Interface SimplifiedDocumentNormalizerSettings

This interface defines simplified settings for document normalizer tasks.

See

SimplifiedCaptureVisionSettings.documentSettings

interface SimplifiedDocumentNormalizerSettings {
    brightness?: number;
    colourMode?: number;
    contrast?: number;
    expectedDocumentsCount?: number;
    grayscaleEnhancementModes?: Int32Array | EnumGrayscaleEnhancementMode[];
    grayscaleTransformationModes?:
        | Int32Array
        | EnumGrayscaleTransformationMode[];
    maxThreadsInOneTask?: number;
    minQuadrilateralAreaRatio?: number;
    pageSize?: [number, number];
    scaleDownThreshold?: number;
}

Properties

brightness? colourMode? contrast? expectedDocumentsCount? grayscaleEnhancementModes? grayscaleTransformationModes? maxThreadsInOneTask? minQuadrilateralAreaRatio? pageSize? scaleDownThreshold?

Properties

Optionalbrightness

brightness?: number

Sets the brightness of the normalized image. The value range is [-100,100].

OptionalcolourMode

colourMode?: number

Sets the colour mode of the normalized image with enumeration ImageColourMode. View the reference page of ImageColourMode for more detail about colour mode.

See

EnumImageColourMode

Optionalcontrast

contrast?: number

Sets the contrast of the normalized image. The value range is [-100,100].

OptionalexpectedDocumentsCount

expectedDocumentsCount?: number

Sets the number of documents expected to be detected.

OptionalgrayscaleEnhancementModes

grayscaleEnhancementModes?: Int32Array | EnumGrayscaleEnhancementMode[]

Sets the grayscale enhancement modes with an array of enumeration GrayscaleEnhancementMode. View the reference page of GrayscaleEnhancementModes for more detail about grayscale enhancement modes.

See

EnumGrayscaleEnhancementMode

OptionalgrayscaleTransformationModes

grayscaleTransformationModes?: Int32Array | EnumGrayscaleTransformationMode[]

Sets the grayscale transformation modes with an array of enumeration GrayscaleTransformationMode. View the reference page of GrayscaleTransformationModes for more detail about grayscale transformation modes.

See

EnumGrayscaleTransformationMode

OptionalmaxThreadsInOneTask

maxThreadsInOneTask?: number

Sets the maximum number of threads in one task.

OptionalminQuadrilateralAreaRatio

minQuadrilateralAreaRatio?: number

Sets the minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages).

OptionalpageSize

pageSize?: [number, number]

Sets the page size (width and height in pixels) of the normalized image.

OptionalscaleDownThreshold

scaleDownThreshold?: number

Sets the threshold for scaling down the input image during document detection. If the shorter edge size of the image is larger than this threshold,the original may be scaled down to reduce processing time. The default value is 2300.

Settings

Member Visibility

On This Page

Properties