Class CustomBinarizationFilter

constructor

• new CustomBinarizationFilter(
      source?: DeepPartial<CustomBinarizationFilter>,
  ): CustomBinarizationFilter

  Parameters

  • Optionalsource: DeepPartial<CustomBinarizationFilter>

  Returns CustomBinarizationFilter

Readonly_type

denoise

outputMode

preset

radius

strokeWeight

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      _type?: "CustomBinarizationFilter";
      denoise?: number;
      outputMode?: OutputMode;
      preset?: BinarizationFilterPreset;
      radius?: number;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly _type?: "CustomBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; strokeWeight?: number | undefined; denoise?: number | undefined; radius?: number | undefined; preset?: BinarizationFilterPreset | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      strokeWeight?: number;
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      _type?: "CustomBinarizationFilter";
      denoise?: number;
      outputMode?: OutputMode;
      preset?: BinarizationFilterPreset;
      radius?: number;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly _type?: "CustomBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; strokeWeight?: number | undefined; denoise?: number | undefined; radius?: number | undefined; preset?: BinarizationFilterPreset | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      strokeWeight?: number;
  }

  • Optional Readonly_type?: "CustomBinarizationFilter"

  • Optionaldenoise?: 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 is 0.5.

  • OptionaloutputMode?: OutputMode

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

    Default is BINARY.

  • Optionalpreset?: BinarizationFilterPreset

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

    Default is PRESET_4.

  • Optionalradius?: 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 127 are clamped to 127.

    Default is 32.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly _type?: "CustomBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; strokeWeight?: number | undefined; denoise?: number | undefined; radius?: number | undefined; preset?: BinarizationFilterPreset | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }

  • OptionalstrokeWeight?: number

    Controls the bias towards thinner or thicker strokes. This bias determines how thin or thick text and lines appear. The valid range is from 0 to 1, where 0 implies a bias towards thinner strokes and 1 implies a bias towards thicker strokes. Thinner strokes look better in poorly lit images, images with heavy shadows, and, more generally, where text is blurry. Thicker strokes look better in well-lit images and, more generally, images with sharp text. The parameter has effect only when outputMode is set to ANTIALIASED.

    Default is 0.5.