Interface CroppedDetectionResult

Result of the document contour detection.

interface CroppedDetectionResult {
    aspectRatio: number;
    averageBrightness: number;
    croppedImage: RawImage;
    detectionScores: DocumentDetectionScores;
    horizontalLines: LineSegmentInt[];
    horizontalLinesNormalized: LineSegmentFloat[];
    originalImage: Image;
    points: Point[];
    pointsNormalized: Point[];
    status: DocumentDetectionStatus;
    verticalLines: LineSegmentInt[];
    verticalLinesNormalized: LineSegmentFloat[];
}

Hierarchy

Properties

aspectRatio averageBrightness croppedImage detectionScores horizontalLines horizontalLinesNormalized originalImage points pointsNormalized status verticalLines verticalLinesNormalized

Properties

Readonly aspectRatio

aspectRatio: number

Aspect ratio of the detected document contour

Readonly averageBrightness

averageBrightness: number

Average brightness, calculated as the average of the Value channel in the HSV color space of:

  • the whole image, if no document was detected
  • the document crop, if a document was detected Ranges from 0 to 255.

Default Value

0;

croppedImage

croppedImage: RawImage

Readonly detectionScores

detectionScores: DocumentDetectionScores

The total and partial scores for the detected quad

Readonly horizontalLines

horizontalLines: LineSegmentInt[]

All detected horizontal lines in image space

Readonly horizontalLinesNormalized

horizontalLinesNormalized: LineSegmentFloat[]

Normalized horizontal lines in image space

originalImage

originalImage: Image

Readonly points

points: Point[]

Absolute coordinates of the detected document contour in image space sorted in clockwise order, starting from the top left corner

Readonly pointsNormalized

pointsNormalized: Point[]

Normalized coordinates of the detected document contour in image space sorted in clockwise order, starting from the top left corner

Readonly status

status: DocumentDetectionStatus

Detection status.

Default Value

"NOT_ACQUIRED";

Readonly verticalLines

verticalLines: LineSegmentInt[]

All detected vertical lines in image space

Readonly verticalLinesNormalized

verticalLinesNormalized: LineSegmentFloat[]

Normalized vertical lines in image space

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc