One Logo Pool Ball
Vision · IOS API REFERENCE

TrackTranslationalImageRegistrationRequest

class · iOS 18.0+ · SDK 27.1

final class TrackTranslationalImageRegistrationRequest

An image analysis request, as a stateful request you track over time, that determines the affine transform necessary to align the content of two images.

Members (10)

get · iOS 18.0+

descriptor

TypeScript
get descriptor(): RequestDescriptor
Swift declaration
final var descriptor: RequestDescriptor { get }

An enum that identifies the request and request revision.

get · iOS 18.0+

regionOfInterest

TypeScript
get regionOfInterest(): NormalizedRect
Swift declaration
final var regionOfInterest: NormalizedRect { get set }

The region of the image in which Vision will perform the request. The rectangle is normalized to the dimensions of the processed image. Its origin is specified relative to the image's lower-left corner. By default, the region of interest will be the full image.

set · iOS 18.0+

regionOfInterest

TypeScript
set regionOfInterest(value: NormalizedRect)
Swift declaration
final var regionOfInterest: NormalizedRect { get set }

The region of the image in which Vision will perform the request. The rectangle is normalized to the dimensions of the processed image. Its origin is specified relative to the image's lower-left corner. By default, the region of interest will be the full image.

method · iOS 18.0+

setComputeDevice

TypeScript
setComputeDevice(computeDevice: (_CoreML_MLComputeDevice) | null, computeStage: ComputeStage): void
Swift declaration
final func setComputeDevice(_ computeDevice: MLComputeDevice?, for computeStage: ComputeStage)

Assigns a compute device for a compute stage. If the parameter `computeDevice` is `nil`, the framework removes any explicit compute device assignment and allows the framework to select the device. Configure any compute device for a given compute stage. When performing a request, the system makes a validity check. Use `supportedComputeStageDevices` to get valid compute devices for a request’s compute stages. - Parameters: - `computeDevice: `The compute device to assign to the compute stage. - `computeStage: `The compute stage.

get · iOS 18.0+

supportedRevisions

TypeScript
static get supportedRevisions(): Array<TrackTranslationalImageRegistrationRequest_Revision>
Swift declaration
static let supportedRevisions: [TrackTranslationalImageRegistrationRequest.Revision]

The collection of currently-supported revisions for `TrackTranslationalImageRegistrationRequest `.

get · iOS 18.0+

frameAnalysisSpacing

TypeScript
get frameAnalysisSpacing(): _CoreMedia_CMTime
Swift declaration
final let frameAnalysisSpacing: CMTime

The reciprocal of maximum rate at which buffers will be processed. The request will not process buffers that fall within the `frameAnalysisSpacing` since the previously performed analysis. The analysis is not done by wall time but by analysis of of the time stamps of the samplebuffers being processed.

get · iOS 18.0+

minimumLatencyFrameCount

TypeScript
get minimumLatencyFrameCount(): number
Swift declaration
final var minimumLatencyFrameCount: Int { get }

The minimum number of frames that the request has to process on before reporting back any observation. This information is provided by the request once initialized with its required paramters. Video-based requests often need a minimum number of frames before they can report back any observation. An example would be that a movement detection requires at least 5 frames to be detected. The `minimumLatencyFrameCount` for that request would report 5 and only after 5 frames have been processed an observation would be returned in the results. This latency is indicative of how responsive a request is in respect to the incoming data.

get · iOS 18.0+

supportedComputeStageDevices

TypeScript
get supportedComputeStageDevices(): NativeMap<ComputeStage, Array<_CoreML_MLComputeDevice>>
Swift declaration
final var supportedComputeStageDevices: [ComputeStage : [MLComputeDevice]] { get }
get · iOS 18.0+

revision

TypeScript
get revision(): TrackTranslationalImageRegistrationRequest_Revision
Swift declaration
final let revision: TrackTranslationalImageRegistrationRequest.Revision

The request's configured revision.

init · iOS 18.0+

init

TypeScript
static init(revision?: (TrackTranslationalImageRegistrationRequest_Revision) | null, frameAnalysisSpacing?: (_CoreMedia_CMTime) | null): TrackTranslationalImageRegistrationRequest
Swift declaration
init(_ revision: TrackTranslationalImageRegistrationRequest.Revision? = nil, frameAnalysisSpacing: CMTime? = nil)

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →