Resource Base
Table of contents

SimplifiedDocumentNormalizerSettings

The SimplifiedDocumentNormalizerSettings class contains settings for document normalization. It is a sub-parameter of SimplifiedCaptureVisionSettings

class SimplifiedDocumentNormalizerSettings(object)

Properties Summary

Property Type
grayscale_transformation_modes List[int]
grayscale_enhancement_modes List[int]
colour_mode int
page_size List[int]
brightness int
contrast int
max_threads_in_one_task int
scale_down_threshold int
min_quadrilateral_area_ratio int
expected_documents_count int

grayscale_transformation_modes

Specifies how grayscale transformations should be applied, including whether to process inverted grayscale images and the specific transformation mode to use.

It is a list of 8 integers, where each integer represents a mode specified by the EnumGrayscaleTransformationMode enumeration.

View the parameter reference page of GrayscaleTransformationModes for more detail about grayscale transformation modes.

grayscale_enhancement_modes

Specifies how to enhance the quality of the grayscale image.

It is a list of 8 integers, where each integer represents a mode specified by the EnumGrayscaleEnhancementMode enumeration.

View the parameter reference page of GrayscaleEnhancementModes for more detail about grayscale enhancement modes.

colour_mode

Specifies the colour mode of the output image.

It is a value of the EnumImageColourMode enumeration.

View the parameter reference page of ColourMode for more detail about colour mode.

Default value

0, which means output image in colour mode.

page_size

Specifies the page size (width by height in pixels) of the normalized image.

brightness

Specifies the brightness of the normalized image.

Value Range

[-100,100]

Default value

0

contrast

Specifies the contrast of the normalized image.

Value Range

[-100,100]

Default value

0

max_threads_in_one_task

Specifies the maximum available threads count in one document normalization task.

Value Range

[1, 256]

Default value

4

scale_down_threshold

Specifies the threshold for the image shrinking.

Value Range

[512, 0x7fffffff]

Default Value

2300

Remarks

If the shorter edge size is larger than the given threshold value, the library will calculate the required height and width of the barcode image and shrink the image to that size before detection. Otherwise, the library will perform document detection on the original image.

min_quadrilateral_area_ratio

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

Value Range

[0, 100]

Default Value

0, which means no limitation.

expected_documents_count

Specifies the number of documents expected to be detected.

Value Range

[0, 0x7fffffff]

Default Value

0, which means the count is unknown. The library will try to find at least 1 document.

Methods

Method Description
__init__ Initializes a new instance of the SimplifiedDocumentNormalizerSettings class.

__init__

Initializes a new instance of the SimplifiedDocumentNormalizerSettings class.

def __init__(self):

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version(2.4.10)
    • Version 2.x
      • Version 2.2.0
      • Version 2.0.20
      • Version 2.0.10
      • Version 2.0.0
    • Version 1.x
      • Version 1.0.20
      • Version 1.0.10
      • Version 1.0.0
      • Version 1.0.20
      • Version 1.0.10
      • Version 1.0.0
    • Documentation Homepage
    Change +