Package io.scanbot.sdk.documentscanner

Enum Class DocumentStraighteningMode

java.lang.Object

java.lang.Enum<DocumentStraighteningMode>

io.scanbot.sdk.documentscanner.DocumentStraighteningMode

All Implemented Interfaces:

Serializable, Comparable<DocumentStraighteningMode>, Constable

public enum DocumentStraighteningMode
extends Enum<DocumentStraighteningMode>

Type of document straightening to apply.

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
NONE	Assume that the document is already straight and crop it based on the estimated perspective distortion.
STRAIGHTEN	In addition to perspective correction, remove paper deformations such as creases, curl, folds and crinkles.

Method Summary

Modifier and Type	Method	Description
static DocumentStraighteningMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentStraighteningMode[]	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

NONE

public static final DocumentStraighteningMode NONE

Assume that the document is already straight and crop it based on the estimated perspective distortion. Very fast.

STRAIGHTEN

public static final DocumentStraighteningMode STRAIGHTEN

In addition to perspective correction, remove paper deformations such as creases, curl, folds and crinkles. This does not apply any filtering to enhance the image, such as shadow removal or contrast enhancement - it only straightens the geometry of the document. Requires the `docstraighten` asset to be present at runtime (on platforms where assets can be optional). Will fail if the asset is not available.

Method Details

values

public static DocumentStraighteningMode[] 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 DocumentStraighteningMode 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