An observation that contains a grayscale heat map of important areas across an image.
Members (8)
get · iOS 18.0+
confidence
TypeScript
get confidence(): number
Swift declaration
let confidence: Float
The level of confidence normalized to `[0, 1]` where `1` is most confident.
The only exception is results coming from `CoreMLRequest`, where confidence values are forwarded as is from relevant CoreML models
get · iOS 18.0+
description
TypeScript
get description(): string
Swift declaration
var description: String { get }
A textual representation of this instance.
Calling this property directly is discouraged. Instead, convert an
instance of any type to a string by using the `String(describing:)`
initializer. This initializer works with any type, and uses the custom
`description` property for types that conform to
`CustomStringConvertible`:
struct Point: CustomStringConvertible {
let x: Int, y: Int
var description: String {
return "(\(x), \(y))"
}
}
let p = Point(x: 21, y: 30)
let s = String(describing: p)
print(s)
// Prints "(21, 30)"
The conversion of `p` to a string in the assignment to `s` uses the
`Point` type's `description` property.
get · iOS 18.0+
salientObjects
TypeScript
get salientObjects(): Array<RectangleObservation>
Swift declaration
let salientObjects: [RectangleObservation]
A collection of objects describing the distinct areas of the saliency heat map.
The objects in this array don't follow any specific ordering.
It's up to your app to iterate across the observations and apply desired ordering.
get · iOS 18.0+
originatingRequestDescriptor
TypeScript
get originatingRequestDescriptor(): (RequestDescriptor) | null
Swift declaration
let originatingRequestDescriptor: RequestDescriptor?
The descriptor of the request that produced the observation.
get · iOS 18.0+
uuid
TypeScript
get uuid(): string
Swift declaration
let uuid: UUID
The unique identifier for the observation.
get · iOS 18.0+
heatMap
TypeScript
get heatMap(): PixelBufferObservation
Swift declaration
let heatMap: PixelBufferObservation
A grayscale heat map of important areas across the image.
The heat map is a pixel buffer in a one-component floating-point pixel format.
get · iOS 18.0+
timeRange
TypeScript
get timeRange(): (_CoreMedia_CMTimeRange) | null
Swift declaration
let timeRange: CMTimeRange?
The time range of the reported observation.
When evaluating a sequence of image buffers, use this property to determine each observation’s start time and duration.