Package io.scanbot.sdk.documentscanner

Enum DocumentStraighteningMode

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DocumentStraighteningMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DocumentStraighteningMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static DocumentStraighteningMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DocumentStraighteningMode c : DocumentStraighteningMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DocumentStraighteningMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null