Android Scanbot SDK

8.0.0

Android Scanbot SDK/io.scanbot.sdk.documentscanner/DocumentDetectionResult

DocumentDetectionResult

data class DocumentDetectionResult(val status: DocumentDetectionStatus = DocumentDetectionStatus.NOT_ACQUIRED, val detectionScores: DocumentDetectionScores, val points: List<Point>, val horizontalLines: List<LineSegmentInt>, val verticalLines: List<LineSegmentInt>, val pointsNormalized: List<PointF>, val horizontalLinesNormalized: List<LineSegmentFloat>, val verticalLinesNormalized: List<LineSegmentFloat>, val aspectRatio: Double, val averageBrightness: Int = 0, val displacement: DocumentDisplacement = DocumentDisplacement.NONE, val displacementVector: PointF) : Parcelable

Result of the document contour detection.

Constructors

DocumentDetectionResult

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(status: DocumentDetectionStatus = DocumentDetectionStatus.NOT_ACQUIRED, detectionScores: DocumentDetectionScores, points: List<Point>, horizontalLines: List<LineSegmentInt>, verticalLines: List<LineSegmentInt>, pointsNormalized: List<PointF>, horizontalLinesNormalized: List<LineSegmentFloat>, verticalLinesNormalized: List<LineSegmentFloat>, aspectRatio: Double, averageBrightness: Int = 0, displacement: DocumentDisplacement = DocumentDisplacement.NONE, displacementVector: PointF)

Properties

val aspectRatio: Double

Aspect ratio of the detected document contour.

averageBrightness

val averageBrightness: Int = 0

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

detectionScores

val detectionScores: DocumentDetectionScores

The total and partial scores for the detected quad.

val displacement: DocumentDisplacement

The direction towards the center of the document if the document is partially visible.

displacementVector

val displacementVector: PointF

The direction vector towards the center of the document if the document is partially visible in normalized coordinates.

horizontalLines

val horizontalLines: List<LineSegmentInt>

All detected horizontal lines in image space.

horizontalLinesNormalized

val horizontalLinesNormalized: List<LineSegmentFloat>

Normalized horizontal lines in image space.

val points: List<Point>

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

pointsNormalized

val pointsNormalized: List<PointF>

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

val status: DocumentDetectionStatus

Detection status.

val verticalLines: List<LineSegmentInt>

All detected vertical lines in image space.

verticalLinesNormalized

val verticalLinesNormalized: List<LineSegmentFloat>

Normalized vertical lines in image space.

Functions

fun clone(): DocumentDetectionResult

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject