Package io.scanbot.sdk.documentscanner

Enum Class DocumentDetectionStatus

java.lang.Object

java.lang.Enum<DocumentDetectionStatus>

io.scanbot.sdk.documentscanner.DocumentDetectionStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentDetectionStatus>, Constable

public enum DocumentDetectionStatus
extends Enum<DocumentDetectionStatus>

Status of the document detection.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_NOTHING_DETECTED	No document was detected.
ERROR_PARTIALLY_VISIBLE	ML engine mode only: A document was detected, but not all of its corners are visible.
ERROR_PARTIALLY_VISIBLE_TOO_CLOSE	Live mode and ML engine mode only: A document was detected, but not all of its corners are visible and the document is too close to the camera.
ERROR_TOO_DARK	No document was detected, likely because the input image is too dark.
ERROR_TOO_NOISY	No document was detected, likely because the input image is too noisy or has a complex background.
NOT_ACQUIRED	Detection has not yet happened.
OK	An acceptable document was detected.
OK_BUT_ALREADY_CROPPED	Single-shot mode and ML engine mode only: No document was detected, likely because the input image is already cropped to the document.
OK_BUT_BAD_ANGLES	A document was detected, but it has too much perspective distortion.
OK_BUT_BAD_ASPECT_RATIO	A document was detected, but its aspect ratio is not acceptable.
OK_BUT_OFF_CENTER	A document was detected, but its center is too far away from the input image center.
OK_BUT_ORIENTATION_MISMATCH	A document was detected, but its orientation does not match the input image orientation.
OK_BUT_TOO_DARK	A document was detected, but it is too dark.
OK_BUT_TOO_SMALL	A document was detected, but it is too small.

Method Summary

Modifier and Type	Method	Description
static DocumentDetectionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentDetectionStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_ACQUIRED

public static final DocumentDetectionStatus NOT_ACQUIRED

Detection has not yet happened.

OK

public static final DocumentDetectionStatus OK

An acceptable document was detected.

OK_BUT_TOO_SMALL

public static final DocumentDetectionStatus OK_BUT_TOO_SMALL

A document was detected, but it is too small.

OK_BUT_BAD_ANGLES

public static final DocumentDetectionStatus OK_BUT_BAD_ANGLES

A document was detected, but it has too much perspective distortion.

OK_BUT_BAD_ASPECT_RATIO

public static final DocumentDetectionStatus OK_BUT_BAD_ASPECT_RATIO

A document was detected, but its aspect ratio is not acceptable.

OK_BUT_ORIENTATION_MISMATCH

public static final DocumentDetectionStatus OK_BUT_ORIENTATION_MISMATCH

A document was detected, but its orientation does not match the input image orientation.

OK_BUT_OFF_CENTER

public static final DocumentDetectionStatus OK_BUT_OFF_CENTER

A document was detected, but its center is too far away from the input image center. Deprecation Warning: This status is never returned by the document scanner.

OK_BUT_TOO_DARK

public static final DocumentDetectionStatus OK_BUT_TOO_DARK

A document was detected, but it is too dark.

OK_BUT_ALREADY_CROPPED

public static final DocumentDetectionStatus OK_BUT_ALREADY_CROPPED

Single-shot mode and ML engine mode only: No document was detected, likely because the input image is already cropped to the document. This status indicates that the scanner confidence that the input is an image of a cropped document, given by the alreadyCroppedScore, is above the alreadyCroppedScoreThreshold.

ERROR_NOTHING_DETECTED

public static final DocumentDetectionStatus ERROR_NOTHING_DETECTED

No document was detected.

ERROR_PARTIALLY_VISIBLE

public static final DocumentDetectionStatus ERROR_PARTIALLY_VISIBLE

ML engine mode only: A document was detected, but not all of its corners are visible. Requires allowPartiallyVisibleDocuments to be true.

ERROR_PARTIALLY_VISIBLE_TOO_CLOSE

public static final DocumentDetectionStatus ERROR_PARTIALLY_VISIBLE_TOO_CLOSE

Live mode and ML engine mode only: A document was detected, but not all of its corners are visible and the document is too close to the camera. Requires allowPartiallyVisibleDocuments to be true.

ERROR_TOO_DARK

public static final DocumentDetectionStatus ERROR_TOO_DARK

No document was detected, likely because the input image is too dark.

ERROR_TOO_NOISY

public static final DocumentDetectionStatus ERROR_TOO_NOISY

No document was detected, likely because the input image is too noisy or has a complex background. Deprecation Warning: This status is never returned by the document scanner.

Method Details

values

public static DocumentDetectionStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DocumentDetectionStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null