|
| 1 | +--- |
| 2 | +title: Dynamsoft Label Recognizer Parameter Reference - Main Page |
| 3 | +description: Dynamsoft Label Recognizer Parameter Reference - Main Page |
| 4 | +keywords: parameter reference, parameters, label recognition |
| 5 | +needAutoGenerateSidebar: false |
| 6 | +permalink: /parameters/reference/index-v3.0.0.html |
| 7 | +--- |
| 8 | + |
| 9 | +# Parameter Reference |
| 10 | + |
| 11 | +## Capture Vision Template |
| 12 | + |
| 13 | + | Parameter Name | Description | |
| 14 | + | ---------------------------------------------------------------------------- | ----------- | |
| 15 | + | [`ImageROIProcessingNameArray`]({{ site.dcv_parameters_reference }}capture-vision-template/image-roi-processing-name-array.html) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. | |
| 16 | + | [`ImageSourceName`]({{ site.dcv_parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | |
| 17 | + | [`MaxParallelTasks`]({{ site.dcv_parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | |
| 18 | + | [`OutputRawImage`]({{ site.dcv_parameters_reference }}capture-vision-template/output-raw-Image.html) | Indicates whether DCV finally outputs the original input image. | |
| 19 | + | [`SemanticProcessingNameArray`]({{ site.dcv_parameters_reference }}capture-vision-template/semantic-processing-name-array.html) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. | |
| 20 | + | [`Timeout`]({{ site.dcv_parameters_reference }}capture-vision-template/timeout.html) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. | |
| 21 | + |
| 22 | +## Target ROI Def |
| 23 | + |
| 24 | + | Parameter Name | Description | |
| 25 | + | ------------------------------------------------------------------------------------- | ----------- | |
| 26 | + | [`BaseTargetROIDefName`]({{ site.dcv_parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | |
| 27 | + | [`Location`]({{ site.dcv_parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | |
| 28 | + | [`PauseFlag`]({{ site.dcv_parameters_reference }}target-roi-def/pause-flag.html) | Indicates that the region results generated by this `TargetROIDef` will not be used by other `TargetROIDef` objects that depend on it to calculate the target regions, unless the user explicitly performs an update operation. | |
| 29 | + | [`TaskSettingNameArray`]({{ site.dcv_parameters_reference }}target-roi-def/task-setting-name-array.html) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `LabelRecognizerTaskSetting` objects. | |
| 30 | + |
| 31 | +## Label Recognizer Task Setting |
| 32 | + |
| 33 | + | Parameter Name | Description | |
| 34 | + | ------------------------------------------------------------------------------------------------------------------------- | ----------- | |
| 35 | + | [`BaseLabelRecognizerTaskSettingName`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/base-label-recognizer-task-setting-name.html) | Represents the name of another `LabelRecognizerTaskSetting` object to inherit from. | |
| 36 | + | [`DictionaryCorrectionThresholds`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-correction-thresholds.html) | Sets the threshold of dictionary error correction. | |
| 37 | + | [`DictionaryPath`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-path.html) | Sets the path of the dictionary file.| |
| 38 | + | [`StringLengthRange`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/string-length-range.html) | Sets the range of string lengths for concatenated strings of recognized text lines. | |
| 39 | + | [`StringRegExPattern`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/string-regex-pattern.html) | Specifies the regular expression pattern for concatenated strings of recognized text lines. | |
| 40 | + |
| 41 | +## TextLine Specification |
| 42 | + |
| 43 | +| Parameter Name | Description | |
| 44 | + | ------------------------------------------------------------------------------------- | ----------- | |
| 45 | + | [`ApplicableTextLineNumbers`]({{ site.dcv_parameters_reference }}text-line-specification/applicable-text-line-numbers.html) | Specifies the line numers of the targeting lines which are specified by the `TextLineSpecification` object. | |
| 46 | + | [`BaseTextLineSpecificationName`]({{ site.dcv_parameters_reference }}text-line-specification/base-text-line-specification-name.html) | Represents the name of another `TextLineSpecification` object to inherit from. | |
| 47 | + | [`CharHeightRange`]({{ site.dcv_parameters_reference }}text-line-specification/char-height-range.html) | Defines the range of the character height. | |
| 48 | + | [`CharacterModelName`]({{ site.dcv_parameters_reference }}text-line-specification/character-model-name.html) | Defines the name of the character model. | |
| 49 | + | [`CharacterNormalizationModes`]({{ site.dcv_parameters_reference }}text-line-specification/character-normalization-modes.html) | Defines an array of character normalization mode to implement. The array index represents the priority of the item. The smaller index is, the higher priority is. | |
| 50 | + | [`Text line position parameters`]({{ site.dcv_parameters_reference }}text-line-specification/position.html) | Defines the position of the text lines with the vertices points. | |
| 51 | + |
| 52 | +## Character Model |
| 53 | + |
| 54 | + | Parameter Name | Description | |
| 55 | + | ------------------------------------------------------------------------------------- | ----------- | |
| 56 | + | [`FilterFilePath`]({{ site.dcv_parameters_reference }}character-model/filter-file-path.html) | Defines the full path of the filter file which specifies the characters to be recognized. | |
| 57 | + |
| 58 | +## ImageParameter |
| 59 | + |
| 60 | + | Parameter Name | Description | |
| 61 | + | ---------------------------------------------------------------------------------------------------- | ----------- | |
| 62 | + | [`BaseImageParameterName`]({{ site.dcv_parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | |
| 63 | + | [`BinarizationModes`]({{ site.dcv_parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | |
| 64 | + | [`ColourChannelUsageType`]({{ site.dcv_parameters_reference }}image-parameter/colour-channel-usage-type.html) | Defines how to use the colour channel from the source image buffer. | |
| 65 | + | [`ColourConversionModes`]({{ site.dcv_parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | |
| 66 | + | [`GrayscaleEnhancementModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | |
| 67 | + | [`GrayscaleTransformationModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | |
| 68 | + | [`IfEraseTextZone`]({{ site.dcv_parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | |
| 69 | + | [`RegionPredetectionModes`]({{ site.dcv_parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. | |
| 70 | + | [`ScaleDownThreshold`]({{ site.dcv_parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | |
| 71 | + | [`ScaleUpModes`]({{ site.dcv_parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | |
| 72 | + | [`TextDetectionMode`]({{ site.dcv_parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | |
| 73 | + | [`TextureDetectionModes`]({{ site.dcv_parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | |
| 74 | + |
| 75 | +## Image Source Options |
| 76 | + |
| 77 | + | Parameter Name | Description | |
| 78 | + | ------------------------------------------------------------------------ | ----------- | |
| 79 | + | [`FileFilter`]({{ site.dcv_parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | |
| 80 | + | [`PDFReadingMode`]({{ site.dcv_parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | |
| 81 | + | [`Recursive`]({{ site.dcv_parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | |
| 82 | + | [`Type`]({{ site.dcv_parameters_reference }}image-source-options/type.html) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. | |
| 83 | + |
| 84 | +## Global Parameter |
| 85 | + |
| 86 | + | Parameter Name | Description | |
| 87 | + | ----------------------------------------------------------------------------------------- | ----------- | |
| 88 | + | [`MaxTotalImageDimension`]({{ site.dcv_parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory | |
| 89 | + |
| 90 | +## Shared Parameter |
| 91 | + |
| 92 | + | Parameter Name | Description | |
| 93 | + | ------------------------------------------------------------------------------------------------- | ----------- | |
| 94 | + | [`DirectoryPath`]({{ site.dcv_parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. | |
| 95 | + | [`MaxThreadsInOneTask`]({{ site.dcv_parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | |
| 96 | + | [`Name`]({{ site.dcv_parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | |
| 97 | + | [`SectionImageParameterArray`]({{ site.dcv_parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | |
| 98 | + | [`StartSection`]({{ site.dcv_parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | |
| 99 | + | [`TerminateSetting`]({{ site.dcv_parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | |
0 commit comments