Documentation
Table of contents

Thanks for downloading Dynamsoft Label Recognizer Package!

Your download will start shortly. If your download does not begin, click here to retry.

LabelRecognizerParameter Object

BinarizationModes

Mode Properties

BinarizationModes is a parameter for setting the mode for binarization. It consisits of one or more BinarizationMode items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is.

Value Type Value Range Default Value
BinarizationMode array “BM_SKIP”
“BM_AUTO”
“BM_LOCAL_BLOCK”
“BM_THRESHOLD”
[“BM_LOCAL_BLOCK”, “BM_SKIP”, “BM_SKIP”, “BM_SKIP”, “BM_SKIP”, “BM_SKIP”, “BM_SKIP”, “BM_SKIP”]

Mode Arguments

BlockSizeX

Sets the horizontal block size for the binarization process.

Value Type Value Range Default Value
int [0, 1000] 0

Remarks
Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target region localizing.

  • 0: the block size used for binarization will be set to a value which is calculated automatically.
  • N:
    • 1 <= N <= 3: the block size used for binarization will be set to 3.
    • N > 3: the block size used for binarization will be set to N.
BlockSizeY

Sets the vertical block size for the binarization process.

Value Type Value Range Default Value
int [0, 1000] 0

Remarks
Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target region localizing.

  • 0: the block size used for binarization will be set to a value which is calculated automatically.
  • N:
    • 1 <= N <= 3: the block size used for binarization will be set to 3.
    • N > 3: the block size used for binarization will be set to N..
EnableFillBinaryVacancy

Sets whether to enable binary vacancy filling.

Value Type Value Range Default Value
int [0, 1] 1

Remarks
0: disable.
1: enable.

For characters with large font-weight, there might be a vacant area in the position detection pattern after binarization. The vacant area may result in capturing failure. Setting this to True will fill in the vacant area with black and may help improve the capturing success rate. Better accuracy for characters with large font-weight.

ThresholdCompensation

Constant subtracted from the mean or weighted mean. Normally, it is positive but may be zero or negative as well.

Value Type Value Range Default Value
int [-255, 255] 10
ThreshValueCoefficient

Deprecated. Use ThresholdCompensation instead.

BinarizationThreshold

Sets the binarization threshold.

Value Type Value Range Default Value
int [-1, 255] -1
MorphOperation

Sets the morph operation for the morphology process.

Value Type Value Range Default Value
string “Erode”
“Dilate”
“Open”
“Close”
“Close”

Remarks

  • “Erode”: Perform erosion process.
  • “Dilate”: Perform dilation process.
  • “Open”: Perform erosion first, then perform dilation.
  • “Close”: Perform dilation first, then perform erosion.

For more information, please check out Image Processing in OpenCV - Morphological Transformations for reference.

MorphShape

Sets the morph shape for the morphology process.

Value Type Value Range Default Value
string “Rectangle”
“Cross”
“Ellipse”
“Rectangle”

Remarks

  • “Rectangle”:
  • “Cross”:
  • “Ellipse”:
MorphOperationKernelSizeX

Sets the horizontal kernel size for the morphology process.

Value Type Value Range Default Value
int [-1, 1000] -1
MorphOperationKernelSizeY

Sets the vertical kernel size for the morphology process.

Value Type Value Range Default Value
int [-1, 1000] -1
LibraryFileName

Sets the file name of the library to load dynamically.

Value Type Value Range Default Value Valid For
string A string value representing file name. ”” All BinarizationMode items except BM_SKIP and BM_AUTO
  • Remarks
  • The library must be in the same place with Dynamsoft Label Recognizer Library.
LibraryParameters

Sets the parameters passed to the library to load dynamically.

Value Type Value Range Default Value Valid For
string A string value representing parameters. ”” All BinarizationMode items except BM_SKIP and BM_AUTO

Setting Methods

As JSON Parameter

BinarizationModes as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for binarization. Default values will be used if there is no manual setting.

Json Object Json Parameter Name Value Type
LabelRecognizerParameter BinarizationModes JSON Object Array

Json Parameter Example

{
    "BinarizationModes": [
        {
            "Mode": "BM_LOCAL_BLOCK",
            "BlockSizeX": 5,
            "BlockSizeY": 5,
        }
    ]
}

As DLR_RuntimeSettings Member

BinarizationModes as a member of DLR_RuntimeSettings struct is a BinarizationMode array for setting the modes and the priority for binarization. Default value will be used if there is no manual setting.

Struct Struct Member Name Value Type
DLR_RuntimeSettings binarizationModes BinarizationMode[8]

See Also

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version(3.2.0)
  • Version 3.x
    • Version 3.0.30
    • Version 3.0.20
    • Version 3.0.10
    • Version 3.0.0
  • Version 2.x
    • Version 2.2.20
    • Version 2.2.11
    • Version 2.2.10
    • Version 2.2.0
    • Version 2.0.0
  • Version 1.x
    • Version 1.2.1
    • Version 1.2
    • Version 1.0
Change +