diff --git a/_config.yml b/_config.yml index 7991ca8..2e441d3 100644 --- a/_config.yml +++ b/_config.yml @@ -3,6 +3,8 @@ repository: Dynamsoft-Docs/label-recognition-docs docFullPath: https://www.dynamsoft.com/label-recognition/docs/core firstLevelUrl: /label-recognition/docs/core docHomePage: /label-recognition/docs/core/introduction/ +needSearchIndex: true +searchNeedFilter: true introduction: /label-recognition/docs/core/introduction/ parameters: /label-recognition/docs/core/parameters/ @@ -62,6 +64,7 @@ license-activation: /label-recognition/docs/core/license-activation/ useVersionTree: false isDCV: true +useJSVersionV3: true baseurl: "/label-recognition/docs/core" diff --git a/_data/full_tree.yml b/_data/full_tree.yml deleted file mode 100644 index 4d16672..0000000 --- a/_data/full_tree.yml +++ /dev/null @@ -1,22 +0,0 @@ -tree_file_list: - - sidelist-full-tree.html - - sidelist-introduction.html - - sidelist-parameters/parameters-enumerations-v1.2.1.html - - sidelist-parameters/parameters-enumerations.html - - sidelist-parameters/parameters-references-v1.2.1.html - - sidelist-parameters/parameters-references.html - - sidelist-release-notes.html - - sidelist-license-activation.html - - sidelist-development-v1.2.1.html - - sidelist-development-v2.2.20.html - - sidelist-development.html - - sidelist-parameters-organization.html - - sidelist-parameters-reference-v3.0.0.html - - sidelist-parameters-reference-v3.0.10.html - - sidelist-parameters-reference-v3.0.30.html - - sidelist-parameters-reference-v3.2.10.html - - sidelist-parameters-reference-v3.2.30.html - - sidelist-parameters-reference.html - - sidelist-understanding.html - - sidelist-understanding-v2.2.20.html - - sidelist-useful.html diff --git a/_data/product_version.yml b/_data/product_version.yml deleted file mode 100644 index dff1670..0000000 --- a/_data/product_version.yml +++ /dev/null @@ -1,26 +0,0 @@ -useGroupedVersion: true - -version_info_list: - - value: latest version - - value: 3.x - child: - - 3.2.30 - - 3.2.20 - - 3.2.10 - - 3.2.0 - - 3.0.30 - - 3.0.20 - - 3.0.10 - - 3.0.0 - - value: 2.x - child: - - 2.2.20 - - 2.2.11 - - 2.2.10 - - 2.2.0 - - 2.0.0 - - value: 1.x - child: - - 1.2.1 - - 1.2 - - 1.0 diff --git a/_includes/dlrNav.html b/_includes/dlrNav.html deleted file mode 100644 index 70fefe3..0000000 --- a/_includes/dlrNav.html +++ /dev/null @@ -1,86 +0,0 @@ - - -
-
-
- -
-
-
-
- -
Documentation
-
-
-
-
-
-
-
- -
-
-
-
-
-
- diff --git a/_includes/release-notes/product-highlight-1.0.md b/_includes/release-notes/product-highlight-1.0.md deleted file mode 100644 index bbd7ba5..0000000 --- a/_includes/release-notes/product-highlight-1.0.md +++ /dev/null @@ -1,9 +0,0 @@ - - -- Supports text recognition from BMP, JPEG, PNG and single-page TIFF files. -- Supports zonal OCR and provides three ways to localize text areas: - - Pre-define an area manually in pixel or percentage. - - Specify an area relative to the barcode zone, which allows you to recognize accompanying texts near the barcode. - - Specify an area relative to blocks which share the same colour or uses the same font colour. A common example would be a price tag, where the text of interest is always on a yellow square background, the yellow square can serve as the reference region. -- Supports specifying a regular expression to improve recognition accuracy and robustness. - diff --git a/_includes/release-notes/product-highlight-1.2.md b/_includes/release-notes/product-highlight-1.2.md deleted file mode 100644 index 320a5d4..0000000 --- a/_includes/release-notes/product-highlight-1.2.md +++ /dev/null @@ -1,14 +0,0 @@ - - -- Added timeout mechanism. DLR checks at a few points whether the elapsed time for the current image is longer than its value. If so, DLR will end the flow. Timeout prevents one image from costing too much time. - -- Added parameters for lines filtering: - - `LineStringLengthRange` is used to define the minimum and maximum string length when running the recognition process on a specific line. - - `MaxLineCharacterSpacing` is used to control the spacing between characters treated as one line. - -- Improved the regular expression parameter by supporting more [RegEx pattern syntaxes]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - -- Improved the recognition accuracy when dealing with skewed and italics characters. - -- Improved the recognition accuracy for serif fonts. - diff --git a/_includes/release-notes/product-highlight-2.0.md b/_includes/release-notes/product-highlight-2.0.md deleted file mode 100644 index 65d6cfc..0000000 --- a/_includes/release-notes/product-highlight-2.0.md +++ /dev/null @@ -1,18 +0,0 @@ - - -- Added image processing modes to enhance the usage scenarios like MRZ reading: - - Texture area detection - - Color Conversion - - Binarization - - Grayscale image processing - -- Added dictionary-based correction. The dictionary is minimal and customizable to only cover a scenario-oriented vocabulary. - -- Improved the overall performance by replacing Caffe engine with OpenCV dnn engine - -- Improved the readability of recognizing skewed characters. - -- Improved the MRZ reading performance. - -- Added a `core` library. Migrated the core structs/classes from the LabelRecognizer library to the `core` library. - diff --git a/_includes/release-notes/product-highlight-2.2.md b/_includes/release-notes/product-highlight-2.2.md deleted file mode 100644 index 96e0012..0000000 --- a/_includes/release-notes/product-highlight-2.2.md +++ /dev/null @@ -1,8 +0,0 @@ - - -- Improved the performance of the MRZ scenario. The recognition speed is improved by about 70%. - -- Added character normalization modes to normalize the text. This feature will improve the read rate when processing the text in nonstandard fonts like dot matrix. - -- New parameter control and recognition methods are added to fit more usage scenarios. - diff --git a/_includes/release-notes/product-highlight-3.0.0.md b/_includes/release-notes/product-highlight-3.0.0.md deleted file mode 100644 index 2c9db35..0000000 --- a/_includes/release-notes/product-highlight-3.0.0.md +++ /dev/null @@ -1,16 +0,0 @@ - -`DynamsoftLabelRecognizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually. - -* `DynamsoftCaptureVision` architecture consists of: - * `ImageSourceAdapter(ISA)`, the standard input interface for you to convert image data from different sources into the standard input image data. In addition, `ISA` incorporates an image buffer management system that allows instant access to the buffered image data. - * `CaptureVisionRouter (CVR)`, an engine for you to update templates, retrieve images from `ISA`, coordinate corresponding functional products and dispatch the results to the receivers. - * Functional products that perform image processing, content understanding and semantic processing. The functional products are pluggable and passively called by CVR when they are required. - * Result receiver interfaces. You can implement `CapturedResultReceiver (CRR)` to receive the `CapturedResults` that output when the processing on an image is finalized. You can also implement `IntermediateResultReceiver (IRR)` to get timely results from different stages of the workflow. -* The parameter template system has been comprehensively upgraded. - * Multiple algorithm task settings are available. You can define barcode decoding, label recognizing, document scanning and semantic processing tasks in one template file. - * Extended the feature of the ROI system. By configuring the `target ROI` parameters, you can not only specify an `ROI` on the original image but also define the dependencies of the algorithm tasks. This feature enables you to customize the workflow when processing complex scenarios. - * The image processing parameters are separated from the task parameters so that the template settings become more clear and concise. -* The `intermediate result` system has been improved. - * Achieved the `intermediate result` sharing between different functional products. The results that have the same image source and processing parameters are directly reused, which speeds up the image processing workflow. You don’t need to add any additional code to enable the `intermediate result` sharing. The library can recognize all the reusable results automatically based on the template file you uploaded. - * The readability and interactivity of the `intermediate results` are enhanced. `IntermediateResultReceiver` allows you to receive up to 27 different types of `Intermediate results`. You can clearly read which stage of the algorithm each result is output from. In addition, `IntermediateResultManager` allows you to intervene in the workflows by modifying the `intermediate results`. - diff --git a/_includes/release-notes/product-highlight-3.2.0.md b/_includes/release-notes/product-highlight-3.2.0.md deleted file mode 100644 index b52f37c..0000000 --- a/_includes/release-notes/product-highlight-3.2.0.md +++ /dev/null @@ -1,10 +0,0 @@ - - -- Introduced the capability for users to influence the image processing process by altering intermediate results. Users can now clone, edit, and substitute intermediate result units within the callback function of each type. Subsequent operations will then proceed based on the updated unit. -- Introduced a feature for multi-condition filtering across products. Users can now specify filtering criteria for the task results of a `TargetROIDef` by implementing an `OutputTaskSetting` based on the task results of varying products from descendant `TargetROIDef` objects. -- Enhanced the `Offset` parameter in `TargetROIDef`. Users now have the capability to meticulously customize components of the coordinate system, including the origin, X-axis, and Y-axis, for precise offset calculation. -- Introduced a feature for grouping text lines. A text line group consists of spatially adjacent lines of text. Through the `TextLineSpecification` parameters, users can now do two things: - - Put text lines in groups and also define the spatial relationship between different groups; - - Specify whether to concatenate text line results within a group, how to do the concatenation and whether to output the concatenated result. - - diff --git a/_includes/release-notes/product-highlight-3.4.10.md b/_includes/release-notes/product-highlight-3.4.10.md deleted file mode 100644 index 0654da0..0000000 --- a/_includes/release-notes/product-highlight-3.4.10.md +++ /dev/null @@ -1,4 +0,0 @@ - - -- Added a new algorithm stage `IRUT_RAW_TEXT_LINES`. Corresponding APIs are added to obtain the intermediate result of this stage. - diff --git a/_includes/sidelist-development-v1.2.1.html b/_includes/sidelist-development-v1.2.1.html deleted file mode 100644 index a812fd7..0000000 --- a/_includes/sidelist-development-v1.2.1.html +++ /dev/null @@ -1,18 +0,0 @@ -
  • DEVELOPMENT
  • -
  • - Web (Client Side)
  • -
  • - Mobile - -
  • -
  • - Server / Desktop - -
  • \ No newline at end of file diff --git a/_includes/sidelist-development-v2.2.20.html b/_includes/sidelist-development-v2.2.20.html deleted file mode 100644 index 07e7239..0000000 --- a/_includes/sidelist-development-v2.2.20.html +++ /dev/null @@ -1,19 +0,0 @@ -
  • DEVELOPMENT
  • -
  • - Web (Client Side)
  • -
  • - Mobile - -
  • -
  • - Server / Desktop - -
  • \ No newline at end of file diff --git a/_includes/sidelist-development.html b/_includes/sidelist-development.html deleted file mode 100644 index 4d2d29a..0000000 --- a/_includes/sidelist-development.html +++ /dev/null @@ -1,18 +0,0 @@ -
  • DEVELOPMENT
  • -
  • - Web (Client Side)
  • -
  • - Mobile - -
  • -
  • - Server / Desktop - -
  • \ No newline at end of file diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html deleted file mode 100644 index 7be5ca4..0000000 --- a/_includes/sidelist-full-tree.html +++ /dev/null @@ -1,4 +0,0 @@ -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-development.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-understanding.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-useful.html" -%} diff --git a/_includes/sidelist-introduction.html b/_includes/sidelist-introduction.html deleted file mode 100644 index 6546aec..0000000 --- a/_includes/sidelist-introduction.html +++ /dev/null @@ -1,3 +0,0 @@ -
  • - Introduction -
  • \ No newline at end of file diff --git a/_includes/sidelist-license-activation.html b/_includes/sidelist-license-activation.html deleted file mode 100644 index 62ec1f7..0000000 --- a/_includes/sidelist-license-activation.html +++ /dev/null @@ -1,2 +0,0 @@ -
  • License Activation -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-organization.html b/_includes/sidelist-parameters-organization.html deleted file mode 100644 index 5c8d217..0000000 --- a/_includes/sidelist-parameters-organization.html +++ /dev/null @@ -1,16 +0,0 @@ -
  • Parameter Organization - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v3.0.0.html b/_includes/sidelist-parameters-reference-v3.0.0.html deleted file mode 100644 index 9dd8436..0000000 --- a/_includes/sidelist-parameters-reference-v3.0.0.html +++ /dev/null @@ -1,84 +0,0 @@ -
  • Parameter Reference - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v3.0.10.html b/_includes/sidelist-parameters-reference-v3.0.10.html deleted file mode 100644 index 5599ada..0000000 --- a/_includes/sidelist-parameters-reference-v3.0.10.html +++ /dev/null @@ -1,87 +0,0 @@ -
  • Parameter Reference - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v3.0.30.html b/_includes/sidelist-parameters-reference-v3.0.30.html deleted file mode 100644 index b9b26e1..0000000 --- a/_includes/sidelist-parameters-reference-v3.0.30.html +++ /dev/null @@ -1,101 +0,0 @@ -
  • Parameter Reference - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v3.2.10.html b/_includes/sidelist-parameters-reference-v3.2.10.html deleted file mode 100644 index a8b288e..0000000 --- a/_includes/sidelist-parameters-reference-v3.2.10.html +++ /dev/null @@ -1,101 +0,0 @@ -
  • Parameter Reference - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v3.2.30.html b/_includes/sidelist-parameters-reference-v3.2.30.html deleted file mode 100644 index c9c9953..0000000 --- a/_includes/sidelist-parameters-reference-v3.2.30.html +++ /dev/null @@ -1,105 +0,0 @@ -
  • Parameter Reference - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference.html b/_includes/sidelist-parameters-reference.html deleted file mode 100644 index e856f4e..0000000 --- a/_includes/sidelist-parameters-reference.html +++ /dev/null @@ -1,106 +0,0 @@ -
  • Parameter Reference - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters/parameters-enumerations-v1.2.1.html b/_includes/sidelist-parameters/parameters-enumerations-v1.2.1.html deleted file mode 100644 index 3196558..0000000 --- a/_includes/sidelist-parameters/parameters-enumerations-v1.2.1.html +++ /dev/null @@ -1,7 +0,0 @@ -
  • Enumerations - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters/parameters-enumerations.html b/_includes/sidelist-parameters/parameters-enumerations.html deleted file mode 100644 index b1b2bf5..0000000 --- a/_includes/sidelist-parameters/parameters-enumerations.html +++ /dev/null @@ -1,30 +0,0 @@ -
  • Enumerations - -
  • \ No newline at end of file diff --git a/_includes/sidelist-parameters/parameters-references-v1.2.1.html b/_includes/sidelist-parameters/parameters-references-v1.2.1.html deleted file mode 100644 index 19445d6..0000000 --- a/_includes/sidelist-parameters/parameters-references-v1.2.1.html +++ /dev/null @@ -1,33 +0,0 @@ -
  • Parameter Reference - -
  • diff --git a/_includes/sidelist-parameters/parameters-references.html b/_includes/sidelist-parameters/parameters-references.html deleted file mode 100644 index a7140f6..0000000 --- a/_includes/sidelist-parameters/parameters-references.html +++ /dev/null @@ -1,38 +0,0 @@ -
  • Parameter Reference - -
  • diff --git a/_includes/sidelist-release-notes.html b/_includes/sidelist-release-notes.html deleted file mode 100644 index 4ba0145..0000000 --- a/_includes/sidelist-release-notes.html +++ /dev/null @@ -1,2 +0,0 @@ -
  • Release Notes -
  • \ No newline at end of file diff --git a/_includes/sidelist-understanding-v2.2.20.html b/_includes/sidelist-understanding-v2.2.20.html deleted file mode 100644 index 3e7bb81..0000000 --- a/_includes/sidelist-understanding-v2.2.20.html +++ /dev/null @@ -1,3 +0,0 @@ -
  • UNDERSTANDING DLR
  • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters/parameters-references.html" -%} - diff --git a/_includes/sidelist-understanding.html b/_includes/sidelist-understanding.html deleted file mode 100644 index 5f0e33b..0000000 --- a/_includes/sidelist-understanding.html +++ /dev/null @@ -1,4 +0,0 @@ -
  • UNDERSTANDING DLR
  • - -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-organization.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-reference.html" -%} diff --git a/_includes/sidelist-useful.html b/_includes/sidelist-useful.html deleted file mode 100644 index 266dda2..0000000 --- a/_includes/sidelist-useful.html +++ /dev/null @@ -1,3 +0,0 @@ -
  • USEFUL RESOURCES
  • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-license-activation.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%} diff --git a/_layouts/default-layout-OLD.html b/_layouts/default-layout-OLD.html deleted file mode 100644 index 1473461..0000000 --- a/_layouts/default-layout-OLD.html +++ /dev/null @@ -1,127 +0,0 @@ - - - -{%- include head.html -%} -{%- assign noTitleIndex = "" -%} -{%- if page.noTitleIndex or page.url contains 'release-notes' -%} - {%- assign noTitleIndex = "noTitleIndex" -%} -{%- endif -%} - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include dlrNav.html -%} -
    Table of contents
    -
    -
    -
    -
    - {%- include main-page-head.html -%} -
    -
    -
    -
    -

    Thanks for downloading Dynamsoft Label Recognizer Package!

    -

    Your download will start shortly. If your download does not begin, click here to retry.

    -
    - {{ content }} - -
    -
    -
    -

    This page is compatible for:

    -

    Version 7.5.0

    -
    -
    -

    Is this page helpful?

    - YesYes - NoNo -
    -
    {%- if page.needAutoGenerateSidebar -%} -

    In this article:

    -
    - {%- endif -%} -
    -
    - -
    - -
    -
    -
    -
    -
    - {%- include liquid_autoGenerateHistoryList.html -%} {%- include auto-version-list.html -%} -
    -
    -
    - - - - - - {%- include livehelp.html -%} - - - - - - - - - - - - diff --git a/_layouts/developing.html b/_layouts/developing.html deleted file mode 100644 index 0c9314f..0000000 --- a/_layouts/developing.html +++ /dev/null @@ -1,93 +0,0 @@ - - - -{%- include head.html -%} - - -
    - {%- include page_header.html -%} -
    -
    -
    -
    - -
    -
    -
    -
    -
    - -
    -
    - {%- include main-page-head.html -%} -
    -
    -
    -

    in the process of development

    -

    Back to Homepage

    - {{ content }} -
    -
    -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - {%- if page.needAutoGenerateSidebar -%} - - {%- else -%} - - {%- endif -%} - - - - - - diff --git a/_layouts/home-page.html b/_layouts/home-page.html deleted file mode 100644 index 89aa900..0000000 --- a/_layouts/home-page.html +++ /dev/null @@ -1,50 +0,0 @@ - - - -{%- include head.html -%} - - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - -
    -
    -
    - - {{ content }} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - - diff --git a/_layouts/search-page-OLD.html b/_layouts/search-page-OLD.html deleted file mode 100644 index 336ae2d..0000000 --- a/_layouts/search-page-OLD.html +++ /dev/null @@ -1,313 +0,0 @@ - - - -{%- include head.html -%} - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - -
    -
    - -
    -
    -
    - -
    Documentation
    -
    -
    -
    -
    -
    -
    -
    - -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -

    Search

    - - -
    -
    -
    - -
    -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - {%- if page.needAutoGenerateSidebar -%} - {%- unless page.needGenerateH3Content -%} - - {%- else -%} - - {%- endunless -%} - {%- else -%} - - {%- endif -%} - - - - {%- include livehelp.html -%} - - - \ No newline at end of file diff --git a/assets/js/dlrCoreVersionSearch.json b/assets/js/dlrCoreVersionSearch.json deleted file mode 100644 index b9cea2f..0000000 --- a/assets/js/dlrCoreVersionSearch.json +++ /dev/null @@ -1,268 +0,0 @@ -[ - { - "version": "3.4.10", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.4.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.4.10" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.4.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.40" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.4.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.40" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.4.10" - } - ] - } - },{ - "version": "3.2.30", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.30" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.30" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.30" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.30" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.30" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.30" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.30" - } - ] - } - },{ - "version": "3.2.20", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.20" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.20" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.20" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.20" - } - ] - } - },{ - "version": "3.2.10", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - } - ] - } - },{ - "version": "3.2.0", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.0" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.0" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.0" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.0" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.0" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.0" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.0" - } - ] - } - },{ - "version": "3.0.30", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.30" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.30" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.30" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.30" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.30" - },{ - "path": "/parameters/reference/image-source-options", - "version": "2.0.30" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.30" - },{ - "path": "/parameters/reference/character-model", - "version": "3.0.30" - } - ] - } - }, - { - "version": "3.0.20", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.20" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.20" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.20" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.20" - },{ - "path": "/parameters/reference/character-model", - "version": "3.0.20" - } - ] - } - },{ - "version": "3.0.10", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.10" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.10" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.10" - },{ - "path": "/parameters/reference/character-model", - "version": "3.0.10" - } - ] - } - },{ - "version": "3.0.0", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.0" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.0" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.0" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.0" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.0" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.0" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.0" - },{ - "path": "/parameters/reference/character-model", - "version": "3.0.0" - } - ] - } - } -] \ No newline at end of file diff --git a/index-v1.2.1.md b/index-v1.2.1.md deleted file mode 100644 index d72f85d..0000000 --- a/index-v1.2.1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: home-page -title: Dynamsoft Label Recognition SDK Documentation -keywords: dynamsoft label recognition, dlr, documentation -description: Dynamsoft Label Recognition SDK Documentation Homepage -needAutoGenerateSidebar: true ---- - -# Dynamsoft Label Recognition Documentation - -* [Introduction]({{ site.introduction }}) - -
    -DEVELOPMENT -
    - -* [Web (Client Side)]({{ site.javascript }}) -* Mobile - * [Android]({{ site.android }}) - * [iOS]({{ site.objectivec-swift }}) -* Server / Desktop - * [Java]({{ site.java }}) - * [C\#]({{ site.dotnet }}) - * [C++]({{ site.cpp }}) - * [C]({{ site.c }}) - -
    -UNDERSTANDING DDN -
    - -* [Parameter Reference]({{ site.parameters-reference }}) -* [Enumerations]({{ site.enumerations }}) - -
    -USEFUL RESOURCES -
    - -* [Release Notes]({{ site.release_notes }}) -* [License Activation]({{ site.license }}license-activation.html) diff --git a/index-v1.2.md b/index-v1.2.md deleted file mode 100644 index 381aab1..0000000 --- a/index-v1.2.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: home-page -title: Dynamsoft Label Recognition SDK Documentation -keywords: dynamsoft label recognition, dlr, documentation -description: Dynamsoft Label Recognition SDK Documentation Homepage -needAutoGenerateSidebar: true ---- - -# Dynamsoft Label Recognition Documentation - -* [Introduction]({{ site.introduction }}) - -
    -DEVELOPMENT -
    - -* Mobile - * [Android]({{ site.android }}) - * [iOS]({{ site.objectivec-swift }}) -* Server / Desktop - * [C\#]({{ site.dotnet }}) - * [C++]({{ site.cpp }}) - * [C]({{ site.c }}) - -
    -UNDERSTANDING DDN -
    - -* [Parameter Reference]({{ site.parameters-reference }}) -* [Enumerations]({{ site.enumerations }}) - -
    -USEFUL RESOURCES -
    - -* [Release Notes]({{ site.release_notes }}) -* [License Activation]({{ site.license }}license-activation.html) diff --git a/index.md b/index.md deleted file mode 100644 index f31149c..0000000 --- a/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: home-page -title: Dynamsoft Label Recognizer SDK Documentation -keywords: dynamsoft label recognizer, dlr, documentation -description: Dynamsoft Label Recognizer SDK Documentation Homepage -needAutoGenerateSidebar: true ---- - -# Dynamsoft Label Recognizer Documentation - -* [Introduction]({{ site.introduction }}) - -
    -DEVELOPMENT -
    - -* [Web (Client Side)]({{ site.js }}) -* Mobile - * [Android]({{ site.android }}) - * [iOS]({{ site.objectivec-swift }}) -* Server / Desktop - * [Java]({{ site.java }}) - * [.NET]({{ site.dotnet }}) - * [C++]({{ site.cpp }}) - * [C]({{ site.c }}) - -
    -UNDERSTANDING DLR -
    - -* [Parameter Organization]({{ site.dcv_parameters }}file/index.html) -* [Parameter Reference]({{ site.dcv_parameters_reference }}) - -
    -USEFUL RESOURCES -
    - -* [Release Notes]({{ site.release_notes }}) -* [License Activation]({{ site.license }}license-activation.html) diff --git a/license-activation/index-v2.2.20.md b/license-activation/index-v2.2.20.md deleted file mode 100644 index 98e8181..0000000 --- a/license-activation/index-v2.2.20.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -layout: default-layout -title: License initialization - Dynamsoft Label Recognizer -description: This is the documentation - License initialization page of Dynamsoft Label Recognizer. -keywords: Label Recognizer, License initialization -needAutoGenerateSidebar: true -breadcrumbText: License Initialization ---- - -# License initialization - -## Get a trial key - -- A free public trial license is available for every new device for first use of Dynamsoft Label Recognizer. The public trial license is the default key used in samples. You can also find the public trial license on the following parts of this page. -- If your free key is expired, please visit Private Trial License Page to get a 30-day trial extension. - -## Get a full license - -- [Contact us](https://www.dynamsoft.com/company/contact/) to purchase a full license - -## Initialize the license - -The following code snippets are using the public trial license to initialize the license. You can replace the public trial license with your own license key. - -
    ->- JavaScript ->- Java-Android ->- Objective-C ->- Swift ->- C ->- C++ ->- C# ->- Java -> ->1. -```javascript -Dynamsoft.DLR.LabelRecognizer.license = "YOUR-LICENSE-KEY"; -``` -2. -```java -LabelRecognizer.initLicense("YOUR-LICENSE-KEY", new DLRLicenseVerificationListener() { - @Override - public void DLRLicenseVerificationCallback(boolean b, Exception e) { - if(!b && e != null){ - e.printStackTrace(); - } - } -}); -``` -3. -```objc -[DynamsoftLabelRecognizer initLicense:@"YOUR-LICENSE-KEY" verificationDelegate:self]; -- (void)DLRLicenseVerificationCallback:(bool)isSuccess error:(NSError *)error{ - if(!isSuccess && error != nil){ - NSString* msg = error.userInfo[NSUnderlyingErrorKey]; - NSLog(@"%@", msg); - } -} -``` -4. -```swift -DynamsoftLabelRecognizer.initLicense("YOUR-LICENSE-KEY",verificationDelegate:self) -func dlrLicenseVerificationCallback(_ isSuccess: Bool, error: Error?) { - if(!isSuccess && error != nil){ - let err = error as NSError? - let msg = err!.userInfo[NSUnderlyingErrorKey] as? String - print(msg ?? "") - } -} -``` -5. -```c -char errorMessage[256]; -DLR_InitLicense("YOUR-LICENSE-KEY", errorMessage, 256); -``` -6. -```cpp -char errorMessage[256]; -CLabelRecognizer::InitLicense("YOUR-LICENSE-KEY", errorMessage, 256); -``` -7. -```csharp -LabelRecognizer.InitLicense("YOUR-LICENSE-KEY"); -``` -8. -```java -LabelRecognizer.initLicense("YOUR-LICENSE-KEY"); -``` - diff --git a/license-activation/index.md b/license-activation/index.md deleted file mode 100644 index 3b27dca..0000000 --- a/license-activation/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -layout: default-layout -title: License initialization - Dynamsoft Label Recognizer -description: This is the documentation - License initialization page of Dynamsoft Label Recognizer. -keywords: Label Recognizer, License initialization -needAutoGenerateSidebar: true -breadcrumbText: License Initialization ---- - -# License initialization - -## Get a trial key - -- A free public trial license is available for every new device for first use of Dynamsoft Label Recognizer. The public trial license is the default key used in samples. You can also find the public trial license on the following parts of this page. -- If your free key is expired, please visit Private Trial License Page to get a 30-day trial extension. - -## Get a full license - -- [Contact us](https://www.dynamsoft.com/company/contact/) to purchase a full license - -## Initialize the license - -The following code snippets are using the public trial license to initialize the license. You can replace the public trial license with your own license key. - -
    ->- JavaScript ->- Java-Android ->- Objective-C ->- Swift ->- C ->- C++ ->- C# ->- Java -> ->1. -```javascript -Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9"); -``` -2. -```java -LicenseManager.initLicense("YOUR-LICENSE-KEY", this, (isSuccess, error) -> { - if (!isSuccess) { - error.printStackTrace(); - } -}); -``` -3. -```objc -[DSLicenseManager initLicense:@"DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" verificationDelegate:self]; -- (void)onLicenseVerified:(BOOL)isSuccess error:(nullable NSError *)error { - if (!isSuccess && error != nil) { - NSLog(@"error: %@", error); - } -} -``` -4. -```swift -LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", verificationDelegate: self) -func onLicenseVerified(_ isSuccess: Bool, error: Error?) { - if !isSuccess { - if let error = error { - print("\(error.localizedDescription)") - } - } -} -``` -5. -```c -char errorMessage[256]; -DLR_InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9", errorMessage, 256); -``` -6. -```cpp -char errorMessage[256]; -CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9", errorMessage, 256); -``` -7. -```csharp -LabelRecognizer.InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9"); -``` -8. -```java -LabelRecognizer.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9"); -``` - diff --git a/parameters/enum/barcode-format-2.md b/parameters/enum/barcode-format-2.md deleted file mode 100644 index 77787bf..0000000 --- a/parameters/enum/barcode-format-2.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - BarcodeFormat_2 -description: This article shows the BarcodeFormat_2 enumeration of Dynamsoft Core. -keywords: enumerations, BarcodeFormat_2 -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# BarcodeFormat_2 -Describes the barcode types in BarcodeFormat group 2. ->Note: The barcode format our library supported is composed of [BarcodeFormat group 1](barcode-format.md) and [BarcodeFormat group 2](#barcodeformat_2), so you need to specify the barcode format in group 1 and group 2 individually. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum BarcodeFormat_2` | -| .Net | `enum Dynamsoft.Core.EnumBarcodeFormat_2` | -| Android | `class com.dynamsoft.core.EnumBarcodeFormat_2` | -| ObjC / Swift | `enum EnumBarcodeFormat_2` | -| Java | `class com.dynamsoft.core.EnumBarcodeFormat_2` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| BF2_POSTALCODE | EnumBarcodeFormat2POSTALCODE | 0x01F00000 | Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC. | -| BF2_NULL | EnumBarcodeFormat2NULL | 0x00 | No barcode format in [BarcodeFormat group 2](#barcodeformat_2). | -| BF2_NONSTANDARD_BARCODE | EnumBarcodeFormat2NONSTANDARDBARCODE | 0x01 | Nonstandard barcode | -| BF2_USPSINTELLIGENTMAIL | EnumBarcodeFormat2USPSINTELLIGENTMAIL | 0x00100000 | USPS Intelligent Mail | -| BF2_POSTNET | EnumBarcodeFormat2POSTNET | 0x00200000 | Postnet | -| BF2_PLANET | EnumBarcodeFormat2PLANET | 0x00400000 | Planet | -| BF2_AUSTRALIANPOST | EnumBarcodeFormat2AUSTRALIANPOST | 0x00800000 | Australian Post | -| BF2_RM4SCC | EnumBarcodeFormat2RM4SCC | 0x01000000 | Royal Mail 4-State Customer Barcode | -| BF2_DOTCODE | EnumBarcodeFormat2DOTCODE | 0x02 | DotCode | diff --git a/parameters/enum/barcode-format.md b/parameters/enum/barcode-format.md deleted file mode 100644 index 2c1c2dd..0000000 --- a/parameters/enum/barcode-format.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - BarcodeFormat -description: This article shows the BarcodeFormat enumeration of Dynamsoft Core. -keywords: enumerations, BarcodeFormat -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# BarcodeFormat - -Describes the barcode types in BarcodeFormat group 1. All the formats can be combined, such as BF_CODE_39 | BF_CODE_128. ->Note: The barcode format our library supported is composed of [BarcodeFormat group 1](#barcodeformat) and [BarcodeFormat group 2](barcode-format-2.md), so you need to specify the barcode format in group 1 and group 2 individually. - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum BarcodeFormat` | -| .Net | `enum Dynamsoft.Core.EnumBarcodeFormat ` | -| Android | `class com.dynamsoft.core.EnumBarcodeFormat` | -| ObjC / Swift | `enum EnumBarcodeFormat` | -| Java | `class com.dynamsoft.core.EnumBarcodeFormat` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| BF_ALL | EnumBarcodeFormatALL | -31457281 | All supported formats in [BarcodeFormat group 1](#barcodeformat). | -| BF_ONED | EnumBarcodeFormatONED | 0x001007FF | Combined value of BF_CODABAR, BF_CODE_128, BF_CODE_39, BF_CODE_39_Extended, BF_CODE_93, BF_EAN_13, BF_EAN_8, INDUSTRIAL_25, BF_ITF, BF_UPC_A, BF_UPC_E, BF_MSI_CODE. | -| BF_GS1_DATABAR | EnumBarcodeFormatGS1DATABAR | 0x0003F800 | Combined value of BF_GS1_DATABAR_OMNIDIRECTIONAL, BF_GS1_DATABAR_TRUNCATED, BF_GS1_DATABAR_STACKED, BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, BF_GS1_DATABAR_EXPANDED, BF_GS1_DATABAR_EXPANDED_STACKED, BF_GS1_DATABAR_LIMITED. | -| BF_NULL | EnumBarcodeFormatNULL | 0x00 | No barcode format in [BarcodeFormat group 1](#barcodeformat). | -| BF_CODE_39 | EnumBarcodeFormatCODE39 | 0x01 | Code 39 | -| BF_CODE_128 | EnumBarcodeFormatCODE128 | 0x02 | Code 128 | -| BF_CODE_93 | EnumBarcodeFormatCODE93 | 0x04 | Code 93 | -| BF_CODABAR | EnumBarcodeFormatCODABAR | 0x08 | Codabar | -| BF_ITF | EnumBarcodeFormatITF | 0x10 | ITF | -| BF_EAN_13 | EnumBarcodeFormatEAN13 | 0x20 | EAN-13 | -| BF_EAN_8 | EnumBarcodeFormatEAN8 | 0x40 | EAN-8 | -| BF_UPC_A | EnumBarcodeFormatUPCA | 0x80 | UPC-A | -| BF_UPC_E | EnumBarcodeFormatUPCE | 0x100 | UPC-E | -| BF_INDUSTRIAL_25 | EnumBarcodeFormatINDUSTRIAL | 0x200 | Industrial 2 of 5 | -| BF_MSI_CODE | EnumBarcodeFormatMSICODE | 0x100000 | MSI Code | -| BF_CODE_39_EXTENDED | EnumBarcodeFormatCODE39EXTENDED | 0x400 | Code 39 Extended | -| BF_GS1_DATABAR_OMNIDIRECTIONAL | EnumBarcodeFormatGS1DATABAROMNIDIRECTIONAL | 0x800 | GS1 Databar Omnidirectional | -| BF_GS1_DATABAR_TRUNCATED | EnumBarcodeFormatGS1DATABARTRUNCATED | 0x1000 | GS1 Databar Truncated | -| BF_GS1_DATABAR_STACKED | EnumBarcodeFormatGS1DATABARSTACKED | 0x2000 | GS1 Databar Stacked | -| BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL | EnumBarcodeFormatGS1DATABARSTACKEDOMNIDIRECTIONAL | 0x4000 | GS1 Databar Stacked Omnidirectional | -| BF_GS1_DATABAR_EXPANDED | EnumBarcodeFormatGS1DATABAREXPANDED | 0x8000 | GS1 Databar Expanded | -| BF_GS1_DATABAR_EXPANDED_STACKED | EnumBarcodeFormatGS1DATABAREXPANDEDSTACKED | 0x10000 | GS1 Databar Expaned Stacked | -| BF_GS1_DATABAR_LIMITED | EnumBarcodeFormatGS1DATABARLIMITED | 0x20000 | GS1 Databar Limited | -| BF_PATCHCODE | EnumBarcodeFormatPATCHCODE | 0x00040000 | Patch code | -| BF_MICRO_PDF417 | EnumBarcodeFormatMICROPDF417 | 0x00080000 | Micro PDF417 | -| BF_PDF417 | EnumBarcodeFormatPDF417 | 0x02000000 | PDF417 | -| BF_QR_CODE | EnumBarcodeFormatQRCODE | 0x04000000 | QRCode | -| BF_DATAMATRIX | EnumBarcodeFormatDATAMATRIX | 0x08000000 | DataMatrix | -| BF_AZTEC | EnumBarcodeFormatAZTEC | 0x10000000 | AZTEC | -| BF_MAXICODE | EnumBarcodeFormatMAXICODE | 0x20000000 | MAXICODE | -| BF_MICRO_QR | EnumBarcodeFormatMICROQR | 0x40000000 | Micro QR Code | -| BF_GS1_COMPOSITE | EnumBarcodeFormatGS1COMPOSITE | -2147483648 | GS1 Composite Code | diff --git a/parameters/enum/binarization-mode.md b/parameters/enum/binarization-mode.md deleted file mode 100644 index 35da182..0000000 --- a/parameters/enum/binarization-mode.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - BinarizationMode -description: This article shows the BinarizationMode enumeration of Dynamsoft Core. -keywords: enumerations, BinarizationMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# BinarizationMode -Describes the binarization mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRBinarizationMode` | -| C / C++ | `enum BinarizationMode` | -| .Net | `enum Dynamsoft.Core.EnumBinarizationMode` | -| Android | `class com.dynamsoft.core.EnumBinarizationMode` | -| ObjC / Swift | `enum EnumBinarizationMode` | -| Java | `class com.dynamsoft.core.EnumBinarizationMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| BM_SKIP | EnumBinarizationModeSkip | 0x00 | Skips the binarization. | `N/A` | -| BM_AUTO | EnumBinarizationModeAuto | 0x01 | **Not supported yet.** | `N/A` | -| BM_LOCAL_BLOCK | EnumBinarizationModeLocalBlock | 0x02 | Binarizes the image based on the local block. | [`BlockSizeX`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#blocksizex)
    [`BlockSizeY`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#blocksizey)
    [`EnableFillBinaryVacancy`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#enablefillbinaryvacancy)
    [`ThreshValueCoefficient`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#threshvaluecoefficient)
    | -| BM_THRESHOLD | EnumBinarizationModeThreshold | 0x04 | Binarizes the image based on given threshold. | [`BinarizationThreshold`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#binarizationThreshold) | - diff --git a/parameters/enum/colour-conversion-mode.md b/parameters/enum/colour-conversion-mode.md deleted file mode 100644 index 2421eaa..0000000 --- a/parameters/enum/colour-conversion-mode.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - ColourConversionMode -description: This article shows the ColourConversionMode enumeration of Dynamsoft Core. -keywords: enumerations, ColourConversionMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - - - -# ColourConversionMode -Describes the colour conversion mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRColourConversionMode` | -| C / C++ | `enum ColourConversionMode` | -| .Net | `enum Dynamsoft.Core.EnumColourConversionMode` | -| Android | `class com.dynamsoft.core.EnumColourConversionMode` | -| ObjC / Swift | `enum EnumColourConversionMode` | -| Java | `class com.dynamsoft.core.EnumColourConversionMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| CICM_SKIP | EnumColourConversionModeSkip | 0x00 | Skip the colour conversion. | `N/A` | -| CICM_GENERAL | EnumColourConversionModeGeneral | 0x01 | Converts a colour image to a grayscale image using the general algorithm. | [`BlueChannelWeight`]({{ site.parameters-reference }}label-recognition-parameter/colour-conversion-modes.html#bluechannelweight)
    [`GreenChannelWeight`]({{ site.parameters-reference }}label-recognition-parameter/colour-conversion-modes.html#greenchannelweight)
    [`RedChannelWeight`]({{ site.parameters-reference }}label-recognition-parameter/colour-conversion-modes.html#redchannelweight) | -| CICM_HSV | EnumColourConversionModeHSV | 0x02 | Converts a colour image to a grayscale image using one of the HSV channels. | [`ReferChannel`]({{ site.parameters-reference }}label-recognition-parameter/colour-conversion-modes.html#referchannel) | diff --git a/parameters/enum/dm-charge-way.md b/parameters/enum/dm-charge-way.md deleted file mode 100644 index 8b7edcd..0000000 --- a/parameters/enum/dm-charge-way.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - DM_ChargeWay -description: This article shows the DM_ChargeWay enumeration of Dynamsoft Core. -keywords: enumerations, DM_ChargeWay -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# DM_ChargeWay -Describes charge way. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_ChargeWay` | -| .Net | `enum Dynamsoft.Core.EnumDMChargeWay` | -| Android | `class com.dynamsoft.core.EnumDMChargeWay` | -| ObjC / Swift | `enum EnumDMChargeWay` | -| Java | `class com.dynamsoft.core.EnumDMChargeWay` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_CW_AUTO | EnumDMChargeWayAuto | 0 | The charge way automatically determined by the license server. | -| DM_CW_DEVICE_COUNT | EnumDMChargeWayDeviceCount | 1 | Charges by the count of devices. | -| DM_CW_SCAN_COUNT | EnumDMChargeWayScanCount | 2 | Charges by the count of barcode scans.| -| DM_CW_CONCURRENT_DEVICE_COUNT | EnumDMChargeWayConcurrentDeviceCount | 3 | Charges by the count of concurrent devices. | -| DM_CW_APP_DOMAIN_COUNT | EnumDMChargeWayAppDomainCount | 6 | Charges by the count of app domains. | -| DM_CW_ACTIVE_DEVICE_COUNT | EnumDMChargeWayActiveDeviceCount | 8 | Charges by the count of active devices. | -| DM_CW_INSTANCE_COUNT | EnumDMChargeWayInstanceCount | 9 | Charges by the count of instances. | -| DM_CW_CONCURRENT_INSTANCE_COUNT | EnumDMChargeWayConcurrentInstanceCount | 10 | Charges by the count of concurrent instances. | - diff --git a/parameters/enum/dm-deployment-type.md b/parameters/enum/dm-deployment-type.md deleted file mode 100644 index 22ec77f..0000000 --- a/parameters/enum/dm-deployment-type.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - DM_DeploymentType -description: This article shows the DM_DeploymentType enumeration of Dynamsoft Core. -keywords: enumerations, DM_DeploymentType -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# DM_DeploymentType -Describes the deployment type. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_DeploymentType` | -| .Net | `enum EnumDMDeploymentType` | -| Android | `N/A` | -| ObjC / Swift | `N/A` | -| Java | `N/A` | - - -## Members - -| Member | Value | Description | -| -------------------------- | ----- | ----------- | -| DM_DT_SERVER | 1 | Server deployment type | -| DM_DT_DESKTOP | 2 | Desktop | -| DM_DT_EMBEDDED_DEVICE | 6 | Embedded device deployment type | -| DM_DT_OEM | 7 | OEM deployment type | diff --git a/parameters/enum/dm-license-module.md b/parameters/enum/dm-license-module.md deleted file mode 100644 index 5316677..0000000 --- a/parameters/enum/dm-license-module.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - DM_LicenseModule -description: This article shows the DM_LicenseModule enumeration of Dynamsoft Core. -keywords: enumerations, DM_LicenseModule -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# DM_LicenseModule -Describes Dynamsoft license modules. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_LicenseModule` | -| .Net | `enum Dynamsoft.Core.EnumDMLicenseModule` | -| Android | `class com.dynamsoft.core.EnumDMLicenseModule` | -| ObjC / Swift | `enum EnumDMLicenseModule` | -| Java | `class com.dynamsoft.core.EnumDMLicenseModule` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_LM_ONED | EnumDMLicenseModuleONED | 1 | One-D barcodes license module | -| DM_LM_QR_CODE | EnumDMLicenseModuleQRCODE | 2 | QR Code barcodes license module | -| DM_LM_PDF417 | EnumDMLicenseModulePDF417 | 3 | PDF417 barcodes license module | -| DM_LM_DATAMATRIX | EnumDMLicenseModuleDATAMATRIX | 4 | DATAMATRIX barcodes license module | -| DM_LM_AZTEC | EnumDMLicenseModuleAZTEC | 5 | Aztec barcodes license module | -| DM_LM_MAXICODE | EnumDMLicenseModuleMAXICODE | 6 | MAXICODE barcodes license module| -| DM_LM_PATCHCODE | EnumDMLicenseModulePatchCode | 7 |Patch code barcodes license module | -| DM_LM_GS1_DATABAR | EnumDMLicenseModuleGS1DATABAR | 8 | GS1 Databar barcodes license module | -| DM_LM_GS1_COMPOSITE | EnumDMLicenseModuleGS1COMPOSITE | 9 | GS1 Composite Code barcodes license module | -| DM_LM_POSTALCODE | EnumDMLicenseModulePOSTALCODE | 10 | Postal code barcodes license module | -| DM_LM_DOTCODE | EnumDMLicenseModuleDOTCODE | 11 | DotCode barcodes license module| -| DM_LM_DDM_LM_INTERMEDIATE_RESULTATAMATRIX | EnumDMLicenseModuleINTERMEDIATERESULT | 12 | Intermediate result license module | -| DM_LM_DPM | EnumDMLicenseModuleDPM | 13 |DATAMATRIX DPM (Direct Part Marking) license module | -| DM_LM_NONSTANDARD_BARCODE | EnumDMLicenseModuleNONSTANDARDBARCODE | 16 | Nonstandard barcodes license module| diff --git a/parameters/enum/dm-uuid-generation-method.md b/parameters/enum/dm-uuid-generation-method.md deleted file mode 100644 index cd369b3..0000000 --- a/parameters/enum/dm-uuid-generation-method.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - DM_UUIDGenerationMethod -description: This article shows the DM_UUIDGenerationMethod enumeration of Dynamsoft Core. -keywords: enumerations, DM_UUIDGenerationMethod -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# DM_UUIDGenerationMethod -Describes UUID generation method. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_UUIDGenerationMethod` | -| .Net | `enum Dynamsoft.Core.EnumDMUUIDGenerationMethod` | -| Android | `class com.dynamsoft.core.EnumDMUUIDGenerationMethod` | -| ObjC / Swift | `enum EnumDMUUIDGenerationMethod` | -| Java | `class com.dynamsoft.core.EnumDMUUIDGenerationMethod` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_UUIDGM_RANDOM | EnumDMUUIDGenerationMethodRandom | 1 | Generates UUID with random values. | -| DM_UUIDGM_HARDWARE | EnumDMUUIDGenerationMethodHardware | 2 | Generates UUID based on hardware info. | diff --git a/parameters/enum/error-code-v1.0.md b/parameters/enum/error-code-v1.0.md deleted file mode 100644 index eea19a2..0000000 --- a/parameters/enum/error-code-v1.0.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default-layout -title: Enumerations Error Code - Dynamsoft Label Recognition -description: This article shows Error Code of Dynamsoft Label Recognition. -keywords: error code, enumeration -needAutoGenerateSidebar: true ---- - -# Dynamsoft Label Recognition - Error Code - -## Error code common to all programming languages - - | Erorr Code (except ObjC/Swift) | Erorr Code (ObjC/Swift) | Value | Description | - |--------------------------------|-------------------------|-------|-------------| - | `DLR_OK` | `EnumErrorCode_OK` | 0 | Successful. | - | `DLRERR_UNKNOWN` | `EnumErrorCode_Unknow` | -10000 | Unknown error. | - | `DLRERR_NO_MEMORY` | `EnumErrorCode_No_Memory` | -10001 | Not enough memory to perform the operation. | - | `DLRERR_NULL_POINTER` | `EnumErrorCode_Null_Pointer` | -10002 | Null pointer. | - | `DLRERR_LICENSE_INVALID` | `EnumErrorCode_License_Invalid` | -10003 | The license is invalid. | - | `DLRERR_FILE_NOT_FOUND` | `EnumErrorCode_File_Not_Found` | -10004 | The file is not found. | - | `DLRERR_JSON_PARSE_FAILED` | `EnumErrorCode_Json_Parse_Failed` | -10005 | Failed to parse JSON string. | - | `DLRERR_JSON_TYPE_INVALID` | `EnumErrorCode_Json_Type_Invalid` | -10006 | The value type is invalid. | - | `DLRERR_JSON_KEY_INVALID` | `EnumErrorCode_Json_Key_Invalid` | -10007 | The key is invalid. | - | `DLRERR_JSON_VALUE_INVALID` | `EnumErrorCode_Json_Value_Invalid` | -10008 | The value is invalid or out of range. | - | `DLRERR_JSON_NAME_KEY_MISSING` | `EnumErrorCode_Json_Name_Key_Missing` | -10009 | The mandatory key "Name" is missing. | - | `DLRERR_JSON_NAME_VALUE_DUPLICATED` | `EnumErrorCode_Json_Name_Value_Duplicated` | -10010 | The value of the key "Name" is duplicated. | - | `DLRERR_PARAMETER_VALUE_INVALID` | `EnumErrorCode_Parameter_Value_Invalid` | -10011 | The parameter value is invalid or out of range. | - | `DLRERR_TEMPLATE_NAME_INVALID` | `EnumErrorCode_Template_Name_Invalid` | -10012 | The template name is invalid. | - | `DLRERR_LICENSE_EXPIRED` | `EnumErrorCode_License_Expired` | -10013 | The license has expired. | - | `DLRERR_CHARACTER_MODEL_FILE_NOT_FOUND` | `EnumErrorCode_Character_Model_File_Not_Found` | -10014 | The character model file is not found. | - | `DLRERR_SET_MODE_ARGUMENT_ERROR` | `EnumErrorCode_Set_Mode_Argument_Error` | -10015 | Failed to set mode's argument. | - | `DLRERR_GET_MODE_ARGUMENT_ERROR` | `EnumErrorCode_Get_MODE_Argument_Error` | -10016 | Failed to set mode's argument. | - | `DLRERR_REQUESTED_FAILED` | `EnumErrorCode_Requested_Failed` | -10044 | Failed to request the license file. | - | `DMERR_NO_LICENSE` | `EnumErrorCode_No_License` | -20000 | No license specified. | - | `DMERR_HANDSHAKE_CODE_INVALID` | `EnumErrorCode_Handshake_Code_Invalid` | -20001 | The handshake code is invalid. | - | `DMERR_LICENSE_BUFFER_FAILED` | `EnumErrorCode_License_Buffer_Failed` | -20002 | Failed to read or write license buffer. | - | `DMERR_LICENSE_SYNC_FAILED` | `EnumErrorCode_License_Sync_Failed` | -20003 | Failed to synchronize license info with license tracking server. | - | `DMERR_DEVICE_NOT_MATCH` | `EnumErrorCode_Device_Not_Match` | -20004 | Device does not match with license buffer. | - | `DMERR_BIND_DEVICE_FAILED` | `EnumErrorCode_Bind_Device_Failed` | -20005 | Failed to bind device. | - | `DMERR_LICENSE_INTERFACE_CONFLICT` | `EnumErrorCode_License_Interface_Conflict` | -20006 | Interface InitLicenseFromLTS can not be used together with other license initiation interfaces.| - | `DMERR_LICENSE_CLIENT_DLL_MISSING` | `EnumErrorCode_License_Client_DLL_Missing` | -20007 | The license client dll is missing. | - | `DMERR_INSTANCE_COUNT_OVER_LIMIT` | `EnumErrorCode_Instance_Count_Over_Limit` | -20008 | The number of instances used has exceeded the limit. | - | `DMERR_LICENSE_INIT_SEQUENCE_FAILED` | `EnumErrorCode_License_Init_Sequence_Failed` | -20009 | Interface InitLicenseFromLTS has to be called before creating any SDK objects. | - | `DMERR_TRIAL_LICENSE` | `EnumErrorCode_Trial_License` | -20010 | Using a trial license. | - - -## Error code for specific programming languages - -### Android - - | Erorr Code | Value | Description | - |------------|-------|-------------| - | `DLR_SYSTEM_EXCEPTION` | 1 | System exception. | - -### .Net - - | Erorr Code | Value | Description | - |------------|-------|-------------| - | `DLR_SYSTEM_EXCEPTION` | 1 | System exception. | diff --git a/parameters/enum/error-code-v1.2.1.md b/parameters/enum/error-code-v1.2.1.md deleted file mode 100644 index fbd284b..0000000 --- a/parameters/enum/error-code-v1.2.1.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default-layout -title: Enumerations Error Code - Dynamsoft Label Recognition -description: This article shows Error Code of Dynamsoft Label Recognition. -keywords: error code, enumeration -needAutoGenerateSidebar: true ---- - -# Dynamsoft Label Recognition - Error Code - -## Error code common to all programming languages - - | Erorr Code (except ObjC/Swift) | Erorr Code (ObjC/Swift) | Value | Description | - |--------------------------------|-------------------------|-------|-------------| - | `DLR_OK` | `EnumErrorCode_OK` | 0 | Successful. | - | `DLRERR_UNKNOWN` | `EnumErrorCode_Unknow` | -10000 | Unknown error. | - | `DLRERR_NO_MEMORY` | `EnumErrorCode_No_Memory` | -10001 | Not enough memory to perform the operation. | - | `DLRERR_NULL_POINTER` | `EnumErrorCode_Null_Pointer` | -10002 | Null pointer. | - | `DLRERR_LICENSE_INVALID` | `EnumErrorCode_License_Invalid` | -10003 | The license is invalid. | - | `DLRERR_FILE_NOT_FOUND` | `EnumErrorCode_File_Not_Found` | -10004 | The file is not found. | - | `DLRERR_JSON_PARSE_FAILED` | `EnumErrorCode_Json_Parse_Failed` | -10005 | Failed to parse JSON string. | - | `DLRERR_JSON_TYPE_INVALID` | `EnumErrorCode_Json_Type_Invalid` | -10006 | The value type is invalid. | - | `DLRERR_JSON_KEY_INVALID` | `EnumErrorCode_Json_Key_Invalid` | -10007 | The key is invalid. | - | `DLRERR_JSON_VALUE_INVALID` | `EnumErrorCode_Json_Value_Invalid` | -10008 | The value is invalid or out of range. | - | `DLRERR_JSON_NAME_KEY_MISSING` | `EnumErrorCode_Json_Name_Key_Missing` | -10009 | The mandatory key "Name" is missing. | - | `DLRERR_JSON_NAME_VALUE_DUPLICATED` | `EnumErrorCode_Json_Name_Value_Duplicated` | -10010 | The value of the key "Name" is duplicated. | - | `DLRERR_PARAMETER_VALUE_INVALID` | `EnumErrorCode_Parameter_Value_Invalid` | -10011 | The parameter value is invalid or out of range. | - | `DLRERR_TEMPLATE_NAME_INVALID` | `EnumErrorCode_Template_Name_Invalid` | -10012 | The template name is invalid. | - | `DLRERR_LICENSE_EXPIRED` | `EnumErrorCode_License_Expired` | -10013 | The license has expired. | - | `DLRERR_CHARACTER_MODEL_FILE_NOT_FOUND` | `EnumErrorCode_Character_Model_File_Not_Found` | -10014 | The character model file is not found. | - | `DLRERR_SET_MODE_ARGUMENT_ERROR` | `EnumErrorCode_Set_Mode_Argument_Error` | -10015 | Failed to set mode's argument. | - | `DLRERR_GET_MODE_ARGUMENT_ERROR` | `EnumErrorCode_Get_MODE_Argument_Error` | -10016 | Failed to set mode's argument. | - | `DLRERR_TIFF_READ_FAILED` | `EnumErrorCode_TIFF_Read_Failed` | -10017 | Failed to read the TIFF image. | - | `DLRERR_PDF_READ_FAILED` | `EnumErrorCode_PDF_Read_Failed` | -10021 | Failed to read the PDF image. | - | `DLRERR_PDF_DLL_MISSING` | `EnumErrorCode_PDF_DLL_Missing` | -10022 | The PDF DLL is missing. | - | `DLRERR_RECOGNITION_TIMEOUT` | `EnumErrorCode_Recognition_Timeout` | -10026 | Recognition timeout. | - | `DLRERR_REQUESTED_FAILED` | `EnumErrorCode_Requested_Failed` | -10044 | Failed to request the license file. | - | `DMERR_NO_LICENSE` | `EnumErrorCode_No_License` | -20000 | No license specified. | - | `DMERR_HANDSHAKE_CODE_INVALID` | `EnumErrorCode_Handshake_Code_Invalid` | -20001 | The handshake code is invalid. | - | `DMERR_LICENSE_BUFFER_FAILED` | `EnumErrorCode_License_Buffer_Failed` | -20002 | Failed to read or write license buffer. | - | `DMERR_LICENSE_SYNC_FAILED` | `EnumErrorCode_License_Sync_Failed` | -20003 | Failed to synchronize license info with license tracking server. | - | `DMERR_DEVICE_NOT_MATCH` | `EnumErrorCode_Device_Not_Match` | -20004 | Device does not match with license buffer. | - | `DMERR_BIND_DEVICE_FAILED` | `EnumErrorCode_Bind_Device_Failed` | -20005 | Failed to bind device. | - | `DMERR_LICENSE_INTERFACE_CONFLICT` | `EnumErrorCode_License_Interface_Conflict` | -20006 | Interface InitLicenseFromLTS can not be used together with other license initiation interfaces.| - | `DMERR_LICENSE_CLIENT_DLL_MISSING` | `EnumErrorCode_License_Client_DLL_Missing` | -20007 | The license client dll is missing. | - | `DMERR_INSTANCE_COUNT_OVER_LIMIT` | `EnumErrorCode_Instance_Count_Over_Limit` | -20008 | The number of instances used has exceeded the limit. | - | `DMERR_LICENSE_INIT_SEQUENCE_FAILED` | `EnumErrorCode_License_Init_Sequence_Failed` | -20009 | Interface InitLicenseFromLTS has to be called before creating any SDK objects. | - | `DMERR_TRIAL_LICENSE` | `EnumErrorCode_Trial_License` | -20010 | Using a trial license. | - - -## Error code for specific programming languages - -### Android - - | Erorr Code | Value | Description | - |------------|-------|-------------| - | `DLR_SYSTEM_EXCEPTION` | 1 | System exception. | - -### .Net - - | Erorr Code | Value | Description | - |------------|-------|-------------| - | `DLR_SYSTEM_EXCEPTION` | 1 | System exception. | diff --git a/parameters/enum/error-code.md b/parameters/enum/error-code.md deleted file mode 100644 index 95cdd75..0000000 --- a/parameters/enum/error-code.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default-layout -title: Enumerations Error Code - Dynamsoft Label Recognizer -description: This article shows Error Code of Dynamsoft Label Recognizer. -keywords: error code, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Error Code - -## For all programming languages - - | Erorr Code (except ObjC/Swift) | Erorr Code (ObjC/Swift) | Value | Description | - |--------------------------------|-------------------------|-------|-------------| - | `DM_OK` | `EnumDMErrorCode_OK` | 0 | Successful. | - | `DMERR_UNKNOWN` | `EnumDMErrorCode_Unknow` | -10000 | Unknown error. | - | `DMERR_NO_MEMORY` | `EnumDMErrorCode_No_Memory` | -10001 | Not enough memory to perform the operation. | - | `DMERR_NULL_POINTER` | `EnumDMErrorCode_Null_Pointer` | -10002 | Null pointer. | - | `DMERR_LICENSE_INVALID` | `EnumDMErrorCode_License_Invalid` | -10003 | The license is invalid. | - | `DMERR_FILE_NOT_FOUND` | `EnumDMErrorCode_File_Not_Found` | -10004 | The file is not found. | - | `DMERR_JSON_PARSE_FAILED` | `EnumDMErrorCode_Json_Parse_Failed` | -10005 | Failed to parse JSON string. | - | `DMERR_JSON_TYPE_INVALID` | `EnumDMErrorCode_Json_Type_Invalid` | -10006 | The value type is invalid. | - | `DMERR_JSON_KEY_INVALID` | `EnumDMErrorCode_Json_Key_Invalid` | -10007 | The key is invalid. | - | `DMERR_JSON_VALUE_INVALID` | `EnumDMErrorCode_Json_Value_Invalid` | -10008 | The value is invalid or out of range. | - | `DMERR_JSON_NAME_KEY_MISSING` | `EnumDMErrorCode_Json_Name_Key_Missing` | -10009 | The mandatory key "Name" is missing. | - | `DMERR_JSON_NAME_VALUE_DUPLICATED` | `EnumDMErrorCode_Json_Name_Value_Duplicated` | -10010 | The value of the key "Name" is duplicated. | - | `DMERR_PARAMETER_VALUE_INVALID` | `EnumDMErrorCode_Parameter_Value_Invalid` | -10011 | The parameter value is invalid or out of range. | - | `DMERR_TEMPLATE_NAME_INVALID` | `EnumDMErrorCode_Template_Name_Invalid` | -10012 | The template name is invalid. | - | `DMERR_LICENSE_EXPIRED` | `EnumDMErrorCode_License_Expired` | -10013 | The license has expired. | - | `DLRERR_CHARACTER_MODEL_FILE_NOT_FOUND` | `EnumDLRErrorCode_Character_Model_File_Not_Found` | -10014 | The character model file is not found. | - | `DMERR_SET_MODE_ARGUMENT_ERROR` | `EnumDMErrorCode_Set_Mode_Argument_Error` | -10015 | Failed to set mode's argument. | - | `DMERR_GET_MODE_ARGUMENT_ERROR` | `EnumDMErrorCode_Get_MODE_Argument_Error` | -10016 | Failed to set mode's argument. | - | `DMERR_TIFF_READ_FAILED` | `EnumDMErrorCode_TIFF_Read_Failed` | -10017 | Failed to read the TIFF image. | - | `DMERR_PDF_READ_FAILED` | `EnumDMErrorCode_PDF_Read_Failed` | -10021 | Failed to read the PDF image. | - | `DMERR_PDF_DLL_MISSING` | `EnumDMErrorCode_PDF_DLL_Missing` | -10022 | The PDF DLL is missing. | - | `DLRERR_RECOGNITION_TIMEOUT` | `EnumDLRErrorCode_Recognition_Timeout` | -10026 | Recognition timeout. | - | `DMERR_REQUESTED_FAILED` | `EnumDMErrorCode_Requested_Failed` | -10044 | Failed to request the license file. | - | `DMERR_NO_LICENSE` | `EnumDMErrorCode_No_License` | -20000 | No license specified. | - | `DMERR_HANDSHAKE_CODE_INVALID` | `EnumDMErrorCode_Handshake_Code_Invalid` | -20001 | The handshake code is invalid. | - | `DMERR_LICENSE_BUFFER_FAILED` | `EnumDMErrorCode_License_Buffer_Failed` | -20002 | Failed to read or write license buffer. | - | `DMERR_LICENSE_SYNC_FAILED` | `EnumDMErrorCode_License_Sync_Failed` | -20003 | Failed to synchronize license info with license tracking server. | - | `DMERR_DEVICE_NOT_MATCH` | `EnumDMErrorCode_Device_Not_Match` | -20004 | Device does not match with license buffer. | - | `DMERR_BIND_DEVICE_FAILED` | `EnumDMErrorCode_Bind_Device_Failed` | -20005 | Failed to bind device. | - | `DMERR_LICENSE_INTERFACE_CONFLICT` | `EnumDMErrorCode_License_Interface_Conflict` | -20006 | Interface InitLicenseFromLTS can not be used together with other license initiation interfaces.| - | `DMERR_LICENSE_CLIENT_DLL_MISSING` | `EnumDMErrorCode_License_Client_DLL_Missing` | -20007 | The license client dll is missing. | - | `DMERR_INSTANCE_COUNT_OVER_LIMIT` | `EnumDMErrorCode_Instance_Count_Over_Limit` | -20008 | The number of instances used has exceeded the limit. | - | `DMERR_LICENSE_INIT_SEQUENCE_FAILED` | `EnumDMErrorCode_License_Init_Sequence_Failed` | -20009 | Interface InitLicenseFromLTS has to be called before creating any SDK objects. | - | `DMERR_TRIAL_LICENSE` | `EnumDMErrorCode_Trial_License` | -20010 | Using a trial license. | - - -## For specific programming languages - -### Android - - | Erorr Code | Value | Description | - |------------|-------|-------------| - | `DLR_SYSTEM_EXCEPTION` | 1 | System exception. | - -### .Net - - | Erorr Code | Value | Description | - |------------|-------|-------------| - | `DLR_SYSTEM_EXCEPTION` | 1 | System exception. | diff --git a/parameters/enum/grayscale-enhancement-mode.md b/parameters/enum/grayscale-enhancement-mode.md deleted file mode 100644 index 30ca9cf..0000000 --- a/parameters/enum/grayscale-enhancement-mode.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - GrayscaleEnhancementMode -description: This article shows the GrayscaleEnhancementMode enumeration of Dynamsoft Core. -keywords: enumerations, GrayscaleEnhancementMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# GrayscaleEnhancementMode -Describes the grayscale image preprocessing mode. - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRGrayscaleEnhancementMode` | -| C / C++ | `enum GrayscaleEnhancementMode` | -| .Net | `enum Dynamsoft.Core.EnumGrayscaleEnhancementMode` | -| Android | `class com.dynamsoft.core.EnumGrayscaleEnhancementMode` | -| ObjC / Swift | `enum EnumGrayscaleEnhancementMode` | -| Java | `class com.dynamsoft.core.EnumGrayscaleEnhancementMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| GEM_SKIP | EnumGrayscaleEnhancementModeSkip | 0x00 | Skips image preprocessing. | `N/A` | -| GEM_AUTO | EnumGrayscaleEnhancementModeAuto | 0x01 | **Not supported yet.** | `N/A` | -| GEM_GENERAL | EnumGrayscaleEnhancementModeGeneral | 0x02 | Takes the unpreprocessed image for following operations. | `N/A` | -| GEM_GRAY_EQUALIZE | EnumGrayscaleEnhancementModeGrayEqualize | 0x04 | Preprocesses the image using the gray equalization algorithm. | [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#sensitivity) | -| GEM_GRAY_SMOOTH | EnumGrayscaleEnhancementModeGraySmooth | 0x08 | Preprocesses the image using the gray smoothing algorithm. | [`SmoothBlockSizeX`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#smoothblocksizex)
    [`SmoothBlockSizeY`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#smoothblocksizey) | -| GEM_SHARPEN_SMOOTH | EnumGrayscaleEnhancementModeSharpenSmooth | 0x10 | Preprocesses the image using the sharpening and smoothing algorithm. | [`SmoothBlockSizeX`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#smoothblocksizex)
    [`SmoothBlockSizeY`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#smoothblocksizey)
    [`SharpenBlockSizeX`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#sharpenblocksizex)
    [`SharpenBlockSizeY`]({{ site.parameters-reference }}label-recognition-parameter/grayscale-enhancement-modes.html#sharpenblocksizey) | diff --git a/parameters/enum/grayscale-transformation-mode.md b/parameters/enum/grayscale-transformation-mode.md deleted file mode 100644 index 10fe9f1..0000000 --- a/parameters/enum/grayscale-transformation-mode.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - GrayscaleTransformationMode -description: This article shows the GrayscaleTransformationMode enumeration of Dynamsoft Core. -keywords: enumerations, GrayscaleTransformationMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# GrayscaleTransformationMode -Describes the grayscale transformation mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRGrayscaleTransformationMode` | -| C / C++ | `enum GrayscaleTransformationMode` | -| .Net | `enum Dynamsoft.Core.EnumGrayscaleTransformationMode` | -| Android | `class com.dynamsoft.core.EnumGrayscaleTransformationMode` | -| ObjC / Swift | `enum EnumGrayscaleTransformationMode` | -| Java | `class com.dynamsoft.core.EnumGrayscaleTransformationMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| GTM_SKIP | EnumGrayscaleTransformationModeSkip | 0x00 | Skips grayscale transformation. | -| GTM_INVERTED | EnumGrayscaleTransformationModeInverted | 0x01 | Transforms to inverted grayscale. Recommended for light on dark images. | -| GTM_ORIGINAL | EnumGrayscaleTransformationModeOriginal | 0x02 | Keeps the original grayscale. Recommended for dark on light images. | -| GTM_AUTO | EnumGrayscaleTransformationModeAuto | 0x04 | Lets the library choose an algorithm automatically for grayscale transformation. | - diff --git a/parameters/enum/image-pixel-format.md b/parameters/enum/image-pixel-format.md deleted file mode 100644 index 3a163e3..0000000 --- a/parameters/enum/image-pixel-format.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - ImagePixelFormat -description: This article shows the ImagePixelFormat enumeration of Dynamsoft Core. -keywords: enumerations, ImagePixelFormat -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# ImagePixelFormat -Describes the image pixel format. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRImagePixelFormat` | -| C / C++ | `enum ImagePixelFormat` | -| .Net | `enum Dynamsoft.Core.EnumImagePixelFormat` | -| Android | `class com.dynamsoft.core.EnumImagePixelFormat` | -| ObjC / Swift | `enum EnumImagePixelFormat` | -| Java | `class com.dynamsoft.core.EnumImagePixelFormat` | - - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| IPF_BINARY | EnumImagePixelFormatBinary | 0 | 0: Black, 1: White | -| IPF_BINARYINVERTED | EnumImagePixelFormatBinaryInverted | 1 | 0: Black, 1: White | -| IPF_GRAYSCALED | EnumImagePixelFormatGrayScaled | 2 | 8 bit gray | -| IPF_NV21 | EnumImagePixelFormatNV21 | 3 | NV21 | -| IPF_RGB_565 | EnumImagePixelFormatRGB_565 | 4 | 16bit with RGB channel order stored in memory from high to low address | -| IPF_RGB_555 | EnumImagePixelFormatRGB_555 | 5 | 16bit with RGB channel order stored in memory from high to low address | -| IPF_RGB_888 | EnumImagePixelFormatRGB_888 | 6 | 24bit with RGB channel order stored in memory from high to low address | -| IPF_ARGB_8888 | EnumImagePixelFormatARGB_8888 | 7 | 32bit with ARGB channel order stored in memory from high to low address | -| IPF_RGB_161616 | EnumImagePixelFormatRGB_161616 | 8 | 48bit with RGB channel order stored in memory from high to low address | -| IPF_ARGB_16161616 | EnumImagePixelFormatARGB_16161616 | 9 | 64bit with ARGB channel order stored in memory from high to low address | -| IPF_ABGR_8888 | EnumImagePixelFormatABGR_8888 | 10 | 32bit with ABGR channel order stored in memory from high to low address | -| IPF_ABGR_16161616 | EnumImagePixelFormatABGR_8888 | 11 | 64bit with ABGR channel order stored in memory from high to low address | -| IPF_BGR_888 | EnumImagePixelFormatBGR_888 | 12 | 24bit with BGR channel order stored in memory from high to low address | - diff --git a/parameters/enum/index-v1.0.md b/parameters/enum/index-v1.0.md deleted file mode 100644 index acf0a71..0000000 --- a/parameters/enum/index-v1.0.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: Enumerations Main Page - Dynamsoft Label Recognition -description: This article shows the main page of Dynamsoft Label Recognition Enumerations. -keywords: enumerations -needAutoGenerateSidebar: false ---- - -# Dynamsoft Label Recognition - Enumerations - -## [Parameter Mode Enumeration](parameter-mode-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBinarizationMode`](parameter-mode-enums.md#dlrbinarizationmode) | Describes the binarization mode. | - | [`DLRGrayscaleTransformationMode`](parameter-mode-enums.md#dlrgrayscaletransformationmode) | Describes the grayscale transformation mode. | - | [`DLRRegionPredetectionMode`](parameter-mode-enums.md#dlrregionpredetectionmode) | Describes the region predetection mode. | - - -## [Other Enumeration](other-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBarcodeFormat`](other-enums.md#dlrbarcodeformat) | Describes the barcode formats in DLRBarcodeFormat group 1. | - | [`DLRBarcodeFormat_2`](other-enums.md#dlrbarcodeformat_2) | Describes the barcode formats in DLRBarcodeFormat group 2. | - | [`DLRImagePixelFormat`](other-enums.md#dlrimagepixelformat) | Describes the image pixel format. | - | [`DLRLocalizationSourceType`](other-enums.md#dlrlocalizationsourcetype) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](other-enums.md#dm_chargeway) | Describes the charge way. | - | [`DM_DeploymentType`](other-enums.md#dm_deploymenttype) | Describes the deployment type. | - | [`DM_LicenseModule`](other-enums.md#dm_licensemodule) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](other-enums.md#dm_uuidgenerationmethod) | Describes the UUID generation method. | - -## [Error Code](error-code.md) - - diff --git a/parameters/enum/index-v1.2.1.md b/parameters/enum/index-v1.2.1.md deleted file mode 100644 index 9cdbcc6..0000000 --- a/parameters/enum/index-v1.2.1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default-layout -title: Enumerations Main Page - Dynamsoft Label Recognition -description: This article shows the main page of Dynamsoft Label Recognition Enumerations. -keywords: enumerations -needAutoGenerateSidebar: false ---- - -# Dynamsoft Label Recognition - Enumerations - -## [Parameter Mode Enumeration](parameter-mode-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBinarizationMode`](parameter-mode-enums.md#dlrbinarizationmode) | Describes the binarization mode. | - | [`DLRGrayscaleTransformationMode`](parameter-mode-enums.md#dlrgrayscaletransformationmode) | Describes the grayscale transformation mode. | - | [`DLRRegionPredetectionMode`](parameter-mode-enums.md#dlrregionpredetectionmode) | Describes the region predetection mode. | - | [`DLRScaleUpMode`](parameter-mode-enums.md#dlrscaleupmode) | Describes the scale up mode. | - - -## [Other Enumeration](other-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBarcodeFormat`](other-enums.md#dlrbarcodeformat) | Describes the barcode formats in DLRBarcodeFormat group 1. | - | [`DLRBarcodeFormat_2`](other-enums.md#dlrbarcodeformat_2) | Describes the barcode formats in DLRBarcodeFormat group 2. | - | [`DLRImagePixelFormat`](other-enums.md#dlrimagepixelformat) | Describes the image pixel format. | - | [`DLRLocalizationSourceType`](other-enums.md#dlrlocalizationsourcetype) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](other-enums.md#dm_chargeway) | Describes the charge way. | - | [`DM_DeploymentType`](other-enums.md#dm_deploymenttype) | Describes the deployment type. | - | [`DM_LicenseModule`](other-enums.md#dm_licensemodule) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](other-enums.md#dm_uuidgenerationmethod) | Describes the UUID generation method. | - | [`Product`](other-enums.md#product) | Describes Dynamsoft products. | - -## [Error Code](error-code.md) - - diff --git a/parameters/enum/index-v1.2.md b/parameters/enum/index-v1.2.md deleted file mode 100644 index efb2e86..0000000 --- a/parameters/enum/index-v1.2.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default-layout -title: Enumerations Main Page - Dynamsoft Label Recognition -description: This article shows the main page of Dynamsoft Label Recognition Enumerations. -keywords: enumerations -needAutoGenerateSidebar: false ---- - -# Dynamsoft Label Recognition - Enumerations - -## [Parameter Mode Enumeration](parameter-mode-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBinarizationMode`](parameter-mode-enums.md#dlrbinarizationmode) | Describes the binarization mode. | - | [`DLRGrayscaleTransformationMode`](parameter-mode-enums.md#dlrgrayscaletransformationmode) | Describes the grayscale transformation mode. | - | [`DLRRegionPredetectionMode`](parameter-mode-enums.md#dlrregionpredetectionmode) | Describes the region predetection mode. | - | [`DLRScaleUpMode`](parameter-mode-enums.md#dlrscaleupmode) | Describes the scale up mode. | - - -## [Other Enumeration](other-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBarcodeFormat`](other-enums.md#dlrbarcodeformat) | Describes the barcode formats in DLRBarcodeFormat group 1. | - | [`DLRBarcodeFormat_2`](other-enums.md#dlrbarcodeformat_2) | Describes the barcode formats in DLRBarcodeFormat group 2. | - | [`DLRImagePixelFormat`](other-enums.md#dlrimagepixelformat) | Describes the image pixel format. | - | [`DLRLocalizationSourceType`](other-enums.md#dlrlocalizationsourcetype) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](other-enums.md#dm_chargeway) | Describes the charge way. | - | [`DM_DeploymentType`](other-enums.md#dm_deploymenttype) | Describes the deployment type. | - | [`DM_LicenseModule`](other-enums.md#dm_licensemodule) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](other-enums.md#dm_uuidgenerationmethod) | Describes the UUID generation method. | - -## [Error Code](error-code.md) - - diff --git a/parameters/enum/index.md b/parameters/enum/index.md deleted file mode 100644 index 1a5811b..0000000 --- a/parameters/enum/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: Enumerations Main Page - Dynamsoft Label Recognizer -description: This article shows the main page of Dynamsoft Label Recognizer Enumerations. -keywords: enumerations -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# Enumerations - -## [Parameter Mode Enumeration](parameter-mode-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`BinarizationMode`](binarization-mode.md) | Describes the binarization mode. | - | [`GrayscaleTransformationMode`](grayscale-transformation-mode.md) | Describes the grayscale transformation mode. | - | [`RegionPredetectionMode`](region-predetection-mode.md) | Describes the region predetection mode. | - | [`ColourConversionMode`](colour-conversion-mode.md) | Describes the colour conversion mode. | - | [`GrayscaleEnhancementMode`](grayscale-enhancement-mode.md) | Describes the grayscale image preprocessing mode. | - | [`TextureDetectionMode`](texture-detection-mode.md) | Describes the texture detection mode. | - | [`ScaleUpMode`](scale-up-mode.md) | Describes the scale up mode. | - | [`PDFReadingMode`](pdf-reading-mode.md) | Describes the PDF reading mode. | - -## [Other Enumeration](other-enums.md) - - | Enumeration | Description | - |-------------|-------------| - | [`BarcodeFormat`](barcode-format.md) | Describes the barcode formats in BarcodeFormat group 1. | - | [`BarcodeFormat_2`](barcode-format-2.md) | Describes the barcode formats in BarcodeFormat group 2. | - | [`ImagePixelFormat`](image-pixel-format.md) | Describes the image pixel format. | - | [`LocalizationSourceType`](localization-source-type.md) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](dm-charge-way.md) | Describes the charge way. | - | [`DM_DeploymentType`](dm-deployment-type.md) | Describes the deployment type. | - | [`DM_LicenseModule`](dm-license-module.md) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](dm-uuid-generation-method.md) | Describes the UUID generation method. | - | [`Product`](product.md) | Describes Dynamsoft products. | - -## [Error Code](error-code.md) - - diff --git a/parameters/enum/localization-source-type.md b/parameters/enum/localization-source-type.md deleted file mode 100644 index 7067fbe..0000000 --- a/parameters/enum/localization-source-type.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default-layout -title: Enumeration LocalizationSourceType - Dynamsoft Label Recognizer -description: This article shows the LocalizationSourceType enumeration of Dynamsoft Label Recognizer. -keywords: enumerations, LocalizationSourceType -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# LocalizationSourceType - -Describes the source type used to localize the reference region(s). - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRLocalizationSourceType` | -| C / C++ | `enum LocalizationSourceType` | -| .Net | `enum Dynamsoft.DLR.EnumLocalizationSourceType` | -| Android | `class com.dynamsoft.dlr.EnumLocalizationSourceType` | -| ObjC / Swift | `enum EnumLocalizationSourceType` | -| Java | `class com.dynamsoft.dlr.EnumLocalizationSourceType` | - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| LST_MANUAL_SPECIFICATION | EnumLocalizationSourceTypeManualSpecification | 0x01 | Define the reference region using the manually specified location. | -| LST_PREDETECTED_REGION | EnumLocalizationSourceTypePredetectedRegion | 0x02 | Define the reference region using the result(s) of region predetection process. | -| LST_BARCODE | EnumLocalizationSourceTypeBarcode | 0x04 | Define the reference region using the barcode info. | diff --git a/parameters/enum/other-enums-v1.2.1.md b/parameters/enum/other-enums-v1.2.1.md deleted file mode 100644 index 673f200..0000000 --- a/parameters/enum/other-enums-v1.2.1.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default-layout -title: Other Enumerations - Dynamsoft Label Recognition Enumerations -description: This article shows other Enumerations of Dynamsoft Label Recognition. -keywords: DM_ChargeWay, DM_DeploymentType, DM_LicenseModule, DM_UUIDGenerationMethod, DLRImagePixelFormat, other enumeration, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - - -# Dynamsoft Label Recognition Enumeration - Other Enumeration - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBarcodeFormat`](#dlrbarcodeformat) | Describes the barcode formats in DLRBarcodeFormat group 1. | - | [`DLRBarcodeFormat_2`](#dlrbarcodeformat_2) | Describes the barcode formats in DLRBarcodeFormat group 2. | - | [`DLRImagePixelFormat`](#dlrimagepixelformat) | Describes the image pixel format. | - | [`DLRLocalizationSourceType`](#dlrlocalizationsourcetype) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](#dm_chargeway) | Describes the charge way. | - | [`DM_DeploymentType`](#dm_deploymenttype) | Describes the deployment type. | - | [`DM_LicenseModule`](#dm_licensemodule) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](#dm_uuidgenerationmethod) | Describes the UUID generation method. | - | [`Product`](#product) | Describes Dynamsoft products. | - ---- - -## DLRBarcodeFormat -Describes the barcode types in DLRBarcodeFormat group 1. All the formats can be combined, such as DLR_BF_CODE_39 | DLR_BF_CODE_128. Note: The barcode format our library supported is composed of [DLRBarcodeFormat group 1](#dlrbarcodeformat) and [DLRBarcodeFormat group 2](#dlrbarcodeformat_2), so you need to specify the barcode format in group 1 and group 2 individually. - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRBarcodeFormat` | -| .Net | `enum Dynamsoft.DLR.EnumDLRBarcodeFormat ` | -| Android | `class EnumDLRBarcodeFormat` | -| ObjC / Swift | `enum EnumBarcodeFormat` | -| Java | `class EnumDLRBarcodeFormat` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_BF_ALL | EnumBarcodeFormatALL | -31457281 | All supported formats in [DLRBarcodeFormat group 1](#dlrbarcodeformat). | -| DLR_BF_ONED | EnumBarcodeFormatONED | 0x001007FF | Combined value of DLR_BF_CODABAR, DLR_BF_CODE_128, DLR_BF_CODE_39, DLR_BF_CODE_39_Extended, DLR_BF_CODE_93, DLR_BF_EAN_13, DLR_BF_EAN_8, INDUSTRIAL_25, DLR_BF_ITF, DLR_BF_UPC_A, DLR_BF_UPC_E, DLR_BF_MSI_CODE. | -| DLR_BF_GS1_DATABAR | EnumBarcodeFormatGS1DATABAR | 0x0003F800 | Combined value of DLR_BF_GS1_DATABAR_OMNIDIRECTIONAL, DLR_BF_GS1_DATABAR_TRUNCATED, DLR_BF_GS1_DATABAR_STACKED, DLR_BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, DLR_BF_GS1_DATABAR_EXPANDED, DLR_BF_GS1_DATABAR_EXPANDED_STACKED, DLR_BF_GS1_DATABAR_LIMITED. | -| DLR_BF_NULL | EnumBarcodeFormatNULL | 0x00 | No barcode format in [DLRBarcodeFormat group 1](#dlrbarcodeformat). | -| DLR_BF_CODE_39 | EnumBarcodeFormatCODE39 | 0x01 | Code 39 | -| DLR_BF_CODE_128 | EnumBarcodeFormatCODE128 | 0x02 | Code 128 | -| DLR_BF_CODE_93 | EnumBarcodeFormatCODE93 | 0x04 | Code 93 | -| DLR_BF_CODABAR | EnumBarcodeFormatCODABAR | 0x08 | Codabar | -| DLR_BF_ITF | EnumBarcodeFormatITF | 0x10 | ITF | -| DLR_BF_EAN_13 | EnumBarcodeFormatEAN13 | 0x20 | EAN-13 | -| DLR_BF_EAN_8 | EnumBarcodeFormatEAN8 | 0x40 | EAN-8 | -| DLR_BF_UPC_A | EnumBarcodeFormatUPCA | 0x80 | UPC-A | -| DLR_BF_UPC_E | EnumBarcodeFormatUPCE | 0x100 | UPC-E | -| DLR_BF_INDUSTRIAL_25 | EnumBarcodeFormatINDUSTRIAL | 0x200 | Industrial 2 of 5 | -| DLR_BF_MSI_CODE | EnumBarcodeFormatMSICODE | 0x100000 | MSI Code | -| DLR_BF_CODE_39_EXTENDED | EnumBarcodeFormatCODE39EXTENDED | 0x400 | Code 39 Extended | -| DLR_BF_GS1_DATABAR_OMNIDIRECTIONAL | EnumBarcodeFormatGS1DATABAROMNIDIRECTIONAL | 0x800 | GS1 Databar Omnidirectional | -| DLR_BF_GS1_DATABAR_TRUNCATED | EnumBarcodeFormatGS1DATABARTRUNCATED | 0x1000 | GS1 Databar Truncated | -| DLR_BF_GS1_DATABAR_STACKED | EnumBarcodeFormatGS1DATABARSTACKED | 0x2000 | GS1 Databar Stacked | -| DLR_BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL | EnumBarcodeFormatGS1DATABARSTACKEDOMNIDIRECTIONAL | 0x4000 | GS1 Databar Stacked Omnidirectional | -| DLR_BF_GS1_DATABAR_EXPANDED | EnumBarcodeFormatGS1DATABAREXPANDED | 0x8000 | GS1 Databar Expanded | -| DLR_BF_GS1_DATABAR_EXPANDED_STACKED | EnumBarcodeFormatGS1DATABAREXPANDEDSTACKED | 0x10000 | GS1 Databar Expaned Stacked | -| DLR_BF_GS1_DATABAR_LIMITED | EnumBarcodeFormatGS1DATABARLIMITED | 0x20000 | GS1 Databar Limited | -| DLR_BF_PATCHCODE | EnumBarcodeFormatPATCHCODE | 0x00040000 | Patch code | -| DLR_BF_MICRO_PDF417 | EnumBarcodeFormatMICROPDF417 | 0x00080000 | Micro PDF417 | -| DLR_BF_PDF417 | EnumBarcodeFormatPDF417 | 0x02000000 | PDF417 | -| DLR_BF_QR_CODE | EnumBarcodeFormatQRCODE | 0x04000000 | QRCode | -| DLR_BF_DATAMATRIX | EnumBarcodeFormatDATAMATRIX | 0x08000000 | DataMatrix | -| DLR_BF_AZTEC | EnumBarcodeFormatAZTEC | 0x10000000 | AZTEC | -| DLR_BF_MAXICODE | EnumBarcodeFormatMAXICODE | 0x20000000 | MAXICODE | -| DLR_BF_MICRO_QR | EnumBarcodeFormatMICROQR | 0x40000000 | Micro QR Code | -| DLR_BF_GS1_COMPOSITE | EnumBarcodeFormatGS1COMPOSITE | -2147483648 | GS1 Composite Code | - - -  - - -## DLRBarcodeFormat_2 -Describes the barcode types in DLRBarcodeFormat group 2. Note: The barcode format our library supported is composed of [DLRBarcodeFormat group 1](#dlrbarcodeformat) and [DLRBarcodeFormat group 2](#dlrbarcodeformat_2), so you need to specify the barcode format in group 1 and group 2 individually. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRBarcodeFormat_2` | -| .Net | `enum Dynamsoft.DLR.EnumDLRBarcodeFormat_2` | -| Android | `class EnumDLRBarcodeFormat_2` | -| ObjC / Swift | `enum EnumBarcodeFormat_2` | -| Java | `class EnumDLRBarcodeFormat_2` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_BF2_POSTALCODE | EnumBarcodeFormat2POSTALCODE | 0x01F00000 | Combined value of DLR_BF2_USPSINTELLIGENTMAIL, DLR_BF2_POSTNET, DLR_BF2_PLANET, DLR_BF2_AUSTRALIANPOST, DLR_BF2_RM4SCC. | -| DLR_BF2_NULL | EnumBarcodeFormat2NULL | 0x00 | No barcode format in [DLRBarcodeFormat group 2](#dlrbarcodeformat_2). | -| DLR_BF2_NONSTANDARD_BARCODE | EnumBarcodeFormat2NONSTANDARDBARCODE | 0x01 | Nonstandard barcode | -| DLR_BF2_USPSINTELLIGENTMAIL | EnumBarcodeFormat2USPSINTELLIGENTMAIL | 0x00100000 | USPS Intelligent Mail | -| DLR_BF2_POSTNET | EnumBarcodeFormat2POSTNET | 0x00200000 | Postnet | -| DLR_BF2_PLANET | EnumBarcodeFormat2PLANET | 0x00400000 | Planet | -| DLR_BF2_AUSTRALIANPOST | EnumBarcodeFormat2AUSTRALIANPOST | 0x00800000 | Australian Post | -| DLR_BF2_RM4SCC | EnumBarcodeFormat2RM4SCC | 0x01000000 | Royal Mail 4-State Customer Barcode | -| DLR_BF2_DOTCODE | EnumBarcodeFormat2DOTCODE | 0x02 | DotCode | - -  - -## DLRImagePixelFormat -Describes the image pixel format. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRImagePixelFormat` | -| .Net | `enum Dynamsoft.DLR.EnumDLRImagePixelFormat` | -| Android | `class EnumDLRImagePixelFormat` | -| ObjC / Swift | `enum EnumDLRImagePixelFormat` | -| Java | `class EnumDLRImagePixelFormat` | - - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_IPF_BINARY | EnumDLRImagePixelFormatBinary | 0 | 0: Black, 1: White | -| DLR_IPF_BINARYINVERTED | EnumDLRImagePixelFormatBinaryInverted | 1 | 0: Black, 1: White | -| DLR_IPF_GRAYSCALED | EnumDLRImagePixelFormatGrayScaled | 2 | 8 bit gray | -| DLR_IPF_NV21 | EnumDLRImagePixelFormatNV21 | 3 | NV21 | -| DLR_IPF_RGB_565 | EnumDLRImagePixelFormatRGB_565 | 4 | 16bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_RGB_555 | EnumDLRImagePixelFormatRGB_555 | 5 | 16bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_RGB_888 | EnumDLRImagePixelFormatRGB_888 | 6 | 24bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_ARGB_8888 | EnumDLRImagePixelFormatARGB_8888 | 7 | 32bit with ARGB channel order stored in memory from high to low address | -| DLR_IPF_RGB_161616 | EnumDLRImagePixelFormatRGB_161616 | 8 | 48bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_ARGB_16161616 | EnumDLRImagePixelFormatARGB_16161616 | 9 | 64bit with ARGB channel order stored in memory from high to low address | -| DLR_IPF_ABGR_8888 | EnumDLRImagePixelFormatABGR_8888 | 10 | 32bit with ABGR channel order stored in memory from high to low address | -| DLR_IPF_ABGR_16161616 | EnumDLRImagePixelFormatABGR_8888 | 11 | 64bit with ABGR channel order stored in memory from high to low address | -| DLR_IPF_BGR_888 | EnumDLRImagePixelFormatBGR_888 | 12 | 24bit with BGR channel order stored in memory from high to low address | - - -  - -## DLRLocalizationSourceType -Describes the source type used to localize the reference region(s). - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRLocalizationSourceType` | -| .Net | `enum EnumDLRLocalizationSourceType` | -| Android | `class EnumDLRLocalizationSourceType` | -| ObjC / Swift | `enum EnumDLRLocalizationSourceType` | -| Java | `class EnumDLRLocalizationSourceType` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_LST_MANUAL_SPECIFICATION | EnumDLRLocalizationSourceTypeManualSpecification | 0x01 | Define the reference region using the manually specified location. | -| DLR_LST_PREDETECTED_REGION | EnumDLRLocalizationSourceTypePredetectedRegion | 0x02 | Define the reference region using the result(s) of region predetection process. | -| DLR_LST_BARCODE | EnumDLRLocalizationSourceTypeBarcode | 0x04 | Define the reference region using the barcode info. | - - - -  - - -## DM_ChargeWay -Describes charge way. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_ChargeWay` | -| .Net | `enum Dynamsoft.DLR.EnumDMChargeWay` | -| Android | `class EnumDMChargeWay` | -| ObjC / Swift | `enum EnumDMChargeWay` | -| Java | `class EnumDMChargeWay` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_CW_AUTO | EnumDMChargeWayAuto | 0 | The charge way automatically determined by the license server. | -| DM_CW_DEVICE_COUNT | EnumDMChargeWayDeviceCount | 1 | Charges by the count of devices. | -| DM_CW_SCAN_COUNT | EnumDMChargeWayScanCount | 2 | Charges by the count of barcode scans.| -| DM_CW_CONCURRENT_DEVICE_COUNT | EnumDMChargeWayConcurrentDeviceCount | 3 | Charges by the count of concurrent devices. | -| DM_CW_APP_DOMAIN_COUNT | EnumDMChargeWayAppDomainCount | 6 | Charges by the count of app domains. | -| DM_CW_ACTIVE_DEVICE_COUNT | EnumDMChargeWayActiveDeviceCount | 8 | Charges by the count of active devices. | -| DM_CW_INSTANCE_COUNT | EnumDMChargeWayInstanceCount | 9 | Charges by the count of instances. | -| DM_CW_CONCURRENT_INSTANCE_COUNT | EnumDMChargeWayConcurrentInstanceCount | 10 | Charges by the count of concurrent instances. | - - - - -  - -## DM_DeploymentType -Describes the deployment type. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_DeploymentType` | -| .Net | `enum EnumDMDeploymentType` | -| Android | `N/A` | -| ObjC / Swift | `N/A` | -| Java | `N/A` | - - -### Members - -| Member | Value | Description | -| -------------------------- | ----- | ----------- | -| DM_DT_SERVER | 1 | Server deployment type | -| DM_DT_DESKTOP | 2 | Desktop | -| DM_DT_EMBEDDED_DEVICE | 6 | Embedded device deployment type | -| DM_DT_OEM | 7 | OEM deployment type | - - - -  - -## DM_LicenseModule -Describes Dynamsoft license modules. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_LicenseModule` | -| .Net | `enum Dynamsoft.DLR.EnumDMLicenseModule` | -| Android | `class EnumDMLicenseModule` | -| ObjC / Swift | `enum EnumDMLicenseModule` | -| Java | `class EnumDMLicenseModule` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_LM_ONED | EnumDMLicenseModuleONED | 1 | One-D barcodes license module | -| DM_LM_QR_CODE | EnumDMLicenseModuleQRCODE | 2 | QR Code barcodes license module | -| DM_LM_PDF417 | EnumDMLicenseModulePDF417 | 3 | PDF417 barcodes license module | -| DM_LM_DATAMATRIX | EnumDMLicenseModuleDATAMATRIX | 4 | DATAMATRIX barcodes license module | -| DM_LM_AZTEC | EnumDMLicenseModuleAZTEC | 5 | Aztec barcodes license module | -| DM_LM_MAXICODE | EnumDMLicenseModuleMAXICODE | 6 | MAXICODE barcodes license module| -| DM_LM_PATCHCODE | EnumDMLicenseModulePatchCode | 7 |Patch code barcodes license module | -| DM_LM_GS1_DATABAR | EnumDMLicenseModuleGS1DATABAR | 8 | GS1 Databar barcodes license module | -| DM_LM_GS1_COMPOSITE | EnumDMLicenseModuleGS1COMPOSITE | 9 | GS1 Composite Code barcodes license module | -| DM_LM_POSTALCODE | EnumDMLicenseModulePOSTALCODE | 10 | Postal code barcodes license module | -| DM_LM_DOTCODE | EnumDMLicenseModuleDOTCODE | 11 | DotCode barcodes license module| -| DM_LM_DDM_LM_INTERMEDIATE_RESULTATAMATRIX | EnumDMLicenseModuleINTERMEDIATERESULT | 12 | Intermediate result license module | -| DM_LM_DPM | EnumDMLicenseModuleDPM | 13 |DATAMATRIX DPM (Direct Part Marking) license module | -| DM_LM_NONSTANDARD_BARCODE | EnumDMLicenseModuleNONSTANDARDBARCODE | 16 | Nonstandard barcodes license module| - - -  - -## DM_UUIDGenerationMethod -Describes UUID generation method. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_UUIDGenerationMethod` | -| .Net | `enum Dynamsoft.DLR.EnumDMUUIDGenerationMethod` | -| Android | `class EnumDMUUIDGenerationMethod` | -| ObjC / Swift | `enum EnumDMUUIDGenerationMethod` | -| Java | `class EnumDMUUIDGenerationMethod` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_UUIDGM_RANDOM | EnumDMUUIDGenerationMethodRandom | 1 | Generates UUID with random values. | -| DM_UUIDGM_HARDWARE | EnumDMUUIDGenerationMethodHardware | 2 | Generates UUID based on hardware info. | - - - -## Product -Describes Dynamsoft products. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum Product` | -| .Net | `enum Dynamsoft.EnumProduct` | -| Android | `class EnumProduct` | -| ObjC / Swift | `enum EnumProduct` | -| Java | `class EnumProduct` | - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| PROD_DBR | EnumProductDBR | 0x0001 | Dynamsoft Barcode Reader | -| PROD_DLR | EnumProductDLR | 0x0002 | Dynamsoft Label Recognition | -| PROD_DWT | EnumProductDWT | 0x0004 | Dynamic Web Twain | -| PROD_DCE | EnumProductDCE | 0x0008 | Dynamsoft Camera Enhancer | -| PROD_DPS | EnumProductDPS | 0x0010 | Dynamsoft Panorama | -| PROD_ALL | EnumProductALL | 0xFFFF | All Dynamsoft products | - -  - - - diff --git a/parameters/enum/other-enums-v1.2.md b/parameters/enum/other-enums-v1.2.md deleted file mode 100644 index 9201062..0000000 --- a/parameters/enum/other-enums-v1.2.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -layout: default-layout -title: Other Enumerations - Dynamsoft Label Recognition Enumerations -description: This article shows other Enumerations of Dynamsoft Label Recognition. -keywords: DM_ChargeWay, DM_DeploymentType, DM_LicenseModule, DM_UUIDGenerationMethod, DLRImagePixelFormat, other enumeration, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - - -# Dynamsoft Label Recognition Enumeration - Other Enumeration - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBarcodeFormat`](#dlrbarcodeformat) | Describes the barcode formats in DLRBarcodeFormat group 1. | - | [`DLRBarcodeFormat_2`](#dlrbarcodeformat_2) | Describes the barcode formats in DLRBarcodeFormat group 2. | - | [`DLRImagePixelFormat`](#dlrimagepixelformat) | Describes the image pixel format. | - | [`DLRLocalizationSourceType`](#dlrlocalizationsourcetype) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](#dm_chargeway) | Describes the charge way. | - | [`DM_DeploymentType`](#dm_deploymenttype) | Describes the deployment type. | - | [`DM_LicenseModule`](#dm_licensemodule) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](#dm_uuidgenerationmethod) | Describes the UUID generation method. | - ---- - -## DLRBarcodeFormat -Describes the barcode types in DLRBarcodeFormat group 1. All the formats can be combined, such as DLR_BF_CODE_39 | DLR_BF_CODE_128. Note: The barcode format our library supported is composed of [DLRBarcodeFormat group 1](#dlrbarcodeformat) and [DLRBarcodeFormat group 2](#dlrbarcodeformat_2), so you need to specify the barcode format in group 1 and group 2 individually. - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRBarcodeFormat` | -| .Net | `enum Dynamsoft.DLR.EnumDLRBarcodeFormat ` | -| Android | `class EnumDLRBarcodeFormat` | -| ObjC / Swift | `enum EnumBarcodeFormat` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_BF_ALL | EnumBarcodeFormatALL | -31457281 | All supported formats in [DLRBarcodeFormat group 1](#dlrbarcodeformat). | -| DLR_BF_ONED | EnumBarcodeFormatONED | 0x001007FF | Combined value of DLR_BF_CODABAR, DLR_BF_CODE_128, DLR_BF_CODE_39, DLR_BF_CODE_39_Extended, DLR_BF_CODE_93, DLR_BF_EAN_13, DLR_BF_EAN_8, INDUSTRIAL_25, DLR_BF_ITF, DLR_BF_UPC_A, DLR_BF_UPC_E, DLR_BF_MSI_CODE. | -| DLR_BF_GS1_DATABAR | EnumBarcodeFormatGS1DATABAR | 0x0003F800 | Combined value of DLR_BF_GS1_DATABAR_OMNIDIRECTIONAL, DLR_BF_GS1_DATABAR_TRUNCATED, DLR_BF_GS1_DATABAR_STACKED, DLR_BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, DLR_BF_GS1_DATABAR_EXPANDED, DLR_BF_GS1_DATABAR_EXPANDED_STACKED, DLR_BF_GS1_DATABAR_LIMITED. | -| DLR_BF_NULL | EnumBarcodeFormatNULL | 0x00 | No barcode format in [DLRBarcodeFormat group 1](#dlrbarcodeformat). | -| DLR_BF_CODE_39 | EnumBarcodeFormatCODE39 | 0x01 | Code 39 | -| DLR_BF_CODE_128 | EnumBarcodeFormatCODE128 | 0x02 | Code 128 | -| DLR_BF_CODE_93 | EnumBarcodeFormatCODE93 | 0x04 | Code 93 | -| DLR_BF_CODABAR | EnumBarcodeFormatCODABAR | 0x08 | Codabar | -| DLR_BF_ITF | EnumBarcodeFormatITF | 0x10 | ITF | -| DLR_BF_EAN_13 | EnumBarcodeFormatEAN13 | 0x20 | EAN-13 | -| DLR_BF_EAN_8 | EnumBarcodeFormatEAN8 | 0x40 | EAN-8 | -| DLR_BF_UPC_A | EnumBarcodeFormatUPCA | 0x80 | UPC-A | -| DLR_BF_UPC_E | EnumBarcodeFormatUPCE | 0x100 | UPC-E | -| DLR_BF_INDUSTRIAL_25 | EnumBarcodeFormatINDUSTRIAL | 0x200 | Industrial 2 of 5 | -| DLR_BF_MSI_CODE | EnumBarcodeFormatMSICODE | 0x100000 | MSI Code | -| DLR_BF_CODE_39_EXTENDED | EnumBarcodeFormatCODE39EXTENDED | 0x400 | Code 39 Extended | -| DLR_BF_GS1_DATABAR_OMNIDIRECTIONAL | EnumBarcodeFormatGS1DATABAROMNIDIRECTIONAL | 0x800 | GS1 Databar Omnidirectional | -| DLR_BF_GS1_DATABAR_TRUNCATED | EnumBarcodeFormatGS1DATABARTRUNCATED | 0x1000 | GS1 Databar Truncated | -| DLR_BF_GS1_DATABAR_STACKED | EnumBarcodeFormatGS1DATABARSTACKED | 0x2000 | GS1 Databar Stacked | -| DLR_BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL | EnumBarcodeFormatGS1DATABARSTACKEDOMNIDIRECTIONAL | 0x4000 | GS1 Databar Stacked Omnidirectional | -| DLR_BF_GS1_DATABAR_EXPANDED | EnumBarcodeFormatGS1DATABAREXPANDED | 0x8000 | GS1 Databar Expanded | -| DLR_BF_GS1_DATABAR_EXPANDED_STACKED | EnumBarcodeFormatGS1DATABAREXPANDEDSTACKED | 0x10000 | GS1 Databar Expaned Stacked | -| DLR_BF_GS1_DATABAR_LIMITED | EnumBarcodeFormatGS1DATABARLIMITED | 0x20000 | GS1 Databar Limited | -| DLR_BF_PATCHCODE | EnumBarcodeFormatPATCHCODE | 0x00040000 | Patch code | -| DLR_BF_MICRO_PDF417 | EnumBarcodeFormatMICROPDF417 | 0x00080000 | Micro PDF417 | -| DLR_BF_PDF417 | EnumBarcodeFormatPDF417 | 0x02000000 | PDF417 | -| DLR_BF_QR_CODE | EnumBarcodeFormatQRCODE | 0x04000000 | QRCode | -| DLR_BF_DATAMATRIX | EnumBarcodeFormatDATAMATRIX | 0x08000000 | DataMatrix | -| DLR_BF_AZTEC | EnumBarcodeFormatAZTEC | 0x10000000 | AZTEC | -| DLR_BF_MAXICODE | EnumBarcodeFormatMAXICODE | 0x20000000 | MAXICODE | -| DLR_BF_MICRO_QR | EnumBarcodeFormatMICROQR | 0x40000000 | Micro QR Code | -| DLR_BF_GS1_COMPOSITE | EnumBarcodeFormatGS1COMPOSITE | -2147483648 | GS1 Composite Code | - - -  - - -## DLRBarcodeFormat_2 -Describes the barcode types in DLRBarcodeFormat group 2. Note: The barcode format our library supported is composed of [DLRBarcodeFormat group 1](#dlrbarcodeformat) and [DLRBarcodeFormat group 2](#dlrbarcodeformat_2), so you need to specify the barcode format in group 1 and group 2 individually. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRBarcodeFormat_2` | -| .Net | `enum Dynamsoft.DLR.EnumDLRBarcodeFormat_2` | -| Android | `class EnumDLRBarcodeFormat_2` | -| ObjC / Swift | `enum EnumBarcodeFormat_2` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_BF2_POSTALCODE | EnumBarcodeFormat2POSTALCODE | 0x01F00000 | Combined value of DLR_BF2_USPSINTELLIGENTMAIL, DLR_BF2_POSTNET, DLR_BF2_PLANET, DLR_BF2_AUSTRALIANPOST, DLR_BF2_RM4SCC. | -| DLR_BF2_NULL | EnumBarcodeFormat2NULL | 0x00 | No barcode format in [DLRBarcodeFormat group 2](#dlrbarcodeformat_2). | -| DLR_BF2_NONSTANDARD_BARCODE | EnumBarcodeFormat2NONSTANDARDBARCODE | 0x01 | Nonstandard barcode | -| DLR_BF2_USPSINTELLIGENTMAIL | EnumBarcodeFormat2USPSINTELLIGENTMAIL | 0x00100000 | USPS Intelligent Mail | -| DLR_BF2_POSTNET | EnumBarcodeFormat2POSTNET | 0x00200000 | Postnet | -| DLR_BF2_PLANET | EnumBarcodeFormat2PLANET | 0x00400000 | Planet | -| DLR_BF2_AUSTRALIANPOST | EnumBarcodeFormat2AUSTRALIANPOST | 0x00800000 | Australian Post | -| DLR_BF2_RM4SCC | EnumBarcodeFormat2RM4SCC | 0x01000000 | Royal Mail 4-State Customer Barcode | -| DLR_BF2_DOTCODE | EnumBarcodeFormat2DOTCODE | 0x02 | DotCode | - -  - -## DLRImagePixelFormat -Describes the image pixel format. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRImagePixelFormat` | -| .Net | `enum Dynamsoft.DLR.EnumDLRImagePixelFormat` | -| Android | `class EnumDLRImagePixelFormat` | -| ObjC / Swift | `enum EnumDLRImagePixelFormat` | - - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_IPF_BINARY | EnumDLRImagePixelFormatBinary | 0 | 0: Black, 1: White | -| DLR_IPF_BINARYINVERTED | EnumDLRImagePixelFormatBinaryInverted | 1 | 0: Black, 1: White | -| DLR_IPF_GRAYSCALED | EnumDLRImagePixelFormatGrayScaled | 2 | 8 bit gray | -| DLR_IPF_NV21 | EnumDLRImagePixelFormatNV21 | 3 | NV21 | -| DLR_IPF_RGB_565 | EnumDLRImagePixelFormatRGB_565 | 4 | 16bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_RGB_555 | EnumDLRImagePixelFormatRGB_555 | 5 | 16bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_RGB_888 | EnumDLRImagePixelFormatRGB_888 | 6 | 24bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_ARGB_8888 | EnumDLRImagePixelFormatARGB_8888 | 7 | 32bit with ARGB channel order stored in memory from high to low address | -| DLR_IPF_RGB_161616 | EnumDLRImagePixelFormatRGB_161616 | 8 | 48bit with RGB channel order stored in memory from high to low address | -| DLR_IPF_ARGB_16161616 | EnumDLRImagePixelFormatARGB_16161616 | 9 | 64bit with ARGB channel order stored in memory from high to low address | -| DLR_IPF_ABGR_8888 | EnumDLRImagePixelFormatABGR_8888 | 10 | 32bit with ABGR channel order stored in memory from high to low address | -| DLR_IPF_ABGR_16161616 | EnumDLRImagePixelFormatABGR_8888 | 11 | 64bit with ABGR channel order stored in memory from high to low address | -| DLR_IPF_BGR_888 | EnumDLRImagePixelFormatBGR_888 | 12 | 24bit with BGR channel order stored in memory from high to low address | - - -  - -## DLRLocalizationSourceType -Describes the source type used to localize the reference region(s). - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRLocalizationSourceType` | -| .Net | `enum EnumDLRLocalizationSourceType` | -| Android | `class EnumDLRLocalizationSourceType` | -| ObjC / Swift | `enum EnumDLRLocalizationSourceType` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_LST_MANUAL_SPECIFICATION | EnumDLRLocalizationSourceTypeManualSpecification | 0x01 | Define the reference region using the manually specified location. | -| DLR_LST_PREDETECTED_REGION | EnumDLRLocalizationSourceTypePredetectedRegion | 0x02 | Define the reference region using the result(s) of region predetection process. | -| DLR_LST_BARCODE | EnumDLRLocalizationSourceTypeBarcode | 0x04 | Define the reference region using the barcode info. | - - - -  - - -## DM_ChargeWay -Describes charge way. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_ChargeWay` | -| .Net | `enum Dynamsoft.DLR.EnumDMChargeWay` | -| Android | `class EnumDMChargeWay` | -| ObjC / Swift | `enum EnumDMChargeWay` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_CW_AUTO | EnumDMChargeWayAuto | 0 | The charge way automatically determined by the license server. | -| DM_CW_DEVICE_COUNT | EnumDMChargeWayDeviceCount | 1 | Charges by the count of devices. | -| DM_CW_SCAN_COUNT | EnumDMChargeWayScanCount | 2 | Charges by the count of barcode scans.| -| DM_CW_CONCURRENT_DEVICE_COUNT | EnumDMChargeWayConcurrentDeviceCount | 3 | Charges by the count of concurrent devices. | -| DM_CW_APP_DOMAIN_COUNT | EnumDMChargeWayAppDomainCount | 6 | Charges by the count of app domains. | -| DM_CW_ACTIVE_DEVICE_COUNT | EnumDMChargeWayActiveDeviceCount | 8 | Charges by the count of active devices. | -| DM_CW_INSTANCE_COUNT | EnumDMChargeWayInstanceCount | 9 | Charges by the count of instances. | -| DM_CW_CONCURRENT_INSTANCE_COUNT | EnumDMChargeWayConcurrentInstanceCount | 10 | Charges by the count of concurrent instances. | - - - - -  - -## DM_DeploymentType -Describes the deployment type. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_DeploymentType` | -| .Net | `enum EnumDMDeploymentType` | -| Android | `N/A` | -| ObjC / Swift | `N/A` | - - -### Members - -| Member | Value | Description | -| -------------------------- | ----- | ----------- | -| DM_DT_SERVER | 1 | Server deployment type | -| DM_DT_DESKTOP | 2 | Desktop | -| DM_DT_EMBEDDED_DEVICE | 6 | Embedded device deployment type | -| DM_DT_OEM | 7 | OEM deployment type | - - - -  - -## DM_LicenseModule -Describes Dynamsoft license modules. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_LicenseModule` | -| .Net | `enum Dynamsoft.DLR.EnumDMLicenseModule` | -| Android | `class EnumDMLicenseModule` | -| ObjC / Swift | `enum EnumDMLicenseModule` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_LM_ONED | EnumDMLicenseModuleONED | 1 | One-D barcodes license module | -| DM_LM_QR_CODE | EnumDMLicenseModuleQRCODE | 2 | QR Code barcodes license module | -| DM_LM_PDF417 | EnumDMLicenseModulePDF417 | 3 | PDF417 barcodes license module | -| DM_LM_DATAMATRIX | EnumDMLicenseModuleDATAMATRIX | 4 | DATAMATRIX barcodes license module | -| DM_LM_AZTEC | EnumDMLicenseModuleAZTEC | 5 | Aztec barcodes license module | -| DM_LM_MAXICODE | EnumDMLicenseModuleMAXICODE | 6 | MAXICODE barcodes license module| -| DM_LM_PATCHCODE | EnumDMLicenseModulePatchCode | 7 |Patch code barcodes license module | -| DM_LM_GS1_DATABAR | EnumDMLicenseModuleGS1DATABAR | 8 | GS1 Databar barcodes license module | -| DM_LM_GS1_COMPOSITE | EnumDMLicenseModuleGS1COMPOSITE | 9 | GS1 Composite Code barcodes license module | -| DM_LM_POSTALCODE | EnumDMLicenseModulePOSTALCODE | 10 | Postal code barcodes license module | -| DM_LM_DOTCODE | EnumDMLicenseModuleDOTCODE | 11 | DotCode barcodes license module| -| DM_LM_DDM_LM_INTERMEDIATE_RESULTATAMATRIX | EnumDMLicenseModuleINTERMEDIATERESULT | 12 | Intermediate result license module | -| DM_LM_DPM | EnumDMLicenseModuleDPM | 13 |DATAMATRIX DPM (Direct Part Marking) license module | -| DM_LM_NONSTANDARD_BARCODE | EnumDMLicenseModuleNONSTANDARDBARCODE | 16 | Nonstandard barcodes license module| - - -  - -## DM_UUIDGenerationMethod -Describes UUID generation method. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DM_UUIDGenerationMethod` | -| .Net | `enum Dynamsoft.DLR.EnumDMUUIDGenerationMethod` | -| Android | `class EnumDMUUIDGenerationMethod` | -| ObjC / Swift | `enum EnumDMUUIDGenerationMethod` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DM_UUIDGM_RANDOM | EnumDMUUIDGenerationMethodRandom | 1 | Generates UUID with random values. | -| DM_UUIDGM_HARDWARE | EnumDMUUIDGenerationMethodHardware | 2 | Generates UUID based on hardware info. | - - - -  - - - diff --git a/parameters/enum/other-enums.md b/parameters/enum/other-enums.md deleted file mode 100644 index 944a7ef..0000000 --- a/parameters/enum/other-enums.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default-layout -title: Other Enumerations - Dynamsoft Label Recognizer -description: This article shows other Enumerations of Dynamsoft Label Recognizer. -keywords: DM_ChargeWay, DM_DeploymentType, DM_LicenseModule, DM_UUIDGenerationMethod, ImagePixelFormat, other enumeration, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Other Enumerations - - | Enumeration | Description | - |-------------|-------------| - | [`BarcodeFormat`](barcode-format.md) | Describes the barcode formats in BarcodeFormat group 1. | - | [`BarcodeFormat_2`](barcode-format-2.md) | Describes the barcode formats in BarcodeFormat group 2. | - | [`ImagePixelFormat`](image-pixel-format.md) | Describes the image pixel format. | - | [`LocalizationSourceType`](localization-source-type.md) | Describes the source type used to localize the reference region(s). | - | [`DM_ChargeWay`](dm-charge-way.md) | Describes the charge way. | - | [`DM_DeploymentType`](dm-deployment-type.md) | Describes the deployment type. | - | [`DM_LicenseModule`](dm-license-module.md) | Describes Dynamsoft license modules. | - | [`DM_UUIDGenerationMethod`](dm-uuid-generation-method.md) | Describes the UUID generation method. | - | [`Product`](product.md) | Describes Dynamsoft products. | - diff --git a/parameters/enum/parameter-mode-enums-v1.0.md b/parameters/enum/parameter-mode-enums-v1.0.md deleted file mode 100644 index 551db0b..0000000 --- a/parameters/enum/parameter-mode-enums-v1.0.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -layout: default-layout -title: Parameter Mode Enumerations - Dynamsoft Label Recognition Enumerations -description: This article shows Parameter Mode Enumerations of Dynamsoft Label Recognition. -keywords: DLRBinarizationMode, DLRGrayscaleTransformationMode, DLRRegionPredetectionMode, parameter mode enumeration, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# Dynamsoft Label Recognition Enumeration - Parameter Mode Enumeration - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBinarizationMode`](#dlrbinarizationmode) | Describes the binarization mode. | - | [`DLRGrayscaleTransformationMode`](#dlrgrayscaletransformationmode) | Describes the grayscale transformation mode. | - | [`DLRRegionPredetectionMode`](#dlrregionpredetectionmode) | Describes the region predetection mode. | - - ---- - - -## DLRBinarizationMode -Describes the binarization mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRBinarizationMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRBinarizationMode` | -| Android | `class EnumDLRBinarizationMode` | -| ObjC / Swift | `enum EnumDLRBinarizationMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_BM_SKIP | EnumDLRBinarizationModeSkip | 0x00 | Skips the binarization. | -| DLR_BM_AUTO | EnumDLRBinarizationModeAuto | 0x01 | **Not supported yet.** | -| DLR_BM_LOCAL_BLOCK | EnumDLRBinarizationModeLocalBlock | 0x02 | Binarizes the image based on the local block. | -| DLR_BM_THRESHOLD | EnumDLRBinarizationModeThreshold | 0x04 | Binarizes the image based on given threshold. | - -**Remarks** -Check arguments of [`DLRBinarizationModes`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#mode-arguments) for available argument settings. - -  - - - -## DLRGrayscaleTransformationMode -Describes the grayscale transformation mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRGrayscaleTransformationMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRGrayscaleTransformationMode` | -| Android | `class EnumDLRGrayscaleTransformationMode` | -| ObjC / Swift | `enum EnumDLRGrayscaleTransformationMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_GTM_SKIP | EnumDLRGrayscaleTransformationModeSkip | 0x00 | Skips grayscale transformation. | -| DLR_GTM_INVERTED | EnumDLRGrayscaleTransformationModeInverted | 0x01 | Transforms to inverted grayscale. Recommended for light on dark images. | -| DLR_GTM_ORIGINAL | EnumDLRGrayscaleTransformationModeOriginal | 0x02 | Keeps the original grayscale. Recommended for dark on light images. | -| DLR_GTM_AUTO | EnumDLRGrayscaleTransformationModeAuto | 0x04 | Lets the library choose an algorithm automatically for grayscale transformation. | - - - -  - - - -## DLRRegionPredetectionMode -Describes the region predetection mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRRegionPredetectionMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRRegionPredetectionMode` | -| Android | `class EnumDLRRegionPredetectionMode` | -| ObjC / Swift | `enum EnumDLRRegionPredetectionMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_RPM_SKIP | EnumDLRRegionPredetectionModeSkip | 0x00 | Skips region detection. | -| DLR_RPM_AUTO | EnumDLRRegionPredetectionModeAuto | 0x01 | Lets the library choose an algorithm automatically to detect region. | -| DLR_RPM_GENERAL | EnumDLRRegionPredetectionModeGeneral | 0x02 | Takes the whole image as a region. | -| DLR_RPM_GENERAL_RGB_CONTRAST | EnumDLRRegionPredetectionModeGeneralRGBContrast | 0x04 | Detects region using the general algorithm based on RGB colour contrast. | -| DLR_RPM_GENERAL_GRAY_CONTRAST | EnumDLRRegionPredetectionModeGeneralGrayContrast | 0x08 | Detects region using the general algorithm based on gray contrast. | -| DLR_RPM_GENERAL_HSV_CONTRAST | EnumDLRRegionPredetectionModeGeneralHSVContrast | 0x10 | Detects region using the general algorithm based on HSV colour contrast. | - -**Remarks** -Check arguments of [`DLRRegionPredetectionModes`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#mode-arguments) for available argument settings. - -  - - - diff --git a/parameters/enum/parameter-mode-enums-v1.2.1.md b/parameters/enum/parameter-mode-enums-v1.2.1.md deleted file mode 100644 index 991039e..0000000 --- a/parameters/enum/parameter-mode-enums-v1.2.1.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default-layout -title: Parameter Mode Enumerations - Dynamsoft Label Recognition Enumerations -description: This article shows Parameter Mode Enumerations of Dynamsoft Label Recognition. -keywords: DLRBinarizationMode, DLRGrayscaleTransformationMode, DLRRegionPredetectionMode, parameter mode enumeration, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# Dynamsoft Label Recognition Enumeration - Parameter Mode Enumeration - - | Enumeration | Description | - |-------------|-------------| - | [`DLRBinarizationMode`](#dlrbinarizationmode) | Describes the binarization mode. | - | [`DLRGrayscaleTransformationMode`](#dlrgrayscaletransformationmode) | Describes the grayscale transformation mode. | - | [`DLRRegionPredetectionMode`](#dlrregionpredetectionmode) | Describes the region predetection mode. | - - ---- - - -## DLRBinarizationMode -Describes the binarization mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRBinarizationMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRBinarizationMode` | -| Android | `class EnumDLRBinarizationMode` | -| ObjC / Swift | `enum EnumDLRBinarizationMode` | -| Java | `class EnumDLRBinarizationMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| DLR_BM_SKIP | EnumDLRBinarizationModeSkip | 0x00 | Skips the binarization. | `N/A` | -| DLR_BM_AUTO | EnumDLRBinarizationModeAuto | 0x01 | **Not supported yet.** | `N/A` | -| DLR_BM_LOCAL_BLOCK | EnumDLRBinarizationModeLocalBlock | 0x02 | Binarizes the image based on the local block. | [`BlockSizeX`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#blocksizex)
    [`BlockSizeY`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#blocksizey)
    [`EnableFillBinaryVacancy`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#enablefillbinaryvacancy)
    [`ThreshValueCoefficient`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#threshvaluecoefficient)
    | -| DLR_BM_THRESHOLD | EnumDLRBinarizationModeThreshold | 0x04 | Binarizes the image based on given threshold. | [`BinarizationThreshold`]({{ site.parameters-reference }}label-recognition-parameter/binarization-modes.html#binarizationThreshold) | - -  - - - -## DLRGrayscaleTransformationMode -Describes the grayscale transformation mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRGrayscaleTransformationMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRGrayscaleTransformationMode` | -| Android | `class EnumDLRGrayscaleTransformationMode` | -| ObjC / Swift | `enum EnumDLRGrayscaleTransformationMode` | -| Java | `class EnumDLRGrayscaleTransformationMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| DLR_GTM_SKIP | EnumDLRGrayscaleTransformationModeSkip | 0x00 | Skips grayscale transformation. | -| DLR_GTM_INVERTED | EnumDLRGrayscaleTransformationModeInverted | 0x01 | Transforms to inverted grayscale. Recommended for light on dark images. | -| DLR_GTM_ORIGINAL | EnumDLRGrayscaleTransformationModeOriginal | 0x02 | Keeps the original grayscale. Recommended for dark on light images. | -| DLR_GTM_AUTO | EnumDLRGrayscaleTransformationModeAuto | 0x04 | Lets the library choose an algorithm automatically for grayscale transformation. | - - - -  - - - -## DLRRegionPredetectionMode -Describes the region predetection mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRRegionPredetectionMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRRegionPredetectionMode` | -| Android | `class EnumDLRRegionPredetectionMode` | -| ObjC / Swift | `enum EnumDLRRegionPredetectionMode` | -| Java | `class EnumDLRRegionPredetectionMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| DLR_RPM_SKIP | EnumDLRRegionPredetectionModeSkip | 0x00 | Skips region detection. | `N/A` | -| DLR_RPM_AUTO | EnumDLRRegionPredetectionModeAuto | 0x01 | Lets the library choose an algorithm automatically to detect region. | `N/A` | -| DLR_RPM_GENERAL | EnumDLRRegionPredetectionModeGeneral | 0x02 | Takes the whole image as a region. | `N/A` | -| DLR_RPM_GENERAL_RGB_CONTRAST | EnumDLRRegionPredetectionModeGeneralRGBContrast | 0x04 | Detects region using the general algorithm based on RGB colour contrast. | [`MinImageDimension`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#minimagedimension)
    [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#sensitivity)
    [`SpatialIndexBlockSize`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#spatialindexblocksize) | -| DLR_RPM_GENERAL_GRAY_CONTRAST | EnumDLRRegionPredetectionModeGeneralGrayContrast | 0x08 | Detects region using the general algorithm based on gray contrast. | [`MinImageDimension`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#minimagedimension)
    [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#sensitivity)
    [`SpatialIndexBlockSize`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#spatialindexblocksize) | -| DLR_RPM_GENERAL_HSV_CONTRAST | EnumDLRRegionPredetectionModeGeneralHSVContrast | 0x10 | Detects region using the general algorithm based on HSV colour contrast. | [`AspectRatioRange`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#aspectratiorange)
    [`FindAccurateBoundary`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#findaccurateboundary)
    [`ForeAndBackgroundColours`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#foreandbackgroundcolours)
    [`HeightRange`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#heightrange)
    [`MinImageDimension`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#minimagedimension)
    [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#sensitivity)
    [`SpatialIndexBlockSize`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#spatialindexblocksize)
    [`WidthRange`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#widthrange) | - - -  - -## DLRScaleUpMode -Describes the scale up mode. - - -### Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum DLRScaleUpMode` | -| .Net | `enum Dynamsoft.DLR.EnumDLRScaleUpMode` | -| Android | `class EnumDLRScaleUpMode` | -| ObjC / Swift | `enum EnumDLRScaleUpMode` | -| Java | `class EnumDLRScaleUpMode` | - - -### Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| DLR_SUM_SKIP | EnumDLRScaleUpModeSkip | 0x00 | Skip the scale-up process. | `N/A` | -| DLR_SUM_AUTO | EnumDLRScaleUpModeAuto | 0x01 | The library chooses an interpolation method automatically to scale up. | `N/A` | -| DLR_SUM_LINEAR_INTERPOLATION | EnumDLRScaleUpModeLinearInterpolation | 0x02 | Scales up using the linear interpolation method. | [`LetterHeightThreshold`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#letterheightthreshold)
    [`TargetLetterHeight`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#targetletterheight) | -| DLR_SUM_NEAREST_NEIGHBOUR_INTERPOLATION | EnumDLRScaleUpModeNearestNeighbourInterpolation | 0x04 | Scales up using the nearest-neighbour interpolation method. | [`LetterHeightThreshold`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#letterheightthreshold)
    [`TargetLetterHeight`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#targetletterheight) | - - -  - - - diff --git a/parameters/enum/parameter-mode-enums.md b/parameters/enum/parameter-mode-enums.md deleted file mode 100644 index a4aa279..0000000 --- a/parameters/enum/parameter-mode-enums.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: default-layout -title: Parameter Mode Enumerations - Dynamsoft Label Recognizer -description: This article shows Parameter Mode Enumerations of Dynamsoft Label Recognizer. -keywords: BinarizationMode, GrayscaleTransformationMode, RegionPredetectionMode, parameter mode enumeration, enumeration -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# Parameter Mode Enumerations - - | Enumeration | Description | - |-------------|-------------| - | [`BinarizationMode`](binarization-mode.md) | Describes the binarization mode. | - | [`GrayscaleTransformationMode`](grayscale-transformation-mode.md) | Describes the grayscale transformation mode. | - | [`RegionPredetectionMode`](region-predetection-mode.md) | Describes the region predetection mode. | - | [`ColourConversionMode`](colour-conversion-mode.md) | Describes the colour conversion mode. | - | [`GrayscaleEnhancementMode`](grayscale-enhancement-mode.md) | Describes the grayscale image preprocessing mode. | - | [`TextureDetectionMode`](texture-detection-mode.md) | Describes the texture detection mode. | - | [`ScaleUpMode`](scale-up-mode.md) | Describes the scale up mode. | - | [`PDFReadingMode`](pdf-reading-mode.md) | Describes the PDF reading mode. | - diff --git a/parameters/enum/pdf-reading-mode.md b/parameters/enum/pdf-reading-mode.md deleted file mode 100644 index ad6b1b8..0000000 --- a/parameters/enum/pdf-reading-mode.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - PDFReadingMode -description: This article shows the PDFReadingMode enumeration of Dynamsoft Core. -keywords: enumerations, PDFReadingMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# PDFReadingMode -Describes the PDF reading mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum PDFReadingMode` | -| .Net | `enum Dynamsoft.Core.EnumPDFReadingMode` | -| Android | `class com.dynamsoft.core.EnumPDFReadingMode` | -| ObjC / Swift | `enum EnumPDFReadingMode` | -| Java | `class com.dynamsoft.core.EnumPDFReadingMode` | - - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| PDFRM_AUTO | EnumPDFReadingModeAuto | 0x01 | Lets the library choose the reading mode automatically. | -| PDFRM_VECTOR | EnumPDFReadingModeVector | 0x02 | Recognize text from vector data in PDF file. | -| PDFRM_RASTER | EnumPDFReadingModeRaster | 0x04 | Converts the PDF file to image(s) first, then perform text recognition. | - - - diff --git a/parameters/enum/product.md b/parameters/enum/product.md deleted file mode 100644 index ffa15f5..0000000 --- a/parameters/enum/product.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - Product -description: This article shows the Product enumeration of Dynamsoft Core. -keywords: enumerations, Product -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# Product -Describes Dynamsoft products. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum Product` | -| .Net | `enum Dynamsoft.Core.EnumProduct` | -| Android | `class com.dynamsoft.core.EnumProduct` | -| ObjC / Swift | `enum EnumProduct` | -| Java | `class com.dynamsoft.core.EnumProduct` | - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | -| -------------------------- | ------------------- | ----- | ----------- | -| PROD_DBR | EnumProductDBR | 0x0001 | Dynamsoft Barcode Reader | -| PROD_DLR | EnumProductDLR | 0x0002 | Dynamsoft Label Recognizer | -| PROD_DWT | EnumProductDWT | 0x0004 | Dynamic Web Twain | -| PROD_DCE | EnumProductDCE | 0x0008 | Dynamsoft Camera Enhancer | -| PROD_DPS | EnumProductDPS | 0x0010 | Dynamsoft Panorama | -| PROD_ALL | EnumProductALL | 0xFFFF | All Dynamsoft products | diff --git a/parameters/enum/region-predetection-mode.md b/parameters/enum/region-predetection-mode.md deleted file mode 100644 index 7cfbf5f..0000000 --- a/parameters/enum/region-predetection-mode.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - RegionPredetectionMode -description: This article shows the RegionPredetectionMode enumeration of Dynamsoft Core. -keywords: enumerations, RegionPredetectionMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# RegionPredetectionMode -Describes the region predetection mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRRegionPredetectionMode` | -| C / C++ | `enum RegionPredetectionMode` | -| .Net | `enum Dynamsoft.Core.EnumRegionPredetectionMode` | -| Android | `class com.dynamsoft.core.EnumRegionPredetectionMode` | -| ObjC / Swift | `enum EnumRegionPredetectionMode` | -| Java | `class com.dynamsoft.core.EnumRegionPredetectionMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| RPM_SKIP | EnumRegionPredetectionModeSkip | 0x00 | Skips region detection. | `N/A` | -| RPM_AUTO | EnumRegionPredetectionModeAuto | 0x01 | Lets the library choose an algorithm automatically to detect region. | `N/A` | -| RPM_GENERAL | EnumRegionPredetectionModeGeneral | 0x02 | Takes the whole image as a region. | `N/A` | -| RPM_GENERAL_RGB_CONTRAST | EnumRegionPredetectionModeGeneralRGBContrast | 0x04 | Detects region using the general algorithm based on RGB colour contrast. | [`MinImageDimension`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#minimagedimension)
    [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#sensitivity)
    [`SpatialIndexBlockSize`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#spatialindexblocksize) | -| RPM_GENERAL_GRAY_CONTRAST | EnumRegionPredetectionModeGeneralGrayContrast | 0x08 | Detects region using the general algorithm based on gray contrast. | [`MinImageDimension`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#minimagedimension)
    [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#sensitivity)
    [`SpatialIndexBlockSize`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#spatialindexblocksize) | -| RPM_GENERAL_HSV_CONTRAST | EnumRegionPredetectionModeGeneralHSVContrast | 0x10 | Detects region using the general algorithm based on HSV colour contrast. | [`AspectRatioRange`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#aspectratiorange)
    [`FindAccurateBoundary`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#findaccurateboundary)
    [`ForeAndBackgroundColours`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#foreandbackgroundcolours)
    [`HeightRange`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#heightrange)
    [`MinImageDimension`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#minimagedimension)
    [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#sensitivity)
    [`SpatialIndexBlockSize`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#spatialindexblocksize)
    [`WidthRange`]({{ site.parameters-reference }}label-recognition-parameter/region-predetection-modes.html#widthrange) | - diff --git a/parameters/enum/scale-up-mode.md b/parameters/enum/scale-up-mode.md deleted file mode 100644 index 927ba66..0000000 --- a/parameters/enum/scale-up-mode.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - ScaleUpMode -description: This article shows the ScaleUpMode enumeration of Dynamsoft Core. -keywords: enumerations, ScaleUpMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# ScaleUpMode -Describes the scale up mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| C / C++ | `enum ScaleUpMode` | -| .Net | `enum Dynamsoft.Core.EnumScaleUpMode` | -| Android | `class com.dynamsoft.core.EnumScaleUpMode` | -| ObjC / Swift | `enum EnumScaleUpMode` | -| Java | `class com.dynamsoft.core.EnumScaleUpMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| SUM_SKIP | EnumScaleUpModeSkip | 0x00 | Skip the scale-up process. | `N/A` | -| SUM_AUTO | EnumScaleUpModeAuto | 0x01 | The library chooses an interpolation method automatically to scale up. | `N/A` | -| SUM_LINEAR_INTERPOLATION | EnumScaleUpModeLinearInterpolation | 0x02 | Scales up using the linear interpolation method. | [`LetterHeightThreshold`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#letterheightthreshold)
    [`TargetLetterHeight`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#targetletterheight) | -| SUM_NEAREST_NEIGHBOUR_INTERPOLATION | EnumScaleUpModeNearestNeighbourInterpolation | 0x04 | Scales up using the nearest-neighbour interpolation method. | [`LetterHeightThreshold`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#letterheightthreshold)
    [`TargetLetterHeight`]({{ site.parameters-reference }}label-recognition-parameter/scale-up-modes.html#targetletterheight) | - diff --git a/parameters/enum/texture-detection-mode.md b/parameters/enum/texture-detection-mode.md deleted file mode 100644 index c45ccf9..0000000 --- a/parameters/enum/texture-detection-mode.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Enumerations - TextureDetectionMode -description: This article shows the TextureDetectionMode enumeration of Dynamsoft Core. -keywords: enumerations, TextureDetectionMode -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# TextureDetectionMode -Describes the texture detection mode. - - -## Declarations - -| Language | Declaration | -| -------- | ----------- | -| JavaScript | `enum EnumDLRTextureDetectionMode` | -| C / C++ | `enum TextureDetectionMode` | -| .Net | `enum Dynamsoft.Core.EnumTextureDetectionMode` | -| Android | `class com.dynamsoft.core.EnumTextureDetectionMode` | -| ObjC / Swift | `enum EnumTextureDetectionMode` | -| Java | `class com.dynamsoft.core.EnumTextureDetectionMode` | - - -## Members - -| Member (except ObjC/Swift) | Member (ObjC/Swift) | Value | Description | Valid Argument(s) | -| -------------------------- | ------------------- | ----- | ----------- | ----------------- | -| TDM_SKIP | EnumTextureDetectionModeSkip | 0x00 | Skips texture detection. | `N/A` | -| TDM_AUTO | EnumTextureDetectionModeAuto | 0x01 | Not supported yet. | `N/A` | -| TDM_GENERAL_WIDTH_CONCENTRATION | EnumTextureDetectionModeGeneralWidthConcentration | 0x02 | Detects texture using the general algorithm. | [`Sensitivity`]({{ site.parameters-reference }}label-recognition-parameter/texture-detection-modes.html#sensitivity) | - diff --git a/parameters/index-v1.2.1.md b/parameters/index-v1.2.1.md deleted file mode 100644 index dbd8fe6..0000000 --- a/parameters/index-v1.2.1.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default-layout -title: Parameters Main Page - Dynamsoft Label Recognition -description: Dynamsoft Label Recognition provides flexible APIs for you to customize the settings for different usage scenarios. -needAutoGenerateSidebar: false ---- - - -# Dynamsoft Label Recognition - Parameters - -## Reference - -- [Reference of Parameters]({{ site.parameters-reference }}) -- [Reference of Enumerations]({{ site.enumerations }}) - diff --git a/parameters/index-v2.2.20.md b/parameters/index-v2.2.20.md deleted file mode 100644 index 061cdef..0000000 --- a/parameters/index-v2.2.20.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: default-layout -title: Parameters Main Page - Dynamsoft Label Recognizer -description: Dynamsoft Label Recognizer provides flexible APIs for you to customize the settings for different usage scenarios. -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer - Parameters - -## Reference - -- [Reference of Parameters]({{ site.parameters-reference }}) -- [Reference of Enumerations]({{ site.enumerations }}) - diff --git a/parameters/index.md b/parameters/index.md deleted file mode 100644 index 9ae8624..0000000 --- a/parameters/index.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameters under Dynamsoft Capture Vision Parameters -description: Introduce the overview parameters design of Dynamsoft Capture Vision related to Dynamsoft Label Recognizer. -keywords: Parameter, Parameter Template, Parameter Template File,Dynamsoft Label Recognizer -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# Overview of Dynamsoft Capture Vision parameters Related to Dynamsoft Label Recognizer - -Starting in version 3.0, Dynamsoft Label Recognizer is restructured under Dynamsoft Capture Vision Framework. - -Dynamsoft Capture Vision (DCV) is designed for high scalability and flexibility, and its parameter system plays a crucial role in achieving this goal. The parameter system is highly configurable and can drive different behavior logic within the SDK. In this article, we will provide an overview of the parametric architecture design in Dynamsoft Capture Vision. - -## Key Terms - -In order to eliminate ambiguity, we first define several key terms. - -1. **Parameter** - A parameter is designed to represent a particular aspect of the behavior of the SDK, and each parameter has its own name. For instance, the `ExpectedBarcodeCount` parameter is used to control the expected count of recognized barcodes. Parameters can be configured with specific values or ranges of values, which can be adjusted as required. - -2. **Parameter template** - A parameter template is a collection of parameters organized in a structured manner, expressed in JSON format. The name of the `CaptureVisionTemplate` object is also called "template name", which is a unique identifier assigned to each parameter template. In the DCV SDK, this name is used to load the relevant configurations and control runtime behavior. - -3. **Parameter template file** - A parameter template file is a JSON file that contains one or multiple parameter templates. - -## Organization of a Parameter Template File - -As shown in the example below, the organizational structure of a parameter template file consists of several top-level objects such as `CaptureVisionTemplates`, `ImageSourceOptions`,`TargetROIDefOptions` etc. - -```json -{ - "CaptureVisionTemplates": [ - { - "Name" : "CV_0", - "ImageSourceName": "ISA_0", - "ImageROIProcessingNameArray": ["TA_0" ], - "SemanticProcessingNameArray": ["SP_0"] - } - ], - "ImageSourceOptions": [ - { - "Name": "ISA_0" - } - ], - "TargetROIDefOptions" : [ - { - "Name" : "TA_0", - "TaskSettingNameArray": [ "LR_0", "BR_0", "DN_0" ] - } - ], - "ImageParameterOptions": [ - { - "Name": "IP_0" - } - ], - "LabelRecognizerTaskSettingOptions": [ - { - "Name" : "LR_0", - "TextLineSpecificationNameArray" : [ "LS_0" ] - } - ], - "TextLineSpecificationOptions" : [ - { - "Name" : "LS_0", - "CharacterModelName" : "NumberLetter" - } - ], - "CharacterModelOptions" : [ - { - "Name" : "NumberLetter" - } - ], - "GlobalParameter":{ - "MaxTotalImageDimension":0 - } -} -``` - -With the exception of GlobalParameter, all top-level objects in the parameter template file are arrays of the corresponding object. For example,`CaptureVisionTemplates` are an array of `CaptureVisionTemplate` objects, and `TargetROIDefOptions` are an array of `TargetROIDef` objects. - -Furthermore, to reuse the same parameter definitions, reduce the size of the parameter template file, and simplify the parameter configuration hierarchy, the reference relationship was adopted in the parameter template file design. For example, the value of the `ImageSource` parameter for the first object in `CaptureVisionTemplates` is `ISA_0`, which refers to the first object in `ImageSourceOptions`. - -Therefore, a parameter template starts with an object in `CaptureVisionTemplates` and recursively searches for the objects that are directly or indirectly referenced by it, and then combines them to form a specific set of parameters. Then, the parameter template may be applied to DCV through "template name" to control its internal execution logic. - -Next, we will focus on introducing some main objects and their relationships in a parameter template. - -## Structure of a Parameter Template - -The following table list the main objects type and description of a complete parameter template when using only Dynamsoft Label Recognizer: - -| Object Type | Description | -| :------------------------------| :----------- | -| CaptureVisionTemplate | This is the entry object of a parameter template in DCV. The `Name` parameter represents the name of the parameter template, which serves as its unique identifier.| -| ImageSource | It defines the input for DCV, responsible for providing images to DCV. It can be defined as different image sources, including but not limited to image directories, scanners, cameras, etc.| -| TargetROIDef | It is used to specify one or more recognition tasks to be performed on some regions of interest (ROIs) within an image.| -| LabelRecognizerTaskSetting | It is used to configure settings for label recognition tasks performed on images in DCV.| -| ImageParameter | It provides various image-processing features to adjust and enhance the input image for better recognition results.| - -For more details, please refer to [introduction of the capture vision template]({{ site.dcv_parameters }}file/capture-vision-template.html) - -## How to Apply DCV Parameters - -Dynamsoft Capture Vision (DCV) provides two methods to apply parameters: - -- `SimplifiedCaptureVisionSettings`: It is a structure that contains commonly used DCV parameters. To update DCV parameters using `SimplifiedCaptureVisionSettings`, you can follow these steps: - - 1. Call the `GetSimplifiedSettings` API to get the `SimplifiedCaptureVisionSettings` object named `dcv_settings` associated with the Dynamsoft Capture Vision Router instance. - 2. Modify the attributes of `dcv_settings`. - 3. Call the `UpdateSettings` API to apply the modified `dcv_settings`. - -- `JSON parameter template file/string` - It supports all DCV parameters. The related parameter setting APIs are: - - 1. `InitSettings/InitSettingsFromFile` - after calling this interface, each parameter template in the file/string will be converted into a single parameter template object. They will replace the previously associated parameter template objects on the Capture Vision Router instance. - - 2. `ResetSettings` - after calling this API, the internal associated parameter template objects are reset to the factory state. - -## Special Rules for DCV Parameter Configuration - -In this section, we will discuss some special rules for configuring the DCV parameter templates. Understanding these rules will help you efficiently configure a simple and user-friendly parameter template. - -### Default Value of Parameters - -Generally, the DCV parameter templates have been designed with many common scenarios in mind, so the default values of many parameters do not need to be modified. When configuring a custom template, you only need to configure required parameters and fine-tuning parameters related to business scenarios. Other optional parameters are automatically filled with default values. This simplifies your configuration and makes your templates easier to read. - -### Inherited Parameters - -Sometimes, we need to configure multiple templates to adapt to different scenarios, but only a few parameter values differ between each template. DCV provides a parameter configuration inheritance mechanism that further reduces the amount of configuration work. -For example, when configuring `IP_A` and `IP_B` objects in `ImageParameterOptions`, you can define a `BaseImageParameterName` parameter in the `IP_B` object with a value of `IP_A`. Then `IP_B` object will inherit all the parameter definitions of `IP_A`, and if `IP_B` defines a parameter with the same name but a different value, that parameter will adopt the value of `IP_B`. - -This allows you to create a new parameter template that inherits most of its configuration from an existing template, reducing the amount of repetitive configuration work needed. diff --git a/parameters/reference/character-model/index-v1.2.1.md b/parameters/reference/character-model/index-v1.2.1.md deleted file mode 100644 index e09dd3e..0000000 --- a/parameters/reference/character-model/index-v1.2.1.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default-layout -title: CharacterModel Object - Dynamsoft Label Recognition Parameter Reference -description: This article shows CharacterModel Object of Dynamsoft Label Recognition. -keywords: parameter reference, parameters, CharacterModel -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - CharacterModel Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`CharacterModel.Name`](parameter-control.md#name) | The name of the CharacterModel object. | - | [`CharacterModel.DirectoryPath`](parameter-control.md#directorypath) | The path of the folder containing the character model files. | - | [`CharacterModel.FilterFilePath`](parameter-control.md#filterfilepath) | The full path of the filter file which specifies the characters to be recognized. | diff --git a/parameters/reference/character-model/index.md b/parameters/reference/character-model/index.md deleted file mode 100644 index f973dd4..0000000 --- a/parameters/reference/character-model/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default-layout -title: CharacterModel Object - Dynamsoft Label Recognizer Parameter Reference -description: This article shows CharacterModel Object of Dynamsoft Label Recognizer. -keywords: parameter reference, parameters, CharacterModel -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - CharacterModel Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`CharacterModel.Name`](parameter-control.md#name) | The name of the CharacterModel object. | - | [`CharacterModel.DirectoryPath`](parameter-control.md#directorypath) | The path of the folder containing the character model files. | - | [`CharacterModel.FilterFilePath`](parameter-control.md#filterfilepath) | The full path of the filter file which specifies the characters to be recognized. | diff --git a/parameters/reference/character-model/parameter-control-v1.2.1.md b/parameters/reference/character-model/parameter-control-v1.2.1.md deleted file mode 100644 index 3551136..0000000 --- a/parameters/reference/character-model/parameter-control-v1.2.1.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for CharacterModel Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for CharacterModel Object. -keywords: CharacterModel, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# CharacterModel Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`CharacterModel.Name`](#name) | The name of the CharacterModel object. | - | [`CharacterModel.DirectoryPath`](#directorypath) | The path of the folder containing the character model files. | - | [`CharacterModel.FilterFilePath`](#filterfilepath) | The full path of the filter file which specifies the characters to be recognized. | - ---- - - -## Name -The name of the CharacterModel object. - -**Remarks** -It must be a unique name. -A CharacterModel is consisted by the following three files: -[Name].txt, -[Name].prototxt, -[Name].caffemodel -And optionally, it can have some assisted CharacterModels with formatted file names like: -[Name]_Assist_[***].txt -[Name]_Assist_[***].prototxt -[Name]_Assist_[***].caffemodel -Note: [Name] is current value and [***] can be customized by you own. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| CharacterModel | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"CharacterModel1" -} -``` - - -  - -## DirectoryPath -The path of the folder containing the character model files. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| CharacterModel | DirectoryPath | *string* | "" | - -**Json Parameter Example** -```json -{ - "DirectoryPath":"C:/CharacterModelFiles" -} -``` - - -  - -## FilterFilePath -The full path of the filter file which specifies the characters to be recognized. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| CharacterModel | FilterFilePath | *string* | "" | - -**Json Parameter Example** -```json -{ - "FilterFilePath":"C:/CharacterModelFiles/CM1_F1.txt" -} -``` - - -  - diff --git a/parameters/reference/character-model/parameter-control.md b/parameters/reference/character-model/parameter-control.md deleted file mode 100644 index c298340..0000000 --- a/parameters/reference/character-model/parameter-control.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference for CharacterModel Object -description: This page shows Dynamsoft Label Recognizer Parameter Reference for CharacterModel Object. -keywords: CharacterModel, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# CharacterModel Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`CharacterModel.Name`](#name) | The name of the CharacterModel object. | - | [`CharacterModel.DirectoryPath`](#directorypath) | The path of the folder containing the character model files. | - | [`CharacterModel.FilterFilePath`](#filterfilepath) | The full path of the filter file which specifies the characters to be recognized. | - ---- - - -## Name -The name of the CharacterModel object. - -**Remarks** -It must be a unique name. -A CharacterModel is consisted by the following three files: -[Name].txt, -[Name].prototxt, -[Name].caffemodel -And optionally, it can have some assisted CharacterModels with formatted file names like: -[Name]_Assist_[SubName].txt -[Name]_Assist_[SubName].prototxt -[Name]_Assist_[SubName].caffemodel -Note: [Name] is current value and [SubName] can be customized by you own. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| CharacterModel | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"CharacterModel1" -} -``` - - - - -## DirectoryPath -The path of the folder containing the character model files. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| CharacterModel | DirectoryPath | *string* | "" | - -**Json Parameter Example** -```json -{ - "DirectoryPath":"C:/CharacterModelFiles" -} -``` - - - - -## FilterFilePath -The full path of the filter file which specifies the characters to be recognized. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| CharacterModel | FilterFilePath | *string* | "" | - -**Json Parameter Example** -```json -{ - "FilterFilePath":"C:/CharacterModelFiles/CM1_F1.txt" -} -``` - - - - diff --git a/parameters/reference/index-v1.0.md b/parameters/reference/index-v1.0.md deleted file mode 100644 index 8f78f54..0000000 --- a/parameters/reference/index-v1.0.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -layout: default-layout -title: Parameter Reference Main Page - Dynamsoft Label Recognition -description: Dynamsoft Label Recognition Parameter Reference - Main Page -keywords: parameter reference, parameters, LabelRecognitionParameter, ReferenceRegion, TextArea, LineSpecification, CharacterModel -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - Parameters - - -## LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](label-recognition-parameter/parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](label-recognition-parameter/binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](label-recognition-parameter/parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](label-recognition-parameter/grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](label-recognition-parameter/parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](label-recognition-parameter/parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](label-recognition-parameter/parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](label-recognition-parameter/parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](label-recognition-parameter/parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](label-recognition-parameter/region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](label-recognition-parameter/parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - - -## ReferenceRegion Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`ReferenceRegion.Name`](reference-region/parameter-control.md#name) | The name of the ReferenceRegion object. | - | [`ReferenceRegion.Localization`](reference-region/localization.md#localization) | The localization of the reference region(s). | - | [`ReferenceRegion.TextAreaNameArray `](reference-region/parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current reference region. | - -## TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](text-area/parameter-control.md#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](text-area/parameter-control.md#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](text-area/parameter-control.md#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](text-area/parameter-control.md#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](text-area/parameter-control.md#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](text-area/parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](text-area/parameter-control.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](text-area/parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LinesCount`](text-area/parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`TextArea.LineSpecificationNameArray `](text-area/parameter-control.md#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringRegExPattern`](text-area/parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.TextAreaNameArray `](text-area/parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextRegExPattern`](text-area/parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - - -## LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](line-specification/parameter-control.md#name) | The name of the LineSpecification object. | - | [`LineSpecification.CharacterModelName`](line-specification/parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineNumber`](line-specification/parameter-control.md#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.LineStringRegExPattern`](line-specification/parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - -## CharacterModel Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`CharacterModel.Name`](character-model/parameter-control.md#name) | The name of the CharacterModel object. | - | [`CharacterModel.DirectoryPath`](character-model/parameter-control.md#directorypath) | The path of the folder containing the character model files. | - | [`CharacterModel.FilterFilePath`](character-model/parameter-control.md#filterfilepath) | The full path of the filter file which specifies the characters to be recognized. | - - - -## Organizational Json Parameter - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameterArray`](index.md#labelrecognitionparameterarray) | An array of LabelRecognitionParameter objects. | - | [`ReferenceRegionArray`](index.md#referenceregionarray) | An array of ReferenceRegionArray objects. | - | [`TextAreaArray`](index.md#textareaarray) | An array of TextArea objects. | - | [`LineSpecificationArray`](index.md#linespecificationarray) | An array of LineSpecification objects. | - | [`CharacterModelArray`](index.md#charactermodelarray) | An array of CharacterModel objects. | diff --git a/parameters/reference/index-v1.2.1.md b/parameters/reference/index-v1.2.1.md deleted file mode 100644 index 7844bdb..0000000 --- a/parameters/reference/index-v1.2.1.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference -description: This page shows Dynamsoft Label Recognition Json Parameters for organization. -keywords: parameter reference -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# Organizational Json Parameter - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameterArray`](#labelrecognitionparameterarray) | An array of LabelRecognitionParameter objects. | - | [`ReferenceRegionArray`](#referenceregionarray) | An array of ReferenceRegionArray objects. | - | [`TextAreaArray `](#textareaarray) | An array of TextArea objects. | - | [`LineSpecificationArray `](#linespecificationarray) | An array of LineSpecification objects. | - | [`CharacterModelArray `](#charactermodelarray) | An array of CharacterModel objects. | - ---- - - -## LabelRecognitionParameterArray -An array of [LabelRecognitionParameter objects](label-recognition-parameter/parameter-control.md). - -### As Json Parameter - -| Json Key Name | Value Type | -| --------------- | ---------- | -| LabelRecognitionParameterArray | *Object array* | - -**Json Parameter Example** -```json -{ - "LabelRecognitionParameterArray": [ - { - "Name": "LabelRecognitionParameter1", - "ReferenceRegionNameArray": ["Region1"] - }, - { - "Name": "LabelRecognitionParameter2", - "ReferenceRegionNameArray": ["Region2"] - } - ] -} -``` - -  - -## ReferenceRegionArray -An array of [ReferenceRegion objects](reference-region/parameter-control.md). - -### As Json Parameter - -| Json Key Name | Value Type | -| --------------- | ---------- | -| ReferenceRegionArray | *Object array* | - -**Json Parameter Example** -```json -{ - "ReferenceRegionArray": [ - { - "Name": "ReferenceRegion1", - "TextAreaNameArray": ["TextArea1"] - }, - { - "Name": "ReferenceRegion2", - "TextAreaNameArray": ["TextArea2"] - } - ] -} -``` - -  - -## TextAreaArray -An array of [TextArea objects](text-area/parameter-control.md). - -### As Json Parameter - -| Json Key Name | Value Type | -| --------------- | ---------- | -| TextAreaArray | *Object array* | - -**Json Parameter Example** -```json -{ - "TextAreaArray": [ - { - "Name": "TextArea1", - "LineSpecificationNameArray": ["LineSpecification1"] - }, - { - "Name": "TextArea2", - "LineSpecificationNameArray": ["LineSpecification2"] - } - ] -} -``` - -  - -## LineSpecificationArray -An array of [LineSpecification objects](line-specification/parameter-control.md). - -### As Json Parameter - -| Json Key Name | Value Type | -| --------------- | ---------- | -| LineSpecificationArray | *Object array* | - -**Json Parameter Example** -```json -{ - "LineSpecificationArray": [ - { - "Name": "LineSpecification1", - "CharacterModelName": "CharacterModel_Name1" - }, - { - "Name": "LineSpecification2", - "CharacterModelName": "CharacterModel_Name2" - } - ] -} -``` - -  - -## CharacterModelArray -An array of [CharacterModel objects](character-model/parameter-control.md). - -### As Json Parameter - -| Json Key Name | Value Type | -| --------------- | ---------- | -| CharacterModelArray | *Object array* | - -**Json Parameter Example** -```json -{ - "CharacterModelArray": [ - { - "Name": "CharacterModel1", - "DirectoryPath": "Path1" - }, - { - "Name": "CharacterMode2", - "DirectoryPath": "Path2" - } - ] -} -``` - -  - diff --git a/parameters/reference/index-v2.2.20.md b/parameters/reference/index-v2.2.20.md deleted file mode 100644 index 117fd9c..0000000 --- a/parameters/reference/index-v2.2.20.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Json Parameters for organization. -keywords: parameter reference -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# Organizational Json Parameter - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognizerParameterArray`](#labelrecognizerparameterarray) | An array of LabelRecognizerParameter objects. | - | [`ReferenceRegionArray`](#referenceregionarray) | An array of ReferenceRegionArray objects. | - | [`TextAreaArray `](#textareaarray) | An array of TextArea objects. | - | [`LineSpecificationArray `](#linespecificationarray) | An array of LineSpecification objects. | - | [`CharacterModelArray `](#charactermodelarray) | An array of CharacterModel objects. | - - ---- - - -## LabelRecognizerParameterArray -An array of [LabelRecognizerParameter objects](label-recognition-parameter/parameter-control.md). - -**As Json Parameter** - -| Json Key Name | Value Type | -| --------------- | ---------- | -| LabelRecognizerParameterArray | *Object array* | - -**Json Parameter Example** -```json -{ - "LabelRecognizerParameterArray": [ - { - "Name": "LabelRecognizerParameter1", - "ReferenceRegionNameArray": ["Region1"] - }, - { - "Name": "LabelRecognizerParameter2", - "ReferenceRegionNameArray": ["Region2"] - } - ] -} -``` - - - -## ReferenceRegionArray -An array of [ReferenceRegion objects](reference-region/parameter-control.md). - -**As Json Parameter** - -| Json Key Name | Value Type | -| --------------- | ---------- | -| ReferenceRegionArray | *Object array* | - -**Json Parameter Example** -```json -{ - "ReferenceRegionArray": [ - { - "Name": "ReferenceRegion1", - "TextAreaNameArray": ["TextArea1"] - }, - { - "Name": "ReferenceRegion2", - "TextAreaNameArray": ["TextArea2"] - } - ] -} -``` - - - -## TextAreaArray -An array of [TextArea objects](text-area/parameter-control.md). - -**As Json Parameter** - -| Json Key Name | Value Type | -| --------------- | ---------- | -| TextAreaArray | *Object array* | - -**Json Parameter Example** -```json -{ - "TextAreaArray": [ - { - "Name": "TextArea1", - "LineSpecificationNameArray": ["LineSpecification1"] - }, - { - "Name": "TextArea2", - "LineSpecificationNameArray": ["LineSpecification2"] - } - ] -} -``` - - - -## LineSpecificationArray -An array of [LineSpecification objects](line-specification/parameter-control.md). - -**As Json Parameter** - -| Json Key Name | Value Type | -| --------------- | ---------- | -| LineSpecificationArray | *Object array* | - -**Json Parameter Example** -```json -{ - "LineSpecificationArray": [ - { - "Name": "LineSpecification1", - "CharacterModelName": "CharacterModel_Name1" - }, - { - "Name": "LineSpecification2", - "CharacterModelName": "CharacterModel_Name2" - } - ] -} -``` - - - -## CharacterModelArray -An array of [CharacterModel objects](character-model/parameter-control.md). - -**As Json Parameter** - -| Json Key Name | Value Type | -| --------------- | ---------- | -| CharacterModelArray | *Object array* | - -**Json Parameter Example** -```json -{ - "CharacterModelArray": [ - { - "Name": "CharacterModel1", - "DirectoryPath": "Path1" - }, - { - "Name": "CharacterMode2", - "DirectoryPath": "Path2" - } - ] -} -``` - diff --git a/parameters/reference/index-v3.0.0.md b/parameters/reference/index-v3.0.0.md deleted file mode 100644 index 980610c..0000000 --- a/parameters/reference/index-v3.0.0.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Dynamsoft Label Recognizer Parameter Reference - Main Page -description: Dynamsoft Label Recognizer Parameter Reference - Main Page -keywords: parameter reference, parameters, label recognition -needAutoGenerateSidebar: false -permalink: /parameters/reference/index-v3.0.0.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`ImageSourceName`]({{ site.dcv_parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MaxParallelTasks`]({{ site.dcv_parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputRawImage`]({{ site.dcv_parameters_reference }}capture-vision-template/output-raw-Image.html) | Indicates whether DCV finally outputs the original input image. | - | [`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. | - | [`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. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`BaseTargetROIDefName`]({{ site.dcv_parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.dcv_parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`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. | - | [`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. | - -## Label Recognizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`DictionaryCorrectionThresholds`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-correction-thresholds.html) | Sets the threshold of dictionary error correction. | - | [`DictionaryPath`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-path.html) | Sets the path of the dictionary file.| - | [`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. | - | [`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. | - -## TextLine Specification - -| Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`BaseTextLineSpecificationName`]({{ site.dcv_parameters_reference }}text-line-specification/base-text-line-specification-name.html) | Represents the name of another `TextLineSpecification` object to inherit from. | - | [`CharHeightRange`]({{ site.dcv_parameters_reference }}text-line-specification/char-height-range.html) | Defines the range of the character height. | - | [`CharacterModelName`]({{ site.dcv_parameters_reference }}text-line-specification/character-model-name.html) | Defines the name of the character model. | - | [`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. | - | [`Text line position parameters`]({{ site.dcv_parameters_reference }}text-line-specification/position.html) | Defines the position of the text lines with the vertices points. | - -## Character Model - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`BaseImageParameterName`]({{ site.dcv_parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.dcv_parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.dcv_parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.dcv_parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`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. | - | [`ScaleDownThreshold`]({{ site.dcv_parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.dcv_parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.dcv_parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.dcv_parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source Options - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`FileFilter`]({{ site.dcv_parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`PDFReadingMode`]({{ site.dcv_parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.dcv_parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`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. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`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 | - -## Shared Parameter - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------- | ----------- | - | [`DirectoryPath`]({{ site.dcv_parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. | - | [`MaxThreadsInOneTask`]({{ site.dcv_parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`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. | - | [`SectionImageParameterArray`]({{ site.dcv_parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.dcv_parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.dcv_parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | \ No newline at end of file diff --git a/parameters/reference/index-v3.0.10.md b/parameters/reference/index-v3.0.10.md deleted file mode 100644 index a38fe67..0000000 --- a/parameters/reference/index-v3.0.10.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Dynamsoft Label Recognizer Parameter Reference - Main Page -description: Dynamsoft Label Recognizer Parameter Reference - Main Page -keywords: parameter reference, parameters, label recognition -needAutoGenerateSidebar: false -permalink: /parameters/reference/index-v3.0.10.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`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. | - | [`ImageSourceName`]({{ site.dcv_parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MaxParallelTasks`]({{ site.dcv_parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputOriginalImage`]({{ site.dcv_parameters_reference }}capture-vision-template/output-original-Image.html) | Indicates whether DCV finally outputs the original input image. | - | [`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. | - | [`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. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`BaseTargetROIDefName`]({{ site.dcv_parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.dcv_parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`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. | - | [`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. | - -## Label Recognizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`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. | - | [`DictionaryCorrectionThresholds`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-correction-thresholds.html) | Sets the threshold of dictionary error correction. | - | [`DictionaryPath`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-path.html) | Sets the path of the dictionary file.| - | [`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. | - | [`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. | - | [`MaxThreadsInOneTask`]({{ site.dcv_parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`SectionImageParameterArray`]({{ site.dcv_parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.dcv_parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.dcv_parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | - -## TextLine Specification - -| Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`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. | - | [`BaseTextLineSpecificationName`]({{ site.dcv_parameters_reference }}text-line-specification/base-text-line-specification-name.html) | Represents the name of another `TextLineSpecification` object to inherit from. | - | [`CharHeightRange`]({{ site.dcv_parameters_reference }}text-line-specification/char-height-range.html) | Defines the range of the character height. | - | [`CharacterModelName`]({{ site.dcv_parameters_reference }}text-line-specification/character-model-name.html) | Defines the name of the character model. | - | [`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. | - | [`Text line position parameters`]({{ site.dcv_parameters_reference }}text-line-specification/position.html) | Defines the position of the text lines with the vertices points. | - -## Character Model - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`DirectoryPath`]({{ site.dcv_parameters_reference }}character-model/directory-path.md) | Defines the path of character models. | - | [`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. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`BaseImageParameterName`]({{ site.dcv_parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.dcv_parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.dcv_parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.dcv_parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`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. | - | [`ScaleDownThreshold`]({{ site.dcv_parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.dcv_parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.dcv_parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.dcv_parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source Options - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`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. | - | [`DirectoryPath`]({{ site.dcv_parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. | - | [`FileFilter`]({{ site.dcv_parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`PDFReadingMode`]({{ site.dcv_parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.dcv_parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`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. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`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 | diff --git a/parameters/reference/index.md b/parameters/reference/index.md deleted file mode 100644 index 8631c41..0000000 --- a/parameters/reference/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Dynamsoft Label Recognizer Parameter Reference - Main Page -description: Dynamsoft Label Recognizer Parameter Reference - Main Page -keywords: parameter reference, parameters, label recognition -needAutoGenerateSidebar: false -permalink: /parameters/reference/index.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`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. | - | [`ImageSourceName`]({{ site.dcv_parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MinImageCaptureInterval`]({{ site.dcv_parameters_reference }}capture-vision-template/min-image-capture-interval.html) | Specifies the minimum time interval (in milliseconds) allowed between consecutive image captures. | - | [`MaxParallelTasks`]({{ site.dcv_parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputOriginalImage`]({{ site.dcv_parameters_reference }}capture-vision-template/output-original-Image.html) | Indicates whether DCV finally outputs the original input image. | - | [`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. | - | [`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. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`BaseTargetROIDefName`]({{ site.dcv_parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.dcv_parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`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. | - | [`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. | - -## Label Recognizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`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. | - | [`DictionaryCorrectionThresholds`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-correction-thresholds.html) | Sets the threshold of dictionary error correction. | - | [`DictionaryPath`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/dictionary-path.html) | Sets the path of the dictionary file.| - | [`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. | - | [`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. | - | [`MaxThreadsInOneTask`]({{ site.dcv_parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`SectionImageParameterArray`]({{ site.dcv_parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.dcv_parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.dcv_parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | - -## TextLine Specification - -| Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`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. | - | [`BaseTextLineSpecificationName`]({{ site.dcv_parameters_reference }}text-line-specification/base-text-line-specification-name.html) | Represents the name of another `TextLineSpecification` object to inherit from. | - | [`CharHeightRange`]({{ site.dcv_parameters_reference }}text-line-specification/char-height-range.html) | Defines the range of the character height. | - | [`CharacterModelName`]({{ site.dcv_parameters_reference }}text-line-specification/character-model-name.html) | Defines the name of the character model. | - | [`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. | - | [`Text line position parameters`]({{ site.dcv_parameters_reference }}text-line-specification/position.html) | Defines the position of the text lines with the vertices points. | - -## Character Model - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`DirectoryPath`]({{ site.dcv_parameters_reference }}character-model/directory-path.html) | Defines the path of character models. | - | [`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. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`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. | - | [`BaseImageParameterName`]({{ site.dcv_parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.dcv_parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.dcv_parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.dcv_parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.dcv_parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`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. | - | [`ScaleDownThreshold`]({{ site.dcv_parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.dcv_parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.dcv_parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.dcv_parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source Options - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`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. | - | [`DirectoryPath`]({{ site.dcv_parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. | - | [`FileFilter`]({{ site.dcv_parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`Pages`]({{ site.dcv_parameters_reference }}image-source-options/pages.html) | Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. | - | [`PDFReadingMode`]({{ site.dcv_parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.dcv_parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`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. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`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 | diff --git a/parameters/reference/inference-setting/index.md b/parameters/reference/inference-setting/index.md deleted file mode 100644 index 8aabe01..0000000 --- a/parameters/reference/inference-setting/index.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -layout: default-layout -title: InferenceSetting Object - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference - InferenceSetting Object. -keywords: parameter reference, parameters, InferenceSetting -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - InferenceSetting Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`InferenceSetting.Name`](#name) | The name of the InferenceSetting object. | - | [`InferenceSetting.FilteringConditions`](#filteringconditions) | Sets the filtering conditions of the InferenceSetting object. | - | [`InferenceSetting.ReferenceSettings`](#referencesettings) | Sets the reference settings of the InferenceSetting object. | - - -## Name -The name of the InferenceSetting object. - -**Remarks** -It must be a unique name. If it is referenced in a `TextArea` object through parameter [InferenceSettingName](../text-area/parameter-control.md#inferencesettingname), the TextArea object became a inference area, then DLR will use the relative position characteristics between text blocks to calculate the target label position. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| InferenceSetting | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"InferenceSetting1" -} -``` - - - -## FilteringConditions -The filtering conditions of the InferenceSetting object. It is used to determine whether the inference area is valid or not. - -### AreaType -Sets the condition level of the inference area. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| FilteringConditions | AreaType | *string* | "AT_ENTIRE"
    "AT_LINE_ALL"
    "AT_LINE_ANY"
    "AT_LINE_N"| "AT_ENTIRE" | - -- AT_ENTIRE: conditions on the oncatenated string -- AT_LINE_ALL: conditions on each of the line string -- AT_LINE_ANY: conditions on any of the line string -- AT_LINE_N: conditions on each specified line string - -**Json Parameter Example** -```json -{ - "FilteringConditions": - { - "AreaType": "AT_ENTIRE", - "RegEx": ".*b.*b.*b.*" - }, - -} -``` - - - -### RegEx -Sets the regular expression condition on the specified area. This parameter only takes effect when the `AreaType` parameter is specified as "AT_ENTIRE" OR "AT_LINE_ALL" OR "AT_LINE_ANY". - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| FilteringConditions | RegEx | *string* | | "" | - -**Json Parameter Example** -```json -{ - "FilteringConditions": - { - "AreaType": "AT_ENTIRE", - "RegEx": ".*b.*b.*b.*" - }, - -} -``` - - - - - -### LineArray -Sets the condition on each specified line. This parameter only takes effect when the `AreaType` parameter is specified as "AT_LINE_N". - -- LineNumber: A string of one or more of the following data,separated by commas:
    1. One int value which represents a specified line index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range;
    3. The value is 1-based. -- LineRegEx: The regular regression on the lines sepcified by `LineNumber`. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| FilteringConditions | LineArray | *Array* | null | - -**Json Parameter Example** -```json -{ - "FilteringConditions": - { - "AreaType": "AT_LINE_N", - "LineArray": - [ - { - "LineNumber": "1,3,5-7", - "LineRegEx":"Nutrition" - } - ] - }, - ...... -} -``` - - - - - -## ReferenceSettings -The reference settings of the InferenceSetting object. It is used to indicate which parts in the inference area should be referenced by the target Label. - -### TargetTextAreaNameArray -Sets the target area where the coordinates need to be inferred. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceSettings | TargetTextAreaNameArray | *Array* | null | - -**Json Parameter Example** -```json -{ - "ReferenceSettings": - [ - { - "TargetTextAreaNameArray":["TA_1"], - "ReferenceAreaType": "RAT_TEXT_LINE", - "LineNumber": "1,3-5", - "LineRegEx": "Sodium[(\w| )]*", - "RestrictedInInferenceArea": 1 - } - ] - -} -``` - - - -### ReferenceAreaType -Sets the reference source type. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| ReferenceSettings | ReferenceAreaType | *string* | "RAT_TEXT_AREA"
    "RAT_TEXT_LINE"| "RAT_TEXT_AREA" | - -- RAT_TEXT_AREA: The source postion is the quadrilateral coordinates of the text area. -- RAT_TEXT_LINE: The source postion is the quadrilateral coordinates of the specified line(s). - -**Json Parameter Example** -```json -{ - "ReferenceSettings": - [ - { - "TargetTextAreaNameArray":["TA_1"], - "ReferenceAreaType": "RAT_TEXT_LINE", - "LineNumber": "1,3-5", - "LineRegEx": "Sodium[(\w| )]*", - "RestrictedInInferenceArea": 1 - } - ] - -} -``` - - - -### LineNumber -Sets the source line(s) by specifying the line numbers. It is optional and only takes effect when the `ReferenceAreaType` parameter is specified as "RAT_TEXT_LINE". If both `LineNumber` and `LineRegEx` are specified, `LineNumber` has a higher priority than `LineRegEx`. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| ReferenceSettings | LineNumber | *string* | A string of one or more of the following data,separated by commas:
    1. One int value which represents a specified line index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range;
    3. The value is 1-based.| "" | - - -**Json Parameter Example** -```json -{ - "ReferenceSettings": - [ - { - "TargetTextAreaNameArray":["TA_1"], - "ReferenceAreaType": "RAT_TEXT_LINE", - "LineNumber": "1,3-5", - "LineRegEx": "Sodium[(\w| )]*", - "RestrictedInInferenceArea": 1 - } - ] - -} -``` - - - -### LineRegEx -Sets the source line(s) where the text satisfies the regular expression. It is optional and only takes effect when the `ReferenceAreaType` parameter is specified as "RAT_TEXT_LINE". If both `LineNumber` and `LineRegEx` are specified, `LineNumber` has a higher priority than `LineRegEx`. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceSettings | LineRegEx | *string* | "" | - - -**Json Parameter Example** -```json -{ - "ReferenceSettings": - [ - { - "TargetTextAreaNameArray":["TA_1"], - "ReferenceAreaType": "RAT_TEXT_LINE", - "LineNumber": "1,3-5", - "LineRegEx": "Sodium[(\w| )]*", - "RestrictedInInferenceArea": 1 - } - ] - -} -``` - - - -### RestrictedInInferenceArea -Set whether the target text area(s) is located inside the Inference Area or not. If the value is specified as 1, the target text area coordinates will be calculated by intersecting with the inference area. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceSettings | RestrictedInInferenceArea | *int* | 0 | - - -**Json Parameter Example** -```json -{ - "ReferenceSettings": - [ - { - "TargetTextAreaNameArray":["TA_1"], - "ReferenceAreaType": "RAT_TEXT_LINE", - "LineNumber": "1,3-5", - "LineRegEx": "Sodium[(\w| )]*", - "RestrictedInInferenceArea": 1 - } - ] - -} -``` - diff --git a/parameters/reference/label-recognition-parameter/binarization-modes-v1.0.md b/parameters/reference/label-recognition-parameter/binarization-modes-v1.0.md deleted file mode 100644 index a3a0b5a..0000000 --- a/parameters/reference/label-recognition-parameter/binarization-modes-v1.0.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default-layout -title: BinarizationModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - BinarizationModes. -keywords: BinarizationModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## BinarizationModes - -### Mode Properties -`BinarizationModes` is a parameter for setting the mode for binarization. It consisits of one or more `DLRBinarizationMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`DLRBinarizationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrbinarizationmode) array* | "DLR_BM_SKIP"
    "DLR_BM_AUTO"
    "DLR_BM_LOCAL_BLOCK" | ["DLR_BM_LOCAL_BLOCK", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP"] | - -- **See also**: - [`DLRBinarizationMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrbinarizationmode) - -#### Mode Arguments -- [BlockSizeX](#blocksizex) -- [BlockSizeY](#blocksizey) -- [EnableFillBinaryVacancy](#enablefillbinaryvacancy) -- [ThreshValueCoefficient](#threshvaluecoefficient) -- [LibraryFileName](#libraryfilename) -- [LibraryParameters](#libraryparameters) - -##### BlockSizeX -Sets the horizontal block size for the binarization process. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [0, 1000] | 0 | "DLR_BM_LOCAL_BLOCK" | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target regions localizing. - - - 0: the block size used for binarization will be set to a value which is calculated automatically. - - N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N. - - - - -##### BlockSizeY -Sets the vertical block size for the binarization process. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [0, 1000] | 0 | "DLR_BM_LOCAL_BLOCK" | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target regions localizing. - - - 0: the block size used for binarization will be set to a value which is calculated automatically. - - N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N.. - - -##### EnableFillBinaryVacancy -Sets whether to enable binary vacancy filling. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [0, 1] | 1 | "DLR_BM_LOCAL_BLOCK" | - -**Remarks** - 0: disable. - 1: enable. - - For character with large font-weight, there might be a vacant area in the position detection pattern after binarization. The vacant area may result in capturing failure. Setting this to True will fill in the vacant area with black and may help improve the capturing success rate. Better accuracy for characters with large font-weight. - - -##### ThreshValueCoefficient -Constant subtracted from the mean or weighted mean. Normally, it is positive but may be zero or negative as well. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [-255, 255] | 10 | "DLR_BM_LOCAL_BLOCK" | - - - -##### LibraryFileName -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `DLRBinarizationMode` items except DLR_BM_SKIP and DLR_BM_AUTO | - - -**Remarks** - - The library must be in the same place with Dynamsoft Label Recognition Library. - - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `DLRBinarizationMode` items except DLR_BM_SKIP and DLR_BM_AUTO | - - -### Setting Methods - -#### As JSON Parameter -`BinarizationModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for binarization. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | BinarizationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ - "BinarizationModes": [ - { - "Mode": "DLR_BM_LOCAL_BLOCK", - "BlockSizeX": 5, - "BlockSizeY": 5, - } - ] -} -``` - - -  diff --git a/parameters/reference/label-recognition-parameter/binarization-modes-v1.2.1.md b/parameters/reference/label-recognition-parameter/binarization-modes-v1.2.1.md deleted file mode 100644 index ed1db32..0000000 --- a/parameters/reference/label-recognition-parameter/binarization-modes-v1.2.1.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -layout: default-layout -title: BinarizationModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - BinarizationModes. -keywords: BinarizationModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## BinarizationModes - -### Mode Properties -`BinarizationModes` is a parameter for setting the mode for binarization. It consisits of one or more `DLRBinarizationMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`DLRBinarizationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrbinarizationmode) array* | "DLR_BM_SKIP"
    "DLR_BM_AUTO"
    "DLR_BM_LOCAL_BLOCK" | ["DLR_BM_LOCAL_BLOCK", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP", "DLR_BM_SKIP"] | - -- **See also**: - [`DLRBinarizationMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrbinarizationmode) - -#### Mode Arguments -- [BlockSizeX](#blocksizex) -- [BlockSizeY](#blocksizey) -- [EnableFillBinaryVacancy](#enablefillbinaryvacancy) -- [ThreshValueCoefficient](#threshvaluecoefficient) -- [BinarizationThreshold](#binarizationThreshold) - -##### BlockSizeX -Sets the horizontal block size for the binarization process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1000] | 0 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target region localizing. - - - 0: the block size used for binarization will be set to a value which is calculated automatically. - - N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N. - - - - -##### BlockSizeY -Sets the vertical block size for the binarization process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1000] | 0 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target region localizing. - - - 0: the block size used for binarization will be set to a value which is calculated automatically. - - N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N.. - - -##### EnableFillBinaryVacancy -Sets whether to enable binary vacancy filling. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1] | 1 | - -**Remarks** - 0: disable. - 1: enable. - - For characters with large font-weight, there might be a vacant area in the position detection pattern after binarization. The vacant area may result in capturing failure. Setting this to True will fill in the vacant area with black and may help improve the capturing success rate. Better accuracy for characters with large font-weight. - - -##### ThreshValueCoefficient -Constant subtracted from the mean or weighted mean. Normally, it is positive but may be zero or negative as well. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-255, 255] | 10 | - -##### BinarizationThreshold -Sets the binarization threshold. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 255] | -1 | - - -### Setting Methods - -#### As JSON Parameter -`BinarizationModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for binarization. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | BinarizationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "BinarizationModes": [ -        { -            "Mode": "DLR_BM_LOCAL_BLOCK", -            "BlockSizeX": 5, -            "BlockSizeY": 5, -        } -    ] -} -``` - - -  diff --git a/parameters/reference/label-recognition-parameter/binarization-modes.md b/parameters/reference/label-recognition-parameter/binarization-modes.md deleted file mode 100644 index aa2c40c..0000000 --- a/parameters/reference/label-recognition-parameter/binarization-modes.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -layout: default-layout -title: BinarizationModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - BinarizationModes. -keywords: BinarizationModes, LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LabelRecognizerParameter Object - -## BinarizationModes - -### Mode Properties -`BinarizationModes` is a parameter for setting the mode for binarization. It consisits of one or more `BinarizationMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`BinarizationMode`]({{ site.enumerations }}binarization-mode.html) array* | "BM_SKIP"
    "BM_AUTO"
    "BM_LOCAL_BLOCK"
    "BM_THRESHOLD" | ["BM_LOCAL_BLOCK", "BM_SKIP", "BM_SKIP", "BM_SKIP", "BM_SKIP", "BM_SKIP", "BM_SKIP", "BM_SKIP"] | - -- **See also**: - [`BinarizationMode` Enumeration]({{ site.enumerations }}binarization-mode.html) - -#### Mode Arguments - -- [LabelRecognizerParameter Object](#labelrecognizerparameter-object) - - [BinarizationModes](#binarizationmodes) - - [Mode Properties](#mode-properties) - - [Mode Arguments](#mode-arguments) - - [BlockSizeX](#blocksizex) - - [BlockSizeY](#blocksizey) - - [EnableFillBinaryVacancy](#enablefillbinaryvacancy) - - [ThresholdCompensation](#thresholdcompensation) - - [ThreshValueCoefficient](#threshvaluecoefficient) - - [BinarizationThreshold](#binarizationthreshold) - - [MorphOperation](#morphoperation) - - [MorphShape](#morphshape) - - [MorphOperationKernelSizeX](#morphoperationkernelsizex) - - [MorphOperationKernelSizeY](#morphoperationkernelsizey) - - [LibraryFileName](#libraryfilename) - - [LibraryParameters](#libraryparameters) - - [Setting Methods](#setting-methods) - - [As JSON Parameter](#as-json-parameter) - - [As `DLR_RuntimeSettings` Member](#as-dlr_runtimesettings-member) - -##### BlockSizeX - -Sets the horizontal block size for the binarization process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1000] | 0 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target region localizing. - - - 0: the block size used for binarization will be set to a value which is calculated automatically. - - N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N. - - - - -##### BlockSizeY -Sets the vertical block size for the binarization process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1000] | 0 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. An appropriate value for binarizationBlockSize can help generate a high quality binary image and increase the accuracy of target region localizing. - - - 0: the block size used for binarization will be set to a value which is calculated automatically. - - N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N.. - - -##### EnableFillBinaryVacancy -Sets whether to enable binary vacancy filling. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1] | 1 | - -**Remarks** - 0: disable. - 1: enable. - - For characters with large font-weight, there might be a vacant area in the position detection pattern after binarization. The vacant area may result in capturing failure. Setting this to True will fill in the vacant area with black and may help improve the capturing success rate. Better accuracy for characters with large font-weight. - - -##### ThresholdCompensation -Constant subtracted from the mean or weighted mean. Normally, it is positive but may be zero or negative as well. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-255, 255] | 10 | - -##### ThreshValueCoefficient -Deprecated. Use [ThresholdCompensation](#thresholdcompensation) instead. - - -##### BinarizationThreshold -Sets the binarization threshold. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 255] | -1 | - - - -##### MorphOperation -Sets the morph operation for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | "Erode"
    "Dilate"
    "Open"
    "Close" | "Close" | - -**Remarks** - - "Erode": Perform erosion process. - - "Dilate": Perform dilation process. - - "Open": Perform erosion first, then perform dilation. - - "Close": Perform dilation first, then perform erosion. - - For more information, please check out [Image Processing in OpenCV - Morphological Transformations](https://docs.opencv.org/master/d9/d61/tutorial_py_morphological_ops.html) for reference. - - -##### MorphShape - Sets the morph shape for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | "Rectangle"
    "Cross"
    "Ellipse" | "Rectangle" | - -**Remarks** - - "Rectangle": - - "Cross": - - "Ellipse": - - - -##### MorphOperationKernelSizeX -Sets the horizontal kernel size for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - - - -##### MorphOperationKernelSizeY - Sets the vertical kernel size for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - - -##### LibraryFileName - -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `BinarizationMode` items except BM_SKIP and BM_AUTO | - -- **Remarks** -- The library must be in the same place with Dynamsoft Label Recognizer Library. - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `BinarizationMode` items except BM_SKIP and BM_AUTO | - - -### Setting Methods - -#### As JSON Parameter -`BinarizationModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for binarization. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognizerParameter | BinarizationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "BinarizationModes": [ -        { -            "Mode": "BM_LOCAL_BLOCK", -            "BlockSizeX": 5, -            "BlockSizeY": 5, -        } -    ] -} -``` - - -#### As `DLR_RuntimeSettings` Member -`BinarizationModes` as a member of `DLR_RuntimeSettings` struct is a [`BinarizationMode`]({{ site.enumerations }}binarization-mode.html) array for setting the modes and the priority for binarization. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLR_RuntimeSettings`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) | [`binarizationModes`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html#binarizationmodes) | [`BinarizationMode`]({{ site.enumerations }}binarization-mode.html)[8] | - -**See Also** -- [`DLR_RuntimeSettings` Struct]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) -- [`BinarizationMode` Enumeration]({{ site.enumerations }}binarization-mode.html) - diff --git a/parameters/reference/label-recognition-parameter/character-normalization-modes.md b/parameters/reference/label-recognition-parameter/character-normalization-modes.md deleted file mode 100644 index 3cee4b1..0000000 --- a/parameters/reference/label-recognition-parameter/character-normalization-modes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default-layout -title: CharacterNormalizationModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - CharacterNormalizationModes . -keywords: CharacterNormalizationModes, LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LabelRecognizerParameter Object - -## CharacterNormalizationModes - -### Mode Properties -`CharacterNormalizationModes` is a parameter for setting the mode for character normalization. It consisits of one or more `CharacterNormalizationMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *`CharacterNormalizationMode` array* | "CNM_SKIP"
    "CNM_AUTO"
    "CNM_MORPH" | ["CNM_AUTO"] | - -#### Mode Arguments -- [MorphOperation](#morphoperation) -- [MorphArgument](#morphargument) - -##### MorphOperation -Sets the morph operation for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | "Erode"
    "Dilate"
    "Open"
    "Close" | "Close" | - -**Remarks** - - "Erode": Perform erosion process. - - "Dilate": Perform dilation process. - - "Open": Perform erosion first, then perform dilation. - - "Close": Perform dilation first, then perform erosion. - - For more information, please check out [Image Processing in OpenCV - Morphological Transformations](https://docs.opencv.org/master/d9/d61/tutorial_py_morphological_ops.html) for reference. - - -##### MorphArgument - Sets the morph argument for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing morph argument. Now it only indicates Morph kernel size. | "3" | - - -### Setting Methods - -#### As JSON Parameter -`CharacterNormalizationModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for character normalization. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognizerParameter | CharacterNormalizationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "CharacterNormalizationModes": [ -        { -            "Mode": "CNM_MORPH", -            "MorphOperation": "Close", -            "MorphArgument": "3", -        } -    ] -} -``` - diff --git a/parameters/reference/label-recognition-parameter/colour-conversion-modes.md b/parameters/reference/label-recognition-parameter/colour-conversion-modes.md deleted file mode 100644 index 4b135c6..0000000 --- a/parameters/reference/label-recognition-parameter/colour-conversion-modes.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -layout: default-layout -title: ColourConversionModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - ColourConversionModes. -keywords: ColourConversionModes, LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# LabelRecognizerParameter Object - -## ColourConversionModes - -### Mode Properties -`ColourConversionModes` is a parameter for setting the mode for converting a colour image to a grayscale image. It consisits of one or more `ColourConversionMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string array* or *[`ColourConversionMode`]({{ site.enumerations }}colour-conversion-mode.html) array* | "CICM_SKIP"
    "CICM_GENERAL"
    "CICM_HSV" | ["CICM_GENERAL", "CICM_SKIP", "CICM_SKIP", "CICM_SKIP", "CICM_SKIP", "CICM_SKIP", "CICM_SKIP", "CICM_SKIP"] | - -- **See also**: - [`ColourConversionMode` Enumeration]({{ site.enumerations }}colour-conversion-mode.html) - -#### Mode Arguments -- [LabelRecognizerParameter Object](#labelrecognizerparameter-object) - - [ColourConversionModes](#colourconversionmodes) - - [Mode Properties](#mode-properties) - - [Mode Arguments](#mode-arguments) - - [BlueChannelWeight](#bluechannelweight) - - [GreenChannelWeight](#greenchannelweight) - - [RedChannelWeight](#redchannelweight) - - [ReferChannel](#referchannel) - - [LibraryFileName](#libraryfilename) - - [LibraryParameters](#libraryparameters) - - [Setting Methods](#setting-methods) - - [As JSON Parameter](#as-json-parameter) - - [As `DLR_RuntimeSettings` Member](#as-dlr_runtimesettings-member) - -##### BlueChannelWeight -Sets the weight value of Blue Colour Channel used for converting a colour image to a grayscale image. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - -**Remarks** - -1: The weight value will be set automatically by the SDK. - - -##### GreenChannelWeight -Sets the weight value of Green Colour Channel used for converting a colour image to a grayscale image. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - -**Remarks** - -1: The weight value will be set automatically by the SDK. - - -##### RedChannelWeight -Sets the weight value of Red Colour Channel used for converting a colour image to a grayscale image. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - -**Remarks** - -1: The weight value will be set automatically by the SDK. - -##### ReferChannel -Sets reference channel used for converting a colour image to a grayscale image by HSV algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | "H_CHANNEL"
    "S_CHANNEL"
    "V_CHANNEL" | "H_CHANNEL" | - -##### LibraryFileName -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `ColourConversionMode` items except CICM_SKIP | - - -**Remarks** - The library must be in the same place with Dynamsoft Label Recognizer Library. - - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `ColourConversionMode` items except CICM_SKIP | - - -### Setting Methods - -#### As JSON Parameter -`ColourConversionModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority of the mode for converting a colour image to a grayscale image. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| ImageParameter | ColourConversionModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "ColourConversionModes": [ -        { -            "Mode": "CICM_GENERAL" -        } -    ] -} -``` - - - -#### As `DLR_RuntimeSettings` Member -`ColourConversionModes` is a [`ColourConversionMode`]({{ site.enumerations }}colour-conversion-mode.html) array defines in `furtherModes` which is a struct member of `DLR_RuntimeSettings`. It is used for setting the modes and the priority for converting a colour image to a grayscale image. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLR_RuntimeSettings`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html)->[`furtherModes`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html#furthermodes) | [`colourConversionModes`]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html#colourconversionmodes) | [`ColourConversionMode`]({{ site.enumerations }}colour-conversion-mode.html)[8] | - - -**See Also** -- [`DLR_RuntimeSettings` Struct]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) -- [`DLR_FurtherModes` Struct]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html) -- [`ColourConversionMode` Enumeration]({{ site.enumerations }}colour-conversion-mode.html) - diff --git a/parameters/reference/label-recognition-parameter/grayscale-enhancement-modes.md b/parameters/reference/label-recognition-parameter/grayscale-enhancement-modes.md deleted file mode 100644 index 279339d..0000000 --- a/parameters/reference/label-recognition-parameter/grayscale-enhancement-modes.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -layout: default-layout -title: GrayscaleEnhancementModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - GrayscaleEnhancementModes. -keywords: GrayscaleEnhancementModes, LabelRecognizerParameter, image process control parameters, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LabelRecognizerParameter Object - -## GrayscaleEnhancementModes - -### Mode Properties -`GrayscaleEnhancementModes` is a parameter for setting the mode for grayscale image preprocessing algorithms. It consisits of one or more `GrayscaleEnhancementMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string array* or *[`GrayscaleEnhancementMode`]({{ site.enumerations }}grayscale-enhancement-mode.html) array* | "GEM_SKIP"
    "GEM_AUTO"
    "GEM_GENERAL"
    "GEM_GRAY_EQUALIZE"
    "GEM_GRAY_SMOOTH"
    "GEM_SHARPEN_SMOOTH" | ["GEM_GENERAL", "GEM_SKIP", "GEM_SKIP", "GEM_SKIP", "GEM_SKIP", "GEM_SKIP", "GEM_SKIP", "GEM_SKIP"] | - -- **See also**: - [`GrayscaleEnhancementMode` Enumeration]({{ site.enumerations }}grayscale-enhancement-mode.html) - -#### Mode Arguments -- [LabelRecognizerParameter Object](#labelrecognizerparameter-object) - - [GrayscaleEnhancementModes](#grayscaleenhancementmodes) - - [Mode Properties](#mode-properties) - - [Mode Arguments](#mode-arguments) - - [Sensitivity](#sensitivity) - - [SmoothBlockSizeX](#smoothblocksizex) - - [SmoothBlockSizeY](#smoothblocksizey) - - [SharpenBlockSizeX](#sharpenblocksizex) - - [SharpenBlockSizeY](#sharpenblocksizey) - - [LibraryFileName](#libraryfilename) - - [LibraryParameters](#libraryparameters) - - [Setting Methods](#setting-methods) - - [As JSON Parameter](#as-json-parameter) - - [As `DLR_RuntimeSettings` Member](#as-dlr_runtimesettings-member) - -##### Sensitivity -Sets the sensitivity used for gray equalization. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [1, 9] | 5 | - -**Remarks** - If you have an image with a low level of contrast, you can set the property to a larger value. A larger value means a higher possibility that gray equalization will be activated. This may cause adverse effect on images with a high level of contrast. - - -##### SmoothBlockSizeX -Sets the horizontal block size for the smoothing process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [3, 1000] | 3 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate the threshold for the pixel. An appropriate value can help increase the accuracy of target region localizing. - - -##### SmoothBlockSizeY -Sets the vertical block size for the smoothing process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [3, 1000] | 3 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate the threshold for the pixel. An appropriate value can help increase the accuracy of target region localizing. - - -##### SharpenBlockSizeX -Sets the horizontal block size for the sharpening process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [3, 1000] | 3 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate the threshold for the pixel. An appropriate value can help increase the accuracy of target region localizing. - - -##### SharpenBlockSizeY -Sets the vertical block size for the sharpening process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [3, 1000] | 3 | - -**Remarks** - Block size refers to the size of a pixel neighborhood used to calculate the threshold for the pixel. An appropriate value can help increase the accuracy of target region localizing. - - - -##### LibraryFileName -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `GrayscaleEnhancementMode` items except GEM_SKIP and GEM_AUTO | - - -**Remarks** - The library must be in the same place with Dynamsoft Label Recognizer Library. - - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `GrayscaleEnhancementMode` items except GEM_SKIP and GEM_AUTO | - - -### Setting Methods - -#### As JSON Parameter -`GrayscaleEnhancementModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for image preprocessing algorithms. -Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognizerParameter | GrayscaleEnhancementModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "GrayscaleEnhancementModes": [ -        { -            "Mode": "GEM_GRAY_EQUALIZE", -            "Sensitivity": 5 -        }, -        { -            "Mode": "GEM_SHARPEN_SMOOTH", -            "SmoothBlockSizeX": 5, -            "SmoothBlockSizeY": 5, -            "SharpenBlockSizeX": 5, -            "SharpenBlockSizeY": 5 -        } -    ] -} -``` - - -#### As `DLR_RuntimeSettings` Member -`GrayscaleEnhancementModes` is a [`GrayscaleEnhancementMode`]({{ site.enumerations }}grayscale-enhancement-mode.html) array defines in `furtherModes` which is a struct member of `DLR_RuntimeSettings`. It is used for setting the modes and the priority for image preprocessing algorithms. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLR_RuntimeSettings`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html)->[`furtherModes`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html#furthermodes) | [`grayscaleEnhancementModes`]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html#grayscaleenhancementmodes) | [`GrayscaleEnhancementMode`]({{ site.enumerations }}grayscale-enhancement-mode.html)[8] | - -**See Also** -- [`DLR_RuntimeSettings` Struct]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) -- [`DLR_FurtherModes` Struct]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html) -- [`GrayscaleEnhancementMode` Enumeration]({{ site.enumerations }}grayscale-enhancement-mode.html) diff --git a/parameters/reference/label-recognition-parameter/grayscale-transformation-modes-v1.0.md b/parameters/reference/label-recognition-parameter/grayscale-transformation-modes-v1.0.md deleted file mode 100644 index 3a86f57..0000000 --- a/parameters/reference/label-recognition-parameter/grayscale-transformation-modes-v1.0.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -layout: default-layout -title: GrayscaleTransformationModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - GrayscaleTransformationModes. -keywords: GrayscaleTransformationModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- - - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## GrayscaleTransformationModes - -### Mode Properties -`GrayscaleTransformationModes` is a parameter for setting the mode for the grayscale image conversion. It consisits of one or more `DLRGrayscaleTransformationMode` items. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`DLRGrayscaleTransformationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) array* | "DLR_GTM_SKIP"
    "DLR_GTM_INVERTED"
    "DLR_GTM_ORIGINAL" | ["DLR_GTM_ORIGINAL", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP"] | - -- **See also**: - [`DLRGrayscaleTransformationMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) - -#### Mode Arguments -- [LibraryFileName](#libraryfilename) -- [LibraryParameters](#libraryparameters) - -##### LibraryFileName -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `DLRGrayscaleTransformationMode` items except DLR_GTM_SKIP | - - -**Remarks** - - The library must be in the same place with Dynamsoft Label Recognition Library. - - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `DLRGrayscaleTransformationMode` items except DLR_GTM_SKIP | - - -### Setting Methods - -#### As JSON Parameter -`GrayscaleTransformationModes` as a JSON parameter is a JSON Object array. ach JSON Object has a key `Mode` for setting the mode, and the array index decides the priority of the mode for the grayscale image conversion. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | GrayscaleTransformationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ - "GrayscaleTransformationModes": [ - { - "Mode": "DLR_GTM_INVERTED" - }, - { - "Mode": "DLR_GTM_ORIGINAL" - } - ] -} -``` - -  - - -#### As `DLRRuntimeSettings` Member -`GrayscaleTransformationModes` is a [`DLRGrayscaleTransformationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) array defines in `furtherModes` which is a struct member of `DLRRuntimeSettings`. It is used for setting the modes and the priority for the grayscale image conversion. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLRRuntimeSettings`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) | [`grayscaleTransformationModes`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html#grayscaletransformationmodes) | [`DLRGrayscaleTransformationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode)[8] | - -**See Also** -- [`DLRRuntimeSettings` Struct]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) -- [`DLRGrayscaleTransformationMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) diff --git a/parameters/reference/label-recognition-parameter/grayscale-transformation-modes-v1.2.1.md b/parameters/reference/label-recognition-parameter/grayscale-transformation-modes-v1.2.1.md deleted file mode 100644 index 02da126..0000000 --- a/parameters/reference/label-recognition-parameter/grayscale-transformation-modes-v1.2.1.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -layout: default-layout -title: GrayscaleTransformationModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - GrayscaleTransformationModes. -keywords: GrayscaleTransformationModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- - - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## GrayscaleTransformationModes - -### Mode Properties -`GrayscaleTransformationModes` is a parameter for setting the mode for the grayscale image conversion. It consisits of one or more `DLRGrayscaleTransformationMode` items. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`DLRGrayscaleTransformationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) array* | "DLR_GTM_SKIP"
    "DLR_GTM_INVERTED"
    "DLR_GTM_ORIGINAL" | ["DLR_GTM_ORIGINAL", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP", "DLR_GTM_SKIP"] | - -- **See also**: - [`DLRGrayscaleTransformationMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) - - -### Setting Methods - -#### As JSON Parameter -`GrayscaleTransformationModes` as a JSON parameter is a JSON Object array. ach JSON Object has a key `Mode` for setting the mode, and the array index decides the priority of the mode for the grayscale image conversion. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | GrayscaleTransformationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "GrayscaleTransformationModes": [ -        { -            "Mode": "DLR_GTM_INVERTED" -        }, - { - "Mode": "DLR_GTM_ORIGINAL" - } -    ] -} -``` - -  - - -#### As `DLRRuntimeSettings` Member -`GrayscaleTransformationModes` is a [`DLRGrayscaleTransformationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) array defines in `DLRRuntimeSettings`. It is used for setting the modes and the priority for the grayscale image conversion. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLRRuntimeSettings`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) | [`grayscaleTransformationModes`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html#grayscaletransformationmodes) | [`DLRGrayscaleTransformationMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode)[8] | - -**See Also** -- [`DLRRuntimeSettings` Struct]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) -- [`DLRGrayscaleTransformationMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrgrayscaletransformationmode) diff --git a/parameters/reference/label-recognition-parameter/grayscale-transformation-modes.md b/parameters/reference/label-recognition-parameter/grayscale-transformation-modes.md deleted file mode 100644 index 45e0d0d..0000000 --- a/parameters/reference/label-recognition-parameter/grayscale-transformation-modes.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default-layout -title: GrayscaleTransformationModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - GrayscaleTransformationModes. -keywords: GrayscaleTransformationModes, LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# LabelRecognizerParameter Object - -## GrayscaleTransformationModes - -### Mode Properties -`GrayscaleTransformationModes` is a parameter for setting the mode for the grayscale image conversion. It consisits of one or more `GrayscaleTransformationMode` items. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`GrayscaleTransformationMode`]({{ site.enumerations }}grayscale-transformation-mode.html) array* | "GTM_SKIP"
    "GTM_INVERTED"
    "GTM_ORIGINAL" | ["GTM_ORIGINAL", "GTM_SKIP", "GTM_SKIP", "GTM_SKIP", "GTM_SKIP", "GTM_SKIP", "GTM_SKIP", "GTM_SKIP"] | - -- **See also**: - [`GrayscaleTransformationMode` Enumeration]({{ site.enumerations }}grayscale-transformation-mode.html) - - -### Setting Methods - -#### As JSON Parameter -`GrayscaleTransformationModes` as a JSON parameter is a JSON Object array. ach JSON Object has a key `Mode` for setting the mode, and the array index decides the priority of the mode for the grayscale image conversion. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | GrayscaleTransformationModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "GrayscaleTransformationModes": [ -        { -            "Mode": "GTM_INVERTED" -        }, - { - "Mode": "GTM_ORIGINAL" - } -    ] -} -``` - - - -#### As `DLR_RuntimeSettings` Member -`GrayscaleTransformationModes` is a [`GrayscaleTransformationMode`]({{ site.enumerations }}grayscale-transformation-mode.html) array defines in `DLRRuntimeSettings`. It is used for setting the modes and the priority for the grayscale image conversion. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLR_RuntimeSettings`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html)->[`furtherModes`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html#furthermodes) | [`grayscaleTransformationModes`]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html#grayscaletransformationmodes) | [`GrayscaleTransformationMode`]({{ site.enumerations }}grayscale-transformation-mode.html)[8] | - -**See Also** -- [`DLR_RuntimeSettings` Struct]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) -- [`GrayscaleTransformationMode` Enumeration]({{ site.enumerations }}grayscale-transformation-mode.html) diff --git a/parameters/reference/label-recognition-parameter/index-v1.0.md b/parameters/reference/label-recognition-parameter/index-v1.0.md deleted file mode 100644 index 300649a..0000000 --- a/parameters/reference/label-recognition-parameter/index-v1.0.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default-layout -title: LabelRecognitionParameter Object - Dynamsoft Label Recognition Parameter Reference -description: This page shows Dynamsoft Label Recognition Parameter Reference - LabelRecognitionParameter Object. -keywords: parameter reference, parameters, LabelRecognitionParameter -needAutoGenerateSidebar: false -needGenerateH3Content: false ---- - - -# Dynamsoft Label Recognition SDK - LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - diff --git a/parameters/reference/label-recognition-parameter/index-v1.2.1.md b/parameters/reference/label-recognition-parameter/index-v1.2.1.md deleted file mode 100644 index ae32ae0..0000000 --- a/parameters/reference/label-recognition-parameter/index-v1.2.1.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default-layout -title: LabelRecognitionParameter Object - Dynamsoft Label Recognition Parameter Reference -description: This page shows Dynamsoft Label Recognition Parameter Reference - LabelRecognitionParameter Object. -keywords: parameter reference, parameters, LabelRecognitionParameter -needAutoGenerateSidebar: false -needGenerateH3Content: false ---- - - -# Dynamsoft Label Recognition SDK - LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxLineCharacterSpacing`](parameter-control.md#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.Pages`](parameter-control.md#pages) | Sets the specific pages or the range of pages of a file (.tiff or .pdf) for label recognition. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for label recognition. | - | [`LabelRecognitionParameter.ScaleUpModes`](scale-up-modes.md#scaleupmodes) | Sets the mode and priority to control the scale-up process for text line with small letter height. | - | [`LabelRecognitionParameter.TextStringLengthRange`](parameter-control.md#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`LabelRecognitionParameter.Timeout`](parameter-control.md#timeout) | Sets the maximum amount of time (in milliseconds) that should be spent searching for labels on each page. | - diff --git a/parameters/reference/label-recognition-parameter/index-v2.0.md b/parameters/reference/label-recognition-parameter/index-v2.0.md deleted file mode 100644 index 40f826b..0000000 --- a/parameters/reference/label-recognition-parameter/index-v2.0.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: LabelRecognizerParameter Object - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference - LabelRecognizerParameter Object. -keywords: parameter reference, parameters, LabelRecognizerParameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - LabelRecognizerParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognizerParameter.Name`](parameter-control.md#name) | The name of the LabelRecognizerParameter object. | - | [`LabelRecognizerParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognizerParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | -| [`LabelRecognizerParameter.ColourConversionModes`](colour-conversion-modes.md#colourconversionmodes) | Sets the mode and priority for converting a colour image to a grayscale image. | - | [`LabelRecognizerParameter.DictionaryCorrectionThresholds`](parameter-control.md#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`LabelRecognizerParameter.DictionaryPath`](parameter-control.md#dictionarypath) | Sets the path of the dictionary file. | - | [`LabelRecognizerParameter.GrayscaleEnhancementModes`](grayscale-enhancement-modes.md#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`LabelRecognizerParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognizerParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognizerParameter.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LabelRecognizerParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognizerParameter.MaxLineCharacterSpacing`](parameter-control.md#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`LabelRecognizerParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognizerParameter.Pages`](parameter-control.md#pages) | Sets the specific pages or the range of pages of a file (.tiff or .pdf) for label recognition. | - | [`LabelRecognizerParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognizerParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for label recognition. | - | [`LabelRecognizerParameter.ScaleUpModes`](scale-up-modes.md#scaleupmodes) | Sets the mode and priority to control the scale-up process for text line with small letter height. | - | [`LabelRecognizerParameter.TextStringLengthRange`](parameter-control.md#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`LabelRecognizerParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`LabelRecognizerParameter.TextureDetectionModes`](texture-detection-modes.md#texturedetectionmodes) | Sets the mode and priority for texture detection. | - | [`LabelRecognizerParameter.Timeout`](parameter-control.md#timeout) | Sets the maximum amount of time (in milliseconds) that should be spent searching for labels on each page. | \ No newline at end of file diff --git a/parameters/reference/label-recognition-parameter/index.md b/parameters/reference/label-recognition-parameter/index.md deleted file mode 100644 index 2c251af..0000000 --- a/parameters/reference/label-recognition-parameter/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default-layout -title: LabelRecognizerParameter Object - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference - LabelRecognizerParameter Object. -keywords: parameter reference, parameters, LabelRecognizerParameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - LabelRecognizerParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognizerParameter.Name`](parameter-control.md#name) | The name of the LabelRecognizerParameter object. | - | [`LabelRecognizerParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognizerParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | -| [`LabelRecognizerParameter.ColourConversionModes`](colour-conversion-modes.md#colourconversionmodes) | Sets the mode and priority for converting a colour image to a grayscale image. | - | [`LabelRecognizerParameter.CharacterNormalizationModes`](character-normalization-modes.md#characternormalizationmodes) | Sets the mode and priority for character normalization. | - | [`LabelRecognizerParameter.DictionaryCorrectionThresholds`](parameter-control.md#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`LabelRecognizerParameter.DictionaryPath`](parameter-control.md#dictionarypath) | Sets the path of the dictionary file. | - | [`LabelRecognizerParameter.GrayscaleEnhancementModes`](grayscale-enhancement-modes.md#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`LabelRecognizerParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognizerParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognizerParameter.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LabelRecognizerParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognizerParameter.MaxLineCharacterSpacing`](parameter-control.md#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`LabelRecognizerParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognizerParameter.Pages`](parameter-control.md#pages) | Sets the specific pages or the range of pages of a file (.tiff or .pdf) for label recognition. | - | [`LabelRecognizerParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognizerParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for label recognition. | - | [`LabelRecognizerParameter.ScaleUpModes`](scale-up-modes.md#scaleupmodes) | Sets the mode and priority to control the scale-up process for text line with small letter height. | - | [`LabelRecognizerParameter.TextStringLengthRange`](parameter-control.md#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`LabelRecognizerParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`LabelRecognizerParameter.TextureDetectionModes`](texture-detection-modes.md#texturedetectionmodes) | Sets the mode and priority for texture detection. | - | [`LabelRecognizerParameter.Timeout`](parameter-control.md#timeout) | Sets the maximum amount of time (in milliseconds) that should be spent searching for labels on each page. | \ No newline at end of file diff --git a/parameters/reference/label-recognition-parameter/parameter-control-v1.0.md b/parameters/reference/label-recognition-parameter/parameter-control-v1.0.md deleted file mode 100644 index 4f4c4ee..0000000 --- a/parameters/reference/label-recognition-parameter/parameter-control-v1.0.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object. -keywords: LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - - ---- - - -## Name -The name of the LabelRecognitionParameter object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LabelRecognitionParameter1" -} -``` - -  - - -## [BinarizationModes](binarization-modes.md#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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - -  - -## [GrayscaleTransformationModes](grayscale-transformation-modes.md#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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | LetterHeightRange | *int array* | [1,100,1] | - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | LinesCount | *int* | [0, 200] | 0 | - - -**Json Parameter Example** -```json -{ - "LinesCount":1 -} -``` - -  - -## 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. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "LineStringRegExPattern":"" -} -``` - -  - -## MaxThreadCount -Sets the maximum number of threads the algorithm will use to recognize text. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | MaxThreadCount | *int* | [1, 4] | 4 | - - -**Json Parameter Example** -```json -{ - "MaxThreadCount":1 -} -``` - -  - -## ReferenceRegionNameArray -The name array of the ReferenceRegion object(s). - -**Remarks** -An array item is a name of any available `ReferenceRegion`. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | ReferenceRegionNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "ReferenceRegionNameArray":[ - "Region1", - "Region2" - ] -} -``` - -  - -## [RegionPredetectionModes](region-predetection-modes.md#regionpredetectionmodes) -  - -## TextRegExPattern -Specifies the regular expression pattern of the text to recognize. - -**Remarks** -All TextArea Objects without TextRegExPattern set will be set from this setting. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "TextRegExPattern":"" -} -``` - -  - diff --git a/parameters/reference/label-recognition-parameter/parameter-control-v1.2.1.md b/parameters/reference/label-recognition-parameter/parameter-control-v1.2.1.md deleted file mode 100644 index 6630455..0000000 --- a/parameters/reference/label-recognition-parameter/parameter-control-v1.2.1.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object. -keywords: LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxLineCharacterSpacing`](#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`LabelRecognitionParameter.MaxThreadCount`](#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.Pages`](#pages) | Sets the specific pages or the range of pages of a file (.tiff or .pdf) for label recognition. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](region-predetection-modes.md#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextStringLengthRange`](#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`LabelRecognitionParameter.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`LabelRecognitionParameter.Timeout`](#timeout) | Sets the maximum amount of time (in milliseconds) that should be spent searching for labels on each page. | - - ---- - - -## Name -The name of the LabelRecognitionParameter object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LabelRecognitionParameter1" -} -``` - -  - - -## [BinarizationModes](binarization-modes.md#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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - -  - -## [GrayscaleTransformationModes](grayscale-transformation-modes.md#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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | LetterHeightRange | *int array* | [1,100,1] | - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | LinesCount | *int* | [0, 200] | 0 | - - -**Json Parameter Example** -```json -{ - "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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "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`](#textregexpattern). - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | MaxLineCharacterSpacing | *int* | [0, 0x7fffffff] | 0 | - - -**Json Parameter Example** -```json -{ - "MaxLineCharacterSpacing":200 -} -``` - -  - -## MaxThreadCount -Sets the maximum number of threads the algorithm will use to recognize text. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | MaxThreadCount | *int* | [1, 4] | 4 | - - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | Pages | *string* | A string of one or more of the following data, separated by commas:
    1. One int value which represents a specified page index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified page index range; | "" | - - -**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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | ReferenceRegionNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "ReferenceRegionNameArray":[ - "Region1", - "Region2" - ] -} -``` - -  - -## [RegionPredetectionModes](region-predetection-modes.md#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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | TextStringLengthRange | *JSON Object* | `null` | - -**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: - -| characters | matches | -| ---------- | ------- | -| \d | a decimal digit character (same as "[0-9]"). | -| \D | any character that is not a decimal digit character (same as "[^0-9]"). | -| \s | a whitespace character (same as " " or "[ ]"). | -| \S | any character that is not a whitespace character (same as "[^ ]"). | -| \w | an alphanumeric or underscore character (same as "[0-9A-z_]"). | -| \W | any character that is not an alphanumeric or underscore character (same as "[^0-9A-z_]"). | -| [class] | any character that is part of the class. | -| [^class] | any character that is not part of the class. | -| * | The preceding atom is matched 0 or more times. | -| + | The preceding atom is matched 1 or more times. | -| ? | The preceding atom is optional (matched either 0 times or once). | -| (subpattern) | Groups a sequence of subpatterns as a matching atom. | -| {`n`} | The preceding atom is matched exactly `n` times. | -| {`min`,} | The preceding atom is matched `min` or more times. | -| {,`max`} | The preceding atom is matched at least 0 times, but not more than `max`. | -| {`min`,`max`} | The preceding atom is matched at least `min` times, but not more than `max`. | -| {(`n`)} | The preceding atom matches exactly `n` characters. | -| {(`min`,)} | The preceding atom matches `min` or more characters. | -| {(,`max`)} | The preceding atom matches at least 0 characters, but not more than `max`. | -| {(`min`,`max`)} | The preceding atom matches at least `min` characters, but not more than `max`. | -| [(`string1`,`string2`,...)] | any case insensitive string that is one of the listed strings separated by commas (,). For example: [(CAN,USA)] matches CAN, USA or can. | -| [(`minnumericstring`-`maxnumericstring`)] | a numeric string that is between `minnumericstring` and `maxnumericstring`. For example: [(01-12)] matches 01, 02, 03, ... until 12). | - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognitionParameter | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognitionParameter | Timeout | *int* | [0,0x7fffffff] | 10000 | - -**Json Parameter Example** -``` -{ - "Timeout":10000 -} -``` - -  diff --git a/parameters/reference/label-recognition-parameter/parameter-control.md b/parameters/reference/label-recognition-parameter/parameter-control.md deleted file mode 100644 index 3371901..0000000 --- a/parameters/reference/label-recognition-parameter/parameter-control.md +++ /dev/null @@ -1,401 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object. -keywords: LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LabelRecognizerParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognizerParameter.Name`](#name) | The name of the LabelRecognizerParameter object. | - | [`LabelRecognizerParameter.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognizerParameter.DictionaryCorrectionThresholds`](#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`LabelRecognizerParameter.DictionaryPath`](#dictionarypath) | Sets the path of the dictionary file. | - | [`LabelRecognizerParameter.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognizerParameter.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LabelRecognizerParameter.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognizerParameter.MaxLineCharacterSpacing`](#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`LabelRecognizerParameter.MaxThreadCount`](#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognizerParameter.Pages`](#pages) | Sets the specific pages or the range of pages of a file (.tiff or .pdf) for label recognition. | - | [`LabelRecognizerParameter.ReferenceRegionNameArray`](#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognizerParameter.TextStringLengthRange`](#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`LabelRecognizerParameter.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`LabelRecognizerParameter.Timeout`](#timeout) | Sets the maximum amount of time (in milliseconds) that should be spent searching for labels on each page. | - ---- - - -## Name -The name of the LabelRecognizerParameter object. - -**Remarks** -It must be a unique name. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LabelRecognizerParameter1" -} -``` - - -## 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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - - -## 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, ByThousandth] -The allowed values for MinHeight/MaxHeight: -ByThousandth=0, [1, 0x7fffffff] -ByThousandth=1, [1, 1000] -The allowed values for ByThousandth: [0,1] -All TextArea Objects without LetterHeightRange set will be set from this setting. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | LetterHeightRange | *int array* | [1,1000,1] | - -**Json Parameter Example** -```json -{ - "LetterHeightRange":[40,60,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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "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`](#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognizerParameter | MaxLineCharacterSpacing | *int* | [0, 0x7fffffff] | 0 | - - -**Json Parameter Example** -```json -{ - "MaxLineCharacterSpacing":200 -} -``` - - - -## MaxThreadCount -Sets the maximum number of threads the algorithm will use to recognize text. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognizerParameter | MaxThreadCount | *int* | [1, 4] | 4 | - - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognizerParameter | Pages | *string* | A string of one or more of the following data, separated by commas:
    1. One int value which represents a specified page index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified page index range; | "" | - - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | ReferenceRegionNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "ReferenceRegionNameArray":[ - "Region1", - "Region2" - ] -} -``` - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | TextStringLengthRange | *JSON Object* | `null` | - -**Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "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: - -| characters | matches | -| ---------- | ------- | -| \d | a decimal digit character (same as "[0-9]"). | -| \D | any character that is not a decimal digit character (same as "[^0-9]"). | -| \s | a whitespace character (same as " " or "[ ]"). | -| \S | any character that is not a whitespace character (same as "[^ ]"). | -| \w | an alphanumeric or underscore character (same as "[0-9A-z_]"). | -| \W | any character that is not an alphanumeric or underscore character (same as "[^0-9A-z_]"). | -| [class] | any character that is part of the class. | -| [^class] | any character that is not part of the class. | -| * | The preceding atom is matched 0 or more times. | -| + | The preceding atom is matched 1 or more times. | -| ? | The preceding atom is optional (matched either 0 times or once). | -| (subpattern) | Groups a sequence of subpatterns as a matching atom. | -| {`n`} | The preceding atom is matched exactly `n` times. | -| {`min`,} | The preceding atom is matched `min` or more times. | -| {,`max`} | The preceding atom is matched at least 0 times, but not more than `max`. | -| {`min`,`max`} | The preceding atom is matched at least `min` times, but not more than `max`. | -| {(`n`)} | The preceding atom matches exactly `n` characters. | -| {(`min`,)} | The preceding atom matches `min` or more characters. | -| {(,`max`)} | The preceding atom matches at least 0 characters, but not more than `max`. | -| {(`min`,`max`)} | The preceding atom matches at least `min` characters, but not more than `max`. | -| [(`string1`,`string2`,...)] | any case insensitive string that is one of the listed strings separated by commas (,). For example: [(CAN,USA)] matches CAN, USA or can. | -| [(`minnumericstring`-`maxnumericstring`)] | a numeric string that is between `minnumericstring` and `maxnumericstring`. For example: [(01-12)] matches 01, 02, 03, ... until 12). | - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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 Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LabelRecognizerParameter | Timeout | *int* | [0,0x7fffffff] | 10000 | - -**Json Parameter Example** -```json -{ - "Timeout":10000 -} -``` - - - - - -## DictionaryPath -Sets the path of the dictionary file. - -**Remarks** -If the parameter is not defined in `TextArea`, it will be inherited. Otherwise, the value will be overwritten. - -**As Json Parameter** - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | DictionaryPath | *string* | "" | - -**Json Parameter Example** -```json -{ - "DictionaryPath":"D:\\DictModel\\nutrition.txt" -} -``` - - - - -## DictionaryCorrectionThresholds -Sets the threshold of dictionary error correction. - -**Remarks** -It supports segmentation threshold. If the parameter is not defined in `TextArea`, it will be inherited. Otherwise, the value will be overwritten. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LabelRecognizerParameter | DictionaryCorrectionThresholds | *Array* | `null` | - -- MinWordLength: The minimum value of word length. -- MaxWordLength: The maximum value of word length. -- Threshold: The threshold for the number of error correction characters. - -**Json Parameter Example** -```json -{ - "DictionaryCorrectionThresholds": [ - { - "MinWordLength": 3, - "MaxWordLength": 5, - "Threshold": 1 - }, - { - "MinWordLength": 6, - "MaxWordLength": 10, - "Threshold": 2 - }, - { - "MinWordLength": 11, - "Threshold": 3 - } - ] - -} -``` diff --git a/parameters/reference/label-recognition-parameter/region-predetection-modes-v1.0.md b/parameters/reference/label-recognition-parameter/region-predetection-modes-v1.0.md deleted file mode 100644 index 5b0d217..0000000 --- a/parameters/reference/label-recognition-parameter/region-predetection-modes-v1.0.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -layout: default-layout -title: RegionPredetectionModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - RegionPredetectionModes. -keywords: RegionPredetectionModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## RegionPredetectionModes - -**Remarks** - -If the image is large and the target region on the image is very small, it is recommended to enable region predetection to speed up the localization process and recognition accuracy. - -### Mode Properties -`RegionPredetectionModes` is a parameter for setting the mode for region pre-detection. It consisits of one or more `DLRRegionPredetectionMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`DLRRegionPredetectionMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) array* | "DLR_RPM_SKIP"
    "DLR_RPM_AUTO"
    "DLR_RPM_GENERAL"
    "DLR_RPM_GENERAL_RGB_CONTRAST"
    "DLR_RPM_GENERAL_GRAY_CONTRAST"
    "DLR_RPM_GENERAL_HSV_CONTRAST" | ["DLR_RPM_GENERAL", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP"] | - -- **See also**: - [`DLRRegionPredetectionMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) - -#### Mode Arguments -- [AspectRatioRange](#aspectratiorange ) -- [ForeAndBackgroundColours](#foreandbackgroundcolours ) -- [HeightRange](#heightrange) -- [MinImageDimension](#minimagedimension) -- [FindAccurateBoundary](#findaccurateboundary) -- [Sensitivity](#sensitivity) -- [SpatialIndexBlockSize](#spatialindexblocksize) -- [WidthRange](#widthrange) -- [LibraryFileName](#libraryfilename) -- [LibraryParameters](#libraryparameters) - -##### AspectRatioRange -Sets the aspect ratio range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing aspect ratio range. | "" | "DLR_RPM_GENERAL_HSV_CONTRAST" | - - -**Remarks** - - The aspect ratio range need to be defined as [`MinAspectRatio`, `MaxAspectRatio`]. There will be no limitation without manual setting. - - Aspect ratio equals to *height/width\*100*. `MinAspectRatio` and `MaxAspectRatio` are used for limiting the aspect ratio range of the predetected region. - - Value range of `MinAspectRatio`, `MaxAspectRatio`: [1,10000] - - -##### ForeAndBackgroundColours -Specifies a set (or multiple sets) of the foreground and background colours used for region predetection algorithm. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing one or more colour sets. | "" | "DLR_RPM_GENERAL_HSV_CONTRAST" | - - -**Remarks** - - Each set of the foreground and background colours need to be defined as [`ForegroundColour`, `BackgroundColour`, `Tolerance`]. If you want to define multiple sets, you can use a "";"" to separate them. This argument is **mandatory**. If there is no manual setting, no region can be detected. - - `ForegroundColour`and `BackgroundColour` are the Hue values in the HSV colour space for defining the foreground and background colours of the regions you want to predetect. The value -1 means black, gray, white. - - `Tolerance` is the allowable deviation of the Hue value defined by `ForegroundColour`. - - Value range of `ForegroundColour`, `BackgroundColour`: [-1,360] - - Value range of `Tolerance`: [0, 360] - - - -##### HeightRange -Sets the height range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing height range. | "" | "DLR_RPM_GENERAL_HSV_CONTRAST" | - - -**Remarks** - - The height range need to be defined as [`MinHeight`, `MaxHeight`]. There will be no limitation without manual setting. - - Value range of `MinHeight`, `MaxHeight`: [1,0x7fffffff] - - - -##### MinImageDimension -Sets the minimum image dimension (in pixels) to pre-detect target regions. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [16384, 0x7fffffff] | 262144 | "DLR_RPM_GENERAL_GRAY_CONTRAST"
    "DLR_RPM_GENERAL_HSV_CONTRAST"
    "DLR_RPM_GENERAL_RGB_CONTRAST" | - -**Remarks** - If the image dimension is larger than the given value, the library will enable the feature of pre-detecting target regions. Otherwise, it will skip this step when searching for target regions. - - -##### FindAccurateBoundary -Sets whether to enable finding accurate boundary. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [0, 1] | 0 | "DLR_RPM_GENERAL_HSV_CONTRAST" | - -**Remarks** - 0: disable.
    - 1: enable. - -##### Sensitivity -Sets the sensitivity used for region predetection algorithm. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [1, 9] | 1 | "DLR_RPM_GENERAL_GRAY_CONTRAST"
    "DLR_RPM_GENERAL_HSV_CONTRAST"
    "DLR_RPM_GENERAL_RGB_CONTRAST" | - -**Remarks** - A larger value means the library will take more effort to detect regions. - -##### SpatialIndexBlockSize -Sets the spatial index block size used for region predetection algorithm. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *int* | [1, 32] | 5 | "DLR_RPM_GENERAL_GRAY_CONTRAST"
    "DLR_RPM_GENERAL_HSV_CONTRAST"
    "DLR_RPM_GENERAL_RGB_CONTRAST" | - -**Remarks** - The block size used for region predetection would be 2 to the power of N. The allowed values of SpatialIndexBlockSize is the power number (N=1,2,3...). - - - -##### WidthRange -Sets the width range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing width range. | "" | "DLR_RPM_GENERAL_HSV_CONTRAST" | - - -**Remarks** - - The width range need to be defined as [`MinWidth`, `MaxWidth`]. There will be no limitation without manual setting. - - Value range of `MinWidth`, `MaxWidth`: [1,0x7fffffff] - - -##### LibraryFileName -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `DLRRegionPredetectionMode` items except DLR_RPM_SKIP and DLR_RPM_AUTO | - - -**Remarks** - - The library must be in the same place with Dynamsoft Label Recognition Library. - - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid Modes | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `DLRRegionPredetectionMode` items except DLR_RPM_SKIP and DLR_RPM_AUTO | - - - -### Setting Methods - -#### As JSON Parameter -`RegionPredetectionModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the region pre-detection mode for searching target regions. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | RegionPredetectionModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ - "RegionPredetectionModes": [ - { - "Mode": "DLR_RPM_GENERAL_GRAY_CONTRAST", - "Sensitivity": 5, - "MinImageDimension":262144 - } - ] -} -``` - - -  - - - -#### As `DLRRuntimeSettings` Member -`regionPredetectionModes` is a [`DLRRegionPredetectionMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) array defines in `DLRRuntimeSettings`. It is used for setting the modes and the priority for region pre-detection. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLRRuntimeSettings`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) | [`regionPredetectionModes`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html#regionpredetectionmodes) | [`DLRRegionPredetectionMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode)[8] | - - -**See Also** -- [`DLRRuntimeSettings` Struct]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) -- [`DLRRegionPredetectionMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) diff --git a/parameters/reference/label-recognition-parameter/region-predetection-modes-v1.2.1.md b/parameters/reference/label-recognition-parameter/region-predetection-modes-v1.2.1.md deleted file mode 100644 index 42ecbb6..0000000 --- a/parameters/reference/label-recognition-parameter/region-predetection-modes-v1.2.1.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -layout: default-layout -title: RegionPredetectionModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - RegionPredetectionModes. -keywords: RegionPredetectionModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- - -# LabelRecognitionParameter Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LabelRecognitionParameter.Name`](parameter-control.md#name) | The name of the LabelRecognitionParameter object. | - | [`LabelRecognitionParameter.BinarizationModes`](binarization-modes.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LabelRecognitionParameter.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LabelRecognitionParameter.GrayscaleTransformationModes`](grayscale-transformation-modes.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`LabelRecognitionParameter.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`LabelRecognitionParameter.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`LabelRecognitionParameter.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current image to recognize. | - | [`LabelRecognitionParameter.MaxThreadCount`](parameter-control.md#maxthreadcount) | Sets the maximum number of threads the algorithm will use to recognize text. | - | [`LabelRecognitionParameter.ReferenceRegionNameArray`](parameter-control.md#referenceregionnamearray) | The name array of the ReferenceRegion object(s). | - | [`LabelRecognitionParameter.RegionPredetectionModes`](#regionpredetectionmodes) | Sets the region pre-detection mode for searching target regions. | - | [`LabelRecognitionParameter.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## RegionPredetectionModes - -**Remarks** -If the image is large and the target regions on the image are very small, it is recommended to enable region predetection to speed up the localization process and recognition accuracy. - -### Mode Properties -`RegionPredetectionModes` is a parameter for setting the mode for region pre-detection. It consisits of one or more `DLRRegionPredetectionMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`DLRRegionPredetectionMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) array* | "DLR_RPM_SKIP"
    "DLR_RPM_AUTO"
    "DLR_RPM_GENERAL"
    "DLR_RPM_GENERAL_RGB_CONTRAST"
    "DLR_RPM_GENERAL_GRAY_CONTRAST"
    "DLR_RPM_GENERAL_HSV_CONTRAST" | ["DLR_RPM_GENERAL", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP", "DLR_RPM_SKIP"] | - -- **See also**: - [`DLRRegionPredetectionMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) - -#### Mode Arguments -- [AspectRatioRange](#aspectratiorange) -- [ForeAndBackgroundColours](#foreandbackgroundcolours) -- [HeightRange](#heightrange) -- [MinImageDimension](#minimagedimension) -- [FindAccurateBoundary](#findaccurateboundary) -- [Sensitivity](#sensitivity) -- [SpatialIndexBlockSize](#spatialindexblocksize) -- [WidthRange](#widthrange) - -##### AspectRatioRange -Sets the aspect ratio range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing aspect ratio range. | "" | - - -**Remarks** - - The aspect ratio range need to be defined as [`MinAspectRatio`, `MaxAspectRatio`]. There will be no limitation without manual setting. - - Aspect ratio equals to *height/width\*100*. `MinAspectRatio` and `MaxAspectRatio` are used for limiting the aspect ratio range of the predetected region. - - Value range of `MinAspectRatio`, `MaxAspectRatio`: [1,10000] - - -##### ForeAndBackgroundColours -Specifies a set (or multiple sets) of the foreground and background colours used for region predetection algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing one or more colour sets. | "" | - - -**Remarks** - - Each set of the foreground and background colours need to be defined as [`ForegroundColour`, `BackgroundColour`, `Tolerance`]. If you want to define multiple sets, you can use a "";"" to separate them. This argument is **mandatory**. If there is no manual setting, no region can be detected. - - `ForegroundColour`and `BackgroundColour` are the Hue values in the HSV colour space for defining the foreground and background colours of the regions you want to predetect. The value -1 means black, gray, white. - - `Tolerance` is the allowable deviation of the Hue value defined by `ForegroundColour`. - - Value range of `ForegroundColour`, `BackgroundColour`: [-1,360] - - Value range of `Tolerance`: [0, 360] - - - -##### HeightRange -Sets the height range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing height range. | "" | - - -**Remarks** - - The height range need to be defined as [`MinHeight`, `MaxHeight`]. There will be no limitation without manual setting. - - Value range of `MinHeight`, `MaxHeight`: [1,0x7fffffff] - - - -##### MinImageDimension -Sets the minimum image dimension (in pixels) to pre-detect target regions. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [16384, 0x7fffffff] | 262144 | - -**Remarks** - If the image dimension is larger than the given value, the library will enable the feature of pre-detecting target regions. Otherwise, it will skip this step when searching for target regions. - - -##### FindAccurateBoundary -Sets whether to enable finding accurate boundary. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1] | 0 | - -**Remarks** - 0: disable.
    - 1: enable. - -##### Sensitivity -Sets the sensitivity used for region predetection algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [1, 9] | 1 | - -**Remarks** - A larger value means the library will take more effort to detect regions. - -##### SpatialIndexBlockSize -Sets the spatial index block size used for region predetection algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [1, 32] | 5 | - -**Remarks** - The block size used for region predetection would be 2 to the power of N. The allowed values of SpatialIndexBlockSize is the power number (N=1,2,3...). - - - -##### WidthRange -Sets the width range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing width range. | "" | - - -**Remarks** - - The width range need to be defined as [`MinWidth`, `MaxWidth`]. There will be no limitation without manual setting. - - Value range of `MinWidth`, `MaxWidth`: [1,0x7fffffff] - - -### Setting Methods - -#### As JSON Parameter -`RegionPredetectionModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the region pre-detection mode for searching target regions. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognitionParameter | RegionPredetectionModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "RegionPredetectionModes": [ -        { -            "Mode": "DLR_RPM_GENERAL_GRAY_CONTRAST", -            "Sensitivity": 5, -            "MinImageDimension":262144 -        } -    ] -} -``` - - -  - - - -#### As `DLRRuntimeSettings` Member -`regionPredetectionModes` is a [`DLRRegionPredetectionMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) array defines in `DLRRuntimeSettings`. It is used for setting the modes and the priority for region pre-detection. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLRRuntimeSettings`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) | [`regionPredetectionModes`]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html#regionpredetectionmodes) | [`DLRRegionPredetectionMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode)[8] | - - -**See Also** -- [`DLRRuntimeSettings` Struct]({{ site.c-cplusplus-structs }}dlr-runtime-settings.html) -- [`DLRRegionPredetectionMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#dlrregionpredetectionmode) diff --git a/parameters/reference/label-recognition-parameter/region-predetection-modes.md b/parameters/reference/label-recognition-parameter/region-predetection-modes.md deleted file mode 100644 index a5c66cd..0000000 --- a/parameters/reference/label-recognition-parameter/region-predetection-modes.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -layout: default-layout -title: RegionPredetectionModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - RegionPredetectionModes. -keywords: RegionPredetectionModes, LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LabelRecognizerParameter Object - -## RegionPredetectionModes - -**Remarks** -If the image is large and the target regions on the image are very small, it is recommended to enable region predetection to speed up the localization process and recognition accuracy. - -### Mode Properties -`RegionPredetectionModes` is a parameter for setting the mode for region pre-detection. It consisits of one or more `RegionPredetectionMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *[`RegionPredetectionMode`]({{ site.enumerations }}region-predetection-mode.html) array* | "RPM_SKIP"
    "RPM_AUTO"
    "RPM_GENERAL"
    "RPM_GENERAL_RGB_CONTRAST"
    "RPM_GENERAL_GRAY_CONTRAST"
    "RPM_GENERAL_HSV_CONTRAST" | ["RPM_GENERAL", "RPM_SKIP", "RPM_SKIP", "RPM_SKIP", "RPM_SKIP", "RPM_SKIP", "RPM_SKIP", "RPM_SKIP"] | - -- **See also**: - [`RegionPredetectionMode` Enumeration]({{ site.enumerations }}region-predetection-mode.html) - -#### Mode Arguments -- [LabelRecognizerParameter Object](#labelrecognizerparameter-object) - - [RegionPredetectionModes](#regionpredetectionmodes) - - [Mode Properties](#mode-properties) - - [Mode Arguments](#mode-arguments) - - [AspectRatioRange](#aspectratiorange) - - [ForeAndBackgroundColours](#foreandbackgroundcolours) - - [HeightRange](#heightrange) - - [MinImageDimension](#minimagedimension) - - [FindAccurateBoundary](#findaccurateboundary) - - [Sensitivity](#sensitivity) - - [SpatialIndexBlockSize](#spatialindexblocksize) - - [WidthRange](#widthrange) - - [Setting Methods](#setting-methods) - - [As JSON Parameter](#as-json-parameter) - - [As `DLR_RuntimeSettings` Member](#as-dlr_runtimesettings-member) - -##### AspectRatioRange -Sets the aspect ratio range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing aspect ratio range. | "" | - - -**Remarks** - - The aspect ratio range need to be defined as [`MinAspectRatio`, `MaxAspectRatio`]. There will be no limitation without manual setting. - - Aspect ratio equals to *height/width\*100*. `MinAspectRatio` and `MaxAspectRatio` are used for limiting the aspect ratio range of the predetected region. - - Value range of `MinAspectRatio`, `MaxAspectRatio`: [1,10000] - - -##### ForeAndBackgroundColours -Specifies a set (or multiple sets) of the foreground and background colours used for region predetection algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing one or more colour sets. | "" | - - -**Remarks** - - Each set of the foreground and background colours need to be defined as [`ForegroundColour`, `BackgroundColour`, `Tolerance`]. If you want to define multiple sets, you can use a "";"" to separate them. This argument is **mandatory**. If there is no manual setting, no region can be detected. - - `ForegroundColour`and `BackgroundColour` are the Hue values in the HSV colour space for defining the foreground and background colours of the regions you want to predetect. The value -1 means black, gray, white. - - `Tolerance` is the allowable deviation of the Hue value defined by `ForegroundColour`. - - Value range of `ForegroundColour`, `BackgroundColour`: [-1,360] - - Value range of `Tolerance`: [0, 360] - - - -##### HeightRange -Sets the height range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing height range. | "" | - - -**Remarks** - - The height range need to be defined as [`MinHeight`, `MaxHeight`]. There will be no limitation without manual setting. - - Value range of `MinHeight`, `MaxHeight`: [1,0x7fffffff] - - - -##### MinImageDimension -Sets the minimum image dimension (in pixels) to pre-detect target regions. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [16384, 0x7fffffff] | 262144 | - -**Remarks** - If the image dimension is larger than the given value, the library will enable the feature of pre-detecting target regions. Otherwise, it will skip this step when searching for target regions. - - -##### FindAccurateBoundary -Sets whether to enable finding accurate boundary. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 1] | 0 | - -**Remarks** - 0: disable.
    - 1: enable. - -##### Sensitivity -Sets the sensitivity used for region predetection algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [1, 9] | 1 | - -**Remarks** - A larger value means the library will take more effort to detect regions. - -##### SpatialIndexBlockSize -Sets the spatial index block size used for region predetection algorithm. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [1, 32] | 5 | - -**Remarks** - The block size used for region predetection would be 2 to the power of N. The allowed values of SpatialIndexBlockSize is the power number (N=1,2,3...). - - - -##### WidthRange -Sets the width range of the bounding rectangle of the predetected region. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | A string value representing width range. | "" | - - -**Remarks** - - The width range need to be defined as [`MinWidth`, `MaxWidth`]. There will be no limitation without manual setting. - - Value range of `MinWidth`, `MaxWidth`: [1,0x7fffffff] - - -### Setting Methods - -#### As JSON Parameter -`RegionPredetectionModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the region pre-detection mode for searching target regions. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| LabelRecognizerParameter | RegionPredetectionModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "RegionPredetectionModes": [ -        { -            "Mode": "RPM_GENERAL_GRAY_CONTRAST", -            "Sensitivity": 5, -            "MinImageDimension":262144 -        } -    ] -} -``` - - - - -#### As `DLR_RuntimeSettings` Member -`regionPredetectionModes` is a [`RegionPredetectionMode`]({{ site.enumerations }}region-predetection-mode.html) array defines in `DLR_RuntimeSettings`. It is used for setting the modes and the priority for region pre-detection. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLR_RuntimeSettings`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html)->[`furtherModes`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html#furthermodes) | [`regionPredetectionModes`]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html#regionpredetectionmodes) | [`RegionPredetectionMode`]({{ site.enumerations }}region-predetection-mode.html)[8] | - - -**See Also** -- [`DLR_RuntimeSettings` Struct]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) -- [`RegionPredetectionMode` Enumeration]({{ site.enumerations }}region-predetection-mode.html) diff --git a/parameters/reference/label-recognition-parameter/scale-up-modes-v1.2.1.md b/parameters/reference/label-recognition-parameter/scale-up-modes-v1.2.1.md deleted file mode 100644 index bf0856c..0000000 --- a/parameters/reference/label-recognition-parameter/scale-up-modes-v1.2.1.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: default-layout -title: ScaleUpModes - Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LabelRecognitionParameter Object - ScaleUpModes. -keywords: ScaleUpModes, LabelRecognitionParameter, parameter reference, parameter -needAutoGenerateSidebar: true ---- -# ImageParameter Object | ScaleUpModes - - - -## ScaleUpModes - -### Mode Properties -`ScaleUpModes` is a parameter for setting the mode to control the scale-up process for text line with small letter height. It consisits of one or more `DLRScaleUpMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string array* or *[`DLRScaleUpMode`]({{ site.enumerations }}parameter-mode-enums.html#dlrscaleupmode) array* | "DLR_SUM_SKIP"
    "DLR_SUM_AUTO"
    "DLR_SUM_LINEAR_INTERPOLATION"
    "DLR_SUM_NEAREST_NEIGHBOUR_INTERPOLATION" | ["DLR_SUM_AUTO", "DLR_SUM_SKIP", "DLR_SUM_SKIP", "DLR_SUM_SKIP", "DLR_SUM_SKIP", "DLR_SUM_SKIP", "DLR_SUM_SKIP", "DLR_SUM_SKIP"] | - -- **See also**: - [`ScaleUpMode` Enumeration]({{ site.enumerations }}parameter-mode-enums.html#scaleupmode) - -#### Mode Arguments -- [LetterHeightThreshold](#letterheightthreshold) -- [TargetLetterHeight](#targetletterheight) - - -##### LetterHeightThreshold -Sets the letter height threshold for scale-up. - - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 0x7fffffff] | 0 | - -**Remarks** - 0 : means automatically set by the library. - If the average letter height of a text line is smaller than the [LetterHeightThreshold](#letterheightthreshold), the image will be enlarged to N times (N=2,4,8…) till N * LetterHeight >= [TargetLetterHeight](#targetletterheight). - - -##### TargetLetterHeight -Sets the target letter height for scale-up. - - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 0x7fffffff] | 0 | - -**Remarks** - 0 : means automatically set by the library. - -### Setting Methods - -#### As JSON Parameter -`ScaleUpModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority and the mode to control the scale-up process for text line with small letter height. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| ImageParameter | ScaleUpModes | *JSON Object Array* | - -**Json Parameter Example** -``` -{ -    "ScaleUpModes": [ - { -            "Mode": "DLR_SUM_AUTO", -            "LetterHeightThreshold": 10, -            "TargetLetterHeight": 50 -        } -] -} -``` - - -  - - - diff --git a/parameters/reference/label-recognition-parameter/scale-up-modes.md b/parameters/reference/label-recognition-parameter/scale-up-modes.md deleted file mode 100644 index 79fa76b..0000000 --- a/parameters/reference/label-recognition-parameter/scale-up-modes.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -layout: default-layout -title: ScaleUpModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LabelRecognizerParameter Object - ScaleUpModes. -keywords: ScaleUpModes, LabelRecognizerParameter, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# LabelRecognizerParameter Object - -## ScaleUpModes - -### Mode Properties -`ScaleUpModes` is a parameter for setting the mode to control the scale-up process for text line with small letter height. It consisits of one or more `ScaleUpMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string array* or *[`ScaleUpMode`]({{ site.enumerations }}scale-up-mode.html) array* | "SUM_SKIP"
    "SUM_AUTO"
    "SUM_LINEAR_INTERPOLATION"
    "SUM_NEAREST_NEIGHBOUR_INTERPOLATION" | ["SUM_AUTO", "SUM_SKIP", "SUM_SKIP", "SUM_SKIP", "SUM_SKIP", "SUM_SKIP", "SUM_SKIP", "SUM_SKIP"] | - -- **See also**: - [`ScaleUpMode` Enumeration]({{ site.enumerations }}scale-up-mode.html) - -#### Mode Arguments -- [LetterHeightThreshold](#letterheightthreshold) -- [TargetLetterHeight](#targetletterheight) - - -##### LetterHeightThreshold -Sets the letter height threshold for scale-up. - - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 0x7fffffff] | 0 | - -**Remarks** - 0 : means automatically set by the library. - If the average letter height of a text line is smaller than the [LetterHeightThreshold](#letterheightthreshold), the image will be enlarged to N times (N=2,4,8…) till N * LetterHeight >= [TargetLetterHeight](#targetletterheight). - - -##### TargetLetterHeight -Sets the target letter height for scale-up. - - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [0, 0x7fffffff] | 0 | - -**Remarks** - 0 : means automatically set by the library. - -### Setting Methods - -#### As JSON Parameter -`ScaleUpModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority and the mode to control the scale-up process for text line with small letter height. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| ImageParameter | ScaleUpModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "ScaleUpModes": [ - { -            "Mode": "SUM_AUTO", -            "LetterHeightThreshold": 10, -            "TargetLetterHeight": 50 -        } -] -} -``` - diff --git a/parameters/reference/label-recognition-parameter/texture-detection-modes.md b/parameters/reference/label-recognition-parameter/texture-detection-modes.md deleted file mode 100644 index ae5c3a0..0000000 --- a/parameters/reference/label-recognition-parameter/texture-detection-modes.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -layout: default-layout -title: TextureDetectionModes - Dynamsoft Label Recognizer Parameter Reference -description: This page shows Dynamsoft Label Recognizer Parameter Reference for ImageParameter Object - TextureDetectionModes. -keywords: TextureDetectionModes, ImageParameter, image process control parameters, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LabelRecognizerParameter Object - -## TextureDetectionModes - -### Mode Properties -`TextureDetectionModes` is a parameter for setting the mode for texture detection. It consists of one or more `TextureDetectionMode` items and each item has its own arguments. The array index represents the priority of the item. The smaller index is, the higher priority is. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string array* or *[`TextureDetectionMode`]({{ site.enumerations }}texture-detection-mode.html) array* | "TDM_SKIP"
    "TDM_AUTO"
    "TDM_GENERAL_WIDTH_CONCENTRATION" | ["TDM_GENERAL_WIDTH_CONCENTRATION", "TDM_SKIP", "TDM_SKIP", "TDM_SKIP", "TDM_SKIP", "TDM_SKIP", "TDM_SKIP", "TDM_SKIP"] | - -- **See also**: - [`TextureDetectionMode` Enumeration]({{ site.enumerations }}texture-detection-mode.html) - -#### Mode Arguments -- [Sensitivity](#sensitivity) -- [LibraryFileName](#libraryfilename) -- [LibraryParameters](#libraryparameters) - -##### Sensitivity -Sets the sensitivity used for texture detection. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [1, 9] | 5 | - -**Remarks** - A larger value means the library will take more effort to detect texture. - -##### LibraryFileName -Sets the file name of the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing file name. | "" | All `TextureDetectionMode` items except TDM_SKIP and TDM_AUTO| - - -**Remarks** - The library must be in the same place with Dynamsoft Label Recognizer Library. - - -##### LibraryParameters -Sets the parameters passed to the library to load dynamically. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | ----------- | -| *string* | A string value representing parameters. | "" | All `TextureDetectionMode` items except TDM_SKIP and TDM_AUTO | - - - -### Setting Methods - -#### As JSON Parameter -`TextureDetectionModes` as a JSON parameter is a JSON Object array. Each JSON Object has several keys for setting the mode and the value of arguments. The array index decides the priority the mode for texture detection. Default values will be used if there is no manual setting. - - -| Json Object | Json Parameter Name | Value Type | -| ----------- | ------------------- | ---------- | -| ImageParameter | TextureDetectionModes | *JSON Object Array* | - -**Json Parameter Example** -```json -{ -    "TextureDetectionModes": [ -        { -            "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION", -            "Sensitivity": 5 -        } -    ] -} -``` - - -#### As `DLR_RuntimeSettings` Member -`TextureDetectionModes` is a [`TextureDetectionMode`]({{ site.enumerations }}texture-detection-mode.html) array defines in `furtherModes` which is a struct member of `DLR_RuntimeSettings`. It is used for setting the modes and the priority for texture detection. Default value will be used if there is no manual setting. - -| Struct | Struct Member Name | Value Type | -| ------ | ------------------ | ---------- | -| [`DLR_RuntimeSettings`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html)->[`furtherModes`]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html#furthermodes) | [`textureDetectionModes`]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html#texturedetectionmodes) | [`TextureDetectionMode`]({{ site.enumerations }}texture-detection-mode.html)[8] | - - -**See Also** -- [`DLR_RuntimeSettings` Struct]({{ site.c-cplusplus-api-reference }}dlr-runtime-settings.html) -- [`DLR_FurtherModes` Struct]({{ site.c-cplusplus-api-reference }}dlr-further-modes.html) -- [`TextureDetectionMode` Enumeration]({{ site.enumerations }}texture-detection-mode.html) diff --git a/parameters/reference/line-specification/index-v1.0.md b/parameters/reference/line-specification/index-v1.0.md deleted file mode 100644 index f912a09..0000000 --- a/parameters/reference/line-specification/index-v1.0.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default-layout -title: LineSpecification Object - Dynamsoft Label Recognition Parameter Reference -description: This article shows LineSpecification Object of Dynamsoft Label Recognition. -keywords: parameter reference, parameters, LineSpecification -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](parameter-control.md#name) | The name of the LineSpecification object. | - | [`LineSpecification.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineNumber`](parameter-control.md#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | diff --git a/parameters/reference/line-specification/index-v1.2.1.md b/parameters/reference/line-specification/index-v1.2.1.md deleted file mode 100644 index 652a04c..0000000 --- a/parameters/reference/line-specification/index-v1.2.1.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: default-layout -title: LineSpecification Object - Dynamsoft Label Recognition Parameter Reference -description: This article shows LineSpecification Object of Dynamsoft Label Recognition. -keywords: parameter reference, parameters, LineSpecification -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](parameter-control.md#name) | The name of the LineSpecification object. | - | [`LineSpecification.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineNumber`](parameter-control.md#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LineSpecification.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - | [`LineSpecification.FirstPoint`](parameter-control.md#firstpoint) | The first point of the line, which is usually the top-left corner. | - | [`LineSpecification.SecondPoint`](parameter-control.md#secondpoint) | The second point of the line, which is usually the top-right corner. | - | [`LineSpecification.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the line, which is usually the bottom-right corner. | - | [`LineSpecification.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the line, which is usually the bottom-left corner. | diff --git a/parameters/reference/line-specification/index-v2.0.md b/parameters/reference/line-specification/index-v2.0.md deleted file mode 100644 index 20c1b6d..0000000 --- a/parameters/reference/line-specification/index-v2.0.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default-layout -title: LineSpecification Object - Dynamsoft Label Recognizer Parameter Reference -description: This article shows LineSpecification Object of Dynamsoft Label Recognizer. -keywords: parameter reference, parameters, LineSpecification -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](parameter-control.md#name) | The name of the LineSpecification object. | - | [`LineSpecification.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineNumber`](parameter-control.md#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LineSpecification.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - | [`LineSpecification.FirstPoint`](parameter-control.md#firstpoint) | The first point of the line, which is usually the top-left corner. | - | [`LineSpecification.SecondPoint`](parameter-control.md#secondpoint) | The second point of the line, which is usually the top-right corner. | - | [`LineSpecification.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the line, which is usually the bottom-right corner. | - | [`LineSpecification.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the line, which is usually the bottom-left corner. | - | [`LineSpecification.BinarizationModes`](parameter-control.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LineSpecification.GrayscaleEnhancementModes`](parameter-control.md#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | \ No newline at end of file diff --git a/parameters/reference/line-specification/index.md b/parameters/reference/line-specification/index.md deleted file mode 100644 index e35acd8..0000000 --- a/parameters/reference/line-specification/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default-layout -title: LineSpecification Object - Dynamsoft Label Recognizer Parameter Reference -description: This article shows LineSpecification Object of Dynamsoft Label Recognizer. -keywords: parameter reference, parameters, LineSpecification -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](parameter-control.md#name) | The name of the LineSpecification object. | - | [`LineSpecification.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineNumber`](parameter-control.md#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LineSpecification.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - | [`LineSpecification.FirstPoint`](parameter-control.md#firstpoint) | The first point of the line, which is usually the top-left corner. | - | [`LineSpecification.SecondPoint`](parameter-control.md#secondpoint) | The second point of the line, which is usually the top-right corner. | - | [`LineSpecification.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the line, which is usually the bottom-right corner. | - | [`LineSpecification.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the line, which is usually the bottom-left corner. | - | [`LineSpecification.BinarizationModes`](parameter-control.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LineSpecification.GrayscaleEnhancementModes`](parameter-control.md#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`LineSpecification.CharacterNormalizationModes`](parameter-control.md#characternormalizationmodes) | Sets the mode and priority for character normalization. | diff --git a/parameters/reference/line-specification/parameter-control-v1.0.md b/parameters/reference/line-specification/parameter-control-v1.0.md deleted file mode 100644 index 876dece..0000000 --- a/parameters/reference/line-specification/parameter-control-v1.0.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for LineSpecification Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LineSpecification Object. -keywords: LineSpecification, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](#name) | The name of the LineSpecification object. | - | [`LineSpecification.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineNumber`](#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - ---- - - -## Name -The name of the LineSpecification object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LineSpecification1" -} -``` - -  - -## LineNumber -The line number of the line targeted by the LineSpecification object. - -**Remarks** -1. The value is 1-based; -2. "" represents all lines. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LineSpecification | LineNumber | *string* | A string of one or more of the following data,separated by commas:
    1. One int value which represents a specified line index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range; | "" | - - -**Json Parameter Example** -```json -{ - "LineNumber": "1,3,5,7-10" -} -``` - -  - - -## 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. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - -  - -## LineStringRegExPattern -Specifies the regular expression pattern of the string within a line. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "LineStringRegExPattern":"" -} -``` - -  - diff --git a/parameters/reference/line-specification/parameter-control-v1.2.1.md b/parameters/reference/line-specification/parameter-control-v1.2.1.md deleted file mode 100644 index 5e58ae5..0000000 --- a/parameters/reference/line-specification/parameter-control-v1.2.1.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for LineSpecification Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for LineSpecification Object. -keywords: LineSpecification, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](#name) | The name of the LineSpecification object. | - | [`LineSpecification.LineNumber`](#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.FirstPoint`](#firstpoint) | The first point of the line, which is usually the top-left corner. | - | [`LineSpecification.SecondPoint`](#secondpoint) | The second point of the line, which is usually the top-right corner. | - | [`LineSpecification.ThirdPoint`](#thirdpoint) | The third point of the line, which is usually the bottom-right corner. | - | [`LineSpecification.FourthPoint`](#fourthpoint) | The fourth point of the line, which is usually the bottom-left corner. | - | [`LineSpecification.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LineSpecification.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - ---- - - -## Name -The name of the LineSpecification object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LineSpecification1" -} -``` - -  - -## LineNumber -The line number of the line targeted by the LineSpecification object. - -**Remarks** -1. The value is 1-based; -2. "" represents all lines. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LineSpecification | LineNumber | *string* | A string of one or more of the following data,separated by commas:
    1. One int value which represents a specified line index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range; | "" | - - -**Json Parameter Example** -```json -{ - "LineNumber": "1,3,5,7-10" -} -``` - -  - -## FirstPoint -The first point of the line, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - -  - -## SecondPoint -The second point of the line, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - -  - -## ThirdPoint -The third point of the line, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - -  - -## FourthPoint -The fourth point of the line, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - -  - -## 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. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - -  - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "LineStringLengthRange": [4,200] -} -``` - -  - - -## LineStringRegExPattern -Specifies the regular expression pattern of the string within a line. - -**Remarks** -Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "LineStringRegExPattern":"" -} -``` - -  - diff --git a/parameters/reference/line-specification/parameter-control-v2.0.md b/parameters/reference/line-specification/parameter-control-v2.0.md deleted file mode 100644 index d7f52b6..0000000 --- a/parameters/reference/line-specification/parameter-control-v2.0.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference for LineSpecification Object -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LineSpecification Object. -keywords: LineSpecification, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](#name) | The name of the LineSpecification object. | - | [`LineSpecification.LineNumber`](#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.FirstPoint`](#firstpoint) | The first point of the line, which is usually the top-left corner. | - | [`LineSpecification.SecondPoint`](#secondpoint) | The second point of the line, which is usually the top-right corner. | - | [`LineSpecification.ThirdPoint`](#thirdpoint) | The third point of the line, which is usually the bottom-right corner. | - | [`LineSpecification.FourthPoint`](#fourthpoint) | The fourth point of the line, which is usually the bottom-left corner. | - | [`LineSpecification.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LineSpecification.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - | [`LineSpecification.BinarizationModes`](#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LineSpecification.GrayscaleEnhancementModes`](#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - ---- - - -## Name -The name of the LineSpecification object. - -**Remarks** -It must be a unique name. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LineSpecification1" -} -``` - - - -## LineNumber -The line number of the line targeted by the LineSpecification object. - -**Remarks** -1. The value is 1-based; -2. "" represents all lines. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LineSpecification | LineNumber | *string* | A string of one or more of the following data,separated by commas:
    1. One int value which represents a specified line index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range; | "" | - - -**Json Parameter Example** -```json -{ - "LineNumber": "1,3,5,7-10" -} -``` - - - -## FirstPoint -The first point of the line, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - - - -## SecondPoint -The second point of the line, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - - - -## ThirdPoint -The third point of the line, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - - - -## FourthPoint -The fourth point of the line, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - - - -## 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. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - - - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "LineStringLengthRange": [4,200] -} -``` - - - - -## LineStringRegExPattern -Specifies the regular expression pattern of the string within a line. - -**Remarks** -Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "LineStringRegExPattern":"" -} -``` - - -## BinarizationModes -Please check [LabelRecognizerParameter.BinarizationModes](../label-recognition-parameter/binarization-modes.md#binarizationmodes) for reference. - -## GrayscaleEnhancementModes -Please check [LabelRecognizerParameter.GrayscaleEnhancementModes](../label-recognition-parameter/grayscale-enhancement-modes.md#grayscaleenhancementmodes) for reference. - diff --git a/parameters/reference/line-specification/parameter-control.md b/parameters/reference/line-specification/parameter-control.md deleted file mode 100644 index a135d61..0000000 --- a/parameters/reference/line-specification/parameter-control.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference for LineSpecification Object -description: This page shows Dynamsoft Label Recognizer Parameter Reference for LineSpecification Object. -keywords: LineSpecification, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# LineSpecification Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`LineSpecification.Name`](#name) | The name of the LineSpecification object. | - | [`LineSpecification.LineNumber`](#linenumber) | The line number of the line targeted by the LineSpecification object. | - | [`LineSpecification.FirstPoint`](#firstpoint) | The first point of the line, which is usually the top-left corner. | - | [`LineSpecification.SecondPoint`](#secondpoint) | The second point of the line, which is usually the top-right corner. | - | [`LineSpecification.ThirdPoint`](#thirdpoint) | The third point of the line, which is usually the bottom-right corner. | - | [`LineSpecification.FourthPoint`](#fourthpoint) | The fourth point of the line, which is usually the bottom-left corner. | - | [`LineSpecification.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`LineSpecification.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`LineSpecification.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of the string within a line. | - | [`LineSpecification.BinarizationModes`](#binarizationmodes) | Sets the mode and priority for binarization. | - | [`LineSpecification.GrayscaleEnhancementModes`](#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`LineSpecification.CharacterNormalizationModes`](#characternormalizationmodes) | Sets the mode and priority for texture detection. | - ---- - - -## Name -The name of the LineSpecification object. - -**Remarks** -It must be a unique name. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"LineSpecification1" -} -``` - - - -## LineNumber -The line number of the line targeted by the LineSpecification object. - -**Remarks** -1. The value is 1-based; -2. "" represents all lines. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| LineSpecification | LineNumber | *string* | A string of one or more of the following data,separated by commas:
    1. One int value which represents a specified line index;
    2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range; | "" | - - -**Json Parameter Example** -```json -{ - "LineNumber": "1,3,5,7-10" -} -``` - - - -## FirstPoint -The first point of the line, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - - - -## SecondPoint -The second point of the line, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - - - -## ThirdPoint -The third point of the line, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - - - -## FourthPoint -The fourth point of the line, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by LineSpecification, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the TextArea.
    -The value of x is a percentage value relative to the width of the TextArea.
    -The value of y is a percentage value relative to the height of the TextArea.
    -The allowed values for x/y: [0, 100].
    -It is valid only when 'LineNumber' is setting to one specified line number.
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - - - -## 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. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - - - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "LineStringLengthRange": [4,200] -} -``` - - - - -## LineStringRegExPattern -Specifies the regular expression pattern of the string within a line. - -**Remarks** -Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| LineSpecification | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "LineStringRegExPattern":"" -} -``` - - -## BinarizationModes -Please check [LabelRecognizerParameter.BinarizationModes](../label-recognition-parameter/binarization-modes.md#binarizationmodes) for reference. - -## GrayscaleEnhancementModes -Please check [LabelRecognizerParameter.GrayscaleEnhancementModes](../label-recognition-parameter/grayscale-enhancement-modes.md#grayscaleenhancementmodes) for reference. - -## CharacterNormalizationModes -Please check [LabelRecognizerParameter.CharacterNormalizationModes](../label-recognition-parameter/character-normalization-modes.md#characternormalizationmodes) for reference. diff --git a/parameters/reference/reference-region/index-v1.2.1.md b/parameters/reference/reference-region/index-v1.2.1.md deleted file mode 100644 index c942b97..0000000 --- a/parameters/reference/reference-region/index-v1.2.1.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default-layout -title: ReferenceRegion Object - Dynamsoft Label Recognition Parameter Reference -description: This article shows ReferenceRegion Object of Dynamsoft Label Recognition. -keywords: parameter reference, parameters, ReferenceRegion -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - ReferenceRegion Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`ReferenceRegion.Name`](parameter-control.md#name) | The name of the ReferenceRegion object. | - | [`ReferenceRegion.Localization`](localization.md#localization) | The localization of the reference region(s). | - | [`ReferenceRegion.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current reference region. | diff --git a/parameters/reference/reference-region/index.md b/parameters/reference/reference-region/index.md deleted file mode 100644 index ff24d20..0000000 --- a/parameters/reference/reference-region/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default-layout -title: ReferenceRegion Object - Dynamsoft Label Recognizer Parameter Reference -description: This article shows ReferenceRegion Object of Dynamsoft Label Recognizer. -keywords: parameter reference, parameters, ReferenceRegion -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - ReferenceRegion Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`ReferenceRegion.Name`](parameter-control.md#name) | The name of the ReferenceRegion object. | - | [`ReferenceRegion.Localization`](localization.md#localization) | The localization of the reference region(s). | - | [`ReferenceRegion.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current reference region. | diff --git a/parameters/reference/reference-region/localization-v1.2.1.md b/parameters/reference/reference-region/localization-v1.2.1.md deleted file mode 100644 index 2af3092..0000000 --- a/parameters/reference/reference-region/localization-v1.2.1.md +++ /dev/null @@ -1,362 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for ReferenceRegion Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for ReferenceRegion Object. -keywords: ReferenceRegion, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# ReferenceRegion Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`ReferenceRegion.Name`](parameter-control.md#name) | The name of the ReferenceRegion object. | - | [`ReferenceRegion.Localization`](#localization) | The localization of the reference region(s). | - | [`ReferenceRegion.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current reference region. | - ---- - -## Localization -A JSON object containing the following settings. - -### SourceType -The source type used to localize the reference region(s). - -**Remarks** - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | SourceType | *string* | "DLR_LST_MANUAL_SPECIFICATION"
    "DLR_LST_PREDETECTED_REGION"
    "DLR_LST_BARCODE". | "DLR_LST_MANUAL_SPECIFICATION" | - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_PREDETECTED_REGION", -        "RegionPredetectionModesIndex": 1 -    } -} -``` - -  - - -### FirstPoint -The first point of the reference region, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to DLR_LST_MANUAL_SPECIFICATION
    - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - -  - -### SecondPoint -The second point of the reference region, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to DLR_LST_MANUAL_SPECIFICATION
    - - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - -  - -### ThirdPoint -The third point of the reference region, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to DLR_LST_MANUAL_SPECIFICATION
    - - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - -  - -### FourthPoint -The fourth point of the reference region, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to DLR_LST_MANUAL_SPECIFICATION
    - - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - -  - -### MeasuredByPercentage -Sets whether or not to use percentages to measure the coordinate. - -**Remarks** -0: not by percentage
    -1: by percentage
    -It works only when [SourceType](#sourcetype) is setting to DLR_LST_MANUAL_SPECIFICATION
    - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | MeasuredByPercentage | *int* | [0, 1] | 1 | - - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - -  - - -### RegionPredetectionModesIndex -The index of a specific region predetection mode in the regionPredetectionModes parameter. - -**Remarks** --1: all region predetection modes in the regionPredetectionModes parameter
    -It works only when [SourceType](#sourcetype) is setting to DLR_LST_PREDETECTED_REGION
    -The library will localize reference region(s) based on the detected regions from the specified region predetection mode.
    - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | RegionPredetectionModesIndex | *int* | [-1, 0x7fffffff] | -1 | - - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "DLR_LST_PREDETECTED_REGION", -        "RegionPredetectionModesIndex": 1 -    } -} -``` - -  - - -### BarcodeFormatIds -The formats of the barcode in BarcodeFormat group 1. - -**Remarks** -It works only when [SourceType](#sourcetype) is setting to DLR_LST_BARCODE.
    -The library will localize reference region(s) based on the barcodes whose format meets current setting. - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | BarcodeFormatIds | *string Array* | An array item can be any one of the [`DLRBarcodeFormat` Enumeration]({{ site.enumerations }}other-enums.html#dlrbarcodeformat) items | "DLR_BF_ALL" | - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", - "Localization": -   { -        "SourceType": "DLR_LST_BARCODE", -        "BarcodeFormatIds": ["DLR_BF_ALL"], -        "BarcodeFormatIds_2": ["DLR_BF2_NULL"], -        "BarcodeTextRegExPattern":"" -    } -} -``` - - -  - - - -### BarcodeFormatIds_2 -The formats of the barcode in BarcodeFormat group 2. - -**Remarks** -It works only when [SourceType](#sourcetype) is setting to DLR_LST_BARCODE.
    -The library will localize reference region(s) based on the barcodes whose format meets current setting. - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | BarcodeFormatIds_2 | *string Array* | An array item can be any one of the [`DLRBarcodeFormat_2` Enumeration]({{ site.enumerations }}other-enums.html#dlrbarcodeformat_2) items | "DLR_BF2_NULL" | - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", - "Localization": -   { -        "SourceType": "DLR_LST_BARCODE", -        "BarcodeFormatIds": ["DLR_BF_ALL"], -        "BarcodeFormatIds_2": ["DLR_BF2_NULL"], -        "BarcodeTextRegExPattern":"" -    } -} -``` - - -  - - -### BarcodeTextRegExPattern -The regular express pattern of barcode text. - -**Remarks** -It works only when [SourceType](#sourcetype) is setting to DLR_LST_BARCODE
    - -#### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | BarcodeTextRegExPattern | *string* | regular express pattern as string. | "" | - -**Json Parameter Example** -``` -ReferenceRegion: -{ -"Name": "R1", - "Localization": -   { -        "SourceType": "DLR_LST_BARCODE", -        "BarcodeFormatIds": ["BF_ALL"], -        "BarcodeFormatIds_2": ["BF2_NULL"], -        "BarcodeTextRegExPattern":"" -    } -} -``` - - -  - - diff --git a/parameters/reference/reference-region/localization.md b/parameters/reference/reference-region/localization.md deleted file mode 100644 index a6a0a48..0000000 --- a/parameters/reference/reference-region/localization.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -layout: default-layout -title: Localization parameter - Dynamsoft Label Recognizer Parameter Reference ReferenceRegion Object -description: This page introduces the localization parameter of ReferenceRegion Object. -keywords: ReferenceRegion, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# ReferenceRegion Object - -## Localization -A JSON object containing the following settings. - -### SourceType -The source type used to localize the reference region(s). - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | SourceType | *string* | "LST_MANUAL_SPECIFICATION"
    "LST_PREDETECTED_REGION"
    "LST_BARCODE". | "LST_MANUAL_SPECIFICATION" | - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_PREDETECTED_REGION", -        "RegionPredetectionModesIndex": 1 -    } -} -``` - - - - -### FirstPoint -The first point of the reference region, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to LST_MANUAL_SPECIFICATION
    - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - - - -### SecondPoint -The second point of the reference region, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to LST_MANUAL_SPECIFICATION
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - - - -### ThirdPoint -The third point of the reference region, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to LST_MANUAL_SPECIFICATION
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - - - -### FourthPoint -The fourth point of the reference region, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by ReferenceRegion, and the other three points are in a clockwise direction.
    - -When MeasuredByPercentage=0, the valid value range for x-coordinate/y-coordinate is [0, 0x7fffffff] -When MeasuredByPercentage=1, the valid value range for x-coordinate/y-coordinate is [0, 100] - -It works only when [SourceType](#sourcetype) is setting to LST_MANUAL_SPECIFICATION
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| Localization | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - - - -### MeasuredByPercentage -Sets whether or not to use percentages to measure the coordinate. - -**Remarks** -0: not by percentage
    -1: by percentage
    -It works only when [SourceType](#sourcetype) is setting to LST_MANUAL_SPECIFICATION
    - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | MeasuredByPercentage | *int* | [0, 1] | 1 | - - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_MANUAL_SPECIFICATION", -        "FirstPoint": [0, 0], -        "SecondPoint": [100, 0], -        "ThirdPoint": [100, 100], -        "FourthPoint": [0, 100], -        "MeasuredByPercentage":1 -    } -} -``` - - - - -### RegionPredetectionModesIndex -The index of a specific region predetection mode in the regionPredetectionModes parameter. - -**Remarks** --1: all region predetection modes in the regionPredetectionModes parameter
    -It works only when [SourceType](#sourcetype) is setting to LST_PREDETECTED_REGION
    -The library will localize reference region(s) based on the detected regions from the specified region predetection mode.
    - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | RegionPredetectionModesIndex | *int* | [-1, 0x7fffffff] | -1 | - - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", -"Localization": -    { -        "SourceType": "LST_PREDETECTED_REGION", -        "RegionPredetectionModesIndex": 1 -    } -} -``` - - - -### BarcodeFormatIds -The formats of the barcode in BarcodeFormat group 1. - -**Remarks** -It works only when [SourceType](#sourcetype) is setting to LST_BARCODE.
    -The library will localize reference region(s) based on the barcodes whose format meets current setting. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | BarcodeFormatIds | *string Array* | An array item can be any one of the [`BarcodeFormat` Enumeration]({{ site.enumerations }}barcode-format.html) items | "BF_ALL" | - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", - "Localization": -   { -        "SourceType": "LST_BARCODE", -        "BarcodeFormatIds": ["BF_ALL"], -        "BarcodeFormatIds_2": ["BF2_NULL"], -        "BarcodeTextRegExPattern":"" -    } -} -``` - - - - - - -### BarcodeFormatIds_2 -The formats of the barcode in BarcodeFormat group 2. - -**Remarks** -It works only when [SourceType](#sourcetype) is setting to LST_BARCODE.
    -The library will localize reference region(s) based on the barcodes whose format meets current setting. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | BarcodeFormatIds_2 | *string Array* | An array item can be any one of the [`BarcodeFormat_2` Enumeration]({{ site.enumerations }}barcode-format-2.html) items | "BF2_NULL" | - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", - "Localization": -   { -        "SourceType": "LST_BARCODE", -        "BarcodeFormatIds": ["BF_ALL"], -        "BarcodeFormatIds_2": ["BF2_NULL"], -        "BarcodeTextRegExPattern":"" -    } -} -``` - - - - - -### BarcodeTextRegExPattern -The regular express pattern of barcode text. - -**Remarks** -It works only when [SourceType](#sourcetype) is setting to LST_BARCODE
    - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| Localization | BarcodeTextRegExPattern | *string* | regular express pattern as string. | "" | - -**Json Parameter Example** -```json -ReferenceRegion: -{ -"Name": "R1", - "Localization": -   { -        "SourceType": "LST_BARCODE", -        "BarcodeFormatIds": ["BF_ALL"], -        "BarcodeFormatIds_2": ["BF2_NULL"], -        "BarcodeTextRegExPattern":"" -    } -} -``` - - - - - diff --git a/parameters/reference/reference-region/parameter-control-v1.2.1.md b/parameters/reference/reference-region/parameter-control-v1.2.1.md deleted file mode 100644 index 02e3c54..0000000 --- a/parameters/reference/reference-region/parameter-control-v1.2.1.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for ReferenceRegion Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for ReferenceRegion Object. -keywords: ReferenceRegion, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# ReferenceRegion Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`ReferenceRegion.Name`](#name) | The name of the ReferenceRegion object. | - | [`ReferenceRegion.Localization`](localization.md#localization) | The localization of the reference region(s). | - | [`ReferenceRegion.TextAreaNameArray `](#textareanamearray) | Specifies the name array of the TextAreas which is relative to current reference region. | - ---- - - -## Name -The name of the ReferenceRegion object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceRegion | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"ReferenceRegion1" -} -``` - -  - - - -## TextAreaNameArray -Specifies the name array of the TextArea objects which is relative to current reference region. - -**Remarks** -An array item is a name of any available `TextArea`. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceRegion | TextAreaNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "TextAreaNameArray":[ - "TextArea1", - "TextArea2" - ] -} -``` - -  - diff --git a/parameters/reference/reference-region/parameter-control.md b/parameters/reference/reference-region/parameter-control.md deleted file mode 100644 index ccdd868..0000000 --- a/parameters/reference/reference-region/parameter-control.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default-layout -title: Name & TextAreaNameArray Dynamsoft Label Recognizer Parameter Reference ReferenceRegion Object -description: This page introduces the Name and TextAreaNameArray parameters of ReferenceRegion Object. -keywords: ReferenceRegion, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# ReferenceRegion Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`ReferenceRegion.Name`](#name) | The name of the ReferenceRegion object. | - | [`ReferenceRegion.TextAreaNameArray `](#textareanamearray) | Specifies the name array of the TextAreas which is relative to current reference region. | - ---- - - -## Name -The name of the ReferenceRegion object. - -**Remarks** -It must be a unique name. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceRegion | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"ReferenceRegion1" -} -``` - - - - - -## TextAreaNameArray -Specifies the name array of the TextArea objects which is relative to current reference region. - -**Remarks** -An array item is a name of any available `TextArea`. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| ReferenceRegion | TextAreaNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "TextAreaNameArray":[ - "TextArea1", - "TextArea2" - ] -} -``` - - diff --git a/parameters/reference/text-area/index-v1.0.md b/parameters/reference/text-area/index-v1.0.md deleted file mode 100644 index 66826db..0000000 --- a/parameters/reference/text-area/index-v1.0.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: TextArea Object - Dynamsoft Label Recognition Parameter Reference -description: This article shows TextArea Object of Dynamsoft Label Recognition. -keywords: parameter reference, parameters, TextArea -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](parameter-control.md#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](parameter-control.md#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](parameter-control.md#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](parameter-control.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`TextArea.LineSpecificationNameArray `](parameter-control.md#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - diff --git a/parameters/reference/text-area/index-v1.2.1.md b/parameters/reference/text-area/index-v1.2.1.md deleted file mode 100644 index 5b29aa2..0000000 --- a/parameters/reference/text-area/index-v1.2.1.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default-layout -title: TextArea Object - Dynamsoft Label Recognition Parameter Reference -description: This article shows TextArea Object of Dynamsoft Label Recognition. -keywords: parameter reference, parameters, TextArea -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognition SDK - TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](parameter-control.md#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](parameter-control.md#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](parameter-control.md#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](parameter-control.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LinesCount`](parameter-control.md#linescount) | Sets the text lines count of the text area. | - | [`TextArea.LineSpecificationNameArray `](parameter-control.md#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`TextArea.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.MaxLineCharacterSpacing`](parameter-control.md#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`TextArea.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextStringLengthRange`](parameter-control.md#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`TextArea.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - diff --git a/parameters/reference/text-area/index-v2.0.md b/parameters/reference/text-area/index-v2.0.md deleted file mode 100644 index ff3ac55..0000000 --- a/parameters/reference/text-area/index-v2.0.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default-layout -title: TextArea Object - Dynamsoft Label Recognizer Parameter Reference -description: This article shows TextArea Object of Dynamsoft Label Recognizer. -keywords: parameter reference, parameters, TextArea -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](parameter-control.md#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](parameter-control.md#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](parameter-control.md#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](parameter-control.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LineSpecificationNameArray `](parameter-control.md#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`TextArea.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.MaxLineCharacterSpacing`](parameter-control.md#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`TextArea.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextStringLengthRange`](parameter-control.md#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`TextArea.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`TextArea.InferenceSettingName`](parameter-control.md#inferencesettingname) | Specifies the name of the Inference Setting object. | - | [`TextArea.DictionaryPath`](parameter-control.md#dictionarypath) | Sets the path of the dictionary file. | - | [`TextArea.DictionaryCorrectionThresholds`](parameter-control.md#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`TextArea.BinarizationModes`](parameter-control.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`TextArea.ColourConversionModes`](parameter-control.md#colourconversionmodes) | Sets the mode and priority for converting a colour image to a grayscale image. | - | [`TextArea.GrayscaleEnhancementModes`](parameter-control.md#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`TextArea.TextureDetectionModes`](parameter-control.md#texturedetectionmodes) | Sets the mode and priority for texture detection. | \ No newline at end of file diff --git a/parameters/reference/text-area/index.md b/parameters/reference/text-area/index.md deleted file mode 100644 index b3696af..0000000 --- a/parameters/reference/text-area/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default-layout -title: TextArea Object - Dynamsoft Label Recognizer Parameter Reference -description: This article shows TextArea Object of Dynamsoft Label Recognizer. -keywords: parameter reference, parameters, TextArea -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - - -# Dynamsoft Label Recognizer SDK - TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](parameter-control.md#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](parameter-control.md#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](parameter-control.md#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](parameter-control.md#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](parameter-control.md#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](parameter-control.md#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](parameter-control.md#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](parameter-control.md#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LineSpecificationNameArray `](parameter-control.md#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringLengthRange`](parameter-control.md#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`TextArea.LineStringRegExPattern`](parameter-control.md#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.MaxLineCharacterSpacing`](parameter-control.md#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`TextArea.TextAreaNameArray `](parameter-control.md#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextStringLengthRange`](parameter-control.md#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`TextArea.TextRegExPattern`](parameter-control.md#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`TextArea.InferenceSettingName`](parameter-control.md#inferencesettingname) | Specifies the name of the Inference Setting object. | - | [`TextArea.DictionaryPath`](parameter-control.md#dictionarypath) | Sets the path of the dictionary file. | - | [`TextArea.DictionaryCorrectionThresholds`](parameter-control.md#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`TextArea.BinarizationModes`](parameter-control.md#binarizationmodes) | Sets the mode and priority for binarization. | - | [`TextArea.ColourConversionModes`](parameter-control.md#colourconversionmodes) | Sets the mode and priority for converting a colour image to a grayscale image. | - | [`TextArea.GrayscaleEnhancementModes`](parameter-control.md#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`TextArea.TextureDetectionModes`](parameter-control.md#texturedetectionmodes) | Sets the mode and priority for texture detection. | - | [`TextArea.CharacterNormalizationModes`](parameter-control.md#characternormalizationmodes) | Sets the mode and priority for character normalization. | diff --git a/parameters/reference/text-area/parameter-control-v1.0.md b/parameters/reference/text-area/parameter-control-v1.0.md deleted file mode 100644 index 03685f6..0000000 --- a/parameters/reference/text-area/parameter-control-v1.0.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for TextArea Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for TextArea Object. -keywords: TextArea, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LinesCount`](#linescount) | Sets the text lines count of the text area. | - | [`TextArea.LineSpecificationNameArray `](#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.TextAreaNameArray `](#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## Name -The name of the TextArea object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"TextArea1" -} -``` - - -  - - -## FirstPoint -The first point of the text area, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - -  - -## SecondPoint -The second point of the text area, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - -  - -## ThirdPoint -The third point of the text area, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - -  - -## FourthPoint -The fourth point of the text area, which is usually the bottom-left corner. - --**Remarks** - - View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    - - The ordinate origin is the top-left corner of the ReferenceRegion.
    - - The value of x is a percentage value relative to the width of the ReferenceRegion.
    - - The value of y is a percentage value relative to the height of the ReferenceRegion.
    - - The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - -  - -## 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. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - -  - -## LinesCount -Sets the text lines count of the text area. - -**Remarks** -0: line count is not certain. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| TextArea | LinesCount | *int* | [0, 200] | 0 | - - -**Json Parameter Example** -```json -{ - "LinesCount":1 -} -``` - -  - -## LineSpecificationNameArray -Specifies the name array of the LineSpecification objects which is relative to current text area. - -**Remarks** -An array item is a name of any available `LineSpecification`. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineSpecificationNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "LineSpecificationNameArray":[ - "LineSpecification1", - "LineSpecification2" - ] -} -``` - -  - -## GrayscaleTransformationModes -Please check [LabelRecognitionParameter.GrayscaleTransformationModes](../label-recognition-parameter/grayscale-transformation-modes.md#GrayscaleTransformationModes) for reference. - -  - -## 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] - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LetterHeightRange | *int array* | [1,100,1] | - -**Json Parameter Example** -```json -{ - "LetterHeightRange":[40,60,1] -} -``` - -  - - - -## TextRegExPattern -Specifies the regular expression pattern of the text to recognize. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "TextRegExPattern":"" -} -``` - -  - - -## LineStringRegExPattern -Specifies the regular expression pattern of each line string text in current text area to recognize. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "LineStringRegExPattern":"" -} -``` - -  - - -## TextAreaNameArray -Specifies the name array of the TextArea objects which is relative to current text area. - -**Remarks** -An array item is a name of any available `TextArea`. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextAreaNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "TextAreaNameArray":[ - "TextArea1", - "TextArea2" - ] -} -``` - -  - diff --git a/parameters/reference/text-area/parameter-control-v1.2.1.md b/parameters/reference/text-area/parameter-control-v1.2.1.md deleted file mode 100644 index 030e82e..0000000 --- a/parameters/reference/text-area/parameter-control-v1.2.1.md +++ /dev/null @@ -1,412 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognition Parameter Reference for TextArea Object -description: This page shows Dynamsoft Label Recognition Parameter Reference for TextArea Object. -keywords: TextArea, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: false ---- - -# TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LinesCount`](#linescount) | Sets the text lines count of the text area. | - | [`TextArea.LineSpecificationNameArray `](#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`TextArea.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.MaxLineCharacterSpacing`](#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`TextArea.TextAreaNameArray `](#textareanamearray ) | Specifies the name array of the TextAreas which is relative to current text area. | - | [`TextArea.TextStringLengthRange`](#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`TextArea.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - ---- - - -## Name -The name of the TextArea object. - -**Remarks** -It must be a unique name. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"TextArea1" -} -``` - - -  - - -## FirstPoint -The first point of the text area, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - -  - -## SecondPoint -The second point of the text area, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - -  - -## ThirdPoint -The third point of the text area, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - -  - -## FourthPoint -The fourth point of the text area, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - -  - -## 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. - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - -  - -## GrayscaleTransformationModes -Please check [LabelRecognitionParameter.GrayscaleTransformationModes](../label-recognition-parameter/grayscale-transformation-modes.md#GrayscaleTransformationModes) for reference. - -  - -## 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] - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LetterHeightRange | *int array* | [1,100,1] | - -**Json Parameter Example** -```json -{ - "LetterHeightRange":[40,60,1] -} -``` - -  - - -## LinesCount -Sets the text lines count of the text area. - -**Remarks** -0: line count is not certain. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| TextArea | LinesCount | *int* | [0, 200] | 0 | - - -**Json Parameter Example** -```json -{ - "LinesCount":1 -} -``` - -  - -## LineSpecificationNameArray -Specifies the name array of the LineSpecification objects which is relative to current text area. - -**Remarks** -An array item is a name of any available `LineSpecification`. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineSpecificationNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "LineSpecificationNameArray":[ - "LineSpecification1", - "LineSpecification2" - ] -} -``` - -  - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "LineStringLengthRange": [4,200] -} -``` - -  - - -## LineStringRegExPattern -Specifies the regular expression pattern of each line string text in current text area to recognize. - -**Remarks** - - All LineSpecification Objects without LineStringRegExPattern set will be set from this setting. - - Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| TextArea | MaxLineCharacterSpacing | *int* | [0, 0x7fffffff] | 0 | - - -**Json Parameter Example** -```json -{ - "MaxLineCharacterSpacing":200 -} -``` - -  - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextStringLengthRange | *JSON Object* | `null` | - -- **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** -Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "TextRegExPattern":"" -} -``` - -  - -## TextAreaNameArray -Specifies the name array of the TextArea objects which is relative to current text area. - -**Remarks** -An array item is a name of any available `TextArea`. - -### As Json Parameter - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextAreaNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "TextAreaNameArray":[ - "TextArea1", - "TextArea2" - ] -} -``` - -  - diff --git a/parameters/reference/text-area/parameter-control-v2.0.md b/parameters/reference/text-area/parameter-control-v2.0.md deleted file mode 100644 index 7605658..0000000 --- a/parameters/reference/text-area/parameter-control-v2.0.md +++ /dev/null @@ -1,437 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference for TextArea Object -description: This page shows Dynamsoft Label Recognizer Parameter Reference for TextArea Object. -keywords: TextArea, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LineSpecificationNameArray `](#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`TextArea.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.MaxLineCharacterSpacing`](#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`TextArea.TextStringLengthRange`](#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`TextArea.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`TextArea.DictionaryPath`](#dictionarypath) | Sets the path of the dictionary file. | - | [`TextArea.DictionaryCorrectionThresholds`](#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`TextArea.BinarizationModes`](#binarizationmodes) | Sets the mode and priority for binarization. | - | [`TextArea.ColourConversionModes`](#colourconversionmodes) | Sets the mode and priority for converting a colour image to a grayscale image. | - | [`TextArea.GrayscaleEnhancementModes`](#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`TextArea.TextureDetectionModes`](#texturedetectionmodes) | Sets the mode and priority for texture detection. | - ---- - - -## Name -The name of the TextArea object. - -**Remarks** -It must be a unique name. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"TextArea1" -} -``` - - - - - -## FirstPoint -The first point of the text area, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - - - -## SecondPoint -The second point of the text area, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - - - -## ThirdPoint -The third point of the text area, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - - - -## FourthPoint -The fourth point of the text area, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - - - -## 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. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - - - -## GrayscaleTransformationModes -Please check [LabelRecognizerParameter.GrayscaleTransformationModes](../label-recognition-parameter/grayscale-transformation-modes.md#grayscaletransformationmodes) for reference. - - - -## 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] - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LetterHeightRange | *int array* | [1,100,1] | - -**Json Parameter Example** -```json -{ - "LetterHeightRange":[40,60,1] -} -``` - - - -## LineSpecificationNameArray -Specifies the name array of the LineSpecification objects which is relative to current text area. - -**Remarks** -An array item is a name of any available `LineSpecification`. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineSpecificationNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "LineSpecificationNameArray":[ - "LineSpecification1", - "LineSpecification2" - ] -} -``` - - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "LineStringLengthRange": [4,200] -} -``` - - - - -## LineStringRegExPattern -Specifies the regular expression pattern of each line string text in current text area to recognize. - -**Remarks** - - All LineSpecification Objects without LineStringRegExPattern set will be set from this setting. - - Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| TextArea | MaxLineCharacterSpacing | *int* | [0, 0x7fffffff] | 0 | - - -**Json Parameter Example** -```json -{ - "MaxLineCharacterSpacing":200 -} -``` - - - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "TextStringLengthRange": - { - "MinValue": 4, - "MaxValue": 200 - } -} -``` - - - - -## TextRegExPattern -Specifies the regular expression pattern of the text to recognize. - -**Remarks** -Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "TextRegExPattern":"" -} -``` - - - -## DictionaryPath -Sets the path of the dictionary file. - -**As Json Parameter** - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | DictionaryPath | *string* | "" | - -**Json Parameter Example** -```json -{ - "DictionaryPath":"D:\\DictModel\\nutrition.txt" -} -``` - - - - -## DictionaryCorrectionThresholds -Sets the threshold of dictionary error correction. - -**Remarks** -It supports segmentation threshold. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | DictionaryCorrectionThresholds | *Array* | `null` | - -- MinWordLength: The minimum value of word length. -- MaxWordLength: The maximum value of word length. -- Threshold: The threshold for the number of error correction characters. - -**Json Parameter Example** -```json -{ - "DictionaryCorrectionThresholds": [ - { - "MinWordLength": 3, - "MaxWordLength": 5, - "Threshold": 1 - }, - { - "MinWordLength": 6, - "MaxWordLength": 10, - "Threshold": 2 - }, - { - "MinWordLength": 11, - "Threshold": 3 - } - ] - -} -``` - -## BinarizationModes -Please check [LabelRecognizerParameter.BinarizationModes](../label-recognition-parameter/binarization-modes.md#binarizationmodes) for reference. - -## ColourConversionModes -Please check [LabelRecognizerParameter.ColourConversionModes](../label-recognition-parameter/colour-conversion-modes.md#colourconversionmodes) for reference. - -## GrayscaleEnhancementModes -Please check [LabelRecognizerParameter.GrayscaleEnhancementModes](../label-recognition-parameter/grayscale-enhancement-modes.md#grayscaleenhancementmodes) for reference. - -## TextureDetectionModes -Please check [LabelRecognizerParameter.TextureDetectionModes](../label-recognition-parameter/texture-detection-modes.md#texturedetectionmodes) for reference. diff --git a/parameters/reference/text-area/parameter-control.md b/parameters/reference/text-area/parameter-control.md deleted file mode 100644 index 06fd028..0000000 --- a/parameters/reference/text-area/parameter-control.md +++ /dev/null @@ -1,441 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recognizer Parameter Reference for TextArea Object -description: This page shows Dynamsoft Label Recognizer Parameter Reference for TextArea Object. -keywords: TextArea, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# TextArea Object - - | Parameter Name | Description | - | -------------- | ----------- | - | [`TextArea.Name`](#name) | The name of the TextArea object. | - | [`TextArea.FirstPoint`](#firstpoint) | The first point of the text area, which is usually the top-left corner. | - | [`TextArea.SecondPoint`](#secondpoint) | The second point of the text area, which is usually the top-right corner. | - | [`TextArea.ThirdPoint`](#thirdpoint) | The third point of the text area, which is usually the bottom-right corner. | - | [`TextArea.FourthPoint`](#fourthpoint) | The fourth point of the text area, which is usually the bottom-left corner. | - | [`TextArea.CharacterModelName`](#charactermodelname) | Sets the name of a white list of recognizable characters. | - | [`TextArea.GrayscaleTransformationModes`](#grayscaletransformationmodes) | Sets the mode and priority for the grayscale image conversion. | - | [`TextArea.LetterHeightRange`](#letterheightrange) | Sets the range of letter height (in pixel or a percentage value relative to the height of the text area). | - | [`TextArea.LineSpecificationNameArray `](#LineSpecificationnamearray ) | Specifies the name array of the LineSpecification objects which is relative to current TextArea. | - | [`TextArea.LineStringLengthRange`](#linestringlengthrange) | Sets the range of string length for each recognized line. | - | [`TextArea.LineStringRegExPattern`](#linestringregexpattern) | Specifies the regular expression pattern of each line string text in current text area to recognize. | - | [`TextArea.MaxLineCharacterSpacing`](#maxlinecharacterspacing) | Sets the maximum spacing between characters treated as one line. | - | [`TextArea.TextStringLengthRange`](#textstringlengthrange) | Sets the range of string length for each recognized text area. | - | [`TextArea.TextRegExPattern`](#textregexpattern) | Specifies the regular expression pattern of the text to recognize. | - | [`TextArea.DictionaryPath`](#dictionarypath) | Sets the path of the dictionary file. | - | [`TextArea.DictionaryCorrectionThresholds`](#dictionarycorrectionthresholds) | Sets the threshold of dictionary error correction. | - | [`TextArea.BinarizationModes`](#binarizationmodes) | Sets the mode and priority for binarization. | - | [`TextArea.ColourConversionModes`](#colourconversionmodes) | Sets the mode and priority for converting a colour image to a grayscale image. | - | [`TextArea.GrayscaleEnhancementModes`](#grayscaleenhancementmodes) | Sets the mode and priority for grayscale image preprocessing algorithms. | - | [`TextArea.TextureDetectionModes`](#texturedetectionmodes) | Sets the mode and priority for texture detection. | - | [`TextArea.CharacterNormalizationModes`](#characternormalizationmodes) | Sets the mode and priority for texture detection. | - ---- - - -## Name -The name of the TextArea object. - -**Remarks** -It must be a unique name. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | Name | *string* | It must be a mandatory setting value. | - -**Json Parameter Example** -```json -{ - "Name":"TextArea1" -} -``` - - - - - -## FirstPoint -The first point of the text area, which is usually the top-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FirstPoint | *int array* | [0, 0] | - - -**Json Parameter Example** -```json -{ - "FirstPoint":[0, 10] -} -``` - - - -## SecondPoint -The second point of the text area, which is usually the top-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | SecondPoint | *int array* | [100, 0] | - - -**Json Parameter Example** -```json -{ - "SecondPoint":[10, 10] -} -``` - - - -## ThirdPoint -The third point of the text area, which is usually the bottom-right corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | ThirdPoint | *int array* | [100, 100] | - - -**Json Parameter Example** -```json -{ - "ThirdPoint":[0, 10] -} -``` - - - -## FourthPoint -The fourth point of the text area, which is usually the bottom-left corner. - -**Remarks** -View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
    -The ordinate origin is the top-left corner of the ReferenceRegion.
    -The value of x is a percentage value relative to the width of the ReferenceRegion.
    -The value of y is a percentage value relative to the height of the ReferenceRegion.
    -The allowed values for x/y: [-10000, 10000]
    - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | FourthPoint | *int array* | [0, 100] | - - -**Json Parameter Example** -```json -{ - "FourthPoint":[10, 20] -} -``` - - - -## 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. - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | CharacterModelName | *string* | "" | - -**Json Parameter Example** -```json -{ - "CharacterModelName":"CharacterModel_Name1" -} -``` - - - -## GrayscaleTransformationModes -Please check [LabelRecognizerParameter.GrayscaleTransformationModes](../label-recognition-parameter/grayscale-transformation-modes.md#grayscaletransformationmodes) for reference. - - - -## 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] - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LetterHeightRange | *int array* | [1,100,1] | - -**Json Parameter Example** -```json -{ - "LetterHeightRange":[40,60,1] -} -``` - - - -## LineSpecificationNameArray -Specifies the name array of the LineSpecification objects which is relative to current text area. - -**Remarks** -An array item is a name of any available `LineSpecification`. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineSpecificationNameArray | *string Array* | `null` | - - -**Json Parameter Example** -```json -{ - "LineSpecificationNameArray":[ - "LineSpecification1", - "LineSpecification2" - ] -} -``` - - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "LineStringLengthRange": [4,200] -} -``` - - - - -## LineStringRegExPattern -Specifies the regular expression pattern of each line string text in current text area to recognize. - -**Remarks** - - All LineSpecification Objects without LineStringRegExPattern set will be set from this setting. - - Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | LineStringRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "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. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Value Range | Default Value | -| ----------- | ------------------- | ---------- | ----------- | ------------- | -| TextArea | MaxLineCharacterSpacing | *int* | [0, 0x7fffffff] | 0 | - - -**Json Parameter Example** -```json -{ - "MaxLineCharacterSpacing":200 -} -``` - - - -## 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. - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextStringLengthRange | *JSON Object* | `null` | - -- **Remarks** - - Value range of `MinValue` and `MaxValue`: [0, 0x7fffffff]
    - - MaxValue >= MinValue - -**Json Parameter Example** -```json -{ - "TextStringLengthRange": - { - "MinValue": 4, - "MaxValue": 200 - } -} -``` - - - - -## TextRegExPattern -Specifies the regular expression pattern of the text to recognize. - -**Remarks** -Supported regular expressions pattern syntax is same as [`TextRegExPattern`]({{ site.parameters-reference }}label-recognition-parameter/parameter-control.html#textregexpattern). - - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | TextRegExPattern | *string* | "" | - -**Json Parameter Example** -```json -{ - "TextRegExPattern":"" -} -``` - - - -## DictionaryPath -Sets the path of the dictionary file. - -**As Json Parameter** - - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | DictionaryPath | *string* | "" | - -**Json Parameter Example** -```json -{ - "DictionaryPath":"D:\\DictModel\\nutrition.txt" -} -``` - - - - -## DictionaryCorrectionThresholds -Sets the threshold of dictionary error correction. - -**Remarks** -It supports segmentation threshold. - -**As Json Parameter** - -| Json Object | Json Parameter Name | Value Type | Default Value | -| ----------- | ------------------- | ---------- | ------------- | -| TextArea | DictionaryCorrectionThresholds | *Array* | `null` | - -- MinWordLength: The minimum value of word length. -- MaxWordLength: The maximum value of word length. -- Threshold: The threshold for the number of error correction characters. - -**Json Parameter Example** -```json -{ - "DictionaryCorrectionThresholds": [ - { - "MinWordLength": 3, - "MaxWordLength": 5, - "Threshold": 1 - }, - { - "MinWordLength": 6, - "MaxWordLength": 10, - "Threshold": 2 - }, - { - "MinWordLength": 11, - "Threshold": 3 - } - ] - -} -``` - -## BinarizationModes -Please check [LabelRecognizerParameter.BinarizationModes](../label-recognition-parameter/binarization-modes.md#binarizationmodes) for reference. - -## ColourConversionModes -Please check [LabelRecognizerParameter.ColourConversionModes](../label-recognition-parameter/colour-conversion-modes.md#colourconversionmodes) for reference. - -## GrayscaleEnhancementModes -Please check [LabelRecognizerParameter.GrayscaleEnhancementModes](../label-recognition-parameter/grayscale-enhancement-modes.md#grayscaleenhancementmodes) for reference. - -## TextureDetectionModes -Please check [LabelRecognizerParameter.TextureDetectionModes](../label-recognition-parameter/texture-detection-modes.md#texturedetectionmodes) for reference. - -## CharacterNormalizationModes -Please check [LabelRecognizerParameter.CharacterNormalizationModes](../label-recognition-parameter/character-normalization-modes.md#characternormalizationmodes) for reference. \ No newline at end of file diff --git a/release-notes/index.md b/release-notes/index.md deleted file mode 100644 index 9383570..0000000 --- a/release-notes/index.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Label Recoginizer SDK - Release Notes -description: This is the release notes page of Dynamsoft Label Recoginizer SDK. -keywords: release notes -needAutoGenerateSidebar: false ---- - -# Release Notes - -## 3.4 - -> First released: 07-23-2023 - -### Highlights - -{%- include release-notes/product-highlight-3.4.10.md -%} - -| Versions | Available Editions | -| -------- | ---------------------------------------------------------- | -| 3.4.10 | [C++]({{site.cpp}}release-notes/cpp-3.html#3410-07232024){:target="_blank"} | - -## 3.2 - -> First released: 01-16-2024 - -### Highlights - -{%- include release-notes/product-highlight-3.2.0.md -%} - -| Versions | Available Editions | -| -------- | ---------------------------------------------------------- | -| 3.2.32 | [.NET]({{site.dotnet}}release-notes/dotnet-3.html#3232-06192024){:target="_blank"} | -| 3.2.31 | [.NET]({{site.dotnet}}release-notes/dotnet-3.html#3231-06122024){:target="_blank"} | -| 3.2.30 | [C++]({{site.cpp}}release-notes/cpp-3.html#3230-05132024){:target="_blank"} / [.NET]({{site.dotnet}}release-notes/dotnet-3.html#3230-05302024){:target="_blank"} / [JavaScript]({{site.js}}release-notes/javascript-3.html#3230-05152024){:target="_blank"} / [Android]({{site.android}}release-notes/android-3.html#3230-05152024){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-3.html#3230-05152024){:target="_blank"} | -| 3.2.20 | [C++]({{site.cpp}}release-notes/cpp-3.html#3220-04072024){:target="_blank"} | -| 3.2.10 | [C++]({{site.cpp}}release-notes/cpp-3.html#3210-03012024){:target="_blank"} | -| 3.2.0 | [C++]({{site.cpp}}release-notes/cpp-3.html#320-01162024){:target="_blank"} | - -## 3.0 - -> First released: 07-04-2023 - -### Highlights - -{%- include release-notes/product-highlight-3.0.0.md -%} - -| Versions | Available Editions | -| -------- | ---------------------------------------------------------- | -| 3.0.30 | [JavaScript]({{site.js}}release-notes/javascript-3.html#3030-02022024){:target="_blank"} | -| 3.0.20 | [C++]({{site.cpp}}release-notes/cpp-3.html#3020-10262023){:target="_blank"} / [Android]({{site.android}}release-notes/android-3.html#3020-12072023){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-3.html#3020-12072023){:target="_blank"} | -| 3.0.10 | [C++]({{site.cpp}}release-notes/cpp-3.html#3010-08082023){:target="_blank"} | -| 3.0.0 | [C++]({{site.cpp}}release-notes/cpp-3.html#300-07042023){:target="_blank"} | - -## 2.2 - -> First released: 11-30-2021 - -### Highlights - -{%- include release-notes/product-highlight-2.2.md -%} - -| Versions | Available Editions | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 2.2.30 | [JavaScript]({{site.js}}release-notes/javascript-2.html#2211-07242023){:target="_blank"} | -| 2.2.20 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-2.html#2220-09292022){:target="_blank"} / [Android]({{site.android}}release-notes/android-2.html#2220-09292022){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-2.html#2220-09292022){:target="_blank"} | -| 2.2.11 | [JavaScript]({{site.js}}release-notes/javascript-2.html#2211-08082022){:target="_blank"} | -| 2.2.10 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-2.html#2210-06212022){:target="_blank"} / [JavaScript]({{site.js}}release-notes/javascript-2.html#2210-06212022){:target="_blank"} /[Java]({{site.java}}release-notes/java-2.html#2210-06272024){:target="_blank"} | -| 2.2.4 | [JavaScript]({{site.js}}release-notes/javascript-2.html#224-04142022){:target="_blank"} | -| 2.2.2 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-2.html#222-03032022){:target="_blank"} / [JavaScript]({{site.js}}release-notes/javascript-2.html#222-03032022){:target="_blank"} | -| 2.2.1 | [JavaScript]({{site.js}}release-notes/javascript-2.html#221-02232022){:target="_blank"} | -| 2.2.0 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-2.html#20-11302021){:target="_blank"} / [JavaScript]({{site.js}}release-notes/javascript-2.html#220-12072021){:target="_blank"} | - -## 2.0 -> First released: 08-26-2021 - -### Highlights - -{%- include release-notes/product-highlight-2.0.md -%} - -| Versions | Available Editions | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 2.0.0 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-2.html#20-08262021){:target="_blank"} / [.NET]({{site.dotnet}}release-notes/dotnet-2.html#20-08262021){:target="_blank"} / [Java]({{site.java}}release-notes/java-2.html#20-08262021){:target="_blank"} / [Android]({{site.android}}release-notes/android-2.html#20-08262021){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-2.html#20-08262021){:target="_blank"} | - -  - -
    - -## 1.x Versions - -
    - -  - -### 1.2 -> First released: 05-18-2021 - -#### Highlights - -{%- include release-notes/product-highlight-1.2.md -%} - -| Versions | Available Editions | -| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1.2.0 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-1.html#12-05182021){:target="_blank"} / [.NET]({{site.dotnet}}release-notes/dotnet-1.html#12-05182021){:target="_blank"} / [Android]({{site.android}}release-notes/android-1.html#12-05182021){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-1.html#12-05182021){:target="_blank"} | -| 1.2.1 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-1.html#121-06082021){:target="_blank"} / [.NET]({{site.dotnet}}release-notes/dotnet-1.html#121-06082021){:target="_blank"} / [Java]({{site.java}}release-notes/java-1.html#121-06082021){:target="_blank"} / [Android]({{site.android}}release-notes/android-1.html#121-06082021){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-1.html#121-06082021){:target="_blank"} | - -  - -### 1.0 - -> First released: 02-24-2021 - -#### Highlights - -{%- include release-notes/product-highlight-1.0.md -%} - -[C/C++]({{site.c-cplusplus}}release-notes/c-cpp-1.html#10-02242021){:target="_blank"} / [.NET]({{site.dotnet}}release-notes/dotnet-1.html#10-02242021){:target="_blank"} / [Android]({{site.android}}release-notes/android-1.html#10-02242021){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-1.html#10-02242021){:target="_blank"} - -| Versions | Available Editions | -| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1.0.0 | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-1.html#10-02242021){:target="_blank"} / [.NET]({{site.dotnet}}release-notes/dotnet-1.html#10-02242021){:target="_blank"} / [Android]({{site.android}}release-notes/android-1.html#10-02242021){:target="_blank"} / [iOS]({{site.objectivec-swift}}release-notes/ios-1.html#10-02242021){:target="_blank"} | - -  - -### 1.0 Beta - -> First released: 12-10-2020 - -| Versions | Available Editions | -| ---------- | ------------------------------------------------------------------------ | -| 1.0.0 Beta | [C/C++]({{site.c-cplusplus}}release-notes/c-cpp-1.html#10-beta-12102020){:target="_blank"} | - -