Class ImageProcessor

API for image processing.

Required licence feature(s): ImageProcessing.

Methods

applyFilter crop destroy resize rotate create

Methods

applyFilter

  • applyFilter(image, filter, consumeImage?): Promise<ImageProcessorApplyfilterResponse>

  • Applies given filter to the given image.

    Parameters

    • image: Image

      The image to apply filter on

    • filter: {
          filterType?: number;
      } & {
          _type: "LegacyFilter";
      } | {
          outputMode?: OutputMode;
      } & {
          _type: "ScanbotBinarizationFilter";
      } | {
          denoise?: number;
          outputMode?: OutputMode;
          preset?: BinarizationFilterPreset;
          radius?: number;
      } & {
          _type: "CustomBinarizationFilter";
      } | {
          blackOutliersFraction?: number;
          borderWidthFraction?: number;
          colorEnhancement?: number;
          contrastEnhancement?: number;
          paperWhitening?: number;
          paperWhiteningBias?: number;
          radius?: number;
          whiteOutliersFraction?: number;
      } & {
          _type: "ColorDocumentFilter";
      } | {
          brightness?: number;
      } & {
          _type: "BrightnessFilter";
      } | {
          contrast?: number;
      } & {
          _type: "ContrastFilter";
      } | {
          blackOutliersFraction?: number;
          borderWidthFraction?: number;
          whiteOutliersFraction?: number;
      } & {
          _type: "GrayscaleFilter";
      } | {
          blackPoint?: number;
          whitePoint?: number;
      } & {
          _type: "WhiteBlackPointFilter";
      }

      Filter to be applied

    • Optional consumeImage: Config.ConsumeType

      Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.

    Returns Promise<ImageProcessorApplyfilterResponse>

    The result of the filter application.

crop

  • crop(image, quad, consumeImage?): Promise<ImageProcessorCropResponse>

  • Crops the given image to the given quadrilateral.

    Parameters

    • image: Image

      The image to crop.

    • quad: Point[]

      The quadrilateral of normalized points to crop.

    • Optional consumeImage: Config.ConsumeType

      Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.

    Returns Promise<ImageProcessorCropResponse>

    Cropped image.

destroy

  • destroy(): Promise<void>

  • Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

    Returns Promise<void>

resize

  • resize(image, size, consumeImage?): Promise<ImageProcessorResizeResponse>

  • Resizes the given image to the given size.

    Parameters

    • image: Image

      The image to resize

    • size: number

      Size of the longer side of the image.

    • Optional consumeImage: Config.ConsumeType

      Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.

    Returns Promise<ImageProcessorResizeResponse>

    Resized image.

rotate

Static create

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc