Need better scanning performance?

Get a FREE customized reading template.

LocalizationModes

Parameter LocalizationModes determines how to localize barcodes. It consists of one or more modes, each mode representing a different localization process.

JSON Structure

Location in template:

BarcodeReaderTaskSettingOptions[i]
    ├── SectionArray[j]
    │   └── StageArray[k] (Stage object)
    │       └── LocalizationModes

Parent object: LocalizeCandidateBarcodesStage object

Example:

{
    "LocalizationModes": [
        {
            "Mode": "LM_CONNECTED_BLOCKS"
        },
        {
            "Mode": "LM_SCAN_DIRECTLY",
            "ScanDirection": 0,
            "ScanStride": 0
        }
    ]
}

• This snippet shows only the LocalizationModes parameter.
• To use it, embed this parameter within a Stage object at the SST_LOCALIZE_CANDIDATE_BARCODES stage.
• For the complete JSON structure, see:
  • Full JSON Structure
  • Minimal Valid JSON

Parameter Details

Parameter LocalizationModes consists of a group of localization mode objects. Each localization mode object includes a candidate mode and a series of auxiliary mode arguments.

Mode Arguments

The mode arguments of the localization mode object are shown as follows:

Mode Arguments

Default Setting

If the LocalizationModes is not configured in your template file, the following settings will be used as the default settings.

{
    "LocalizationModes": [
        {
            "Mode": "LM_CONNECTED_BLOCKS"
        },
        {
            "Mode": "LM_SCAN_DIRECTLY",
            "IsOneDStacked": 0,
            "ScanDirection": 0,
            "ScanStride": 0
        },
        {
            "Mode": "LM_STATISTICS"
        },
        {
            "Mode": "LM_LINES"
        }
    ]
}

If you specify a localization mode object with the Mode Argument “Mode” only, the default values of the other mode arguments will be used.

Candidate Mode Introductions

LM_CONNECTED_BLOCKS

Localizes barcodes by searching for connected blocks. It is optimized for clear images with obvious connected blocks. This algorithm usually gives best result and it is recommended to set as highest priority.

Available Mode Arguments:

• ModelNameArray

LM_STATISTICS

Localizes barcodes by groups of contiguous black-white regions. This is optimized for QRCode and DataMatrix.

Available Mode Arguments:

• ModelNameArray

LM_LINES

Localizes barcodes by searching for groups of lines. It is optimized for 1D and PDF417 barcodes which are with obvious straight lines. Compared with the LM_CONNECTED_BLOCKS mode, it can handle the situation where some bars (or lines) of the barcode stick to each other.

Available Mode Arguments:

• ModelNameArray

LM_SCAN_DIRECTLY

Localizes barcodes based on the direct scanning mode. It is the fastest among all localization modes, but it requires high barcode image quality, and the direction of the barcode must be horizontal or vertical. This mode is recommended in the real-time video scanning scenarios.

Available Mode Arguments:

• ScanStride
• ScanDirection
• IsOneDStacked
• ModelNameArray

LM_STATISTICS_MARKS

Localizes barcodes by dot matrix information. This mode is only applicable to DPM Code and DotCode.

Available Mode Arguments:

• ModelNameArray

LM_STATISTICS_POSTAL_CODE

Localizes barcodes by statistics, connected blocks and straight lines. This is optimized for postal codes.

Available Mode Arguments:

• ModelNameArray

LM_CENTRE

Localizes barcodes from the centre of the image. This mode uses the central area of the image as the suspected code area and then try to localize and decode.

Available Mode Arguments:

• ModuleSize
• ModelNameArray

LM_ONED_FAST_SCAN

Localizes 1D barcodes in a fast mode. This mode is designed for reading 1D barcodes in a very fast mode.

Available Mode Arguments:

• ScanStride
• ScanDirection
• ConfidenceThreshold
• ModelNameArray

LM_NEURAL_NETWORK

Localizes barcodes by utilizing a neural network model.

Available Mode Arguments:

• ModelNameArray