# 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](https://www.dynamsoft.com/capture-vision/docs/core/parameters/reference/barcode-reader-task-settings/stage-localize-candidate-barcodes.md) object

**Example:**

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

> [!NOTE]
> - 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](https://www.dynamsoft.com/capture-vision/docs/core/parameters/reference/index.md#full-json-structure)
>   - [Minimal Valid JSON](https://www.dynamsoft.com/capture-vision/docs/core/parameters/reference/index.md#minimal-valid-json-example)

## 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

<table style = "text-align:left">
    <thead>
        <tr>
            <th nowrap="nowrap">Mode Argument Name</th>
            <th nowrap="nowrap">Mode Argument Summary</th>
        </tr>
    </thead>
    <tr>
        <td rowspan = "3" style="vertical-align:text-top">Mode<br>(Required)</td>
        <td><b>Description</b><br>Any one in Candidate Mode List as string
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>String</i>
        </td>
    </tr>
    <tr>
        <td><b>Candidate Mode List</b><br>
            LM_CONNECTED_BLOCKS<br>
            LM_LINES<br>
            LM_NEURAL_NETWORK<br>
            LM_SCAN_DIRECTLY<br>
            LM_STATISTICS<br>
            LM_STATISTICS_MARKS<br>
            LM_STATISTICS_POSTAL_CODE<br>
            LM_CENTRE<br>
            LM_ONED_FAST_SCAN<br>
            LM_SKIP<br>
        </td>
    </tr>
    <tr>
        <td rowspan = "6" style="vertical-align:text-top">ScanStride<br>(Optional)</td>
        <td><b>Description</b><br>Sets the interval (in pixels) between adjacent scan lines when searching for barcodes.
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>int</i>
        </td>
    </tr>
    <tr>
        <td><b>Range</b><br>[0,0x7fffffff]
        </td>
    </tr>
    <tr>
        <td><b>Default Value</b><br>0
        </td>
    </tr>
    <tr>
        <td><b>Remarks</b><br>0: Let the library automatically calculates the interval.<br>The smaller the value is, the more likely it is to locate the code area, but it will also increase the time.
        </td>
    </tr>
    <tr>
        <td><b>Valid For</b><br>
            LM_SCAN_DIRECTLY<br>
            LM_ONED_FAST_SCAN<br>
        </td>
    </tr>
    <tr>
        <td rowspan = "6" style="vertical-align:text-top">ScanDirection<br>(Optional)</td>
        <td><b>Description</b><br>Sets the scan direction when searching barcode.
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>int</i>
        </td>
    </tr>
    <tr>
        <td><b>Range</b><br>[0,2]
        </td>
    </tr>
    <tr>
        <td><b>Default Value</b><br>0
        </td>
    </tr>
    <tr>
        <td><b>Remarks</b><br>0: Both vertical and horizontal direction.<br>1: Vertical direction.<br>2: Horizontal direction.
        </td>
    </tr>
    <tr>
        <td><b>Valid For</b><br>
            LM_SCAN_DIRECTLY<br>
            LM_ONED_FAST_SCAN<br>
        </td>
    </tr>
    <tr>
        <td rowspan = "5" style="vertical-align:text-top">ConfidenceThreshold<br>(Optional)</td>
        <td><b>Description</b><br>Sets the confidence threshold.
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>int</i>
        </td>
    </tr>
    <tr>
        <td><b>Range</b><br>[0,100]
        </td>
    </tr>
    <tr>
        <td><b>Default Value</b><br>60
        </td>
    </tr>
    <tr>
        <td><b>Valid For</b><br>
            LM_ONED_FAST_SCAN<br>
        </td>
    </tr>
    <tr>
        <td rowspan = "5" style="vertical-align:text-top">IsOneDStacked<br>(Optional)</td>
        <td><b>Description</b><br>Sets whether the oned barcodes are stacked.
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>int</i>
        </td>
    </tr>
    <tr>
        <td><b>Range</b><br>[0, 1]
        </td>
    </tr>
    <tr>
        <td><b>Default Value</b><br>0
        </td>
    </tr>
    <tr>
        <td><b>Valid For</b><br>
            LM_SCAN_DIRECTLY<br>
        </td>
    </tr>
    <tr>
        <td rowspan = "5" style="vertical-align:text-top">ModuleSize<br>(Optional)</td>
        <td><b>Description</b><br>Set the module size, if the module size is known.
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>int</i>
        </td>
    </tr>
    <tr>
        <td><b>Range</b><br>[0, 0x7fffffff]
        </td>
    </tr>
    <tr>
        <td><b>Default Value</b><br>0
        </td>
    </tr>
    <tr>
        <td><b>Valid For</b><br>
            LM_CENTRE<br>
        </td>
    </tr>
    <tr>
        <td rowspan = "6" style="vertical-align:text-top" id="modelnamearray">ModelNameArray<br>(Optional)</td>
        <td><b>Description</b><br>Sets the names of a barcode localization model.
        </td>
    </tr>
    <tr>
        <td><b>Type</b><br><i>String Array</i>
        </td>
    </tr>
    <tr>
        <td><b>Range</b><br>Each element is the name of a model.<br>Candidate values: "OneDLocalization", "DataMatrixQRCodeLocalization", "PDF417Localization".<br>"OneDLocalization": for OneD barcodes.<br>"DataMatrixQRCodeLocalization": for DataMatrix and QRCode barcodes.<br>"PDF417Localization": for PDF417 barcodes. Introduced in version 11.4.1000.
        </td>
    </tr>
    <tr>
        <td><b>Default Value</b><br>null
        </td>
    </tr>
    <tr>
        <td><b>Valid For</b><br>All candidate modes.
        </td>
    </tr>
    <tr>
        <td><b>Remarks</b><br>Introduced in version 11.2.1000.<br>When set to null in version 11.2.1000, "OneDLocalization", "DataMatrixQRCodeLocalization" models will be used by default.<br>When set to null in version 11.4.1000, "OneDLocalization", "DataMatrixQRCodeLocalization", "PDF417Localization" models will be used by default.
        </td>
    </tr>
</table>

### Default Setting

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

```json
{
    "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