Vision · IOS API REFERENCE

DetectedDocumentObservation

struct · iOS 18.0+ · SDK 27.1

struct DetectedDocumentObservation

An observation that contains a detected document. The observation includes the four corner points of a document’s quadrilateral and saliency mask.

Members (16)

get · iOS 18.0+

bottomLeft

TypeScript

get bottomLeft(): NormalizedPoint

Swift declaration

var bottomLeft: NormalizedPoint

The coordinates of the lower-left corner of the quadrilateral.

set · iOS 18.0+

bottomLeft

TypeScript

set bottomLeft(value: NormalizedPoint)

Swift declaration

var bottomLeft: NormalizedPoint

The coordinates of the lower-left corner of the quadrilateral.

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+

bottomRight

TypeScript

get bottomRight(): NormalizedPoint

Swift declaration

var bottomRight: NormalizedPoint

The coordinates of the lower-right corner of the quadrilateral.

set · iOS 18.0+

bottomRight

TypeScript

set bottomRight(value: NormalizedPoint)

Swift declaration

var bottomRight: NormalizedPoint

The coordinates of the lower-right corner of the quadrilateral.

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+

globalSegmentationMask

TypeScript

get globalSegmentationMask(): PixelBufferObservation

Swift declaration

var globalSegmentationMask: PixelBufferObservation

A pixel buffer representing a segmentation mask for the detected document.

set · iOS 18.0+

globalSegmentationMask

TypeScript

set globalSegmentationMask(value: PixelBufferObservation)

Swift declaration

var globalSegmentationMask: PixelBufferObservation

A pixel buffer representing a segmentation mask for the detected document.

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+

topLeft

TypeScript

get topLeft(): NormalizedPoint

Swift declaration

var topLeft: NormalizedPoint

The coordinates of the upper-left corner of the quadrilateral.

set · iOS 18.0+

topLeft

TypeScript

set topLeft(value: NormalizedPoint)

Swift declaration

var topLeft: NormalizedPoint

The coordinates of the upper-left corner of the quadrilateral.

get · iOS 18.0+

topRight

TypeScript

get topRight(): NormalizedPoint

Swift declaration

var topRight: NormalizedPoint

The coordinates of the upper-right corner of the quadrilateral.

set · iOS 18.0+

topRight

TypeScript

set topRight(value: NormalizedPoint)

Swift declaration

var topRight: NormalizedPoint

The coordinates of the upper-right corner of the quadrilateral.

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.

init · iOS 18.0+

init

TypeScript

static init(observation: VNRectangleObservation): (DetectedDocumentObservation) | null

Swift declaration

init?(_ observation: VNRectangleObservation)

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →