LabelRecognitionParameter Object

Name

The name of the LabelRecognitionParameter object.

Remarks
It must be a unique name.

As Json Parameter

Json Parameter Example

{
    "Name":"LabelRecognitionParameter1"
}

BinarizationModes

CharacterModelName

Sets the name of a white list of recognizable characters.

Remarks
If you set a character model, the result will only contain characters within the model.
All TextArea Objects without CharacterModelName set will be set from this setting.

As Json Parameter

Json Parameter Example

{
    "CharacterModelName":"CharacterModel_Name1"
}

GrayscaleTransformationModes

LetterHeightRange

Sets the range of letter height (in pixel or a percentage value relative to the height of the text area).

Remarks
Format: [MinHeight, MaxHeight, ByPercentage]
The allowed values for MinHeight/MaxHeight:
ByPercentage=0, [1, 0x7fffffff]
ByPercentage=1, [1, 100]
The allowed values for ByPercentage: [0,1]
All TextArea Objects without LetterHeightRange set will be set from this setting.

As Json Parameter

Json Parameter Example

{
    "LetterHeightRange":[40,60,1]
}

LinesCount

Sets the text lines count of the text area.

Remarks

• 0: line count is not certain.
• All TextArea Objects without LinesCount set will be set from this setting.

As Json Parameter

Json Parameter Example

{
    "LinesCount":1
}

LineStringLengthRange

Sets the range of string length for each recognized line.

As Json Parameter

LineStringLengthRange as a JSON parameter is a JSON Object with two keys MinValue and MaxValue for setting the range of string length for each recognized line. Default values will be used if there is no manual setting.

• Remarks
• Value range of MinValue and MaxValue: [0, 0x7fffffff]
  
• MaxValue >= MinValue

Json Parameter Example

{
    "LineStringLengthRange": [4,200]
}

LineStringRegExPattern

Specifies the regular expression pattern of each line string text in current image to recognize.

Remarks

• All TextArea Objects without LineStringRegExPattern set will be set from this setting.
• Supported regular expressions pattern syntax is same as TextRegExPattern.

As Json Parameter

Json Parameter Example

{
    "LineStringRegExPattern":""
}

MaxLineCharacterSpacing

Sets the maximum spacing between characters treated as one line.

Remarks

• 0: means automatically set by the library.
• It is a percentage value relative to the average letter height of each line.
• All TextArea Objects without MaxLineCharacterSpacing set will be set from this setting.

As Json Parameter

Json Parameter Example

{
    "MaxLineCharacterSpacing":200
}

MaxThreadCount

Sets the maximum number of threads the algorithm will use to recognize text.

As Json Parameter

Json Parameter Example

{
    "MaxThreadCount":1
}

Pages

Sets the specific pages or the range of pages of a file (.tiff or .pdf) for label recognition.

Remarks

1. The value is 0-based;
2. ”” represents all pages.

As Json Parameter

Json Parameter Example

{
    "Pages": "0,3,5,7-10"
}

ReferenceRegionNameArray

The name array of the ReferenceRegion object(s).

Remarks
An array item is a name of any available ReferenceRegion.

As Json Parameter

Json Parameter Example

{
    "ReferenceRegionNameArray":[
        "Region1",
        "Region2"
    ]
}

RegionPredetectionModes

TextStringLengthRange

Sets the range of string length for each recognized text area.

As Json Parameter

TextStringLengthRange as a JSON parameter is a JSON Object with two keys MinValue and MaxValue for setting the range of string length for each recognized text area. Default values will be used if there is no manual setting.

Remarks

• Value range of MinValue and MaxValue: [0, 0x7fffffff]
  
• MaxValue >= MinValue

Json Parameter Example

{
    "TextStringLengthRange": 
    {
        "MinValue": 4,
        "MaxValue": 200
    }
}

TextRegExPattern

Specifies the regular expression pattern of the text to recognize.

Remarks

• All TextArea Objects without TextRegExPattern set will be set from this setting.
• Supported regular expressions pattern syntax:

As Json Parameter

Json Parameter Example

{
    "TextRegExPattern":""
}

Timeout

Sets the maximum amount of time (in milliseconds) that should be spent searching for labels on each page. It does not include the time taken to load/capture an image (Tiff, PNG, etc) from disk into memory.

Remarks
If you want to stop searching for labels after a specified amount of time, you can use this parameter to set a timeout.

As Json Parameter

Json Parameter Example

{
    "Timeout":10000
}