Package io.scanbot.sdk.imageprocessing

Enum PageBinarization

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PageBinarization>
    public enum PageBinarization
extends java.lang.Enum<PageBinarization>
    Binarization behavior to apply when adding a page to a PDF/TIFF.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DISABLED
      Do not binarize the image.
      ENABLED
      Binarize the image.
      ENABLED_IF_BINARIZATION_FILTER_SET
      Same behavior as ENABLED if a binarizationFilter is set, otherwise same behavior as DISABLED.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PageBinarization valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PageBinarization[] 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

      • DISABLED

        public static final PageBinarization DISABLED
        Do not binarize the image.

      • ENABLED

        public static final PageBinarization ENABLED
        Binarize the image. Image will be stored as a compressed black-and-white image. This will result in a very small file size. If binarizationFilter is set, this binarization filter will be applied. Otherwise, a simple thresholding binarization will be applied.

      • ENABLED_IF_BINARIZATION_FILTER_SET

        public static final PageBinarization ENABLED_IF_BINARIZATION_FILTER_SET
        Same behavior as ENABLED if a binarizationFilter is set, otherwise same behavior as DISABLED. This is the default.

    • Method Detail

      • values

        public static PageBinarization[] 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 (PageBinarization c : PageBinarization.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PageBinarization 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