From a5452f36d382c2a594163163538c50fe2d659a44 Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Fri, 12 Sep 2025 13:26:20 +0800 Subject: [PATCH] update to internal commit 55d1ed2c --- _config.yml | 1 + _data/product_version.yml | 3 +- .../sidelist-architecture-v2.6.1000.html | 19 - ...idelist-parameter-reference-v2.4.2200.html | 200 --- ...idelist-parameter-reference-v2.6.1000.html | 219 --- ...ist-parameters-organization-v2.6.1000.html | 18 - .../sidelist-understanding-v2.6.1000.html | 4 - _layouts/default-layout-OLD.html | 142 -- _layouts/search-page-OLD.html | 206 --- .../document-normalization-v2.6.1004.md | 46 - .../image-processing/index-v2.6.1004.md | 141 -- .../barcode-format-v2.4.2000.md | 767 ---------- .../camera-position-v2.2.3000.md | 50 - .../drawing-item-media-type-v2.2.3000.md | 98 -- .../preset-template-v2.4.2000.md | 252 ---- enums/core/corner-type-v2.4.2100.md | 105 -- enums/core/error-code-v2.2.3000.md | 1310 ----------------- ...intermediate-result-unit-type-v2.2.3000.md | 353 ----- ...intermediate-result-unit-type-v2.4.2200.md | 360 ----- ...intermediate-result-unit-type-v2.5.2100.md | 427 ------ .../region-object-element-type-v2.4.2100.md | 130 -- enums/core/section-type-v2.4.2100.md | 134 -- enums/core/transform-matrix-type-v2.4.2100.md | 86 -- .../raw-text-line-status-v2.4.2100.md | 55 - .../barcode-format-specification-v2.6.1000.md | 147 -- .../textline-specification-v2.6.1000.md | 114 -- parameters/file/image-parameter-v2.6.1004.md | 192 --- parameters/file/index-v2.6.1000.md | 197 --- .../target-roi-definition/index-v2.6.1004.md | 226 --- .../barcode-reader-task-settings-v2.6.1000.md | 134 -- ...ment-normalizer-task-settings-v2.6.1004.md | 95 -- ...abel-recognizer-task-settings-v2.6.1004.md | 72 - .../deblur-modes-v2.6.1000.md | 208 --- .../index-v2.4.2200.md | 30 - .../corner-angle-range-v2.4.2200.md | 92 -- .../expected-documents-count-v2.4.2200.md | 29 - .../index-v2.2.12.md | 29 - .../index-v2.4.2200.md | 30 - .../index-v2.6.1004.md | 31 - .../quadrilateral-detection-modes-v2.2.12.md | 82 -- .../binarization-modes-v2.6.1004.md | 408 ----- .../colour-conversion-modes-v2.4.2200.md | 229 --- .../grayscale-enhancement-modes-v2.6.1004.md | 278 ---- .../image-parameter/index-v2.6.1003.md | 26 - .../region-predetection-modes-v2.6.1004.md | 399 ----- .../target-roi-def/index-v2.6.1004.md | 19 - .../target-roi-def/location-v2.6.1004.md | 546 ------- .../character-model-name-v2.6.1004.md | 29 - 48 files changed, 3 insertions(+), 8765 deletions(-) delete mode 100644 _includes/sidelist-architecture-v2.6.1000.html delete mode 100644 _includes/sidelist-parameter-reference-v2.4.2200.html delete mode 100644 _includes/sidelist-parameter-reference-v2.6.1000.html delete mode 100644 _includes/sidelist-parameters-organization-v2.6.1000.html delete mode 100644 _includes/sidelist-understanding-v2.6.1000.html delete mode 100644 _layouts/default-layout-OLD.html delete mode 100644 _layouts/search-page-OLD.html delete mode 100644 architecture/image-processing/document-normalization-v2.6.1004.md delete mode 100644 architecture/image-processing/index-v2.6.1004.md delete mode 100644 enums/barcode-reader/barcode-format-v2.4.2000.md delete mode 100644 enums/camera-enhancer/camera-position-v2.2.3000.md delete mode 100644 enums/camera-enhancer/drawing-item-media-type-v2.2.3000.md delete mode 100644 enums/capture-vision-router/preset-template-v2.4.2000.md delete mode 100644 enums/core/corner-type-v2.4.2100.md delete mode 100644 enums/core/error-code-v2.2.3000.md delete mode 100644 enums/core/intermediate-result-unit-type-v2.2.3000.md delete mode 100644 enums/core/intermediate-result-unit-type-v2.4.2200.md delete mode 100644 enums/core/intermediate-result-unit-type-v2.5.2100.md delete mode 100644 enums/core/region-object-element-type-v2.4.2100.md delete mode 100644 enums/core/section-type-v2.4.2100.md delete mode 100644 enums/core/transform-matrix-type-v2.4.2100.md delete mode 100644 enums/label-recognizer/raw-text-line-status-v2.4.2100.md delete mode 100644 parameters/file/auxiliary/barcode-format-specification-v2.6.1000.md delete mode 100644 parameters/file/auxiliary/textline-specification-v2.6.1000.md delete mode 100644 parameters/file/image-parameter-v2.6.1004.md delete mode 100644 parameters/file/index-v2.6.1000.md delete mode 100644 parameters/file/target-roi-definition/index-v2.6.1004.md delete mode 100644 parameters/file/task-settings/barcode-reader-task-settings-v2.6.1000.md delete mode 100644 parameters/file/task-settings/document-normalizer-task-settings-v2.6.1004.md delete mode 100644 parameters/file/task-settings/label-recognizer-task-settings-v2.6.1004.md delete mode 100644 parameters/reference/barcode-reader-task-settings/deblur-modes-v2.6.1000.md delete mode 100644 parameters/reference/barcode-reader-task-settings/index-v2.4.2200.md delete mode 100644 parameters/reference/document-normalizer-task-settings/corner-angle-range-v2.4.2200.md delete mode 100644 parameters/reference/document-normalizer-task-settings/expected-documents-count-v2.4.2200.md delete mode 100644 parameters/reference/document-normalizer-task-settings/index-v2.2.12.md delete mode 100644 parameters/reference/document-normalizer-task-settings/index-v2.4.2200.md delete mode 100644 parameters/reference/document-normalizer-task-settings/index-v2.6.1004.md delete mode 100644 parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes-v2.2.12.md delete mode 100644 parameters/reference/image-parameter/binarization-modes-v2.6.1004.md delete mode 100644 parameters/reference/image-parameter/colour-conversion-modes-v2.4.2200.md delete mode 100644 parameters/reference/image-parameter/grayscale-enhancement-modes-v2.6.1004.md delete mode 100644 parameters/reference/image-parameter/index-v2.6.1003.md delete mode 100644 parameters/reference/image-parameter/region-predetection-modes-v2.6.1004.md delete mode 100644 parameters/reference/target-roi-def/index-v2.6.1004.md delete mode 100644 parameters/reference/target-roi-def/location-v2.6.1004.md delete mode 100644 parameters/reference/text-line-specification/character-model-name-v2.6.1004.md diff --git a/_config.yml b/_config.yml index 190b2d8..749acc7 100644 --- a/_config.yml +++ b/_config.yml @@ -44,6 +44,7 @@ dnt_icon: /capture-vision/docs/core/assets/img-icon/icon-dnt.svg useVersionTree: true isDCV: true +useJSVersionV3: true baseurl: "/capture-vision/docs/core" plugins: diff --git a/_data/product_version.yml b/_data/product_version.yml index 31c8516..e67cb27 100644 --- a/_data/product_version.yml +++ b/_data/product_version.yml @@ -1,4 +1,5 @@ useGroupedVersion: true version_info_list: - - value: latest version \ No newline at end of file + - value: latest version + - value: 2.x diff --git a/_includes/sidelist-architecture-v2.6.1000.html b/_includes/sidelist-architecture-v2.6.1000.html deleted file mode 100644 index 1cd4505..0000000 --- a/_includes/sidelist-architecture-v2.6.1000.html +++ /dev/null @@ -1,19 +0,0 @@ -
  • Architecture - -
    • diff --git a/_includes/sidelist-parameter-reference-v2.4.2200.html b/_includes/sidelist-parameter-reference-v2.4.2200.html deleted file mode 100644 index 7e1624f..0000000 --- a/_includes/sidelist-parameter-reference-v2.4.2200.html +++ /dev/null @@ -1,200 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameter-reference-v2.6.1000.html b/_includes/sidelist-parameter-reference-v2.6.1000.html deleted file mode 100644 index bde76e2..0000000 --- a/_includes/sidelist-parameter-reference-v2.6.1000.html +++ /dev/null @@ -1,219 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-organization-v2.6.1000.html b/_includes/sidelist-parameters-organization-v2.6.1000.html deleted file mode 100644 index e257054..0000000 --- a/_includes/sidelist-parameters-organization-v2.6.1000.html +++ /dev/null @@ -1,18 +0,0 @@ -
  • Parameter Organization - -
    • \ No newline at end of file diff --git a/_includes/sidelist-understanding-v2.6.1000.html b/_includes/sidelist-understanding-v2.6.1000.html deleted file mode 100644 index ce2d4cd..0000000 --- a/_includes/sidelist-understanding-v2.6.1000.html +++ /dev/null @@ -1,4 +0,0 @@ -
  • UNDERSTANDING DCV
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-architecture.html" -%} -{%- 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-parameter-reference.html" -%} \ No newline at end of file diff --git a/_layouts/default-layout-OLD.html b/_layouts/default-layout-OLD.html deleted file mode 100644 index 9e3c673..0000000 --- a/_layouts/default-layout-OLD.html +++ /dev/null @@ -1,142 +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 dcvNav.html -%} -
    Table of contents
    -
    -
    -
    -
    - {%- include main-page-head.html -%} -
    -
    -
    - - {{ content }} - -
    -
    -
    -

    This page is compatible for:

    -

    Version 1.0

    -
    -
    -

    Is this page helpful?

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

    In this article:

    -
    - {%- endif -%} -
    -
    - -
    - -
    -
    -
    -
    -
    - {%- include liquid_autoGenerateHistoryList.html -%} - {%- include auto-version-list.html -%} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - {%- include livehelp.html -%} - - - - - - - - - - - - \ No newline at end of file diff --git a/_layouts/search-page-OLD.html b/_layouts/search-page-OLD.html deleted file mode 100644 index 00196e6..0000000 --- a/_layouts/search-page-OLD.html +++ /dev/null @@ -1,206 +0,0 @@ - - - -{%- include head.html -%} - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include dcvNav.html -%} -
    Table of contents
    -
    -
    -
    -
    -
    -
    -
    -

    Search

    - -
    -
    -
    -
    -
    - {{ content }} - -
    -
    -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - {%- include livehelp.html -%} - - - \ No newline at end of file diff --git a/architecture/image-processing/document-normalization-v2.6.1004.md b/architecture/image-processing/document-normalization-v2.6.1004.md deleted file mode 100644 index f1ec50b..0000000 --- a/architecture/image-processing/document-normalization-v2.6.1004.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default-layout -title: Document Normalization Section - Dynamsoft Capture Vision Architecture -description: This article introduces Document Normalization Section in the Dynamsoft Capture Vision architecture. -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -The following diagram shows how sections connect to each other to form tasks: - -```mermaid -flowchart LR; - A[1.Region Pre-Detection]-->C[2.1.Shared Detection] - C---D[2.2.Barcode Localization] - C---E[2.2.Text-line Localization] - C---F[2.2.Document Detection] - D---G[3.Barcode Decoding] - E---H[3.Text-line Recognition] - F---I[3.Document Normalization] - style I fill:#f96,stroke:#333,stroke-width:4px -``` - -In this article, we'll discuss the section **Document Normalization** which is usually the 3rd section of a "Normalize-a-Document" task. - -# Section 3 - Document Normalization - -The purpose of this section is to generate a standard rectangular image of the "document" localized in the section "Document Detection". - -> A document is an object that exhibit clear boundaries. - -## Constituting Stages - -This section consists of just one stage: - -- Document-normalizing: to normalize the document which may involve one or several of these actions: - - Deskew - - Perspective correction - - Colour conversion - - Brightness and contrast adjustment - -## Output and Parameters - -| Stage | Intermediate Result Type | Related Parameter | -| ----- | ------------------------ | ----------------- | -| Document-normalizing | `IRUT_NORMALIZED_IMAGES` | [`Brightness`](../../parameters/reference/document-normalizer-task-settings/brightness.md), [`Contrast`](../../parameters/reference/document-normalizer-task-settings/contrast.md), [`ColourMode`](../../parameters/reference/document-normalizer-task-settings/colour-mode.md), [`DeskewMode`](../../parameters/reference/document-normalizer-task-settings/deskew-mode.md) | diff --git a/architecture/image-processing/index-v2.6.1004.md b/architecture/image-processing/index-v2.6.1004.md deleted file mode 100644 index 7e075a4..0000000 --- a/architecture/image-processing/index-v2.6.1004.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -layout: default-layout -title: Image-Processing Tasks - Dynamsoft Capture Vision Architecture -description: This article introduces all image-processing tasks in the Dynamsoft Capture Vision architecture. -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: false ---- - -# Image-Processing Tasks - -In the Dynamsoft Capture Vision (DCV) architecture, various image processing tasks exist, each constituting a comprehensive algorithmic procedure designed to extract specific information or to produce an improved version of the original image. - -## Task Types - -The following are the image-processing tasks supported at present: - -| Task Type | Performed By | Category | Result Type | -| :------------------------- | :----------- | :--------------- | :---------------------- | -| Read Barcodes | DBR | Image-Processing | Decoded Barcodes | -| Recognize Text Lines | DLR | Image-Processing | Recognized TextLines | -| Detect Document Boundaries | DDN | Image-Processing | Document Boundary Quads | -| Normalize a Document | DDN | Image-Processing | Normalized Image | - -***Table 1: Task Types*** - -## Divide Tasks into Sections - -Each image-processing task can be further divided into three sections, each of these sections constitutes a collection of relevant algorithmic proedures designed to produce the location results - -| Task Type | Sections | -| :------------------- | :------------------------------------------------------------------ | -| Read Barcodes | Region Pre-detection, Barcode Localization, Barcode Decoding | -| Recognize Text Lines | Region Pre-detection, Text-line Localization, Text-line Recognition | -| Normalize a Document | Region Pre-detection, Document Detection, Document Normalization | - -***Table 2: Tasks and Sections*** - -In total, there are 7 unique image-processing sections, which belong to one of three steps of a task: - -### Step one: initial image-processing - -This step tries to find parts of the image, called "regions of interest (ROI)" that exhibit distinct features that match the result we are trying to obtain. Then these regions are cropped to produce regional images as the final output of this step for the next step to process. There is only one section for this step: - -- [Region Pre-detection](region-predetection.md) - -> 1. If no specific region is found, the entire image is the output. -> 2. There can be multiple regions found which result in multiple regional images as the output. - -### Step two: detecting the precise location - -This step tries to find the precise location, called "zones", of the final results (a barcode, a text-line or a document) on the regional images from step one. Then these zones are cropped to produce zonal images as the final output of this step. - -Step two of a task can be one of the following three sections: - -- [Barcode Localization](barcode-localization.md) -- [Text-line Localization](textline-localization.md) -- [Document Detection](document-detection.md) (a document refers to an object with a quadrilateral boundary) - -> As mentioned in ["Divide Sections into Stages"](#divide-sections-into-stages), each section is further divided into stages. These three sections in step two starts with the same few stages. Read more on [Shared Detection](shared-detection.md). - -### Step three: producing the final results - -Based on the zonal images, each functional product performs the last operation to obtain the final results. - -Step three of a task can be one of the following three sections: - -- [Barcode Decoding](barcode-decoding.md) -- [Text-line Recognition](textline-recognition.md) -- [Document Normalization](document-normalization.md) - -The following is a simple demonstration of the sections: - -```mermaid -flowchart LR; - A[1.Region Pre-Detection]-->C[2.1.Shared Detection] - C---D[2.2.Barcode Localization] - C---E[2.2.Text-line Localization] - C---F[2.2.Document Detection] - D---G[3.Barcode Decoding] - E---H[3.Text-line Recognition] - F---I[3.Document Normalization] -``` - -## Divide Sections into Stages - -Each of the 7 sections mentioned in ["Divide Tasks into Sections"](#divide-tasks-into-sections) can be further divided into many stages as shown below: - -> Stages shared by "Barcode Localization", "Text-line Localization" and "Document Detection" are put together for the pseudo type "Shared Detection Section". Read more on [Shared Detection](shared-detection.md) - -| Section Type | Stages | -| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Region Pre-detection | IRUT_COLOUR_IMAGE, IRUT_SCALED_DOWN_COLOUR_IMAGE, IRUT_GRAYSCALE_IMAGE,
    IRUT_TRANSFORMED_GRAYSCALE_IMAGE, IRUT_PREDETECTED_REGIONS | -| Shared Detection Section | IRUT_COLOUR_IMAGE, IRUT_SCALED_DOWN_COLOUR_IMAGE, IRUT_GRAYSCALE_IMAGE,
    IRUT_TRANSFORMED_GRAYSCALE_IMAGE, IRUT_ENHANCED_GRAYSCALE_IMAGE, IRUT_BINARY_IMAGE,
    IRUT_TEXTURE_DETECTION_RESULT, IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE, IRUT_TEXTURE_REMOVED_BINARY_IMAGE,
    IRUT_TEXT_ZONES, IRUT_TEXT_REMOVED_BINARY_IMAGE | -| Barcode Localization | IRUT_CONTOURS, IRUT_LINE_SEGMENTS, IRUT_CANDIDATE_BARCODE_ZONES,
    IRUT_LOCALIZED_BARCODES | -| Text-line Localization | IRUT_LOCALIZED_TEXT_LINES | -| Document Detection | IRUT_CONTOURS, IRUT_LINE_SEGMENTS, IRUT_LONG_LINES,
    IRUT_CORNERS, IRUT_CANDIDATE_QUAD_EDGES, IRUT_DETECTED_QUADS | -| Barcode Decoding | IRUT_COLOUR_IMAGE, IRUT_GRAYSCALE_IMAGE, IRUT_TRANSFORMED_GRAYSCALE_IMAGE,
    IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE, IRUT_COMPLEMENTED_BARCODE_IMAGE, IRUT_SCALED_UP_BARCODE_IMAGE,
    IRUT_DECODED_BARCODES | -| Text-line Recognition | IRUT_COLOUR_IMAGE, IRUT_GRAYSCALE_IMAGE, IRUT_TRANSFORMED_GRAYSCALE_IMAGE,
    IRUT_RECOGNIZED_TEXT_LINES | -| Document Normalization | IRUT_NORMALIZED_IMAGES | - -***Table 3: Sections and Stages*** - -In total, there are 27 unique stages which are identified by the types of results they generate: - -- IRUT_COLOUR_IMAGE -- IRUT_SCALED_DOWN_COLOUR_IMAGE -- IRUT_GRAYSCALE_IMAGE -- IRUT_TRANSFORMED_GRAYSCALE_IMAGE -- IRUT_ENHANCED_GRAYSCALE_IMAGE -- IRUT_PREDETECTED_REGIONS -- IRUT_BINARY_IMAGE -- IRUT_TEXTURE_DETECTION_RESULT -- IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE -- IRUT_TEXTURE_REMOVED_BINARY_IMAGE -- IRUT_CONTOURS -- IRUT_LINE_SEGMENTS -- IRUT_TEXT_ZONES -- IRUT_TEXT_REMOVED_BINARY_IMAGE -- IRUT_CANDIDATE_BARCODE_ZONES -- IRUT_LOCALIZED_BARCODES -- IRUT_SCALED_UP_BARCODE_IMAGE -- IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE -- IRUT_COMPLEMENTED_BARCODE_IMAGE -- IRUT_DECODED_BARCODES -- IRUT_LONG_LINES -- IRUT_CORNERS -- IRUT_CANDIDATE_QUAD_EDGES -- IRUT_DETECTED_QUADS -- IRUT_LOCALIZED_TEXT_LINES -- IRUT_RECOGNIZED_TEXT_LINES -- IRUT_NORMALIZED_IMAGES - -These stages are the minimal processing units that can be manipulated and these results are called intermediate results. For successive stages, the result of one stage is usually the source object to be processed by the next stage. A user can register listeners to obtain the results for one or multiple stages. DCV also allows the user to manipulate the algorithmic process by changing the result in between stages. Read more on [Intermediate Result Receiver](../output.md#intermediate-result-receiver) and [Bidirectional Interactivity with Intermediate Results](../index.md#bidirectional-interactivity-with-intermediate-results). - -## Incomplete Task - -As mentioned in **Table 2** above, a task is usually complete, which means it consists of three consecutive sections. However, it is not always the case. - -1. An incomplete task can be a halfway task which means it starts from step two or even step three and consists of only two or even just one section. Read more about [StartSection](../../parameters/reference/shared-parameter/start-section.md). -2. An incomplete task can be a premature task which means it ends early and doesn't produce the final results. Unlike a halfway task which must start at the beginning of a section, a premature task may end at any stage of a section. Read more about [TerminateSetting](../../parameters/reference/shared-parameter/terminate-setting.md). diff --git a/enums/barcode-reader/barcode-format-v2.4.2000.md b/enums/barcode-reader/barcode-format-v2.4.2000.md deleted file mode 100644 index 72fec8a..0000000 --- a/enums/barcode-reader/barcode-format-v2.4.2000.md +++ /dev/null @@ -1,767 +0,0 @@ ---- -layout: default-layout -title: BarcodeFormat - Dynamsoft Barcode Reader Enumerations -description: The enumeration BarcodeFormat of Dynamsoft Barcode Reader defines the supported barcode formats. -keywords: Barcode formats -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: BarcodeFormat -codeAutoHeight: true ---- - -# Enumeration BarcodeFormat - -`BarcodeFormat` defines the supported barcode formats. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - >- C# - >- Python - > -> -```javascript -enum EnumBarcodeFormat { - /** No barcode format specified.*/ - BF_NULL = 0x00, - /** Represents all supported barcode formats. Useful for scanning operations where any type of barcode is acceptable. */ - BF_ALL = 0xFFFFFFFEFFFFFFFF, - /** Default barcode formats that are commonly used. This is a subset of `BF_ALL` tailored for general use. */ - BF_DEFAULT = 0xFE3BFFFF, - /** One-dimensional barcode formats, including BF_CODE_39, BF_CODE_128, BF_CODE_93, BF_CODABAR, BF_ITF, BF_EAN_13, BF_EAN_8, BF_UPC_A, BF_UPC_E, INDUSTRIAL_25, BF_CODE_39_Extended, BF_CODE_11 and BF_MSI_CODE. */ - BF_ONED = 0x3007FF, - /** Code 39 format, widely used in various industries for inventory and manufacturing. */ - BF_CODE_39 = 0x1, - /** Code 128 format, a high-density barcode for alphanumeric or numeric-only data. */ - BF_CODE_128 = 0x2, - /** Code 93 format, similar to Code 39 but more compact and secure with support for the full ASCII character set. */ - BF_CODE_93 = 0x4, - /** Codabar format, used for various numeric barcodes in libraries, blood banks, and parcels. */ - BF_CODABAR = 0x8, - /** Interleaved 2 of 5 format, a numeric-only barcode used in warehousing, distribution, and logistics. */ - BF_ITF = 0x10, - /** EAN-13 format, a superset of the UPC-A barcode used worldwide for marking retail goods. */ - BF_EAN_13 = 0x20, - /** EAN-8 format, a compressed version of EAN-13 for smaller packages. */ - BF_EAN_8 = 0x40, - /** UPC-A format, widely used in the United States and Canada for tracking trade items in stores. */ - BF_UPC_A = 0x80, - /** UPC-E format, a smaller version of the UPC-A barcode used for smaller packages. */ - BF_UPC_E = 0x100, - /** Industrial 2 of 5 format, an older, numeric-only barcode used in the industrial sector. */ - BF_INDUSTRIAL_25 = 0x200, - /** Extended Code 39 format, capable of encoding the full ASCII character set by combining standard Code 39 characters. */ - BF_CODE_39_EXTENDED = 0x400, - /** GS1 DataBar barcode formats, including 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. These barcodes are designed for use in retail and healthcare for fresh foods and small items. */ - BF_GS1_DATABAR = 0x3F800, - BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800, - BF_GS1_DATABAR_TRUNCATED = 0x1000, - BF_GS1_DATABAR_STACKED = 0x2000, - BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000, - BF_GS1_DATABAR_EXPANDED = 0x8000, - BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000, - BF_GS1_DATABAR_LIMITED = 0x20000, - /** Patch code, a special barcode used for document scanning applications to separate batches of documents. */ - BF_PATCHCODE = 0x40000, - /** Micro PDF417, a compact version of PDF417 used for applications where space is limited. */ - BF_MICRO_PDF417 = 0x80000, - /** MSI Code, a barcode used in inventory and warehouse to encode information in the distribution of goods. */ - BF_MSI_CODE = 0x100000, - /** Code 11, used primarily for labeling telecommunications equipment. */ - BF_CODE_11 = 0x200000, - /** Two-Digit Add-On, an extension to UPC and EAN codes for magazines and books. */ - BF_TWO_DIGIT_ADD_ON = 0x400000, - /** Five-Digit Add-On, used with UPC and EAN codes for additional data, such as suggested retail price. */ - BF_FIVE_DIGIT_ADD_ON = 0x800000, - /** Code 32, also known as Italian PharmaCode, used specifically in the Italian pharmaceutical industry. */ - BF_CODE_32 = 0x1000000, - /** PDF417, a two-dimensional barcode used in a variety of applications, capable of encoding large amounts of data. */ - BF_PDF417 = 0x2000000, - /** QR Code, a widely used two-dimensional barcode with high data capacity and error correction capability. */ - BF_QR_CODE = 0x4000000, - /** DataMatrix, a two-dimensional barcode used for marking small items, providing high data density and reliability. */ - BF_DATAMATRIX = 0x8000000, - /** Aztec, a two-dimensional barcode known for its compact size and suitability for encoding small amounts of data efficiently. */ - BF_AZTEC = 0x10000000, - /** MaxiCode, a two-dimensional barcode used primarily for parcel and package tracking in logistics and postal services. */ - BF_MAXICODE = 0x20000000, - /** Micro QR, a smaller version of the QR Code designed for applications where space is limited. */ - BF_MICRO_QR = 0x40000000, - /** GS1 Composite, a group of barcodes used in conjunction with GS1 DataBar or linear barcodes to provide additional information. */ - BF_GS1_COMPOSITE = 0x80000000, - /** Nonstandard barcode, a placeholder for barcodes that do not conform to established industry standards. */ - BF_NONSTANDARD_BARCODE = 0x100000000, - /** DotCode, a two-dimensional barcode designed for high-speed printing applications. */ - BF_DOTCODE = 0x200000000, - /** PharmaCode, a general category that includes both BF_PHARMACODE_ONE_TRACK and BF_PHARMACODE_TWO_TRACK. */ - BF_PHARMACODE = 0xC00000000, - /** PharmaCode One Track, used in the pharmaceutical industry for packaging control. */ - BF_PHARMACODE_ONE_TRACK = 0x400000000, - /** PharmaCode Two Track, an extension of PharmaCode for encoding additional data. */ - BF_PHARMACODE_TWO_TRACK = 0x800000000, - /** Matrix 2 of 5, an older form of barcode used in warehouse sorting and conveyor systems. */ - BF_MATRIX_25 = 0x1000000000, - /** Postal code barcodes, including various formats (BF_USPSINTELLIGENTMAIL, BF_POSTNET, BF_PLANET, BF_AUSTRALIANPOST, BF_RM4SCC and BF_KIX) used by postal services worldwide for efficient mail sorting and delivery. */ - BF_POSTALCODE = 0x3F0000000000000, - /** USPS Intelligent Mail, a barcode used by the United States Postal Service to provide greater information and tracking capabilities. */ - BF_USPSINTELLIGENTMAIL = 0x10000000000000, - /** Postnet, used by the USPS for automating the sorting of mail. */ - BF_POSTNET = 0x20000000000000, - /** Planet, another USPS barcode, similar to Postnet, but with additional data capacity. */ - BF_PLANET = 0x40000000000000, - /** Australian Post, barcodes used by the Australian postal service for mail sorting. */ - BF_AUSTRALIANPOST = 0x80000000000000, - /** RM4SCC (Royal Mail 4 State Customer Code), used by the UK's Royal Mail for automated mail sorting. */ - BF_RM4SCC = 0x100000000000000, - /** KIX (Klant index - Customer index), used by the Dutch postal service for sorting mail. */ - BF_KIX = 0x200000000000000 -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumBarcodeFormat { - /**All supported formats in BarcodeFormat.*/ - public static final long BF_ALL = 0xFFFFFFFEFFFFFFFF; - /**The default settings.*/ - public static final long BF_DEFAULT = 0xFE3BFFFFL; - /**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.*/ - public static final long BF_ONED = 0x3007FFL; - /**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*/ - public static final long BF_GS1_DATABAR = 0x3F800L; - /**Disable all barcode format.*/ - public static final long BF_NULL = 0L; - /**Code 39.*/ - public static final long BF_CODE_39 = 1L << 0; - /**Code 128.*/ - public static final long BF_CODE_128 = 1L << 1; - /**Code 93.*/ - public static final long BF_CODE_93 = 1L << 2; - /**Codabar.*/ - public static final long BF_CODABAR = 1L << 3; - /**Interleaved 2 of 5.*/ - public static final long BF_ITF = 1L << 4; - /**EAN 13.*/ - public static final long BF_EAN_13 = 1L << 5; - /**EAN_8 barcode.*/ - public static final long BF_EAN_8 = 1L << 6; - /**UPC_A barcode.*/ - public static final long BF_UPC_A = 1L << 7; - /**UPC_E barcode.*/ - public static final long BF_UPC_E = 1L << 8; - /**Industrial 25 barcode*/ - public static final long BF_INDUSTRIAL_25 = 1L << 9; - /**Code 39 Extended.*/ - public static final long BF_CODE_39_EXTENDED = 1L << 10; - /**GS1 Databar - Omnidirectional.*/ - public static final long BF_GS1_DATABAR_OMNIDIRECTIONAL = 1L << 11; - /**GS1 Databar - Truncated.*/ - public static final long BF_GS1_DATABAR_TRUNCATED = 1L << 12; - /**GS1 Databar - Stacked.*/ - public static final long BF_GS1_DATABAR_STACKED = 1L << 13; - /**GS1 Databar - Stacked omnidirectional.*/ - public static final long BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 1L << 14; - /**GS1 Databar - Expanded.*/ - public static final long BF_GS1_DATABAR_EXPANDED = 1L << 15; - /**GS1 Databar - Expanded stacked.*/ - public static final long BF_GS1_DATABAR_EXPANDED_STACKED = 1L << 16; - /**GS1 Databar - Limited.*/ - public static final long BF_GS1_DATABAR_LIMITED = 1L << 17; - /**Patch code.*/ - public static final long BF_PATCHCODE = 1L << 18; - /**Micro PDF417 barcode.*/ - public static final long BF_MICRO_PDF417 = 1L << 19; - /**MSI code.*/ - public static final long BF_MSI_CODE = 1L << 20; - /**Code 11.*/ - public static final long BF_CODE_11 = 1L << 21; - /**Decode barcode with 2 digital addons.*/ - public static final long BF_TWO_DIGIT_ADD_ON = 1L << 22, - /**Decode barcode with 5 digital addons.*/ - public static final long BF_FIVE_DIGIT_ADD_ON = 1L << 23, - /**Code 32*/ - public static final long BF_CODE_32 = 1L << 24; - /**PDF417 barcode.*/ - public static final long BF_PDF417 = 1L << 25; - /**QR code.*/ - public static final long BF_QR_CODE = 1L << 26; - /**Data matrix.*/ - public static final long BF_DATAMATRIX = 1L << 27; - /**AZTEC barcode.*/ - public static final long BF_AZTEC = 1L << 28; - /**Maxicode.*/ - public static final long BF_MAXICODE = 1L << 29; - /**Micro QR Code.*/ - public static final long BF_MICRO_QR = 1L << 30; - /**GS1 Composite Code.*/ - public static final long BF_GS1_COMPOSITE = 1L << 31; - /**Nonstandard barcode.*/ - public static final long BF_NONSTANDARD_BARCODE = 1L << 32; - /**Dotcode.*/ - public static final long BF_DOTCODE = 1L << 33; - /**Pharma code.*/ - public static final long BF_PHARMACODE = 0xC00000000L; - /**Pharma code with one track.*/ - public static final long BF_PHARMACODE_ONE_TRACK = 1L << 34; - /**Pharma code with two track.*/ - public static final long BF_PHARMACODE_TWO_TRACK = 1L << 35; - /**Matrix25.*/ - public static final long BF_MATRIX_25 = 1L << 36; - /**Postal code*/ - public static final long BF_POSTALCODE = 0x1F0000000000000L; - /**USPS Intelligent Mail barcode.*/ - public static final long BF_USPSINTELLIGENTMAIL = 1L << 52; - /**Postnet barcode.*/ - public static final long BF_POSTNET = 1L << 53; - /**Planet barcode.*/ - public static final long BF_PLANET = 1L << 54; - /**Australian post barcode.*/ - public static final long BF_AUSTRALIANPOST = 1L << 55; - /**Royal Mail 4-State Customer barcode.*/ - public static final long BF_RM4SCC = 1L << 56; - /**Kix.*/ - public static final long BF_KIX = 1L << 57; -} -``` -> -```objc -typedef NS_OPTIONS(NSUInteger , DSBarcodeFormat) -{ - /**No barcode format in BarcodeFormat*/ - DSBarcodeFormatNull = 0, - /**All supported formats in BarcodeFormat .*/ - DSBarcodeFormatAll = 0xFFFFFFFEFFFFFFFF, - DSBarcodeFormatDefault = 0xFE3BFFFF, - /**Code 39*/ - DSBarcodeFormatCode39 = 1, - /**Code 128*/ - DSBarcodeFormatCode128 = 1 << 1, - /**Code 93*/ - DSBarcodeFormatCode93 = 1 << 2, - /**Codabar*/ - DSBarcodeFormatCodabar = 1 << 3, - /**Interleaved 2 of 5*/ - DSBarcodeFormatITF = 1 << 4, - /**EAN-13*/ - DSBarcodeFormatEAN13 = 1 << 5, - /**EAN-8*/ - DSBarcodeFormatEAN8 = 1 << 6, - /**UPC-A*/ - DSBarcodeFormatUPCA = 1 << 7, - /**UPC-E*/ - DSBarcodeFormatUPCE = 1 << 8, - /**Industrial 2 of 5*/ - DSBarcodeFormatIndustrial25 = 1 << 9, - /**CODE39 Extended*/ - DSBarcodeFormatCode39Extended = 1 << 10, - /**DataBar Omnidirectional*/ - DSBarcodeFormatGS1DatabarOmniDirectional = 1 << 11, - /**DataBar Truncated*/ - DSBarcodeFormatGS1DatabarTruncated = 1 << 12, - /**DataBar Stacked*/ - DSBarcodeFormatGS1DatabarStacked = 1 << 13, - /**DataBar Stacked Omnidirectional*/ - DSBarcodeFormatGS1DatabarStackedOmniDirectional = 1 << 14, - /**DataBar Expanded*/ - DSBarcodeFormatGS1DatabarExpanded = 1 << 15, - /**DataBar Expaned Stacked*/ - DSBarcodeFormatGS1DatabarExpandedStacked = 1 << 16, - /**DataBar Limited*/ - DSBarcodeFormatGS1DatabarLimited = 1 << 17, - /**Patch code.*/ - DSBarcodeFormatPatchCode = 1 << 18, - /**Micro PDF417*/ - DSBarcodeFormatMicroPDF417 = 1 << 19, - /**MSI Code*/ - DSBarcodeFormatMSICode = 1 << 20, - /**CODE_11 .*/ - DSBarcodeFormatCode11 = 1 << 21, - /**Decode barcode with 2 digital addons.*/ - DSBarcodeFormatTwoDigitAddOn = 1 << 22, - /**Decode barcode with 5 digital addons.*/ - DSBarcodeFormatFiveDigitAddOn = 1 << 23, - /**Code 32*/ - DSBarcodeFormatCode32 = 1L << 24, - /**PDF417*/ - DSBarcodeFormatPDF417 = 1 << 25, - /**QRCode*/ - DSBarcodeFormatQRCode = 1 << 26, - /**DataMatrix*/ - DSBarcodeFormatDataMatrix = 1 << 27, - /**AZTEC*/ - DSBarcodeFormatAztec = 1 << 28, - /**MAXICODE*/ - DSBarcodeFormatMaxiCode = 1 << 29, - /**Micro QR Code*/ - DSBarcodeFormatMicroQR = 1 << 30, - /**GS1 Composite Code*/ - DSBarcodeFormatGS1Composite = 1 << 31, - /**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*/ - DSBarcodeFormatOneD = 0x3007FF, - /**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*/ - DSBarcodeFormatGS1Databar = 0x3F800, - DSBarcodeFormatNonStandardBarcode = 1 << 32, - /**DotCode Barcode. - When you set this barcode format, the library will automatically add DSLocalizationModeStatisticsMarks to LocalizationMode if you don't set it,*/ - DSBarcodeFormatDotCode = 1 << 33, - /**PHARMACODE_ONE_TRACK*/ - DSBarcodeFormatPharmaCodeOneTrack = 1 << 34, - /**PHARMACODE_ONE_TRACK*/ - DSBarcodeFormatPharmaCodeTwoTrack = 1 << 35, - /**Matrix25.*/ - DSBarcodeFormatMatrix25 = 1L << 36, - /**PHARMACODE*/ - DSBarcodeFormatPharmaCode = 0xC00000000, - /**Combined value of DSBarcodeFormatUSPSINTELLIGENTMAIL, DSBarcodeFormatPOSTNET, DSBarcodeFormatPLANET, DSBarcodeFormatAUSTRALIANPOST, DSBarcodeFormatRM4SCC. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - DSBarcodeFormatPostalCode = 0x1F0000000000000, - /**USPS Intelligent Mail. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - DSBarcodeFormatUSPSIntelligentMail = 1 << 52, - /**Postnet. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - DSBarcodeFormatPostnet = 1 << 53, - /**Planet. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - DSBarcodeFormatPlant = 1 << 54, - /**Australian Post. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - DSBarcodeFormatAustralianPost = 1 << 55, - /**Royal Mail 4-State Customer Barcode. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - DSBarcodeFormatRM4SCC = 1 << 56, - /**Kix*/ - DSBarcodeFormatKix = 1L << 57 -}; -``` -> -```swift -public enum BarcodeFormat : Int -{ - /**No barcode format in BarcodeFormat*/ - Null = 0 - /**All supported formats in BarcodeFormat .*/ - all = 0xFFFFFFFEFFFFFFFF - default = 0xFE3BFFFF - /**Code 39*/ - code39 = 1 - /**Code 128*/ - code128 = 1 << 1 - /**Code 93*/ - code93 = 1 << 2 - /**Codabar*/ - codabar = 1 << 3 - /**Interleaved 2 of 5*/ - ITF = 1 << 4 - /**EAN-13*/ - EAN13 = 1 << 5 - /**EAN-8*/ - EAN8 = 1 << 6 - /**UPC-A*/ - UPCA = 1 << 7 - /**UPC-E*/ - UPCE = 1 << 8 - /**Industrial 2 of 5*/ - industrial25 = 1 << 9 - /**CODE39 Extended*/ - code39Extended = 1 << 10 - /**DataBar Omnidirectional*/ - gs1DatabarOmnidirectional = 1 << 11 - /**DataBar Truncated*/ - gs1DatabarTruncated = 1 << 12 - /**DataBar Stacked*/ - gs1DatabarStacked = 1 << 13 - /**DataBar Stacked Omnidirectional*/ - gs1DatabarStackedOmnidirectional = 1 << 14 - /**DataBar Expanded*/ - gs1DatabarExpanded = 1 << 15 - /**DataBar Expaned Stacked*/ - gs1DatabarExpandedStacked = 1 << 16 - /**DataBar Limited*/ - gs1DatabarLimited = 1 << 17 - /**Patch code.*/ - patchCode = 1 << 18 - /**Micro PDF417*/ - microPDF417 = 1 << 19 - /**MSI Code*/ - msiCode = 1 << 20 - /**CODE_11.*/ - code11 = 1 << 21 - /**Decode barcode with 2 digital addons.*/ - twoDigitAddOn = 1 << 22 - /**Decode barcode with 5 digital addons.*/ - fiveDigitAddOn = 1 << 23 - /**Code 32*/ - code32 = 1L << 24 - /**PDF417*/ - PDF417 = 1 << 25 - /**QRCode*/ - qrCode = 1 << 26 - /**DataMatrix*/ - dataMatrix = 1 << 27 - /**AZTEC*/ - aztec = 1 << 28 - /**MAXICODE*/ - maxiCode = 1 << 29 - /**Micro QR Code*/ - microQR = 1 << 30 - /**GS1 Composite Code*/ - gs1Composite = 1 << 31 - /**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*/ - oneD = 0x3007FF - /**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*/ - gs1Databar = 0x3F800, - nonStandardBarcode = 1 << 32 - /**DotCode Barcode. - When you set this barcode format, the library will automatically add DSLocalizationModeStatisticsMarks to LocalizationMode if you don't set it,*/ - dotCode = 1 << 33 - /**PHARMACODE_ONE_TRACK*/ - pharmaCodeOneTrack = 1 << 34 - /**PHARMACODE_ONE_TRACK*/ - pharmaCodeTwoTrack = 1 << 35 - /**Matrix25.*/ - matrix25 = 1L << 36 - /**PHARMACODE*/ - pharmaCode = 0xC00000000 - /**Combined value of DSBarcodeFormatUSPSINTELLIGENTMAIL, DSBarcodeFormatPOSTNET, DSBarcodeFormatPLANET, DSBarcodeFormatAUSTRALIANPOST, DSBarcodeFormatRM4SCC. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - postalCode = 0x1F0000000000000, - /**USPS Intelligent Mail. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - uspsIntelligentMail = 1 << 52 - /**Postnet. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - postnet = 1 << 53 - /**Planet. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - planet = 1 << 54 - /**Australian Post. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - australianPost = 1 << 55 - /**Royal Mail 4-State Customer Barcode. - When you set this barcode format, the library will automatically add LocalizationModeStatisticsPostalCode to LocalizationMode if you don't set it,*/ - RM4SCC = 1 << 56, - /**Kix*/ - kix = 1L << 57 -} -``` -> -```cpp -enum BarcodeFormat : unsigned long long -{ - /**No barcode format in BarcodeFormat.*/ - BF_NULL = 0x00, - /**All supported formats in BarcodeFormat.*/ - BF_ALL = 0xFFFFFFFEFFFFFFFF, - /**Use the default barcode format settings.*/ - BF_DEFAULT = 0xFE3BFFFF, - /**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_ONED = 0x003007FF, - /**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_GS1_DATABAR = 0x0003F800, - /**Code 39*/ - BF_CODE_39 = 0x1, - /**Code 128*/ - BF_CODE_128 = 0x2, - /**Code 93*/ - BF_CODE_93 = 0x4, - /**Codabar*/ - BF_CODABAR = 0x8, - /**Interleaved 2 of 5*/ - BF_ITF = 0x10, - /**EAN-13*/ - BF_EAN_13 = 0x20, - /**EAN-8*/ - BF_EAN_8 = 0x40, - /**UPC-A*/ - BF_UPC_A = 0x80, - /**UPC-E*/ - BF_UPC_E = 0x100, - /**Industrial 2 of 5*/ - BF_INDUSTRIAL_25 = 0x200, - /**CODE39 Extended*/ - BF_CODE_39_EXTENDED = 0x400, - /**GS1 Databar Omnidirectional*/ - BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800, - /**GS1 Databar Truncated*/ - BF_GS1_DATABAR_TRUNCATED = 0x1000, - /**GS1 Databar Stacked*/ - BF_GS1_DATABAR_STACKED = 0x2000, - /**GS1 Databar Stacked Omnidirectional*/ - BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000, - /**GS1 Databar Expanded*/ - BF_GS1_DATABAR_EXPANDED = 0x8000, - /**GS1 Databar Expaned Stacked*/ - BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000, - /**GS1 Databar Limited*/ - BF_GS1_DATABAR_LIMITED = 0x20000, - /**Patch code.*/ - BF_PATCHCODE = 0x00040000, - /**Code 32*/ - BF_CODE_32 = 0x1000000, - /**PDF417*/ - BF_PDF417 = 0x02000000, - /**QRCode*/ - BF_QR_CODE = 0x04000000, - /**DataMatrix*/ - BF_DATAMATRIX = 0x08000000, - /**AZTEC*/ - BF_AZTEC = 0x10000000, - /**MAXICODE*/ - BF_MAXICODE = 0x20000000, - /**Micro QR Code*/ - BF_MICRO_QR = 0x40000000, - /**Micro PDF417*/ - BF_MICRO_PDF417 = 0x00080000, - /**GS1 Composite Code*/ - BF_GS1_COMPOSITE = 0x80000000, - /**MSI Code*/ - BF_MSI_CODE = 0x100000, - /**Code 11*/ - BF_CODE_11 = 0x200000, - /**Decode barcode with 2 digital addons.*/ - BF_TWO_DIGIT_ADD_ON = 0x400000, - /**Decode barcode with 5 digital addons.*/ - BF_FIVE_DIGIT_ADD_ON = 0x800000, - /**Matrix 25*/ - BF_MATRIX_25 = 0x1000000000, - /**Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC.*/ - BF_POSTALCODE = 0x3F0000000000000, - /**Nonstandard barcode*/ - BF_NONSTANDARD_BARCODE = 0x100000000, - /**USPS Intelligent Mail.*/ - BF_USPSINTELLIGENTMAIL = 0x10000000000000, - /**Postnet.*/ - BF_POSTNET = 0x20000000000000, - /**Planet.*/ - BF_PLANET = 0x40000000000000, - /**Australian Post.*/ - BF_AUSTRALIANPOST = 0x80000000000000, - /**Royal Mail 4-State Customer Barcode.*/ - BF_RM4SCC = 0x100000000000000, - /**KIX.*/ - BF_KIX = 0x200000000000000, - /**DotCode.*/ - BF_DOTCODE = 0x200000000, - /**_PHARMACODE_ONE_TRACK.*/ - BF_PHARMACODE_ONE_TRACK = 0x400000000, - /**PHARMACODE_TWO_TRACK.*/ - BF_PHARMACODE_TWO_TRACK = 0x800000000, - /**PHARMACODE.*/ - BF_PHARMACODE = 0xC00000000 -}; -``` -> -```csharp - public enum EnumBarcodeFormat : ulong - { - /**No barcode format in BarcodeFormat*/ - BF_NULL = 0x00, - /**All supported formats in BarcodeFormat*/ - BF_ALL = 0xFFFFFFFEFFFFFFFF, - /**Use the default barcode format settings*/ - BF_DEFAULT = 0xFE3BFFFF, - /**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_ONED = 0x003007FF, - /**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_GS1_DATABAR = 0x0003F800, - /**Code 39 */ - BF_CODE_39 = 0x1, - /**Code 128 */ - BF_CODE_128 = 0x2, - /**Code 93 */ - BF_CODE_93 = 0x4, - /**Codabar */ - BF_CODABAR = 0x8, - /**Interleaved 2 of 5 */ - BF_ITF = 0x10, - /**EAN-13 */ - BF_EAN_13 = 0x20, - /**EAN-8 */ - BF_EAN_8 = 0x40, - /**UPC-A */ - BF_UPC_A = 0x80, - /**UPC-E */ - BF_UPC_E = 0x100, - /**Industrial 2 of 5 */ - BF_INDUSTRIAL_25 = 0x200, - /**CODE39 Extended */ - BF_CODE_39_EXTENDED = 0x400, - /**GS1 Databar Omnidirectional*/ - BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800, - /**GS1 Databar Truncated*/ - BF_GS1_DATABAR_TRUNCATED = 0x1000, - /**GS1 Databar Stacked*/ - BF_GS1_DATABAR_STACKED = 0x2000, - /**GS1 Databar Stacked Omnidirectional*/ - BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000, - /**GS1 Databar Expanded*/ - BF_GS1_DATABAR_EXPANDED = 0x8000, - /**GS1 Databar Expaned Stacked*/ - BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000, - /**GS1 Databar Limited*/ - BF_GS1_DATABAR_LIMITED = 0x20000, - /**Patch code*/ - BF_PATCHCODE = 0x00040000, - /**Code 32*/ - BF_CODE_32 = 0x1000000, - /**PDF417 */ - BF_PDF417 = 0x02000000, - /**QRCode */ - BF_QR_CODE = 0x04000000, - /**DataMatrix */ - BF_DATAMATRIX = 0x08000000, - /**AZTEC */ - BF_AZTEC = 0x10000000, - /**MAXICODE */ - BF_MAXICODE = 0x20000000, - /**Micro QR Code*/ - BF_MICRO_QR = 0x40000000, - /**Micro PDF417*/ - BF_MICRO_PDF417 = 0x00080000, - /**GS1 Composite Code*/ - BF_GS1_COMPOSITE = 0x80000000, - /**MSI Code*/ - BF_MSI_CODE = 0x100000, - /*Code 11*/ - BF_CODE_11 = 0x200000, - /*Decode barcode with 2 digital addons*/ - BF_TWO_DIGIT_ADD_ON = 0x400000, - /*Decode barcode with 5 digital addons*/ - BF_FIVE_DIGIT_ADD_ON = 0x800000, - /*Matrix 25*/ - BF_MATRIX_25 = 0x1000000000, - /**Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC.*/ - BF_POSTALCODE = 0x3F0000000000000, - /**Nonstandard barcode */ - BF_NONSTANDARD_BARCODE = 0x100000000, - /**USPS Intelligent Mail.*/ - BF_USPSINTELLIGENTMAIL = 0x10000000000000, - /**Postnet.*/ - BF_POSTNET = 0x20000000000000, - /**Planet.*/ - BF_PLANET = 0x40000000000000, - /**Australian Post.*/ - BF_AUSTRALIANPOST = 0x80000000000000, - /**Royal Mail 4-State Customer Barcode.*/ - BF_RM4SCC = 0x100000000000000, - /**KIX.*/ - BF_KIX = 0x200000000000000, - /**DotCode.*/ - BF_DOTCODE = 0x200000000, - /**_PHARMACODE_ONE_TRACK.*/ - BF_PHARMACODE_ONE_TRACK = 0x400000000, - /**PHARMACODE_TWO_TRACK.*/ - BF_PHARMACODE_TWO_TRACK = 0x800000000, - /**PHARMACODE.*/ - BF_PHARMACODE = 0xC00000000 - } -``` -> -```python -class EnumBarcodeFormat(Enum): - #No barcode format in BarcodeFormat - BF_NULL = 0x00 - #All supported formats in BarcodeFormat - BF_ALL = 0xFFFFFFFEFFFFFFFF - #Use the default barcode format settings - BF_DEFAULT = 0xFE3BFFFF - #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_ONED = 0x003007FF - #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_GS1_DATABAR = 0x0003F800 - #Code 39 - BF_CODE_39 = 0x1 - #Code 128 - BF_CODE_128 = 0x2 - #Code 93 - BF_CODE_93 = 0x4 - #Codabar - BF_CODABAR = 0x8 - #Interleaved 2 of 5 - BF_ITF = 0x10 - #EAN-13 - BF_EAN_13 = 0x20 - #EAN-8 - BF_EAN_8 = 0x40 - #UPC-A - BF_UPC_A = 0x80 - #UPC-E - BF_UPC_E = 0x100 - #Industrial 2 of 5 - BF_INDUSTRIAL_25 = 0x200 - #CODE39 Extended - BF_CODE_39_EXTENDED = 0x400 - #GS1 Databar Omnidirectional - BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800 - #GS1 Databar Truncated - BF_GS1_DATABAR_TRUNCATED = 0x1000 - #GS1 Databar Stacked - BF_GS1_DATABAR_STACKED = 0x2000 - #GS1 Databar Stacked Omnidirectional - BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000 - #GS1 Databar Expanded - BF_GS1_DATABAR_EXPANDED = 0x8000 - #GS1 Databar Expaned Stacked - BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000 - #GS1 Databar Limited - BF_GS1_DATABAR_LIMITED = 0x20000 - #Patch code - BF_PATCHCODE = 0x00040000 - #Code 32 - BF_CODE_32 = 0x1000000 - #PDF417 - BF_PDF417 = 0x02000000 - #QRCode - BF_QR_CODE = 0x04000000 - #DataMatrix - BF_DATAMATRIX = 0x08000000 - #AZTEC - BF_AZTEC = 0x10000000 - #MAXICODE - BF_MAXICODE = 0x20000000 - #Micro QR Code - BF_MICRO_QR = 0x40000000 - #Micro PDF417 - BF_MICRO_PDF417 = 0x00080000 - #GS1 Composite Code - BF_GS1_COMPOSITE = 0x80000000 - #MSI Code - BF_MSI_CODE = 0x100000 - #Code 11 - BF_CODE_11 = 0x200000 - #Decode barcode with 2 digital addons - BF_TWO_DIGIT_ADD_ON = 0x400000 - #Decode barcode with 5 digital addons - BF_FIVE_DIGIT_ADD_ON = 0x800000 - #Matrix 25 - BF_MATRIX_25 = 0x1000000000 - #Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC. - BF_POSTALCODE = 0x3F0000000000000 - #Nonstandard barcode - BF_NONSTANDARD_BARCODE = 0x100000000 - #USPS Intelligent Mail. - BF_USPSINTELLIGENTMAIL = 0x10000000000000 - #Postnet. - BF_POSTNET = 0x20000000000000 - #Planet. - BF_PLANET = 0x40000000000000 - #Australian Post. - BF_AUSTRALIANPOST = 0x80000000000000 - #Royal Mail 4-State Customer Barcode. - BF_RM4SCC = 0x100000000000000 - #KIX. - BF_KIX = 0x200000000000000 - #DotCode. - BF_DOTCODE = 0x200000000 - #_PHARMACODE_ONE_TRACK. - BF_PHARMACODE_ONE_TRACK = 0x400000000 - #PHARMACODE_TWO_TRACK. - BF_PHARMACODE_TWO_TRACK = 0x800000000 - #PHARMACODE. - BF_PHARMACODE = 0xC00000000 -``` diff --git a/enums/camera-enhancer/camera-position-v2.2.3000.md b/enums/camera-enhancer/camera-position-v2.2.3000.md deleted file mode 100644 index f9aff1f..0000000 --- a/enums/camera-enhancer/camera-position-v2.2.3000.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default-layout -title: CameraPosition - Dynamsoft Camera Enhancer Enumerations -description: The enumeration CameraPosition of Dynamsoft Camera Enhancer describes the camera position. -keywords: Camera Position -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: CameraPosition ---- - -# CameraPosition - -Enumeration `CameraPosition` describes the camera position. - -
    - >- Android - >- Objective-C - >- Swift - > -> -```java -@IntDef({CP_FRONT,CP_BACK}) -@Retention(RetentionPolicy.CLASS) -public @interface EnumCameraPosition { - // The back-facing camera. - public static final int CP_FRONT= 0; - // The front-facing camera. - public static final int CP_BACK = 1; -} -``` -> -```objc -typedef NS_ENUM(NSInteger, DSCameraPosition) -{ - /** The back-facing camera. */ - DSCameraPositionBack = 0, - /** The front-facing camera. */ - DSCameraPositionBack = 1 -}; -``` -> -```swift -public enum CameraPosition : Int{ - /** The back-facing camera. */ - back = 0 - /** The front-facing camera. */ - front = 1 -} -``` diff --git a/enums/camera-enhancer/drawing-item-media-type-v2.2.3000.md b/enums/camera-enhancer/drawing-item-media-type-v2.2.3000.md deleted file mode 100644 index 29c60cb..0000000 --- a/enums/camera-enhancer/drawing-item-media-type-v2.2.3000.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -layout: default-layout -title: CameraPosition - Dynamsoft Camera Enhancer Enumerations -description: The enumeration CameraPosition of Dynamsoft Camera Enhancer describes the camera position. -keywords: Camera Position -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: CameraPosition ---- - -# CameraPosition - -Enumeration `CameraPosition` describes the camera position. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - > -> -```javascript -enum EnumDrawingItemMediaType { - /**The mediate type of the DrawingItem is rectangle. */ - DIMT_RECTANGLE = 1, - /**The mediate type of the DrawingItem is quadrilateral. */ - DIMT_QUADRILATERAL = 2, - /**The mediate type of the DrawingItem is text. */ - DIMT_TEXT = 4, - /**The mediate type of the DrawingItem is arc. */ - DIMT_ARC = 8, - /**The mediate type of the DrawingItem is image. */ - DIMT_IMAGE = 16, - /**The mediate type of the DrawingItem is polygon. */ - DIMT_POLYGON = 32, - /**The mediate type of the DrawingItem is line. */ - DIMT_LINE = 64, - /**The mediate type of the DrawingItem is a group of shapes. */ - DIMT_GROUP = 128 -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumDrawingItemMediaType { - // The mediate type of the DrawingItem is rectangle. - public static final int DIMT_RECTANGLE = 1; - // The mediate type of the DrawingItem is quadrilateral. - public static final int DIMT_QUADRILATERAL = 2; - // The mediate type of the DrawingItem is text. - public static final int DIMT_TEXT = 4; - // The mediate type of the DrawingItem is line. - public static final int DIMT_LINE = 8; -} -``` -> -```objc -typedef NS_ENUM(NSInteger, DSDrawingItemMediaType) { - /** - * The mediate type of the DrawingItem is rectangle. - */ - DSDrawingItemMediaTypeRectangle = 1, - /** - * The mediate type of the DrawingItem is quadrilateral. - */ - DSDrawingItemMediaTypeQuadrilateral = 2, - /** - * The mediate type of the DrawingItem is text. - */ - DSDrawingItemMediaTypeText = 4, - /** - * The mediate type of the DrawingItem is line. - */ - DSDrawingItemMediaTypeLine = 8 -}; -``` -> -```swift -public enum DrawingItemMediaType : Int{ - /** - * The mediate type of the DrawingItem is rectangle. - */ - rectangle = 1 - /** - * The mediate type of the DrawingItem is quadrilateral. - */ - quadrilateral = 2 - /** - * The mediate type of the DrawingItem is text. - */ - text = 4 - /** - * The mediate type of the DrawingItem is line. - */ - line = 8 -} -``` diff --git a/enums/capture-vision-router/preset-template-v2.4.2000.md b/enums/capture-vision-router/preset-template-v2.4.2000.md deleted file mode 100644 index a40b543..0000000 --- a/enums/capture-vision-router/preset-template-v2.4.2000.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -layout: default-layout -title: PresetTemplate - Dynamsoft Vision Router Enumerations -description: The enumeration PresetTemplate of Dynamsoft Vision Router describes the preset template. -keywords: Capture state -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# Enumeration PresetTemplate - -`PresetTemplate` describes the preset template names. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- Python - > -> -```javascript -enum EnumPresetTemplate { - /** - * @brief Versatile function for barcode reading, document detection, or text recognition. - */ - PT_DEFAULT = "Default", - /** - * @brief Scans a single barcode. - */ - PT_READ_BARCODES = "ReadBarcodes_Default", - /** - * @brief Identifies and reads any text present. - */ - PT_RECOGNIZE_TEXT_LINES = "RecognizeTextLines_Default", - /** - * @brief RIdentifies the edges of a document. - */ - PT_DETECT_DOCUMENT_BOUNDARIES = "DetectDocumentBoundaries_Default", - /** - * @brief Detects document edges and standardizes its format. - */ - PT_DETECT_AND_NORMALIZE_DOCUMENT = "DetectAndNormalizeDocument_Default", - /** - * @brief Adjusts a document to a standard format using detected borders. - */ - PT_NORMALIZE_DOCUMENT = "NormalizeDocument_Default", - /** - * @brief Represents a barcode reading mode where speed is prioritized. - * - * In this mode, the barcode reader will optimize for faster barcode detection - * and decoding, sacrificing some level of accuracy and read rate. It is suitable - * for situations where a quick response time is more important than perfect - * barcode recognition. - */ - PT_READ_BARCODES_SPEED_FIRST = "ReadBarcodes_SpeedFirst", - /** - * @brief Represents a barcode reading mode where barcode read rate is prioritized. - * - * In this mode, the barcode reader will optimize for higher barcode read rates, - * even if it may sometimes result in reduced accuracy and speed. It is suitable for - * scenarios where maximizing the number of successfully read barcodes is critical. - */ - PT_READ_BARCODES_READ_RATE_FIRST = "ReadBarcodes_ReadRateFirst", - /** - * @brief Represents a balanced barcode reading mode. - * - * This mode aims for a reasonable balance between speed and read rate in barcode - * recognition. It is suitable for most common use cases where a compromise between - * speed and read rate is acceptable. - */ - PT_READ_BARCODES_BALANCE = "ReadBarcodes_Balance", - /** - * @brief Represents a barcode reading mode for single barcode code detection. - * - * In this mode, the barcode reader will focus on detecting and decoding a single - * barcode code, ignoring any additional codes in the same image. It is efficient - * when the target image has only one barcode. - */ - PT_READ_SINGLE_BARCODE = "ReadBarcodes_Balanced", - /** - * @brief Represents a barcode reading mode optimized for dense barcode codes. - * - * This mode is designed to handle dense or closely packed barcode codes where - * accuracy is paramount. It may operate slower than other modes but is suitable - * for challenging scenarios where code density is high. - */ - PT_READ_DENSE_BARCODES = "ReadDenseBarcodes", - /** - * @brief Represents a barcode reading mode optimized for distant barcode codes. - * - * This mode is designed to scanning a barcode that is placed far from the device. - */ - PT_READ_DISTANT_BARCODES = "ReadDistantBarcodes", - /** - * @brief Represents a text recognition mode focused on recognizing numbers. - */ - PT_RECOGNIZE_NUMBERS = "RecognizeNumbers", - /** - * @brief Represents a text recognition mode focused on recognizing alphabetic characters (letters). - * - */ - PT_RECOGNIZE_LETTERS = "RecognizeLetters", - /** - * @brief Represents a text recognition mode that combines numbers and alphabetic characters (letters) recognition. - */ - PT_RECOGNIZE_NUMBERS_AND_LETTERS = "RecognizeNumbersAndLetters", - /** - * @brief Represents a text recognition mode that combines numbers and uppercase letters recognition. - */ - PT_RECOGNIZE_NUMBERS_AND_UPPERCASE_LETTERS = "RecognizeNumbersAndUppercaseLetters", - /** - * @brief Represents a text recognition mode focused on recognizing uppercase letters. - */ - PT_RECOGNIZE_UPPERCASE_LETTERS = "RecognizeUppercaseLetters" -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumPresetTemplate -{ - /** Template name: "Default". It implements barcode decoding, label recognizing and document normalizing. */ - String PT_DEFAULT = "Default"; - /** Template name: "ReadBarcodes_Default". */ - String PT_READ_BARCODES = "ReadBarcodes_Default"; - /** Template name: "RecognizeTextLines_Default". */ - String PT_RECOGNIZE_TEXT_LINES = "RecognizeTextLines_Default"; - /** Template name: "DetectDocumentBoundaries_Default". */ - String PT_DETECT_DOCUMENT_BOUNDARIES = "DetectDocumentBoundaries_Default"; - /** Template name: "DetectAndNormalizeDocument_Default". */ - String PT_DETECT_AND_NORMALIZE_DOCUMENT = "DetectAndNormalizeDocument_Default"; - /** Template name: "NormalizeDocument_Default". */ - String PT_NORMALIZE_DOCUMENT = "NormalizeDocument_Default"; - /** Template name: "ReadBarcodes_SpeedFirst". */ - String PT_READ_BARCODES_SPEED_FIRST = "ReadBarcodes_SpeedFirst"; - /** Template name: "ReadBarcodes_ReadRateFirst". */ - String PT_READ_BARCODES_READ_RATE_FIRST = "ReadBarcodes_ReadRateFirst"; - /** Template name: "ReadSingleBarcode". */ - String PT_READ_SINGLE_BARCODE = "ReadSingleBarcode"; - /** Template name: "RecognizeNumbers". */ - String PT_RECOGNIZE_NUMBERS = "RecognizeNumbers"; - /** Template name: "RecognizeLetters". */ - String PT_RECOGNIZE_LETTERS = "RecognizeLetters"; - /** Template name: "RecognizeNumbersAndLetters". */ - String PT_RECOGNIZE_NUMBERS_AND_LETTERS = "RecognizeNumbersAndLetters"; - /** Template name: "RecognizeNumbersAndUppercaseLetters". */ - String PT_RECOGNIZE_NUMBERS_AND_UPPERCASE_LETTERS = "RecognizeNumbersAndUppercaseLetters"; - /** Template name: "RecognizeUppercaseLetters". */ - String PT_RECOGNIZE_UPPERCASE_LETTERS = "RecognizeUppercaseLetters"; -} -``` -> -```objc -/** DSPresetTemplate defines the enumerations that indicates the preset capture vision templates.*/ -typedef NSString * DSPresetTemplate NS_STRING_ENUM NS_SWIFT_NAME(PresetTemplate); -/** The default template that performs barcode decoding, label recognizing, boundary detecting and document normalizing. The template name is "Default".*/ -FOUNDATION_EXPORT DSPresetTemplate const _Nonnull DSPresetTemplateDefault NS_SWIFT_NAME(presetDefault); -/** The template that enables barcode decoding only. The template name is "ReadBarcodes_Default".*/ -FOUNDATION_EXPORT DSPresetTemplate const _Nonnull DSPresetTemplateReadBarcodes NS_SWIFT_NAME(readBarcodes); -/** The template that enables label recognizing only. The template name is "RecognizeTextLines_Default".*/ -FOUNDATION_EXPORT DSPresetTemplate const _Nonnull DSPresetTemplateRecognizeTextLines NS_SWIFT_NAME(recognizeTextLines); -/** The template that enables boundary detecting only. The template name is "DetectDocumentBoundaries_Default".*/ -FOUNDATION_EXPORT DSPresetTemplate const _Nonnull DSPresetTemplateDetectDocumentBoundaries NS_SWIFT_NAME(detectDocumentBoundaries); -/** The template that enables both boundary detecting and document normalizing. The template name is "DetectAndNormalizeDocument_Default".*/ -FOUNDATION_EXPORT DSPresetTemplate const _Nonnull DSPresetTemplateDetectAndNormalizeDocument NS_SWIFT_NAME(detectAndNormalizeDocument); -/** The template that enables document normalizing only. The template name is "NormalizeDocument_Default".*/ -FOUNDATION_EXPORT DSPresetTemplate const _Nonnull DSPresetTemplateNormalizeDocument NS_SWIFT_NAME(normalizeDocument); -/** The template that enables barcode decoding and the speed performance is prioritized. The template name is "ReadBarcodes_SpeedFirst".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateReadBarcodesSpeedFirst NS_SWIFT_NAME(readBarcodesSpeedFirst); -/** The template that enables barcode decoding and the read rate performance is prioritized. The template name is "ReadBarcodes_ReadRateFirst".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateReadBarcodesReadRateFirst NS_SWIFT_NAME(readBarcodesReadRateFirst); -/** This template is specially configured for single barcode decoding. The template name is "ReadSingleBarcode".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateReadSingleBarcode NS_SWIFT_NAME(readSingleBarcode); -/** This template is specially configured for recognizing numbers from the text lines. The template name is "RecognizeNumbers".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateRecognizeNumbers NS_SWIFT_NAME(recognizeNumbers); -/** This template is specially configured for recognizing letters from the text lines. The template name is "RecognizeLetters".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateRecognizeLetters NS_SWIFT_NAME(recognizeLetters); -/** This template is specially configured for recognizing number and letters from the text lines. The template name is "RecognizeNumbersAndLetters".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateRecognizeNumbersAndLetters NS_SWIFT_NAME(recognizeNumbersAndLetters); -/** This template is specially configured for recognizing number and upper case letters from the text lines. The template name is "RecognizeNumbersAndUppercaseLetters".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateRecognizeNumbersAndUppercaseLetters NS_SWIFT_NAME(recognizeNumbersAndUppercaseLetters); -/** This template is specially configured for recognizing upper case letters from the text lines. The template name is "RecognizeUppercaseLetters".*/ -FOUNDATION_EXPORT PresetTemplate const _Nonnull DSPresetTemplateRecognizeUppercaseLetters NS_SWIFT_NAME(recognizeUppercaseLetters); -``` -> -```swift -struct PresetTemplate -{ - /** The default template that performs barcode decoding, label recognizing, boundary detecting and document normalizing. The template name is "Default".*/ - static let default = "default" - /** The template that enables barcode decoding only. The template name is "ReadBarcodes_Default".*/ - static let readBarcodes = "read-barcodes" - /** The template that enables label recognizing only. The template name is "RecognizeTextLines_Default".*/ - static let recognizeTextLines = "recognize-textLines" - /** The template that enables boundary detecting only. The template name is "DetectDocumentBoundaries_Default".*/ - static let detectDocumentBoundaries = "detect-document-boundaries" - /** The template that enables both boundary detecting and document normalizing. The template name is "DetectAndNormalizeDocument_Default".*/ - static let detectAndNormalizeDocument = "DetectAndNormalizeDocument_Default" - /** The template that enables document normalizing only. The template name is "NormalizeDocument_Default".*/ - static let normalizeDocument = "NormalizeDocument_Default" - /** The template that enables barcode decoding and the speed performance is prioritized. The template name is "ReadBarcodes_SpeedFirst".*/ - static let readBarcodesSpeedFirst = "ReadBarcodes_SpeedFirst" - /** The template that enables barcode decoding and the read rate performance is prioritized. The template name is "ReadBarcodes_ReadRateFirst".*/ - static let readBarcodesReadRateFirst = "ReadBarcodes_ReadRateFirst" - /** This template is specially configured for single barcode decoding. The template name is "ReadSingleBarcode".*/ - static let readSingleBarcode = "ReadSingleBarcode" - /** This template is specially configured for recognizing numbers from the text lines. The template name is "RecognizeNumbers".*/ - static let recognizeNumbers = "RecognizeNumbers" - /** This template is specially configured for recognizing letters from the text lines. The template name is "RecognizeLetters".*/ - static let recognizeLetters = "RecognizeLetters" - /** This template is specially configured for recognizing number and letters from the text lines. The template name is "RecognizeNumbersAndLetters".*/ - static let recognizeNumbersAndLetters = "RecognizeNumbersAndLetters" - /** This template is specially configured for recognizing number and upper case letters from the text lines. The template name is "RecognizeNumbersAndUppercaseLetters".*/ - static let recognizeNumbersAndUppercaseLetters = "RecognizeNumbersAndUppercaseLetters" - /** This template is specially configured for recognizing upper case letters from the text lines. The template name is "RecognizeUppercaseLetters".*/ - static let recognizeUppercaseLetters = "RecognizeUppercaseLetters" -} -``` -> -```python -class EnumPresetTemplate(Enum): - # Template name: "Default". It supports barcode decoding, label recognizing and document normalizing. - PT_DEFAULT = "Default" - # Template name: "ReadBarcodes_Default". It only supports barcode decoding. - PT_READ_BARCODES = "ReadBarcodes_Default" - # Template name: "RecognizeTextLines_Default". It only supports label recognition. - PT_RECOGNIZE_TEXT_LINES = "RecognizeTextLines_Default" - # Template name: "DetectDocumentBoundaries_Default". It only supports detecting document boundaries. - PT_DETECT_DOCUMENT_BOUNDARIES = "DetectDocumentBoundaries_Default" - # Template name: "DetectAndNormalizeDocument_Default". It supports detecting document boundaries and normalizing documents. - PT_DETECT_AND_NORMALIZE_DOCUMENT = "DetectAndNormalizeDocument_Default" - # Template name: "NormalizeDocument_Default". It only supports normalizing documents. - PT_NORMALIZE_DOCUMENT = "NormalizeDocument_Default" - # Template name: "ReadBarcodes_SpeedFirst". Represents a barcode reading mode where speed is prioritized. - PT_READ_BARCODES_SPEED_FIRST = "ReadBarcodes_SpeedFirst" - # Template name: "ReadBarcodes_ReadRateFirst". Represents a barcode reading mode where barcode read rate is prioritized. - PT_READ_BARCODES_READ_RATE_FIRST = "ReadBarcodes_ReadRateFirst" - # Template name: "ReadSingleBarcode". Represents a barcode reading mode for single barcode code detection. - PT_READ_SINGLE_BARCODE = "ReadSingleBarcode" - # Template name: "RecognizeNumbers". Represents a text recognition mode focused on recognizing numbers. - PT_RECOGNIZE_NUMBERS = "RecognizeNumbers" - # Template name: "RecognizeLetters". Represents a text recognition mode focused on recognizing alphabetic characters (letters). - PT_RECOGNIZE_LETTERS = "RecognizeLetters" - # Template name: "RecognizeNumbersAndLetters". Represents a text recognition mode that combines numbers and alphabetic characters (letters) recognition. - PT_RECOGNIZE_NUMBERS_AND_LETTERS = "RecognizeNumbersAndLetters" - # Template name: "RecognizeNumbersAndUppercaseLetters". Represents a text recognition mode that combines numbers and uppercase letters recognition. - PT_RECOGNIZE_NUMBERS_AND_UPPERCASE_LETTERS = "RecognizeNumbersAndUppercaseLetters" - # Template name: "RecognizeUppercaseLetters". Represents a text recognition mode focused on recognizing uppercase letters. - PT_RECOGNIZE_UPPERCASE_LETTERS = "RecognizeUppercaseLetters" -``` \ No newline at end of file diff --git a/enums/core/corner-type-v2.4.2100.md b/enums/core/corner-type-v2.4.2100.md deleted file mode 100644 index 5100924..0000000 --- a/enums/core/corner-type-v2.4.2100.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -layout: default-layout -title: CornerType - Dynamsoft Core Enumerations -description: The enumeration CornerType of Dynamsoft Core describes how the corner is formed by its sides. -keywords: Corner type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: CornerType -codeAutoHeight: true ---- - -# Enumeration CornerType - -`CornerType` categorizes the nature of a corner based on the intersection of its adjoining sides. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - > -> -```javascript -enum EnumCornerType { - /** - * Represents a corner formed by the standard intersection of two line segments at a point, creating a typical corner shape. - * This is the most common corner type, where the angle between the line segments can vary from acute to obtuse. - */ - CT_NORMAL_INTERSECTED = 0, - /** - * Describes a corner where two line segments intersect in a T-shape. - * This occurs when one line segment terminates at the midpoint of another, creating three distinct angles. - */ - CT_T_INTERSECTED = 1, - /** - * Characterizes a corner formed by two line segments intersecting each other in a cross shape. - * This configuration results in four angles and is commonly encountered in grid or lattice patterns. - */ - CT_CROSS_INTERSECTED = 2, - /** - * Defines a scenario where two line segments do not physically intersect but conceptually form a corner. - * This can occur in virtual shapes or when the corner is implied by the continuation of lines beyond their endpoints. - */ - CT_NOT_INTERSECTED = 3 -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumCornerType -{ - /** The corner is formed by two intersecting line segments. */ - public static final int CT_NORMAL_INTERSECTED = 0; - /** The corner is formed by two T intersecting line segments. */ - public static final int CT_T_INTERSECTED = 1; - /** The corner is formed by two cross intersecting line segments. */ - public static final int CT_CROSS_INTERSECTED = 2; - /** The two line segments are not intersected but they definitely consist a corner. */ - public static final int CT_NOT_INTERSECTED = 3; -} -``` -> -```objc -typedef NS_ENUM(NSInteger, DSCornerType) -{ - /** The corner is formed by two intersecting line segments. */ - DSCornerTypeNormalIntersected, - /** The corner is formed by two T intersecting line segments. */ - DSCornerTypeTIntersected, - /** The corner is formed by two cross intersecting line segments. */ - DSCornerTypeCrossIntersected, - /** The two line segments are not intersected but they definitely consist a corner. */ - DSCornerTypeNotIntersected -}; -``` -> -```swift -public enum CornerType : Int -{ - /** The corner is formed by two intersecting line segments. */ - intersected - /** The corner is formed by two T intersecting line segments. */ - tIntersected - /** The corner is formed by two cross intersecting line segments. */ - crossIntersected - /** The two line segments are not intersected but they definitely consist a corner. */ - notIntersected -}; -``` -> -```cpp -typedef enum CornerType -{ - /* The sides of the corner is normally intersected. */ - CT_NORMAL_INTERSECTED = 0, - /* The sides of the corner is T-intersected. */ - CT_T_INTERSECTED = 1, - /* The sides of the corner is cross-intersected. */ - CT_CROSS_INTERSECTED = 2, - /* The sides are not intersected but they definitely make up a corner. */ - CT_NOT_INTERSECTED = 3, -} CornerType; -``` diff --git a/enums/core/error-code-v2.2.3000.md b/enums/core/error-code-v2.2.3000.md deleted file mode 100644 index f47e0d4..0000000 --- a/enums/core/error-code-v2.2.3000.md +++ /dev/null @@ -1,1310 +0,0 @@ ---- -layout: default-layout -title: ErrorCode - Dynamsoft Core Enumerations -description: The enumeration ErrorCode of Dynamsoft Core describes all error codes. -keywords: Error code -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: ErrorCode -codeAutoHeight: true ---- - -# Enumeration ErrorCode - -`ErrorCode` enumerates the specific error codes that the SDK may return, providing a systematic way to identify and handle errors encountered during its operation. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - >- C# - > -> -```javascript -enum EnumErrorCode -{ - /** Operation completed successfully. */ - EC_OK = 0, - // Common error codes range from -10000 to -19999 - /** An unspecified error occurred. */ - EC_UNKNOWN = -10000, - /** The system does not have enough memory to perform the requested operation. */ - EC_NO_MEMORY = -10001, - /** A null pointer was encountered where a valid pointer was required. */ - EC_NULL_POINTER = -10002, - /** The provided license is not valid. */ - EC_LICENSE_INVALID = -10003, - /** The provided license has expired. */ - EC_LICENSE_EXPIRED = -10004, - /** The specified file could not be found. */ - EC_FILE_NOT_FOUND = -10005, - /** The file type is not supported for processing. */ - EC_FILE_TYPE_NOT_SUPPORTED = -10006, - /** The image's bits per pixel (BPP) is not supported. */ - EC_BPP_NOT_SUPPORTED = -10007, - /** The specified index is out of the valid range. */ - EC_INDEX_INVALID = -10008, - /** The specified custom region value is invalid or out of range. */ - EC_CUSTOM_REGION_INVALID = -10010, - /** Failed to read the image due to an error in accessing or interpreting the image data. */ - EC_IMAGE_READ_FAILED = -10012, - /** Failed to read a TIFF image, possibly due to corruption or unsupported format. */ - EC_TIFF_READ_FAILED = -10013, - /** The provided DIB (Device-Independent Bitmaps) buffer is invalid or corrupted. */ - EC_DIB_BUFFER_INVALID = -10018, - /** Failed to read a PDF image, possibly due to corruption or unsupported format. */ - EC_PDF_READ_FAILED = -10021, - /** Required PDF processing DLL is missing. */ - EC_PDF_DLL_MISSING = -10022, - /** The specified page number is invalid or out of bounds for the document. */ - EC_PAGE_NUMBER_INVALID = -10023, - /** The specified custom size is invalid or not supported. */ - EC_CUSTOM_SIZE_INVALID = -10024, - /** The operation timed out. */ - EC_TIMEOUT = -10026, - /** Failed to parse JSON input. */ - EC_JSON_PARSE_FAILED = -10030, - /** The JSON type is invalid for the expected context. */ - EC_JSON_TYPE_INVALID = -10031, - /** The JSON key is invalid or unrecognized in the current context. */ - EC_JSON_KEY_INVALID = -10032, - /** The JSON value is invalid for the specified key. */ - EC_JSON_VALUE_INVALID = -10033, - /** The required "Name" key is missing in the JSON data. */ - EC_JSON_NAME_KEY_MISSING = -10034, - /** The value of the "Name" key is duplicated and conflicts with existing data. */ - EC_JSON_NAME_VALUE_DUPLICATED = -10035, - /** The template name is invalid or does not match any known template. */ - EC_TEMPLATE_NAME_INVALID = -10036, - /** The reference made by the "Name" key is invalid or points to nonexistent data. */ - EC_JSON_NAME_REFERENCE_INVALID = -10037, - /** The parameter value provided is invalid or out of the expected range. */ - EC_PARAMETER_VALUE_INVALID = -10038, - /** The domain of the current site does not match the domain bound to the current product key. */ - EC_DOMAIN_NOT_MATCH = -10039, - /** The reserved information does not match the reserved info bound to the current product key. */ - EC_RESERVED_INFO_NOT_MATCH = -10040, - /** The license key does not match the license content. */ - EC_LICENSE_KEY_NOT_MATCH = -10043, - /** Failed to request the license content from the server. */ - EC_REQUEST_FAILED = -10044, - /** Failed to initialize the license. */ - EC_LICENSE_INIT_FAILED = -10045, - /** Error setting the mode's argument, indicating invalid or incompatible arguments. */ - EC_SET_MODE_ARGUMENT_ERROR = -10051, - /** The license content is invalid or corrupted. */ - EC_LICENSE_CONTENT_INVALID = -10052, - /** The license key is invalid or does not match any known valid keys. */ - EC_LICENSE_KEY_INVALID = -10053, - /** The license key has reached its maximum allowed usage and has no remaining quota. */ - EC_LICENSE_DEVICE_RUNS_OUT = -10054, - /** Failed to retrieve the mode's argument, possibly due to invalid state or configuration. */ - EC_GET_MODE_ARGUMENT_ERROR = -10055, - /** The Intermediate Result Types (IRT) license is invalid or not present. */ - EC_IRT_LICENSE_INVALID = -10056, - /** Failed to save the file, possibly due to permissions, space, or an invalid path. */ - EC_FILE_SAVE_FAILED = -10058, - /** The specified stage type is invalid or not supported in the current context. */ - EC_STAGE_TYPE_INVALID = -10059, - /** The specified image orientation is invalid or not supported. */ - EC_IMAGE_ORIENTATION_INVALID = -10060, - /** Failed to convert complex template to simplified settings, indicating a configuration or compatibility issue. */ - EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061, - /** Rejecting function call while capturing is in progress, to prevent conflicts or data corruption. */ - EC_CALL_REJECTED_WHEN_CAPTURING = -10062, - /** The specified image source was not found, indicating a missing or inaccessible input source. */ - EC_NO_IMAGE_SOURCE = -10063, - /** Failed to read the directory, possibly due to permissions, non-existence, or other access issues. */ - EC_READ_DIRECTORY_FAILED = -10064, - /** A required module (e.g., DynamsoftBarcodeReader, DynamsoftLabelRecognizer) was not found. */ - EC_MODULE_NOT_FOUND = -10065, - /** The operation does not support multi-page files; use FileFetcher for processing such files. */ - EC_MULTI_PAGES_NOT_SUPPORTED = -10066, - /** Indicates an attempt to write to a file that already exists, with overwriting explicitly disabled. This error suggests the need for either enabling overwriting or ensuring unique file names to avoid conflicts. */ - EC_FILE_ALREADY_EXISTS = -10067, - /** The specified file path does not exist and could not be created. This error could be due to insufficient permissions, a read-only filesystem, or other environmental constraints preventing file creation. */ - EC_CREATE_FILE_FAILED = -10068, - /** The input ImageData object contains invalid parameters. This could be due to incorrect data types, out-of-range values, or improperly formatted data being passed to a function expecting ImageData. */ - EC_IMGAE_DATA_INVALID = -10069, - // DLS license error codes range from -20000 to -29999 - /** Indicates no license is available or the license is not set. */ - EC_NO_LICENSE = -20000, - /** The provided Handshake Code is invalid or does not match expected format. */ - EC_HANDSHAKE_CODE_INVALID = -20001, - /** Encountered failures while attempting to read or write to the license buffer. */ - EC_LICENSE_BUFFER_FAILED = -20002, - /** Synchronization with the license server failed, possibly due to network issues or server unavailability. */ - EC_LICENSE_SYNC_FAILED = -20003, - /** The device attempting to use the license does not match the device specified in the license buffer. */ - EC_DEVICE_NOT_MATCH = -20004, - /** Binding the device to the license failed, indicating possible issues with the license or device identifier. */ - EC_BIND_DEVICE_FAILED = -20005, - /** The number of instances using the license exceeds the limit allowed by the license terms. */ - EC_INSTANCE_COUNT_OVER_LIMIT = -20008, - /** InitLicenseFromDLS must be called before any SDK objects are created to ensure proper license initialization. */ - EC_LICENSE_INIT_SEQUENCE_FAILED = -20009, - /** Indicates the license in use is a trial version with limited functionality or usage time. */ - EC_TRIAL_LICENSE = -20010, - /** The system failed to reach the License Server, likely due to network connectivity issues. */ - EC_FAILED_TO_REACH_DLS = -20200, - // DBR error codes range from -30000 to -39999 - /** The specified barcode format is invalid or unsupported. */ - EC_BARCODE_FORMAT_INVALID = -30009, - /** The license for decoding QR Codes is invalid or not present. */ - EC_QR_LICENSE_INVALID = -30016, - /** The license for decoding 1D barcodes is invalid or not present. */ - EC_1D_LICENSE_INVALID = -30017, - /** The license for decoding PDF417 barcodes is invalid or not present. */ - EC_PDF417_LICENSE_INVALID = -30019, - /** The license for decoding DataMatrix barcodes is invalid or not present. */ - EC_DATAMATRIX_LICENSE_INVALID = -30020, - /** The specified custom module size for barcode generation is invalid or outside acceptable limits. */ - EC_CUSTOM_MODULESIZE_INVALID = -30025, - /** The license for decoding Aztec barcodes is invalid or not present. */ - EC_AZTEC_LICENSE_INVALID = -30041, - /** The license for decoding Patchcode barcodes is invalid or not present. */ - EC_PATCHCODE_LICENSE_INVALID = -30046, - /** The license for decoding postal code formats is invalid or not present. */ - EC_POSTALCODE_LICENSE_INVALID = -30047, - /** The license for Direct Part Marking (DPM) decoding is invalid or not present. */ - EC_DPM_LICENSE_INVALID = -30048, - /** A frame decoding thread is already running, indicating a concurrent operation conflict. */ - EC_FRAME_DECODING_THREAD_EXISTS = -30049, - /** Stopping the frame decoding thread failed, indicating potential issues with thread management. */ - EC_STOP_DECODING_THREAD_FAILED = -30050, - /** The license for decoding MaxiCode barcodes is invalid or not present. */ - EC_MAXICODE_LICENSE_INVALID = -30057, - /** The license for decoding GS1 DataBar barcodes is invalid or not present. */ - EC_GS1_DATABAR_LICENSE_INVALID = -30058, - /** The license for decoding GS1 Composite codes is invalid or not present. */ - EC_GS1_COMPOSITE_LICENSE_INVALID = -30059, - /** The license for decoding DotCode barcodes is invalid or not present. */ - EC_DOTCODE_LICENSE_INVALID = -30061, - /** The license for decoding Pharmacode barcodes is invalid or not present. */ - EC_PHARMACODE_LICENSE_INVALID = -30062, - // DLR error codes range from -40000 to -49999 - /** Indicates that the required character model file was not found, possibly due to incorrect paths or missing files. */ - EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100, - // DDN error codes range from -50000 to -59999 - /** The specified quadrilateral is invalid, potentially due to incorrect points or an unprocessable shape. */ - EC_QUADRILATERAL_INVALID = -50057, - // Panorama error codes range from -70000 to -79999 - /** The license for generating or processing panoramas is invalid or missing. */ - EC_PANORAMA_LICENSE_INVALID = -70060, - // Reserved error codes range from -80000 to -89999 - // DCP error codes range from -90000 to -99999 - /** The specified resource path does not exist, indicating a missing directory or incorrect path specification. */ - EC_RESOURCE_PATH_NOT_EXIST = -90001, - /** Failed to load the specified resource, which might be due to missing files, access rights, or other issues preventing loading. */ - EC_RESOURCE_LOAD_FAILED = -90002, - /** The code specification required for processing was not found, indicating a missing or incorrect specification. */ - EC_CODE_SPECIFICATION_NOT_FOUND = -90003, - /** The full code string provided is empty, indicating no data was provided for processing. */ - EC_FULL_CODE_EMPTY = -90004, - /** Preprocessing the full code string failed, possibly due to invalid format, corruption, or unsupported features. */ - EC_FULL_CODE_PREPROCESS_FAILED = -90005, - /** The license required for parsing South Africa Driver License data is invalid or not present. */ - EC_ZA_DL_LICENSE_INVALID = -90006, - /** The license required for parsing North America DL/ID (AAMVA) data is invalid or not present. */ - EC_AAMVA_DL_ID_LICENSE_INVALID = -90007, - /** The license required for parsing Aadhaar data is invalid or not present. */ - EC_AADHAAR_LICENSE_INVALID = -90008, - /** The license required for parsing Machine Readable Travel Documents (MRTD) is invalid or not present. */ - EC_MRTD_LICENSE_INVALID = -90009, - /** The license required for parsing Vehicle Identification Number (VIN) data is invalid or not present. */ - EC_VIN_LICENSE_INVALID = -90010, - /** The license required for parsing customized code types is invalid or not present. */ - EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011 -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumErrorCode -{ - /** Successful. */ - public static final int EC_OK = 0; - /** -10000~-19999: Common error code. */ - /** Unknown error. */ - public static final int EC_UNKNOWN = -10000, - /**Not enough memory to perform the operation. */ - public static final int EC_NO_MEMORY = -10001, - /** Null pointer */ - public static final int EC_NULL_POINTER = -10002, - /** License invalid. */ - public static final int EC_LICENSE_INVALID = -10003, - /** License expired. */ - public static final int EC_LICENSE_EXPIRED = -10004, - /** File not found. */ - public static final int EC_FILE_NOT_FOUND = -10005, - /** The file type is not supported. */ - public static final int EC_FILE_TYPE_NOT_SUPPORTED = -10006, - /** The BPP (Bits Per Pixel) is not supported. */ - public static final int EC_BPP_NOT_SUPPORTED = -10007, - /** The index is invalid. */ - public static final int EC_INDEX_INVALID = -10008, - /** The input region value parameter is invalid. */ - public static final int EC_CUSTOM_REGION_INVALID = -10010, - /** Failed to read the image. */ - public static final int EC_IMAGE_READ_FAILED = -10012, - /** Failed to read the TIFF image. */ - public static final int EC_TIFF_READ_FAILED = -10013, - /** The DIB (Device-Independent Bitmaps) buffer is invalid. */ - public static final int EC_DIB_BUFFER_INVALID = -10018, - /** Failed to read the PDF image. */ - public static final int EC_PDF_READ_FAILED = -10021, - /** The PDF DLL is missing. */ - public static final int EC_PDF_DLL_MISSING = -10022, - /** The page number is invalid. */ - public static final int EC_PAGE_NUMBER_INVALID = -10023, - /** The custom size is invalid. */ - public static final int EC_CUSTOM_SIZE_INVALID = -10024, - /** timeout. */ - public static final int EC_TIMEOUT = -10026, - /** Json parse failed. */ - public static final int EC_JSON_PARSE_FAILED = -10030, - /** Json type invalid. */ - public static final int EC_JSON_TYPE_INVALID = -10031, - /** Json key invalid. */ - public static final int EC_JSON_KEY_INVALID = -10032, - /** Json value invalid. */ - public static final int EC_JSON_VALUE_INVALID = -10033, - /** Json name key missing. */ - public static final int EC_JSON_NAME_KEY_MISSING = -10034, - /** The value of the key "Name" is duplicated. */ - public static final int EC_JSON_NAME_VALUE_DUPLICATED = -10035, - /** Template name invalid. */ - public static final int EC_TEMPLATE_NAME_INVALID = -10036, - /** The name reference is invalid. */ - public static final int EC_JSON_NAME_REFERENCE_INVALID = -10037, - /** Parameter value invalid. */ - public static final int EC_PARAMETER_VALUE_INVALID = -10038, - /** The domain of your current site does not match the domain bound in the current product key. */ - public static final int EC_DOMAIN_NOT_MATCH = -10039, - /** The reserved info does not match the reserved info bound in the current product key. */ - public static final int EC_RESERVED_INFO_NOT_MATCH = -10040, - /** The license key does not match the license content. */ - public static final int EC_LICENSE_KEY_NOT_MATCH = -10043, - /** Failed to request the license content. */ - public static final int EC_REQUEST_FAILED = -10044, - /** Failed to init the license. */ - public static final int EC_LICENSE_INIT_FAILED = -10045, - /** Failed to set mode's argument. */ - public static final int EC_SET_MODE_ARGUMENT_ERROR = -10051, - /** The license content is invalid. */ - public static final int EC_LICENSE_CONTENT_INVALID = -10052, - /** The license key is invalid. */ - public static final int EC_LICENSE_KEY_INVALID = -10053, - /** The license key has no remaining quota. */ - public static final int EC_LICENSE_DEVICE_RUNS_OUT = -10054, - /** Failed to get mode's argument. */ - public static final int EC_GET_MODE_ARGUMENT_ERROR = -10055, - /** The Intermediate Result Types license is invalid. */ - public static final int EC_IRT_LICENSE_INVALID = -10056, - /** Failed to save file. */ - public static final int EC_FILE_SAVE_FAILED = -10058, - /** The stage type is invalid. */ - public static final int EC_STAGE_TYPE_INVALID = -10059, - /** The image orientation is invalid. */ - public static final int EC_IMAGE_ORIENTATION_INVALID = -10060, - /** Complex tempalte can't be converted to simplified settings. */ - public static final int EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061, - /** Reject function call while capturing in progress.*/ - public static final int EC_CALL_REJECTED_WHEN_CAPTURING = -10062, - /**The input image source was not found.*/ - public static final int EC_NO_IMAGE_SOURCE = -10063, - /**Failed to read directory.*/ - public static final int EC_READ_DIRECTORY_FAILED = -10064, - /**[Name] Module not found.*/ - /**Name : */ - /**DynamsoftBarcodeReader*/ - /**DynamsoftLabelRecognizer*/ - /**DynamsoftDocumentNormalizer*/ - public static final int EC_MODULE_NOT_FOUND = -10065, - /**The file already exists but overwriting is disabled.*/ - public static final int EC_FILE_ALREADY_EXISTS = -10067, - /**The file path does not exist but cannot be created, or cannot be created for any other reason.*/ - public static final int EC_CREATE_FILE_FAILED = -10068, - /**The input ImageData object contains invalid parameter(s).*/ - public static final int EC_IMGAE_DATA_INVALID = -10069, - /**The size of the input image do not meet the requirements.*/ - public static final int EC_IMAGE_SIZE_NOT_MATCH = -10070, - /**The pixel format of the input image do not meet the requirements.*/ - public static final int EC_IMAGE_PIXEL_FORMAT_NOT_MATCH = -10071, - /**The section level result is irreplaceable.*/ - public static final int EC_SECTION_LEVEL_RESULT_IRREPLACEABLE = -10072, - /** -20000~-29999: DLS license error code. */ - /** No license. */ - public static final int EC_NO_LICENSE = -20000, - /** The Handshake Code is invalid. */ - public static final int EC_HANDSHAKE_CODE_INVALID = -20001, - /** Failed to read or write license buffer. */ - public static final int EC_LICENSE_BUFFER_FAILED = -20002, - /** Failed to synchronize license info with license server. */ - public static final int EC_LICENSE_SYNC_FAILED = -20003, - /** Device dose not match with buffer. */ - public static final int EC_DEVICE_NOT_MATCH = -20004, - /** Failed to bind device. */ - public static final int EC_BIND_DEVICE_FAILED = -20005, - /** Instance count is over limit. */ - public static final int EC_INSTANCE_COUNT_OVER_LIMIT = -20008, - /** Trial License */ - public static final int EC_TRIAL_LICENSE = -20010, - /** Failed to reach License Server. */ - public static final int EC_FAILED_TO_REACH_DLS = -20200, - /** -30000~-39999: DBR error code. */ - /** The barcode format is invalid. */ - public static final int EC_BARCODE_FORMAT_INVALID = -30009, - /** The QR Code license is invalid. */ - public static final int EC_QR_LICENSE_INVALID = -30016, - /** The 1D Barcode license is invalid. */ - public static final int EC_1D_LICENSE_INVALID = -30017, - /** The PDF417 license is invalid. */ - public static final int EC_PDF417_LICENSE_INVALID = -30019, - /** The DATAMATRIX license is invalid. */ - public static final int EC_DATAMATRIX_LICENSE_INVALID = -30020, - /** The custom module size is invalid. */ - public static final int EC_CUSTOM_MODULESIZE_INVALID = -30025, - /** The AZTEC license is invalid. */ - public static final int EC_AZTpublic static final int EC_LICENSE_INVALID = -30041, - /** The Patchcode license is invalid. */ - public static final int EC_PATCHCODE_LICENSE_INVALID = -30046, - /** The Postal code license is invalid. */ - public static final int EC_POSTALCODE_LICENSE_INVALID = -30047, - /** The DPM license is invalid. */ - public static final int EC_DPM_LICENSE_INVALID = -30048, - /** The frame decoding thread already exists. */ - public static final int EC_FRAME_DECODING_THREAD_EXISTS = -30049, - /** Failed to stop the frame decoding thread. */ - public static final int EC_STOP_DECODING_THREAD_FAILED = -30050, - /** The Maxicode license is invalid. */ - public static final int EC_MAXICODE_LICENSE_INVALID = -30057, - /** The GS1 Databar license is invalid. */ - public static final int EC_GS1_DATABAR_LICENSE_INVALID = -30058, - /** The GS1 Composite code license is invalid. */ - public static final int EC_GS1_COMPOSITE_LICENSE_INVALID = -30059, - /** The DotCode license is invalid. */ - public static final int EC_DOTCODE_LICENSE_INVALID = -30061, - /** The Pharmacode license is invalid. */ - public static final int EC_PHARMACODE_LICENSE_INVALID = -30062, - /** -40000~-49999: DLR error code */ - /** Character Model file is not found. */ - public static final int EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100, - /**There is a conflict in the layout of TextLineGroup. */ - public static final int EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT = -40101, - /**There is a conflict in the regex of TextLineGroup. */ - public static final int EC_TEXT_LINE_GROUP_REGEX_CONFLICT = -40102, - /** -50000~-59999: DDN error code. */ - /**No content has been detected. */ - public static final int EC_CONTENT_NOT_FOUND = -50056, - /*The quadrilateral is invalid. */ - public static final int EC_QUADRILATERAL_INVALID = -50057, - /** -60000~-69999: DCE error code. */ - /**-60000~-69999: DCE error code*/ - /** The camera module is not exist. */ - public static final int EC_CAMERA_MODULE_NOT_EXIST = -60003; - /** The camera id does not exist. */ - public static final int EC_CAMERA_ID_NOT_EXIST = -60006; - /** The sensor does not exist. */ - public static final int EC_NO_SENSOR = -60045; - /**-70000~-79999: Panorama error code. */ - /**The panorama license is invalid. */ - public static final int EC_PANORAMA_LICENSE_INVALID = -70060, - /** -80000~-89999: Reserved error code. */ - /**-90000~-99999: DCP error code. */ - /** The resource path is not exist. */ - public static final int EC_RESOURCE_PATH_NOT_EXIST = -90001, - /** Failed to load resource. */ - public static final int EC_RESOURCE_LOAD_FAILED = -90002, - /** The code specification is not found. */ - public static final int EC_CODE_SPECIFICATION_NOT_FOUND = -90003, - /** The full code string is empty. */ - public static final int EC_FULL_CODE_EMPTY = -90004, - /** Failed to preprocess the full code string */ - public static final int EC_FULL_CODE_PREPROCESS_FAILED = -90005, - /** The license for parsing South Africa Driver License is invalid. */ - public static final int EC_ZA_DL_LICENSE_INVALID = -90006, - /** The license for parsing North America DL/ID is invalid. */ - public static final int EC_AAMVA_DL_ID_LICENSE_INVALID = -90007, - /** The license for parsing Aadhaar is invalid. */ - public static final int EC_AADHAAR_LICENSE_INVALID = -90008, - /** The license for parsing Machine Readable Travel Documents is invalid. */ - public static final int EC_MRTD_LICENSE_INVALID = -90009, - /** The license for parsing Vehicle Identification Number is invalid. */ - public static final int EC_VIN_LICENSE_INVALID = -90010, - /** The license for parsing customized code type is invalid. */ - public static final int EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011, -} ErrorCode; -``` -> -```objc -typedef NS_ERROR_ENUM(DSErrorDomain, DSError) { - /**Successful. */ - DSErrorOK = 0, - /**Unknown error. */ - DSErrorUnknown = -10000, - /**Not enough memory to perform the operation. */ - DSErrorNoMemory = -10001, - /**Null pointer */ - DSErrorNullPointer = -10002, - /**License invalid*/ - DSErrorLicenseInvalid = -10003, - /**License expired*/ - DSErrorLicenseExpired = -10004, - /**File not found*/ - DSErrorFileNotFound = -10005, - /**The file type is not supported. */ - DSErrorFiletypeNotSupported = -10006, - /**The BPP (Bits Per Pixel) is not supported. */ - DSErrorBPPNotSupported = -10007, - /**Failed to read the image. */ - DSErrorImageReadFailed = -10012, - /**Failed to read the TIFF image. */ - DSErrorTiffReadFailed = -10013, - /**The DIB (Device-Independent Bitmaps) buffer is invalid. */ - DSErrorDIBBufferInvalid = -10018, - /**Failed to read the PDF image. */ - DSErrorPdfReadFailed = -10021, - /**The PDF DLL is missing. */ - DSErrorPdfDllMissing = -10022, - /**The page number is invalid. */ - DSErrorPageNumberInvalid = -10023, - /**The custom size is invalid. */ - DSErrorCustomSizeInvalid = -10024, - /** timeout. */ - DSErrorTimeout = -10026, - /**Json parse failed*/ - DSErrorJsonParseFailed = -10030, - /**Json type invalid*/ - DSErrorJsonTypeInvalid = -10031, - /**Json key invalid*/ - DSErrorJsonKeyInvalid = -10032, - /**Json value invalid*/ - DSErrorJsonValueInvalid = -10033, - /**Json name key missing*/ - DSErrorJsonNameKeyMissing = -10034, - /**The value of the key "Name" is duplicated.*/ - DSErrorJsonNameValueDuplicated = -10035, - /**Template name invalid*/ - DSErrorTemplateNameInvalid = -10036, - /**The name reference is invalid.*/ - DSErrorJsonNameReferenceInvalid = -10037, - /**Parameter value invalid*/ - DSErrorParameterValueInvalid = -10038, - /**The domain of your current site does not match the domain bound in the current product key.*/ - DSErrorDomainNotMatch = -10039, - /**The reserved info does not match the reserved info bound in the current product key.*/ - DSErrorReservedInfoNotMatch = -10040, - /**The license key does not match the license content.*/ - DSErrorLicenseKeyNotMatch = -10043, - /**Failed to request the license content.*/ - DSErrorRequestFailed = -10044, - /**Failed to init the license.*/ - DSErrorLicenseInitFailed = -10045, - /**Failed to set mode's argument.*/ - DSErrorSetModeArgumentError = -10051, - /**The license content is invalid.*/ - DSErrorLicenseContentInvalid = -10052, - /**The license key is invalid.*/ - DSErrorLicenseKeyInvalid = -10053, - /**The license key has no remaining quota.*/ - DSErrorLicenseDeviceRunsOut = -10054, - /**Failed to get mode's argument.*/ - DSErrorGetModeArgumentError = -10055, - /**The Intermediate Result Types license is invalid.*/ - DSErrorIrtLicenseInvalid = -10056, - /**Failed to save file.*/ - DSErrorFileSaveFailed = -10058, - /**The stage type is invalid.*/ - DSErrorStageTypeInvalid = -10059, - /**The image orientation is invalid.*/ - DSErrorImageOrientationInvalid = -10060, - /**Failed to convert complex tempalte to simplified settings.*/ - DSErrorConvertComplexTemplateError = -10061, - /**Reject function call while capturing in progress.*/ - DSErrorCallRejectedWhenCapturing = -10062, - /**The input image source was not found.*/ - DSErrorNoImageSource = -10063, - /**Failed to read directory.*/ - DSErrorReadDirectoryFailed = -10064, - /**[Name] Module not found.*/ - /**Name : */ - /**DynamsoftBarcodeReader*/ - /**DynamsoftLabelRecognizer*/ - /**DynamsoftDocumentNormalizer*/ - DSErrorModuleNotFound = -10065, - /**The file already exists but overwriting is disabled.*/ - DSErrorFileAlreadyExists = -10067, - /**The file path does not exist but cannot be created, or cannot be created for any other reason.*/ - DSErrorCreateFileFailed = -10068, - /**The input ImageData object contains invalid parameter(s).*/ - DSErrorImageDataInvalid = -10069, - /**The size of the input image does not meet the requirements.*/ - DSErrorImageSizeNotMatch = -10070, - /**The pixel format of the input image does not meet the requirements.*/ - DSErrorImagePixelFormatNotMatch = -10071, - /**The section level result is irreplaceable.*/ - DSErrorSectionLevelResultIrreplaceable = -10072, - /**No license.*/ - DSErrorNoLicense = -20000, - /**The handshake code is invalid. */ - DSErrorHandshakeCodeInvalid = -20001, - /**Failed to read or write license cache. */ - DSErrorLicenseBufferFailed = -20002, - /**Falied to synchronize license info wirh license tracking server. */ - DSErrorLicenseSyncFailed = -20003, - /**Device does not match with license buffer. */ - DSErrorDeviceNotMatch = -20004, - /**Falied to bind device. */ - DSErrorBindDeviceFailed = -20005, - /**Install.*/ - DSErrorInstanceCountOverLimit = -20008, - /**Trial License*/ - DSErrorTrialLicense = -20010, - /**The license is not valid for current version*/ - DSErrorLicenseVersionNotMatch = -20011, - /**Failed to reach License Tracking Server.*/ - DSErrorFailedToReachDLS = -20200 - /** -30000~-39999: DBR error code. */ - /** The barcode format is invalid. */ - DSErrorBarcodeFormatInvalid = -30009, - /** The QR Code license is invalid. */ - DSErrorQRLicenseInvalid = -30016, - /** The 1D Barcode license is invalid. */ - DSError1DLicenseInvalid = -30017, - /** The PDF417 license is invalid. */ - DSErrorPDF417LicenseInvalid = -30019, - /** The DATAMATRIX license is invalid. */ - DSErrorDATAMATRIXLicenseInvalid = -30020, - /** The custom module size is invalid. */ - DSErrorCustomModuleSizeInvalid = -30025, - /** The AZTEC license is invalid. */ - DSErrorAztecLicenseInvalid = -30041, - /** The Patchcode license is invalid. */ - DSErrorPatchCodeLicenseInvalid = -30046, - /** The Postal code license is invalid. */ - DSErrorPostalCodeLicenseInvalid = -30047, - /** The DPM license is invalid. */ - DSErrorDPMLicenseInvalid = -30048, - /** The frame decoding thread already exists. */ - DSErrorFrameDecodingThreadExists = -30049, - /** Failed to stop the frame decoding thread. */ - DSErrorStopDecodingThreadFailed = -30050, - /** The Maxicode license is invalid. */ - DSErrorMaxiCodeLicenseInvalid = -30057, - /** The GS1 Databar license is invalid. */ - DSErrorGS1DatabarLicenseInvalid = -30058, - /** The GS1 Composite code license is invalid. */ - DSErrorGS1CompositeLicenseInvalid = -30059, - /** The DotCode license is invalid. */ - DSErrorDotCodeLicenseInvalid = -30061, - /** The Pharmacode license is invalid. */ - DSErrorPharmaCodeLicenseInvalid = -30062, - /** -40000~-49999: DLR error code */ - /** Character Model file is not found. */ - DSErrorCharacterModelFileNotFound = -40100, - /** There is a conflict in the layout of TextLineGroup. */ - DSErrorTextLineGroupLayoutConflict = -40101, - /** There is a conflict in the regex of TextLineGroup. */ - DSErrorTextLineGroupRegexConflict = -40102, - /** -50000~-59999: DDN error code. */ - /**No content has been detected. */ - DSErrorContentNotFound = -50056, - /*The quadrilateral is invalid. */ - DSErrorQuardrilateralInvalid = -50057, - /** -60000~-69999: DCE error code. */ - DSErrorCameraModelNotExist = -60003, - DSErrorCameraIDNotExist = -60006, - DSErrorNoSensor = -60045, - /**-70000~-79999: Panorama error code. */ - /**The panorama license is invalid. */ - DSErrorPanoramaLicenseInvalid = -70060, - /** -80000~-89999: Reserved error code. */ - /**-90000~-99999: DCP error code. */ - /** The resource path is not exist. */ - DSErrorResourcePathNotExist = -90001, - /** Failed to load resource. */ - DSErrorResourceLoadFailed = -90002, - /** The code specification is not found. */ - DSErrorCodeSpecificationNotFound = -90003, - /** The full code string is empty. */ - DSErrorFullCodeEmpty = -90004, - /** Failed to preprocess the full code string */ - DSErrorFullCodePreprocessFailed = -90005, - /** The license for parsing South Africa Driver License is invalid. */ - DSErrorZADLLicenseInvalid = -90006, - /** The license for parsing North America DL/ID is invalid. */ - DSErrorAAMVADLIDLicenseInvalid = -90007, - /** The license for parsing Aadhaar is invalid. */ - DSErrorAADHAARLicenseInvalid = -90008, - /** The license for parsing Machine Readable Travel Documents is invalid. */ - DSErrorMRTDLicenseInvalid = -90009, - /** The license for parsing Vehicle Identification Number is invalid. */ - DSErrorVINLicenseInvalid = -90010, - /** The license for parsing customized code type is invalid. */ - DSErrorCustomizedCodeTypeLicenseInvalid = -90011, -}; -``` -> -```swift -public enum ErrorCode : Int -{ - /**Successful. */ - oK = 0 - /**Unknown error. */ - unknown = -10000 - /**Not enough memory to perform the operation. */ - noMemory = -10001 - /**Null pointer */ - nullPointer = -10002 - /**License invalid*/ - licenseInvalid = -10003 - /**License expired*/ - licenseExpired = -10004 - /**File not found*/ - fileNotFound = -10005 - /**The file type is not supported. */ - filetypeNotSupported = -10006 - /**The BPP (Bits Per Pixel) is not supported. */ - bppNotSupported = -10007 - /**Failed to read the image. */ - imageReadFailed = -10012 - /**Failed to read the TIFF image. */ - tiffReadFailed = -10013 - /**The DIB (Device-Independent Bitmaps) buffer is invalid. */ - dibBufferInvalid = -10018, - /**Failed to read the PDF image. */ - pdfReadFailed = -10021 - /**The PDF DLL is missing. */ - pdfDllMissing = -10022 - /**The page number is invalid. */ - pageNumberInvalid = -10023 - /**The custom size is invalid. */ - customSizeInvalid = -10024 - /** timeout. */ - timeout = -10026 - /**Json parse failed*/ - jsonParseFailed = -10030 - /**Json type invalid*/ - jsonTypeInvalid = -10031 - /**Json key invalid*/ - jsonKeyInvalid = -10032 - /**Json value invalid*/ - jsonValueInvalid = -10033 - /**Json name key missing*/ - jsonNameKeyMissing = -10034 - /**The value of the key "Name" is duplicated.*/ - jsonNameValueDuplicated = -10035 - /**Template name invalid*/ - templateNameInvalid = -10036 - /**The name reference is invalid.*/ - jsonNameReferenceInvalid = -10037 - /**Parameter value invalid*/ - parameterValueInvalid = -10038 - /**The domain of your current site does not match the domain bound in the current product key.*/ - domainNotMatch = -10039 - /**The reserved info does not match the reserved info bound in the current product key.*/ - reservedInfoNotMatch = -10040 - /**The license key does not match the license content.*/ - licenseKeyNotMatch = -10043 - /**Failed to request the license content.*/ - requestFailed = -10044 - /**Failed to init the license.*/ - licenseInitFailed = -10045 - /**Failed to set mode's argument.*/ - setModeArgumentError = -10051 - /**The license content is invalid.*/ - licenseContentInvalid = -10052 - /**The license key is invalid.*/ - licenseKeyInvalid = -10053 - /**The license key has no remaining quota.*/ - licenseDeviceRunsOut = -10054 - /**Failed to get mode's argument.*/ - getModeArgumentError = -10055 - /**The Intermediate Result Types license is invalid.*/ - irtLicenseInvalid = -10056 - /**Failed to save file.*/ - fileSaveFailed = -10058 - /**The stage type is invalid.*/ - stageTypeInvalid = -10059 - /**The image orientation is invalid.*/ - imageOrientationInvalid = -10060 - /**Failed to convert complex tempalte to simplified settings.*/ - convertComplexTemplateError = -10061 - /**Reject function call while capturing in progress.*/ - callRejectedWhenCapturing = -10062 - /**The input image source was not found.*/ - noImageSource = -10063 - /**Failed to read directory.*/ - readDirectoryFailed = -10064 - /**[Name] Module not found.*/ - /**Name : */ - /**DynamsoftBarcodeReader*/ - /**DynamsoftLabelRecognizer*/ - /**DynamsoftDocumentNormalizer*/ - moduleNotFound = -10065 - /**The file already exists but overwriting is disabled.*/ - fileAlreadyExists = -10067 - /**The file path does not exist but cannot be created, or cannot be created for any other reason.*/ - createFileFailed = -10068 - /**The input ImageData object contains invalid parameter(s).*/ - imageDataInvalid = -10069 - /**The size of the input image does not meet the requirements.*/ - imageSizeNotMatch = -10070 - /**The pixel format of the input image does not meet the requirements.*/ - imagePixelFormatNotMatch = -10071 - /**The section level result is irreplaceable.*/ - sectionLevelResultIrreplaceable = -10072 - /**No license.*/ - noLicense = -20000 - /**The handshake code is invalid. */ - handshakeCodeInvalid = -20001 - /**Failed to read or write license cache. */ - licenseBufferFailed = -20002 - /**Falied to synchronize license info wirh license tracking server. */ - licenseSyncFailed = -20003 - /**Device does not match with license buffer. */ - deviceNotMatch = -20004 - /**Falied to bind device. */ - bindDeviceFailed = -20005 - /**Install.*/ - instanceCountOverLimit = -20008 - /**Trial License*/ - trialLicense = -20010 - /**The license is not valid for current version*/ - licenseVersionNotMatch = -20011 - /**Failed to reach License Tracking Server.*/ - failedToReachDLS = -20200 - /** -30000~-39999: DBR error code. */ - /** The barcode format is invalid. */ - barcodeFormatInvalid = -30009 - /** The QR Code license is invalid. */ - qrLicenseInvalid = -30016 - /** The 1D Barcode license is invalid. */ - 1DLicenseInvalid = -30017 - /** The PDF417 license is invalid. */ - pdf417LicenseInvalid = -30019 - /** The DATAMATRIX license is invalid. */ - dataMatrixLicenseInvalid = -30020 - /** The custom module size is invalid. */ - customModuleSizeInvalid = -30025 - /** The AZTEC license is invalid. */ - aztecLicenseInvalid = -30041 - /** The Patchcode license is invalid. */ - patchCodeLicenseInvalid = -30046 - /** The Postal code license is invalid. */ - postalCodeLicenseInvalid = -30047 - /** The DPM license is invalid. */ - dpmLicenseInvalid = -30048 - /** The frame decoding thread already exists. */ - frameDecodingThreadExists = -30049 - /** Failed to stop the frame decoding thread. */ - stopDecodingThreadFailed = -30050 - /** The Maxicode license is invalid. */ - maxiCodeLicenseInvalid = -30057 - /** The GS1 Databar license is invalid. */ - gs1DatabarLicenseInvalid = -30058 - /** The GS1 Composite code license is invalid. */ - gs1CompositeLicenseInvalid = -30059 - /** The DotCode license is invalid. */ - dotCodeLicenseInvalid = -30061 - /** The Pharmacode license is invalid. */ - pharmaCodeLicenseInvalid = -30062 - /** -40000~-49999: DLR error code */ - /** Character Model file is not found. */ - characterModelFileNotFound = -40100 - /** There is a conflict in the layout of TextLineGroup. */ - textLineGroupLayoutConflict = -40101 - /** There is a conflict in the regex of TextLineGroup. */ - textLineGroupRegexConflict = -40102 - /** -50000~-59999: DDN error code. */ - /** No content has been detected. */ - contentNotFound = -50056 - /*The quadrilateral is invalid. */ - quardrilateralInvalid = -50057 - /** -60000~-69999: DCE error code. */ - /** The camera module is not exist. */ - cameraModelNotExist = -60003 - /** The camera id does not exist. */ - cameraIDNotExist = -60006 - /** The sensor does not exist. */ - noSensor = -60045 - /**-70000~-79999: Panorama error code. */ - /**The panorama license is invalid. */ - panoramaLicenseInvalid = -70060 - /** -80000~-89999: Reserved error code. */ - /**-90000~-99999: DCP error code. */ - /** The resource path is not exist. */ - resourcePathNotExist = -90001 - /** Failed to load resource. */ - resourceLoadFailed = -90002 - /** The code specification is not found. */ - codeSpecificationNotFound = -90003 - /** The full code string is empty. */ - fullCodeEmpty = -90004 - /** Failed to preprocess the full code string */ - fullCodePreprocessFailed = -90005 - /** The license for parsing South Africa Driver License is invalid. */ - zadlLicenseInvalid = -90006 - /** The license for parsing North America DL/ID is invalid. */ - aamvadlidLicenseInvalid = -90007 - /** The license for parsing Aadhaar is invalid. */ - aadhaarLicenseInvalid = -90008 - /** The license for parsing Machine Readable Travel Documents is invalid. */ - mrtdLicenseInvalid = -90009 - /** The license for parsing Vehicle Identification Number is invalid. */ - vinLicenseInvalid = -90010 - /** The license for parsing customized code type is invalid. */ - customizedCodeTypeLicenseInvalid = -90011 -} -``` -> -```cpp -typedef enum ErrorCode -{ - /** Successful. */ - EC_OK = 0, - /** -10000~-19999: Common error code. */ - /** Unknown error. */ - EC_UNKNOWN = -10000, - /**Not enough memory to perform the operation. */ - EC_NO_MEMORY = -10001, - /** Null pointer */ - EC_NULL_POINTER = -10002, - /** License invalid. */ - EC_LICENSE_INVALID = -10003, - /** License expired. */ - EC_LICENSE_EXPIRED = -10004, - /** File not found. */ - EC_FILE_NOT_FOUND = -10005, - /** The file type is not supported. */ - EC_FILE_TYPE_NOT_SUPPORTED = -10006, - /** The BPP (Bits Per Pixel) is not supported. */ - EC_BPP_NOT_SUPPORTED = -10007, - /** The index is invalid. */ - EC_INDEX_INVALID = -10008, - /** The input region value parameter is invalid. */ - EC_CUSTOM_REGION_INVALID = -10010, - /** Failed to read the image. */ - EC_IMAGE_READ_FAILED = -10012, - /** Failed to read the TIFF image. */ - EC_TIFF_READ_FAILED = -10013, - /** The DIB (Device-Independent Bitmaps) buffer is invalid. */ - EC_DIB_BUFFER_INVALID = -10018, - /** Failed to read the PDF image. */ - EC_PDF_READ_FAILED = -10021, - /** The PDF DLL is missing. */ - EC_PDF_DLL_MISSING = -10022, - /** The page number is invalid. */ - EC_PAGE_NUMBER_INVALID = -10023, - /** The custom size is invalid. */ - EC_CUSTOM_SIZE_INVALID = -10024, - /** timeout. */ - EC_TIMEOUT = -10026, - /** Json parse failed. */ - EC_JSON_PARSE_FAILED = -10030, - /** Json type invalid. */ - EC_JSON_TYPE_INVALID = -10031, - /** Json key invalid. */ - EC_JSON_KEY_INVALID = -10032, - /** Json value invalid. */ - EC_JSON_VALUE_INVALID = -10033, - /** Json name key missing. */ - EC_JSON_NAME_KEY_MISSING = -10034, - /** The value of the key "Name" is duplicated. */ - EC_JSON_NAME_VALUE_DUPLICATED = -10035, - /** Template name invalid. */ - EC_TEMPLATE_NAME_INVALID = -10036, - /** The name reference is invalid. */ - EC_JSON_NAME_REFERENCE_INVALID = -10037, - /** Parameter value invalid. */ - EC_PARAMETER_VALUE_INVALID = -10038, - /** The domain of your current site does not match the domain bound in the current product key. */ - EC_DOMAIN_NOT_MATCH = -10039, - /** The reserved info does not match the reserved info bound in the current product key. */ - EC_RESERVED_INFO_NOT_MATCH = -10040, - /** The license key does not match the license content. */ - EC_LICENSE_KEY_NOT_MATCH = -10043, - /** Failed to request the license content. */ - EC_REQUEST_FAILED = -10044, - /** Failed to init the license. */ - EC_LICENSE_INIT_FAILED = -10045, - /** Failed to set mode's argument. */ - EC_SET_MODE_ARGUMENT_ERROR = -10051, - /** The license content is invalid. */ - EC_LICENSE_CONTENT_INVALID = -10052, - /** The license key is invalid. */ - EC_LICENSE_KEY_INVALID = -10053, - /** The license key has no remaining quota. */ - EC_LICENSE_DEVICE_RUNS_OUT = -10054, - /** Failed to get mode's argument. */ - EC_GET_MODE_ARGUMENT_ERROR = -10055, - /** The Intermediate Result Types license is invalid. */ - EC_IRT_LICENSE_INVALID = -10056, - /** Failed to save file. */ - EC_FILE_SAVE_FAILED = -10058, - /** The stage type is invalid. */ - EC_STAGE_TYPE_INVALID = -10059, - /** The image orientation is invalid. */ - EC_IMAGE_ORIENTATION_INVALID = -10060, - /** Complex tempalte can't be converted to simplified settings. */ - EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061, - /** Reject function call while capturing in progress.*/ - EC_CALL_REJECTED_WHEN_CAPTURING = -10062, - /**The input image source was not found.*/ - EC_NO_IMAGE_SOURCE = -10063, - /**Failed to read directory.*/ - EC_READ_DIRECTORY_FAILED = -10064, - /**[Name] Module not found.*/ - /**Name : */ - /**DynamsoftBarcodeReader*/ - /**DynamsoftLabelRecognizer*/ - /**DynamsoftDocumentNormalizer*/ - EC_MODULE_NOT_FOUND = -10065, - /**The file already exists but overwriting is disabled.*/ - EC_FILE_ALREADY_EXISTS = -10067, - /**The file path does not exist but cannot be created, or cannot be created for any other reason.*/ - EC_CREATE_FILE_FAILED = -10068, - /**The input ImageData object contains invalid parameter(s).*/ - EC_IMGAE_DATA_INVALID = -10069, - /**The size of the input image do not meet the requirements.*/ - EC_IMAGE_SIZE_NOT_MATCH = -10070, - /**The pixel format of the input image do not meet the requirements.*/ - EC_IMAGE_PIXEL_FORMAT_NOT_MATCH = -10071, - /**The section level result is irreplaceable.*/ - EC_SECTION_LEVEL_RESULT_IRREPLACEABLE = -10072, - /**The axis definition is incorrect.*/ - EC_AXIS_DEFINITION_INCORRECT = -10073, - /**The result is not replaceable due to type mismatch*/ - EC_RESULT_TYPE_MISMATCH_IRREPLACEABLE = -10074, - /**Failed to load the PDF library.*/ - EC_PDF_LIBRARY_LOAD_FAILED = -10075, - /** -20000~-29999: DLS license error code. */ - /** No license. */ - EC_NO_LICENSE = -20000, - /** The Handshake Code is invalid. */ - EC_HANDSHAKE_CODE_INVALID = -20001, - /** Failed to read or write license buffer. */ - EC_LICENSE_BUFFER_FAILED = -20002, - /** Failed to synchronize license info with license server. */ - EC_LICENSE_SYNC_FAILED = -20003, - /** Device dose not match with buffer. */ - EC_DEVICE_NOT_MATCH = -20004, - /** Failed to bind device. */ - EC_BIND_DEVICE_FAILED = -20005, - /** Instance count is over limit. */ - EC_INSTANCE_COUNT_OVER_LIMIT = -20008, - /** Trial License */ - EC_TRIAL_LICENSE = -20010, - /**Online license validation failed due to network issues. Using cached license information for validation*/ - EC_LICENSE_CACHE_USED = -20012, - /** Failed to reach License Server. */ - EC_FAILED_TO_REACH_DLS = -20200, - /** -30000~-39999: DBR error code. */ - /** The barcode format is invalid. */ - EC_BARCODE_FORMAT_INVALID = -30009, - /** The QR Code license is invalid. */ - EC_QR_LICENSE_INVALID = -30016, - /** The 1D Barcode license is invalid. */ - EC_1D_LICENSE_INVALID = -30017, - /** The PDF417 license is invalid. */ - EC_PDF417_LICENSE_INVALID = -30019, - /** The DATAMATRIX license is invalid. */ - EC_DATAMATRIX_LICENSE_INVALID = -30020, - /** The custom module size is invalid. */ - EC_CUSTOM_MODULESIZE_INVALID = -30025, - /** The AZTEC license is invalid. */ - EC_AZTEC_LICENSE_INVALID = -30041, - /** The Patchcode license is invalid. */ - EC_PATCHCODE_LICENSE_INVALID = -30046, - /** The Postal code license is invalid. */ - EC_POSTALCODE_LICENSE_INVALID = -30047, - /** The DPM license is invalid. */ - EC_DPM_LICENSE_INVALID = -30048, - /** The frame decoding thread already exists. */ - EC_FRAME_DECODING_THREAD_EXISTS = -30049, - /** Failed to stop the frame decoding thread. */ - EC_STOP_DECODING_THREAD_FAILED = -30050, - /** The Maxicode license is invalid. */ - EC_MAXICODE_LICENSE_INVALID = -30057, - /** The GS1 Databar license is invalid. */ - EC_GS1_DATABAR_LICENSE_INVALID = -30058, - /** The GS1 Composite code license is invalid. */ - EC_GS1_COMPOSITE_LICENSE_INVALID = -30059, - /** The DotCode license is invalid. */ - EC_DOTCODE_LICENSE_INVALID = -30061, - /** The Pharmacode license is invalid. */ - EC_PHARMACODE_LICENSE_INVALID = -30062, - /** -40000~-49999: DLR error code */ - /** Character Model file is not found. */ - EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100, - /**There is a conflict in the layout of TextLineGroup. */ - EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT = -40101, - /**There is a conflict in the regex of TextLineGroup. */ - EC_TEXT_LINE_GROUP_REGEX_CONFLICT = -40102, - /** -50000~-59999: DDN error code. */ - /**No content has been detected. */ - EC_CONTENT_NOT_FOUND = -50056, - /*The quadrilateral is invalid. */ - EC_QUADRILATERAL_INVALID = -50057, - /** -60000~-69999: DCE error code. */ - /**-60000~-69999: DCE error code*/ - EC_CAMERA_MODULE_NOT_EXIST = -60003; - EC_CAMERA_ID_NOT_EXIST = -60006; - EC_NO_SENSOR = -60045; - /**-70000~-79999: Panorama error code. */ - /**The panorama license is invalid. */ - EC_PANORAMA_LICENSE_INVALID = -70060, - /** -80000~-89999: Reserved error code. */ - /**-90000~-99999: DCP error code. */ - /** The resource path is not exist. */ - EC_RESOURCE_PATH_NOT_EXIST = -90001, - /** Failed to load resource. */ - EC_RESOURCE_LOAD_FAILED = -90002, - /** The code specification is not found. */ - EC_CODE_SPECIFICATION_NOT_FOUND = -90003, - /** The full code string is empty. */ - EC_FULL_CODE_EMPTY = -90004, - /** Failed to preprocess the full code string */ - EC_FULL_CODE_PREPROCESS_FAILED = -90005, - /** The license for parsing South Africa Driver License is invalid. */ - EC_ZA_DL_LICENSE_INVALID = -90006, - /** The license for parsing North America DL/ID is invalid. */ - EC_AAMVA_DL_ID_LICENSE_INVALID = -90007, - /** The license for parsing Aadhaar is invalid. */ - EC_AADHAAR_LICENSE_INVALID = -90008, - /** The license for parsing Machine Readable Travel Documents is invalid. */ - EC_MRTD_LICENSE_INVALID = -90009, - /** The license for parsing Vehicle Identification Number is invalid. */ - EC_VIN_LICENSE_INVALID = -90010, - /** The license for parsing customized code type is invalid. */ - EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011, -} ErrorCode; -``` -> -```csharp -public enum EnumErrorCode -{ - /**Successful. */ - EC_OK = 0, - /** -10000~-19999: Common error code. */ - /**Unknown error. */ - EC_UNKNOWN = -10000, - /**Not enough memory to perform the operation. */ - EC_NO_MEMORY = -10001, - /**Null pointer */ - EC_NULL_POINTER = -10002, - /**License invalid*/ - EC_LICENSE_INVALID = -10003, - /**License expired*/ - EC_LICENSE_EXPIRED = -10004, - /**File not found*/ - EC_FILE_NOT_FOUND = -10005, - /**The file type is not supported. */ - EC_FILE_TYPE_NOT_SUPPORTED = -10006, - /**The BPP (Bits Per Pixel) is not supported. */ - EC_BPP_NOT_SUPPORTED = -10007, - /**The index is invalid.*/ - EC_INDEX_INVALID = -10008, - /**The input region value parameter is invalid.*/ - EC_CUSTOM_REGION_INVALID = -10010, - /**Failed to read the image. */ - EC_IMAGE_READ_FAILED = -10012, - /**Failed to read the TIFF image. */ - EC_TIFF_READ_FAILED = -10013, - /**The DIB (Device-Independent Bitmaps) buffer is invalid. */ - EC_DIB_BUFFER_INVALID = -10018, - /**Failed to read the PDF image. */ - EC_PDF_READ_FAILED = -10021, - /**The PDF DLL is missing. */ - EC_PDF_DLL_MISSING = -10022, - /**The page number is invalid. */ - EC_PAGE_NUMBER_INVALID = -10023, - /**The custom size is invalid. */ - EC_CUSTOM_SIZE_INVALID = -10024, - /** timeout. */ - EC_TIMEOUT = -10026, - /**Json parse failed*/ - EC_JSON_PARSE_FAILED = -10030, - /**Json type invalid*/ - EC_JSON_TYPE_INVALID = -10031, - /**Json key invalid*/ - EC_JSON_KEY_INVALID = -10032, - /**Json value invalid*/ - EC_JSON_VALUE_INVALID = -10033, - /**Json name key missing*/ - EC_JSON_NAME_KEY_MISSING = -10034, - /**The value of the key "Name" is duplicated.*/ - EC_JSON_NAME_VALUE_DUPLICATED = -10035, - /**Template name invalid*/ - EC_TEMPLATE_NAME_INVALID = -10036, - /**The name reference is invalid.*/ - EC_JSON_NAME_REFERENCE_INVALID = -10037, - /**Parameter value invalid*/ - EC_PARAMETER_VALUE_INVALID = -10038, - /**The domain of your current site does not match the domain bound in the current product key.*/ - EC_DOMAIN_NOT_MATCH = -10039, - /**The reserved info does not match the reserved info bound in the current product key.*/ - EC_RESERVED_INFO_NOT_MATCH = -10040, - /**The license key does not match the license content.*/ - EC_LICENSE_KEY_NOT_MATCH = -10043, - /**Failed to request the license content.*/ - EC_REQUEST_FAILED = -10044, - /**Failed to init the license.*/ - EC_LICENSE_INIT_FAILED = -10045, - /**Failed to set mode's argument.*/ - EC_SET_MODE_ARGUMENT_ERROR = -10051, - /**The license content is invalid.*/ - EC_LICENSE_CONTENT_INVALID = -10052, - /**The license key is invalid.*/ - EC_LICENSE_KEY_INVALID = -10053, - /**The license key has no remaining quota.*/ - EC_LICENSE_DEVICE_RUNS_OUT = -10054, - /**Failed to get mode's argument.*/ - EC_GET_MODE_ARGUMENT_ERROR = -10055, - /**The Intermediate Result Types license is invalid.*/ - EC_IRT_LICENSE_INVALID = -10056, - /**Failed to save file.*/ - EC_FILE_SAVE_FAILED = -10058, - /**The stage type is invalid.*/ - EC_STAGE_TYPE_INVALID = -10059, - /**The image orientation is invalid.*/ - EC_IMAGE_ORIENTATION_INVALID = -10060, - /**Complex template can't be converted to simplified settings.*/ - EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061, - /**Reject function call while capturing in progress.*/ - EC_CALL_REJECTED_WHEN_CAPTURING = -10062, - /**The input image source was not found.*/ - EC_NO_IMAGE_SOURCE = -10063, - /**Failed to read directory.*/ - EC_READ_DIRECTORY_FAILED = -10064, - /**[Name] Module not found.*/ - /**Name: */ - /**DynamsoftBarcodeReader*/ - /**DynamsoftLabelRecognizer*/ - /**DynamsoftDocumentNormalizer*/ - EC_MODULE_NOT_FOUND = -10065, - /**The api does not support multi-page files. Please use FileFetcher instead.*/ - EC_MULTI_PAGES_NOT_SUPPORTED = -10066, - /**The file already exists but overwriting is disabled.*/ - EC_FILE_ALREADY_EXISTS = -10067, - /**The file path does not exist but cannot be created, or the file - cannot be created for any other reason.*/ - EC_CREATE_FILE_FAILED = -10068, - /**The input ImageData object contains invalid parameter(s).*/ - EC_IMAGE_DATA_INVALID = -10069, - /**The size of the input image does not meet the requirements.*/ - EC_IMAGE_SIZE_NOT_MATCH = -10070, - /**The pixel format of the input image does not meet the requirements.*/ - EC_IMAGE_PIXEL_FORMAT_NOT_MATCH = -10071, - /**The section level result is irreplaceable.*/ - EC_SECTION_LEVEL_RESULT_IRREPLACEABLE = -10072, - /**The axis definition is incorrect.*/ - EC_AXIS_DEFINITION_INCORRECT = -10073, - /**The result is not replaceable due to type mismatch.*/ - EC_RESULT_TYPE_MISMATCH_IRREPLACEABLE = -10074, - /** -20000~-29999: DLS license error code. */ - /**No license.*/ - EC_NO_LICENSE = -20000, - /**The Handshake Code is invalid.*/ - EC_HANDSHAKE_CODE_INVALID = -20001, - /**Failed to read or write license buffer. */ - EC_LICENSE_BUFFER_FAILED = -20002, - /**Failed to synchronize license info with license server. */ - EC_LICENSE_SYNC_FAILED = -20003, - /**Device dose not match with buffer. */ - EC_DEVICE_NOT_MATCH = -20004, - /**Failed to bind device. */ - EC_BIND_DEVICE_FAILED = -20005, - /**License Client dll is missing.*/ - EC_LICENSE_CLIENT_DLL_MISSING = -20007, - /**Instance count is over limit.*/ - EC_INSTANCE_COUNT_OVER_LIMIT = -20008, - /**Interface InitLicense has to be called before creating any SDK objects.*/ - EC_LICENSE_INIT_SEQUENCE_FAILED = -20009, - /**Trial License*/ - EC_TRIAL_LICENSE = -20010, - /**The license is not valid for current version*/ - EC_LICENSE_VERSION_NOT_MATCH = -20011, - /**Online license validation failed due to network issues. Using cached license information for validation*/ - EC_LICENSE_CACHE_USED = -20012, - /**Failed to reach License Server.*/ - EC_FAILED_TO_REACH_DLS = -20200, - /**-30000~-39999: DBR error code*/ - /**The barcode format is invalid.*/ - EC_BARCODE_FORMAT_INVALID = -30009, - /**The QR Code license is invalid.*/ - EC_QR_LICENSE_INVALID = -30016, - /**The 1D Barcode license is invalid.*/ - EC_1D_LICENSE_INVALID = -30017, - /**The PDF417 license is invalid.*/ - EC_PDF417_LICENSE_INVALID = -30019, - /**The DATAMATRIX license is invalid. */ - EC_DATAMATRIX_LICENSE_INVALID = -30020, - /**The custom module size is invalid. */ - EC_CUSTOM_MODULESIZE_INVALID = -30025, - /**The AZTEC license is invalid.*/ - EC_AZTEC_LICENSE_INVALID = -30041, - /**The Patchcode license is invalid.*/ - EC_PATCHCODE_LICENSE_INVALID = -30046, - /**The Postal code license is invalid.*/ - EC_POSTALCODE_LICENSE_INVALID = -30047, - /**The DPM license is invalid.*/ - EC_DPM_LICENSE_INVALID = -30048, - /**The frame decoding thread already exists.*/ - EC_FRAME_DECODING_THREAD_EXISTS = -30049, - /**Failed to stop the frame decoding thread.*/ - EC_STOP_DECODING_THREAD_FAILED = -30050, - /**The Maxicode license is invalid.*/ - EC_MAXICODE_LICENSE_INVALID = -30057, - /**The GS1 Databar license is invalid.*/ - EC_GS1_DATABAR_LICENSE_INVALID = -30058, - /**The GS1 Composite code license is invalid.*/ - EC_GS1_COMPOSITE_LICENSE_INVALID = -30059, - /**The DotCode license is invalid.*/ - EC_DOTCODE_LICENSE_INVALID = -30061, - /**The Pharmacode license is invalid.*/ - EC_PHARMACODE_LICENSE_INVALID = -30062, - /**-40000~-49999: DLR error code*/ - /**Character Model file is not found*/ - EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100, - /**There is a conflict in the layout of TextLineGroup. */ - EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT = -40101, - /**There is a conflict in the regex of TextLineGroup. */ - EC_TEXT_LINE_GROUP_REGEX_CONFLICT = -40102, - /**-50000~-59999: DDN error code*/ - /*The quadrilateral is invalid*/ - EC_QUADRILATERAL_INVALID = -50057, - /**-60000~-69999: DCE error code*/ - /**-70000~-79999: Panorama error code*/ - /**The panorama license is invalid.*/ - EC_PANORAMA_LICENSE_INVALID = -70060, - /**-80000~-89999: Reserved error code*/ - /**-90000~-99999: DCP error code*/ - /*The resource path does not exist.*/ - EC_RESOURCE_PATH_NOT_EXIST = -90001, - /*Failed to load resource.*/ - EC_RESOURCE_LOAD_FAILED = -90002, - /*The code specification is not found.*/ - EC_CODE_SPECIFICATION_NOT_FOUND = -90003, - /*The full code string is empty.*/ - EC_FULL_CODE_EMPTY = -90004, - /*Failed to preprocess the full code string.*/ - EC_FULL_CODE_PREPROCESS_FAILED = -90005, - /*The license for parsing South Africa Driver License is invalid.*/ - EC_ZA_DL_LICENSE_INVALID = -90006, - /*The license for parsing North America DL/ID is invalid.*/ - EC_AAMVA_DL_ID_LICENSE_INVALID = -90007, - /*The license for parsing Aadhaar is invalid.*/ - EC_AADHAAR_LICENSE_INVALID = -90008, - /*The license for parsing Machine Readable Travel Documents is invalid.*/ - EC_MRTD_LICENSE_INVALID = -90009, - /*The license for parsing Vehicle Identification Number is invalid.*/ - EC_VIN_LICENSE_INVALID = -90010, - /*The license for parsing customized code type is invalid.*/ - EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011 -} -``` diff --git a/enums/core/intermediate-result-unit-type-v2.2.3000.md b/enums/core/intermediate-result-unit-type-v2.2.3000.md deleted file mode 100644 index e97f50e..0000000 --- a/enums/core/intermediate-result-unit-type-v2.2.3000.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -layout: default-layout -title: IntermediateResultUnitType - Dynamsoft Core Enumerations -description: The enumeration IntermediateResultUnitType of Dynamsoft Core describes the type of the intermediate result unit. -keywords: Intermediate result unit type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: IntermediateResultUnitType -codeAutoHeight: true ---- - -# Enumeration IntermediateResultUnitType - -`IntermediateResultUnitType` defines different types of intermediate results generated or expected to be generated during image processing. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - > -> -```javascript -enum EnumIntermediateResultUnitType { - /** No intermediate result. */ - IRUT_NULL = 0, - /** A full-color image. */ - IRUT_COLOUR_IMAGE = 1, - /** A color image that has been scaled down for efficiency. */ - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, - /** A grayscale image derived from the original input. */ - IRUT_GRAYSCALE_IMAGE = 1 << 2, - /** A grayscale image that has undergone transformation. */ - IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1 << 3, - /** A grayscale image enhanced for further processing. */ - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - IRUT_PREDETECTED_REGIONS = 1 << 5, - /** A binary (black and white) image. */ - IRUT_BINARY_IMAGE = 1 << 6, - /** Results from detecting textures within the image. */ - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - IRUT_CONTOURS = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - IRUT_LINE_SEGMENTS = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - IRUT_TEXT_ZONES = 1 << 12, - /** A binary image with text regions removed. */ - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - IRUT_LOCALIZED_BARCODES = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, - /** Barcode images that have been complemented. */ - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, - /** Successfully decoded barcodes. */ - IRUT_DECODED_BARCODES = 1 << 19, - /** Detected long lines. */ - IRUT_LONG_LINES = 1 << 20, - /** Detected corners within the image. */ - IRUT_CORNERS = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, - /** Successfully detected quadrilaterals. */ - IRUT_DETECTED_QUADS = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - IRUT_LOCALIZED_TEXT_LINES = 1 << 24, - /** Successfully recognized text lines. */ - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, - /** Successfully normalized images. */ - IRUT_NORMALIZED_IMAGES = 1 << 26, - /**Detected short lines.*/ - IRUT_SHORT_LINES = 1 << 27, - /**grouped lines of text.*/ - IRUT_TEXT_LINE_GROUPS = 1 << 28, - /** A mask to select all types of intermediate results. */ - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumIntermediateResultUnitType { - /** No intermediate result. */ - long IRUT_NULL = 0L; - /** A full-color image. */ - long IRUT_COLOUR_IMAGE = 1L; - /** A color image that has been scaled down for efficiency. */ - long IRUT_SCALED_DOWN_COLOUR_IMAGE = 1L << 1; - /** A grayscale image derived from the original input. */ - long IRUT_GRAYSCALE_IMAGE = 1L << 2; - /** A grayscale image that has undergone transformation. */ - long IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1L << 3; - /** A grayscale image enhanced for further processing. */ - long IRUT_ENHANCED_GRAYSCALE_IMAGE = 1L << 4; - /** Regions pre-detected as potentially relevant for further analysis. */ - long IRUT_PREDETECTED_REGIONS = 1L << 5; - /** A binary (black and white) image. */ - long IRUT_BINARY_IMAGE = 1L << 6; - /** Results from detecting textures within the image. */ - long IRUT_TEXTURE_DETECTION_RESULT = 1L << 7; - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - long IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1L << 8; - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - long IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1L << 9; - /** Detected contours within the image, which can help in identifying shapes and objects. */ - long IRUT_CONTOURS = 1L << 10; - /** Detected line segments, useful in structural analysis of the image content. */ - long IRUT_LINE_SEGMENTS = 1L << 11; - /** Identified text zones, indicating areas with potential textual content. */ - long IRUT_TEXT_ZONES = 1L << 12; - /** A binary image with text regions removed. */ - long IRUT_TEXT_REMOVED_BINARY_IMAGE = 1L << 13; - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - long IRUT_CANDIDATE_BARCODE_ZONES = 1L << 14; - /** Barcodes that have been localized but not yet decoded. */ - long IRUT_LOCALIZED_BARCODES = 1L << 15; - /** Barcode images scaled up for improved readability or decoding accuracy. */ - long IRUT_SCALED_UP_BARCODE_IMAGE = 1L << 16; - /** Images of barcodes processed to resist deformation and improve decoding success. */ - long IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1L << 17; - /** Barcode images that have been complemented. */ - long IRUT_COMPLEMENTED_BARCODE_IMAGE = 1L << 18; - /** Successfully decoded barcodes. */ - long IRUT_DECODED_BARCODES = 1L << 19; - /** Detected long lines. */ - long IRUT_LONG_LINES = 1L << 20; - /** Detected corners within the image. */ - long IRUT_CORNERS = 1L << 21; - /** Candidate edges identified as potential components of quadrilaterals. */ - long IRUT_CANDIDATE_QUAD_EDGES = 1L << 22; - /** Successfully detected quadrilaterals. */ - long IRUT_DETECTED_QUADS = 1L << 23; - /** Text lines that have been localized in preparation for recognition. */ - long IRUT_LOCALIZED_TEXT_LINES = 1L << 24; - /** Successfully recognized text lines. */ - long IRUT_RECOGNIZED_TEXT_LINES = 1L << 25; - /** Successfully normalized images. */ - long IRUT_NORMALIZED_IMAGES = 1L << 26; - /** Detected short lines. */ - long IRUT_SHORT_LINES = 1L << 27; - /** A mask to select all types of intermediate results. */ - long IRUT_ALL = 0xFFFFFFFL; -} -``` -> -```objc -typedef NS_OPTIONS(NSUInteger, DSIntermediateResultUnitType) { - /** No intermediate result. */ - DSIntermediateResultUnitTypeNull = 0, - /** A full-color image. */ - DSIntermediateResultUnitTypeColourImage = 1, - /** A color image that has been scaled down for efficiency. */ - DSIntermediateResultUnitTypeScaledDownColourImage = 1 << 1, - /** A grayscale image derived from the original input. */ - DSIntermediateResultUnitTypeGrayscaleImage = 1 << 2, - /** A grayscale image that has undergone transformation. */ - DSIntermediateResultUnitTypeTransformedGrayscaleImage = 1 << 3, - /** A grayscale image enhanced for further processing. */ - DSIntermediateResultUnitTypeEnhancedGrayscaleImage = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - DSIntermediateResultUnitTypePredetectedRegions = 1 << 5, - /** A binary (black and white) image. */ - DSIntermediateResultUnitTypeBinaryImage = 1 << 6, - /** Results from detecting textures within the image. */ - DSIntermediateResultUnitTypeTextureDetectionResult = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - DSIntermediateResultUnitTypeTextureRemovedGrayscaleImage = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - DSIntermediateResultUnitTypeTextureRemovedBinaryImage = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - DSIntermediateResultUnitTypeContours = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - DSIntermediateResultUnitTypeLineSegments = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - DSIntermediateResultUnitTypeTextZones = 1 << 12, - /** A binary image with text regions removed. */ - DSIntermediateResultUnitTypeTextRemovedBinaryImage = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - DSIntermediateResultUnitTypeCandidateBarcodeZones = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - DSIntermediateResultUnitTypeLocalizedBarcodes = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - DSIntermediateResultUnitTypeScaledUpBarcodeImage = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - DSIntermediateResultUnitTypeDeformationResistedBarcodeImage = 1 << 17, - /** Barcode images that have been complemented. */ - DSIntermediateResultUnitTypeComplementedBarcodeImage = 1 << 18, - /** Successfully decoded barcodes. */ - DSIntermediateResultUnitTypeDecodedBarcodes = 1 << 19, - /** Detected long lines. */ - DSIntermediateResultUnitTypeLongLines = 1 << 20, - /** Detected corners within the image. */ - DSIntermediateResultUnitTypeCorners = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - DSIntermediateResultUnitTypeCandidateQuadEdges = 1 << 22, - /** Successfully detected quadrilaterals. */ - DSIntermediateResultUnitTypeDetectedQuads = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - DSIntermediateResultUnitTypeLocalizedTextLines = 1 << 24, - /** Successfully recognized text lines. */ - DSIntermediateResultUnitTypeRecognizedTextLines = 1 << 25, - /** Successfully normalized images. */ - DSIntermediateResultUnitTypeNormalizedImages = 1 << 26, - /** Detected short lines. */ - DSIntermediateResultUnitTypeShortLines = 1 << 27, - /** A mask to select all types of intermediate results. */ - DSIntermediateResultUnitTypeAll = 0xFFFFFFF -}; -``` -> -```swift -public enum IntermediateResultUnitType: Int { - /** No intermediate result. */ - case null = 0 - /** A full-color image. */ - case colourImage = 1 - /** A color image that has been scaled down for efficiency. */ - case scaledDownColourImage = 1 << 1 - /** A grayscale image derived from the original input. */ - case grayscaleImage = 1 << 2 - /** A grayscale image that has undergone transformation. */ - case transformedGrayscaleImage = 1 << 3 - /** A grayscale image enhanced for further processing. */ - case enhancedGrayscaleImage = 1 << 4 - /** Regions pre-detected as potentially relevant for further analysis. */ - case predetectedRegions = 1 << 5 - /** A binary (black and white) image. */ - case binaryImage = 1 << 6 - /** Results from detecting textures within the image. */ - case textureDetectionResult = 1 << 7 - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - case textureRemovedGrayscaleImage = 1 << 8 - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - case textureRemovedBinaryImage = 1 << 9 - /** Detected contours within the image, which can help in identifying shapes and objects. */ - case contours = 1 << 10 - /** Detected line segments, useful in structural analysis of the image content. */ - case lineSegments = 1 << 11 - /** Identified text zones, indicating areas with potential textual content. */ - case textZones = 1 << 12 - /** A binary image with text regions removed. */ - case textRemovedBinaryImage = 1 << 13 - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - case candidateBarcodeZones = 1 << 14 - /** Barcodes that have been localized but not yet decoded. */ - case localizedBarcodes = 1 << 15 - /** Barcode images scaled up for improved readability or decoding accuracy. */ - case scaledUpBarcodeImage = 1 << 16 - /** Images of barcodes processed to resist deformation and improve decoding success. */ - case deformationResistedBarcodeImage = 1 << 17 - /** Barcode images that have been complemented. */ - case complementedBarcodeImage = 1 << 18 - /** Successfully decoded barcodes. */ - case decodedBarcodes = 1 << 19 - /** Detected long lines. */ - case longLines = 1 << 20 - /** Detected corners within the image. */ - case corners = 1 << 21 - /** Candidate edges identified as potential components of quadrilaterals. */ - case candidateQuadEdges = 1 << 22 - /** Successfully detected quadrilaterals. */ - case detectedQuads = 1 << 23 - /** Text lines that have been localized in preparation for recognition. */ - case localizedTextLines = 1 << 24 - /** Successfully recognized text lines. */ - case recognizedTextLines = 1 << 25 - /** Successfully normalized images. */ - case normalizedImages = 1 << 26 - /** Detected short lines. */ - case shortLines = 1 << 27 - /** A mask to select all types of intermediate results. */ - case all = 0xFFFFFFF -} -``` -> -```cpp -enum IntermediateResultUnitType : unsigned long long { - /** No intermediate result. */ - IRUT_NULL = 0, - /** A full-color image. */ - IRUT_COLOUR_IMAGE = 1, - /** A color image that has been scaled down for efficiency. */ - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, - /** A grayscale image derived from the original input. */ - IRUT_GRAYSCALE_IMAGE = 1 << 2, - /** A grayscale image that has undergone transformation. */ - IRUT_TRANSFORMED_GRAYSCALE_IMAGE = 1 << 3, - /** A grayscale image enhanced for further processing. */ - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - IRUT_PREDETECTED_REGIONS = 1 << 5, - /** A binary (black and white) image. */ - IRUT_BINARY_IMAGE = 1 << 6, - /** Results from detecting textures within the image. */ - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - IRUT_CONTOURS = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - IRUT_LINE_SEGMENTS = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - IRUT_TEXT_ZONES = 1 << 12, - /** A binary image with text regions removed. */ - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - IRUT_LOCALIZED_BARCODES = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, - /** Barcode images that have been complemented. */ - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, - /** Successfully decoded barcodes. */ - IRUT_DECODED_BARCODES = 1 << 19, - /** Detected long lines. */ - IRUT_LONG_LINES = 1 << 20, - /** Detected corners within the image. */ - IRUT_CORNERS = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, - /** Successfully detected quadrilaterals. */ - IRUT_DETECTED_QUADS = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - IRUT_LOCALIZED_TEXT_LINES = 1 << 24, - /** Successfully recognized text lines. */ - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, - /** Successfully normalized images. */ - IRUT_NORMALIZED_IMAGES = 1 << 26, - /** Detected short lines. */ - IRUT_SHORT_LINES = 1 << 27, - /** Recognized raw text lines. */ - IRUT_RAW_TEXT_LINES = 1 << 28, - /** A mask to select all types of intermediate results. */ - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -}; -``` diff --git a/enums/core/intermediate-result-unit-type-v2.4.2200.md b/enums/core/intermediate-result-unit-type-v2.4.2200.md deleted file mode 100644 index 0d06a16..0000000 --- a/enums/core/intermediate-result-unit-type-v2.4.2200.md +++ /dev/null @@ -1,360 +0,0 @@ ---- -layout: default-layout -title: IntermediateResultUnitType - Dynamsoft Core Enumerations -description: The enumeration IntermediateResultUnitType of Dynamsoft Core describes the type of the intermediate result unit. -keywords: Intermediate result unit type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: IntermediateResultUnitType -codeAutoHeight: true ---- - -# Enumeration IntermediateResultUnitType - -`IntermediateResultUnitType` defines different types of intermediate results generated or expected to be generated during image processing. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - > -> -```javascript -enum EnumIntermediateResultUnitType { - /** No intermediate result. */ - IRUT_NULL = 0, - /** A full-color image. */ - IRUT_COLOUR_IMAGE = 1, - /** A color image that has been scaled down for efficiency. */ - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, - /** A grayscale image derived from the original input. */ - IRUT_GRAYSCALE_IMAGE = 1 << 2, - /** A grayscale image that has undergone transformation. */ - IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1 << 3, - /** A grayscale image enhanced for further processing. */ - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - IRUT_PREDETECTED_REGIONS = 1 << 5, - /** A binary (black and white) image. */ - IRUT_BINARY_IMAGE = 1 << 6, - /** Results from detecting textures within the image. */ - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - IRUT_CONTOURS = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - IRUT_LINE_SEGMENTS = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - IRUT_TEXT_ZONES = 1 << 12, - /** A binary image with text regions removed. */ - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - IRUT_LOCALIZED_BARCODES = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, - /** Barcode images that have been complemented. */ - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, - /** Successfully decoded barcodes. */ - IRUT_DECODED_BARCODES = 1 << 19, - /** Detected long lines. */ - IRUT_LONG_LINES = 1 << 20, - /** Detected corners within the image. */ - IRUT_CORNERS = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, - /** Successfully detected quadrilaterals. */ - IRUT_DETECTED_QUADS = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - IRUT_LOCALIZED_TEXT_LINES = 1 << 24, - /** Successfully recognized text lines. */ - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, - /** Successfully normalized images. */ - IRUT_NORMALIZED_IMAGES = 1 << 26, - /**Detected short lines.*/ - IRUT_SHORT_LINES = 1 << 27, - /**grouped lines of text.*/ - IRUT_TEXT_LINE_GROUPS = 1 << 28, - /** A mask to select all types of intermediate results. */ - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumIntermediateResultUnitType { - /** No intermediate result. */ - long IRUT_NULL = 0L; - /** A full-color image. */ - long IRUT_COLOUR_IMAGE = 1L; - /** A color image that has been scaled down for efficiency. */ - long IRUT_SCALED_DOWN_COLOUR_IMAGE = 1L << 1; - /** A grayscale image derived from the original input. */ - long IRUT_GRAYSCALE_IMAGE = 1L << 2; - /** A grayscale image that has undergone transformation. */ - long IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1L << 3; - /** A grayscale image enhanced for further processing. */ - long IRUT_ENHANCED_GRAYSCALE_IMAGE = 1L << 4; - /** Regions pre-detected as potentially relevant for further analysis. */ - long IRUT_PREDETECTED_REGIONS = 1L << 5; - /** A binary (black and white) image. */ - long IRUT_BINARY_IMAGE = 1L << 6; - /** Results from detecting textures within the image. */ - long IRUT_TEXTURE_DETECTION_RESULT = 1L << 7; - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - long IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1L << 8; - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - long IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1L << 9; - /** Detected contours within the image, which can help in identifying shapes and objects. */ - long IRUT_CONTOURS = 1L << 10; - /** Detected line segments, useful in structural analysis of the image content. */ - long IRUT_LINE_SEGMENTS = 1L << 11; - /** Identified text zones, indicating areas with potential textual content. */ - long IRUT_TEXT_ZONES = 1L << 12; - /** A binary image with text regions removed. */ - long IRUT_TEXT_REMOVED_BINARY_IMAGE = 1L << 13; - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - long IRUT_CANDIDATE_BARCODE_ZONES = 1L << 14; - /** Barcodes that have been localized but not yet decoded. */ - long IRUT_LOCALIZED_BARCODES = 1L << 15; - /** Barcode images scaled up for improved readability or decoding accuracy. */ - long IRUT_SCALED_UP_BARCODE_IMAGE = 1L << 16; - /** Images of barcodes processed to resist deformation and improve decoding success. */ - long IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1L << 17; - /** Barcode images that have been complemented. */ - long IRUT_COMPLEMENTED_BARCODE_IMAGE = 1L << 18; - /** Successfully decoded barcodes. */ - long IRUT_DECODED_BARCODES = 1L << 19; - /** Detected long lines. */ - long IRUT_LONG_LINES = 1L << 20; - /** Detected corners within the image. */ - long IRUT_CORNERS = 1L << 21; - /** Candidate edges identified as potential components of quadrilaterals. */ - long IRUT_CANDIDATE_QUAD_EDGES = 1L << 22; - /** Successfully detected quadrilaterals. */ - long IRUT_DETECTED_QUADS = 1L << 23; - /** Text lines that have been localized in preparation for recognition. */ - long IRUT_LOCALIZED_TEXT_LINES = 1L << 24; - /** Successfully recognized text lines. */ - long IRUT_RECOGNIZED_TEXT_LINES = 1L << 25; - /** Successfully normalized images. */ - long IRUT_NORMALIZED_IMAGES = 1L << 26; - /** Detected short lines. */ - long IRUT_SHORT_LINES = 1L << 27; - /** Recognized raw text lines. */ - public static final long IRUT_RAW_TEXT_LINES = 1 << 28; - /** A mask to select all types of intermediate results. */ - long IRUT_ALL = 0xFFFFFFFFFFFFFFFF; -} -``` -> -```objc -typedef NS_OPTIONS(NSUInteger, DSIntermediateResultUnitType) { - /** No intermediate result. */ - DSIntermediateResultUnitTypeNull = 0, - /** A full-color image. */ - DSIntermediateResultUnitTypeColourImage = 1, - /** A color image that has been scaled down for efficiency. */ - DSIntermediateResultUnitTypeScaledDownColourImage = 1 << 1, - /** A grayscale image derived from the original input. */ - DSIntermediateResultUnitTypeGrayscaleImage = 1 << 2, - /** A grayscale image that has undergone transformation. */ - DSIntermediateResultUnitTypeTransformedGrayscaleImage = 1 << 3, - /** A grayscale image enhanced for further processing. */ - DSIntermediateResultUnitTypeEnhancedGrayscaleImage = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - DSIntermediateResultUnitTypePredetectedRegions = 1 << 5, - /** A binary (black and white) image. */ - DSIntermediateResultUnitTypeBinaryImage = 1 << 6, - /** Results from detecting textures within the image. */ - DSIntermediateResultUnitTypeTextureDetectionResult = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - DSIntermediateResultUnitTypeTextureRemovedGrayscaleImage = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - DSIntermediateResultUnitTypeTextureRemovedBinaryImage = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - DSIntermediateResultUnitTypeContours = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - DSIntermediateResultUnitTypeLineSegments = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - DSIntermediateResultUnitTypeTextZones = 1 << 12, - /** A binary image with text regions removed. */ - DSIntermediateResultUnitTypeTextRemovedBinaryImage = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - DSIntermediateResultUnitTypeCandidateBarcodeZones = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - DSIntermediateResultUnitTypeLocalizedBarcodes = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - DSIntermediateResultUnitTypeScaledUpBarcodeImage = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - DSIntermediateResultUnitTypeDeformationResistedBarcodeImage = 1 << 17, - /** Barcode images that have been complemented. */ - DSIntermediateResultUnitTypeComplementedBarcodeImage = 1 << 18, - /** Successfully decoded barcodes. */ - DSIntermediateResultUnitTypeDecodedBarcodes = 1 << 19, - /** Detected long lines. */ - DSIntermediateResultUnitTypeLongLines = 1 << 20, - /** Detected corners within the image. */ - DSIntermediateResultUnitTypeCorners = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - DSIntermediateResultUnitTypeCandidateQuadEdges = 1 << 22, - /** Successfully detected quadrilaterals. */ - DSIntermediateResultUnitTypeDetectedQuads = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - DSIntermediateResultUnitTypeLocalizedTextLines = 1 << 24, - /** Successfully recognized text lines. */ - DSIntermediateResultUnitTypeRecognizedTextLines = 1 << 25, - /** Successfully normalized images. */ - DSIntermediateResultUnitTypeNormalizedImages = 1 << 26, - /** Detected short lines. */ - DSIntermediateResultUnitTypeShortLines = 1 << 27, - /** Recognized raw text lines. */ - DSIntermediateResultUnitTypeRawTextLines = 1 << 28, - /** A mask to select all types of intermediate results. */ - DSIntermediateResultUnitTypeAll = 0xFFFFFFFFFFFFFFFF -}; -``` -> -```swift -public enum IntermediateResultUnitType: Int { - /** No intermediate result. */ - case null = 0 - /** A full-color image. */ - case colourImage = 1 - /** A color image that has been scaled down for efficiency. */ - case scaledDownColourImage = 1 << 1 - /** A grayscale image derived from the original input. */ - case grayscaleImage = 1 << 2 - /** A grayscale image that has undergone transformation. */ - case transformedGrayscaleImage = 1 << 3 - /** A grayscale image enhanced for further processing. */ - case enhancedGrayscaleImage = 1 << 4 - /** Regions pre-detected as potentially relevant for further analysis. */ - case predetectedRegions = 1 << 5 - /** A binary (black and white) image. */ - case binaryImage = 1 << 6 - /** Results from detecting textures within the image. */ - case textureDetectionResult = 1 << 7 - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - case textureRemovedGrayscaleImage = 1 << 8 - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - case textureRemovedBinaryImage = 1 << 9 - /** Detected contours within the image, which can help in identifying shapes and objects. */ - case contours = 1 << 10 - /** Detected line segments, useful in structural analysis of the image content. */ - case lineSegments = 1 << 11 - /** Identified text zones, indicating areas with potential textual content. */ - case textZones = 1 << 12 - /** A binary image with text regions removed. */ - case textRemovedBinaryImage = 1 << 13 - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - case candidateBarcodeZones = 1 << 14 - /** Barcodes that have been localized but not yet decoded. */ - case localizedBarcodes = 1 << 15 - /** Barcode images scaled up for improved readability or decoding accuracy. */ - case scaledUpBarcodeImage = 1 << 16 - /** Images of barcodes processed to resist deformation and improve decoding success. */ - case deformationResistedBarcodeImage = 1 << 17 - /** Barcode images that have been complemented. */ - case complementedBarcodeImage = 1 << 18 - /** Successfully decoded barcodes. */ - case decodedBarcodes = 1 << 19 - /** Detected long lines. */ - case longLines = 1 << 20 - /** Detected corners within the image. */ - case corners = 1 << 21 - /** Candidate edges identified as potential components of quadrilaterals. */ - case candidateQuadEdges = 1 << 22 - /** Successfully detected quadrilaterals. */ - case detectedQuads = 1 << 23 - /** Text lines that have been localized in preparation for recognition. */ - case localizedTextLines = 1 << 24 - /** Successfully recognized text lines. */ - case recognizedTextLines = 1 << 25 - /** Successfully normalized images. */ - case normalizedImages = 1 << 26 - /** Detected short lines. */ - case shortLines = 1 << 27 - /** Recognized raw text lines. */ - rawTextLines = 1 << 28 - /** A mask to select all types of intermediate results. */ - case all = 0xFFFFFFFFFFFFFFFF -} -``` -> -```cpp -enum IntermediateResultUnitType : unsigned long long -{ - /**No IntermediateResult type is specified.*/ - IRUT_NULL = 0, - /**The type of the IntermediateResult is "colour image".*/ - IRUT_COLOUR_IMAGE = 1, - /**The type of the IntermediateResult is "scaled down colour image".*/ - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, - /**The type of the IntermediateResult is "grayscale image".*/ - IRUT_GRAYSCALE_IMAGE = 1 << 2, - /**The type of the IntermediateResult is "transformed grayscale image".*/ - IRUT_TRANSFORMED_GRAYSCALE_IMAGE = 1 << 3, - /**The type of the IntermediateResult is "enhanced grayscale image".*/ - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, - /**The type of the IntermediateResult is "predected regions".*/ - IRUT_PREDETECTED_REGIONS = 1 << 5, - /**The type of the IntermediateResult is "binary image".*/ - IRUT_BINARY_IMAGE = 1 << 6, - /**The type of the IntermediateResult is "texture detection result".*/ - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, - /**The type of the IntermediateResult is "texture removed grayscale image".*/ - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, - /**The type of the IntermediateResult is "texture removed binary image".*/ - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, - /**The type of the IntermediateResult is "contours".*/ - IRUT_CONTOURS = 1 << 10, - /**The type of the IntermediateResult is "line segments".*/ - IRUT_LINE_SEGMENTS = 1 << 11, - /**The type of the IntermediateResult is "text zones".*/ - IRUT_TEXT_ZONES = 1 << 12, - /**The type of the IntermediateResult is "text removed binary image".*/ - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, - /**The type of the IntermediateResult is "candidate barcode zones".*/ - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, - /**The type of the IntermediateResult is "localized barcodes".*/ - IRUT_LOCALIZED_BARCODES = 1 << 15, - /**The type of the IntermediateResult is "scaled up barcode image".*/ - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, - /**The type of the IntermediateResult is "deformation resisted barcode image".*/ - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, - /**The type of the IntermediateResult is "complemented barcode image".*/ - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, - /**The type of the IntermediateResult is "decoded barcodes".*/ - IRUT_DECODED_BARCODES = 1 << 19, - /**The type of the IntermediateResult is "long lines".*/ - IRUT_LONG_LINES = 1 << 20, - /**The type of the IntermediateResult is "corners".*/ - IRUT_CORNERS = 1 << 21, - /**The type of the IntermediateResult is "candidate quad edges".*/ - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, - /**The type of the IntermediateResult is "detected quads".*/ - IRUT_DETECTED_QUADS = 1 << 23, - /**The type of the IntermediateResult is "localized text lines".*/ - IRUT_LOCALIZED_TEXT_LINES = 1 << 24, - /**The type of the IntermediateResult is "recognized text lines".*/ - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, - /**The type of the IntermediateResult is "normalized image".*/ - IRUT_NORMALIZED_IMAGES = 1 << 26, - /**The type of the IntermediateResult is "short lines".*/ - IRUT_SHORT_LINES = 1 << 27, - /**The type of the IntermediateResult is "text line groups".*/ - IRUT_RAW_TEXT_LINES = 1LL << 28, - /**The type of the IntermediateResult is "all".*/ - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -}; -``` diff --git a/enums/core/intermediate-result-unit-type-v2.5.2100.md b/enums/core/intermediate-result-unit-type-v2.5.2100.md deleted file mode 100644 index ab8702f..0000000 --- a/enums/core/intermediate-result-unit-type-v2.5.2100.md +++ /dev/null @@ -1,427 +0,0 @@ ---- -layout: default-layout -title: IntermediateResultUnitType - Dynamsoft Core Enumerations -description: The enumeration IntermediateResultUnitType of Dynamsoft Core describes the type of the intermediate result unit. -keywords: Intermediate result unit type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: IntermediateResultUnitType -codeAutoHeight: true ---- - -# Enumeration IntermediateResultUnitType - -`IntermediateResultUnitType` defines different types of intermediate results generated or expected to be generated during image processing. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - >- Python - > -> -```javascript -enum EnumIntermediateResultUnitType { - /** No intermediate result. */ - IRUT_NULL = 0, - /** A full-color image. */ - IRUT_COLOUR_IMAGE = 1, - /** A color image that has been scaled down for efficiency. */ - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, - /** A grayscale image derived from the original input. */ - IRUT_GRAYSCALE_IMAGE = 1 << 2, - /** A grayscale image that has undergone transformation. */ - IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1 << 3, - /** A grayscale image enhanced for further processing. */ - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - IRUT_PREDETECTED_REGIONS = 1 << 5, - /** A binary (black and white) image. */ - IRUT_BINARY_IMAGE = 1 << 6, - /** Results from detecting textures within the image. */ - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - IRUT_CONTOURS = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - IRUT_LINE_SEGMENTS = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - IRUT_TEXT_ZONES = 1 << 12, - /** A binary image with text regions removed. */ - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - IRUT_LOCALIZED_BARCODES = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, - /** Barcode images that have been complemented. */ - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, - /** Successfully decoded barcodes. */ - IRUT_DECODED_BARCODES = 1 << 19, - /** Detected long lines. */ - IRUT_LONG_LINES = 1 << 20, - /** Detected corners within the image. */ - IRUT_CORNERS = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, - /** Successfully detected quadrilaterals. */ - IRUT_DETECTED_QUADS = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - IRUT_LOCALIZED_TEXT_LINES = 1 << 24, - /** Successfully recognized text lines. */ - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, - /** Successfully normalized images. */ - IRUT_NORMALIZED_IMAGES = 1 << 26, - /**Detected short lines.*/ - IRUT_SHORT_LINES = 1 << 27, - /**grouped lines of text.*/ - IRUT_TEXT_LINE_GROUPS = 1 << 28, - /** A mask to select all types of intermediate results. */ - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumIntermediateResultUnitType { - /** No intermediate result. */ - long IRUT_NULL = 0L; - /** A full-color image. */ - long IRUT_COLOUR_IMAGE = 1L; - /** A color image that has been scaled down for efficiency. */ - long IRUT_SCALED_DOWN_COLOUR_IMAGE = 1L << 1; - /** A grayscale image derived from the original input. */ - long IRUT_GRAYSCALE_IMAGE = 1L << 2; - /** A grayscale image that has undergone transformation. */ - long IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1L << 3; - /** A grayscale image enhanced for further processing. */ - long IRUT_ENHANCED_GRAYSCALE_IMAGE = 1L << 4; - /** Regions pre-detected as potentially relevant for further analysis. */ - long IRUT_PREDETECTED_REGIONS = 1L << 5; - /** A binary (black and white) image. */ - long IRUT_BINARY_IMAGE = 1L << 6; - /** Results from detecting textures within the image. */ - long IRUT_TEXTURE_DETECTION_RESULT = 1L << 7; - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - long IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1L << 8; - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - long IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1L << 9; - /** Detected contours within the image, which can help in identifying shapes and objects. */ - long IRUT_CONTOURS = 1L << 10; - /** Detected line segments, useful in structural analysis of the image content. */ - long IRUT_LINE_SEGMENTS = 1L << 11; - /** Identified text zones, indicating areas with potential textual content. */ - long IRUT_TEXT_ZONES = 1L << 12; - /** A binary image with text regions removed. */ - long IRUT_TEXT_REMOVED_BINARY_IMAGE = 1L << 13; - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - long IRUT_CANDIDATE_BARCODE_ZONES = 1L << 14; - /** Barcodes that have been localized but not yet decoded. */ - long IRUT_LOCALIZED_BARCODES = 1L << 15; - /** Barcode images scaled up for improved readability or decoding accuracy. */ - long IRUT_SCALED_UP_BARCODE_IMAGE = 1L << 16; - /** Images of barcodes processed to resist deformation and improve decoding success. */ - long IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1L << 17; - /** Barcode images that have been complemented. */ - long IRUT_COMPLEMENTED_BARCODE_IMAGE = 1L << 18; - /** Successfully decoded barcodes. */ - long IRUT_DECODED_BARCODES = 1L << 19; - /** Detected long lines. */ - long IRUT_LONG_LINES = 1L << 20; - /** Detected corners within the image. */ - long IRUT_CORNERS = 1L << 21; - /** Candidate edges identified as potential components of quadrilaterals. */ - long IRUT_CANDIDATE_QUAD_EDGES = 1L << 22; - /** Successfully detected quadrilaterals. */ - long IRUT_DETECTED_QUADS = 1L << 23; - /** Text lines that have been localized in preparation for recognition. */ - long IRUT_LOCALIZED_TEXT_LINES = 1L << 24; - /** Successfully recognized text lines. */ - long IRUT_RECOGNIZED_TEXT_LINES = 1L << 25; - /** Successfully normalized images. */ - long IRUT_NORMALIZED_IMAGES = 1L << 26; - /** Detected short lines. */ - long IRUT_SHORT_LINES = 1L << 27; - /** Recognized raw text lines. */ - public static final long IRUT_RAW_TEXT_LINES = 1 << 28; - /** A mask to select all types of intermediate results. */ - long IRUT_ALL = 0xFFFFFFFFFFFFFFFF; -} -``` -> -```objc -typedef NS_OPTIONS(NSUInteger, DSIntermediateResultUnitType) { - /** No intermediate result. */ - DSIntermediateResultUnitTypeNull = 0, - /** A full-color image. */ - DSIntermediateResultUnitTypeColourImage = 1, - /** A color image that has been scaled down for efficiency. */ - DSIntermediateResultUnitTypeScaledDownColourImage = 1 << 1, - /** A grayscale image derived from the original input. */ - DSIntermediateResultUnitTypeGrayscaleImage = 1 << 2, - /** A grayscale image that has undergone transformation. */ - DSIntermediateResultUnitTypeTransformedGrayscaleImage = 1 << 3, - /** A grayscale image enhanced for further processing. */ - DSIntermediateResultUnitTypeEnhancedGrayscaleImage = 1 << 4, - /** Regions pre-detected as potentially relevant for further analysis. */ - DSIntermediateResultUnitTypePredetectedRegions = 1 << 5, - /** A binary (black and white) image. */ - DSIntermediateResultUnitTypeBinaryImage = 1 << 6, - /** Results from detecting textures within the image. */ - DSIntermediateResultUnitTypeTextureDetectionResult = 1 << 7, - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - DSIntermediateResultUnitTypeTextureRemovedGrayscaleImage = 1 << 8, - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - DSIntermediateResultUnitTypeTextureRemovedBinaryImage = 1 << 9, - /** Detected contours within the image, which can help in identifying shapes and objects. */ - DSIntermediateResultUnitTypeContours = 1 << 10, - /** Detected line segments, useful in structural analysis of the image content. */ - DSIntermediateResultUnitTypeLineSegments = 1 << 11, - /** Identified text zones, indicating areas with potential textual content. */ - DSIntermediateResultUnitTypeTextZones = 1 << 12, - /** A binary image with text regions removed. */ - DSIntermediateResultUnitTypeTextRemovedBinaryImage = 1 << 13, - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - DSIntermediateResultUnitTypeCandidateBarcodeZones = 1 << 14, - /** Barcodes that have been localized but not yet decoded. */ - DSIntermediateResultUnitTypeLocalizedBarcodes = 1 << 15, - /** Barcode images scaled up for improved readability or decoding accuracy. */ - DSIntermediateResultUnitTypeScaledUpBarcodeImage = 1 << 16, - /** Images of barcodes processed to resist deformation and improve decoding success. */ - DSIntermediateResultUnitTypeDeformationResistedBarcodeImage = 1 << 17, - /** Barcode images that have been complemented. */ - DSIntermediateResultUnitTypeComplementedBarcodeImage = 1 << 18, - /** Successfully decoded barcodes. */ - DSIntermediateResultUnitTypeDecodedBarcodes = 1 << 19, - /** Detected long lines. */ - DSIntermediateResultUnitTypeLongLines = 1 << 20, - /** Detected corners within the image. */ - DSIntermediateResultUnitTypeCorners = 1 << 21, - /** Candidate edges identified as potential components of quadrilaterals. */ - DSIntermediateResultUnitTypeCandidateQuadEdges = 1 << 22, - /** Successfully detected quadrilaterals. */ - DSIntermediateResultUnitTypeDetectedQuads = 1 << 23, - /** Text lines that have been localized in preparation for recognition. */ - DSIntermediateResultUnitTypeLocalizedTextLines = 1 << 24, - /** Successfully recognized text lines. */ - DSIntermediateResultUnitTypeRecognizedTextLines = 1 << 25, - /** Successfully normalized images. */ - DSIntermediateResultUnitTypeNormalizedImages = 1 << 26, - /** Detected short lines. */ - DSIntermediateResultUnitTypeShortLines = 1 << 27, - /** Recognized raw text lines. */ - DSIntermediateResultUnitTypeRawTextLines = 1 << 28, - /** A mask to select all types of intermediate results. */ - DSIntermediateResultUnitTypeAll = 0xFFFFFFFFFFFFFFFF -}; -``` -> -```swift -public enum IntermediateResultUnitType: Int { - /** No intermediate result. */ - case null = 0 - /** A full-color image. */ - case colourImage = 1 - /** A color image that has been scaled down for efficiency. */ - case scaledDownColourImage = 1 << 1 - /** A grayscale image derived from the original input. */ - case grayscaleImage = 1 << 2 - /** A grayscale image that has undergone transformation. */ - case transformedGrayscaleImage = 1 << 3 - /** A grayscale image enhanced for further processing. */ - case enhancedGrayscaleImage = 1 << 4 - /** Regions pre-detected as potentially relevant for further analysis. */ - case predetectedRegions = 1 << 5 - /** A binary (black and white) image. */ - case binaryImage = 1 << 6 - /** Results from detecting textures within the image. */ - case textureDetectionResult = 1 << 7 - /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ - case textureRemovedGrayscaleImage = 1 << 8 - /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ - case textureRemovedBinaryImage = 1 << 9 - /** Detected contours within the image, which can help in identifying shapes and objects. */ - case contours = 1 << 10 - /** Detected line segments, useful in structural analysis of the image content. */ - case lineSegments = 1 << 11 - /** Identified text zones, indicating areas with potential textual content. */ - case textZones = 1 << 12 - /** A binary image with text regions removed. */ - case textRemovedBinaryImage = 1 << 13 - /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ - case candidateBarcodeZones = 1 << 14 - /** Barcodes that have been localized but not yet decoded. */ - case localizedBarcodes = 1 << 15 - /** Barcode images scaled up for improved readability or decoding accuracy. */ - case scaledUpBarcodeImage = 1 << 16 - /** Images of barcodes processed to resist deformation and improve decoding success. */ - case deformationResistedBarcodeImage = 1 << 17 - /** Barcode images that have been complemented. */ - case complementedBarcodeImage = 1 << 18 - /** Successfully decoded barcodes. */ - case decodedBarcodes = 1 << 19 - /** Detected long lines. */ - case longLines = 1 << 20 - /** Detected corners within the image. */ - case corners = 1 << 21 - /** Candidate edges identified as potential components of quadrilaterals. */ - case candidateQuadEdges = 1 << 22 - /** Successfully detected quadrilaterals. */ - case detectedQuads = 1 << 23 - /** Text lines that have been localized in preparation for recognition. */ - case localizedTextLines = 1 << 24 - /** Successfully recognized text lines. */ - case recognizedTextLines = 1 << 25 - /** Successfully normalized images. */ - case normalizedImages = 1 << 26 - /** Detected short lines. */ - case shortLines = 1 << 27 - /** Recognized raw text lines. */ - rawTextLines = 1 << 28 - /** A mask to select all types of intermediate results. */ - case all = 0xFFFFFFFFFFFFFFFF -} -``` -> -```cpp -enum IntermediateResultUnitType : unsigned long long -{ - /**No IntermediateResult type is specified.*/ - IRUT_NULL = 0, - /**The type of the IntermediateResult is "colour image".*/ - IRUT_COLOUR_IMAGE = 1, - /**The type of the IntermediateResult is "scaled down colour image".*/ - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, - /**The type of the IntermediateResult is "grayscale image".*/ - IRUT_GRAYSCALE_IMAGE = 1 << 2, - /**The type of the IntermediateResult is "transformed grayscale image".*/ - IRUT_TRANSFORMED_GRAYSCALE_IMAGE = 1 << 3, - /**The type of the IntermediateResult is "enhanced grayscale image".*/ - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, - /**The type of the IntermediateResult is "predected regions".*/ - IRUT_PREDETECTED_REGIONS = 1 << 5, - /**The type of the IntermediateResult is "binary image".*/ - IRUT_BINARY_IMAGE = 1 << 6, - /**The type of the IntermediateResult is "texture detection result".*/ - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, - /**The type of the IntermediateResult is "texture removed grayscale image".*/ - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, - /**The type of the IntermediateResult is "texture removed binary image".*/ - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, - /**The type of the IntermediateResult is "contours".*/ - IRUT_CONTOURS = 1 << 10, - /**The type of the IntermediateResult is "line segments".*/ - IRUT_LINE_SEGMENTS = 1 << 11, - /**The type of the IntermediateResult is "text zones".*/ - IRUT_TEXT_ZONES = 1 << 12, - /**The type of the IntermediateResult is "text removed binary image".*/ - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, - /**The type of the IntermediateResult is "candidate barcode zones".*/ - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, - /**The type of the IntermediateResult is "localized barcodes".*/ - IRUT_LOCALIZED_BARCODES = 1 << 15, - /**The type of the IntermediateResult is "scaled up barcode image".*/ - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, - /**The type of the IntermediateResult is "deformation resisted barcode image".*/ - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, - /**The type of the IntermediateResult is "complemented barcode image".*/ - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, - /**The type of the IntermediateResult is "decoded barcodes".*/ - IRUT_DECODED_BARCODES = 1 << 19, - /**The type of the IntermediateResult is "long lines".*/ - IRUT_LONG_LINES = 1 << 20, - /**The type of the IntermediateResult is "corners".*/ - IRUT_CORNERS = 1 << 21, - /**The type of the IntermediateResult is "candidate quad edges".*/ - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, - /**The type of the IntermediateResult is "detected quads".*/ - IRUT_DETECTED_QUADS = 1 << 23, - /**The type of the IntermediateResult is "localized text lines".*/ - IRUT_LOCALIZED_TEXT_LINES = 1 << 24, - /**The type of the IntermediateResult is "recognized text lines".*/ - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, - /**The type of the IntermediateResult is "normalized image".*/ - IRUT_NORMALIZED_IMAGES = 1 << 26, - /**The type of the IntermediateResult is "short lines".*/ - IRUT_SHORT_LINES = 1 << 27, - /**The type of the IntermediateResult is "text line groups".*/ - IRUT_RAW_TEXT_LINES = 1LL << 28, - /**The type of the IntermediateResult is "all".*/ - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -}; -``` -> -```python -class EnumIntermediateResultUnitType(IntEnum): - # No IntermediateResult type is specified. - IRUT_NULL = 0 - # The type of the IntermediateResult is "colour image". - IRUT_COLOUR_IMAGE = 1 - # The type of the IntermediateResult is "scaled down colour image". - IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1 - # The type of the IntermediateResult is "grayscale image". - IRUT_GRAYSCALE_IMAGE = 1 << 2 - # The type of the IntermediateResult is "transformed grayscale image". - IRUT_TRANSFORMED_GRAYSCALE_IMAGE = 1 << 3 - # The type of the IntermediateResult is "enhanced grayscale image". - IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4 - # The type of the IntermediateResult is "predected regions". - IRUT_PREDETECTED_REGIONS = 1 << 5 - # The type of the IntermediateResult is "binary image". - IRUT_BINARY_IMAGE = 1 << 6 - # The type of the IntermediateResult is "texture detection result". - IRUT_TEXTURE_DETECTION_RESULT = 1 << 7 - # The type of the IntermediateResult is "texture removed grayscale image". - IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8 - # The type of the IntermediateResult is "texture removed binary image". - IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9 - # The type of the IntermediateResult is "contours". - IRUT_CONTOURS = 1 << 10 - # The type of the IntermediateResult is "line segments". - IRUT_LINE_SEGMENTS = 1 << 11 - # The type of the IntermediateResult is "text zones". - IRUT_TEXT_ZONES = 1 << 12 - # The type of the IntermediateResult is "text removed binary image". - IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13 - # The type of the IntermediateResult is "candidate barcode zones". - IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14 - # The type of the IntermediateResult is "localized barcodes". - IRUT_LOCALIZED_BARCODES = 1 << 15 - # The type of the IntermediateResult is "scaled up barcode image". - IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16 - # The type of the IntermediateResult is "deformation resisted barcode image". - IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17 - # The type of the IntermediateResult is "complemented barcode image". - IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18 - # The type of the IntermediateResult is "decoded barcodes". - IRUT_DECODED_BARCODES = 1 << 19 - # The type of the IntermediateResult is "long lines". - IRUT_LONG_LINES = 1 << 20 - # The type of the IntermediateResult is "corners". - IRUT_CORNERS = 1 << 21 - # The type of the IntermediateResult is "candidate quad edges". - IRUT_CANDIDATE_QUAD_EDGES = 1 << 22 - # The type of the IntermediateResult is "detected quads". - IRUT_DETECTED_QUADS = 1 << 23 - # The type of the IntermediateResult is "localized text lines". - IRUT_LOCALIZED_TEXT_LINES = 1 << 24 - # The type of the IntermediateResult is "recognized text lines". - IRUT_RECOGNIZED_TEXT_LINES = 1 << 25 - # The type of the IntermediateResult is "normalized image". - IRUT_NORMALIZED_IMAGES = 1 << 26 - # The type of the IntermediateResult is "short lines". - IRUT_SHORT_LINES = 1 << 27 - # The type of the IntermediateResult is "text line groups". - IRUT_RAW_TEXT_LINES = 1LL << 28 - # The type of the IntermediateResult is "all". - IRUT_ALL = 0xFFFFFFFFFFFFFFFF -``` diff --git a/enums/core/region-object-element-type-v2.4.2100.md b/enums/core/region-object-element-type-v2.4.2100.md deleted file mode 100644 index 3c80eff..0000000 --- a/enums/core/region-object-element-type-v2.4.2100.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -layout: default-layout -title: RegionObjectElementType - Dynamsoft Core Enumerations -description: The enumeration RegionObjectElementType of Dynamsoft Core describes the types of RegionObjectElement. -keywords: Region object element type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: RegionObjectElementType -codeAutoHeight: true ---- - -# Enumeration RegionObjectElementType - -`RegionObjectElementType` specifies the exact subclass type within the `RegionObjectElement` hierarchy. This enumeration facilitates the identification and differentiation of various processed elements in an image. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - > -> -```javascript -enum EnumRegionObjectElementType { - /** - * Corresponds to the `PredetectedRegionElement` subclass, representing areas within the image identified as potentially significant - * for further analysis before detailed processing. - */ - ROET_PREDETECTED_REGION = 0, - /** Corresponds to the `LocalizedBarcodeElement` subclass, indicating areas where barcodes have been localized within the image.*/ - ROET_LOCALIZED_BARCODE = 1, - /** Corresponds to the `DecodedBarcodeElement` subclass, signifying barcodes that have not only been localized but also successfully decoded. */ - ROET_DECODED_BARCODE = 2, - /** Corresponds to the `LocalizedTextLineElement` subclass, indicating lines of text that have been localized within the image. */ - ROET_LOCALIZED_TEXT_LINE = 3, - /** Corresponds to the `RecognizedTextLineElement` subclass, referring to text lines that have been recognized. */ - ROET_RECOGNIZED_TEXT_LINE = 4, - /** Corresponds to the `DetectedQuadElement` subclass, representing quadrilateral shapes detected within the image. */ - ROET_DETECTED_QUAD = 5, - /** Corresponds to the `NormalizedImageElement` subclass, referring to images that have been normalized. */ - ROET_NORMALIZED_IMAGE = 6 -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumRegionObjectElementType -{ - /**The type of subclass PredetectedRegionElement.*/ - public static final int ROET_PREDETECTED_REGION = 0; - /**The type of subclass LocalizedBarcodeElement.*/ - public static final int ROET_LOCALIZED_BARCODE = 1; - /**The type of subclass DecodedBarcodeElement.*/ - public static final int ROET_DECODED_BARCODE = 2; - /**The type of subclass LocalizedTextLineElement.*/ - public static final int ROET_LOCALIZED_TEXT_LINE = 3; - /**The type of subclass RecognizedTextLineElement.*/ - public static final int ROET_RECOGNIZED_TEXT_LINE = 4; - /**The type of subclass DetectedQuadElement.*/ - public static final int ROET_DETECTED_QUAD = 5; - /**The type of subclass NormalizedImageElement.*/ - public static final int ROET_NORMALIZED_IMAGE = 6; -} -``` -> -```objc -typedef NS_ENUM(NSInteger, DSRegionObjectElementType) -{ - /**The type of subclass PredetectedRegionElement.*/ - DSRegionObjectElementTypePredetectedRegion = 0, - /**The type of subclass LocalizedBarcodeElement.*/ - DSRegionObjectElementTypeLocalizedBarcode = 1, - /**The type of subclass DecodedBarcodeElement.*/ - DSRegionObjectElementTypeDecodedBarcode = 2, - /**The type of subclass LocalizedTextLineElement.*/ - DSRegionObjectElementTypeLocalizedTextLine = 3, - /**The type of subclass RecognizedTextLineElement.*/ - DSRegionObjectElementTypeRecognizedTextLine = 4, - /**The type of subclass DetectedQuadElement.*/ - DSRegionObjectElementTypeDetectedQuad = 5, - /**The type of subclass NormalizedImageElement.*/ - DSRegionObjectElementTypeNormalizedImage = 6 -}; -``` -> -```swift -public enum RegionObjectElementType : Int -{ - /**The type of subclass PredetectedRegionElement.*/ - predetectedRegion = 0, - /**The type of subclass LocalizedBarcodeElement.*/ - localizedBarcode = 1, - /**The type of subclass DecodedBarcodeElement.*/ - decodedBarcode = 2, - /**The type of subclass LocalizedTextLineElement.*/ - localizedTextLine = 3, - /**The type of subclass RecognizedTextLineElement.*/ - recognizedTextLine = 4, - /**The type of subclass DetectedQuadElement.*/ - detectedQuad = 5, - /**The type of subclass NormalizedImageElement.*/ - normalizedImage = 6 -} -``` -> -```cpp -typedef enum RegionObjectElementType -{ - /**The type of subclass PredetectedRegionElement.*/ - ROET_PREDETECTED_REGION, - /**The type of subclass LocalizedBarcodeElement.*/ - ROET_LOCALIZED_BARCODE, - /**The type of subclass DecodedBarcodeElement.*/ - ROET_DECODED_BARCODE, - /**The type of subclass LocalizedTextLineElement.*/ - ROET_LOCALIZED_TEXT_LINE, - /**The type of subclass RecognizedTextLineElement.*/ - ROET_RECOGNIZED_TEXT_LINE, - /**The type of subclass DetectedQuadElement.*/ - ROET_DETECTED_QUAD, - /**The type of subclass NormalizedImageElement.*/ - ROET_NORMALIZED_IMAGE, - /**The type of subclass SourceImageElement.*/ - ROET_SOURCE_IMAGE, - /**The type of subclass TargetROIElement.*/ - ROET_TARGET_ROI -} RegionObjectElementType; -``` diff --git a/enums/core/section-type-v2.4.2100.md b/enums/core/section-type-v2.4.2100.md deleted file mode 100644 index 8a40ce3..0000000 --- a/enums/core/section-type-v2.4.2100.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -layout: default-layout -title: SectionType - Dynamsoft Core Enumerations -description: The enumeration SectionType of Dynamsoft Core describes the section of the algorithm. -keywords: Section type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: SectionType -codeAutoHeight: true ---- - -# Enumeration SectionType - -`SectionType` categorizes the distinct segments within the image processing algorithm, pinpointing the exact phase responsible for generating a specific `IntermediateResult`. - - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - > -> -```javascript -enum EnumSectionType { - /** Indicates that no specific section type has been specified. */ - ST_NULL = 0, - /** Corresponds to results generated in the "region prediction" section. */ - ST_REGION_PREDETECTION = 1, - /** Corresponds to results generated in the "barcode localization" section. */ - ST_BARCODE_LOCALIZATION = 2, - /** Corresponds to results generated in the "barcode decoding" section. */ - ST_BARCODE_DECODING = 3, - /** Corresponds to results generated in the "text line localization" section. */ - ST_TEXT_LINE_LOCALIZATION = 4, - /** Corresponds to results generated in the "text line recognition" section. */ - ST_TEXT_LINE_RECOGNITION = 5, - /** Corresponds to results generated in the "document detection" section. */ - ST_DOCUMENT_DETECTION = 6, - /** Corresponds to results generated in the "document normalization" section. */ - ST_DOCUMENT_NORMALIZATION = 7 -} -``` -> -```java -@Retention(RetentionPolicy.CLASS) -public @interface EnumSectionType -{ - /**No section type is specified.*/ - public static final int ST_NULL = 0; - /**The result is output by "region prediction" section.*/ - public static final int ST_REGION_PREDETECTION = 1; - /**The result is output by "barcode localization" section.*/ - public static final int ST_BARCODE_LOCALIZATION = 2; - /**The result is output by "barcode decoding" section.*/ - public static final int ST_BARCODE_DECODING = 3; - /**The result is output by "text line localization" section.*/ - public static final int ST_TEXT_LINE_LOCALIZATION = 4; - /**The result is output by "text line recognition" section.*/ - public static final int ST_TEXT_LINE_RECOGNITION = 5; - /**The result is output by "document detection" section.*/ - public static final int ST_DOCUMENT_DETECTION = 6; - /**The result is output by "document normalization" section.*/ - public static final int ST_DOCUMENT_NORMALIZATION = 7; -} -``` -> -```objc -typedef NS_ENUM(NSInteger, DSSectionType) -{ - /**No section type is specified.*/ - DSSectionTypeNull = 0, - /**The result is output by "region prediction" section.*/ - DSSectionTypeRegionPredection = 1, - /**The result is output by "barcode localization" section.*/ - DSSectionTypeBarcodeLocalization = 2, - /**The result is output by "barcode decoding" section.*/ - DSSectionTypeBarcodeDecoding = 3, - /**The result is output by "text line localization" section.*/ - DSSectionTypeTextLineLocalization = 4, - /**The result is output by "text line recognition" section.*/ - DSSectionTypeTextLineRecognition = 5, - /**The result is output by "document detection" section.*/ - DSSectionTypeDocumentDetection = 6, - /**The result is output by "document normalization" section.*/ - DSSectionTypeDocumentNormalization = 7 -}; -``` -> -```swift -public enum SectionType : Int -{ - /**No section type is specified.*/ - null = 0, - /**The result is output by "region prediction" section.*/ - regionPredection = 1, - /**The result is output by "barcode localization" section.*/ - barcodeLocalization = 2, - /**The result is output by "barcode decoding" section.*/ - barcodeDecoding = 3, - /**The result is output by "text line localization" section.*/ - textLineLocalization = 4, - /**The result is output by "text line recognition" section.*/ - textLineRecognition = 5, - /**The result is output by "document detection" section.*/ - documentDetection = 6, - /**The result is output by "document normalization" section.*/ - documentNormalization = 7 -} -``` -> -```cpp -typedef enum SectionType -{ - /**No section type is specified.*/ - ST_NULL, - /**The result is output by "region prediction" section.*/ - ST_REGION_PREDETECTION, - /**The result is output by "barcode localization" section.*/ - ST_BARCODE_LOCALIZATION, - /**The result is output by "barcode decoding" section.*/ - ST_BARCODE_DECODING, - /**The result is output by "text line localization" section.*/ - ST_TEXT_LINE_LOCALIZATION, - /**The result is output by "text line recognition" section.*/ - ST_TEXT_LINE_RECOGNITION, - /**The result is output by "document detection" section.*/ - ST_DOCUMENT_DETECTION, - /**The result is output by "document normalization" section.*/ - ST_DOCUMENT_NORMALIZATION, -} SectionType; -``` diff --git a/enums/core/transform-matrix-type-v2.4.2100.md b/enums/core/transform-matrix-type-v2.4.2100.md deleted file mode 100644 index 50f5e12..0000000 --- a/enums/core/transform-matrix-type-v2.4.2100.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -layout: default-layout -title: TransformMatrixType - Dynamsoft Core Enumerations -description: The enumeration TransformMatrixType of Dynamsoft Core describes transform matrix types. -keywords: Target type -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: TransformMatrixType ---- - -# Enumeration TransformMatrixType - -`TransformMatrixType` describes the transform matrix types. - -
    - >- JavaScript - >- Android - >- Objective-C - >- Swift - >- C++ - > -> -```javascript -enum EnumTransformMatrixType { - /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ - TMT_LOCAL_TO_ORIGINAL_IMAGE, - /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ - TMT_ORIGINAL_TO_LOCAL_IMAGE -} -``` -> -```java -public @interface EnumTransformMatrixType { - /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ - int TMT_LOCAL_TO_ORIGINAL_IMAGE = 0; - /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ - int TMT_ORIGINAL_TO_LOCAL_IMAGE = 1; - /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ - int TMT_ROTATED_TO_ORIGINAL_IMAGE = 2; - /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ - int TMT_ORIGINAL_TO_ROTATED_IMAGE = 3; -} -``` -> -```objc -typedef NS_ENUM(NSInteger, DSTransformMatrixType) -{ - /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ - DSTransformMatrixTypeLocalToOriginalImage = 0, - /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ - DSTransformMatrixTypeOriginalToLocalImage = 1, - /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ - DSTransformMatrixTypeRotatedToOriginalImage = 2, - /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ - DSTransformMatrixTypeOriginalToRotatedImage = 3 -}NS_SWIFT_NAME(TransformMatrixType); -``` -> -```swift -public enum TransformMatrixType : Int -{ - /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ - localToOriginalImage = 0, - /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ - originalToLocalImage = 1, - /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ - rotatedToOriginalImage = 2, - /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ - originalToRotatedImage = 3 -} -``` -> -```cpp -typedef enum TransformMatrixType -{ - /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ - TMT_LOCAL_TO_ORIGINAL_IMAGE, - /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ - TMT_ORIGINAL_TO_LOCAL_IMAGE, - /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ - TMT_ROTATED_TO_ORIGINAL_IMAGE, - /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ - TMT_ORIGINAL_TO_ROTATED_IMAGE -} TransformMatrixType; -``` diff --git a/enums/label-recognizer/raw-text-line-status-v2.4.2100.md b/enums/label-recognizer/raw-text-line-status-v2.4.2100.md deleted file mode 100644 index 04c8a8e..0000000 --- a/enums/label-recognizer/raw-text-line-status-v2.4.2100.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: default-layout -title: RawTextLineStatus - Dynamsoft LabelRecognizer Enumerations -description: The enumeration RawTextLineStatus of Dynamsoft LabelRecognizer describes the final status of a raw text line. -keywords: Raw Text Line Status -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: RawTextLineStatus -codeAutoHeight: true ---- - -# Enumeration RawTextLineStatus - -`RawTextLineStatus` enumerates the final status of a raw text line. - -
    - >- JavaScript - >- C++ - >- Python - > -> -```javascript -enum EnumRawTextLineStatus -{ - /** Localized but recognition not performed. */ - RTLS_LOCALIZED = 0 , - /** Recognition failed. */ - RTLS_RECOGNITION_FAILED = 1, - /** Successfully recognized. */ - RTLS_RECOGNITION_SUCCEEDED = 2 -} -``` -> -```cpp -typedef enum RawTextLineStatus -{ - /** Localized but recognition not performed. */ - RTLS_LOCALIZED, - /** Recognition failed. */ - RTLS_RECOGNITION_FAILED, - /** Successfully recognized. */ - RTLS_RECOGNITION_SUCCEEDED -} RawTextLineStatus; -``` -> -```python -class EnumRawTextLineStatus(IntEnum): - # Localized but recognition not performed. - RTLS_LOCALIZED - # Recognition failed. - RTLS_RECOGNITION_FAILED - # Successfully recognized. - RTLS_RECOGNITION_SUCCEEDED -``` diff --git a/parameters/file/auxiliary/barcode-format-specification-v2.6.1000.md b/parameters/file/auxiliary/barcode-format-specification-v2.6.1000.md deleted file mode 100644 index 7736d6e..0000000 --- a/parameters/file/auxiliary/barcode-format-specification-v2.6.1000.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -layout: default-layout -title: BarcodeFormatSpecification - Dynamsoft Capture Vision Parameter File -description: The BarcodeFormatSpecification object in the Dynamsoft Capture Vision Parameter File defines how barcodes will be processed. -keywords: Barcode format specification, binarization, grayscale enhancement, character normalization -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# BarcodeFormatSpecification Object - -`BarcodeFormatSpecification` is able to set configurations for specified barcode formats. You can leave this area empty to use the default barcode reading settings. - -```json -{ - "Name":"BFS_1", - "AllModuleDeviation" : 0, - "AustralianPostEncodingTable" : "C", - "EnableAddOnCode": 0, - "BarcodeAngleRangeArray" : [ - { - "MinValue": 100, - "MaxValue": 200 - } - ], - "BarcodeBytesLengthRangeArray" : [ - { - "MinValue": 100, - "MaxValue": 200 - } - ], - "BarcodeComplementModes" : [ - { - "Mode": "BCM_GENERAL" - } - ], - "BarcodeFormatIds" : ["BF_DATAMATRIX"], - "BarcodeHeightRangeArray" : [ - { - "MinValue": 100, - "MaxValue": 200 - } - ], - "BarcodeTextLengthRangeArray" : [ - { - "MinValue": 100, - "MaxValue": 200 - } - ], - "BarcodeTextRegExPattern" : " ^([*].+[*]|[+].+[+])$", - "BarcodeWidthRangeArray" : [ - { - "MinValue": 100, - "MaxValue": 200 - } - ], - "BarcodeZoneBarCountRangeArray" : [ - { - "MinValue": 1, - "MaxValue": 128 - } - ], - "BarcodeZoneMinDistanceToImageBorders" : 1, - "Code128Subset" : "A", - "DeformationResistingModes" : [ - { - "Mode": "DRM_GENERAL", - "Level": 1 - } - ], - "FindUnevenModuleBarcode" : 1, - "HeadModuleRatio" : "211412", - "MinQuietZoneWidth" : 1, - "MinRatioOfBarcodeZoneWidthToHeight" : 100, - "MinResultConfidence" : 30, - "MirrorMode" : "MM_NORMAL", - "ModuleSizeRangeArray" : [ - { - "MinValue": 3, - "MaxValue": 20 - } - ], - "MSICodeCheckDigitCalculation" : "MSICCDC_MOD_10", - "PartitionModes" : ["PM_WHOLE_BARCODE"], - "RequireStartStopChars" : 1, - "ReturnPartialBarcodeValue" : 1, - "StandardFormat" : "BF_CODE128", - "TailModuleRatio" : "2331112", - "VerifyCheckDigit" : 1 -} -``` - - -## Usage Instructions - -### Parameter Configurations - -**Select target barcode format** - -Select `BarcodeFormatIds` for barcode by specifying the name of the format. View enumeration [BarcodeFormats]({{site.dcvb_enums}}barcode-reader/barcode-format.html) for all supported barcode formats. - -**Set special configurations for target format** - -The design intent of `BarcodeFormatSpecification` is to do special processing for specific barcode format while not affecting the decoding of other barcode types. - -In other words, settings in `BarcodeFormatSpecification` have a higher priority when conflicting with global settings. For example: - -
    -

    barcode-format-specification

    -
    - -Sometimes the image and the real scene happen to be mirror images of each other. For 2D barcodes, mirroring may cause the decoding to fail. In this case, all barcodes are normal except QR code, we could configure the MirrorMode to correct the situation: - -```json -{ - "Name": "BFS_mirror", - "BarcodeFormatIds": ["BF_QR_CODE"], - "MirrorMode":"MM_MIRROR" -} -``` - -### Quick Settings - -Based on a existing `BarcodeFormatSpecification` object, you can use `BaseBarcodeFormatSpecificationName` with other minor changes to configure a new `BarcodeFormatSpecification` object. For example； - -```json -{ - "Name":"BFS_0", - "BarcodeFormatIds" : ["BF_DATAMATRIX"], - "BinarizationModes" : [ - { - "Mode": "BM_LOCAL_BLOCK", - "BlockSizeX": 5, - "BlockSizeY": 5, - } - ] -}, -{ - "Name":"BFS_1", - "BaseBarcodeFormatSpecificationName" : "BFS_0", // Use the same settings with BFS_0 but add little changes. - "MinResultConfidence" : 20 -} -``` - -### Additional Annotations - -`BarcodeReaderTaskSetting` determines how a barcode reader task works from initializing to finializing. As a parameter of `BarcodeReaderTaskSetting`, `BarcodeFormatSpecification` decides how the barcodes are processed when they are detected in the barcode reader task. A group of default settings has been allocated for the `BarcodeFormatSpecification` so that the `BarcodeReaderTaskSetting` still works without specifying `BarcodeFormatSpecification` parameters. \ No newline at end of file diff --git a/parameters/file/auxiliary/textline-specification-v2.6.1000.md b/parameters/file/auxiliary/textline-specification-v2.6.1000.md deleted file mode 100644 index fdd3524..0000000 --- a/parameters/file/auxiliary/textline-specification-v2.6.1000.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -layout: default-layout -title: TextLineSpecification - Dynamsoft Capture Vision Parameter File -description: The TextLineSpecification object in the Dynamsoft Capture Vision Parameter File defines how text lines will be processed. -keywords: Text line specification, binarization, grayscale enhancement, character normalization -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# TextLineSpecification Object - -Set the `CharacterModel`, `ImageProcessing` parameters and other configurations for the specified text lines. This is the parameter that defines how the algorithm extract characters from each text lines of a `LabelRecognizer` task. You can leave this area empty to use the default character recognizing settings. - -```json -{ - "Name":"LS_1", - "CharacterModelName" : "NumberLetter", - "ApplicableTextLineNumbers":"", - "GrayscaleEnhancementModes" : [], - "BinarizationModes" : [], - "CharacterNormalizationModes" : [], - "BaseTextLineSpecificationName" : "LS_0", - "StringLengthRange" : [44,44], - "StringRegExPattern" : "", - "FirstPoint" : [ 0, 0 ], - "SecondPoint" : [ 100, 0 ], - "ThirdPoint" : [ 100, 20 ], - "FourthPoint" : [ 0, 20 ], - "CharHeightRange" : [ 800, 1000, 1 ] -} -``` - -## Usage Instructions - -### Parameter Configurations - -**Select CharacterModel** - -Select one of the `CharacterModel` for the text line(s) by specifying the name of the model. View [`CharacterModel`](character-model.md) page for how to configure the models. - -**Set Targeting Text Lines** - -Parameter `ApplicableTextLineNumbers` defines which text lines shall apply the settings of this `TextLineSpecification` object. - -- If `ApplicableTextLineNumbers` is null, all the text lines will use the default settings. -- If `ApplicableTextLineNumbers` is not applied to all the text lines, the remaining text lines will use the default settings. - -You can also specify the location of the targeting text lines with 4 point coordinates. The targeting text line is filtered based on the combination of `ApplicableTextLineNumbers` and area definition. For example: - -
    -

    text-line-specification

    - Example Text Line Specification -
    - -You can use the following parameters to process the above image: - -```json -{ - "ApplicableTextLineNumbers" : "7,8", - "FirstPoint" : [ 0, 60 ], - "SecondPoint" : [ 70, 60 ], - "ThirdPoint" : [ 70, 100 ], - "FourthPoint" : [ 0, 100 ] -} -``` - -If your set the `ApplicableTextLineNumbers` as "1-8", the text line from 1 to 6 are not recognized because they are not in the specified area. - -**Configure ImageProcessing Modes** - -`GrayscaleEnhancementModes` enhance the quality of the grayscale image. - -`BinarizationModes` configurations finally reflect in the quality of the binary image. It determines how the characters are presented on the text areas before they recognized by the library. The higher quality of the binary image, the higher read rate and accuracy of the character recognition result. - -`CharacterNormalizationModes` are additional settings that further improve the quality of characters. Generally, they are **morphological transformations**. You can view more about them from Image-Processing in OpenCV - Morphological Transformations. - -### Quick Settings - -Based on a existing `TextLineSpecification` object, you can use `BaseTextLineSpecificationName` with other minor changes to configure a new `TextLineSpecification` object. For example； - -```json -{ - "Name":"LS_0", - "CharacterModelName" : "NumberLetter", - "ApplicableTextLineNumbers":"1-3", - "BinarizationModes" : [ - { - "Mode": "BM_LOCAL_BLOCK", - "BlockSizeX": 5, - "BlockSizeY": 5, - } - ], - "CharacterNormalizationModes" : [ - { - "Mode": "CNM_MORPH", - "MorphOperation": "Close", - "MorphArgument": "3", - } - ], - "StringLengthRange" : [44,44], - "StringRegExPattern" : "Dynamsoft", - "CharHeightRange" : [ 800, 1000, 1 ] -}, -{ - "Name":"LS_1", - "BaseTextLineSpecificationName" : "LS_0", // Use the same settings with LS_0 but add some changes. - "ApplicableTextLineNumbers":"4-7", - "CharHeightRange" : [ 600, 800, 1 ] -} -``` - -### Additional Annotations - -`LabelRecognizerTaskSetting` determines how a label recognizer task works from initializing to finalizing. As a parameter of `LabelRecognizerTaskSetting`, `TextLineSpecification` decides how the text lines are processed when they are detected in the label recognizer task. A group of default settings has been allocated for the `TextLineSpecification` so that the `LabelRecognizerTaskSetting` still works without specifying `TextLineSpecification` parameters. diff --git a/parameters/file/image-parameter-v2.6.1004.md b/parameters/file/image-parameter-v2.6.1004.md deleted file mode 100644 index fe6ad30..0000000 --- a/parameters/file/image-parameter-v2.6.1004.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -layout: default-layout -title: ImageParameter - Dynamsoft Capture Vision Parameter File -description: ImageParameter in the Dynamsoft Capture Vision Parameter File is an object for configuring common image processing steps. -keywords: image parameter, image processing, setting -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: false ---- - -# ImageParameter Object - -The ImageParameter object is designed to configure and organize common parameters for image processing, including but not limited to color-to-grayscale conversion, grayscale enhancement, binarization, color region pre-detection, text detection, and texture detection. These configuration parameters play a role in different stages of recognition tasks. - -```json -{ - "Name" : "ip_default", - "BaseImageParameterName" : "", - "BinarizationModes" : - [ - { - "BinarizationThreshold" : -1, - "BlockSizeX" : 0, - "BlockSizeY" : 0, - "EnableFillBinaryVacancy" : 1, - "GrayscaleEnhancementModesIndex" : -1, - "Mode" : "BM_LOCAL_BLOCK", - "MorphOperation" : "Close", - "MorphOperationKernelSizeX" : -1, - "MorphOperationKernelSizeY" : -1, - "MorphShape" : "Rectangle", - "ThresholdCompensation" : 10 - } - ], - "ColourConversionModes" : - [ - { - "BlueChannelWeight" : -1, - "GreenChannelWeight" : -1, - "Mode" : "CICM_GENERAL", - "RedChannelWeight" : -1, - "ReferChannel" : "H_CHANNEL" - } - ], - "GrayscaleEnhancementModes" : - [ - { - "Mode" : "GEM_GENERAL", - "Sensitivity" : -1, - "SharpenBlockSizeX" : -1, - "SharpenBlockSizeY" : -1, - "SmoothBlockSizeX" : -1, - "SmoothBlockSizeY" : -1 - } - ], - "GrayscaleTransformationModes" : - [ - { - "Mode" : "GTM_ORIGINAL" - } - ], - "IfEraseTextZone" : 0, - "RegionPredetectionModes" : - [ - { - "AspectRatioRange" : "[]", - "FindAccurateBoundary" : 0, - "ForeAndBackgroundColours" : "[]", - "HeightRange" : "[]", - "ImageParameterName" : "", - "MeasuredByPercentage" : 1, - "MinImageDimension" : 262144, - "Mode" : "RPM_GENERAL", - "RelativeRegions" : "[]", - "Sensitivity" : 1, - "SpatialIndexBlockSize" : 5, - "WidthRange" : "[]" - } - ], - "ScaleDownThreshold" : 2300, - "ScaleUpModes" : - [ - { - "AcuteAngleWithXThreshold" : -1, - "LetterHeightThreshold" : 0, - "Mode" : "SUM_AUTO", - "ModuleSizeThreshold" : 0, - "TargetLetterHeight" : 0, - "TargetModuleSize" : 0 - } - ], - "TextDetectionMode" : - { - "CharHeightRange" : - [ - 1, - 1000, - 1 - ], - "Direction" : "HORIZONTAL", - "MaxSpacingInALine" : -1, - "Mode" : "TTDM_SKIP" - }, - "TextureDetectionModes" : - [ - { - "Mode" : "TDM_GENERAL_WIDTH_CONCENTRATION", - "Sensitivity" : 5 - } - ] -} -``` - -## Definition and Reference - -Each algorithm section of the funtional products has a default `ImageParameter` settings. You can either skip the ImageParameter settings to implement the default settings or define your own `ImageParameter` objects and specify them in the sections you want to customize. - -### Define an ImageParameter Object - -`ImageParameter` objects are configured under `ImageParameterOptions` and each object has a unique name as its identifier. - -```json -{ - "ImageParameterOptions": [ - { - "Name": "IP_0" - }, - { - "Name": "IP_1" - } - ] -} -``` - -You can define a new `ImageParameter` object based on an existing `ImageParameter` object. For example: - -```json -{ - "ImageParameterOptions": [ - { - "Name": "IP_0" - }, - { - "Name": "IP_1", - "BaseImageParameterName" : "IP_0" - } - ] -} -``` - -### Specify an ImageParameter for Task Sections - -`ImageParameter` is referenced in task settings under `SectionImageParameterArray` with their names. For example: - -```json -{ - "SectionImageParameterArray": - [ - { - "Section": "ST_REGION_PREDETECTION", - "ImageParameterName": "IP_0" - }, - { - "Section": "ST_BARCODE_LOCALIZATION", - "ImageParameterName": "IP_1" - }, - { - "Section": "ST_BARCODE_DECODING", - "ImageParameterName": "IP_2" - } - ] -} -``` - -## Summary of ImageParameter Top-level Parameters - -View the parameter references for the details of each `ImageParameter` parameters. - -| Parameter Name | Description | -| -------------- | ----------- | -| [`Name`](../reference/shared-parameter/name.md) | Represents the name of the `ImageParameter` object, which serves as its unique identifier. | -| [`BaseImageParameterName`](../reference/image-parameter/base-image-parameter-name.md) | Represents the name of another `ImageParameter` object. It is used to inherit the parameters defined in its parent `ImageParameter` object. If a parameter has already been defined in this object, the parameter with the same name will not be inherited from the parent object.| -| [`BinarizationModes`](../reference/image-parameter/binarization-modes.md) | Used to control the binarization process, including two modes of local binarization and global binarization. | -| [`ColourConversionModes`](../reference/image-parameter/colour-conversion-modes.md) | Used to control the process of colour conversion, i.e. converting a colour image to a grayscale image.| -| [`GrayscaleEnhancementModes`](../reference/image-parameter/grayscale-enhancement-modes.md) | Provides some image processing methods to enhance the quality of the grayscale image, including gray equalization, grayscale smoothing, grayscale sharpening and smoothing.| -| [`GrayscaleTransformationModes`](../reference/image-parameter/grayscale-transformation-modes.md) | Used to control the color mode of the grayscale image, including the original mode and the inverted mode. | -| [`IfEraseTextZone`](../reference/image-parameter/if-erase-text-zone.md) | Indicates whether to erase the detected text area in the image.| -| [`RegionPredetectionModes`](../reference/image-parameter/region-predetection-modes.md) | Controls how to find a region of interest (ROI) within the image or frame. It consists of one or more modes, each mode representing a different way to find a region of interest.| -| [`ScaleDownThreshold`](../reference/image-parameter/scale-down-threshold.md) | Controls the threshold used when shrinking an image. If the shorter edge size is larger than the given value, the library will calculate the required height and width of the image and shrink the image to that size.| -| [`ScaleUpModes`](../reference/image-parameter/scale-up-modes.md)| Determines the process for scaling up an image used for detecting barcodes with small module size or recognizing text lines with small fonts. It consists of one or more modes, each mode represents a way to implement the scale-up. | -| [`TextDetectionMode`](../reference/image-parameter/text-detection-mode.md) | Determines how to detect texts on an image. It consists of one or more modes, each mode represents a way to implement the detection. | -| [`TextureDetectionModes`](../reference/image-parameter/texture-detection-modes.md) | Determines how to detect texture on an image. It consists of one or more modes, each mode represents a way to implement the detection. | diff --git a/parameters/file/index-v2.6.1000.md b/parameters/file/index-v2.6.1000.md deleted file mode 100644 index b7bb7fc..0000000 --- a/parameters/file/index-v2.6.1000.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -layout: default-layout -title: Overview of Dynamsoft Capture Vision Parameters -description: Introduce the overview parameters design of Dynamsoft Capture Vision. -keywords: Parameter, Parameter Template, Parameter Template File -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# Overview of DCV parameters - -Dynamsoft Capture Vision (DCV) is designed for high scalability and flexibility, and its parameter system plays a crucial role in achieving that. The parameter system can drive the behaviour of the SDK through its many varied configurations. In this article, we will provide an overview of the parametric architecture design of 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 `ExpectedBarcodesCount` parameter is used to control the expected number of recognized barcodes in the image or frame. Parameters can be configured with specific values or a range of values, which can be adjusted as required. - -1. **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. - -1. **Parameter template file** -A parameter template file is a JSON file that contains one or multiple parameter templates. - -## Structure 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" - } - ], - "BarcodeReaderTaskSettingOptions": [ - { - "Name" : "BR_0", - "BarcodeFormatSpecificationNameArray" : ["FS_0"] - } - ], - "BarcodeFormatSpecificationOptions": [ - { - "Name": "FS_0" - } - ], - "LabelRecognizerTaskSettingOptions": [ - { - "Name" : "LR_0", - "TextLineSpecificationNameArray" : [ "LS_0" ] - } - ], - "TextLineSpecificationOptions" : [ - { - "Name" : "LS_0", - "CharacterModelName" : "NumberLetter" - } - ], - "CharacterModelOptions" : [ - { - "Name" : "NumberLetter" - } - ], - "DocumentNormalizerTaskSettingOptions": [ - { - "Name" : "DN_0" - } - ], - "SemanticProcessingOptions": [ - { - "Name": "SP_0", - "TaskSettingNameArray": [ - "CP_0" - ] - } - ], - "CodeParserTaskSettingOptions": [ - { - "Name": "CP_0" - } - ], - "GlobalParameter":{ - "MaxTotalImageDimension":0 - }, - "OutputTaskSettingOptions":[ - { - "Name" : "output_task", - "OutputCondition": { - "TaskResultArray": [ - { - "TargetROIDefName": "B", - "TaskSettingNameArray": ["B_task"], - "Operator": "AND", - - "BackwardReferenceOutput": { - "ReferenceTaskNameArray": ["A_task"], - "ReferenceResultTypeArray":[ "ART_TEXT_LINE","ART_BARCODE","ART_FRAME", "ART_TABLE_CELL", "ART_COLOUR_REGION" ] - } - } - ], - "Operator": "AND" - } - } - ] -} -``` - -With the exception of `GlobalParameter`, all top-level objects in the parameter template file are arrays of the corresponding object. For example,`CaptureVisionTemplates` is an array of `CaptureVisionTemplate` objects, and `TargetROIDefOptions` is an array of `TargetROIDef` objects, and so on. - -Furthermore, you will notice that some of the parameters' definitions are reused across the parameter template file. This helps reduce the size of the parameter template file and simplify the parameter configuration hierarchy, making it easier for you to understand and create your own template. For example, the value of the `ImageSourceName` 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 diagram below illustrates the objects included in a complete parameter template, as well as the reference relationships between them. - -- A solid blue line indicates a one-to-zero or one-to-one correspondence between the two objects. -- A solid black line indicates a one-to-zero or one-to-n correspondence between the two objects. -- The dash line indicates that these objects may be associated with one-to-n `ImageParameter` objects, which may take effect at different stages of the algorithm. - -
    -

    Top level objects of DCV template file

    -

    Figure 2 – Object reference relationships in a parameter template

    -
    - -The following table list the main objects type and description of a complete parameter template: - -| Object Type | Description | -| :------------------------------| :----------- | -| [CaptureVisionTemplate]({{site.dcvb_parameters}}file/capture-vision-template.html) | 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]({{site.dcvb_parameters}}file/image-source.html) | 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]({{site.dcvb_parameters}}file/target-roi-definition/index.html) | Used to specify one or more recognition tasks to be performed on some regions of interest (ROIs) within an image.| -| [SemanticProcessing]({{site.dcvb_parameters}}file/semantic-processing/index.html) | Used to specify one or more code parsing tasks to be performed on text/byte results to help extract human readable information. | -| [BarcodeReaderTaskSetting]({{site.dcvb_parameters}}file/task-settings/barcode-reader-task-settings.html) | Configures the settings for barcode reading tasks performed on images in DCV. | -| [LabelRecognizerTaskSetting]({{site.dcvb_parameters}}file/task-settings/label-recognizer-task-settings.html) | Configures the settings for label recognition tasks performed on images in DCV.| -| [DocumentNormalizerTaskSetting]({{site.dcvb_parameters}}file/task-settings/document-normalizer-task-settings.html) | Configures the settings for the document detection or normalization process of an image in DCV. | -| [CodeParserTaskSetting]({{site.dcvb_parameters}}file/task-settings/code-parser-task-settings.html) | Configures the code parsing tasks such as passport MRZ, driving license and other user specific tasks in DCV etc.| -| [OutputTaskSetting]({{site.dcvb_parameters}}file/task-settings/output-task-setting.html) | Configure how to output the expected results of the ancestor `TargetROIDef` by filtering the results of the descendant `TargetROIDef` object. | -| [ImageParameter]({{site.dcvb_parameters}}file/image-parameter.html) | 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](capture-vision-template.md) - -## How to Apply DCV Parameters - -There are two ways in which the parameters can be implemented in Dynamsoft Capture Vision (DCV): - -- `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/file/target-roi-definition/index-v2.6.1004.md b/parameters/file/target-roi-definition/index-v2.6.1004.md deleted file mode 100644 index 5379557..0000000 --- a/parameters/file/target-roi-definition/index-v2.6.1004.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -layout: default-layout -title: TargetROIDef Object Introduction -description: Introduced the TargetROIDef definition for Dynamsoft Capture Vision. -keywords: TargetROIDef -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# Design of the TargetROIDef Object - -The `TargetROIDef` object is used to specify one or more recognition tasks to be performed on some regions of interest (ROIs) within an image. - -```json -{ - "Name" : "TA_1", - - "TaskSettingNameArray": [ - "LR_0",// Name of LabelRecognizerTaskSetting Object - "BR_0",// Name of BarcodeReaderTaskSetting Object - "DN_0" // Name of DocumentNormalizerTaskSetting Object - ], - "Location": - { - "ReferenceObjectFilter" : - { - "ReferenceTargetROIDefNameArray": ["TR_0", "TR_1"], - "AtomicResultTypeArray" : ["ART_TEXT_LINE","ART_BARCODE","ART_FRAME"], - - "BarcodeFilteringCondition": {}, - "FrameFilteringCondition": {}, - "TextLineFilteringCondition": {}, - "RegionFilteringCondition": {} - }, - "Offset": { - "ReferenceObjectOriginIndex": 0, - "ReferenceObjectType": "ROT_ATOMIC_OBJECT", - "MeasuredByPercentage" : 1, - "FirstPoint" : [ 0, 0 ], - "SecondPoint" : [ 100, 0 ], - "ThirdPoint" : [ 100, 100 ], - "FourthPoint" : [ 0, 100 ], - } - } -} -``` - -
    -

    Example 1 – Parameters of TargetROIDef

    -
    - -## Summary of TargetROIDef top-level parameters - -| Parameter Name | Description | -| -------------- | ----------- | -| [`Name`]({{site.dcvb_parameters_reference}}target-roi-def/name.html) | Represents the name of the `TargetROIDef` object, which serves as its unique identifier. | -| [`TaskSettingNameArray`]({{site.dcvb_parameters_reference}}target-roi-def/task-setting-name-array.html) | Represents the collection of task setting object names, used to refer to the `BarcodeReaderTaskSetting`,`LabelRecognizerTaskSetting`,`DocumentNormalizerTaskSetting` objects. It is used to define recognition tasks such as reading barcodes, recognizing labels, or detecting document quads. | -| [`Location`]({{site.dcvb_parameters_reference}}target-roi-def/location.html) | Define the spatial location where the recognition tasks are performed. It consists of `ReferenceObjectFilter` and `Offset` parameter. | -| [`PauseFlag`]({{site.dcvb_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.| -| [`BaseTargetROIDefName`]({{site.dcvb_parameters_reference}}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object. It is used to inherit the parameters defined in its parent `TargetROIDef` object. If a parameter has already been defined in this object, the parameter with the same name will not be inherited from the parent object.| - -In simple terms, `TargetROIDef` can be expressed using the following formula: - -``` -TargetROIDef = Recognition Task Definition + Spatial Location Definition -``` - -## Recognition Tasks - -The recognition tasks configured on the `TargetROIDef` object include barcode recognition, label recognition, document boundary detection, etc. -The atomic result of each task type is the smallest output item, which can be a barcode, text line, table cell, detected quadrilateral, etc. `CapturedResult` represents a set of all captured atomic result items on an image. The following table lists the task types and corresponding atomic result item types. - -| Task Type | Performed By | Atomic Result Type | -| :------------------- | :----------- | :------------------- | -| Read Barcodes | Dynamsoft Barcode Reader SDK | BarcodeResultItem | -| Recognize Text Lines | Dynamsoft Label Recognizer SDK | TextResultItem | -| Detect Document Borders | Dynamsoft Document Normalizer SDK | DetectedQuadResultItem | -| Normalize a Document | Dynamsoft Document Normalizer SDK | NormalizedImageResultItem | - -If you want to learn more about the design details of recognition task settings, please refer to the following links: - -- [Design of barcode reader task settings](../task-settings/barcode-reader-task-settings.md) -- [Design of label recognizer task settings](../task-settings/label-recognizer-task-settings.md) -- [Design of document normalizer task settings](../task-settings/document-normalizer-task-settings.md) - -## Spatial Location - -Parameter `Location` defines the spatial location where the recognition tasks are performed. It consists of `ReferenceObjectFilter` parameter and `Offset` parameter. The former is used to filter out the desired reference regions, and the latter defines a uniform offset relative to the reference regions. -Next, we focus on explaining some key concepts based on the example diagram below: - -
    -

    An example showing the key concepts

    -

    Figure 1 – An example showing the key concepts

    -
    - -|Concept|Description|Explanation with example| -|:------|:----------|:-----------------------| -|**Atomic Result**| Represents the atomic result of the recognition task output. It can be a color detection region, a barcode, a text line, a table cell, a detected quadrilateral etc.|`T1`, `T2`, `T3` are three atomic result objects of `TextLineResultItem` type, and B1 is one atomic object of `BarcodeResultItem` type.| -|**Reference Region**|A reference region is a physical quadrilateral region. It includes two types: **entire image region** and **atomic result region**. The former refers to the quadrilateral extent of the original image, and the latter refers to the quadrilateral extent of each atomic result.| `ROI1` has only one reference region which is the entire image region. `ROI2` has three reference regions which generated from `T1`, `T2`, `T3`. | -|**Target Region**| A target region is a physical quadrilateral region, which is calculated from a reference region and offset.| `ROI1` has only one target region, which is equal to the reference region. `ROI2` has three target regions, which are calculated by offsets from quadrilateral regions of `T1`, `T2`, `T3`.| - -### Reference Object Filter - -Defines the filter conditions of the reference objects. You can filter the reference objects by the `TargetROIDefName`, the type of the atomic results and even the further details of the atomic results. There might exist multiple objects that fit the filter conditions. As a result, the more appropriate the filter conditions are, the more accurate reference regions you receive. - -#### Summary of ReferenceObjectFilter top-level parameters - -| Parameter Name | Description | -| -------------------------------- | ----------- | -| [`ReferenceTargetROIDefNameArray`]({{site.dcvb_parameters_reference}}target-roi-def/location/reference-object-filter/reference-object-filter-parameter-details.html#referencetargetroidefnamearray) | Reference the atomic object generated by other `TargetROIDef` objects by specifying its name. This parameter will intersect with the `AtomicResultTypeArray` parameter to determine the final referenced `TargetROIDef` objects. | -| [`AtomicResultTypeArray`]({{site.dcvb_parameters_reference}}target-roi-def/location/reference-object-filter/reference-object-filter-parameter-details.html#referencetasknamearray) | Set atomic result types that can be used as reference objects. This parameter will intersect with the `ReferenceTargetROIDefNameArray` parameter to determine the final referenced `TargetROIDef` objects. | -| [`BarcodeFilteringCondition`]({{site.dcvb_parameters_reference}}target-roi-def/location/reference-object-filter/barcode-filtering-condition.html) | Set barcode conditions that can be used as reference objects. | -| [`FrameFilteringCondition`]({{site.dcvb_parameters_reference}}target-roi-def/location/reference-object-filter/frame-filtering-condition.html) | Set frame conditions that can be used as reference objects. | -| [`TextLineFilteringCondition`]({{site.dcvb_parameters_reference}}target-roi-def/location/reference-object-filter/text-line-filtering-condition.html) | Set text line conditions that can be used as reference objects | -| [`RegionFilteringCondition`]({{site.dcvb_parameters_reference}}target-roi-def/location/reference-object-filter/region-filtering-condition.html) | Set colour region conditions that can be used as reference *objects* | - - -### Offset - -Defines the offset of the target region from the reference object. If there is no reference object defined, the origin will be set to the top-left vertex of the original image. - -
    -

    Offset example

    -

    Figure 2 – Offset example

    -
    - -#### Summary of Offset top-level parameters - -| Parameter Name | Description | -| -------------------------------- | ----------- | -| [`ReferenceObjectOriginIndex`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#referenceobjectoriginindex) | Defines which point of the reference object will be set as the origin of the coordinate system. | -| [`ReferenceObjectType`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#referenceobjecttype) | Defines which coordinate system to use when configuring offset parameters basd on the reference objects. | -| [`ReferenceXAxis`]({{site.dcvb_parameters_reference}}target-roi-def/offset/reference-x-axis.html) | Defines the x-axis of the coordinate system to use when configuring offset parameters basd on the reference objects. | -| [`ReferenceYAxis`]({{site.dcvb_parameters_reference}}target-roi-def/offset/reference-y-axis.html) | Defines the y-axis of the coordinate system to use when configuring offset parameters basd on the reference objects. | -| [`MeasuredByPercentage`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#measuredbypercentage) | Sets whether or not to use percentage to measure the points' coordinates. | -| [`FirstPoint`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#firstpoint) | The first point of the target region, which defines the offset from the origin. | -| [`SecondPoint`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#secondpoint) | The second point of the target region, which defines the offset from the origin. | -| [`ThirdPoint`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#thirdpoint) | The third point of the target region, which defines the offset from the origin. | -| [`FourthPoint`]({{site.dcvb_parameters_reference}}target-roi-def/offset/offset-parameter-details.html#fourthpoint) | The fourth point of the target region, which defines the offset from the origin. | - -## How to Configure Target/Reference Relationships - -### Reference the Original Image - -Even if you don't have any reference object, you can still set a offset based on the original image to localize the ROI. - -The following parameter template snippet shows how to define ROI from the original image and perform barcode recognition. - -- Step 1: Name your `TargetROI` "ROI_0". -- Step 2: Set the `ReferenceObjectFilter` of the "ROI_0" to `null`. -- Step 3: Define the Offset. Here it is assumed that barcode recognition is performed on the upper part(50%) of the image. - -```json -{ - "TargetROIDefOptions": - [ - { - "Name": "ROI_0", - "TaskSettingNameArray":["barcode_task"], - "Location": - { - "ReferenceObjectFilter": null, - "Offset": - { - "MeasuredByPercentage": 1, - "FirstPoint": [ 0, 0 ], - "SecondPoint": [ 100, 0 ], - "ThirdPoint": [ 100, 50 ], - "FourthPoint": [ 0, 50 ] - } - }, - } - ] -} -``` - -### Reference Another TargetObjectDef - -If the there exists significant objects that can help you localizing the targeting content, you can define filter conditions to localize the reference objects first and then capture the targeting content. - -The following example shows how to configure the `ReferenceObjectFilter` to use the barcode location to extract the certain text line information: - -
    -

    set-reference-object

    -

    Figure 3 – How to reference another TargetObjectDef

    -
    - -```json -{ - "TargetROIDefOptions": - [ - { - "Name": "ROI_0", - "TaskSettingNameArray":["barcode_task"], - "Location": null - }, - { - "Name": "ROI_1", - "TaskSettingNameArray":["text_task"], - "Location": - { - "ReferenceObjectFilter" : - { - "ReferenceTargetROIDefNameArray": ["ROI_0"], // The ROI that you decoded the barcodes. - "AtomicResultTypeArray" : ["ART_BARCODE"], // Set the AtomicResult type to barcode. - - // Set BarcodeFilteringCondition. Otherwise, all the barcodes will become ReferenceObject. - "BarcodeFilteringCondition": - { - "BarcodeFormatIds": ["BF_CODE_128"], // Use Code 128 only. - "BarcodeTextRegExPattern": "ReferenceObject" // Find the Code 128 whose text has "ReferenceObject" - } - }, - "Offset" : - { - "MeasuredByPercentage" : 1, - "FirstPoint" : [ 20, 140 ], - "SecondPoint" : [ 60, 140 ], - "ThirdPoint" : [ 60, 170 ], - "FourthPoint" : [ 20, 170 ] - } - }, - } - ] -} -``` diff --git a/parameters/file/task-settings/barcode-reader-task-settings-v2.6.1000.md b/parameters/file/task-settings/barcode-reader-task-settings-v2.6.1000.md deleted file mode 100644 index 1a8a43a..0000000 --- a/parameters/file/task-settings/barcode-reader-task-settings-v2.6.1000.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -layout: default-layout -title: Barcode Reader Task Setting - Dynamsoft Capture Vision Parameter File -description: Barcode Reader Task Setting object in the Dynamsoft Capture Vision Parameter File is an object for configuring and organizing the process of barcode reading task. -keywords: barcode reader,task, setting -needAutoGenerateSidebar: false ---- - -# BarcodeReaderTaskSetting Object -In Dynamsoft Capture Vision(DCV), we use Json files to configure and organize the process tasks. The `BarcodeReaderTaskSetting` described in this chapter is one of the configurable tasks. If you have more strict requirements for speed or accuracy, it is highly recommended that you start by trying the barcode reader task settings. - - -## Available Settings -All available parameters related to barcode decoding are listed here, along with a brief description. - - | Parameter Name | Description | - | -------------- | ----------- | - | [`BarcodeFormatIds`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/barcode-format-ids.html) | Sets which barcode format the current FormatSpecification configuration is applied to. | - | [`BarcodeFormatSpecificationNameArray`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/barcode-format-specification-name-array.html) | The names of the referenced BarcodeFormatSpecification object(s). | - | [`BarcodeColourModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/barcode-colour-modes.html) | Sets the mode and priority for the barcode colour mode used to process the barcode zone. | - | [`BarcodeComplementModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/barcode-complement-modes.html) | Sets the mode and priority to complement the missing parts in the barcode. | - | [`DeblurModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/deblur-modes.html) | Sets the mode and priority for deblurring. | - | [`DeformationResistingModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/deformation-resisting-modes.html) | Sets the mode and priority for deformation resisting. | - | [`DPMCodeReadingModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/dpm-code-reading-modes.html) | Sets the mode and priority for DPM code reading. | - | [`ExpectedBarcodesCount`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/expected-barcodes-count.html) | Sets the number of barcodes expected to be detected for each image. | - | [`LocalizationModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/localization-modes.html) | Sets the mode and priority for barcode localization algorithms. | - | [`MaxThreadsInOneTask`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/max-threads-in-one-task.html) | Represents the maximum number of parallel threads that can be used on a single task.| - | [`Name`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/name.html) | The name of the BarcodeReaderTaskSetting object. | - | [`ReturnBarcodeZoneClarity`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/return-barcode-zone-clarity.html) | Sets whether or not to return the clarity of the barcode zone. | - | [`SectionImageParameterArray`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/section-image-parameter-array.html) | Sets image parameters for three different sections, where each section performs image processing stages with different parameters.| - | [`StartSection`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/start-section.html) | Indicates which Section the task will start executing from.| - | [`TerminateSetting`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/terminate-setting.html) | Indicates where the task stops, specifically indicating a Stage under a certain Section.| - | [`TextResultOrderModes`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/text-result-order-modes.html) | Sets the mode and priority for the order of the text results returned. | - | [`BaseBarcodeReaderTaskSettingName`]({{site.dcvb_parameters_reference}}barcode-reader-task-settings/base-barcode-reader-task-setting-name.html) | Sets the name of a BarcodeReaderTaskSetting object to be Inheritanced.| - -When DCV executes tasks related to barcode reading, it will process them according to the settings in the `BarcodeReaderTaskSetting`. Here is a sample: - -## Barcode Reader Task Setting Example - -```json - { - "Name": "BR_0", - "MaxThreadsInOneTask":4, - "ExpectedBarcodesCount" : 512, - "BarcodeFormatIds" : [ "BF_ALL" ], - "DeblurModes" : null, - "BarcodeFormatSpecificationNameArray" : null, - "LocalizationModes" : [ - { - "LibraryFileName" : "", - "LibraryParameters" : "", - "Mode" : "LM_CONNECTED_BLOCKS" - }, - { - "LibraryFileName" : "", - "LibraryParameters" : "", - "Mode" : "LM_SCAN_DIRECTLY", - "ScanDirection" : 0, - "ScanStride" : 0 - }, - { - "LibraryFileName" : "", - "LibraryParameters" : "", - "Mode" : "LM_STATISTICS" - }, - { - "LibraryFileName" : "", - "LibraryParameters" : "", - "Mode" : "LM_LINES" - }, - { - "LibraryFileName" : "", - "LibraryParameters" : "", - "Mode" : "LM_STATISTICS_MARKS" - } - ], - "DPMCodeReadingModes" : [ - { - "Mode" : "DPMCRM_SKIP" - } - ], - "BarcodeColourModes" : [ - { - "LibraryFileName" : "", - "LibraryParameters" : "", - "LightReflection" : 1, - "Mode" : "BICM_DARK_ON_LIGHT" - } - ], - "BarcodeComplementModes" : [ - { - "Mode": "BCM_GENERAL" - } - ], - "DeformationResistingModes" : [ - { - "Mode" : "DRM_SKIP" - } - ], - "ReturnBarcodeZoneClarity" : 0, - "TextResultOrderModes" : [ - { - "Mode" : "TROM_CONFIDENCE" - }, - { - "Mode" : "TROM_POSITION" - }, - { - "Mode" : "TROM_FORMAT" - } - ], - "SectionImageParameterArray":[ - { - "Section": "REGION_PREDETECTION", - "ImageParameterName": "IP_0" - }, - { - "Section": "BARCODE_LOCALIZATION", - "ImageParameterName": "IP_1" - }, - { - "Section": "BARCODE_DECODING", - "ImageParameterName": "IP_2" - } - ], - "StartSection": "REGION_PREDETECTION", - "TerminateSetting": - { - "Section": "REGION_PREDETECTION", - "Stage": "IRUT_GRAYSCALE_IMAGE" - }, - "BaseBarcodeReaderTaskSettingName": "" -} -``` diff --git a/parameters/file/task-settings/document-normalizer-task-settings-v2.6.1004.md b/parameters/file/task-settings/document-normalizer-task-settings-v2.6.1004.md deleted file mode 100644 index d17f52b..0000000 --- a/parameters/file/task-settings/document-normalizer-task-settings-v2.6.1004.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default-layout -title: DocumentNormalizerTaskSetting - Dynamsoft Capture Vision Parameter File -description: The DocumentNormalizerTaskSetting object in the Dynamsoft Capture Vision Parameter File. -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true ---- - -# DocumentNormalizerTaskSetting Object - -## Parameter Organization - -A `DocumentNormalizerTaskSetting` object is defined as below: - -| Key Name | Value Type | Required or Optional | Description | -|---|---|---|---| -| Name | string | Mandatory | Sets the name of current `DocumentNormalizerTaskSetting` object. The value must be unique between all `task-setting` objects. | -| Brightness | string | Optional | Sets the value for parameter [Brightness]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/brightness.html) | -| ColourMode | string | Optional | Sets the value for parameter [ColourMode]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/colour-mode.html) | -| ContentType | string | Optional | Sets the value for parameter [ContentType]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/content-type.html) | -| Contrast | string | Optional | Sets the value for parameter [Contrast]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/contrast.html) | -| CornerAngleRange | string | Optional | Sets the value for parameter [CornerAngleRange]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/corner-angle-range.html) | -| DeskewMode | string | Optional | Sets the value for parameter [DeskewMode]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/deskew-mode.html) | -| ExpectedDocumentsCount | string | Optional | Sets the value for parameter [ExpectedDocumentsCount]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/expected-documents-count.html) | -| LineAssemblyMode | string | Optional | Sets the value for parameter [LineAssemblyMode]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/line-assembly-mode.html) | -| MaxThreadsInOneTask | string array | Optional | Sets the value for parameter [MaxThreadsInOneTask]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/max-threads-in-one-task.html) | -| PageSize | string | Optional | Sets the value for parameter [PageSize]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/page-size.html) | -| QuadrilateralDetectionModes | string | Optional | Sets the value for parameter [QuadrilateralDetectionModes]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/quadrilateral-detection-modes.html) | -| SectionImageParameterArray | string | Optional | Sets the value for parameter [SectionImageParameterArray]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/section-image-parameter-array.html) | -| ShortLineDetectionMode | string | Optional | Sets the value for parameter [ShortLineDetectionMode]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/short-line-detection-mode.html) | -| StartSection | string | Optional | Sets the value for parameter [StartSection]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/start-section.html) | -| TerminateSetting | string | Optional | Sets the value for parameter [TerminateSetting]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/terminate-setting.html) | -| BaseDocumentNormalizerTaskSettingName | string | Optional | Sets the value for parameter [BaseDocumentNormalizerTaskSettingName]({{site.dcvb_parameters_reference}}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html) | - -Here is a sample: - -```json -{ - "Name": "DR_1", - "MaxThreadsInOneTask":4, - "Brightness" : 0, - "ColourMode" : "ICM_COLOUR", - "ContentType" : "CT_DOCUMENT", - "Contrast" : 0, - "DeskewMode" : - { - "ContentDirection" : 0, - "Mode" : "DM_PERSPECTIVE_CORRECTION" - }, - "CornerAngleRange" : [ - { - "MaxValue" : 110, - "MinValue" : 70 - } - ], - "PageSize" : [-1, -1], - "QuadrilateralDetectionModes" : [ - { - "Mode" : "QDM_GENERAL" - } - ], - "LineAssemblyMode": - { - "Mode": "LAM_GENERAL", - "Sensitivity": 3 - }, - "ShortlineDetectionMode": - { - "Mode": "SDM_GENERAL", - "Sensitivity": 3 - } - "SectionImageParameterArray" : [ - { - "Section": "REGION_PREDETECTION", - "ImageParameterName": "IP_0" - }, - { - "Section": "DOCUMENT_DETECTION", - "ImageParameterName": "IP_1" - }, - { - "Section": "DOCUMENT_NORMALIZATION", - "ImageParameterName": "IP_2" - } - ], - "StartSection": "REGION_PREDETECTION", - "TerminateSetting": - { - "Section": "REGION_PREDETECTION", - "Stage": "IRUT_GRAYSCALE_IMAGE", - }, - "BaseDocumentNormalizerTaskSettingName": "", -} -``` diff --git a/parameters/file/task-settings/label-recognizer-task-settings-v2.6.1004.md b/parameters/file/task-settings/label-recognizer-task-settings-v2.6.1004.md deleted file mode 100644 index 9528f5e..0000000 --- a/parameters/file/task-settings/label-recognizer-task-settings-v2.6.1004.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: default-layout -title: Label Recognizer Task Setting - Dynamsoft Capture Vision Parameter File -description: Label Recognizer Task Setting object in the Dynamsoft Capture Vision Parameter File is an object for configuring and organizing the process of label recognition task. -keywords: label recognition, task, setting -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: false ---- - -# LabelRecognizerTaskSetting Object - -The `LabelRecognizerTaskSetting` object is used to configure settings for a label recognition task to be performed on certain regions of interest (ROIs) in an image. - -```json -{ - "Name" : "dlr_task_default", - "TextLineSpecificationNameArray" : ["tls_default"], - "DictionaryPath" : "", - "DictionaryCorrectionThresholds" : [ - { - "MaxWordLength" : 256, - "MinWordLength" : 3, - "Threshold" : 1 - } - ], - "StringLengthRange" : [3,200], - "StringRegExPattern" : "", - "SectionImageParameterArray":[ - { - "Section": "REGION_PREDETECTION", - "ImageParameterName": "ip_dlrDefault" - }, - { - "Section": "TEXT_LINE_LOCALIZATION", - "ImageParameterName": "ip_dlrDefault" - }, - { - "Section": "TEXT_LINE_RECOGNITION", - "ImageParameterName": "ip_dlrDefault" - } - ], - "StartSection": "REGION_PREDETECTION", - "TerminateSetting": - { - "Section": "REGION_PREDETECTION", - "Stage": "IRUT_GRAYSCALE_IMAGE", - }, - "MaxThreadsInOneTask" : 4, - "BaseLabelRecognizerTaskSettingName" : "", -} -``` - -
    -

    Example 1 – Parameters of LabelRecognizerTaskSetting

    -
    - -## Summary of LabelRecognizerTaskSetting top-level parameters - -| Parameter Name | Description | -| -------------- | ----------- | -| [`Name`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/name.html) | Represents the name of the `LabelRecognizerTaskSetting` object, which serves as its unique identifier. | -| [`TextLineSpecificationNameArray`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/text-line-specification-name-array.html) | Represents the collection of text line specification object names, used to refer to the `TextLineSpecification` objects. It is used to define the recognition settings for the text lines. | -| [`DictionaryPath`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/dictionary-path.html) | Sets the path of the dictionary file. | -| [`DictionaryCorrectionThresholds`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/dictionary-correction-thresholds.html)| Sets the threshold of dictionary error correction.| -| [`StringLengthRange`]({{site.dcvb_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.dcvb_parameters_reference}}label-recognizer-task-settings/string-regex-pattern.html) | Specifies the regular expression pattern for concatenated strings of recognized text lines.| -| [`SectionImageParameterArray`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/section-image-parameter-array.html) | Sets image parameters for three different sections, where each section performs image processing stages with different parameters.| -| [`StartSection`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/start-section.html) | Indicates which Section the task will start executing from.| -| [`TerminateSetting`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/terminate-setting.html) | Indicates where the task stops, specifically indicating a Stage under a certain Section.| -| [`MaxThreadsInOneTask`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/max-threads-in-one-task.html) | Represents the maximum number of parallel threads that can be used on a single task.| -| [`BaseLabelRecognizerTaskSettingName`]({{site.dcvb_parameters_reference}}label-recognizer-task-settings/base-label-recognizer-task-setting-name.html) | Represents the name of another `LabelRecognizerTaskSetting` object. It is used to inherit the parameters defined in its parent `LabelRecognizerTaskSetting` object. If a parameter has already been defined in this object, the parameter with the same name will not be inherited from the parent object.| diff --git a/parameters/reference/barcode-reader-task-settings/deblur-modes-v2.6.1000.md b/parameters/reference/barcode-reader-task-settings/deblur-modes-v2.6.1000.md deleted file mode 100644 index 44e60d1..0000000 --- a/parameters/reference/barcode-reader-task-settings/deblur-modes-v2.6.1000.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -layout: default-layout -title: DeblurModes - Dynamsoft Barcode Reader Parameters -description: The parameter DeblurModes of Dynamsoft Barcode Reader defines the mode and priority for deblurring. -keywords: Deblur modes -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# DeblurModes - -Parameter `DeblurModes` defines the mode and priority for deblurring. - -## Example - -```json -{ - "DeblurModes": - [ - { - "Mode": "DM_BASED_ON_LOC_BIN" - }, - { - "Mode": "DM_THRESHOLD_BINARIZATION" - } - ] -} -``` - -## Parameter Summary - -Parameter `DeblurModes` consist of a group of deblur mode objects. Each deblur mode object includes a candidate mode and a series of auxiliary mode arguments. - -### Mode Arguments - -The mode arguments of the deblur mode object are shown as follow: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Mode Argument NameMode Argument Summary
    Mode
    (Required)    		Description
    Specifies a deblur mode. -
    Type
    String -
    Candidate Mode List -
    DM_DIRECT_BINARIZATION -
    DM_THRESHOLD_BINARIZATION -
    DM_GRAY_EQUALIZATION -
    DM_SMOOTHING -
    DM_MORPHING -
    DM_DEEP_ANALYSIS -
    DM_SHARPENING -
    DM_BASED_ON_LOC_BIN -
    DM_SHARPENING_SMOOTHING -
    DM_SKIP -
    LibraryFileName
    (Optional)    		Description
    Sets the file name of the library to load dynamically. -
    Type
    String -
    Range
    A string value representing file name. -
    Default Value
    "" -
    Valid For
    All modes. -
    LibraryParameters
    (Optional)    		Description
    The library must be in the same place with Dynamsoft Barcode Reader Library. -
    Type
    String -
    Range
    A string value representing parameters. -
    Default Value
    "" -
    Valid For
    All modes. -
    - -### Default Setting - -If the `DeblurModes` is not configured in your template file, the following settings will be used as the default settings. - -```json -{ - "DeblurModes": null -} -``` - -## Candidate Modes Introduction - -### DM_DIRECT_BINARIZATION - -Performs deblur process using the binarization algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_THRESHOLD_BINARIZATION - -Performs deblur process using the threshold binarization algorithm. - -When processing OneD barcodes, you can add two `DM_THRESHOLD_BINARIZATION` to your DeblurModes settings. If you do, the second round `DM_THRESHOLD_BINARIZATION` will detect and fill in the blurry area with predicted barcode modules. The second round `DM_THRESHOLD_BINARIZATION` can sharpenly improve the read-rate of blurry OneD barcodes but sacrifice the accuracy. - -This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_GRAY_EQUALIZATION - -Performs deblur process using the gray equalization algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_SMOOTHING - -Performs deblur process using the smoothing algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_MORPHING - -Performs deblur process using the morphing algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_DEEP_ANALYSIS - -Performs deblur process using the deep analysis algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_SHARPENING - -Performs deblur process using the sharpening algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_BASED_ON_LOC_BIN - -Performs deblur process based on the binary image from the localization process. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters - -### DM_SHARPENING_SMOOTHING - -Performs deblur process using the sharpening and smoothing algorithm. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -- LibraryFileName -- LibraryParameters diff --git a/parameters/reference/barcode-reader-task-settings/index-v2.4.2200.md b/parameters/reference/barcode-reader-task-settings/index-v2.4.2200.md deleted file mode 100644 index 6600f53..0000000 --- a/parameters/reference/barcode-reader-task-settings/index-v2.4.2200.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default-layout -title: Index - BarcodeReaderTaskSetting Parameters -description: The index of BarcodeReaderTaskSetting parameters. -keywords: BarcodeReaderTaskSetting, parameter reference, parameter -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# BarcodeReaderTaskSetting Parameters - -| Parameter Name | Description | -| -------------- | ----------- | -| [`BarcodeColourModes`](barcode-colour-modes.md) | Defines the barcode colour modes. | -| [`BarcodeComplementModes`](barcode-complement-modes.md) | Defines how to complement the missing parts of a barcode. | -| [`BarcodeFormatIds`](barcode-format-ids.md) | Defines the formats of the barcode to process. | -| [`BaseBarcodeReaderTaskSettingName`](base-barcode-reader-task-setting-name.md) | Represents the name of another `BarcodeReaderTaskSetting` object to inherit from. | -| [`DeblurModes`](deblur-modes.md) | Defines the mode and priority for deblurring. | -| [`DeformationResistingModes`](deformation-resisting-modes.md) | Defines how to handle distorted and deformed barcodes. | -| [`DPMCodeReadingModes`](dpm-code-reading-modes.md) | Defines how to read direct part mark (DPM) barcodes. | -| [`ExpectedBarcodesCount`](expected-barcodes-count.md) | Defines the number of barcodes expected to be detected. | -| [`LocalizationModes`](localization-modes.md) | Defines how to localize barcodes. | -| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. | -| [`Name`](name.md) | Defines the name of a `BarcodeReaderTaskSetting` object, which serves as its unique identifier. | -| [`ReturnBarcodeZoneClarity`](return-barcode-zone-clarity.md) | Defines whether to return the clarity of the barcode zone. | -| [`SectionImageParameterArray`](section-image-parameter-array.md) | Defines `ImageParameter` in section unit. | -| [`StartSection`](start-section.md) | Defines the start section of the `BarcodeReaderTask`. | -| [`TerminateSetting`](terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. | -| [`TextResultOrderModes`](text-result-order-modes.md) | Defines the order of the returned text results. | diff --git a/parameters/reference/document-normalizer-task-settings/corner-angle-range-v2.4.2200.md b/parameters/reference/document-normalizer-task-settings/corner-angle-range-v2.4.2200.md deleted file mode 100644 index af18e28..0000000 --- a/parameters/reference/document-normalizer-task-settings/corner-angle-range-v2.4.2200.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default-layout -title: CornerAngleRange - Dynamsoft Document Normalizer Parameters -description: The parameter CornerAngleRange of Dynamsoft Document Normalizer is XXX. -keywords: -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# CornerAngleRange - -Parameter `CornerAngleRange` specifies the range of angles (in degrees) of the extracted corners. The corners refer to the corners of a quad or document. - -## Example - -```json -{ - "CornerAngleRange": - { - "MinValue": 80, - "MaxValue": 100 - } -} -``` - -## Parameter Summary - -`CornerAngleRange` The range of a maximum and a minimum value of the angles. - -### Child Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Child Parameter NameChild Parameter Summary
    MinValueDescription
    Sets the minimum interior angle. -
    Type
    int -
    Range
    [0,90] -
    Default Value
    70 -
    MaxValueDescription
    Sets the maximum interior angle. -
    Type
    int -
    Range
    [90,180] -
    Default Value
    110
    Remarks
    Please ensure that all interior angles of the target quadrilateral fall within the specified value range. -
    If the setting values doesn't meet the requirement ranges, an error will be raised. -
    - -### Default Setting - -If the `CornerAngleRange` is not configured in your template file, the following setting will be used as the default setting. - -```json -{ - "CornerAngleRange" : - { - "MaxValue" : 110, - "MinValue" : 70 - } -} -``` diff --git a/parameters/reference/document-normalizer-task-settings/expected-documents-count-v2.4.2200.md b/parameters/reference/document-normalizer-task-settings/expected-documents-count-v2.4.2200.md deleted file mode 100644 index 83cd6fa..0000000 --- a/parameters/reference/document-normalizer-task-settings/expected-documents-count-v2.4.2200.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default-layout -title: ExpectedDocumentsCount - Dynamsoft Document Normalizer Parameters -description: The parameter ExpectedDocumentsCount of Dynamsoft Document Normalizer sets the number of documents expected to be detected. -keywords: Expected Documents Count -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# ExpectedDocumentsCount - -ExpectedDocumentsCount sets the number of documents expected to be detected. - -## Example - -```json -{ - "ExpectedDocumentsCount" : 1 -} -``` - -## Parameter Summary - -| ExpectedDocumentsCount Parameter Summary | -| :--------------- | -| **Type**
    int | -| **Range**
    [0, 0x7fffffff] | -| **Default Value**
    0 | diff --git a/parameters/reference/document-normalizer-task-settings/index-v2.2.12.md b/parameters/reference/document-normalizer-task-settings/index-v2.2.12.md deleted file mode 100644 index b44412b..0000000 --- a/parameters/reference/document-normalizer-task-settings/index-v2.2.12.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default-layout -title: Index - DocumentNormalizerTaskSetting Parameters -description: The index of DocumentNormalizerTaskSetting parameters. -keywords: DocumentNormalizerTaskSetting, parameter reference, parameter -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# DocumentNormalizerTaskSetting Parameters - -| Parameter Name | Description | -| ------------------------------------------- | ----------- | -| [`BaseDocumentNormalizerTaskSettingName`](base-document-normalizer-task-setting-name.md) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | -| [`Brightness`](brightness.md) | Defines the brightness of the normalized image. | -| [`ColourMode`](colour-mode.md) | Defines the output colour mode of the normalized image. | -| [`ContentType`](content-type.md) | Defines which contents are the targeting objects. | -| [`Contrast`](contrast.md) | Defines the contrast of the normalized image. | -| [`CornerAngleRange`](corner-angle-range.md) | Defines the range of angles (in degrees) of the extracted corners. | -| [`DeskewMode`](deskew-mode.md) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | -| [`LineExtractionModes`](line-extraction-modes.md) | Defines the algorithm used to extract lines. | -| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. | -| [`Name`](name.md) | Defines the name of a `DocumentNormalizerTaskSetting` object, which serves as its unique identifier. | -| [`PageSize`](page-size.md) | Defines the page size (width by height in pixels) of the normalized image. | -| [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.md) | Defines the quadrilateral detection process on an image. | -| [`SectionImageParameterArray`](section-image-parameter-array.md) | Defines `ImageParameter` in section unit. | -| [`StartSection`](start-section.md) | Defines the start section of the `DocumentNormalizerTask`. | -| [`TerminateSetting`](terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. | diff --git a/parameters/reference/document-normalizer-task-settings/index-v2.4.2200.md b/parameters/reference/document-normalizer-task-settings/index-v2.4.2200.md deleted file mode 100644 index 54f989a..0000000 --- a/parameters/reference/document-normalizer-task-settings/index-v2.4.2200.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default-layout -title: Index - DocumentNormalizerTaskSetting Parameters -description: The index of DocumentNormalizerTaskSetting parameters. -keywords: DocumentNormalizerTaskSetting, parameter reference, parameter -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# DocumentNormalizerTaskSetting Parameters - -| Parameter Name | Description | -| ------------------------------------------- | ----------- | -| [`BaseDocumentNormalizerTaskSettingName`](base-document-normalizer-task-setting-name.md) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | -| [`Brightness`](brightness.md) | Defines the brightness of the normalized image. | -| [`ColourMode`](colour-mode.md) | Defines the output colour mode of the normalized image. | -| [`ContentType`](content-type.md) | Defines which contents are the targeting objects. | -| [`Contrast`](contrast.md) | Defines the contrast of the normalized image. | -| [`CornerAngleRange`](corner-angle-range.md) | Defines the range of angles (in degrees) of the extracted corners. | -| [`DeskewMode`](deskew-mode.md) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | -| [`ExpectedDocumentsCount`](expected-documents-count.md) | Defines the the number of documents expected to be detected. | -| [`LineExtractionModes`](line-extraction-modes.md) | Defines the algorithm used to extract lines. | -| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. | -| [`Name`](name.md) | Defines the name of a `DocumentNormalizerTaskSetting` object, which serves as its unique identifier. | -| [`PageSize`](page-size.md) | Defines the page size (width by height in pixels) of the normalized image. | -| [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.md) | Defines the quadrilateral detection process on an image. | -| [`SectionImageParameterArray`](section-image-parameter-array.md) | Defines `ImageParameter` in section unit. | -| [`StartSection`](start-section.md) | Defines the start section of the `DocumentNormalizerTask`. | -| [`TerminateSetting`](terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. | diff --git a/parameters/reference/document-normalizer-task-settings/index-v2.6.1004.md b/parameters/reference/document-normalizer-task-settings/index-v2.6.1004.md deleted file mode 100644 index 1318cec..0000000 --- a/parameters/reference/document-normalizer-task-settings/index-v2.6.1004.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default-layout -title: Index - DocumentNormalizerTaskSetting Parameters -description: The index of DocumentNormalizerTaskSetting parameters. -keywords: DocumentNormalizerTaskSetting, parameter reference, parameter -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# DocumentNormalizerTaskSetting Parameters - -| Parameter Name | Description | -| ------------------------------------------- | ----------- | -| [`BaseDocumentNormalizerTaskSettingName`](base-document-normalizer-task-setting-name.md) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | -| [`Brightness`](brightness.md) | Defines the brightness of the normalized image. | -| [`ColourMode`](colour-mode.md) | Defines the output colour mode of the normalized image. | -| [`ContentType`](content-type.md) | Defines which contents are the targeting objects. | -| [`Contrast`](contrast.md) | Defines the contrast of the normalized image. | -| [`CornerAngleRange`](corner-angle-range.md) | Defines the range of angles (in degrees) of the extracted corners. | -| [`DeskewMode`](deskew-mode.md) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | -| [`ExpectedDocumentsCount`](expected-documents-count.md) | Defines the the number of documents expected to be detected. | -| [`LineAssemblyMode`](line-assembly-mode.md) | Determines how to assemble the short lines. | -| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. | -| [`Name`](name.md) | Defines the name of a `DocumentNormalizerTaskSetting` object, which serves as its unique identifier. | -| [`PageSize`](page-size.md) | Defines the page size (width by height in pixels) of the normalized image. | -| [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.md) | Defines the quadrilateral detection process on an image. | -| [`SectionImageParameterArray`](section-image-parameter-array.md) | Defines `ImageParameter` in section unit. | -| [`ShortlineDetectionMode`](short-line-detection-mode.md) | Determines how to detect the short lines. | -| [`StartSection`](start-section.md) | Defines the start section of the `DocumentNormalizerTask`. | -| [`TerminateSetting`](terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. | diff --git a/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes-v2.2.12.md b/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes-v2.2.12.md deleted file mode 100644 index dc40b73..0000000 --- a/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes-v2.2.12.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -layout: default-layout -title: QuadrilateralDetectionModes - Dynamsoft Document Normalizer Parameters -description: The parameter QuadrilateralDetectionModes of Dynamsoft Document Normalizer v2.2.12. -keywords: Quadrilateral detection -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# QuadrilateralDetectionModes - -Parameter `QuadrilateralDetectionModes` controls the quadrilateral detection process on an image. It currently includes only one mode. - -## Example - -```json -{ - "QuadrilateralDetectionModes": [ - { - "Mode": "QDM_GENERAL" - } - ] -} -``` - -## Parameter Summary - -`QuadrilateralDetectionModes` consist one or more mode objects. Each mode object contains a candidate mode and other mode arguments. - -### Mode Arguments - - - - - - - - - - - - - - - - - - - - - -
    Mode Argument NameMode Argument Summary
    Mode
    (Required)    		Description
    Specifies a mode for quadrilateral detection. -
    Type
    String -
    Candidate Mode List
    QDM_GENERAL
    QDM_SKIP -
    Default Value
    ["QDM_GENERAL"] -
    - -### Default Setting - -If the `QuadrilateralDetectionModes` is not configured in your template file, the following setting will be used as the default setting. - -```json -{ - "QuadrilateralDetectionModes" : - [ - { - "Mode" : "QDM_GENERAL" - } - ] -} -``` - -## Candidate Modes Introduction - -### QDM_GENERAL - -Detects quadrilateral(s) using the general algorithm. - -### QDM_SKIP - -Skip quadrilateral(s) detection. \ No newline at end of file diff --git a/parameters/reference/image-parameter/binarization-modes-v2.6.1004.md b/parameters/reference/image-parameter/binarization-modes-v2.6.1004.md deleted file mode 100644 index 71ff6e4..0000000 --- a/parameters/reference/image-parameter/binarization-modes-v2.6.1004.md +++ /dev/null @@ -1,408 +0,0 @@ ---- -layout: default-layout -title: BinarizationModes - Dynamsoft Capture Vision Parameters -description: The parameter BinarizationModes of Dynamsoft Capture Vision is for controlling the process of image binarization. -keywords: BinarizationModes, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# BinarizationModes - -Parameter `BinarizationModes` helps control the process of binarization, i.e., converting a grayscale image to a binary image. A better binary image greatly helps the following processes. During binarization, the threshold is the key criteria. If the pixel value is smaller than the threshold, it is set to 0, otherwise, it is set to a maximum value (255 in the library). By default, the library automatically calculates the adaptive size of the neighbourhood area and then binarizes the grayscale image with the adaptive threshold based on a small neighbourhood area with an adaptive size around it. `BinarizationModes` consists of one or more modes, each mode representing a different binarization process. - -## Example - -```json -{ - "BinarizationModes": [ - { - "Mode": "BM_LOCAL_BLOCK", - "BlockSizeX": 5, - "BlockSizeY": 5, - "EnableFillBinaryVacancy" : 1, - "ThresholdCompensation" : 5, - "LibraryFileName" : "", - "LibraryParameters" : "" - }, - { - "Mode": "BM_THRESHOLD", - "BinarizationThreshold": 125 - } - ] -} -``` - -## Parameter Summary - -Parameter `BinarizationModes` consist of a group of binarization mode objects. Each binarization mode object includes a candidate mode and a series of mode arguments. The available mode arguments of the binarization mode object is shown as follow. - -### Mode Arguments - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Mode Argument NameMode Argument Summary
    Mode
    (Required)    		Description
    Any one in Candidate Mode List as string -
    Type
    String -
    Candidate Mode List
    BM_THRESHOLD -
    BM_LOCAL_BLOCK -
    BM_SKIP -
    BlockSizeX
    (Optional)    		Description
    Sets the horizontal block size for the binarization process. -
    Type
    int -
    Range
    [0,1000] -
    Valid For
    BM_LOCAL_BLOCK -
    BlockSizeY
    (Optional)    		Description
    Sets the vertical block size for the binarization process. -
    Type
    int -
    Range
    [0,1000] -
    Valid For
    BM_LOCAL_BLOCK -
    EnableFillBinaryVacancy
    (Optional)    		Description
    Sets whether to enable binary vacancy filling. -
    Type
    int -
    Range
    [0,1] -
    Valid For
    BM_LOCAL_BLOCK -
    ThresholdCompensation
    (Optional)    		Description
    Constant subtracted from the mean or weighted mean used for calculating the threshold. Normally, it is positive but may be zero or negative as well. -
    Type
    int -
    Range
    [-255, 255] -
    Valid For
    BM_LOCAL_BLOCK -
    BinarizationThreshold
    (Optional)    		Description
    Sets the binarization threshold. -
    Type
    int -
    Range
    [-1, 255] -
    Valid For
    BM_THRESHOLD -

    MorphOperation(Optional)    		Description
    Sets the morph operation for the morphology process. -
    Type
    String -
    Range
    "Erode", "Dilate", "Open" or "Close" -
    Valid For
    All modes -
    MorphOperationKernelSizeX
    (Optional)    		Description
    Sets the horizontal kernel size for the morphology process. -
    Type
    int -
    Range
    [-1, 1000] -
    Valid For
    All modes -
    MorphOperationKernelSizeY
    (Optional)    		Description
    Sets the vertical kernel size for the morphology process. -
    Type
    int -
    Range
    [-1, 1000] -
    Valid For
    All modes -
    MorphShape
    (Optional)    		Description
    Sets the morph shape for the morphology process. -
    Type
    String -
    Range
    "Rectangle", "Cross" or "Ellipse" -
    Valid For
    All modes -
    GrayscaleEnhancementModesIndex
    (Optional)    		Description
    The index of a specific image preprocessing mode in the GrayscaleEnhancementModes parameter which the current binarization mode is applied to. -
    Type
    int -
    Range
    [-1, 0x7fffffff] -
    Valid For
    All modes -
    LibraryFileName
    (Optional)    		Description
    Sets the file name of the library to load dynamically. -
    Type
    String -
    Range
    A string value representing file name. -
    Default Value
    "" -
    Valid For
    All modes -
    LibraryParameters
    (Optional)    		Description
    The library must be in the same place with Dynamsoft Barcode Reader Library. -
    Type
    String -
    Range
    A string value representing parameters. -
    Default Value
    "" -
    Valid For
    All modes. -
    - -### Default Setting - -If the `BinarizationModes` is not configured in your template file, the following settings will be used as the default settings. - -#### For Barcode Decoding - -```json -{ - "BinarizationModes" : - [ - { - "BlockSizeX" : 0, - "BlockSizeY" : 0, - "EnableFillBinaryVacancy" : 1, - "GrayscaleEnhancementModesIndex" : -1, - "Mode" : "BM_LOCAL_BLOCK", - "MorphOperation" : "Close", - "MorphOperationKernelSizeX" : -1, - "MorphOperationKernelSizeY" : -1, - "MorphShape" : "Rectangle", - "ThresholdCompensation" : 10 - } - ] -} -``` - -#### For Label Recognizing - -```json -{ - "BinarizationModes" : - [ - { - "BlockSizeX" : 0, - "BlockSizeY" : 0, - "EnableFillBinaryVacancy" : 1, - "GrayscaleEnhancementModesIndex" : -1, - "Mode" : "BM_LOCAL_BLOCK", - "MorphOperation" : "Close", - "MorphOperationKernelSizeX" : -1, - "MorphOperationKernelSizeY" : -1, - "MorphShape" : "Rectangle", - "ThresholdCompensation" : 10 - } - ] -} -``` - -#### For Document Normalizing - -```json -{ - "BinarizationModes" : - [ - { - "BlockSizeX" : 0, - "BlockSizeY" : 0, - "EnableFillBinaryVacancy" : 0, - "GrayscaleEnhancementModesIndex" : -1, - "Mode" : "BM_LOCAL_BLOCK", - "MorphOperation" : "Close", - "MorphOperationKernelSizeX" : -1, - "MorphOperationKernelSizeY" : -1, - "MorphShape" : "Rectangle", - "ThresholdCompensation" : 10 - } - ] -} -``` - -#### For Text Line Specification - -Re-binarize the text line area to support the character segmentation. - -```json -{ - "BinarizationModes" : - [ - { - "BlockSizeX": 11, - "BlockSizeY": 11, - "EnableFillBinaryVacancy": 1, - "GrayscaleEnhancementModesIndex": -1, - "Mode": "BM_LOCAL_BLOCK", - "MorphOperation": "Erode", - "MorphOperationKernelSizeX": -1, - "MorphOperationKernelSizeY": -1, - "MorphShape": "Rectangle", - "ThresholdCompensation": 10 - } - ] -} -``` - -## Candidate Modes Introduction - -### BM_LOCAL_BLOCK - -If an image has different lighting conditions in different areas, BM_LOCAL_BLOCK can help. In this case, our algorithm determines the threshold for a pixel based on a small region around it, which makes it more adaptive and gives better results. - -**Available Mode Arguments:** - -* BlockSizeX -* BlockSizeY -* EnableFillBinaryVacancy -* ThresholdCompensation -* BinarizationThreshold -* GrayscaleEnhancementModesIndex -* MorphOperation -* MorphShape -* MorphOperationKernelSizeX -* MorphOperationKernelSizeY -* LibraryFileName -* LibraryParameters - -### BM_THRESHOLD - -Binarizes the image for each pixel based on a unified threshold. If the gray value of the pixel is less than the threshold, it will be black in the binary image, otherwise it will be white. - -**Available Mode Arguments:** - -* BinarizationThreshold -* GrayscaleEnhancementModesIndex -* MorphOperation -* MorphShape -* MorphOperationKernelSizeX -* MorphOperationKernelSizeY -* LibraryFileName -* LibraryParameters diff --git a/parameters/reference/image-parameter/colour-conversion-modes-v2.4.2200.md b/parameters/reference/image-parameter/colour-conversion-modes-v2.4.2200.md deleted file mode 100644 index 2432487..0000000 --- a/parameters/reference/image-parameter/colour-conversion-modes-v2.4.2200.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -layout: default-layout -title: ColourConversionModes - Dynamsoft Capture Vision Parameters -description: The parameter ColourConversionModes of Dynamsoft Capture Vision is for controlling the converting of colour image to grayscale image. -keywords: ColourConversionModes, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# ColourConversionModes - -Parameter `ColourConversionModes` is a parameter for setting the mode for converting a colour image to a grayscale image. It consists of one or more `ColourConversionMode` items and each item has its own arguments. - -## Example - -```json -{ - "ColourConversionModes": [ - { - "Mode": "CICM_GENERAL" - } - ] -} -``` - -## Parameter Summary - -Parameter `ColourConversionModes` consist of a group of colour conversion mode objects. Each colour conversion mode object includes a candidate mode and a series of mode arguments. The mode arguments of the colour conversion mode object is shown as follow: - -### Mode Arguments - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Mode Argument NameMode Argument Summary
    Mode
    (Required)    		Description
    Any one in Candidate Mode List as string -
    Type
    String -
    Candidate Mode List
    CICM_HSV -
    CICM_GENERAL -
    CICM_SKIP -
    Default Value
    CICM_GENERAL -
    BlueChannelWeight
    (Optional)    		Description
    Sets the weight value of Blue Colour Channel used for converting a colour image to a grayscale image. -
    Type
    int -
    Range
    [-1,1000] -
    Default Value
    -1 -
    Valid For
    CICM_GENERAL -
    GreenChannelWeight
    (Optional)    		Description
    Sets the weight value of Green Colour Channel used for converting a colour image to a grayscale image. -
    Type
    int -
    Range
    [-1,1000] -
    Default Value
    -1 -
    Valid For
    CICM_GENERAL -
    RedChannelWeight
    (Optional)    		Description
    Sets the weight value of Red Colour Channel used for converting a colour image to a grayscale image. -
    Type
    int -
    Range
    [-1,1000] -
    Default Value
    -1 -
    Valid For
    CICM_GENERAL -
    ReferChannel
    (Optional)    		Description
    Sets reference channel used for converting a colour image to a grayscale image by HSV algorithm. -
    Type
    string -
    Range
    "H_CHANNEL","S_CHANNEL","V_CHANNEL" -
    Default Value
    "H_CHANNEL" -
    Valid For
    CICM_HSV -
    LibraryFileName
    (Optional)    		Description
    Sets the file name of the library to load dynamically. -
    Type
    String -
    Range
    A string value representing file name. -
    Default Value
    "" -
    Valid For
    All modes. -
    LibraryParameters
    (Optional)    		Description
    The library must be in the same place with Dynamsoft Barcode Reader Library. -
    Type
    String -
    Range
    A string value representing parameters. -
    Default Value
    "" -
    Valid For
    All modes. -
    - -### Default Setting - -If the `ColourConversionModes` is not configured in your template file, the following settings will be used as the default settings. - -```json -{ - "ColourConversionModes" : - [ - { - "BlueChannelWeight" : -1, - "GreenChannelWeight" : -1, - "Mode" : "CICM_GENERAL", - "RedChannelWeight" : -1, - "ReferChannel" : "H_CHANNEL" - } - ] -} -``` - -## Candidate Modes Introduction - -### CICM_GENERAL - -Converts a colour image to a grayscale image using the general RGB colour model. - -**Available Mode Arguments:** - -* RedChannelWeight -* BlueChannelWeight -* GreenChannelWeight -* LibraryFileName -* LibraryParameters - -### CICM_HSV - -Converts a colour image to a grayscale image using the HSV colour model. - -**Available Mode Arguments:** - -* ReferChannel -* LibraryFileName -* LibraryParameters diff --git a/parameters/reference/image-parameter/grayscale-enhancement-modes-v2.6.1004.md b/parameters/reference/image-parameter/grayscale-enhancement-modes-v2.6.1004.md deleted file mode 100644 index a0fedc4..0000000 --- a/parameters/reference/image-parameter/grayscale-enhancement-modes-v2.6.1004.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -layout: default-layout -title: GrayscaleEnhancementModes - Dynamsoft Capture Vision Parameters -description: The parameter GrayscaleEnhancementModes of Dynamsoft Capture Vision is for enhancing the quality of grayscale image. -keywords: GrayscaleEnhancementModes, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# GrayscaleEnhancementModes - -Parameter `GrayscaleEnhancementModes` provides some image processing methods to enhance the quality of the grayscale image. By default, the library does no image preprocessing. Assume your image has distorted features that can be solved by common image processing methods, this parameter can help you get a higher quality grayscale image by shifting the order of the preprocessing algorithms used (if at all). - -## Example - -```json -{ - "GrayscaleEnhancementModes": [ - { - "Mode": "GEM_GRAY_EQUALIZE", - "Sensitivity": 1 - }, - { - "Mode": "GEM_GRAY_SMOOTH", - "SmoothBlockSizeX": 5, - "SmoothBlockSizeY": 5 - }, - { - "Mode": "GEM_SHARPEN_SMOOTH", - "SmoothBlockSizeX": 5, - "SmoothBlockSizeY": 5, - "SharpenBlockSizeX": 5, - "SharpenBlockSizeY": 5 - } - ] -} -``` - -## Parameter Summary - -Parameter `GrayscaleEnhancementModes` consist of a group of grayscale enhancement mode objects. Each grayscale enhancement mode object includes a candidate mode and a series of mode arguments. The mode arguments of the grayscale enhancement mode object is shown as follow: - -### Mode Arguments - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Mode Argument NameMode Argument Summary
    Mode
    (Required)    		Description
    Any one in Candidate Mode List as string -
    Type
    String -
    Candidate Mode List
    GEM_GENERAL -
    GEM_GRAY_EQUALIZE -
    GEM_GRAY_SMOOTH -
    GEM_SHARPEN_SMOOTH -
    GEM_SKIP -
    Default Value
    GEM_GENERAL -
    Sensitivity
    (Optional)    		Description
    Sets the sensitivity to perform the equalization process. A larger value means a higher possibility that gray equalization will be activated. -
    Type
    int -
    Range
    [1,9] -
    Default Value
    5 -
    Valid For
    GEM_GRAY_EQUALIZE -
    SmoothBlockSizeX
    (Optional)    		Description
    Sets the horizontal block size(neighborhood pixel counts) for the smoothing process. -
    Type
    int -
    Range
    [3,1000] -
    Default Value
    3 -
    Valid For
    GEM_GRAY_SMOOTH -
    GEM_SHARPEN_SMOOTH -
    SmoothBlockSizeY
    (Optional)    		Description
    Sets the vertical block size(neighborhood pixel counts) for the smoothing process. -
    Type
    int -
    Range
    [3,1000] -
    Default Value
    3 -
    Valid For
    GEM_GRAY_SMOOTH -
    GEM_SHARPEN_SMOOTH -
    SharpenBlockSizeX
    (Optional)    		Description
    Sets the horizontal block size(neighborhood pixel counts) for the sharpening process. -
    Type
    int -
    Range
    [3,1000] -
    Default Value
    3 -
    Valid For
    GEM_SHARPEN_SMOOTH -
    SharpenBlockSizeY
    (Optional)    		Description
    Sets the vertical block size(neighborhood pixel counts) for the sharpening process. -
    Type
    int -
    Range
    [3,1000] -
    Default Value
    3 -
    Valid For
    GEM_SHARPEN_SMOOTH -
    LibraryFileName
    (Optional)    		Description
    Sets the file name of the library to load dynamically. -
    Type
    String -
    Range
    A string value representing file name. -
    Default Value
    "" -
    Valid For
    All modes. -
    LibraryParameters
    (Optional)    		Description
    The library must be in the same place with Dynamsoft Barcode Reader Library. -
    Type
    String -
    Range
    A string value representing parameters. -
    Default Value
    "" -
    Valid For
    All modes. -
    - -### Default Setting - -If the `GrayscaleEnhancementModes` is not configured in your template file, the following settings will be used as the default settings. - -```json -{ - "GrayscaleEnhancementModes" : - [ - { - "Mode" : "GEM_GENERAL", - "Sensitivity" : -1, - "SharpenBlockSizeX" : -1, - "SharpenBlockSizeY" : -1, - "SmoothBlockSizeX" : -1, - "SmoothBlockSizeY" : -1 - } - ] -} -``` - -## Candidate Modes Introduction - -### GEM_GENERAL - -Takes the un-preprocessed grayscale image for the next stage of operations. - -### GEM_GRAY_EQUALIZE - -Preprocesses the grayscale image using the gray equalization algorithm. This mode can be used for images with low contrast between content and background colour. - -**Available Mode Arguments:** - -* Sensitivity - -### GEM_GRAY_SMOOTH - -Preprocesses the grayscale image using the gray smoothing algorithm. This mode can be used for for images with noise or texture. - -**Available Mode Arguments:** - -* SmoothBlockSizeX -* SmoothBlockSizeY - -### GEM_SHARPEN_SMOOTH - -Preprocesses the grayscale image using the sharpening and smoothing algorithm. This mode can be used for blurry images. - -**Available Mode Arguments:** - -* SmoothBlockSizeX -* SmoothBlockSizeY -* SharpenBlockSizeX -* SharpenBlockSizeY diff --git a/parameters/reference/image-parameter/index-v2.6.1003.md b/parameters/reference/image-parameter/index-v2.6.1003.md deleted file mode 100644 index b0b6f1f..0000000 --- a/parameters/reference/image-parameter/index-v2.6.1003.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default-layout -title: Index - ImageParameter Parameters -description: The index of ImageParameter parameters. -keywords: ImageParameter, parameter reference, parameter -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# ImageParameter Parameters - -| Parameter Name | Description | -| ---------------------------------- | ----------- | -| [`BaseImageParameterName`](base-image-parameter-name.md) | Represents the name of another `ImageParameter` object to inherit from. | -| [`BinarizationModes`](binarization-modes.md) | Defines the process of binarization | -| [`ColourConversionModes`](colour-conversion-modes.md) | Defines how to convert a colour image to a grayscale image. | -| [`GrayscaleEnhancementModes`](grayscale-enhancement-modes.md) | Defines the image processing methods to enhance the quality of the grayscale image. | -| [`GrayscaleTransformationModes`](grayscale-transformation-modes.md) | Defines whether or not to invert the color of the grayscale image. | -| [`IfEraseTextZone`](if-erase-text-zone.md) | Defines whether to erase the detected text zone. | -| [`Name`](name.md) | Defines the name of a `ImageParameter` object, which serves as its unique identifier. | -| [`RegionPredetectionModes`](region-predetection-modes.md) | Defines how to find a region of interest (ROI) within the image or frame. | -| [`ScaleDownThreshold`](scale-down-threshold.md) | Defines the threshold for image shrinking. | -| [`ScaleUpModes`](scale-up-modes.md) | Defines the scale-up process when targets in the image are too small. | -| [`TextDetectionMode`](text-detection-mode.md) | Defines how to detect the text area. | -| [`TextureDetectionModes`](texture-detection-modes.md) | Defines how to detect texture on an image. | diff --git a/parameters/reference/image-parameter/region-predetection-modes-v2.6.1004.md b/parameters/reference/image-parameter/region-predetection-modes-v2.6.1004.md deleted file mode 100644 index 790b00c..0000000 --- a/parameters/reference/image-parameter/region-predetection-modes-v2.6.1004.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -layout: default-layout -title: RegionPredetectionModes * Dynamsoft Capture Vision Parameters -description: The parameter RegionPredetectionModes of Dynamsoft Capture Vision is for detecting the region of interest(s) automatically. -keywords: RegionPredetectionModes, parameter reference, parameter -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - - -# RegionPredetectionModes - -Parameter `RegionPredetectionModes` controls how to find a region of interest (ROI) within the image or frame. - -## Example - -```json -{ - "RegionPredetectionModes": [ - { - "Mode": "RPM_GENERAL_GRAY_CONTRAST", - "Sensitivity": 5 - }, - { - "Mode": "RPM_GENERAL_RGB_CONTRAST", - "Sensitivity": 5 - }, - { - "Mode": "RPM_GENERAL_HSV_CONTRAST", - "ForeAndBackgroundColours":"[20,170,10]", - "WidthRange": "[100, 200]" - } - ] -} -``` - -## Parameter Summary - -### Mode Arguments - -Parameter `RegionPredetectionModes` consist of a group of region predetection mode objects. Each region predetection mode object includes a candidate mode and a series of mode arguments. The mode arguments of the region predetection mode object is shown as follow: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Mode Argument NameMode Argument Summary
    Mode
    (Required)    		Description
    Any one in Candidate Mode List as string -
    Type
    String -
    Candidate Mode List
    - RPM_SKIP
    - RPM_AUTO
    - RPM_GENERAL
    - RPM_GENERAL_RGB_CONTRAST
    - RPM_GENERAL_GRAY_CONTRAST
    - RPM_GENERAL_HSV_CONTRAST -
    AspectRatioRange
    (Optional)    		Description
    Specifies one or multiple sets of aspect ratio ranges as a string for filtering the predetected region.

    Aspect Ratio = BoundingRectHeight/BoundingRectWidth * 100 -
    Type
    String -
    Substruct
    Define one range:
    "[MinAspectRatio, MaxAspectRatio]"
    Define multiple ranges:
    "[MinAspectRatio, MaxAspectRatio];[MinAspectRatio, MaxAspectRatio];..." -
    Range
    MinAspectRatio: [0,10000]
    MaxAspectRatio: [0,10000] -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    -
    FindAccurateBoundary
    (Optional)    		Description
    Sets whether to enable finding accurate boundary:
    - 0: disable.
    - 1: enable. -
    Type
    int -
    Range
    [0,1] -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    - RPM_GENERAL_RGB_CONTRAST
    - RPM_GENERAL_GRAY_CONTRAST -
    ForeAndBackgroundColours
    (Required by RPM_GENERAL_HSV_CONTRAST )    		Description
    Specifies a set (or multiple sets) of the foreground and background colours used for region predetection algorithm based on HSV colour space:
    -
    Type
    String -
    Substruct
    Define one range:
    "[ForegroundColour,BackgroundColour,Tolerance]"
    Define multiple ranges:
    "[ForegroundColour,BackgroundColour,Tolerance];[ForegroundColour,BackgroundColour,Tolerance];..." -
    Range
    ForegroundColour: [-1,360]
    BackgroundColour: [-1,360]
    Tolerance: [0, 360] -
    Valid For
    RPM_GENERAL_HSV_CONTRAST -
    HeightRange
    (Optional)    		Description
    Specifies a set (or multiple sets) of height range for filtering the predetected region. The height is measured by the height of the bounding rect of the predetected region. -
    Type
    String -
    Substruct
    Define one range:
    "[MinHeight, MaxHeight]"
    Define multiple ranges:
    "[MinHeight, MaxHeight];[MinHeight, MaxHeight];..." -
    Range
    MinHeight: [1, 0x7fffffff]
    MaxHeight: [1, 0x7fffffff] -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    -
    WidthRange
    (Optional)    		Description
    Specifies a set (or multiple sets) of width range for filtering the predetected region. The width is measured by the width of the bounding rect of the predetected region. -
    Type
    String -
    Substruct
    Define one range:
    "[MinWidth, MaxWidth]"
    Define multiple ranges:
    "[MinWidth, MaxWidth];[MinWidth, MaxWidth];..." -
    Range
    A string value representing height range sets. -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    -
    MinImageDimension
    (Optional)    		Description
    Sets the minimum image dimension (in pixels) to enable region pre-detection. - The library will enable the region pre-detection feature only when the image dimension is larger than the given value.
    -
    Type
    int -
    Range
    [16384, 0x7fffffff] -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    - RPM_GENERAL_RGB_CONTRAST
    - RPM_GENERAL_GRAY_CONTRAST
    -
    RelativeRegions
    (Optional)    		Description
    Sets the barcode regions relative to the pre-detected region. -
    Type
    String -
    Substruct
    Define one region:
    "[Left,Top,Right,Bottom,Index]"
    Define multiple region:
    "[Left,Top,Right,Bottom,Index];[Left,Top,Right,Bottom,Index];..." -
    Range
    Left, Top, Right, Bottom: [-10000,10000]
    Index: [-1,0x7fffffff] -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    -
    Remarks
    Parameters Left, Top, Right, Bottom are measured in percentage.
    Parameter Index points to a specific colour that set in ForeAndBackgroundColours. Set it to -1 to apply the current RelativeRegion to all ForeAndBackgroundColours. -
    Sensitivity
    (Optional)    		Description
    Sets the sensitivity used for region predetection algorithm, a larger value means the library will take more effort to detect regions. -
    Type
    int -
    Range
    [1,9] -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    - RPM_GENERAL_RGB_CONTRAST
    - RPM_GENERAL_GRAY_CONTRAST
    -
    SpatialIndexBlockSize
    (Optional)    		Description
    Sets the spatial index block size used for region predetection algorithm. 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…). -
    Type
    int -
    Range
    [1, 32] -
    Default Value
    5 -
    Valid For
    - RPM_GENERAL_HSV_CONTRAST
    - RPM_GENERAL_RGB_CONTRAST
    - RPM_GENERAL_GRAY_CONTRAST
    -
    LibraryFileName
    (Optional)    		Description
    Sets the file name of the library to load dynamically. -
    Type
    String -
    Range
    A string value representing file name. -
    Default Value
    "" -
    Valid For
    All modes. -
    LibraryParameters
    (Optional)    		Description
    The library must be in the same place with Dynamsoft Barcode Reader Library. -
    Type
    String -
    Range
    A string value representing parameters. -
    Default Value
    "" -
    Valid For
    All modes. -
    - -### Default Setting - -The default settings of RegionPredetectionModes is: - -```json -{ - "RegionPredetectionModes" : - [ - { - "AspectRatioRange" : "[]", - "FindAccurateBoundary" : 0, - "ForeAndBackgroundColours" : "[]", - "HeightRange" : "[]", - "ImageParameterName" : "", - "MeasuredByPercentage" : 1, - "MinImageDimension" : 262144, - "Mode" : "RPM_GENERAL", - "RelativeRegions" : "[]", - "Sensitivity" : 1, - "SpatialIndexBlockSize" : 5, - "WidthRange" : "[]" - } - ], -} -``` - -## Candidate Modes Introduction - -### RPM_SKIP - -Skip region pre-detection process. - -### RPM_AUTO - -Lets the library choose a mode automatically. - -### RPM_GENERAL - -Takes the whole image as a region. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -* LibraryFileName -* LibraryParameters - -### RPM_GENERAL_RGB_CONTRAST - -Detects region using the general algorithm based on RGB colour contrast. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -* MinImageDimension -* Sensitivity -* SpatialIndexBlockSize -* LibraryFileName -* LibraryParameters - -### RPM_GENERAL_GRAY_CONTRAST - -Detects region using the general algorithm based on gray contrast. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -* MinImageDimension -* Sensitivity -* SpatialIndexBlockSize -* LibraryFileName -* LibraryParameters - -### RPM_GENERAL_HSV_CONTRAST - -Detects region using the general algorithm based on HSV colour contrast. This mode has the following arguments for further customizing. - -**Available Mode Arguments:** - -* AspectRatioRange -* FindAccurateBoundary -* ForeAndBackgroundColours -* HeightRange -* WidthRange -* RelativeBarcodeRegions -* MinImageDimension -* Sensitivity -* SpatialIndexBlockSize -* LibraryFileName -* LibraryParameters diff --git a/parameters/reference/target-roi-def/index-v2.6.1004.md b/parameters/reference/target-roi-def/index-v2.6.1004.md deleted file mode 100644 index 786e3d8..0000000 --- a/parameters/reference/target-roi-def/index-v2.6.1004.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default-layout -title: Index - TargetROIDef Parameters -description: The index of TargetROIDef parameters. -keywords: TargetROIDef, parameter reference, parameter -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# TargetROIDef Parameters - -| Parameter Name | Description | -| --------------- | ----------- | -| [`BaseTargetROIDefName`](base-target-roidef-name.md) | Represents the name of another `TargetROIDef` object to inherit from. | -| [`Location`](location.md) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | -| [`Name`](name.md) | Defines the name of a `TargetROIDef` object, which serves as its unique identifier. | -| [`PauseFlag`](pause-flag.md) | 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`](task-setting-name-array.md) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `BarcodeReaderTaskSetting`, `LabelRecognizerTaskSetting`, `DocumentNormalizerTaskSetting` objects. | diff --git a/parameters/reference/target-roi-def/location-v2.6.1004.md b/parameters/reference/target-roi-def/location-v2.6.1004.md deleted file mode 100644 index 715f00e..0000000 --- a/parameters/reference/target-roi-def/location-v2.6.1004.md +++ /dev/null @@ -1,546 +0,0 @@ ---- -layout: default-layout -title: Location - Dynamsoft Capture Vision Parameters -description: The parameter Location of Dynamsoft Capture Vision defines the location information of the ROIs. -keywords: Location -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# Location - -Parameter `Location` defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. - -## Example - -```json -{ - "Location": - { - "ReferenceObjectFilter" : - { - "ReferenceTargetROIDefNameArray": ["TR_0", "TR_1"], - "AtomicResultTypeArray" : ["ART_TEXT_LINE","ART_BARCODE","ART_FRAME","ART_TABLE_CELL"], - "ReferenceTaskNameArray": ["A_task"], - "BarcodeFilteringCondition": - { - "BarcodeFormatIds": ["BF_CODE39"], - "BarcodeTextRegExPattern": ".*b.*b.*b.*", - "RegionState": "default" - }, - "FrameFilteringCondition": - { - "ImageDimensionRange": [16384,0x7fffffff], - "AspectRatioRange": [1, 10000], - "WidthRange": [1, 0x7fffffff], - "HeightRange": [1, 0x7fffffff], - "RegionState": "default" - }, - "TableCellFilteringCondition": - { - "RowNumbers": "1,3,5", - "ColNumbers": "1", - "RegionState": "default" - }, - "TextLineFilteringCondition": - { - "LineNumbers": "1,3-5", - "LineStringRegExPattern": "Sodium[(\w| )]*", - "RegionState": "default" - } - }, - "Offset": { - "ReferenceObjectOriginIndex": 0, - "ReferenceObjectType": "ROT_ATOMIC_OBJECT", - "MeasuredByPercentage" : 1, - "FirstPoint" : [ 0, 0 ], - "SecondPoint" : [ 100, 0 ], - "ThirdPoint" : [ 100, 100 ], - "FourthPoint" : [ 0, 100 ] - } - } -} -``` - -## Parameter Summary - -### ReferenceObjectFilter - -Parameter `ReferenceObjectFilter` is a group of filter conditions for figuring out the `reference objects`. - -#### ReferenceTargetROIDefNameArray - -Filter the reference object by specifying `TargetROI` names. - -| ReferenceTargetROIDefNameArray Parameter Summary | -| :------------------- | -| **Type**
    *String[]* | -| **Range**
    Each member should be a name of `TargetROI` that defined in `TargetROIDefOptions`. | -| **Default Value**
    null | - -#### AtomicResultTypeArray - -Filter the reference object by specifying the type of atomic results. In the `TargetROIs` algorithm task can produce atomic results that can support the localization of the other `TargetROIs`. - -| AtomicResultTypeArray Parameter Summary | -| :------------------- | -| **Type**
    *String[]* | -| **Range**
    Each member should be one of the `AtomicResultType`, which are `ART_TEXT_LINE`, `ART_BARCODE`, `ART_FRAME`, `ART_TABLE_CELL`, `ART_GEOMETRY_LINE`, `ART_CORNER` and `ART_COLOUR_REGION` | -| **Default Value**
    ["ART_TEXT_LINE","ART_BARCODE","ART_FRAME"] | - -#### ReferenceTaskNameArray - -Filter the reference object by specifying the reference task name array. - -| AtomicResultTypeArray Parameter Summary | -| :------------------- | -| **Type**
    *String[]* | -| **Range**
    Each member should be one of the task in the reference TargetROIDef object array. | -| **Default Value**
    null | - -#### BarcodeFilteringCondition - -One of the filter conditions. Filter the reference objects with the decoded barcode information. The parameter `BarcodeFilteringCondition` includes the following child parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Child Parameter NameChild Parameter Summary
    BarcodeFormatIdsDescription
    Filter the reference objects by the barcode formats. -
    Type
    String[] -
    Range
    Each member of the array should be one of the BarcodeFormatIds as a string. -
    Default Value
    -
    BarcodeTextRegExPatternDescription
    Filter the reference objects by the barcode text with a RegEx string. -
    Type
    String -
    Default Value
    "" -
    - -#### FrameFilteringCondition - -One of the filter conditions. Filter the reference objects with the frame information. The parameter `FrameFilteringCondition` includes the following child parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Child Parameter NameChild Parameter Summary
    ImageDimensionRangeDescription
    Filter the reference objects by the dimension of their original images. -
    Type
    int[2] -
    Default Value
    [16384,0x7fffffff] -
    AspectRatioRangeDescription
    Filter the reference objects by the aspect ratio of their original images. -

    Aspect Ratio = BoundingRectHeight/BoundingRectWidth * 100

    [MinAspectRatio, MaxAspectRatio] -
    Type
    int[2] -
    Default Value
    [1, 10000] -
    WidthRangeDescription
    Filter the reference objects by the width of their original images. -
    Type
    int[2] -
    Default Value
    [1, 0x7fffffff] -
    HeightRangeDescription
    Filter the reference objects by the height of their original images. -
    Type
    int[2] -
    Default Value
    [1, 0x7fffffff] -
    - -#### TextLineFilteringCondition - -One of the filter conditions. Filter the reference objects with the text line content. The parameter `TextLineFilteringCondition` includes the following child parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Child Parameter NameChild Parameter Summary
    LineNumbersDescription
    Filter the reference objects by the line numbers. -
    Type
    String -
    Range
    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. -
    Default Value
    "" -
    Remarks
    (1) The value is 1-based.
    (2) "" represents all lines.
    (3) The processed of the not specified text lines will implement the default settings.
    (4) If the line number you specified doesn't exist, the library will ignore it. -
    LineStringRegExPatternDescription
    Filter the reference objects by the content of the text line with a RegEx string. -
    Type
    String -
    Default Value
    "" -
    - -### Offset - -Parameter `Offset` is an object that defines how the location is offset from the `reference object` or the original image. It includes the following child parameters: - -* ReferenceObjectOriginIndex -* ReferenceObjectType -* ReferenceXAxis -* ReferenceYAxis -* MeasuredByPercentage -* FirstPoint -* SecondPoint -* ThirdPoint -* FourthPoint - -#### ReferenceObjectOriginIndex - -Defines which point of the reference object will be set as the origin of the coordinate system. - -| ReferenceObjectOriginIndex Parameter Details | -| :------------------- | -| **Type**
    *int* | -| **Value Range**
    [0,3] | -| **Default Value**
    0 | - -#### ReferenceObjectType - -Defines which coordinate system to use when configuring offset parameters basd on the reference objects. - -| ReferenceObjectType Parameter Details | -| :------------------- | -| **Type**
    *String* | -| **Value Range**
    "ROT_ATOMIC_OBJECT" or "ROT_WHOLE_IMAGE" | -| **Default Value**
    "ROT_ATOMIC_OBJECT" | - -#### ReferenceXAxis - -Defines the x-axis of the coordinate system to use when configuring offset parameters basd on the reference objects. It includes the following child parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Child Parameter NameChild Parameter Details
    AxisType
    		Description
    The type of the axis. -
    Type
    String -
    Value Range
    "AT_MIDPOINT_EDGE", "AT_EDGE", or "AT_ROTATION_OTHER_AXIS" -
    "AT_MIDPOINT_EDGE": Indicates connecting the midpoints of the reference object's opposite edges as the axis. -
    "AT_EDGE": Indicates using one of the reference object's edges as the axis. -
    "AT_ROTATION_OTHER_AXIS": Indicates deriving the current axis by rotating another reference axis. -
    Default Value
    "AT_MIDPOINT_EDGE" -
    EdgeIndex
    		Description
    Define which edge of the reference object will be set as the x-axis of the coordinate system. -
    Type
    int -
    Value Range
    0, 1, 2, 3 -
    Default Value
    0 -
    Remarks
    Valid only when `AxisType` is "AT_EDGE" -
    RotationAngle
    		Description
    The counterclockwise rotation angle used to rotate the reference axis. -
    Type
    int -
    Value Range
    [0, 180] -
    Default Value
    90 -
    RemarksValid only when `AxisType` is "AT_ROTATION_OTHER_AXIS". -
    LengthReference
    		Description
    Defines the measurement benchmark. -
    Type
    String -
    Value Range
    "LR_X", "LR_Y" -
    "LR_X": Indicates using the x-axis edge length as the standard length within the coordinate system. -
    "LR_Y": Indicates using the y-axis edge length as the standard length within the coordinate system . -
    Default Value
    "LR_X" -
    Remarks
    Valid only when `AxisType` is "AT_MIDPOINT_EDGE" or "AT_EDGE" -
    - -#### ReferenceYAxis - -Defines the y-axis of the coordinate system to use when configuring offset parameters basd on the reference objects. It includes the following child parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Child Parameter NameChild Parameter Details
    AxisType
    		Description
    The type of the axis. -
    Type
    String -
    Value Range
    "AT_MIDPOINT_EDGE", "AT_EDGE", or "AT_ROTATION_OTHER_AXIS" -
    "AT_MIDPOINT_EDGE": Indicates connecting the midpoints of the reference object's opposite edges as the axis. -
    "AT_EDGE": Indicates using one of the reference object's edges as the axis. -
    "AT_ROTATION_OTHER_AXIS": Indicates deriving the current axis by rotating another reference axis. -
    Default Value
    "AT_MIDPOINT_EDGE" -
    EdgeIndex
    		Description
    Define which edge of the reference object will be set as the y-axis of the coordinate system. -
    Type
    int -
    Value Range
    0, 1, 2, 3 -
    Default Value
    1 -
    Remarks
    Valid only when `AxisType` is "AT_EDGE" -
    RotationAngle
    		Description
    The clockwise rotation angle used to rotate the reference axis. -
    Type
    int -
    Value Range
    [0, 180] -
    Default Value
    90 -
    RemarksValid only when `AxisType` is "AT_ROTATION_OTHER_AXIS". -
    LengthReference
    		Description
    Defines the measurement benchmark. -
    Type
    String -
    Value Range
    "LR_X", "LR_Y" -
    "LR_X": Indicates using the x-axis edge length as the standard length within the coordinate system. -
    "LR_Y": Indicates using the y-axis edge length as the standard length within the coordinate system . -
    Default Value
    "LR_Y" -
    Remarks
    Valid only when `AxisType` is "AT_MIDPOINT_EDGE" or "AT_EDGE" -
    - -#### MeasuredByPercentage - -Sets whether or not to use percentage to measure the points' coordinates. - -| MeasuredByPercentage Parameter Details | -| :------------------- | -| **Type**
    *int* | -| **Range**
    0 or 1 | -| **Default Value**
    1 | -| **Remarks**
    0: not by percentage
    1: by percentage | - -#### FirstPoint - -Specifies the top-left vertex of the ROI with two possible expression forms: - -* `[X, Y]`: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameter `MeasuredByPercentage`. -* `[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]`: Includes independent control over whether the values for x and y are expressed in percentage. `MeasuredXByPercentage` determines if the x-value is in percentage, and `MeasuredYByPercentage` controls the y-value. - -| FirstPoint Parameter Details | -| :------------------- | -| **Type**
    *int[2]* or *int[4]* | -| **Default Value**
    null | - -#### SecondPoint - -Specifies the top-right vertex of the ROI with two possible expression forms: - -* `[X, Y]`: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameter `MeasuredByPercentage`. -* `[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]`: Includes independent control over whether the values for x and y are expressed in percentage. `MeasuredXByPercentage` determines if the x-value is in percentage, and `MeasuredYByPercentage` controls the y-value. - -| FirstPoint Parameter Details | -| :------------------- | -| **Type**
    *int[2]* or *int[4]* | -| **Default Value**
    null | - -#### ThirdPoint - -Specifies the bottom-right vertex of the ROI with two possible expression forms: - -* `[X, Y]`: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameter `MeasuredByPercentage`. -* `[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]`: Includes independent control over whether the values for x and y are expressed in percentage. `MeasuredXByPercentage` determines if the x-value is in percentage, and `MeasuredYByPercentage` controls the y-value. - -| FirstPoint Parameter Details | -| :------------------- | -| **Type**
    *int[2]* or *int[4]* | -| **Default Value**
    null | - -#### FourthPoint - -Specifies the bottom-left vertex of the ROI with two possible expression forms: - -* `[X, Y]`: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameter `MeasuredByPercentage`. -* `[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]`: Includes independent control over whether the values for x and y are expressed in percentage. `MeasuredXByPercentage` determines if the x-value is in percentage, and `MeasuredYByPercentage` controls the y-value. - -| FirstPoint Parameter Details | -| :------------------- | -| **Type**
    *int[2]* or *int[4]* | -| **Default Value**
    null | - diff --git a/parameters/reference/text-line-specification/character-model-name-v2.6.1004.md b/parameters/reference/text-line-specification/character-model-name-v2.6.1004.md deleted file mode 100644 index e93e6f8..0000000 --- a/parameters/reference/text-line-specification/character-model-name-v2.6.1004.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default-layout -title: CharacterModelName - Dynamsoft Label Recognizer Parameters -description: The parameter CharacterModelName of Dynamsoft Label Recognizer defines the name of character models. -keywords: Character model -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# CharacterModelName - -Parameter `CharacterModelName` defines the name of the character model. - -## Example - -```json -{ - "CharacterModelName": "NumberLetter" -} -``` - -## Parameter Summary - -| CharacterModelName Parameter Summary | -| :----------------------------------- | -| **Type**
    *String* | -| **Range**
    The name of a `CharacterModel` object that defined in `CharacterModelOptions`. | -| **Default Value**
    "NumberLetter" |