Resource Base
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

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

ImageParameter Object | BinarizationModes

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
string array or 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 binarization. BlockSize can help generate a high-quality binary image and increase the accuracy of barcode localization.

    • 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 binarization. BlockSize can help generate a high-quality binary image and increase the accuracy of barcode localization.

    • 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 barcodes with a large module size, there might be a vacant area in the position detection pattern after binarization. The vacant area may result in decoding failure. Setting this to True will fill in the vacant area with black and may help improve the decoding success rate.

ImagePreprocessingModesIndex

The index of a specific image preprocessing mode in the ImagePreprocessingModes parameter which the current binarization mode is applied to.

Value Type Value Range Default Value
int [-1, 0x7fffffff] -1
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
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 Barcode Reader 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
ImageParameter BinarizationModes JSON Object Array

Json Parameter Example

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

 

As PublicRuntimeSettings Member

BinarizationModes as a member of PublicRuntimeSettings 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
PublicRuntimeSettings binarizationModes BinarizationMode[8]

Remarks
GetModeArgument and SetModeArgument need to be called for getting or setting the value of arguments.

See Also

This page is compatible for:

Version 7.5

Is this page helpful?

YesYes NoNo

latest version

  • Latest Version
  • version 8.2.5
  • version 8.2
  • version 8.1.2
  • version 8.0
  • version 7.6
  • version 7.5
Change +
© 2003–2021 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support