Automatic binarization filter. This filter is a good starting point for most use cases.

Hierarchy

  • PartiallyConstructible
    • CustomBinarizationFilter

Constructors

  • Parameters

    • Optional source: {
          _type?: "CustomBinarizationFilter";
          denoise?: number;
          outputMode?: OutputMode;
          preset?: BinarizationFilterPreset;
          radius?: number;
      }
      • Optional _type?: "CustomBinarizationFilter"
      • Optional denoise?: number

        Value controlling the amount of noise removal. Value between 0 and 1. Too little noise removal may result in a very noisy image, worsening readability. Too much noise removal may result in the degradation of text, again, worsening readability.

        Default Value

        0.5;
        
      • Optional outputMode?: OutputMode

        Output mode of the filter. BINARY will return a black and white image, GRAYSCALE will return an antialiased grayscale image.

        Default Value

        "BINARY";
        
      • Optional preset?: BinarizationFilterPreset

        Preset of binarization filter parameters that are found to perform well on different types of documents.

        Default Value

        "PRESET_4";
        
      • Optional radius?: number

        Filter radius. The bigger the radius, the slower the filter and generally the less noise in the result. The radius is used for both shadows removal and the calculation of local statistics in the main body of the filter. Higher radius usually allows to cope better with regions of light text on dark background. All the values larger than 512 are clamped to 512.

        Default Value

        32;
        

    Returns CustomBinarizationFilter

Properties

_type: "CustomBinarizationFilter"
denoise: number

Value controlling the amount of noise removal. Value between 0 and 1. Too little noise removal may result in a very noisy image, worsening readability. Too much noise removal may result in the degradation of text, again, worsening readability.

Default Value

0.5;
outputMode: OutputMode

Output mode of the filter. BINARY will return a black and white image, GRAYSCALE will return an antialiased grayscale image.

Default Value

"BINARY";

Preset of binarization filter parameters that are found to perform well on different types of documents.

Default Value

"PRESET_4";
radius: number

Filter radius. The bigger the radius, the slower the filter and generally the less noise in the result. The radius is used for both shadows removal and the calculation of local statistics in the main body of the filter. Higher radius usually allows to cope better with regions of light text on dark background. All the values larger than 512 are clamped to 512.

Default Value

32;

Generated using TypeDoc