Need better scanning performance?

Get a FREE customized reading template.

LabelRecognizerTaskSetting Parameters

The LabelRecognizerTaskSetting object configures settings for label recognition tasks in Dynamsoft Capture Vision, including text line localization, recognition, and correction.

Example JSON

{
    "LabelRecognizerTaskSettingOptions": [
        {
            "Name": "dlr_task_default",
            "MaxThreadsInOneTask": 4,
            "TextLineSpecificationNameArray": ["tls_default"],
            "BaseLabelRecognizerTaskSettingName": "",
            "SectionArray": [
                {
                    "Section": "ST_REGION_PREDETECTION",
                    "ImageParameterName": "ip_default",
                    "StageArray": [
                        {
                            "Stage": "SST_PREDETECT_REGIONS",
                            "RegionPredetectionModes": []
                        }
                    ]
                },
                {
                    "Section": "ST_TEXT_LINE_LOCALIZATION",
                    "ImageParameterName": "ip_default",
                    "StageArray": [
                        {
                            "Stage": "SST_LOCALIZE_TEXT_LINES",
                            "LocalizationModes": [],
                            "OrientationDetectionModes": []
                        }
                    ]
                },
                {
                    "Section": "ST_TEXT_LINE_RECOGNITION",
                    "ImageParameterName": "ip_default",
                    "StageArray": [
                        {
                            "Stage": "SST_RECOGNIZE_RAW_TEXT_LINES",
                            "DictionaryPath": "",
                            "DictionaryCorrectionThresholds": [],
                            "ConfusableCharactersPath": "ConfusableChars.data",
                            "ClusterSamplesCountThreshold": 0,
                            "OverlappingCharactersPath": "OverlappingChars.data",
                            "EnableRegexForceCorrection": 1
                        },
                        {
                            "Stage": "SST_ASSEMBLE_TEXT_LINES",
                            "StringLengthRange": [3, 200],
                            "StringRegexPattern": ""
                        }
                    ]
                }
            ]
        }
    ]
}

Hierarchical Structure

This tree shows one LabelRecognizerTaskSetting object inside LabelRecognizerTaskSettingOptions.

LabelRecognizerTaskSetting
├── Name
├── MaxThreadsInOneTask
├── TextLineSpecificationNameArray
├── BaseLabelRecognizerTaskSettingName
└── SectionArray[]
    ├── item (Section = ST_REGION_PREDETECTION)
    │   ├── Section
    │   ├── ImageParameterName
    │   └── StageArray[]
    │       └── item (Stage = SST_PREDETECT_REGIONS)
    │           ├── Stage
    │           └── RegionPredetectionModes
    ├── item (Section = ST_TEXT_LINE_LOCALIZATION)
    │   ├── Section
    │   ├── ImageParameterName
    │   └── StageArray[]
    │       └── item (Stage = SST_LOCALIZE_TEXT_LINES)
    │           ├── Stage
    │           ├── LocalizationModes
    │           └── OrientationDetectionModes
    └── item (Section = ST_TEXT_LINE_RECOGNITION)
        ├── Section
        ├── ImageParameterName
        └── StageArray[]
            ├── item (Stage = SST_RECOGNIZE_RAW_TEXT_LINES)
            │   ├── Stage
            │   ├── DictionaryPath
            │   ├── DictionaryCorrectionThresholds
            │   ├── ConfusableCharactersPath
            │   ├── ClusterSamplesCountThreshold
            │   ├── OverlappingCharactersPath
            │   └── EnableRegexForceCorrection
            └── item (Stage = SST_ASSEMBLE_TEXT_LINES)
                ├── Stage
                ├── StringLengthRange
                └── StringRegexPattern

Stage values are constrained by the parent Section value, and stage-scoped parameters are constrained by the Stage value.

Top-Level Parameters

Parameter Name	Description
`Name`	The unique name of the LabelRecognizerTaskSetting object.
`BaseLabelRecognizerTaskSettingName`	The name of another LabelRecognizerTaskSetting to inherit from.
`MaxThreadsInOneTask`	The maximum threads in one task.
`TextLineSpecificationNameArray`	The names of TextLineSpecification objects to reference.
`SectionArray`	The sections of the label recognizer task.

Nested Parameter Quick Links

Actual Nested Parameters in the Tree

Parameter Name	Description
`RegionPredetectionModes`	Controls how to find a region of interest (ROI) within the image or frame.
`LocalizationModes`	The modes for text line localization.
`OrientationDetectionModes`	The modes for orientation detection.
`DictionaryPath`	The path to the dictionary file.
`DictionaryCorrectionThresholds`	The thresholds for dictionary-based correction.
`ConfusableCharactersPath`	The path to confusable characters definition.
`ClusterSamplesCountThreshold`	The threshold for cluster samples count.
`OverlappingCharactersPath`	The path to overlapping characters definition.
`EnableRegexForceCorrection`	Whether to enable regex-based force correction.
`StringLengthRange`	The expected string length range.
`StringRegexPattern`	The regex pattern for validating recognized strings.

Conceptual Section/Stage Objects

Object	Description
`SectionRegionsPredetection`	Section object for `Section = ST_REGION_PREDETECTION`.
`StagePredetectRegions`	Stage object under `Section = ST_REGION_PREDETECTION` with `Stage = SST_PREDETECT_REGIONS`.
`SectionTextLinesLocalization`	Section object for `Section = ST_TEXT_LINE_LOCALIZATION`.
`StageLocalizeTextLines`	Stage object under `Section = ST_TEXT_LINE_LOCALIZATION` with `Stage = SST_LOCALIZE_TEXT_LINES`.
`SectionTextLinesRecognition`	Section object for `Section = ST_TEXT_LINE_RECOGNITION`.
`StageRecognizeRawTextLines`	Stage object under `Section = ST_TEXT_LINE_RECOGNITION` with `Stage = SST_RECOGNIZE_RAW_TEXT_LINES`.
`StageAssembleTextLines`	Stage object under `Section = ST_TEXT_LINE_RECOGNITION` with `Stage = SST_ASSEMBLE_TEXT_LINES`.