- Remarks
Only available for "DM_PERSPECTIVE_CORRECTION".
+ | Remarks
Only available for "DSM_PERSPECTIVE_CORRECTION".
0: Direction unknown.
1: Vertical direction.
2: Horizontal direction.
@@ -89,13 +104,13 @@ If the `DeskewMode` is not configured in your template file, the following setti
"DeskewMode" :
{
"ContentDirection" : 0,
- "Mode" : "DM_PERSPECTIVE_CORRECTION"
+ "Mode" : "DSM_PERSPECTIVE_CORRECTION"
}
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
-### DM_PERSPECTIVE_CORRECTION
+### DSM_PERSPECTIVE_CORRECTION
Deskew the document by applying perspective correction process.
diff --git a/parameters/reference/document-normalizer-task-settings/expected-documents-count.md b/parameters/reference/document-normalizer-task-settings/expected-documents-count.md
index 6805f0d..2ccac1d 100644
--- a/parameters/reference/document-normalizer-task-settings/expected-documents-count.md
+++ b/parameters/reference/document-normalizer-task-settings/expected-documents-count.md
@@ -1,28 +1,42 @@
---
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.
+description: The parameter ExpectedDocumentsCount 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.
+`ExpectedDocumentsCount` sets the number of documents expected to be detected.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── ExpectedDocumentsCount
+```
+
+**Parent object:** [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html)
+
+**Example:**
```json
{
- "ExpectedDocumentsCount" : 1
+ "ExpectedDocumentsCount": 1
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `ExpectedDocumentsCount` parameter.
+> - To use it, embed this parameter within a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| ExpectedDocumentsCount Parameter Summary |
+| ExpectedDocumentsCount Parameter Details |
| :--------------- |
| **Type**
int |
| **Range**
[0, 0x7fffffff] |
diff --git a/parameters/reference/document-normalizer-task-settings/line-assembly-mode.md b/parameters/reference/document-normalizer-task-settings/line-assembly-mode.md
deleted file mode 100644
index 860b617..0000000
--- a/parameters/reference/document-normalizer-task-settings/line-assembly-mode.md
+++ /dev/null
@@ -1,102 +0,0 @@
----
-layout: default-layout
-title: LineAssemblyMode - Dynamsoft Capture Vision Parameters
-description: The parameter LineAssemblyMode of Dynamsoft Capture Vision is for assembling short lines.
-keywords: LineAssemblyMode, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
----
-
-
-# LineAssemblyMode
-
-Parameter `LineAssemblyMode` determines how to assemble the short lines. For tasks like document detection, short line is very important and usually requires a stronger assembling sensitivity to ensure enough lines are captured.
-
-## Example
-
-```json
-{
- "LineAssemblyMode":
- {
- "Mode": "LAM_GENERAL",
- "Sensitivity": 3
- }
-}
-```
-
-## Parameter Summary
-
-Parameter `LineAssemblyMode` includes a mode arguments shown as follow:
-
-### Mode Arguments
-
-
-
-
- | Mode Argument Name |
- Mode Argument Summary |
-
-
-
- Mode
(Required) |
- Description
Any one in Candidate Mode List as string
- |
-
-
- Type
String
- |
-
-
- Candidate Mode List
LAM_GENERAL
- |
-
-
- Default Value
LAM_GENERAL
- |
-
-
- Sensitivity
(Optional) |
- Description
Sets the sensitivity used for short line assembling. A larger value means the library will take more effort to assemble short lines.
- |
-
-
- Type
int
- |
-
-
- Range
[1, 9]
- |
-
-
- Valid For
-
LAM_GENERAL
- |
-
-
-
-### Default Setting
-
-If the `LineAssemblyMode` is not configured in your template file, the following setting will be used as the default setting.
-
-```json
-{
- "LineAssemblyMode":
- [
- {
- "Mode": "LAM_GENERAL",
- "Sensitivity": 6
- }
- ]
-}
-```
-
-## Candidate Modes Introduction
-
-### LAM_GENERAL
-
-Assemble short lines using the general algorithm. This mode has the following arguments for further customization.
-
-**Available Mode Arguments:**
-
-- Sensitivity
diff --git a/parameters/reference/document-normalizer-task-settings/line-extraction-modes.md b/parameters/reference/document-normalizer-task-settings/line-extraction-modes.md
deleted file mode 100644
index fbd24d2..0000000
--- a/parameters/reference/document-normalizer-task-settings/line-extraction-modes.md
+++ /dev/null
@@ -1,89 +0,0 @@
----
-layout: default-layout
-title: LineExtractionModes - Dynamsoft Document Normalizer Parameters
-description: The parameter LineExtractionModes of Dynamsoft Document Normalizer is to specifies the modes used in line extraction.
-keywords:
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
-ignore: true
-pageEndVer: 2.4.2200
----
-
-# LineExtractionModes
-
-Parameter `LineExtractionModes` specifies the algorithm used to extract lines. It currently consist of `LEM_GENERAL` and `LEM_MARGIN_BASED`. Each mode representing a different way to extract lines.
-
-## Example
-
-```json
-{
- "LineExtractionModes":
- [
- {
- "Mode": "LEM_GENERAL"
- },
- {
- "Mode": "LEM_MARGIN_BASED"
- }
- ]
-}
-```
-
-## Parameter Summary
-
-`LineExtractionModes` consist one or more mode objects. Each mode object contains a candidate mode and other mode arguments.
-
-### Mode Arguments
-
-
-
-
- | Mode Argument Name |
- Mode Argument Summary |
-
-
-
- Mode
(Required) |
- Description
Specifies a mode for line extraction.
- |
-
-
- Type
String
- |
-
-
- Candidate Mode List
LEM_GENERAL
-
LEM_MARGIN_BASED
- |
-
-
- Default Value
["LEM_GENERAL"]
- |
-
-
-
-### Default Setting
-
-If the `LineExtractionModes` is not configured in your template file, the following setting will be used as the default setting.
-
-```json
-{
- "LineExtractionModes" :
- [
- {
- "Mode" : "LEM_GENERAL"
- }
- ]
-}
-```
-
-## Candidate Modes Introduction
-
-### LEM_GENERAL
-
-Designed for the senarios where the document background colour is distinct from the environment background colour. In these scenarios, contours of the document bounaries are clear enough on the binary images. As a result, the line segments can be easily extracted from the image.
-
-### LEM_MARGIN_BASED
-
-Designed for the senarios where the background colour is similar to the environment background colour. For these scenarios, it is hard to get distinct contours of document boundaries with general binarization process. When the mode `LEM_MARGIN_BASED` is enabled, the library will implement different parameters for the binarization mode to separate the document contents and the background areas. The line segments of the document boundaries will be extracted from the margin between document contents and the background areas.
diff --git a/parameters/reference/document-normalizer-task-settings/max-threads-in-one-task.md b/parameters/reference/document-normalizer-task-settings/max-threads-in-one-task.md
index 3f7004b..b476a52 100644
--- a/parameters/reference/document-normalizer-task-settings/max-threads-in-one-task.md
+++ b/parameters/reference/document-normalizer-task-settings/max-threads-in-one-task.md
@@ -3,26 +3,40 @@ layout: default-layout
title: MaxThreadsInOneTask - Dynamsoft Document Normalizer Parameters
description: The parameter MaxThreadsInOneTask defines the maximum threads that can be consumed in one document normalizer task.
keywords: Max threads
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# MaxThreadsInOneTask
-Parameter `MaxThreadsInOneTask` defines the maximum threads that can be consumed in one task.
+`MaxThreadsInOneTask` defines the maximum threads that can be consumed in one task.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── MaxThreadsInOneTask
+```
+
+**Parent object:** [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html)
+
+**Example:**
```json
{
- "MaxThreadsInOneTask":4
+ "MaxThreadsInOneTask": 4
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `MaxThreadsInOneTask` parameter.
+> - To use it, embed this parameter within a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| MaxThreadsInOneTask Parameter Summary |
+| MaxThreadsInOneTask Parameter Details |
| :------------- |
| **Type**
*int* |
| **Range**
[0, 256] |
diff --git a/parameters/reference/document-normalizer-task-settings/name.md b/parameters/reference/document-normalizer-task-settings/name.md
index 7ff6ab8..abe7c7c 100644
--- a/parameters/reference/document-normalizer-task-settings/name.md
+++ b/parameters/reference/document-normalizer-task-settings/name.md
@@ -1,26 +1,40 @@
---
layout: default-layout
-title: DocumentNormalizerTaskSetting Name - Dynamsoft Document Normalizer Parameter.
+title: Name - Dynamsoft Document Normalizer DocumentNormalizerTaskSetting Parameters
description: The parameter Name defines the unique identifier of a DocumentNormalizerTaskSetting object.
keywords: top-level object, name, unique identifier
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# Name
-Parameter `Name` represents the name of a `DocumentNormalizerTaskSetting` object, which serves as its unique identifier.
+`Name` represents the name of a `DocumentNormalizerTaskSetting` object, which serves as its unique identifier.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── Name
+```
+
+**Parent object:** [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html)
+
+**Example:**
```json
{
- "Name" : "dn_0"
+ "Name": "dn_0"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Name` parameter.
+> - To use it, embed this parameter within a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
| Parameter Details |
| :----------------------------------- |
diff --git a/parameters/reference/document-normalizer-task-settings/page-size.md b/parameters/reference/document-normalizer-task-settings/page-size.md
index 8d5cfa9..0d0a619 100644
--- a/parameters/reference/document-normalizer-task-settings/page-size.md
+++ b/parameters/reference/document-normalizer-task-settings/page-size.md
@@ -1,28 +1,44 @@
---
layout: default-layout
title: PageSize - Dynamsoft Document Normalizer Parameters
-description: The parameter PageSize of Dynamsoft Document Normalizer is XXX.
+description: The parameter PageSize sets the page size of the target image.
keywords: Page size
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# PageSize
-Parameter `PageSize` sets the page size (width by height in pixels) of the target image.
+`PageSize` sets the page size (width by height in pixels) of the target image.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_DESKEW_IMAGE")
+ └── PageSize
+```
+
+**Parent object:** [DeskewImageStage]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/stage-deskew-image.html)
+
+**Example:**
```json
{
- "PageSize" : [ 210, 297 ]
+ "PageSize": [210, 297]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `PageSize` parameter.
+> - To use it, embed this parameter within a [DeskewImageStage]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/stage-deskew-image.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| PageSize Parameter Summary |
+| PageSize Parameter Details |
| :--------------- |
| **Type**
int[2] |
| **Range**
Each member should be a int value betweem [-1,0x7fffffff]. |
diff --git a/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes.md b/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes.md
index e595457..7f5042e 100644
--- a/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes.md
+++ b/parameters/reference/document-normalizer-task-settings/quadrilateral-detection-modes.md
@@ -1,31 +1,47 @@
---
layout: default-layout
title: QuadrilateralDetectionModes - Dynamsoft Document Normalizer Parameters
-description: The parameter QuadrilateralDetectionModes of Dynamsoft Document Normalizer.
+description: The parameter QuadrilateralDetectionModes controls the quadrilateral detection process on an image.
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.
+`QuadrilateralDetectionModes` controls the quadrilateral detection process on an image. It currently includes only one mode.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_DETECT_QUADS")
+ └── QuadrilateralDetectionModes
+```
+
+**Parent object:** [DetectQuadsStage]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/stage-detect-quads.html)
+
+**Example:**
```json
{
"QuadrilateralDetectionModes": [
{
"Mode": "QDM_GENERAL",
- "MinQuadrilateralAreaRatio" : 30
+ "MinQuadrilateralAreaRatio": 30
}
]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `QuadrilateralDetectionModes` parameter.
+> - To use it, embed this parameter within a [DetectQuadsStage]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/stage-detect-quads.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
`QuadrilateralDetectionModes` consist one or more mode objects. Each mode object contains a candidate mode and other mode arguments.
@@ -90,7 +106,7 @@ If the `QuadrilateralDetectionModes` is not configured in your template file, th
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### QDM_GENERAL
diff --git a/parameters/reference/document-normalizer-task-settings/section-array.md b/parameters/reference/document-normalizer-task-settings/section-array.md
index c5144fe..b7671ac 100644
--- a/parameters/reference/document-normalizer-task-settings/section-array.md
+++ b/parameters/reference/document-normalizer-task-settings/section-array.md
@@ -3,46 +3,59 @@ layout: default-layout
title: SectionArray - Dynamsoft Document Normalizer Parameters
description: The parameter SectionArray defines which sections exist under the DocumentNormalizerTask.
keywords: Section Array parameter
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# SectionArray
-`SectionArray` is a parameter that defines which sections exist under the `DocumentNormalizerTask`. A `Section` is a sequence of Stages that form a relatively complete processing unit, producing milestone results that include location information along with other details.
+Parameter `SectionArray` defines which sections exist under the `DocumentNormalizerTask`. A `Section` is a sequence of `Stages` that form a relatively complete processing unit, producing milestone results that include location information along with other details.
-The `DocumentNormalizerTask` includes the following sections:
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray
+```
+
+**Parent object:** [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html) object
-* [ST_REGION_PREDETECTION](./section-regions-predetection.md)
- * It is designed to find regions of interest (ROIs) and thus ignoring other parts of the image during subsequent processing.
-* [ST_DOCUMENT_DETECTION](./section-document-detection.md)
- * It is designed to detect the edges of the document.
-* [ST_DOCUMENT_DESKEWING](./section-document-deskewing.md)
- * It is designed to correct perspective distortion.
-* [ST_IMAGE_ENHANCEMENT](./section-image-enhancement.md)
- * It is designed to enhance the quality of the image.
+**Example:**
```json
{
- "SectionArray":
- [
+ "SectionArray": [
{
- "Section": "ST_REGION_PREDETECTION",
- // Other parameters...
+ "Section": "ST_REGION_PREDETECTION"
},
{
- "Section": "ST_DOCUMENT_DETECTION",
- // Other parameters...
+ "Section": "ST_DOCUMENT_DETECTION"
},
{
- "Section": "ST_DOCUMENT_DESKEWING",
- // Other parameters...
+ "Section": "ST_DOCUMENT_DESKEWING"
},
{
- "Section": "ST_IMAGE_ENHANCEMENT",
- // Other parameters...
+ "Section": "ST_IMAGE_ENHANCEMENT"
}
]
}
```
+
+> [!NOTE]
+> - This snippet shows only the `SectionArray` parameter.
+> - To use it, embed this parameter within a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+The `DocumentNormalizerTask` includes the following sections:
+
+* [RegionPredetectionSection](./section-regions-predetection.md) (`ST_REGION_PREDETECTION`)
+ * Designed to find regions of interest (ROIs) and thus ignore other parts of the image during subsequent processing.
+* [DocumentDetectionSection](./section-document-detection.md) (`ST_DOCUMENT_DETECTION`)
+ * Designed to detect the edges of the document.
+* [DocumentDeskewingSection](./section-document-deskewing.md) (`ST_DOCUMENT_DESKEWING`)
+ * Designed to correct perspective distortion.
+* [ImageEnhancementSection](./section-image-enhancement.md) (`ST_IMAGE_ENHANCEMENT`)
+ * Designed to enhance the quality of the image.
diff --git a/parameters/reference/document-normalizer-task-settings/section-document-deskewing.md b/parameters/reference/document-normalizer-task-settings/section-document-deskewing.md
index 69d7735..483e412 100644
--- a/parameters/reference/document-normalizer-task-settings/section-document-deskewing.md
+++ b/parameters/reference/document-normalizer-task-settings/section-document-deskewing.md
@@ -1,44 +1,71 @@
---
layout: default-layout
-title: Document Deskewing Section - Dynamsoft Document Normalizer Parameters
-description: The parameter defines document deskewing section under the DocumentNormalizerTask.
-keywords: Document Deskewing Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: DocumentDeskewingSection - Dynamsoft Document Normalizer Parameters
+description: The DocumentDeskewingSection corrects perspective distortion by deskewing the document.
+keywords: DocumentDeskewingSection
---
-# Document Deskewing Section
+# DocumentDeskewingSection
-The Document Deskewing Section is designed to detect the edges of a document.
+`DocumentDeskewingSection` corrects perspective distortion by deskewing the document. In JSON, it is represented as a Section object with `"Section": "ST_DOCUMENT_DESKEWING"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_DOCUMENT_DESKEWING")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_DOCUMENT_DESKEWING",
"ImageParameterName": "ip_ddnDefault",
- "StageArray": []
+ "StageArray": [
+ {
+ "Stage": "SST_DESKEW_IMAGE"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for document deskewing.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html) of a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_DOCUMENT_DESKEWING`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_DOCUMENT_DESKEWING`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_ddnDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_DOCUMENT_DESKEWING"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `Document Deskewing Section`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `Document Deskewing Section` consists of only one stage:
+Specifies the stage objects within this section. The `DocumentDeskewingSection` consists of the following stages:
-* [SST_DESKEW_IMAGE](./stage-deskew-image.md)
- * It is designed at the stage level to de-skew the quadrilateral to transform it into a rectangle.
+| Stage | Description |
+|-------|-------------|
+| [DeskewImageStage](./stage-deskew-image.md) (`SST_DESKEW_IMAGE`) | Deskews the quadrilateral to transform it into a rectangle. |
diff --git a/parameters/reference/document-normalizer-task-settings/section-document-detection.md b/parameters/reference/document-normalizer-task-settings/section-document-detection.md
index 05d6472..3a19f3a 100644
--- a/parameters/reference/document-normalizer-task-settings/section-document-detection.md
+++ b/parameters/reference/document-normalizer-task-settings/section-document-detection.md
@@ -1,52 +1,75 @@
---
layout: default-layout
-title: Document Detection Section - Dynamsoft Document Normalizer Parameters
-description: The parameter defines document detection section under the DocumentNormalizerTask.
-keywords: Document Detection Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: DocumentDetectionSection - Dynamsoft Document Normalizer Parameters
+description: The DocumentDetectionSection detects the edges of a document.
+keywords: DocumentDetectionSection
---
-# Document Detection Section
+# DocumentDetectionSection
-The Document Detection Section is designed to detect the edges of a document.
+`DocumentDetectionSection` detects the edges of a document. In JSON, it is represented as a Section object with `"Section": "ST_DOCUMENT_DETECTION"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_DOCUMENT_DETECTION")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_DOCUMENT_DETECTION",
"ImageParameterName": "ip_ddnDefault",
- "StageArray": []
+ "StageArray": [
+ {
+ "Stage": "SST_DETECT_QUADS"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for document detection.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html) of a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_DOCUMENT_DETECTION`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_DOCUMENT_DETECTION`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_ddnDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_DOCUMENT_DETECTION"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `Document Detection Section`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `Document Detection Section` consists of stages show below:
+Specifies the stage objects within this section. The `DocumentDetectionSection` consists of the following stages:
-* [SST_ASSEMBLE_LONG_LINES](./stage-assemble-long-lines.md)
- * It is designed at the stage level to assemble relatively long line segments to facilitate the assembly of more advanced line segments.
-* [SST_ASSEMBLE_LOGICAL_LINES](./stage-assemble-logical-lines.md)
- * It is designed at the stage level to assemble line segments based on certain criteria to serve the assembly of quadrilateral corners.
-* [SST_DETECT_CORNERS](./stage-detect-corners.md)
- * It is designed at the stage level to detect corners of quadrilaterals that meet the specified conditions.
-* [SST_DETECT_EDGES](./stage-detect-edges.md)
- * It is designed at the stage level to detect edges of quadrilaterals that meet the specified conditions.
-* [SST_DETECT_QUADS](./stage-detect-quads.md)
- * It is designed at the stage level to detect complete quadrilaterals.
+| Stage | Description |
+|-------|-------------|
+| [AssembleLongLinesStage](./stage-assemble-long-lines.md) (`SST_ASSEMBLE_LONG_LINES`) | Assembles relatively long line segments to facilitate the assembly of more advanced line segments. |
+| [AssembleLogicalLinesStage](./stage-assemble-logical-lines.md) (`SST_ASSEMBLE_LOGICAL_LINES`) | Assembles line segments based on certain criteria to serve the assembly of quadrilateral corners. |
+| [DetectCornersStage](./stage-detect-corners.md) (`SST_DETECT_CORNERS`) | Detects corners of quadrilaterals that meet the specified conditions. |
+| [DetectEdgesStage](./stage-detect-edges.md) (`SST_DETECT_EDGES`) | Detects edges of quadrilaterals that meet the specified conditions. |
+| [DetectQuadsStage](./stage-detect-quads.md) (`SST_DETECT_QUADS`) | Detects complete quadrilaterals. |
diff --git a/parameters/reference/document-normalizer-task-settings/section-image-enhancement.md b/parameters/reference/document-normalizer-task-settings/section-image-enhancement.md
index a3a0289..356014f 100644
--- a/parameters/reference/document-normalizer-task-settings/section-image-enhancement.md
+++ b/parameters/reference/document-normalizer-task-settings/section-image-enhancement.md
@@ -1,44 +1,71 @@
---
layout: default-layout
-title: Image Enhancement Section - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Image Enhancement section under the DocumentNormalizerTask.
-keywords: Image Enhancement Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: ImageEnhancementSection - Dynamsoft Document Normalizer Parameters
+description: The ImageEnhancementSection adjusts the image quality.
+keywords: ImageEnhancementSection
---
-# Image Enhancement Section
+# ImageEnhancementSection
-The Image Enhancement Section is designed to adjust the image quality.
+`ImageEnhancementSection` adjusts the image quality. In JSON, it is represented as a Section object with `"Section": "ST_IMAGE_ENHANCEMENT"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_IMAGE_ENHANCEMENT")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_IMAGE_ENHANCEMENT",
"ImageParameterName": "ip_ddnDefault",
- "StageArray": []
+ "StageArray": [
+ {
+ "Stage": "SST_ENHANCE_IMAGE"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for image enhancement.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html) of a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_IMAGE_ENHANCEMENT`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_IMAGE_ENHANCEMENT`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_ddnDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_IMAGE_ENHANCEMENT"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `Image Enhancement Section`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `Image Enhancement Section` consists of only one stage:
+Specifies the stage objects within this section. The `ImageEnhancementSection` consists of the following stages:
-* [SST_ENHANCE_IMAGE](./stage-enhance-image.md)
- * It is designed at the stage level to adjust the image quality, such as changing the brightness, contrast, and the color mode of the image.
+| Stage | Description |
+|-------|-------------|
+| [EnhanceImageStage](./stage-enhance-image.md) (`SST_ENHANCE_IMAGE`) | Adjusts the image quality, such as changing the brightness, contrast, and color mode. |
diff --git a/parameters/reference/document-normalizer-task-settings/section-image-parameter-array.md b/parameters/reference/document-normalizer-task-settings/section-image-parameter-array.md
deleted file mode 100644
index 3566989..0000000
--- a/parameters/reference/document-normalizer-task-settings/section-image-parameter-array.md
+++ /dev/null
@@ -1,74 +0,0 @@
----
-layout: default-layout
-title: SectionImageParameterArray - Dynamsoft Document Normalizer Parameters
-description: The parameter SectionImageParameterArray defines the image processing algorithms that implemented in the different sections of a document normalizer algorithm task.
-keywords: Section image parameter
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
----
-
-# SectionImageParameterArray
-
-`SectionImageParameterArray` is a parameter that defines `ImageParameter` in section unit. Each `SectionImageParameterArray` element is a group of a section name and a `ImageParameter` name so that this section will use the ImageParameter you specified. If a section is not specified in the array, it will use the default `ImageParameter` configuration.
-
-The `DocumentNormalizerTask` includes the following sections:
-
-* `ST_REGION_PREDETECTION`
-* `ST_DOCUMENT_DETECTION`
-* `ST_DOCUMENT_NORMALIZATION`
-
-## Example
-
-```json
-{
- "SectionImageParameterArray":
- [
- {
- "Section": "ST_REGION_PREDETECTION",
- "ImageParameterName": "IP_0"
- },
- {
- "Section": "ST_DOCUMENT_DETECTION",
- "ImageParameterName": "IP_1"
- },
- {
- "Section": "ST_DOCUMENT_NORMALIZATION",
- "ImageParameterName": "IP_1"
- }
-
- ]
-}
-```
-
-## Parameter Summary
-
-
-
-
- | Child Parameter Name |
- Child Parameter Summary |
-
-
-
- Section
|
- Description
Specifies an algorithm section. |
-
-
- Type
String |
-
-
- Range
One of the following SectionType as a string.
-
ST_REGION_PREDETECTION
-
ST_DOCUMENT_DETECTION
-
ST_DOCUMENT_NORMALIZATION
- |
-
-
- ImageParameterName
|
- Description
Specifies the ImageParameter that you want to implement in this section. It must be one of the name that defined under ImageParameterOptions. |
-
-
- Type
String |
-
-
diff --git a/parameters/reference/document-normalizer-task-settings/section-regions-predetection.md b/parameters/reference/document-normalizer-task-settings/section-regions-predetection.md
index 684d713..74e0fbf 100644
--- a/parameters/reference/document-normalizer-task-settings/section-regions-predetection.md
+++ b/parameters/reference/document-normalizer-task-settings/section-regions-predetection.md
@@ -1,44 +1,71 @@
---
layout: default-layout
-title: Regions Predetection Section - Dynamsoft Label Recognizer Parameters
-description: The parameter defines regions predtection section under the LabelRecognizerTask.
-keywords: Regions Predetection Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: RegionPredetectionSection - Dynamsoft Document Normalizer Parameters
+description: The RegionPredetectionSection identifies regions of interest (ROIs) for subsequent processing.
+keywords: RegionPredetectionSection
---
-# Regions Predetection Section
+# RegionPredetectionSection
-The Regions Predetection Section is designed to identify regions of interest (ROIs), allowing subsequent processing to ignore other parts of the image. The pre-detected region may be identified based on color features, grayscale features, or neural network localization.
+`RegionPredetectionSection` identifies regions of interest (ROIs), allowing subsequent processing to ignore other parts of the image. In JSON, it is represented as a Section object with `"Section": "ST_REGION_PREDETECTION"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_REGION_PREDETECTION")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_REGION_PREDETECTION",
- "ImageParameterName": "ip_dlrDefault",
- "StageArray": []
+ "ImageParameterName": "ip_ddnDefault",
+ "StageArray": [
+ {
+ "Stage": "SST_PREDETECT_REGIONS"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for region predetection.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-array.html) of a [DocumentNormalizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/document-normalizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_REGION_PREDETECTION`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_REGION_PREDETECTION`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_dlrDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_REGION_PREDETECTION"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `Regions Predetection Section`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `Regions Predetection Section` consists of a single stage:
+Specifies the stage objects within this section. The `RegionPredetectionSection` consists of the following stages:
-* [SST_PREDETECT_REGIONS](./stage-predetect-regions.md)
- * It is designed at the stage level to identify regions of interest (ROIs).
+| Stage | Description |
+|-------|-------------|
+| [PredetectRegionsStage](./stage-predetect-regions.md) (`SST_PREDETECT_REGIONS`) | Identifies regions of interest (ROIs). |
diff --git a/parameters/reference/document-normalizer-task-settings/short-line-detection-mode.md b/parameters/reference/document-normalizer-task-settings/short-line-detection-mode.md
deleted file mode 100644
index a345309..0000000
--- a/parameters/reference/document-normalizer-task-settings/short-line-detection-mode.md
+++ /dev/null
@@ -1,102 +0,0 @@
----
-layout: default-layout
-title: ShortLineDetectionMode - Dynamsoft Capture Vision Parameters
-description: The parameter ShortLineDetectionMode of Dynamsoft Capture Vision is for detecting short lines on an image.
-keywords: ShortLineDetectionMode, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
----
-
-
-# ShortLineDetectionMode
-
-Parameter `ShortLineDetectionMode` determines how to detect the short lines. For tasks like document detection, short line is very important and usually requires a stronger detection sensitivity to ensure enough short lines are captured.
-
-## Example
-
-```json
-{
- "ShortlineDetectionMode":
- {
- "Mode": "SDM_GENERAL",
- "Sensitivity": 3
- }
-}
-```
-
-## Parameter Summary
-
-Parameter `ShortlineDetectionMode` includes a mode arguments shown as follow:
-
-### Mode Arguments
-
-
-
-
- | Mode Argument Name |
- Mode Argument Summary |
-
-
-
- Mode
(Required) |
- Description
Any one in Candidate Mode List as string
- |
-
-
- Type
String
- |
-
-
- Candidate Mode List
SDM_GENERAL
- |
-
-
- Default Value
SDM_GENERAL
- |
-
-
- Sensitivity
(Optional) |
- Description
Sets the sensitivity used for short line detection. A larger value means the library will take more effort to detect short lines.
- |
-
-
- Type
int
- |
-
-
- Range
[1, 9]
- |
-
-
- Valid For
-
SDM_GENERAL
- |
-
-
-
-### Default Setting
-
-If the `ShortlineDetectionMode` is not configured in your template file, the following setting will be used as the default setting.
-
-```json
-{
- "ShortlineDetectionMode":
- [
- {
- "Mode": "SDM_GENERAL",
- "Sensitivity": 6
- }
- ]
-}
-```
-
-## Candidate Modes Introduction
-
-### SDM_GENERAL
-
-Detects short lines using the general algorithm. This mode has the following arguments for further customization.
-
-**Available Mode Arguments:**
-
-- Sensitivity
diff --git a/parameters/reference/document-normalizer-task-settings/stage-assemble-logical-lines.md b/parameters/reference/document-normalizer-task-settings/stage-assemble-logical-lines.md
index 9c4e561..bbc733b 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-assemble-logical-lines.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-assemble-logical-lines.md
@@ -1,16 +1,26 @@
---
layout: default-layout
-title: Assemble Logical Lines Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Assemble Logical Lines Stage under the Document Detection Section.
+title: AssembleLogicalLinesStage - Dynamsoft Document Normalizer Parameters
+description: The AssembleLogicalLinesStage assembles long line segments based on certain criteria.
keywords: Assemble Logical Lines Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Assemble Logical Lines Stage
+# AssembleLogicalLinesStage
-The `Assemble Logical Lines Stage` is designed at the stage level to assemble long line segments based on certain criteria to serve the assembly of quadrilateral corners.
+`AssembleLogicalLinesStage` assembles long line segments based on certain criteria to serve the assembly of quadrilateral corners. In JSON, it is represented as a Stage object with `"Stage": "SST_ASSEMBLE_LOGICAL_LINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_ASSEMBLE_LOGICAL_LINES")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html#stagearray) within [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html)
+
+**Example:**
```json
{
@@ -18,6 +28,21 @@ The `Assemble Logical Lines Stage` is designed at the stage level to assemble lo
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for assembling logical lines.
+> - To use it, add this object to the `StageArray` within a [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_ASSEMBLE_LOGICAL_LINES`.
-The stage is named `SST_ASSEMBLE_LOGICAL_LINES`.
\ No newline at end of file
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_ASSEMBLE_LOGICAL_LINES"` |
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-assemble-long-lines.md b/parameters/reference/document-normalizer-task-settings/stage-assemble-long-lines.md
index e429fbb..c5b334e 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-assemble-long-lines.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-assemble-long-lines.md
@@ -1,16 +1,26 @@
---
layout: default-layout
-title: Assemble Long Lines Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Assemble Long Lines Stage under the Document Detection Section.
+title: AssembleLongLinesStage - Dynamsoft Document Normalizer Parameters
+description: The AssembleLongLinesStage assembles relatively long line segments.
keywords: Assemble Long Lines Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Assemble Long Lines Stage
+# AssembleLongLinesStage
-The `Assemble Long Lines Stage` is designed at the stage level to assemble relatively long line segments to facilitate the assembly of more advanced line segments.
+`AssembleLongLinesStage` assembles relatively long line segments to facilitate the assembly of more advanced line segments. In JSON, it is represented as a Stage object with `"Stage": "SST_ASSEMBLE_LONG_LINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_ASSEMBLE_LONG_LINES")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html#stagearray) within [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html)
+
+**Example:**
```json
{
@@ -18,6 +28,21 @@ The `Assemble Long Lines Stage` is designed at the stage level to assemble relat
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for assembling long lines.
+> - To use it, add this object to the `StageArray` within a [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_ASSEMBLE_LONG_LINES`.
-The stage is named `SST_ASSEMBLE_LONG_LINES`.
\ No newline at end of file
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_ASSEMBLE_LONG_LINES"` |
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-deskew-image.md b/parameters/reference/document-normalizer-task-settings/stage-deskew-image.md
index bb149b8..09b3a81 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-deskew-image.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-deskew-image.md
@@ -1,39 +1,61 @@
---
layout: default-layout
-title: Deskew Image Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Deskew Image Stage under the Document Deskewing Section.
+title: DeskewImageStage - Dynamsoft Document Normalizer Parameters
+description: The DeskewImageStage de-skews the quadrilateral to transform it into a rectangle.
keywords: Deskew Image Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Deskew Image Stage
+# DeskewImageStage
-The `Deskew Image Stage` is designed at the stage level to de-skew the quadrilateral to transform it into a rectangle.
+`DeskewImageStage` de-skews the quadrilateral to transform it into a rectangle. In JSON, it is represented as a Stage object with `"Stage": "SST_DESKEW_IMAGE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_DESKEW_IMAGE")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-deskewing.html#stagearray) within [DocumentDeskewingSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-deskewing.html)
+
+**Example:**
```json
{
- "Stage": "SST_DESKEW_IMAGE",
- "DeskewMode": {
- "ContentDirection": 0,
- "Mode": "DSM_PERSPECTIVE_CORRECTION"
- },
- "PageSize": [
- -1,
- -1
- ]
+ "Stage": "SST_DESKEW_IMAGE",
+ "DeskewMode": {
+ "ContentDirection": 0,
+ "Mode": "DSM_PERSPECTIVE_CORRECTION"
+ },
+ "PageSize": [-1, -1]
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for deskewing images.
+> - To use it, add this object to the `StageArray` within a [DocumentDeskewingSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-deskewing.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_DESKEW_IMAGE`.
-The stage is named `SST_DESKEW_IMAGE`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DESKEW_IMAGE"` |
-## DeskewMode
+### DeskewMode
-Parameter [`DeskewMode`](./deskew-mode.md) specifies the method in which the deskew process way used to apply the deskew process on the target image.
+Specifies the method in which the deskew process is applied to the target image. See [`DeskewMode`](deskew-mode.md) for details.
-## PageSize
+### PageSize
-Parameter [`PageSize`](./page-size.md) sets the page size (width by height in pixels) of the image after deskew process.
\ No newline at end of file
+Sets the page size (width by height in pixels) of the image after deskew process. See [`PageSize`](page-size.md) for details.
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-detect-corners.md b/parameters/reference/document-normalizer-task-settings/stage-detect-corners.md
index b178aa3..e0a827f 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-detect-corners.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-detect-corners.md
@@ -1,31 +1,56 @@
---
layout: default-layout
-title: Detect Corners Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Detect Corners Stage under the Document Detection Section.
+title: DetectCornersStage - Dynamsoft Document Normalizer Parameters
+description: The DetectCornersStage detects corners of quadrilaterals that meet the specified conditions.
keywords: Detect Corners Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Detect Corners Stage
+# DetectCornersStage
-The `Detect Corners Stage` is designed at the stage level to detect corners of quadrilaterals that meet the specified conditions.
+`DetectCornersStage` detects corners of quadrilaterals that meet the specified conditions. In JSON, it is represented as a Stage object with `"Stage": "SST_DETECT_CORNERS"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_DETECT_CORNERS")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html#stagearray) within [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html)
+
+**Example:**
```json
{
"Stage": "SST_DETECT_CORNERS",
- "CornerAngleRange": {
- "MaxValue": 110,
- "MinValue": 70
- }
+ "CornerAngleRange": {
+ "MaxValue": 110,
+ "MinValue": 70
+ }
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for detecting corners.
+> - To use it, add this object to the `StageArray` within a [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_DETECT_CORNERS`.
-The stage is named `SST_DETECT_CORNERS`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DETECT_CORNERS"` |
-## CornerAngleRange
+### CornerAngleRange
-Parameter [`CornerAngleRange`](./corner-angle-range.md) specifies the range of angles (in degrees) of the extracted corners. The corners refer to the corners of a quad or document.
\ No newline at end of file
+Specifies the range of angles (in degrees) of the extracted corners. See [`CornerAngleRange`](corner-angle-range.md) for details.
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-detect-edges.md b/parameters/reference/document-normalizer-task-settings/stage-detect-edges.md
index 48f54d7..48bc069 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-detect-edges.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-detect-edges.md
@@ -1,16 +1,26 @@
---
layout: default-layout
-title: Detect Edges Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Detect Edges Stage under the Document Detection Section.
+title: DetectEdgesStage - Dynamsoft Document Normalizer Parameters
+description: The DetectEdgesStage detects edges of quadrilaterals that meet the specified conditions.
keywords: Detect Edges Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Detect Edges Stage
+# DetectEdgesStage
-The `Detect Edges Stage` is designed at the stage level to detect edges of quadrilaterals that meet the specified conditions.
+`DetectEdgesStage` detects edges of quadrilaterals that meet the specified conditions. In JSON, it is represented as a Stage object with `"Stage": "SST_DETECT_EDGES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_DETECT_EDGES")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html#stagearray) within [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html)
+
+**Example:**
```json
{
@@ -18,6 +28,21 @@ The `Detect Edges Stage` is designed at the stage level to detect edges of quadr
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for detecting edges.
+> - To use it, add this object to the `StageArray` within a [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_DETECT_EDGES`.
-The stage is named `SST_DETECT_EDGES`.
\ No newline at end of file
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DETECT_EDGES"` |
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-detect-quads.md b/parameters/reference/document-normalizer-task-settings/stage-detect-quads.md
index 37c459e..e3aba0a 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-detect-quads.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-detect-quads.md
@@ -1,32 +1,57 @@
---
layout: default-layout
-title: Detect Quads Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Detect Quads Stage under the Document Detection Section.
+title: DetectQuadsStage - Dynamsoft Document Normalizer Parameters
+description: The DetectQuadsStage detects complete quadrilaterals.
keywords: Detect Quads Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Detect Quads Stage
+# DetectQuadsStage
-The `Detect Quads Stage` is designed at the stage level to detect complete quadrilaterals.
+`DetectQuadsStage` detects complete quadrilaterals. In JSON, it is represented as a Stage object with `"Stage": "SST_DETECT_QUADS"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_DETECT_QUADS")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html#stagearray) within [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html)
+
+**Example:**
```json
{
-"Stage": "SST_DETECT_QUADS",
-"QuadrilateralDetectionModes": [
- {
- "Mode": "QDM_GENERAL"
- }
-]
+ "Stage": "SST_DETECT_QUADS",
+ "QuadrilateralDetectionModes": [
+ {
+ "Mode": "QDM_GENERAL"
+ }
+ ]
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for detecting quads.
+> - To use it, add this object to the `StageArray` within a [DocumentDetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-document-detection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_DETECT_QUADS`.
-The stage is named `SST_DETECT_QUADS`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DETECT_QUADS"` |
-## QuadrilateralDetectionModes
+### QuadrilateralDetectionModes
-Parameter [`QuadrilateralDetectionModes`](./quadrilateral-detection-modes.md) controls the quadrilateral detection process on an image.
\ No newline at end of file
+Controls the quadrilateral detection process on an image. See [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.md) for details.
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-enhance-image.md b/parameters/reference/document-normalizer-task-settings/stage-enhance-image.md
index 82f710c..09c1ff8 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-enhance-image.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-enhance-image.md
@@ -1,38 +1,63 @@
---
layout: default-layout
-title: Enhance Image Stage - Dynamsoft Document Normalizer Parameters
-description: The parameter defines Enhance Image Stage under the Image Enhancement Section.
+title: EnhanceImageStage - Dynamsoft Document Normalizer Parameters
+description: The EnhanceImageStage adjusts the image quality.
keywords: Enhance Image Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Enhance Image Stage
+# EnhanceImageStage
-The `Enhance Image Stage` is designed at the stage level to adjust the image quality, such as changing the brightness, contrast, and the color mode of the image.
+`EnhanceImageStage` adjusts the image quality, such as changing the brightness, contrast, and the color mode of the image. In JSON, it is represented as a Stage object with `"Stage": "SST_ENHANCE_IMAGE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_ENHANCE_IMAGE")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-image-enhancement.html#stagearray) within [ImageEnhancementSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-image-enhancement.html)
+
+**Example:**
```json
{
"Stage": "SST_ENHANCE_IMAGE",
- "ColourMode": "ICM_COLOUR",
- "Brightness": 0,
- "Contrast": 0
+ "ColourMode": "ICM_COLOUR",
+ "Brightness": 0,
+ "Contrast": 0
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for enhancing images.
+> - To use it, add this object to the `StageArray` within an [ImageEnhancementSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-image-enhancement.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_ENHANCE_IMAGE`.
-The stage is named `SST_ENHANCE_IMAGE`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_ENHANCE_IMAGE"` |
-## ColourMode
+### ColourMode
-Parameter [`ColourMode`](./colour-mode.md) defines the output colour mode of the target image.
+Defines the output colour mode of the target image. See [`ColourMode`](colour-mode.md) for details.
-## Brightness
+### Brightness
-Parameter [`Brightness`](./brightness.md) defines the brightness of the target image.
+Defines the brightness of the target image. See [`Brightness`](brightness.md) for details.
-## Contrast
+### Contrast
-Parameter [`Contrast`](./contrast.md) specifies the contrast of the target image.
\ No newline at end of file
+Specifies the contrast of the target image. See [`Contrast`](contrast.md) for details.
\ No newline at end of file
diff --git a/parameters/reference/document-normalizer-task-settings/stage-predetect-regions.md b/parameters/reference/document-normalizer-task-settings/stage-predetect-regions.md
index 4a3ad34..1ca55b2 100644
--- a/parameters/reference/document-normalizer-task-settings/stage-predetect-regions.md
+++ b/parameters/reference/document-normalizer-task-settings/stage-predetect-regions.md
@@ -1,28 +1,57 @@
---
layout: default-layout
-title: Predetect Regions Stage - Dynamsoft Label Recognizer Parameters
-description: The parameter defines Predetect Regions Stage under the Regions Predetection Section.
+title: PredetectRegionsStage - Dynamsoft Document Normalizer Parameters
+description: The PredetectRegionsStage identifies regions of interest (ROIs).
keywords: Predetect Regions Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# Predetect Regions Stage
+# PredetectRegionsStage
-The `Predetect Regions Stage` is designed at the stage level to identify regions of interest (ROIs). The pre-detected region may be identified based on color features, grayscale features, or neural network localization.
+`PredetectRegionsStage` identifies regions of interest (ROIs). The pre-detected region may be identified based on color features, grayscale features, or neural network localization. In JSON, it is represented as a Stage object with `"Stage": "SST_PREDETECT_REGIONS"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+DocumentNormalizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_PREDETECT_REGIONS")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-regions-predetection.html#stagearray) within [RegionsPredetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-regions-predetection.html)
+
+**Example:**
```json
{
"Stage": "SST_PREDETECT_REGIONS",
- "RegionPredetectionModes": []
+ "RegionPredetectionModes": [
+ {
+ "Mode": "RPM_GENERAL"
+ }
+ ]
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for region predetection.
+> - To use it, add this object to the `StageArray` within a [RegionsPredetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-regions-predetection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_PREDETECT_REGIONS`.
-The stage is named `SST_PREDETECT_REGIONS`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_PREDETECT_REGIONS"` |
-## RegionPredetectionModes
+### RegionPredetectionModes
-Parameter [`RegionPredetectionModes`](../image-parameter/region-predetection-modes.md) controls how to find a region of interest (ROI) within the image or frame.
+Controls how to find a region of interest (ROI) within the image or frame. See [`RegionPredetectionModes`]({{ site.dcvb_parameters_reference }}image-parameter/region-predetection-modes.html) for details.
diff --git a/parameters/reference/document-normalizer-task-settings/start-section.md b/parameters/reference/document-normalizer-task-settings/start-section.md
deleted file mode 100644
index 42cc303..0000000
--- a/parameters/reference/document-normalizer-task-settings/start-section.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-layout: default-layout
-title: StartSection - Dynamsoft Document Normalizer Parameters
-description: The parameter StartSection defines the start section of the document normalizer algorithm task.
-keywords: Start section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
----
-
-# StartSection
-
-Parameter `StartSection` defines the start section of the `DocumentNormalizerTask`.
-
-## Example
-
-```json
-{
- "StartSection": "ST_REGION_PREDETECTION"
-}
-```
-
-## Parameter Summary
-
-| StartSection Parameter Summary |
-| :---------------------------- |
-| **Type**
*String* |
-| **Range**
ST_REGION_PREDETECTION
ST_DOCUMENT_DETECTION
ST_DOCUMENT_NORMALIZATION |
-| **Default Value**
ST_REGION_PREDETECTION |
diff --git a/parameters/reference/document-normalizer-task-settings/terminate-setting.md b/parameters/reference/document-normalizer-task-settings/terminate-setting.md
deleted file mode 100644
index a4f79bf..0000000
--- a/parameters/reference/document-normalizer-task-settings/terminate-setting.md
+++ /dev/null
@@ -1,67 +0,0 @@
----
-layout: default-layout
-title: TerminateSetting - Dynamsoft Document Normalizer Parameters
-description: The parameter TerminateSetting defines the terminate stages of the document normalizer task.
-keywords: Terminate setting
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
----
-
-# TerminateSetting
-
-Parameter `TerminateSetting` defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage.
-
-## Example
-
-```json
-"TerminateSetting":
-{
- "Section": "ST_REGION_PREDETECTION",
- "Stage": "IRUT_GRAYSCALE_IMAGE"
-}
-```
-
-## Parameter Summary
-
-
-
-
- | Child Parameter Name |
- Child Parameter Summary |
-
-
-
- Section
|
- Description
Specifies a mode for ordering. |
-
-
- Type
String |
-
-
- Range
One of the following SectionType as a string.
-
ST_REGION_PREDETECTION
-
ST_DOCUMENT_DETECTION
-
ST_DOCUMENT_NORMALIZATION
- |
-
-
- Stage
|
- Description
Specifies a mode for ordering. |
-
-
- Type
String |
-
-
- Range
One of the IntermediateResultUnitType as a string. The available stage type is different for each sections. View the appendix for more details.
- |
-
-
-
-## Appendix - Available Stage for Sections
-
-| Section | Available Stages |
-| :------------------ | :--------------- |
-| ST_REGION_PREDETECTION | IRUT_COLOUR_IMAGE
IRUT_SCALED_DOWN_COLOUR_IMAGE
IRUT_GRAYSCALE_IMAGE
IRUT_TRANSFORMED_GRAYSCALE_IMAGE
IRUT_PREDETECTED_REGIONS |
-| ST_DOCUMENT_DETECTION | 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
IRUT_CONTOURS
IRUT_LINE_SEGMENTS
IRUT_LONG_LINES
IRUT_CORNERS
IRUT_CANDIDATE_QUAD_EDGES
IRUT_DETECTED_QUADS |
-| ST_DOCUMENT_NORMALIZATION | IRUT_NORMALIZED_IMAGES |
diff --git a/parameters/reference/image-parameter/applicable-stages.md b/parameters/reference/image-parameter/applicable-stages.md
index 5c1f418..60fdb53 100644
--- a/parameters/reference/image-parameter/applicable-stages.md
+++ b/parameters/reference/image-parameter/applicable-stages.md
@@ -2,10 +2,7 @@
layout: default-layout
title: ApplicableStages - Dynamsoft Capture Vision Parameters
description: The parameter ApplicableStages of Dynamsoft Capture Vision is for configuring the applicable stages parameters.
-keywords: Stages
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+keywords: ApplicableStages
---
@@ -13,41 +10,56 @@ noTitleIndex: true
Defines the applicable stage parameters with an array of stage objects. Each applicable stage object contains the name of the stage and related parameters.
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages
+```
+
+**Parent object:** [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
+
```json
-"ApplicableStages":[
- {
- "Stage":"SST_SCALE_IMAGE",
- "ImageScaleSetting" : {}
- },
- {
- "Stage":"SST_CONVERT_TO_GRAYSCALE",
- "ColourConversionModes" : []
- },
- {
- "Stage":"SST_TRANSFORM_GRAYSCALE",
- "GrayscaleTransformationModes" : []
- },
- {
- "Stage":"SST_ENHANCE_GRAYSCALE",
- "GrayscaleEnhancementModes" : []
- },
-]
+{
+ "ApplicableStages": [
+ {
+ "Stage": "SST_SCALE_IMAGE",
+ "ImageScaleSetting": {}
+ },
+ {
+ "Stage": "SST_CONVERT_TO_GRAYSCALE",
+ "ColourConversionModes": []
+ }
+ ]
+}
```
-## Stages
+> [!NOTE]
+> - This snippet shows only the `ApplicableStages` parameter.
+> - To use it, embed this parameter within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+The `ImageParameter` includes the following stages:
-| Applicable Name | Descriptions |
+| Stage Name | Descriptions |
| -------------- | ------------ |
-| [`SST_ASSEMBLE_LINES`](stage-assemble-lines.md) | The stage that assembles short lines when processing documents. |
-| [`SST_BINARIZE_IMAGE`](stage-binarize-image.md) | The stage that transfers a grayscale image into a binary image. |
-| [`SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`](stage-binarize-texture-removed-grayscale.md) | The stage that transfers a texture-removed grayscale image into a binary image. |
-| [`SST_CONVERT_TO_GRAYSCALE`](stage-convert-to-grayscale.md) | The stage that converts a colour image to a grayscale image. |
-| [`SST_DETECT_SHORTLINES`](stage-detect-shortlines.md) | The stage that detects short lines for document boundary detection. |
-| [`SST_DETECT_TEXTURE`](stage-detect-texture.md) | The stage that detects texture on the image. |
-| [`SST_DETECT_TEXT_ZONES`](stage-detect-text-zones.md) | The stage that detects text zones on the image. |
-| [`SST_ENHANCE_GRAYSCALE`](stage-enhance-grayscale.md) | The stage that improves the quality of the grayscale image. |
-| [`SST_FIND_CONTOURS`](stage-find-contours.md) | The stage that finds contours in the image. |
-| [`SST_REMOVE_TEXTURE_FROM_GRAYSCALE`](stage-remove-texture-from-grayscale.md) | The stage that removes texture from the grayscale image. |
-| [`SST_REMOVE_TEXT_ZONES_FROM_BINARY`](stage-remove-text-zones-from-binary.md) | The stage that removes text zones from the binary image. |
-| [`SST_SCALE_IMAGE`](stage-scale-image.md) | The stage that down/up scales the image. |
-| [`SST_TRANSFORM_GRAYSCALE`](stage-transform-grayscale.md) | The stage that transforms the grayscale image. |
+| [AssembleLinesStage](stage-assemble-lines.md) (`SST_ASSEMBLE_LINES`) | The stage that assembles short lines when processing documents. |
+| [BinarizeImageStage](stage-binarize-image.md) (`SST_BINARIZE_IMAGE`) | The stage that transfers a grayscale image into a binary image. |
+| [BinarizeTextureRemovedGrayscaleStage](stage-binarize-texture-removed-grayscale.md) (`SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`) | The stage that transfers a texture-removed grayscale image into a binary image. |
+| [ConvertToGrayscaleStage](stage-convert-to-grayscale.md) (`SST_CONVERT_TO_GRAYSCALE`) | The stage that converts a colour image to a grayscale image. |
+| [DetectShortLinesStage](stage-detect-shortlines.md) (`SST_DETECT_SHORTLINES`) | The stage that detects short lines for document boundary detection. |
+| [DetectTextureStage](stage-detect-texture.md) (`SST_DETECT_TEXTURE`) | The stage that detects texture on the image. |
+| [DetectTextZonesStage](stage-detect-text-zones.md) (`SST_DETECT_TEXT_ZONES`) | The stage that detects text zones on the image. |
+| [EnhanceGrayscaleStage](stage-enhance-grayscale.md) (`SST_ENHANCE_GRAYSCALE`) | The stage that improves the quality of the grayscale image. |
+| [FindContoursStage](stage-find-contours.md) (`SST_FIND_CONTOURS`) | The stage that finds contours in the image. |
+| [RemoveTextureFromGrayscaleStage](stage-remove-texture-from-grayscale.md) (`SST_REMOVE_TEXTURE_FROM_GRAYSCALE`) | The stage that removes texture from the grayscale image. |
+| [RemoveTextZonesFromBinaryStage](stage-remove-text-zones-from-binary.md) (`SST_REMOVE_TEXT_ZONES_FROM_BINARY`) | The stage that removes text zones from the binary image. |
+| [ScaleImageStage](stage-scale-image.md) (`SST_SCALE_IMAGE`) | The stage that down/up scales the image. |
+| [TransformGrayscaleStage](stage-transform-grayscale.md) (`SST_TRANSFORM_GRAYSCALE`) | The stage that transforms the grayscale image. |
diff --git a/parameters/reference/image-parameter/base-image-parameter-name.md b/parameters/reference/image-parameter/base-image-parameter-name.md
index c747ac9..97c1e91 100644
--- a/parameters/reference/image-parameter/base-image-parameter-name.md
+++ b/parameters/reference/image-parameter/base-image-parameter-name.md
@@ -1,31 +1,44 @@
---
layout: default-layout
title: BaseImageParameterName - Dynamsoft Capture Vision Parameters
-description: The parameter BaseImageParameterName of Dynamsoft Capture Vision is for Inheritancing parameters from a ImageParameter object.
+description: The parameter BaseImageParameterName of Dynamsoft Capture Vision is for inheriting parameters from an ImageParameter object.
keywords: BaseImageParameterName, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
-permalink: /parameters/reference/image-parameter/base-image-parameter-name.html
---
# BaseImageParameterName
Parameter `BaseImageParameterName` 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.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── BaseImageParameterName
+```
+
+**Parent object:** [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "BaseImageParameterName": "IP_0"
+ "BaseImageParameterName": "ip_0"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `BaseImageParameterName` parameter.
+> - To use it, embed this parameter within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| BaseImageParameterName Parameter Summary |
+| Parameter Details |
| :---------------------------------- |
-| **Description**
Name of the ImageParameter object to inherit. |
| **Type**
*String* |
-| **Value range**
One of the ImageParameter name. |
-| **Default Value**
"" |
+| **Value Range**
One of the `ImageParameter` name. |
+| **Default Value**
`""` |
+| **Remarks**
The default value "" means this object don't inherit the settings of another object. |
diff --git a/parameters/reference/image-parameter/binarization-modes.md b/parameters/reference/image-parameter/binarization-modes.md
index 5f1f5fe..fbdb659 100644
--- a/parameters/reference/image-parameter/binarization-modes.md
+++ b/parameters/reference/image-parameter/binarization-modes.md
@@ -3,9 +3,6 @@ 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
---
@@ -13,30 +10,41 @@ noTitleIndex: true
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 Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_BINARIZE_IMAGE" or "SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE")
+ └── BinarizationModes
+```
+
+**Parent object:** [BinarizeImageStage](stage-binarize-image.md) or [BinarizeTextureRemovedGrayscaleStage](stage-binarize-texture-removed-grayscale.md)
+
+**Example:**
```json
{
- "BinarizationModes" :
- [
+ "BinarizationModes": [
{
- "BinarizationThreshold" : -1,
- "BlockSizeX" : 0,
- "BlockSizeY" : 0,
- "EnableFillBinaryVacancy" : 1,
- "GrayscaleEnhancementModesIndex" : -1,
- "Mode" : "BM_LOCAL_BLOCK",
- "MorphOperation" : "None",
- "MorphOperationKernelSizeX" : 0,
- "MorphOperationKernelSizeY" : 0,
- "MorphShape" : "Rectangle",
- "ThresholdCompensation" : 10
+ "Mode": "BM_LOCAL_BLOCK",
+ "BlockSizeX": 0,
+ "BlockSizeY": 0,
+ "EnableFillBinaryVacancy": 1,
+ "ThresholdCompensation": 10
}
]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `BinarizationModes` parameter.
+> - To use it, embed this parameter within a Stage object (such as [BinarizeImageStage](stage-binarize-image.md)).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
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.
@@ -350,7 +358,7 @@ If the `BinarizationModes` is not configured in your template file, the followin
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### BM_LOCAL_BLOCK
diff --git a/parameters/reference/image-parameter/colour-conversion-modes.md b/parameters/reference/image-parameter/colour-conversion-modes.md
index fd0f20e..3faa337 100644
--- a/parameters/reference/image-parameter/colour-conversion-modes.md
+++ b/parameters/reference/image-parameter/colour-conversion-modes.md
@@ -3,9 +3,6 @@ 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
---
@@ -13,7 +10,18 @@ noTitleIndex: true
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 Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_CONVERT_TO_GRAYSCALE")
+ └── ColourConversionModes
+```
+
+**Parent object:** [ConvertToGrayscaleStage](stage-convert-to-grayscale.md)
+
+**Example:**
```json
{
@@ -25,7 +33,14 @@ Parameter `ColourConversionModes` is a parameter for setting the mode for conver
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `ColourConversionModes` parameter.
+> - To use it, embed this parameter within a [ConvertToGrayscaleStage](stage-convert-to-grayscale.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
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:
@@ -232,7 +247,7 @@ In document detection tasks, various ColuorConversionModes will be tried as much
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### CICM_GENERAL
diff --git a/parameters/reference/image-parameter/grayscale-enhancement-modes.md b/parameters/reference/image-parameter/grayscale-enhancement-modes.md
index 432eb39..a0e4906 100644
--- a/parameters/reference/image-parameter/grayscale-enhancement-modes.md
+++ b/parameters/reference/image-parameter/grayscale-enhancement-modes.md
@@ -3,9 +3,6 @@ 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
---
@@ -13,32 +10,37 @@ noTitleIndex: true
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 Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_ENHANCE_GRAYSCALE")
+ └── GrayscaleEnhancementModes
+```
+
+**Parent object:** [EnhanceGrayscaleStage](stage-enhance-grayscale.md)
+
+**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
+ "Mode": "GEM_GENERAL"
}
]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `GrayscaleEnhancementModes` parameter.
+> - To use it, embed this parameter within an [EnhanceGrayscaleStage](stage-enhance-grayscale.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
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:
@@ -243,7 +245,7 @@ If the `GrayscaleEnhancementModes` is not configured in your template file, the
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### GEM_GENERAL
diff --git a/parameters/reference/image-parameter/grayscale-transformation-modes.md b/parameters/reference/image-parameter/grayscale-transformation-modes.md
index 3c8ad24..3e0d4a2 100644
--- a/parameters/reference/image-parameter/grayscale-transformation-modes.md
+++ b/parameters/reference/image-parameter/grayscale-transformation-modes.md
@@ -3,9 +3,6 @@ layout: default-layout
title: GrayscaleTransformationModes - Dynamsoft Capture Vision Parameters
description: The parameter GrayscaleTransformationModes of Dynamsoft Capture Vision is for controlling the inversion of colors in grayscale image.
keywords: GrayscaleTransformationModes, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
@@ -13,22 +10,37 @@ noTitleIndex: true
Parameter `GrayscaleTransformationModes` are used to control whether or not to invert the color of the grayscale image. Generally, we think of the lighter colors as the background and the darker colors as the target in a grayscale image. However in a few cases it is opposite.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_TRANSFORM_GRAYSCALE")
+ └── GrayscaleTransformationModes
+```
+
+**Parent object:** [TransformGrayscaleStage](stage-transform-grayscale.md)
+
+**Example:**
```json
{
"GrayscaleTransformationModes": [
{
"Mode": "GTM_ORIGINAL"
- },
- {
- "Mode": "GTM_INVERTED"
}
]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `GrayscaleTransformationModes` parameter.
+> - To use it, embed this parameter within a [TransformGrayscaleStage](stage-transform-grayscale.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
### Mode Arguments
@@ -100,7 +112,7 @@ If the `GrayscaleTransformationModes` is not configured in your template file, t
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### GTM_ORIGINAL
diff --git a/parameters/reference/image-parameter/if-erase-text-zone.md b/parameters/reference/image-parameter/if-erase-text-zone.md
index ba2287a..e164a04 100644
--- a/parameters/reference/image-parameter/if-erase-text-zone.md
+++ b/parameters/reference/image-parameter/if-erase-text-zone.md
@@ -3,9 +3,6 @@ layout: default-layout
title: IfEraseTextZone - Dynamsoft Capture Vision Parameters
description: The parameter IfEraseTextZone of Dynamsoft Capture Vision is for controlling whether to erase the detected text zone.
keywords: IfEraseTextZone, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
@@ -21,9 +18,9 @@ Parameter `IfEraseTextZone` sets whether to erase the detected text zone. The de
}
```
-## Parameter Summary
+## Parameter Details
-| IfEraseTextZone Parameter Summary |
+| IfEraseTextZone Parameter Details |
| :---------------------------------- |
| **Description**
0: Do not erase the text zone.
1: Erase the text zone. |
| **Type**
*int* |
diff --git a/parameters/reference/image-parameter/image-scale-settings.md b/parameters/reference/image-parameter/image-scale-settings.md
index 1d09577..431ab2f 100644
--- a/parameters/reference/image-parameter/image-scale-settings.md
+++ b/parameters/reference/image-parameter/image-scale-settings.md
@@ -3,45 +3,67 @@ layout: default-layout
title: ImageScaleSetting - Dynamsoft Capture Vision Parameters
description: The parameter ImageScaleSetting of Dynamsoft Capture Vision is for controlling how to up or down scale the image.
keywords: scale-up, scale down, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
# ImageScaleSetting
Parameter `ImageScaleSetting` is for controlling how to up or down scale the image.
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_SCALE_IMAGE")
+ └── ImageScaleSetting
+```
+
+**Parent object:** [ScaleImageStage](stage-scale-image.md)
+
+**Example:**
+
```json
-"ImageScaleSetting":
{
- "ScaleType": "ST_SCALE_DOWN",
- "ReferenceEdge": "RE_SHORTER_EDGE",
- "EdgeLengthThreshold": 2300
+ "ImageScaleSetting": {
+ "ScaleType": "ST_SCALE_DOWN",
+ "ReferenceEdge": "RE_SHORTER_EDGE",
+ "EdgeLengthThreshold": 2300
+ }
}
```
-## ScaleType
+> [!NOTE]
+> - This snippet shows only the `ImageScaleSetting` parameter.
+> - To use it, embed this parameter within a [ScaleImageStage](stage-scale-image.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+The `ImageScaleSetting` object includes the following parameters:
+
+### ScaleType
Specifies whether to scale up or down the image.
| ScaleType Parameter Details |
| :-------------------------- |
| **Type**
*String* |
-| **Value range**
"ST_SCALE_DOWN", "ST_SCALE_UP" |
+| **Value Range**
"ST_SCALE_DOWN", "ST_SCALE_UP" |
| **Default Value**
"ST_SCALE_DOWN" |
-## ReferenceEdge
+### ReferenceEdge
Specifies which edge (longer edge or shorter edge) to use when scaling the image.
| ReferenceEdge Parameter Details |
| :------------------------------ |
| **Type**
*String* |
-| **Value range**
"RE_SHORTER_EDGE", "RE_LONGER_EDGE" |
+| **Value Range**
"RE_SHORTER_EDGE", "RE_LONGER_EDGE" |
| **Default Value**
"RE_SHORTER_EDGE" |
-## EdgeLengthThreshold
+### EdgeLengthThreshold
Specifies the threshold for scaling the image.
@@ -51,5 +73,5 @@ Specifies the threshold for scaling the image.
| EdgeLengthThreshold Parameter Details |
| :----------------------------------- |
| **Type**
*int* |
-| **Value range**
[512, 0x7fffffff] |
+| **Value Range**
[512, 0x7fffffff] |
| **Default Value**
2300 |
diff --git a/parameters/reference/image-parameter/index.md b/parameters/reference/image-parameter/index.md
deleted file mode 100644
index 1592a0f..0000000
--- a/parameters/reference/image-parameter/index.md
+++ /dev/null
@@ -1,17 +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. |
-| [`Name`](name.md) | Defines the name of a `ImageParameter` object, which serves as its unique identifier. |
-| [`ApplicableStages`](applicable-stages.md) | Defines the applicable stage parameters with an array of stage objects. |
diff --git a/parameters/reference/image-parameter/line-assembly-mode.md b/parameters/reference/image-parameter/line-assembly-mode.md
index c352fc4..9a304d6 100644
--- a/parameters/reference/image-parameter/line-assembly-mode.md
+++ b/parameters/reference/image-parameter/line-assembly-mode.md
@@ -3,9 +3,6 @@ layout: default-layout
title: LineAssemblyMode - Dynamsoft Capture Vision Parameters
description: The parameter LineAssemblyMode of Dynamsoft Capture Vision is for controlling how to assemble the lines.
keywords: LineAssemblyMode, assemble lines, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
@@ -13,64 +10,56 @@ noTitleIndex: true
Parameter `LineAssemblyMode` is for controlling how to assemble the lines.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_ASSEMBLE_LINES")
+ └── LineAssemblyMode
+```
+
+**Parent object:** [AssembleLinesStage](stage-assemble-lines.md)
+
+**Example:**
```json
{
"LineAssemblyMode": {
- "Mode": "LAM_GENERAL",
+ "Mode": "LAM_GENERAL",
"Sensitivity": 3
}
}
```
-### Mode Arguments
-
-Each `LineAssemblyMode` object consists a candidate mode name and a series of other mode arguments.
-
-
-
-
- | Mode Argument Name |
- Mode Argument Summary |
-
-
-
- Mode
(Required) |
- Description
Any one in Candidate Mode List as string
- |
-
-
- Type
String
- |
-
-
- Candidate Mode List
"LAM_GENERAL"
- |
-
-
- Default Value
-
"LAM_GENERAL"
- |
-
-
- Sensitivity
(Optional) |
- Description
The sensitivity level used for line assembling.
- |
-
- Type
int
- |
-
-
- Range
[1, 9]
- |
-
-
- Default Value
3 for BarcodeReader Task.
6 for DocumentNormalizer Task
- |
-
-
- Valid For
"LAM_GENERAL"
- |
-
-
+> [!NOTE]
+> - This snippet shows only the `LineAssemblyMode` parameter.
+> - To use it, embed this parameter within an [AssembleLinesStage](stage-assemble-lines.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+The `LineAssemblyMode` object includes the following parameters:
+
+### Mode
+
+Specifies the line assembly mode to use.
+
+| Mode Parameter Details |
+| :--------------------- |
+| **Type**
*String* |
+| **Value Range**
"LAM_GENERAL" |
+| **Default Value**
"LAM_GENERAL" |
+
+### Sensitivity
+
+Specifies the sensitivity level used for line assembling. A higher value means the algorithm will be more sensitive when detecting and assembling lines.
+
+| Sensitivity Parameter Details |
+| :---------------------------- |
+| **Type**
*int* |
+| **Value Range**
[1, 9] |
+| **Default Value**
3 for BarcodeReader Task
6 for DocumentNormalizer Task |
+| **Valid For**
"LAM_GENERAL" |
diff --git a/parameters/reference/image-parameter/name.md b/parameters/reference/image-parameter/name.md
index 348b326..6a0a461 100644
--- a/parameters/reference/image-parameter/name.md
+++ b/parameters/reference/image-parameter/name.md
@@ -3,27 +3,42 @@ layout: default-layout
title: Name - Dynamsoft Capture Vision Parameter Reference ImageParameter Object.
description: The parameter Name defines the unique identifier of ImageParameter object.
keywords: top-level object, name, unique identifier
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# Name
Parameter `Name` represents the name of a `ImageParameter` object, which serves as its unique identifier.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── Name
+```
+
+**Parent object:** [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Name" : "ip_0"
+ "Name": "ip_0"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Name` parameter.
+> - To use it, embed this parameter within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
| Parameter Details |
| :----------------------------------- |
| **Type**
*String* |
-| **Default Value**
It must be a mandatory setting value. |
+| **Required**
Yes |
+| **Default Value**
N/A |
| **Remarks**
It must be a unique name. |
diff --git a/parameters/reference/image-parameter/region-predetection-modes.md b/parameters/reference/image-parameter/region-predetection-modes.md
index 927b87c..f9f945f 100644
--- a/parameters/reference/image-parameter/region-predetection-modes.md
+++ b/parameters/reference/image-parameter/region-predetection-modes.md
@@ -1,11 +1,8 @@
---
layout: default-layout
-title: RegionPredetectionModes * Dynamsoft Capture Vision Parameters
+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
---
@@ -13,6 +10,23 @@ noTitleIndex: true
Parameter `RegionPredetectionModes` controls how to find a region of interest (ROI) within the image or frame.
+## JSON Structure
+
+**Location in template:**
+```
+BarcodeReaderTaskSettingOptions[i] / DocumentNormalizerTaskSettingOptions[i] / LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_REGION_PREDETECTION")
+ └── StageArray[k] (Stage object where Stage = "SST_PREDETECT_REGIONS")
+ └── RegionPredetectionModes
+```
+
+**Parent object:**
+- [PredetectRegionsStage]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/stage-predetect-regions.html) object within [RegionPredetectionSection]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/section-region-predetection.html) of `BarcodeReaderTaskSettingOptions`
+- [PredetectRegionsStage]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/stage-predetect-regions.html) object within [RegionPredetectionSection]({{ site.dcvb_parameters_reference }}document-normalizer-task-settings/section-regions-predetection.html) of `DocumentNormalizerTaskSettingOptions`
+- [PredetectRegionsStage]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/stage-predetect-regions.html) object within [RegionPredetectionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-regions-predetection.html) of `LabelRecognizerTaskSettingOptions`
+
+**Example:**
+
```json
{
"RegionPredetectionModes": [
@@ -20,24 +34,23 @@ Parameter `RegionPredetectionModes` controls how to find a region of interest (R
"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]"
- },
- {
- "Mode": "RPM_NEURAL_NETWORK",
- "DetectionModelName": ""
- }
+ }
]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `RegionPredetectionModes` parameter.
+> - To use it, embed this parameter within a Stage object in the `RegionPredetectionSection`.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
### Mode Arguments
@@ -340,7 +353,7 @@ The default settings of RegionPredetectionModes is:
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### RPM_SKIP
diff --git a/parameters/reference/image-parameter/scale-down-threshold.md b/parameters/reference/image-parameter/scale-down-threshold.md
deleted file mode 100644
index 6536452..0000000
--- a/parameters/reference/image-parameter/scale-down-threshold.md
+++ /dev/null
@@ -1,33 +0,0 @@
----
-layout: default-layout
-title: ScaleDownThreshold - Dynamsoft Capture Vision Parameters
-description: The parameter ScaleDownThreshold of Dynamsoft Capture Vision is for defining the threshold for image shrinking.
-keywords: ScaleDownThreshold, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
----
-
-
-# ScaleDownThreshold
-
-Parameter `ScaleDownThreshold` defines the threshold for image shrinking.
-
-## Example
-
-```json
-{
- "ScaleDownThreshold": 1024
-}
-```
-
-## Parameter Summary
-
-When the input image is too large, this parameter ScaleDownThreshold can be used to reduce the size.
-
-| ScaleDownThreshold Parameter Summary |
-| :---------------------------------- |
-| **Description**
If the shorter edge size is larger than the given value, the library will calculate the required height and width of the barcode image and shrink the image to that size before going to further processes. Otherwise, it will perform processes on the original image. |
-| **Type**
*int* |
-| **Value range**
[512, 0x7fffffff] |
-| **Default Value**
2300 |
diff --git a/parameters/reference/image-parameter/scale-up-modes.md b/parameters/reference/image-parameter/scale-up-modes.md
deleted file mode 100644
index a4117c2..0000000
--- a/parameters/reference/image-parameter/scale-up-modes.md
+++ /dev/null
@@ -1,290 +0,0 @@
----
-layout: default-layout
-title: ScaleUpModes - Dynamsoft Capture Vision Parameters
-description: The parameter ScaleUpModes of Dynamsoft Capture Vision is for controlling the scale-up process when targets are too small in the image.
-keywords: ScaleUpModes, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
----
-
-
-# ScaleUpModes
-
-Parameter `ScaleUpModes` is for controlling the scale-up process when targets in the image are too small.
-
-## Example
-
-```json
-{
- "ScaleUpModes":
- [
- {
- "Mode": "SUM_LINEAR_INTERPOLATION",
- "ModuleSizeThreshold": 4,
- "TargetModuleSize": 8
- },
- {
- "Mode": "SUM_NEAREST_NEIGHBOUR_INTERPOLATION",
- "ModuleSizeThreshold": 4,
- "TargetModuleSize": 6
- },
- {
- "Mode": "SUM_LINEAR_INTERPOLATION",
- "LetterHeightThreshold": 10,
- "TargetLetterHeight": 50
- }
- ]
-}
-```
-
-## Parameter Summary
-
-Parameter `ScaleUpModes` consist of a group of scale up mode objects. Each scale up mode object includes a candidate mode and a series of mode arguments. The mode arguments of the scale up mode object is shown as follow:
-
-### Mode Arguments
-
-
-
-
- | Mode Argument Name |
- Mode Argument Summary |
-
-
-
- Mode
(Required) |
- Description
Any one in Candidate Mode List as string
- |
-
-
- Type
String
- |
-
-
- Candidate Mode List
SUM_LINEAR_INTERPOLATION
-
SUM_NEAREST_NEIGHBOUR_INTERPOLATION
-
SUM_AUTO
-
SUM_SKIP
- |
-
-
- Default Value
-
SUM_AUTO
- |
-
-
- AcuteAngleWithXThreshold
(Optional) |
- Description
Sets the acute angle threshold for barcode scale-up.
-
-1: means automatically set by the library.
-
If the module size of the barcode is smaller than the ModuleSizeThreshold and the acute angle with X of the barcode is larger than the AcuteAngleWithXThreshold, the barcode will be enlarged by a scale factor of N (the value of N is a power of 2) till N * modulesize >= TargetModuleSize.
- |
-
-
- Type
int
- |
-
-
- Range
[-1, 90]
- |
-
-
- Default Value
-1
- |
-
-
- Valid For
-
SUM_LINEAR_INTERPOLATION
-
SUM_NEAREST_NEIGHBOUR_INTERPOLATION
- |
-
-
- ModuleSizeThreshold
(Optional) |
- Description
Sets the module size threshold for barcode scale-up.
-
0: means automatically set by the library.
-
If the module size of the barcode is smaller than the ModuleSizeThreshold and the acute angle with X of the barcode is larger than the AcuteAngleWithXThreshold, the barcode will be enlarged by a scale factor of N (the value of N is a power of 2) till N * modulesize >= TargetModuleSize.
- |
-
-
- Type
int
- |
-
-
- Range
[1, 0x7fffffff]
- |
-
-
- Default Value
0
- |
-
-
- Valid For
-
SUM_LINEAR_INTERPOLATION
-
SUM_NEAREST_NEIGHBOUR_INTERPOLATION
- |
-
-
- TargetModuleSize
(Optional) |
- Description
Sets the module size threshold for barcode scale-up.
-
0: means automatically set by the library.
-
If the module size of the barcode is smaller than the ModuleSizeThreshold and the acute angle with X of the barcode is larger than the AcuteAngleWithXThreshold, the barcode will be enlarged by a scale factor of N (the value of N is a power of 2) till N * modulesize >= TargetModuleSize.
- |
-
-
- Type
int
- |
-
-
- Range
[0, 0x7fffffff]
- |
-
-
- Default Value
0
- |
-
-
- Valid For
-
SUM_LINEAR_INTERPOLATION
-
SUM_NEAREST_NEIGHBOUR_INTERPOLATION
- |
-
-
- LetterHeightThreshold
(Optional) |
- Description
Sets the letter height threshold for character scale-up.
-
0 : means automatically set by the library. If the average letter height of a text line is smaller than the LetterHeightThreshold, the image will be enlarged to N times (N=2,4,8…) till N * LetterHeight >= TargetLetterHeight.
- |
-
-
- Type
int
- |
-
-
- Range
[0, 0x7fffffff]
- |
-
-
- Default Value
0
- |
-
-
- Valid For
-
SUM_LINEAR_INTERPOLATION
-
SUM_NEAREST_NEIGHBOUR_INTERPOLATION
- |
-
-
- TargetLetterHeight
(Optional) |
- Description
Sets the target letter height for character scale-up.
-
0 : means automatically set by the library.
- |
-
-
- Type
int
- |
-
-
- Range
[0, 0x7fffffff]
- |
-
-
- Default Value
0
- |
-
-
- Valid For
-
SUM_LINEAR_INTERPOLATION
-
SUM_NEAREST_NEIGHBOUR_INTERPOLATION
- |
-
-
- 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 `ScaleUpModes` is not configured in your template file, the following setting will be used as the default setting.
-
-```json
-{
- "ScaleUpModes" :
- [
- {
- "AcuteAngleWithXThreshold" : -1,
- "LetterHeightThreshold" : 0,
- "Mode" : "SUM_AUTO",
- "ModuleSizeThreshold" : 0,
- "TargetLetterHeight" : 0,
- "TargetModuleSize" : 0
- }
- ]
-}
-```
-
-## Candidate Modes Introduction
-
-### SUM_LINEAR_INTERPOLATION
-
-Scales up using the linear interpolation method. This mode has the following arguments for further customizing:
-
-- AcuteAngleWithXThreshold
-- ModuleSizeThreshold
-- TargetModuleSize
-- LetterHeightThreshold
-- TargetLetterHeight
-- LibraryFileName
-- LibraryParameters
-
-### SUM_NEAREST_NEIGHBOUR_INTERPOLATION
-
-Scales up using the nearest neighbour method. This mode has the following arguments for further customizing:
-
-- AcuteAngleWithXThreshold
-- ModuleSizeThreshold
-- TargetModuleSize
-- LetterHeightThreshold
-- TargetLetterHeight
-- LibraryFileName
-- LibraryParameters
-
-### SUM_AUTO
-
-Lets the library choose a mode automatically.
diff --git a/parameters/reference/image-parameter/shortline-detection-mode.md b/parameters/reference/image-parameter/shortline-detection-mode.md
index 62f791e..5fcdeb7 100644
--- a/parameters/reference/image-parameter/shortline-detection-mode.md
+++ b/parameters/reference/image-parameter/shortline-detection-mode.md
@@ -3,9 +3,6 @@ layout: default-layout
title: ShortlineDetectionMode - Dynamsoft Capture Vision Parameters
description: The parameter ShortlineDetectionMode of Dynamsoft Capture Vision is for controlling how to detect the shortlines.
keywords: ShortlineDetectionMode, short lines, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
@@ -13,64 +10,56 @@ noTitleIndex: true
Parameter `ShortlineDetectionMode` is for controlling how to detect the shortlines.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_DETECT_SHORTLINES")
+ └── ShortlineDetectionMode
+```
+
+**Parent object:** [DetectShortLinesStage](stage-detect-shortlines.md)
+
+**Example:**
```json
{
"ShortlineDetectionMode": {
- "Mode": "SDM_GENERAL",
+ "Mode": "SDM_GENERAL",
"Sensitivity": 3
}
}
```
-### Mode Arguments
-
-Each `ShortlineDetectionMode` object consists a candidate mode name and a series of other mode arguments.
-
-
-
-
- | Mode Argument Name |
- Mode Argument Summary |
-
-
-
- Mode
(Required) |
- Description
Any one in Candidate Mode List as string
- |
-
-
- Type
String
- |
-
-
- Candidate Mode List
"SDM_GENERAL"
- |
-
-
- Default Value
-
"SDM_GENERAL"
- |
-
-
- Sensitivity
(Optional) |
- Description
The sensitivity level used for short line detection.
- |
-
- Type
int
- |
-
-
- Range
[1, 9]
- |
-
-
- Default Value
3 for BarcodeReader Task.
6 for DocumentNormalizer Task
- |
-
-
- Valid For
"SDM_GENERAL"
- |
-
-
+> [!NOTE]
+> - This snippet shows only the `ShortlineDetectionMode` parameter.
+> - To use it, embed this parameter within a [DetectShortLinesStage](stage-detect-shortlines.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+The `ShortlineDetectionMode` object includes the following parameters:
+
+### Mode
+
+Specifies the shortline detection mode to use.
+
+| Mode Parameter Details |
+| :--------------------- |
+| **Type**
*String* |
+| **Value Range**
"SDM_GENERAL" |
+| **Default Value**
"SDM_GENERAL" |
+
+### Sensitivity
+
+Specifies the sensitivity level used for shortline detection. A higher value means the algorithm will be more sensitive when detecting short lines.
+
+| Sensitivity Parameter Details |
+| :---------------------------- |
+| **Type**
*int* |
+| **Value Range**
[1, 9] |
+| **Default Value**
3 for BarcodeReader Task
6 for DocumentNormalizer Task |
+| **Valid For**
"SDM_GENERAL" |
diff --git a/parameters/reference/image-parameter/stage-assemble-lines.md b/parameters/reference/image-parameter/stage-assemble-lines.md
index adfd6b9..2f35e13 100644
--- a/parameters/reference/image-parameter/stage-assemble-lines.md
+++ b/parameters/reference/image-parameter/stage-assemble-lines.md
@@ -1,32 +1,54 @@
---
layout: default-layout
-title: Assemble Lines Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under assemble lines stage of Dynamsoft Capture Vision.
-keywords: Stages, assemble lines, LineAssemblyMode, line assembly mode
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: AssembleLinesStage - Dynamsoft Capture Vision Parameters
+description: The AssembleLinesStage assembles short lines when processing documents.
+keywords: Assemble Lines Stage
---
-# Assemble Lines Stage Parameters
+# AssembleLinesStage
-The parameters that available under the assemble lines stage.
+`AssembleLinesStage` assembles short lines when processing documents. In JSON, it is represented as a Stage object with `"Stage": "SST_ASSEMBLE_LINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_ASSEMBLE_LINES")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
"Stage": "SST_ASSEMBLE_LINES",
- "LineAssemblyMode": {}
-},
+ "LineAssemblyMode": {
+ "Mode": "LAM_GENERAL"
+ }
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for assembling lines.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of assemble lines stage is `SST_ASSEMBLE_LINES`.
+Specifies the stage type. Fixed value: `SST_ASSEMBLE_LINES`.
-## LineAssemblyMode
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_ASSEMBLE_LINES"` |
-Defines how to assemble lines.
+### LineAssemblyMode
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
A *[LineAssemblyMode](line-assembly-mode.md)* Object |
+Defines how to assemble lines. See [`LineAssemblyMode`](line-assembly-mode.md) for details.
diff --git a/parameters/reference/image-parameter/stage-binarize-image.md b/parameters/reference/image-parameter/stage-binarize-image.md
index 5f17e6e..d2744a4 100644
--- a/parameters/reference/image-parameter/stage-binarize-image.md
+++ b/parameters/reference/image-parameter/stage-binarize-image.md
@@ -1,32 +1,56 @@
---
layout: default-layout
-title: Binarize Image Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under binarize image stage of Dynamsoft Capture Vision.
-keywords: Stages, binarize image, binarization modes, BinarizationMode
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: BinarizeImageStage - Dynamsoft Capture Vision Parameters
+description: The BinarizeImageStage transfers a grayscale image into a binary image.
+keywords: Binarize Image Stage
---
-# Binarize Image Stage Parameters
+# BinarizeImageStage
-The parameters that available under the Binarize Image Stage.
+`BinarizeImageStage` transfers a grayscale image into a binary image. In JSON, it is represented as a Stage object with `"Stage": "SST_BINARIZE_IMAGE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_BINARIZE_IMAGE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_BINARIZE_IMAGE",
- "BinarizationModes" : []
+ "Stage": "SST_BINARIZE_IMAGE",
+ "BinarizationModes": [
+ {
+ "Mode": "BM_LOCAL_BLOCK"
+ }
+ ]
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for binarizing images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of binarize image stage is `SST_BINARIZE_IMAGE`.
+Specifies the stage type. Fixed value: `SST_BINARIZE_IMAGE`.
-## BinarizationModes
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_BINARIZE_IMAGE"` |
-Defines the binarization options with an array of [`BinarizationMode`](binarization-modes.md) objects. The modes in the array will be executed sequentially until the task is completed.
+### BinarizationModes
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An array of [`BinarizationMode`](binarization-modes.md) objects |
+Defines the binarization options. See [`BinarizationModes`](binarization-modes.md) for details.
diff --git a/parameters/reference/image-parameter/stage-binarize-texture-removed-grayscale.md b/parameters/reference/image-parameter/stage-binarize-texture-removed-grayscale.md
index da1c9f3..6a8e141 100644
--- a/parameters/reference/image-parameter/stage-binarize-texture-removed-grayscale.md
+++ b/parameters/reference/image-parameter/stage-binarize-texture-removed-grayscale.md
@@ -1,32 +1,56 @@
---
layout: default-layout
-title: Binarize texture removed grayscale image Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under binarize texture removed grayscale image stage of Dynamsoft Capture Vision.
-keywords: Stages, binarize texture removed grayscale image
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: BinarizeTextureRemovedGrayscaleStage - Dynamsoft Capture Vision Parameters
+description: The BinarizeTextureRemovedGrayscaleStage transfers a texture-removed grayscale image into a binary image.
+keywords: Binarize Texture Removed Grayscale Stage
---
-# Binarize texture removed grayscale image Stage Parameters
+# BinarizeTextureRemovedGrayscaleStage
-The parameters that available under the Binarize texture removed grayscale image Stage.
+`BinarizeTextureRemovedGrayscaleStage` transfers a texture-removed grayscale image into a binary image. In JSON, it is represented as a Stage object with `"Stage": "SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE",
- "BinarizationModes" : []
-},
+ "Stage": "SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE",
+ "BinarizationModes": [
+ {
+ "Mode": "BM_LOCAL_BLOCK"
+ }
+ ]
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for binarizing texture-removed grayscale images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of binarize texture removed grayscale image stage is `SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`.
+Specifies the stage type. Fixed value: `SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`.
-## BinarizationModes
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE"` |
-Defines the binarization options with an array of [`BinarizationMode`](binarization-modes.md) objects. The modes in the array will be executed sequentially until the task is completed.
+### BinarizationModes
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An array of [`BinarizationMode`](binarization-modes.md) objects |
+Defines the binarization options. See [`BinarizationModes`](binarization-modes.md) for details.
diff --git a/parameters/reference/image-parameter/stage-convert-to-grayscale.md b/parameters/reference/image-parameter/stage-convert-to-grayscale.md
index 2e6338f..8ea5ac5 100644
--- a/parameters/reference/image-parameter/stage-convert-to-grayscale.md
+++ b/parameters/reference/image-parameter/stage-convert-to-grayscale.md
@@ -1,32 +1,56 @@
---
layout: default-layout
-title: Convert to Grayscale Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under convert to grayscale stage of Dynamsoft Capture Vision.
-keywords: Stages, convert to grayscale, ColourConversionModes, colour conversion modes
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: ConvertToGrayscaleStage - Dynamsoft Capture Vision Parameters
+description: The ConvertToGrayscaleStage converts a colour image to a grayscale image.
+keywords: Convert to Grayscale Stage
---
-# Convert to Grayscale Stage Parameters
+# ConvertToGrayscaleStage
-The parameters that available under the convert to grayscale stage.
+`ConvertToGrayscaleStage` converts a colour image to a grayscale image. In JSON, it is represented as a Stage object with `"Stage": "SST_CONVERT_TO_GRAYSCALE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_CONVERT_TO_GRAYSCALE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_CONVERT_TO_GRAYSCALE",
- "ColourConversionModes" : []
-},
+ "Stage": "SST_CONVERT_TO_GRAYSCALE",
+ "ColourConversionModes": [
+ {
+ "Mode": "CICM_GENERAL"
+ }
+ ]
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for converting to grayscale.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of Convert to grayscale stage is `SST_CONVERT_TO_GRAYSCALE`.
+Specifies the stage type. Fixed value: `SST_CONVERT_TO_GRAYSCALE`.
-## ColourConversionModes
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_CONVERT_TO_GRAYSCALE"` |
-Defines how to Convert to grayscale.
+### ColourConversionModes
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An array of *[ColourConversionModes](colour-conversion-modes.md)* objects |
+Defines how to convert a colour image to a grayscale image. See [`ColourConversionModes`](colour-conversion-modes.md) for details.
diff --git a/parameters/reference/image-parameter/stage-detect-shortlines.md b/parameters/reference/image-parameter/stage-detect-shortlines.md
index 448f280..c4655b8 100644
--- a/parameters/reference/image-parameter/stage-detect-shortlines.md
+++ b/parameters/reference/image-parameter/stage-detect-shortlines.md
@@ -1,35 +1,55 @@
---
layout: default-layout
-title: Detect Short Lines Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under detect short lines stage of Dynamsoft Capture Vision.
-keywords: Stages, detect short lines, ShortlineDetectionMode, short line detection modes
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: DetectShortLinesStage - Dynamsoft Capture Vision Parameters
+description: The DetectShortLinesStage detects short lines for document boundary detection.
+keywords: Detect Short Lines Stage
---
-# Detect Short Lines Stage Parameters
+# DetectShortLinesStage
-The parameters that available under the detect short lines stage.
+`DetectShortLinesStage` detects short lines for document boundary detection. In JSON, it is represented as a Stage object with `"Stage": "SST_DETECT_SHORTLINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_DETECT_SHORTLINES")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
"Stage": "SST_DETECT_SHORTLINES",
"ShortlineDetectionMode": {
- "Mode": "SDM_GENERAL",
+ "Mode": "SDM_GENERAL",
"Sensitivity": 3
}
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for detecting short lines.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of detect short lines stage is `SST_DETECT_SHORTLINES`.
+Specifies the stage type. Fixed value: `SST_DETECT_SHORTLINES`.
-## ShortlineDetectionMode
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DETECT_SHORTLINES"` |
-Defines how to detect short lines.
+### ShortlineDetectionMode
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
A *[ShortlineDetectionMode](shortline-detection-mode.md)* object. |
+Defines how to detect short lines. See [`ShortlineDetectionMode`](shortline-detection-mode.md) for details.
diff --git a/parameters/reference/image-parameter/stage-detect-text-zones.md b/parameters/reference/image-parameter/stage-detect-text-zones.md
index 4b86dcd..7b9198e 100644
--- a/parameters/reference/image-parameter/stage-detect-text-zones.md
+++ b/parameters/reference/image-parameter/stage-detect-text-zones.md
@@ -1,33 +1,54 @@
---
layout: default-layout
-title: Detect Text Zones Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under detect Text Zones stage of Dynamsoft Capture Vision.
-keywords: Stages, detect Text Zones, TextDetectionMode, text detection modes
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: DetectTextZonesStage - Dynamsoft Capture Vision Parameters
+description: The DetectTextZonesStage detects text zones on the image.
+keywords: Detect Text Zones Stage
---
-# Detect Text Zones Stage Parameters
+# DetectTextZonesStage
-The parameters that available under the detect text zones stage.
+`DetectTextZonesStage` detects text zones on the image. In JSON, it is represented as a Stage object with `"Stage": "SST_DETECT_TEXT_ZONES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_DETECT_TEXT_ZONES")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
"Stage": "SST_DETECT_TEXT_ZONES",
"TextDetectionMode": {
+ "Mode": "TTDM_LINE"
}
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for detecting text zones.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of detect text zones stage is `SST_DETECT_TEXT_ZONES`.
+Specifies the stage type. Fixed value: `SST_DETECT_TEXT_ZONES`.
-## TextDetectionMode
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DETECT_TEXT_ZONES"` |
-Defines how to detect text zones.
+### TextDetectionMode
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
A *[TextDetectionMode](text-detection-mode.md)* object. |
+Defines how to detect text zones. See [`TextDetectionMode`](text-detection-mode.md) for details.
diff --git a/parameters/reference/image-parameter/stage-detect-texture.md b/parameters/reference/image-parameter/stage-detect-texture.md
index a918379..ccd78e5 100644
--- a/parameters/reference/image-parameter/stage-detect-texture.md
+++ b/parameters/reference/image-parameter/stage-detect-texture.md
@@ -1,33 +1,56 @@
---
layout: default-layout
-title: Detect Texture Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under detect texture stage of Dynamsoft Capture Vision.
-keywords: Stages, detect texture, TextureDetectionModes, texture detection modes
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: DetectTextureStage - Dynamsoft Capture Vision Parameters
+description: The DetectTextureStage detects texture on the image.
+keywords: Detect Texture Stage
---
-# Detect Texture Stage Parameters
+# DetectTextureStage
-The parameters that available under the detect texture stage.
+`DetectTextureStage` detects texture on the image. In JSON, it is represented as a Stage object with `"Stage": "SST_DETECT_TEXTURE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_DETECT_TEXTURE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_DETECT_TEXTURE",
- "TextureDetectionModes" : [
+ "Stage": "SST_DETECT_TEXTURE",
+ "TextureDetectionModes": [
+ {
+ "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION"
+ }
]
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for detecting texture.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of detect texture stage is `SST_DETECT_TEXTURE`.
+Specifies the stage type. Fixed value: `SST_DETECT_TEXTURE`.
-## TextureDetectionModes
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_DETECT_TEXTURE"` |
-Defines how to detect texture.
+### TextureDetectionModes
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An array of *[TextureDetectionModes](texture-detection-modes.md)* objects. |
+Defines how to detect texture. See [`TextureDetectionModes`](texture-detection-modes.md) for details.
diff --git a/parameters/reference/image-parameter/stage-enhance-grayscale.md b/parameters/reference/image-parameter/stage-enhance-grayscale.md
index 9573e58..505f59e 100644
--- a/parameters/reference/image-parameter/stage-enhance-grayscale.md
+++ b/parameters/reference/image-parameter/stage-enhance-grayscale.md
@@ -1,33 +1,56 @@
---
layout: default-layout
-title: Enhance Grayscale Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under enhance grayscale stage of Dynamsoft Capture Vision.
-keywords: Stages, enhance grayscale, GrayscaleEnhancementModes, grayscale enhancement modes
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: EnhanceGrayscaleStage - Dynamsoft Capture Vision Parameters
+description: The EnhanceGrayscaleStage improves the quality of the grayscale image.
+keywords: Enhance Grayscale Stage
---
-# Enhance Grayscale Stage Parameters
+# EnhanceGrayscaleStage
-The parameters that available under the enhance grayscale stage.
+`EnhanceGrayscaleStage` improves the quality of the grayscale image. In JSON, it is represented as a Stage object with `"Stage": "SST_ENHANCE_GRAYSCALE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_ENHANCE_GRAYSCALE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_ENHANCE_GRAYSCALE",
- "GrayscaleEnhancementModes" : [
+ "Stage": "SST_ENHANCE_GRAYSCALE",
+ "GrayscaleEnhancementModes": [
+ {
+ "Mode": "GEM_GENERAL"
+ }
]
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for enhancing grayscale images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of enhance grayscale stage is `SST_ENHANCE_GRAYSCALE`.
+Specifies the stage type. Fixed value: `SST_ENHANCE_GRAYSCALE`.
-## GrayscaleEnhancementModes
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_ENHANCE_GRAYSCALE"` |
-Defines how to enhance grayscale.
+### GrayscaleEnhancementModes
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An array of *[GrayscaleEnhancementModes](grayscale-enhancement-modes.md)* objects. |
+Defines how to enhance the grayscale image. See [`GrayscaleEnhancementModes`](grayscale-enhancement-modes.md) for details.
diff --git a/parameters/reference/image-parameter/stage-find-contours.md b/parameters/reference/image-parameter/stage-find-contours.md
index 8cd63a8..5a1e298 100644
--- a/parameters/reference/image-parameter/stage-find-contours.md
+++ b/parameters/reference/image-parameter/stage-find-contours.md
@@ -1,23 +1,47 @@
---
layout: default-layout
-title: Find Contours Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under find contours stage of Dynamsoft Capture Vision.
-keywords: Stages, find contours
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: FindContoursStage - Dynamsoft Capture Vision Parameters
+description: The FindContoursStage finds contours in the image.
+keywords: Find Contours Stage
---
-# Find Contours Stage Parameters
+# FindContoursStage
-The parameters that available under the find contours stage.
+`FindContoursStage` finds contours in the image. In JSON, it is represented as a Stage object with `"Stage": "SST_FIND_CONTOURS"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_FIND_CONTOURS")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
"Stage": "SST_FIND_CONTOURS"
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for finding contours.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_FIND_CONTOURS`.
-The stage name of find contours stage is `SST_FIND_CONTOURS`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_FIND_CONTOURS"` |
diff --git a/parameters/reference/image-parameter/stage-remove-text-zones-from-binary.md b/parameters/reference/image-parameter/stage-remove-text-zones-from-binary.md
index 174967d..b93b1d8 100644
--- a/parameters/reference/image-parameter/stage-remove-text-zones-from-binary.md
+++ b/parameters/reference/image-parameter/stage-remove-text-zones-from-binary.md
@@ -1,30 +1,52 @@
---
layout: default-layout
-title: Remove Text Zones from Binary Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under remove text zones from binary stage of Dynamsoft Capture Vision.
-keywords: Stages, remove text zones from binary, IfEraseTextZone, erase text zone
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: RemoveTextZonesFromBinaryStage - Dynamsoft Capture Vision Parameters
+description: The RemoveTextZonesFromBinaryStage removes text zones from the binary image.
+keywords: Remove Text Zones from Binary Stage
---
-# Remove Text Zones from Binary Stage Parameters
+# RemoveTextZonesFromBinaryStage
-The parameters that available under the remove text zones from binary stage.
+`RemoveTextZonesFromBinaryStage` removes text zones from the binary image. In JSON, it is represented as a Stage object with `"Stage": "SST_REMOVE_TEXT_ZONES_FROM_BINARY"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_REMOVE_TEXT_ZONES_FROM_BINARY")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
"Stage": "SST_REMOVE_TEXT_ZONES_FROM_BINARY",
- "IfEraseTextZone": 0
+ "IfEraseTextZone": 1
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for removing text zones from binary images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of remove text zones from binary stage is `SST_REMOVE_TEXT_ZONES_FROM_BINARY`.
+Specifies the stage type. Fixed value: `SST_REMOVE_TEXT_ZONES_FROM_BINARY`.
-## IfEraseTextZone
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_REMOVE_TEXT_ZONES_FROM_BINARY"` |
-Defines how to remove text zones from binary.
+### IfEraseTextZone
-See [`IfEraseTextZone`](if-erase-text-zone.md)
+Defines whether to erase text zones from the binary image. See [`IfEraseTextZone`](if-erase-text-zone.md) for details.
diff --git a/parameters/reference/image-parameter/stage-remove-texture-from-grayscale.md b/parameters/reference/image-parameter/stage-remove-texture-from-grayscale.md
index c614310..c78712a 100644
--- a/parameters/reference/image-parameter/stage-remove-texture-from-grayscale.md
+++ b/parameters/reference/image-parameter/stage-remove-texture-from-grayscale.md
@@ -1,34 +1,58 @@
---
layout: default-layout
-title: Remove Texture from Grayscale Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under remove texture from grayscale stage of Dynamsoft Capture Vision.
-keywords: Stages, remove texture from grayscale
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: RemoveTextureFromGrayscaleStage - Dynamsoft Capture Vision Parameters
+description: The RemoveTextureFromGrayscaleStage removes texture from the grayscale image.
+keywords: Remove Texture from Grayscale Stage
---
-# Remove Texture from Grayscale Stage Parameters
+# RemoveTextureFromGrayscaleStage
-The parameters that available under the remove texture from grayscale stage.
+`RemoveTextureFromGrayscaleStage` removes texture from the grayscale image. In JSON, it is represented as a Stage object with `"Stage": "SST_REMOVE_TEXTURE_FROM_GRAYSCALE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_REMOVE_TEXTURE_FROM_GRAYSCALE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_REMOVE_TEXTURE_FROM_GRAYSCALE",
+ "Stage": "SST_REMOVE_TEXTURE_FROM_GRAYSCALE",
"TextureRemovalStrength": 2
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for removing texture from grayscale images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_REMOVE_TEXTURE_FROM_GRAYSCALE`.
-The stage name of remove texture from grayscale stage is `SST_REMOVE_TEXTURE_FROM_GRAYSCALE`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_REMOVE_TEXTURE_FROM_GRAYSCALE"` |
-## TextureRemovalStrength
+### TextureRemovalStrength
-Defines how to remove texture from grayscale.
+Defines the strength for removing texture from the grayscale image.
-| TextureRemovalStrength Parameter Summary |
-| :---------------------------------- |
+| Parameter Details |
+| :------------- |
| **Type**
*int* |
-| **Value range**
[1,9] |
+| **Value Range**
[1, 9] |
| **Default Value**
2 for BarcodeReaderTask & DocumentNormalizerTask
1 for LabelRecognizerTask |
diff --git a/parameters/reference/image-parameter/stage-scale-image.md b/parameters/reference/image-parameter/stage-scale-image.md
index 9dda0a7..864f377 100644
--- a/parameters/reference/image-parameter/stage-scale-image.md
+++ b/parameters/reference/image-parameter/stage-scale-image.md
@@ -1,33 +1,56 @@
---
layout: default-layout
-title: Scale Image Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under scale image stage of Dynamsoft Capture Vision.
-keywords: Stages, scale image, ImageScaleSetting, image scale setting
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: ScaleImageStage - Dynamsoft Capture Vision Parameters
+description: The ScaleImageStage down/up scales the image.
+keywords: Scale Image Stage
---
-# Scale Image Stage Parameters
+# ScaleImageStage
-The parameters that available under the scale image stage.
+`ScaleImageStage` down/up scales the image. In JSON, it is represented as a Stage object with `"Stage": "SST_SCALE_IMAGE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_SCALE_IMAGE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_SCALE_IMAGE",
- "ImageScaleSetting" : {
+ "Stage": "SST_SCALE_IMAGE",
+ "ImageScaleSetting": {
+ "ScaleType": "ST_SCALE_DOWN",
+ "ReferenceEdge": "RE_SHORTER_EDGE",
+ "EdgeLengthThreshold": 2300
}
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for scaling images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of scale image stage is `SST_SCALE_IMAGE`.
+Specifies the stage type. Fixed value: `SST_SCALE_IMAGE`.
-## ImageScaleSetting
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_SCALE_IMAGE"` |
-Defines how to scale image.
+### ImageScaleSetting
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An *[ImageScaleSetting](image-scale-settings.md)* object. |
+Defines how to scale the image. See [`ImageScaleSetting`](image-scale-settings.md) for details.
diff --git a/parameters/reference/image-parameter/stage-transform-grayscale.md b/parameters/reference/image-parameter/stage-transform-grayscale.md
index e20782a..f31a0a1 100644
--- a/parameters/reference/image-parameter/stage-transform-grayscale.md
+++ b/parameters/reference/image-parameter/stage-transform-grayscale.md
@@ -1,33 +1,56 @@
---
layout: default-layout
-title: Transform Grayscale Stage Parameters - Dynamsoft Capture Vision Parameters
-description: The parameters that available under transform grayscale stage of Dynamsoft Capture Vision.
-keywords: Stages, transform grayscale, GrayscaleTransformationModes, grayscale transformation modes
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
+title: TransformGrayscaleStage - Dynamsoft Capture Vision Parameters
+description: The TransformGrayscaleStage transforms the grayscale image.
+keywords: Transform Grayscale Stage
---
-# Transform Grayscale Stage Parameters
+# TransformGrayscaleStage
-The parameters that available under the transform grayscale Stage.
+`TransformGrayscaleStage` transforms the grayscale image. In JSON, it is represented as a Stage object with `"Stage": "SST_TRANSFORM_GRAYSCALE"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_TRANSFORM_GRAYSCALE")
+```
+
+**Parent object:** [ApplicableStages]({{ site.dcvb_parameters_reference }}image-parameter/applicable-stages.html) within [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html)
+
+**Example:**
```json
{
- "Stage":"SST_TRANSFORM_GRAYSCALE",
- "GrayscaleTransformationModes" : [
+ "Stage": "SST_TRANSFORM_GRAYSCALE",
+ "GrayscaleTransformationModes": [
+ {
+ "Mode": "GTM_ORIGINAL"
+ }
]
-},
+}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for transforming grayscale images.
+> - To use it, add this object to the `ApplicableStages` array within an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
-The stage name of transform grayscale stage is `SST_TRANSFORM_GRAYSCALE`.
+Specifies the stage type. Fixed value: `SST_TRANSFORM_GRAYSCALE`.
-## GrayscaleTransformationModes
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_TRANSFORM_GRAYSCALE"` |
-Defines how to transform grayscale.
+### GrayscaleTransformationModes
-| Stage Parameter Summary |
-| :---------------------- |
-| **Type**
An array of *[GrayscaleTransformationModes](grayscale-transformation-modes.md)* objects. |
+Defines how to transform the grayscale image. See [`GrayscaleTransformationModes`](grayscale-transformation-modes.md) for details.
diff --git a/parameters/reference/image-parameter/text-detection-mode.md b/parameters/reference/image-parameter/text-detection-mode.md
index 438ff5f..fcfa88c 100644
--- a/parameters/reference/image-parameter/text-detection-mode.md
+++ b/parameters/reference/image-parameter/text-detection-mode.md
@@ -3,9 +3,6 @@ layout: default-layout
title: TextDetectionMode - Dynamsoft Capture Vision Parameters
description: The parameter TextDetectionMode of Dynamsoft Capture Vision is for detecting texts on an image.
keywords: TextDetectionMode, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
@@ -13,20 +10,35 @@ noTitleIndex: true
Parameter `TextDetectionMode` determines how to detect the text area. For tasks like barcode reading or border detection, the text part is not important; while for the task of text recognition, the results of detected text zone are mandatory.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_DETECT_TEXT_ZONES")
+ └── TextDetectionMode
+```
+
+**Parent object:** [DetectTextZonesStage](stage-detect-text-zones.md)
+
+**Example:**
```json
{
- "TextDetectionMode":
- {
- "Mode": "TTDM_WORD",
- "Direction": "HORIZONTAL",
- "CharHeightRange": [1,1000,1]
+ "TextDetectionMode": {
+ "Mode": "TTDM_LINE"
}
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `TextDetectionMode` parameter.
+> - To use it, embed this parameter within a [DetectTextZonesStage](stage-detect-text-zones.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
Parameter `TextDetectionMode` consist of a group of text detection mode objects. Each text detection mode object includes a candidate mode and a series of mode arguments. The mode arguments of the text detection mode object is shown as follow:
@@ -249,7 +261,7 @@ Parameter `TextDetectionMode` consist of a group of text detection mode objects.
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### TTDM_WORD
diff --git a/parameters/reference/image-parameter/texture-detection-modes.md b/parameters/reference/image-parameter/texture-detection-modes.md
index 129df74..6e784b4 100644
--- a/parameters/reference/image-parameter/texture-detection-modes.md
+++ b/parameters/reference/image-parameter/texture-detection-modes.md
@@ -3,9 +3,6 @@ layout: default-layout
title: TextureDetectionModes - Dynamsoft Capture Vision Parameters
description: The parameter TextureDetectionModes of Dynamsoft Capture Vision is for detecting texts on an image.
keywords: TextureDetectionModes, parameter reference, parameter
-needAutoGenerateSidebar: true
-needGenerateH3Content: true
-noTitleIndex: true
---
@@ -13,25 +10,37 @@ noTitleIndex: true
Parameter `TextureDetectionModes` controls how to detect texture on an image.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageParameterOptions[i]
+ └── ApplicableStages[j] (Stage object where Stage = "SST_DETECT_TEXTURE")
+ └── TextureDetectionModes
+```
+
+**Parent object:** [DetectTextureStage](stage-detect-texture.md)
+
+**Example:**
```json
{
- "TextureDetectionModes":
- [
+ "TextureDetectionModes": [
{
- "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION",
- "Sensitivity": 1
- },
- {
- "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION",
- "Sensitivity": 9
+ "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION"
}
]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `TextureDetectionModes` parameter.
+> - To use it, embed this parameter within a [DetectTextureStage](stage-detect-texture.md) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
Parameter `TextureDetectionModes` consist of a group of texture detection mode objects. Each texture detection mode object includes a candidate mode and a series of mode arguments. The mode arguments of the texture detection mode object is shown as follow:
@@ -143,7 +152,7 @@ If the `TextureDetectionModes` is not configured in your template file, the foll
}
```
-## Candidate Modes Introduction
+## Candidate Mode Introductions
### TDM_GENERAL_WIDTH_CONCENTRATION
diff --git a/parameters/reference/image-source-options/directory-path.md b/parameters/reference/image-source-options/directory-path.md
index 54c099d..7e3ecc4 100644
--- a/parameters/reference/image-source-options/directory-path.md
+++ b/parameters/reference/image-source-options/directory-path.md
@@ -3,17 +3,23 @@ layout: default-layout
title: DirectoryPath - ImageSource - Dynamsoft Capture Vision Parameters
description: The parameter DirectoryPath defines a path when the library have to read files.
keywords: Directory path
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
permalink: /parameters/reference/image-source-options/directory-path.html
---
-
# DirectoryPath
Parameter `DirectoryPath` defines a path when the library have to read files.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageSourceOptions
+ └── DirectoryPath
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
@@ -21,8 +27,15 @@ Parameter `DirectoryPath` defines a path when the library have to read files.
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `DirectoryPath` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| DirectoryPath Parameter Summary |
+| DirectoryPath Parameter Details |
| :------------- |
| **Type**
*String* |
diff --git a/parameters/reference/image-source-options/file-filter.md b/parameters/reference/image-source-options/file-filter.md
index ac174e2..1322822 100644
--- a/parameters/reference/image-source-options/file-filter.md
+++ b/parameters/reference/image-source-options/file-filter.md
@@ -9,7 +9,17 @@ keywords: File filter, ISA
Parameter `FileFilter` specifies a file name filter string, which determines which files are fetched.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageSourceOptions
+ └── FileFilter
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
@@ -17,9 +27,16 @@ Parameter `FileFilter` specifies a file name filter string, which determines whi
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `FileFilter` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| FileFilter Parameter Summary |
+| FileFilter Parameter Details |
| :----------------------------------- |
| **Description**
A file name filter string |
| **Type**
*String* |
diff --git a/parameters/reference/image-source-options/index.md b/parameters/reference/image-source-options/index.md
deleted file mode 100644
index 9fd677d..0000000
--- a/parameters/reference/image-source-options/index.md
+++ /dev/null
@@ -1,21 +0,0 @@
----
-layout: default-layout
-title: Index - ImageSourceOptions Parameters
-description: The index of ImageSourceOptions parameters.
-keywords: ImageSourceOptions, parameter reference, parameter
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
----
-
-# ImageSourceOptions Parameters
-
-| Parameter Name | Description |
-| -------------------- | ----------- |
-| [`DirectoryPath`](directory-path.md) | Defines the path of the image source. |
-| [`FileFilter`](file-filter.md) | Defines a file name filter string, which determines which files are fetched. |
-| [`Name`](name.md) | Defines the name of a `ImageSourceOptions` object, which serves as its unique identifier. |
-| [`Pages`]({{ site.dcvb_parameters_reference }}image-source-options/pages.html) | Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. |
-| [`PDFReadingMode`](pdf-reading-mode.md) | Defines how to handle PDF files. |
-| [`Recursive`](recursive.md) | Defines whether to fetch files recursively. |
-| [`Type`](type.md) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. |
diff --git a/parameters/reference/image-source-options/name.md b/parameters/reference/image-source-options/name.md
index 6aa8609..c9f541a 100644
--- a/parameters/reference/image-source-options/name.md
+++ b/parameters/reference/image-source-options/name.md
@@ -3,16 +3,23 @@ layout: default-layout
title: Name - Dynamsoft Capture Vision Parameter Reference ImageSource Object.
description: The parameter Name defines the unique identifier of ImageSource object.
keywords: top-level object, name, unique identifier
-needAutoGenerateSidebar: true
-noTitleIndex: true
needGenerateH3Content: true
---
-
# Name
Parameter `Name` represents the name of a `ImageSource` object, which serves as its unique identifier.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageSourceOptions
+ └── Name
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
@@ -20,7 +27,14 @@ Parameter `Name` represents the name of a `ImageSource` object, which serves as
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Name` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
| Parameter Details |
| :----------------------------------- |
diff --git a/parameters/reference/image-source-options/pages.md b/parameters/reference/image-source-options/pages.md
index d7eadbd..f8e0fea 100644
--- a/parameters/reference/image-source-options/pages.md
+++ b/parameters/reference/image-source-options/pages.md
@@ -3,16 +3,23 @@ layout: default-layout
title: Pages - Dynamsoft Capture Vision Parameters
description: The parameter Pages of Dynamsoft Capture Vision defines .
keywords: Pages, ISA
-needAutoGenerateSidebar: true
-noTitleIndex: true
needGenerateH3Content: true
---
-
# Pages
Parameter `Pages` sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageSourceOptions
+ └── Pages
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
@@ -20,9 +27,16 @@ Parameter `Pages` sets the 0-based page indexes of a file (.tiff or .pdf) for ba
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Pages` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| Pages Parameter Summary |
+| Pages Parameter Details |
| :--------------------- |
| **Description**
Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. |
| **Type**
*int array* |
diff --git a/parameters/reference/image-source-options/pdf-reading-mode.md b/parameters/reference/image-source-options/pdf-reading-mode.md
index 4d11800..34fcb26 100644
--- a/parameters/reference/image-source-options/pdf-reading-mode.md
+++ b/parameters/reference/image-source-options/pdf-reading-mode.md
@@ -3,21 +3,27 @@ layout: default-layout
title: PDFReadingMode - Dynamsoft Capture Vision Parameters
description: The parameter PDFReadingMode of Dynamsoft Capture Vision defines .
keywords: PDF reading mode, ISA
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
permalink: /parameters/reference/image-source-options/pdf-reading-mode.html
---
-
# PDFReadingMode
Parameter `PDFReadingMode` defines how to handle PDF files.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageSourceOptions
+ └── PdfReadingMode
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
- "PDFReadingMode":
+ "PDFReadingMode":
{
"Mode": "PDFRM_RASTER",
"DPI": 300,
@@ -26,7 +32,14 @@ Parameter `PDFReadingMode` defines how to handle PDF files.
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `PdfReadingMode` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
Parameter `PDFReadingMode` is configured by a PDF reading mode objects. The PDF reading mode object includes a candidate mode and a series of mode arguments. The available mode arguments of the PDF reading mode object is shown as follow.
diff --git a/parameters/reference/image-source-options/recursive.md b/parameters/reference/image-source-options/recursive.md
index 39b10e9..1a38125 100644
--- a/parameters/reference/image-source-options/recursive.md
+++ b/parameters/reference/image-source-options/recursive.md
@@ -3,17 +3,23 @@ layout: default-layout
title: Recursive - Dynamsoft Capture Vision Parameters
description: The parameter Recursive of Dynamsoft Capture Vision defines .
keywords: Recursive, ISA
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
permalink: /parameters/reference/image-source-options/recursive.html
---
-
# Recursive
Parameter `Recursive` indicates whether to fetch files recursively.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+ImageSourceOptions
+ └── Recursive
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
@@ -21,9 +27,16 @@ Parameter `Recursive` indicates whether to fetch files recursively.
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Recursive` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| Recursive Parameter Summary |
+| Recursive Parameter Details |
| :-------------------------- |
| **Description**
Use 0 (false) and 1 (true) to define whether to fetch files. |
| **Type**
*int* |
diff --git a/parameters/reference/image-source-options/type.md b/parameters/reference/image-source-options/type.md
index fb84773..539b884 100644
--- a/parameters/reference/image-source-options/type.md
+++ b/parameters/reference/image-source-options/type.md
@@ -3,17 +3,23 @@ layout: default-layout
title: Type - Dynamsoft Capture Vision Parameters
description: The parameter Type of Dynamsoft Capture Vision defines .
keywords: Type, ISA
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
permalink: /parameters/reference/image-source-options/type.html
---
-
# Type
-Parameter `Type` indicates the type of the ImageSource object, which helps CVR create the correct type of image source.
+Parameter `Type` indicates the type of the `ImageSource` object, which helps CVR create the correct type of image source.
+
+## JSON Structure
-## Example
+**Location in template:**
+```
+ImageSourceOptions
+ └── Type
+```
+
+**Parent object:** [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object
+
+**Example:**
```json
{
@@ -21,9 +27,16 @@ Parameter `Type` indicates the type of the ImageSource object, which helps CVR c
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Type` parameter.
+> - To use it, embed this parameter within a [ImageSource]({{ site.dcvb_parameters }}file/image-source.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| Type Parameter Summary |
+| Type Parameter Details |
| :--------------------- |
| **Description**
Define the type of ImageSource. |
| **Type**
*String* |
diff --git a/parameters/reference/index.md b/parameters/reference/index.md
deleted file mode 100644
index 88544cf..0000000
--- a/parameters/reference/index.md
+++ /dev/null
@@ -1,222 +0,0 @@
----
-layout: default-layout
-title: Dynamsoft Capture Vision Parameter Reference - Main Page
-description: Dynamsoft Capture Vision Parameter Reference - Main Page
-keywords: parameter reference, parameters
-needAutoGenerateSidebar: false
-permalink: /parameters/reference/index.html
----
-
-# Parameter Reference
-
-## Capture Vision Template
-
-| Parameter Name | Description |
-| -------------- | ----------- |
-| [`ImageROIProcessingNameArray`](capture-vision-template/image-roi-processing-name-array.md) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. |
-| [`ImageSourceName`](capture-vision-template/image-source-name.md) | Indicates the input source name, used to refer to the `ImageSource` object. |
-| [`MaxParallelTasks`](capture-vision-template/max-parallel-tasks.md) | Defines the maximum number of parallel tasks for the DCV runtime. |
-| [`MinImageCaptureInterval`]({{ site.dcvb_parameters_reference }}capture-vision-template/min-image-capture-interval.html) | Specifies the minimum time interval (in milliseconds) allowed between consecutive image captures. |
-| [`Name`](capture-vision-template/name.md) | Defines the name of a `CaptureVisionTemplate` object, which serves as its unique identifier. |
-| [`OutputOriginalImage`](capture-vision-template/output-original-Image.md) | Indicates whether DCV finally outputs the original input image. |
-| [`SemanticProcessingNameArray`](capture-vision-template/semantic-processing-name-array.md) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. |
-| [`Timeout`](capture-vision-template/timeout.md) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. |
-
-## Target ROI Def
-
-| Parameter Name | Description |
-| --------------- | ----------- |
-| [`BaseTargetROIDefName`](target-roi-def/base-target-roidef-name.md) | Represents the name of another `TargetROIDef` object to inherit from. |
-| [`Location`](target-roi-def/location.md) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. |
-| [`Name`](target-roi-def/name.md) | Defines the name of a `TargetROIDef` object, which serves as its unique identifier. |
-| [`PauseFlag`](target-roi-def/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`](target-roi-def/task-setting-name-array.md) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `BarcodeReaderTaskSetting`, `LabelRecognizerTaskSetting`, `DocumentNormalizerTaskSetting` objects. |
-
-## Semantic Processing
-
-| Parameter Name | Description |
-| --------------- | ----------- |
-| [`Name`](semantic-processing/name.md) | Defines the name of a `SemanticProcessing` object, which serves as its unique identifier. |
-| [`ReferenceObjectFilter`](semantic-processing/reference-object-filter.md) | Sets a [ReferenceObjectFilter](#referenceobjectfilter) object to define the filter conditions. |
-| [`TaskSettingNameArray`](semantic-processing/task-setting-name-array.md) | Represents the collection of task setting object names, used to refer to the `CodeParserTaskSetting` objects. |
-
-## Barcode Reader Task Setting
-
-| Parameter Name | Description |
-| -------------- | ----------- |
-| [`BarcodeColourModes`](barcode-reader-task-settings/barcode-colour-modes.md) | Defines the barcode colour modes. |
-| [`BarcodeComplementModes`](barcode-reader-task-settings/barcode-complement-modes.md) | Defines how to complement the missing parts of a barcode. |
-| [`BarcodeFormatIds`](barcode-reader-task-settings/barcode-format-ids.md) | Defines the formats of the barcode to process. |
-| [`BaseBarcodeReaderTaskSettingName`](barcode-reader-task-settings/base-barcode-reader-task-setting-name.md) | Represents the name of another `BarcodeReaderTaskSetting` object to inherit from. |
-| [`DeblurModes`](barcode-reader-task-settings/deblur-modes.md) | Defines the mode and priority for deblurring. |
-| [`DeformationResistingModes`](barcode-reader-task-settings/deformation-resisting-modes.md) | Defines how to handle distorted and deformed barcodes. |
-| [`DPMCodeReadingModes`](barcode-reader-task-settings/dpm-code-reading-modes.md) | Defines how to read direct part mark (DPM) barcodes. |
-| [`ExpectedBarcodesCount`](barcode-reader-task-settings/expected-barcodes-count.md) | Defines the number of barcodes expected to be detected. |
-| [`LocalizationModes`](barcode-reader-task-settings/localization-modes.md) | Defines how to localize barcodes. |
-| [`MaxThreadsInOneTask`](barcode-reader-task-settings/max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. |
-| [`Name`](barcode-reader-task-settings/name.md) | Defines the name of a `BarcodeReaderTaskSetting` object, which serves as its unique identifier. |
-| [`ReturnBarcodeZoneClarity`](barcode-reader-task-settings/return-barcode-zone-clarity.md) | Defines whether to return the clarity of the barcode zone. |
-| [`SectionImageParameterArray`](barcode-reader-task-settings/section-image-parameter-array.md) | Defines `ImageParameter` in section unit. |
-| [`StartSection`](barcode-reader-task-settings/start-section.md) | Defines the start section of the `BarcodeReaderTask`. |
-| [`TerminateSetting`](barcode-reader-task-settings/terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. |
-| [`TextResultOrderModes`](barcode-reader-task-settings/text-result-order-modes.md) | Defines the order of the returned text results. |
-
-## Label Recognizer Task Setting
-
-| Parameter Name | Description |
-| -------------- | ----------- |
-| [`BaseLabelRecognizerTaskSettingName`](label-recognizer-task-settings/base-label-recognizer-task-setting-name.md) | Represents the name of another `LabelRecognizerTaskSetting` object to inherit from. |
-| [`DictionaryCorrectionThresholds`](label-recognizer-task-settings/dictionary-correction-thresholds.md) | Sets the threshold of dictionary error correction. |
-| [`DictionaryPath`](label-recognizer-task-settings/dictionary-path.md) | Sets the path of the dictionary file. |
-| [`MaxThreadsInOneTask`](label-recognizer-task-settings/max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. |
-| [`Name`](label-recognizer-task-settings/name.md) | Defines the name of a `LabelRecognizerTaskSetting` object, which serves as its unique identifier. |
-| [`SectionImageParameterArray`](label-recognizer-task-settings/section-image-parameter-array.md) | Defines `ImageParameter` in section unit. |
-| [`StartSection`](label-recognizer-task-settings/start-section.md) | Defines the start section of the `LabelRecognizerTask`. |
-| [`StringLengthRange`](label-recognizer-task-settings/string-length-range.md) | Sets the range of string lengths for concatenated strings of recognized text lines. |
-| [`StringRegExPattern`](label-recognizer-task-settings/string-regex-pattern.md) | Specifies the regular expression pattern for concatenated strings of recognized text lines. |
-| [`TerminateSetting`](label-recognizer-task-settings/terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. |
-| [`TextLineSpecificationNameArray`](label-recognizer-task-settings/text-line-specification-name-array.md) | Defines the collection of text line specification object names |
-| [`ConfusableCharactersPath`](label-recognizer-task-settings/confusable-characters-path.md) | Defines the path to the .data file of the confusable characters. |
-| [`ClusterSamplesCountThreshold`](label-recognizer-task-settings/cluster-samples-count-threshold.md) | Defines the threshold for successful character clustering. |
-
-## Document Normalizer Task Setting
-
-| Parameter Name | Description |
-| ------------------------------------------- | ----------- |
-| [`BaseDocumentNormalizerTaskSettingName`](document-normalizer-task-settings/base-document-normalizer-task-setting-name.md) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. |
-| [`Brightness`](document-normalizer-task-settings/brightness.md) | Defines the brightness of the normalized image. |
-| [`ColourMode`](document-normalizer-task-settings/colour-mode.md) | Defines the output colour mode of the normalized image. |
-| [`ContentType`](document-normalizer-task-settings/content-type.md) | Defines which contents are the targeting objects. |
-| [`Contrast`](document-normalizer-task-settings/contrast.md) | Defines the contrast of the normalized image. |
-| [`CornerAngleRange`](document-normalizer-task-settings/corner-angle-range.md) | Defines the range of angles (in degrees) of the extracted corners. |
-| [`DeskewMode`](document-normalizer-task-settings/deskew-mode.md) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. |
-| [`ExpectedDocumentsCount`](document-normalizer-task-settings/expected-documents-count.md) | Defines the number of documents expected to be detected. |
-| [`LineExtractionModes`](document-normalizer-task-settings/line-extraction-modes.md) | Defines the algorithm used to extract lines. |
-| [`MaxThreadsInOneTask`](document-normalizer-task-settings/max-threads-in-one-task.md) | Defines the maximum threads that can be consumed in one task. |
-| [`Name`](document-normalizer-task-settings/name.md) | Defines the name of a `DocumentNormalizerTaskSetting` object, which serves as its unique identifier. |
-| [`PageSize`](document-normalizer-task-settings/page-size.md) | Defines the page size (width by height in pixels) of the normalized image. |
-| [`QuadrilateralDetectionModes`](document-normalizer-task-settings/quadrilateral-detection-modes.md) | Defines the quadrilateral detection process on an image. |
-| [`SectionImageParameterArray`](document-normalizer-task-settings/section-image-parameter-array.md) | Defines `ImageParameter` in section unit. |
-| [`StartSection`](document-normalizer-task-settings/start-section.md) | Defines the start section of the `DocumentNormalizerTask`. |
-| [`TerminateSetting`](document-normalizer-task-settings/terminate-setting.md) | Defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage. |
-
-## Image Parameter
-
-| Parameter Name | Description |
-| ---------------------------------- | ----------- |
-| [`BaseImageParameterName`](image-parameter/base-image-parameter-name.md) | Represents the name of another `ImageParameter` object to inherit from. |
-| [`BinarizationModes`](image-parameter/binarization-modes.md) | Defines the process of binarization |
-| [`ColourConversionModes`](image-parameter/colour-conversion-modes.md) | Defines how to convert a colour image to a grayscale image. |
-| [`GrayscaleEnhancementModes`](image-parameter/grayscale-enhancement-modes.md) | Defines the image processing methods to enhance the quality of the grayscale image. |
-| [`GrayscaleTransformationModes`](image-parameter/grayscale-transformation-modes.md) | Defines whether or not to invert the color of the grayscale image. |
-| [`IfEraseTextZone`](image-parameter/if-erase-text-zone.md) | Defines whether to erase the detected text zone. |
-| [`Name`](image-parameter/name.md) | Defines the name of a `ImageParameter` object, which serves as its unique identifier. |
-| [`RegionPredetectionModes`](image-parameter/region-predetection-modes.md) | Defines how to find a region of interest (ROI) within the image or frame. |
-| [`ScaleDownThreshold`](image-parameter/scale-down-threshold.md) | Defines the threshold for image shrinking. |
-| [`ScaleUpModes`](image-parameter/scale-up-modes.md) | Defines the scale-up process when targets in the image are too small. |
-| [`TextDetectionMode`](image-parameter/text-detection-mode.md) | Defines how to detect the text area. |
-| [`TextureDetectionModes`](image-parameter/texture-detection-modes.md) | Defines how to detect texture on an image. |
-
-## TextLine Specification
-
-| Parameter Name | Description |
-| ----------------------------------- | ----------- |
-| [`ApplicableTextLineNumbers`](text-line-specification/applicable-text-line-numbers.md) | Defines the line numers of the targeting lines which are specified by the `TextLineSpecification` object. |
-| [`BaseTextLineSpecificationName`](text-line-specification/base-text-line-specification-name.md) | Defines the name of another `BaseTextLineSpecificationName` object. |
-| [`CharHeightRange`](text-line-specification/char-height-range.md) | Defines the range of the character height. |
-| [`CharacterModelName`](text-line-specification/character-model-name.md) | Defines the name of the character model. |
-| [`CharacterNormalizationModes`](text-line-specification/character-normalization-modes.md) | Defines an array of character normalization mode to implement. |
-| [`FirstPoint`](text-line-specification/position.md#firstpoint) | The top-left vertex coordinate of the the text line. |
-| [`SecondPoint`](text-line-specification/position.md#secondpoint) | The top-right vertex coordinate of the the text line. |
-| [`ThirdPoint`](text-line-specification/position.md#thirdpoint) | The bottom-right vertex coordinate of the the text line. |
-| [`FourthPoint`](text-line-specification/position.md#fourthpoint) | The bottom-left vertex coordinate of the the text line. |
-| [`Name`](text-line-specification/name.md) | Defines the name of a `TextLineSpecification` object, which serves as its unique identifier. |
-| [`BinarizationModes`](text-line-specification/binarization-modes.md) | Helps control the process of binarization, i.e., converting a grayscale image to a binary image. |
-| [`GrayscaleEnhancementModes`](text-line-specification/grayscale-enhancement-modes.md) | Provides some image processing methods to enhance the grayscale quality of the text line area. |
-| [`StringLengthRange`](text-line-specification/string-length-range.md) | Sets the range of string length for each recognized line. |
-| [`StringRegExPattern`](text-line-specification/string-regex-pattern.md) | Specifies the regular expression pattern of the string within a line. It is used to correct the recognized line text. |
-| [`ConcatStringLengthRange`](text-line-specification/concat-string-length-range.md) | Sets the range of string length for the concated recognized text lines. |
-| [`ConcatStringRegExPattern`](text-line-specification/concat-string-regex-pattern.md) | Specifies the regular expression pattern of the concated text lines. It is used to correct the recognized line text. |
-| [`ConcatSeparator`](text-line-specification/concat-separator.md) | Defines the concat separator used to join multiple lines of text. |
-| [`ConcatResults`](text-line-specification/concat-results.md) | Defines whether to concatenate multiple lines of text. |
-| [`OutputResults`](text-line-specification/output-results.md) | Defines whether to enable the output of the `TextLineSpecification` object. |
-| [`SubGroups`](text-line-specification/sub-groups.md) | Defines the layout of subgroups of the `TextLineSpecification` object. |
-| [`ReferenceGroupName`](text-line-specification/reference-group-name.md) | Defines the reference group for space layout configuration. |
-| [`TextLinesCount`](text-line-specification/text-lines-count.md) | Defines the expected number of text lines for the `TextLineSpecification` object. |
-| [`ConfusableCharactersCorrection`](text-line-specification/confusable-characters-correction.md) | Defines the confusing character set and an array of reference font names for error correction. |
-
-## Character Model
-
-| Parameter Name | Description |
-| -------------------- | ----------- |
-| [`DirectoryPath`](character-model/directory-path.md) | Defines the path of character models. |
-| [`FilterFilePath`](character-model/filter-file-path.md) | Defines the full path of the filter file which specifies the characters to be recognized. |
-| [`Name`](character-model/name.md) | Defines the name of a `CharacterModel` object, which serves as its unique identifier. |
-
-## Barcode Format Specification
-
-| Parameter Name | Description |
-| ---------------- | ----------- |
-| [`AllModuleDeviation`](barcode-format-specification/all-module-deviation.md) | Defines the width deviation value (in moduleSize) of a non-standard 1D barcode type relative to the standard barcode width. |
-| [`AustralianPostEncodingTable`](barcode-format-specification/australian-post-encoding-table.md) | Defines the encoding table used to code the Customer Information Field of Australian Post Customer Barcode. |
-| [`BarcodeAngleRangeArray`](barcode-format-specification/barcode-angle-range-array.md) | Defines the range of angles (in degrees) for barcodes searching and result filtering. |
-| [`BarcodeBytesLengthRangeArray`](barcode-format-specification/barcode-bytes-length-range-array.md) | Defines the range of barcode bytes length for barcodes searching and result filtering. |
-| [`BarcodeHeightRangeArray`](barcode-format-specification/barcode-height-range-array.md) | Defines the range of heights (in pixels) for barcodes searching and result filtering. |
-| [`BarcodeTextLengthRangeArray`](barcode-format-specification/barcode-text-length-range-array.md) | Defines the range of barcode text length for barcodes searching and result filtering. |
-| [`BarcodeTextRegExPattern`](barcode-format-specification/barcode-text-regex-pattern.md) | Defines the regular expression pattern of barcode text characters for barcodes searching and result filtering. |
-| [`BarcodeWidthRangeArray`](barcode-format-specification/barcode-width-range-array.md) | Defines the range of widths (in pixels) for barcodes searching and result filtering. |
-| [`BarcodeZoneBarCountRangeArray`](barcode-format-specification/barcode-zone-bar-count-range-array.md) | Defines the range of bar count of the barcode zone for barcodes searching. |
-| [`BarcodeZoneMinDistanceToImageBorders`](barcode-format-specification/barcode-zone-min-distance-to-image-borders.md) | Defines the minimum distance (in pixels) between the barcode zone and image borders. |
-| [`Code128Subset`](barcode-format-specification/code128-subset.md) | Defines the subset of Code 128. |
-| [`EnableAddOnCode`](barcode-format-specification/enable-addon-code.md) | Defines whether to identify addon code. |
-| [`EnableDataMatrixECC000-140`](barcode-format-specification/enable-data-matrix-ecc000-140.md) | Defines whether to read Data Matrix ECC000-140 barcode. |
-| [`EnableQRCodeModel1`](barcode-format-specification/enable-qr-code-model-1.md) | Defines whether to read QR code model 1. |
-| [`FindUnevenModuleBarcode`](barcode-format-specification/find-uneven-module-barcode.md) | Defines whether to find barcodes with uneven barcode modules. |
-| [`HeadModuleRatio`](barcode-format-specification/head-module-ratio.md) | Defines the module count and module size ratio of the barcode head section. |
-| [`MinQuietZoneWidth`](barcode-format-specification/min-quiet-zone-width.md) | Defines the minimum width (in moduleSize) of the barcode quiet zone. |
-| [`MinRatioOfBarcodeZoneWidthToHeight`](barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.md) | Defines the minimum ratio (width/height as a percentage) of the barcode zone. |
-| [`MinResultConfidence`](barcode-format-specification/min-result-confidence.md) | Defines the minimum confidence of the result. |
-| [`MirrorMode`](barcode-format-specification/mirror-mode.md) | Defines whether to decode mirrored barcodes. |
-| [`ModuleSizeRangeArray`](barcode-format-specification/module-size-range-array.md) | Defines the range of module size (in pixels) while barcode searching and result filtering. |
-| [`MSICodeCheckDigitCalculation`](barcode-format-specification/msi-code-check-digit-calculation.md) | Defines the scheme used for calculating a check digit of an MSI barcode. |
-| [`Name`](barcode-format-specification/name.md) | Defines the name of a `BarcodeFormatSpecification` object, which serves as its unique identifier. |
-| [`PartitionModes`](barcode-format-specification/partition-modes.md) | Defines the mode to apply partition process when decoding QRCode and DataMatrix. |
-| [`PatchCodeSearchingMargin`](barcode-format-specification/patch-code-searching-margins.md) | Defines the patch code searching margins. |
-| [`RequireStartStopChars`](barcode-format-specification/require-start-stop-chars.md) | Defines whether the start and stop characters are required when searching for common 1D barcodes. |
-| [`ReturnPartialBarcodeValue`](barcode-format-specification/return-partial-barcode-value.md) | Defines whether to return partial barcode value(s). |
-| [`StandardFormat`](barcode-format-specification/standard-format.md) | Defines the standard barcode format. |
-| [`TailModuleRatio`](barcode-format-specification/tail-module-ratio.md) | Defines the module count and module size ratio of the barcode tail section. |
-| [`VerifyCheckDigit`](barcode-format-specification/verify-check-digit.md) | Defines whether to verify the check digit in barcodes where this check digit is optional. |
-
-## Code Parser Task Setting Options
-
-| Parameter Name | Description |
-| ------------------------ | ----------- |
-| [`CodeSpecifications`](code-parser-task-settings/code-specifications.md) | Defines the names of CodeSpecification used for code parsing. |
-| [`Name`](code-parser-task-settings/name.md) | Defines the name of a `CodeParserTaskSetting` object, which serves as its unique identifier. |
-| [`ResourcesPath`](code-parser-task-settings/resources-path.md) | Defines the directory path that contains the resources needed for code parsing. |
-
-## Image Source Options
-
-| Parameter Name | Description |
-| -------------------- | ----------- |
-| [`DirectoryPath`](image-source-options/directory-path.md) | Defines the path of the image source. |
-| [`FileFilter`](image-source-options/file-filter.md) | Defines a file name filter string, which determines which files are fetched. |
-| [`Name`]({{ site.dcvb_parameters_reference }}image-source-options/name.html) | Defines the name of a `ImageSource` object, which serves as its unique identifier. |
-| [`Pages`]({{ site.dcvb_parameters_reference }}image-source-options/pages.html) | Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. |
-| [`PDFReadingMode`](image-source-options/pdf-reading-mode.md) | Defines how to handle PDF files. |
-| [`Recursive`](image-source-options/recursive.md) | Defines whether to fetch files recursively. |
-| [`Type`](image-source-options/type.md) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. |
-
-## Global Parameter
-
-| Parameter Name | Description |
-| ---------------------------- | ----------- |
-| [`MaxTotalImageDimension`](global-parameter/max-total-image-dimension.md) | Defines the maximum total dimension of the images that read in the memory. |
-
-## OutputTaskSetting Parameters
-
-| Parameter Name | Description |
-| -------------- | ----------- |
-| [`Name`](output-task-setting/name.md) | Defines the name of a [`OutputTaskSetting`]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html) object, which serves as its unique identifier. |
-| [`OutputCondidtion`](output-task-setting/output-condition.md) | Defines how the [`OutputTaskSetting`]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html) object outputs results that satisfy multiple filter conditions across products. |
diff --git a/parameters/reference/label-recognizer-task-settings/base-label-recognizer-task-setting-name.md b/parameters/reference/label-recognizer-task-settings/base-label-recognizer-task-setting-name.md
index 1cec614..2cc8386 100644
--- a/parameters/reference/label-recognizer-task-settings/base-label-recognizer-task-setting-name.md
+++ b/parameters/reference/label-recognizer-task-settings/base-label-recognizer-task-setting-name.md
@@ -1,18 +1,25 @@
---
layout: default-layout
title: BaseLabelRecognizerTaskSettingName - Dynamsoft Label Recognizer Parameters
-description: The parameter BaseLabelRecognizerTaskSettingName of Dynamsoft Label Recognizer defines the name of the inherited LabelRecognizerTaskSetting object.
+description: The parameter BaseLabelRecognizerTaskSettingName defines the name of the inherited LabelRecognizerTaskSetting object.
keywords: inheritance, LabelRecognizerTaskSetting
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# BaseLabelRecognizerTaskSettingName
-Parameter `BaseLabelRecognizerTaskSettingName` 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.
+`BaseLabelRecognizerTaskSettingName` 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.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── BaseLabelRecognizerTaskSettingName
+```
+
+**Parent object:** [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html)
+
+**Example:**
```json
{
@@ -20,7 +27,14 @@ Parameter `BaseLabelRecognizerTaskSettingName` represents the name of another `L
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `BaseLabelRecognizerTaskSettingName` parameter.
+> - To use it, embed this parameter within a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
| BaseLabelRecognizerTaskSettingName Parameter Details |
| :----------------------------------- |
diff --git a/parameters/reference/label-recognizer-task-settings/cluster-samples-count-threshold.md b/parameters/reference/label-recognizer-task-settings/cluster-samples-count-threshold.md
index fec57d3..b6b7df2 100644
--- a/parameters/reference/label-recognizer-task-settings/cluster-samples-count-threshold.md
+++ b/parameters/reference/label-recognizer-task-settings/cluster-samples-count-threshold.md
@@ -3,16 +3,26 @@ layout: default-layout
title: ClusterSamplesCountThreshold - Dynamsoft Label Recognizer Parameters
description: The parameter ClusterSamplesCountThreshold of Dynamsoft Label Recognizer defines the threshold for successful character clustering.
keywords: confusable character clustering
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# ClusterSamplesCountThreshold
The parameter `ClusterSamplesCountThreshold` defines the threshold for successful character clustering. It defines the minimum number of samples in a single cluster. If every character in a group of confusable characters has been successfully clustered, the group will stop clustering. For example, [0,O,o] is a typical group of confusing characters.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+ └── ClusterSamplesCountThreshold
+```
+
+**Parent object:** [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html)
+
+**Example:**
```json
{
@@ -20,9 +30,16 @@ The parameter `ClusterSamplesCountThreshold` defines the threshold for successfu
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `ClusterSamplesCountThreshold` parameter.
+> - To use it, embed this parameter within a [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| ClusterSamplesCountThreshold Parameter Summary |
+| ClusterSamplesCountThreshold Parameter Details |
| :----------------------------------- |
| **Type**
*int* |
| **Range**
[0, 0x7FFFFFFF].|
diff --git a/parameters/reference/label-recognizer-task-settings/confusable-characters-path.md b/parameters/reference/label-recognizer-task-settings/confusable-characters-path.md
index 8115898..7d5dd40 100644
--- a/parameters/reference/label-recognizer-task-settings/confusable-characters-path.md
+++ b/parameters/reference/label-recognizer-task-settings/confusable-characters-path.md
@@ -3,26 +3,43 @@ layout: default-layout
title: ConfusableCharactersPath - Dynamsoft Label Recognizer Parameters
description: The parameter ConfusableCharactersPath of Dynamsoft Label Recognizer defines the path to the .data file containing standard characters features for confusable characters telling.
keywords: confusable characters path
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# ConfusableCharactersPath
The parameter `ConfusableCharactersPath` sets the path to the .data file containing characters features for confusable characters telling.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+ └── ConfusableCharactersPath
+```
+
+**Parent object:** [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html)
+
+**Example:**
```json
{
- "ConfusableCharactersPath" : "D:\\YourApp\\ConfusableChars.data"
+ "ConfusableCharactersPath": "D:\\YourApp\\ConfusableChars.data"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `ConfusableCharactersPath` parameter.
+> - To use it, embed this parameter within a [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| ConfusableCharactersPath Parameter Summary |
+| ConfusableCharactersPath Parameter Details |
| :----------------------------------- |
| **Type**
*String* |
| **Range**
The absolute file path or the path relative to the Dynamsoft Label Recognizer library.|
diff --git a/parameters/reference/label-recognizer-task-settings/dictionary-correction-thresholds.md b/parameters/reference/label-recognizer-task-settings/dictionary-correction-thresholds.md
index f7abe54..fcb0b28 100644
--- a/parameters/reference/label-recognizer-task-settings/dictionary-correction-thresholds.md
+++ b/parameters/reference/label-recognizer-task-settings/dictionary-correction-thresholds.md
@@ -3,16 +3,26 @@ layout: default-layout
title: DictionaryCorrectionThresholds - Dynamsoft Label Recognizer Parameters
description: The parameter DictionaryCorrectionThresholds of Dynamsoft Label Recognizer defines the threshold of dictionary error correction.
keywords: user dictionary, text correction
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# DictionaryCorrectionThresholds
Parameter `DictionaryCorrectionThresholds` sets the threshold of dictionary error correction.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+ └── DictionaryCorrectionThresholds
+```
+
+**Parent object:** [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html)
+
+**Example:**
```json
{
@@ -32,16 +42,22 @@ Parameter `DictionaryCorrectionThresholds` sets the threshold of dictionary erro
"Threshold": 3
}
]
-
}
```
+> [!NOTE]
+> - This snippet shows only the `DictionaryCorrectionThresholds` parameter.
+> - To use it, embed this parameter within a [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
**Remarks**
- It supports segmentation threshold.
- It works together with the [DictionaryPath](dictionary-path.md) parameter to perform error correction during the recognition process.
-## Parameter Summary
+## Parameter Details
Parameter `DictionaryCorrectionThresholds` consist of a group of dictionary correction threshold objects. Each threshold object includes a series of child parameters.
diff --git a/parameters/reference/label-recognizer-task-settings/dictionary-path.md b/parameters/reference/label-recognizer-task-settings/dictionary-path.md
index 0ffc233..cd85415 100644
--- a/parameters/reference/label-recognizer-task-settings/dictionary-path.md
+++ b/parameters/reference/label-recognizer-task-settings/dictionary-path.md
@@ -3,26 +3,43 @@ layout: default-layout
title: DictionaryPath - Dynamsoft Label Recognizer Parameters
description: The parameter DictionaryPath of Dynamsoft Label Recognizer defines the path of the dictionary file
keywords: user dictionary, text correction
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# DictionaryPath
Parameter `DictionaryPath` sets the path of the dictionary file.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+ └── DictionaryPath
+```
+
+**Parent object:** [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html)
+
+**Example:**
```json
{
- "DictionaryPath" : "D:\\DictModel\\nutrition.txt"
+ "DictionaryPath": "D:\\DictModel\\nutrition.txt"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `DictionaryPath` parameter.
+> - To use it, embed this parameter within a [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| DictionaryPath Parameter Summary |
+| DictionaryPath Parameter Details |
| :----------------------------------- |
| **Type**
*String* |
| **Range**
The absolute file path.|
diff --git a/parameters/reference/label-recognizer-task-settings/enable-regex-force-correction.md b/parameters/reference/label-recognizer-task-settings/enable-regex-force-correction.md
index e2c76a8..ece1c84 100644
--- a/parameters/reference/label-recognizer-task-settings/enable-regex-force-correction.md
+++ b/parameters/reference/label-recognizer-task-settings/enable-regex-force-correction.md
@@ -3,26 +3,43 @@ layout: default-layout
title: EnableRegexForceCorrection - Dynamsoft Label Recognizer Parameters
description: The parameter EnableRegexForceCorrection of Dynamsoft Label Recognizer defines the regular expression pattern for concatenated strings of recognized text lines.
keywords: text lines, concatenated strings, regular expression
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# EnableRegexForceCorrection
Parameter `EnableRegexForceCorrection` specifies whether to enable forced correction based on the regular expression pattern.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+ └── EnableRegexForceCorrection
+```
+
+**Parent object:** [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html)
+
+**Example:**
```json
{
- "EnableRegexForceCorrection" : 1
+ "EnableRegexForceCorrection": 1
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `EnableRegexForceCorrection` parameter.
+> - To use it, embed this parameter within a [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| EnableRegexForceCorrection Parameter Summary |
+| EnableRegexForceCorrection Parameter Details |
| :----------------------------------- |
| **Type**
*int* |
| **Range**
0, 1|
diff --git a/parameters/reference/label-recognizer-task-settings/localization-modes.md b/parameters/reference/label-recognizer-task-settings/localization-modes.md
index 3f2c4f3..7558c01 100644
--- a/parameters/reference/label-recognizer-task-settings/localization-modes.md
+++ b/parameters/reference/label-recognizer-task-settings/localization-modes.md
@@ -3,35 +3,52 @@ layout: default-layout
title: LocalizationModes - Dynamsoft Label Recognizer Parameters
description: The parameter LocalizationModes of Dynamsoft Label Recognizer defines how to localize text lines.
keywords: Localization modes
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
---
# LocalizationModes
-Determines how to localize barcodes. It consists of one or more modes, each mode representing a different localization process.
+Determines how to localize text lines. It consists of one or more modes, each mode representing a different localization process.
**Remarks**
- Introduced in Dynamsoft Capture Vision version 3.2.1000.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_LOCALIZE_TEXT_LINES")
+ └── LocalizationModes
+```
+
+**Parent object:** [LocalizeTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-localize-text-lines.html)
+
+**Example:**
```json
-"LocalizationModes" :
+"LocalizationModes":
[
{
- "Mode" : "LM_NEURAL_NETWORK",
+ "Mode": "LM_NEURAL_NETWORK",
"ModelNameArray": ["MRZLocalization"]
},
{
- "Mode" : "LM_GENERAL"
+ "Mode": "LM_GENERAL"
}
]
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `LocalizationModes` parameter.
+> - To use it, embed this parameter within a [LocalizeTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-localize-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
Parameter `LocalizationModes` consist of a group of localization mode objects. Each localization mode object includes a candidate mode and a series of auxiliary mode arguments. The structure of the localization mode object is shown as follow:
@@ -92,10 +109,10 @@ If the `LocalizationModes` is not configured in your template file, the followin
```json
{
- "LocalizationModes" :
+ "LocalizationModes":
[
{
- "Mode" : "LM_GENERAL"
+ "Mode": "LM_GENERAL"
}
]
}
diff --git a/parameters/reference/label-recognizer-task-settings/max-threads-in-one-task.md b/parameters/reference/label-recognizer-task-settings/max-threads-in-one-task.md
index e34405a..331a37a 100644
--- a/parameters/reference/label-recognizer-task-settings/max-threads-in-one-task.md
+++ b/parameters/reference/label-recognizer-task-settings/max-threads-in-one-task.md
@@ -3,26 +3,40 @@ layout: default-layout
title: MaxThreadsInOneTask - Dynamsoft Label Recognizer Parameters
description: The parameter MaxThreadsInOneTask defines the maximum threads that can be consumed in one label recognition task.
keywords: Max threads
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# MaxThreadsInOneTask
-Parameter `MaxThreadsInOneTask` defines the maximum threads that can be consumed in one task.
+`MaxThreadsInOneTask` defines the maximum threads that can be consumed in one task.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── MaxThreadsInOneTask
+```
+
+**Parent object:** [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html)
+
+**Example:**
```json
{
- "MaxThreadsInOneTask":4
+ "MaxThreadsInOneTask": 4
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `MaxThreadsInOneTask` parameter.
+> - To use it, embed this parameter within a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| MaxThreadsInOneTask Parameter Summary |
+| MaxThreadsInOneTask Parameter Details |
| :------------- |
| **Type**
*int* |
| **Range**
[0, 256] |
diff --git a/parameters/reference/label-recognizer-task-settings/name.md b/parameters/reference/label-recognizer-task-settings/name.md
index 1b947eb..6bbc990 100644
--- a/parameters/reference/label-recognizer-task-settings/name.md
+++ b/parameters/reference/label-recognizer-task-settings/name.md
@@ -1,26 +1,40 @@
---
layout: default-layout
-title: LabelRecognizerTaskSetting Name - Dynamsoft Label Recognizer Parameter.
+title: Name - Dynamsoft Label Recognizer LabelRecognizerTaskSetting Parameters
description: The parameter Name defines the unique identifier of a LabelRecognizerTaskSetting object.
keywords: top-level object, name, unique identifier
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# Name
-Parameter `Name` represents the name of a `LabelRecognizerTaskSetting` object, which serves as its unique identifier.
+`Name` represents the name of a `LabelRecognizerTaskSetting` object, which serves as its unique identifier.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── Name
+```
+
+**Parent object:** [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html)
+
+**Example:**
```json
{
- "Name" : "lr_0"
+ "Name": "lr_0"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Name` parameter.
+> - To use it, embed this parameter within a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
| Parameter Details |
| :----------------------------------- |
diff --git a/parameters/reference/label-recognizer-task-settings/overlapping-characters-path.md b/parameters/reference/label-recognizer-task-settings/overlapping-characters-path.md
index 29f1dea..0a7d318 100644
--- a/parameters/reference/label-recognizer-task-settings/overlapping-characters-path.md
+++ b/parameters/reference/label-recognizer-task-settings/overlapping-characters-path.md
@@ -3,26 +3,43 @@ layout: default-layout
title: OverlappingCharactersPath - Dynamsoft Label Recognizer Parameters
description: The parameter OverlappingCharactersPath of Dynamsoft Label Recognizer defines the path to the .data file containing characters features for overlapping matching.
keywords: characters overlapping matching
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# OverlappingCharactersPath
The parameter `OverlappingCharactersPath` sets the path to the .data file containing characters features for overlapping matching.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+ └── OverlappingCharactersPath
+```
+
+**Parent object:** [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html)
+
+**Example:**
```json
{
- "OverlappingCharactersPath" : "D:\\YourApp\\OverlappingChars.data"
+ "OverlappingCharactersPath": "D:\\YourApp\\OverlappingChars.data"
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `OverlappingCharactersPath` parameter.
+> - To use it, embed this parameter within a [RecognizeRawTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| OverlappingCharactersPath Parameter Summary |
+| OverlappingCharactersPath Parameter Details |
| :----------------------------------- |
| **Type**
*String* |
| **Range**
The absolute file path or the path relative to the Dynamsoft Label Recognizer library.|
diff --git a/parameters/reference/label-recognizer-task-settings/section-array.md b/parameters/reference/label-recognizer-task-settings/section-array.md
index f4ae378..453eea5 100644
--- a/parameters/reference/label-recognizer-task-settings/section-array.md
+++ b/parameters/reference/label-recognizer-task-settings/section-array.md
@@ -3,40 +3,54 @@ layout: default-layout
title: SectionArray - Dynamsoft Label Recognizer Parameters
description: The parameter SectionArray defines which sections exist under the LabelRecognizerTask.
keywords: Section Array parameter
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# SectionArray
-`SectionArray` is a parameter that defines which sections exist under the `LabelRecognizerTask`. A `Section` is a sequence of Stages that form a relatively complete processing unit, producing milestone results that include location information along with other details.
+Parameter `SectionArray` defines which sections exist under the `LabelRecognizerTask`. A `Section` is a sequence of `Stages` that form a relatively complete processing unit, producing milestone results that include location information along with other details.
-The `LabelRecognizerTask` includes the following sections:
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray
+```
+
+**Parent object:** [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html) object
-* [ST_REGION_PREDETECTION](section-regions-predetection.md)
- * It is designed to find regions of interest (ROIs) and thus ignoring other parts of the image during subsequent processing.
-* [ST_TEXT_LINE_LOCALIZATION](section-text-lines-localization.md)
- * It is designed to detect the exact locations of text-lines.
-* [ST_TEXT_LINE_RECOGNITION](section-text-lines-recognition.md)
- * It is designed to recognize the text from the text-line areas identified in the previous section [ST_TEXT_LINE_LOCALIZATION](text-line-localization-section.md)
+**Example:**
```json
{
- "SectionArray":
- [
+ "SectionArray": [
{
- "Section": "ST_REGION_PREDETECTION",
- // Other parameters...
+ "Section": "ST_REGION_PREDETECTION"
},
{
- "Section": "ST_TEXT_LINE_LOCALIZATION",
- // Other parameters...
+ "Section": "ST_TEXT_LINE_LOCALIZATION"
},
{
- "Section": "ST_TEXT_LINE_RECOGNITION",
- // Other parameters...
+ "Section": "ST_TEXT_LINE_RECOGNITION"
}
]
}
```
+
+> [!NOTE]
+> - This snippet shows only the `SectionArray` parameter.
+> - To use it, embed this parameter within a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+The `LabelRecognizerTask` includes the following sections:
+
+* [RegionPredetectionSection](section-regions-predetection.md) (`ST_REGION_PREDETECTION`)
+ * Designed to find regions of interest (ROIs) and thus ignore other parts of the image during subsequent processing.
+* [TextLineLocalizationSection](section-text-lines-localization.md) (`ST_TEXT_LINE_LOCALIZATION`)
+ * Designed to detect the exact locations of text-lines.
+* [TextLineRecognitionSection](section-text-lines-recognition.md) (`ST_TEXT_LINE_RECOGNITION`)
+ * Designed to recognize the text from the text-line areas identified in the previous `TextLineLocalizationSection` section.
diff --git a/parameters/reference/label-recognizer-task-settings/section-image-parameter-array.md b/parameters/reference/label-recognizer-task-settings/section-image-parameter-array.md
deleted file mode 100644
index 1bf764d..0000000
--- a/parameters/reference/label-recognizer-task-settings/section-image-parameter-array.md
+++ /dev/null
@@ -1,73 +0,0 @@
----
-layout: default-layout
-title: SectionImageParameterArray - Dynamsoft Label Recognizer Parameters
-description: The parameter SectionImageParameterArray defines the image processing algorithms that implemented in the different sections of a label recognition algorithm task.
-keywords: Section image parameter
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
----
-
-# SectionImageParameterArray
-
-`SectionImageParameterArray` is a parameter that defines `ImageParameter` in section unit. Each `SectionImageParameterArray` element is a group of a section name and a `ImageParameter` name so that this section will use the ImageParameter you specified. If a section is not specified in the array, it will use the default `ImageParameter` configuration.
-
-The `LabelRecognizerTask` includes the following sections:
-
-* `ST_REGION_PREDETECTION`
-* `ST_TEXT_LINE_LOCALIZATION`
-* `ST_TEXT_LINE_RECOGNITION`
-
-## Example
-
-```json
-{
- "SectionImageParameterArray":
- [
- {
- "Section": "ST_REGION_PREDETECTION",
- "ImageParameterName": "IP_0"
- },
- {
- "Section": "ST_TEXT_LINE_LOCALIZATION",
- "ImageParameterName": "IP_1"
- },
- {
- "Section": "ST_TEXT_LINE_RECOGNITION",
- "ImageParameterName": "IP_1"
- }
- ]
-}
-```
-
-## Parameter Summary
-
-
-
-
- | Child Parameter Name |
- Child Parameter Summary |
-
-
-
- Section
|
- Description
Specifies an algorithm section. |
-
-
- Type
String |
-
-
- Range
One of the following SectionType as a string.
-
ST_REGION_PREDETECTION
-
ST_TEXT_LINE_LOCALIZATION
-
ST_TEXT_LINE_RECOGNITION
- |
-
-
- ImageParameterName
|
- Description
Specifies the ImageParameter that you want to implement in this section. It must be one of the name that defined under ImageParameterOptions. |
-
-
- Type
String |
-
-
diff --git a/parameters/reference/label-recognizer-task-settings/section-regions-predetection.md b/parameters/reference/label-recognizer-task-settings/section-regions-predetection.md
index 5690ea8..4aaf8e5 100644
--- a/parameters/reference/label-recognizer-task-settings/section-regions-predetection.md
+++ b/parameters/reference/label-recognizer-task-settings/section-regions-predetection.md
@@ -1,44 +1,71 @@
---
layout: default-layout
-title: RegionsPredetectionSection - Dynamsoft Label Recognizer Parameters
-description: The parameter defines regions predtection section under the Section Array.
-keywords: Regions Predetection Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: RegionPredetectionSection - Dynamsoft Label Recognizer Parameters
+description: The RegionPredetectionSection identifies regions of interest (ROIs) for subsequent processing.
+keywords: RegionPredetectionSection
---
-# RegionsPredetectionSection Object
+# RegionPredetectionSection
-The `RegionsPredetectionSection` is designed to identify regions of interest (ROIs), allowing subsequent processing to ignore other parts of the image. The pre-detected region may be identified based on color features, grayscale features, or neural network localization.
+`RegionPredetectionSection` identifies regions of interest (ROIs), allowing subsequent processing to ignore other parts of the image. In JSON, it is represented as a Section object with `"Section": "ST_REGION_PREDETECTION"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_REGION_PREDETECTION")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_REGION_PREDETECTION",
"ImageParameterName": "ip_dlrDefault",
- "StageArray": []
+ "StageArray": [
+ {
+ "Stage": "SST_PREDETECT_REGIONS"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for region predetection.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-array.html) of a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_REGION_PREDETECTION`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_REGION_PREDETECTION`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_dlrDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_REGION_PREDETECTION"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `RegionsPredetectionSection`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `RegionsPredetectionSection` consists of a single stage:
+Specifies the stage objects within this section. The `RegionPredetectionSection` consists of the following stages:
-* [SST_PREDETECT_REGIONS](stage-predetect-regions.md)
- * It is designed at the stage level to identify regions of interest (ROIs).
+| Stage | Description |
+|-------|-------------|
+| [PredetectRegionsStage](stage-predetect-regions.md) (`SST_PREDETECT_REGIONS`) | Identifies regions of interest (ROIs). |
diff --git a/parameters/reference/label-recognizer-task-settings/section-text-lines-localization.md b/parameters/reference/label-recognizer-task-settings/section-text-lines-localization.md
index 4962450..eec40ca 100644
--- a/parameters/reference/label-recognizer-task-settings/section-text-lines-localization.md
+++ b/parameters/reference/label-recognizer-task-settings/section-text-lines-localization.md
@@ -1,44 +1,71 @@
---
layout: default-layout
-title: TextLinesLocalizationSection - Dynamsoft Label Recognizer Parameters
-description: The parameter defines text lines localization section under the Section Array.
-keywords: Text Lines Localization Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: TextLineLocalizationSection - Dynamsoft Label Recognizer Parameters
+description: The TextLineLocalizationSection detects the exact locations of text-lines.
+keywords: TextLineLocalizationSection
---
-# TextLinesLocalizationSection Object
+# TextLineLocalizationSection
-The `TextLinesLocalizationSection` is designed to detect the exact locations of text-lines.
+`TextLineLocalizationSection` detects the exact locations of text-lines. In JSON, it is represented as a Section object with `"Section": "ST_TEXT_LINE_LOCALIZATION"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_TEXT_LINE_LOCALIZATION")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_TEXT_LINE_LOCALIZATION",
"ImageParameterName": "ip_dlrDefault",
- "StageArray": []
+ "StageArray": [
+ {
+ "Stage": "SST_LOCALIZE_TEXT_LINES"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for text line localization.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-array.html) of a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_TEXT_LINE_LOCALIZATION`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_TEXT_LINE_LOCALIZATION`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_dlrDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_TEXT_LINE_LOCALIZATION"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `TextLinesLocalizationSection`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `TextLinesLocalizationSection` consists of a single stage:
+Specifies the stage objects within this section. The `TextLineLocalizationSection` consists of the following stages:
-* [SST_LOCALIZE_TEXT_LINES](stage-localize-text-lines.md)
- * It is designed at the stage level to detect the exact locations of text-lines.
+| Stage | Description |
+|-------|-------------|
+| [LocalizeTextLinesStage](stage-localize-text-lines.md) (`SST_LOCALIZE_TEXT_LINES`) | Detects the exact locations of text-lines. |
diff --git a/parameters/reference/label-recognizer-task-settings/section-text-lines-recognition.md b/parameters/reference/label-recognizer-task-settings/section-text-lines-recognition.md
index f154e2d..71a1867 100644
--- a/parameters/reference/label-recognizer-task-settings/section-text-lines-recognition.md
+++ b/parameters/reference/label-recognizer-task-settings/section-text-lines-recognition.md
@@ -1,46 +1,75 @@
---
layout: default-layout
-title: TextLinesRecognitionSection - Dynamsoft Label Recognizer Parameters
-description: The parameter defines text lines recognition section under the Section Array.
-keywords: Text Lines Recognition Section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
+title: TextLineRecognitionSection - Dynamsoft Label Recognizer Parameters
+description: The TextLineRecognitionSection recognizes text from localized text-line regions.
+keywords: TextLineRecognitionSection
---
-# TextLinesRecognitionSection Object
+# TextLineRecognitionSection
-The `TextLinesRecognitionSection` is designed to detect the exact locations of text-lines.
+`TextLineRecognitionSection` recognizes text from localized text-line regions. In JSON, it is represented as a Section object with `"Section": "ST_TEXT_LINE_RECOGNITION"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object where Section = "ST_TEXT_LINE_RECOGNITION")
+```
+
+**Parent object:** [SectionArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-array.html)
+
+**Example:**
```json
{
"Section": "ST_TEXT_LINE_RECOGNITION",
"ImageParameterName": "ip_dlrDefault",
- "StageArray": []
+ "StageArray": [
+ {
+ "Stage": "SST_RECOGNIZE_RAW_TEXT_LINES"
+ },
+ {
+ "Stage": "SST_ASSEMBLE_TEXT_LINES"
+ }
+ ]
}
```
-## Section
+> [!NOTE]
+> - This snippet shows a Section object configured for text line recognition.
+> - To use it, add this object to the [SectionArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-array.html) of a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The section is named `ST_TEXT_LINE_RECOGNITION`.
+## Parameters
-## ImageParameterName
+### Section
-Specifies the `ImageParameter` to apply in the stages of this section.
+Specifies the section type. Fixed value: `ST_TEXT_LINE_RECOGNITION`.
-| Parameter Summary |
+| Parameter Details |
| :------------- |
| **Type**
*string* |
-| **Range**
*It must be one of the name that defined under `ImageParameterOptions`* |
-| **Default Value**
*ip_dlrDefault* |
+| **Required**
Yes |
+| **Default Value**
`"ST_TEXT_LINE_RECOGNITION"` |
+
+### ImageParameterName
+
+Specifies the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object to apply in the stages of this section.
-## StageArray
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Range**
Must be the name of an [ImageParameter]({{ site.dcvb_parameters }}file/image-parameter.html) object defined under `ImageParameterOptions` |
+| **Default Value**
`""` |
-`StageArray` is a parameter that specifies the stages within the `TextLinesRecognitionSection`. A `Stage` is the smallest step significant enough to involve users in image processing.
+### StageArray
-The `TextLinesRecognitionSection` consists of two stages:
+Specifies the stage objects within this section. The `TextLineRecognitionSection` consists of the following stages:
-* [SST_RECOGNIZE_RAW_TEXT_LINES](stage-recognize-raw-text-lines.md)
- * It is designed at the stage level to recognize the raw values of text-lines.
-* [SST_ASSEMBLE_TEXT_LINES](stage-assemble-text-lines.md)
- * It is designed at the stage level to assemble the grouped text-lines into a single text-line.
+| Stage | Description |
+|-------|-------------|
+| [RecognizeRawTextLinesStage](stage-recognize-raw-text-lines.md) (`SST_RECOGNIZE_RAW_TEXT_LINES`) | Recognizes the raw values of text-lines. |
+| [AssembleTextLinesStage](stage-assemble-text-lines.md) (`SST_ASSEMBLE_TEXT_LINES`) | Assembles grouped text-lines into a single text-line. |
diff --git a/parameters/reference/label-recognizer-task-settings/stage-assemble-text-lines.md b/parameters/reference/label-recognizer-task-settings/stage-assemble-text-lines.md
index 33c9e09..f493933 100644
--- a/parameters/reference/label-recognizer-task-settings/stage-assemble-text-lines.md
+++ b/parameters/reference/label-recognizer-task-settings/stage-assemble-text-lines.md
@@ -1,36 +1,58 @@
---
layout: default-layout
title: AssembleTextLinesStage - Dynamsoft Label Recognizer Parameters
-description: The parameter defines Assemble Text Lines Stage under the Text Line Recognition Section.
+description: The AssembleTextLinesStage assembles the grouped text lines into a single text line.
keywords: Assemble Text Lines Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# AssembleTextLinesStage Object
+# AssembleTextLinesStage
-The `AssembleTextLinesStage` is designed at the stage level to assemble the grouped text-lines into a single text-line.
+`AssembleTextLinesStage` assembles the grouped text lines into a single text line. In JSON, it is represented as a Stage object with `"Stage": "SST_ASSEMBLE_TEXT_LINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_ASSEMBLE_TEXT_LINES")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-recognition.html#stagearray) within [TextLinesRecognitionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-recognition.html)
+
+**Example:**
```json
{
"Stage": "SST_ASSEMBLE_TEXT_LINES",
- "StringLengthRange": [
- 3,
- 200
- ],
+ "StringLengthRange": [3, 200],
"StringRegExPattern": ""
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for assembling text lines.
+> - To use it, add this object to the `StageArray` within a [TextLinesRecognitionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-recognition.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_ASSEMBLE_TEXT_LINES`.
-The stage is named `SST_ASSEMBLE_TEXT_LINES`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_ASSEMBLE_TEXT_LINES"` |
-## StringLengthRange
+### StringLengthRange
-Parameter [`StringLengthRange`](string-length-range.md) sets the range of string lengths for concatenated strings of recognized text lines.
+Sets the range of string lengths for concatenated strings of recognized text lines. See [`StringLengthRange`](string-length-range.md) for details.
-## StringRegExPattern
+### StringRegExPattern
-Parameter [`StringRegExPattern`](string-regex-pattern.md) specifies the regular expression pattern for concatenated strings of recognized text lines.
+Specifies the regular expression pattern for concatenated strings of recognized text lines. See [`StringRegExPattern`](string-regex-pattern.md) for details.
diff --git a/parameters/reference/label-recognizer-task-settings/stage-localize-text-lines.md b/parameters/reference/label-recognizer-task-settings/stage-localize-text-lines.md
index db72b24..ad7685a 100644
--- a/parameters/reference/label-recognizer-task-settings/stage-localize-text-lines.md
+++ b/parameters/reference/label-recognizer-task-settings/stage-localize-text-lines.md
@@ -1,16 +1,26 @@
---
layout: default-layout
title: LocalizeTextLinesStage - Dynamsoft Label Recognizer Parameters
-description: The parameter defines Localize Text Lines Stage under the Text Lines Localization Section.
+description: The LocalizeTextLinesStage detects the exact locations of text lines.
keywords: Localize Text Lines Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# LocalizeTextLinesStage Object
+# LocalizeTextLinesStage
-The `LocalizeTextLinesStage` is designed at the stage level to detect the exact locations of text-lines.
+`LocalizeTextLinesStage` detects the exact locations of text lines. In JSON, it is represented as a Stage object with `"Stage": "SST_LOCALIZE_TEXT_LINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_LOCALIZE_TEXT_LINES")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-localization.html#stagearray) within [TextLinesLocalizationSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-localization.html)
+
+**Example:**
```json
{
@@ -18,6 +28,21 @@ The `LocalizeTextLinesStage` is designed at the stage level to detect the exact
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for localizing text lines.
+> - To use it, add this object to the `StageArray` within a [TextLinesLocalizationSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-localization.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_LOCALIZE_TEXT_LINES`.
-The stage is named `SST_LOCALIZE_TEXT_LINES`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_LOCALIZE_TEXT_LINES"` |
diff --git a/parameters/reference/label-recognizer-task-settings/stage-predetect-regions.md b/parameters/reference/label-recognizer-task-settings/stage-predetect-regions.md
index 2c2687c..38dccef 100644
--- a/parameters/reference/label-recognizer-task-settings/stage-predetect-regions.md
+++ b/parameters/reference/label-recognizer-task-settings/stage-predetect-regions.md
@@ -1,28 +1,57 @@
---
layout: default-layout
title: PredetectRegionsStage - Dynamsoft Label Recognizer Parameters
-description: The parameter defines Predetect Regions Stage under the Regions Predetection Section.
+description: The PredetectRegionsStage identifies regions of interest (ROIs).
keywords: Predetect Regions Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# PredetectRegionsStage Object
+# PredetectRegionsStage
-The `PredetectRegionsStage` is designed at the stage level to identify regions of interest (ROIs). The pre-detected region may be identified based on color features, grayscale features, or neural network localization.
+`PredetectRegionsStage` identifies regions of interest (ROIs). The pre-detected region may be identified based on color features, grayscale features, or neural network localization. In JSON, it is represented as a Stage object with `"Stage": "SST_PREDETECT_REGIONS"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_PREDETECT_REGIONS")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-regions-predetection.html#stagearray) within [RegionsPredetectionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-regions-predetection.html)
+
+**Example:**
```json
{
"Stage": "SST_PREDETECT_REGIONS",
- "RegionPredetectionModes": []
+ "RegionPredetectionModes": [
+ {
+ "Mode": "RPM_GENERAL"
+ }
+ ]
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for region predetection.
+> - To use it, add this object to the `StageArray` within a [RegionsPredetectionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-regions-predetection.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_PREDETECT_REGIONS`.
-The stage is named `SST_PREDETECT_REGIONS`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_PREDETECT_REGIONS"` |
-## RegionPredetectionModes
+### RegionPredetectionModes
-Parameter [`RegionPredetectionModes`](../image-parameter/region-predetection-modes.md) controls how to find a region of interest (ROI) within the image or frame.
+Controls how to find a region of interest (ROI) within the image or frame. See [`RegionPredetectionModes`]({{ site.dcvb_parameters_reference }}image-parameter/region-predetection-modes.html) for details.
diff --git a/parameters/reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.md b/parameters/reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.md
index 7cd4fa5..9d2ffd0 100644
--- a/parameters/reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.md
+++ b/parameters/reference/label-recognizer-task-settings/stage-recognize-raw-text-lines.md
@@ -1,16 +1,26 @@
---
layout: default-layout
title: RecognizeRawTextLinesStage - Dynamsoft Label Recognizer Parameters
-description: The parameter defines Recognize Raw Text Lines Stage under the Text Line Recognition Section.
+description: The RecognizeRawTextLinesStage recognizes the raw values of text lines.
keywords: Recognize Raw Text Lines Stage
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
-# RecognizeRawTextLinesStage Object
+# RecognizeRawTextLinesStage
-The `RecognizeRawTextLinesStage` is designed at the stage level to recognize the raw values of text-lines.
+`RecognizeRawTextLinesStage` recognizes the raw values of text lines. In JSON, it is represented as a Stage object with `"Stage": "SST_RECOGNIZE_RAW_TEXT_LINES"`.
+
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_RECOGNIZE_RAW_TEXT_LINES")
+```
+
+**Parent object:** [StageArray]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-recognition.html#stagearray) within [TextLinesRecognitionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-recognition.html)
+
+**Example:**
```json
{
@@ -25,35 +35,50 @@ The `RecognizeRawTextLinesStage` is designed at the stage level to recognize the
],
"ConfusableCharactersPath": "",
"ClusterSamplesCountThreshold": 0,
- "OverlappingCharactersPath": "OverlappingChars.data",
+ "OverlappingCharactersPath": "OverlappingChars.data",
"EnableRegexForceCorrection": 1
}
```
-## Stage
+> [!NOTE]
+> - This snippet shows a Stage object configured for recognizing raw text lines.
+> - To use it, add this object to the `StageArray` within a [TextLinesRecognitionSection]({{ site.dcvb_parameters_reference }}label-recognizer-task-settings/section-text-lines-recognition.html).
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameters
+
+### Stage
+
+Specifies the stage type. Fixed value: `SST_RECOGNIZE_RAW_TEXT_LINES`.
-The stage is named `SST_RECOGNIZE_RAW_TEXT_LINES`.
+| Parameter Details |
+| :------------- |
+| **Type**
*string* |
+| **Required**
Yes |
+| **Default Value**
`"SST_RECOGNIZE_RAW_TEXT_LINES"` |
-## DictionaryPath
+### DictionaryPath
-Parameter [`DictionaryPath`](dictionary-path.md) sets the path of the dictionary file.
+Sets the path of the dictionary file. See [`DictionaryPath`](dictionary-path.md) for details.
-## DictionaryCorrectionThresholds
+### DictionaryCorrectionThresholds
-Parameter [`DictionaryCorrectionThresholds`](dictionary-correction-thresholds.md) sets the threshold of dictionary error correction.
+Sets the threshold of dictionary error correction. See [`DictionaryCorrectionThresholds`](dictionary-correction-thresholds.md) for details.
-## ConfusableCharactersPath
+### ConfusableCharactersPath
-Parameter [`ConfusableCharactersPath`](confusable-characters-path.md) sets the path to the .data file containing characters features for confusable characters telling.
+Sets the path to the .data file containing characters features for confusable characters telling. See [`ConfusableCharactersPath`](confusable-characters-path.md) for details.
-## ClusterSamplesCountThreshold
+### ClusterSamplesCountThreshold
-Parameter [`ClusterSamplesCountThreshold`](cluster-samples-count-threshold.md) sets the threshold of cluster samples count.
+Sets the threshold of cluster samples count. See [`ClusterSamplesCountThreshold`](cluster-samples-count-threshold.md) for details.
-## OverlappingCharactersPath
+### OverlappingCharactersPath
-Parameter [`OverlappingCharactersPath`](overlapping-characters-path.md) sets the path to the .data file containing characters features for overlapping matching.
+Sets the path to the .data file containing characters features for overlapping matching. See [`OverlappingCharactersPath`](overlapping-characters-path.md) for details.
-## EnableRegexForceCorrection
+### EnableRegexForceCorrection
-Parameter [`EnableRegexForceCorrection`](enable-regex-force-correction.md) sets whether to enable forced correction based on the RegexPattern.
+Sets whether to enable forced correction based on the RegexPattern. See [`EnableRegexForceCorrection`](enable-regex-force-correction.md) for details.
diff --git a/parameters/reference/label-recognizer-task-settings/start-section.md b/parameters/reference/label-recognizer-task-settings/start-section.md
deleted file mode 100644
index 5f27be8..0000000
--- a/parameters/reference/label-recognizer-task-settings/start-section.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-layout: default-layout
-title: StartSection - Dynamsoft Label Recognizer Parameters
-description: The parameter StartSection defines the start section of the label recognition algorithm task.
-keywords: Start section
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
----
-
-# StartSection
-
-Parameter `StartSection` defines the start section of the `LabelRecognizerTask`.
-
-## Example
-
-```json
-{
- "StartSection": "ST_REGION_PREDETECTION"
-}
-```
-
-## Parameter Summary
-
-| StartSection Parameter Summary |
-| :---------------------------- |
-| **Type**
*String* |
-| **Range**
ST_REGION_PREDETECTION
ST_TEXT_LINE_LOCALIZATION |
-| **Default Value**
ST_REGION_PREDETECTION |
diff --git a/parameters/reference/label-recognizer-task-settings/string-length-range.md b/parameters/reference/label-recognizer-task-settings/string-length-range.md
index d482a57..5c63a04 100644
--- a/parameters/reference/label-recognizer-task-settings/string-length-range.md
+++ b/parameters/reference/label-recognizer-task-settings/string-length-range.md
@@ -3,26 +3,43 @@ layout: default-layout
title: StringLengthRange - Dynamsoft Label Recognizer Parameters
description: The parameter StringLengthRange of Dynamsoft Label Recognizer defines the range of string lengths for concatenated strings of recognized text lines.
keywords: text lines, concatenated strings length
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# StringLengthRange
Parameter `StringLengthRange` sets the range of string lengths for concatenated strings of recognized text lines.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_ASSEMBLE_TEXT_LINES")
+ └── StringLengthRange
+```
+
+**Parent object:** [AssembleTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-assemble-text-lines.html)
+
+**Example:**
```json
{
- "StringLengthRange" : [3,200]
+ "StringLengthRange": [3,200]
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `StringLengthRange` parameter.
+> - To use it, embed this parameter within a [AssembleTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-assemble-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| StringLengthRange Parameter Summary |
+| StringLengthRange Parameter Details |
| :----------------------------------- |
| **Type**
*int[]* |
| **Range**
The array contains only two elements, corresponding to the lower and upper bounds of the Range, respectively. The value range is [0, 0x7fffffff].|
diff --git a/parameters/reference/label-recognizer-task-settings/string-regex-pattern.md b/parameters/reference/label-recognizer-task-settings/string-regex-pattern.md
index f7cda8d..fe7ba96 100644
--- a/parameters/reference/label-recognizer-task-settings/string-regex-pattern.md
+++ b/parameters/reference/label-recognizer-task-settings/string-regex-pattern.md
@@ -3,26 +3,43 @@ layout: default-layout
title: StringRegExPattern - Dynamsoft Label Recognizer Parameters
description: The parameter StringRegExPattern of Dynamsoft Label Recognizer defines the regular expression pattern for concatenated strings of recognized text lines.
keywords: text lines, concatenated strings, regular expression
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
---
# StringRegExPattern
Parameter `StringRegExPattern` specifies the regular expression pattern for concatenated strings of recognized text lines.
-## Example
+## JSON Structure
+
+**Location in template:**
+
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── SectionArray[j] (Section object)
+ └── StageArray[k] (Stage object where Stage = "SST_ASSEMBLE_TEXT_LINES")
+ └── StringRegExPattern
+```
+
+**Parent object:** [AssembleTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-assemble-text-lines.html)
+
+**Example:**
```json
{
- "StringRegExPattern" : ""
+ "StringRegExPattern": ""
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `StringRegExPattern` parameter.
+> - To use it, embed this parameter within a [AssembleTextLinesStage]({{ site.dcvb_parameters }}reference/label-recognizer-task-settings/stage-assemble-text-lines.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json)
+
+## Parameter Details
-| StringRegExPattern Parameter Summary |
+| StringRegExPattern Parameter Details |
| :----------------------------------- |
| **Type**
*String* |
| **Range**
All standard regular expressions.|
diff --git a/parameters/reference/label-recognizer-task-settings/terminate-setting.md b/parameters/reference/label-recognizer-task-settings/terminate-setting.md
deleted file mode 100644
index 3a560d7..0000000
--- a/parameters/reference/label-recognizer-task-settings/terminate-setting.md
+++ /dev/null
@@ -1,67 +0,0 @@
----
-layout: default-layout
-title: TerminateSetting - Dynamsoft Label Recognizer Parameters
-description: The parameter TerminateSetting defines the terminate stages of the label recognition task.
-keywords: Terminate setting
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
----
-
-# TerminateSetting
-
-Parameter `TerminateSetting` defines the terminate stages of each section in the task. For each sections, you can define only one terminate stage.
-
-## Example
-
-```json
-"TerminateSetting":
-{
- "Section": "ST_REGION_PREDETECTION",
- "Stage": "IRUT_GRAYSCALE_IMAGE"
-}
-```
-
-## Parameter Summary
-
-
-
-
- | Child Parameter Name |
- Child Parameter Summary |
-
-
-
- Section
|
- Description
Specifies a mode for ordering. |
-
-
- Type
String |
-
-
- Range
One of the following SectionType as a string.
-
ST_REGION_PREDETECTION
-
ST_TEXT_LINE_LOCALIZATION
-
ST_TEXT_LINE_RECOGNITION
- |
-
-
- Stage
|
- Description
Specifies a mode for ordering. |
-
-
- Type
String |
-
-
- Range
One of the IntermediateResultUnitType as a string. The available stage type is different for each sections. View the appendix for more details.
- |
-
-
-
-## Appendix - Available Stage for Sections
-
-| Section | Available Stages |
-| :------------------ | :--------------- |
-| ST_REGION_PREDETECTION | IRUT_COLOUR_IMAGE
IRUT_SCALED_DOWN_COLOUR_IMAGE
IRUT_GRAYSCALE_IMAGE
IRUT_TRANSFORMED_GRAYSCALE_IMAGE
IRUT_PREDETECTED_REGIONS |
-| ST_TEXT_LINE_LOCALIZATION | 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
IRUT_LOCALIZED_TEXT_LINES |
-| ST_TEXT_LINE_RECOGNITION | IRUT_COLOUR_IMAGE
IRUT_GRAYSCALE_IMAGE
IRUT_TRANSFORMED_GRAYSCALE_IMAGE
IRUT_RECOGNIZED_TEXT_LINES |
diff --git a/parameters/reference/label-recognizer-task-settings/text-line-specification-name-array.md b/parameters/reference/label-recognizer-task-settings/text-line-specification-name-array.md
index 281ab96..05257fa 100644
--- a/parameters/reference/label-recognizer-task-settings/text-line-specification-name-array.md
+++ b/parameters/reference/label-recognizer-task-settings/text-line-specification-name-array.md
@@ -1,18 +1,25 @@
---
layout: default-layout
title: TextLineSpecificationNameArray - Dynamsoft Label Recognizer Parameters
-description: The parameter TextLineSpecificationNameArray of Dynamsoft Label Recognizer defines the collection of text line specification object names
+description: The parameter TextLineSpecificationNameArray defines the collection of text line specification object names.
keywords: text line specification, LabelRecognizerTaskSetting
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
---
# TextLineSpecificationNameArray
-Parameter `TextLineSpecificationNameArray` defines the collection of text line specification object names, used to refer to the `TextLineSpecification` objects
+`TextLineSpecificationNameArray` defines the collection of text line specification object names, used to refer to the `TextLineSpecification` objects.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+LabelRecognizerTaskSettingOptions[i]
+ └── TextLineSpecificationNameArray
+```
+
+**Parent object:** [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html)
+
+**Example:**
```json
{
@@ -20,11 +27,18 @@ Parameter `TextLineSpecificationNameArray` defines the collection of text line s
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `TextLineSpecificationNameArray` parameter.
+> - To use it, embed this parameter within a [LabelRecognizerTaskSetting]({{ site.dcvb_parameters }}file/task-settings/label-recognizer-task-settings.html) object in the complete JSON structure.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| TextLineSpecificationNameArray Parameter Summary |
+| TextLineSpecificationNameArray Parameter Details |
| :----------------------------------- |
| **Type**
*String[]* |
| **Range**
Each element is the name of a `TextLineSpecification` object. |
| **Default Value**
['tls_default'] |
-| **Remarks**
If `TextLineSpecificationNameArray` is not specified, a default array ["tls_default"] will be created. The TextLineSpecification object with the name "tls_default" will have a default configuration for all text lines.|
+| **Remarks**
If `TextLineSpecificationNameArray` is not specified, a default array ["tls_default"] will be created. The `TextLineSpecification` object with the name "tls_default" will have a default configuration for all text lines.|
diff --git a/parameters/reference/output-task-setting/index.md b/parameters/reference/output-task-setting/index.md
deleted file mode 100644
index 4ac9bf7..0000000
--- a/parameters/reference/output-task-setting/index.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-layout: default-layout
-title: Index - OutputTaskSetting Parameters
-description: The index of OutputTaskSetting parameters.
-keywords: OutputTaskSetting, parameter reference, parameter
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-permalink: /parameters/reference/output-task-setting/index.html
----
-
-# OutputTaskSetting Parameters
-
-| Parameter Name | Description |
-| -------------- | ----------- |
-| [`Name`](name.md) | Defines the name of a `OutputTaskSetting` object, which serves as its unique identifier. |
-| [`OutputCondidtion`](output-condition.md) | Defines how the [`OutputTaskSetting`](../../file/task-settings/output-task-setting.md) object outputs results that satisfy multiple filter conditions across products. |
diff --git a/parameters/reference/output-task-setting/name.md b/parameters/reference/output-task-setting/name.md
index f13962b..7eb3f34 100644
--- a/parameters/reference/output-task-setting/name.md
+++ b/parameters/reference/output-task-setting/name.md
@@ -13,7 +13,17 @@ permalink: /parameters/reference/output-task-setting/name.html
Parameter `Name` represents the name of a `OutputTaskSetting` object, which serves as its unique identifier.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+OutputTaskSettingOptions[i]
+ └── Name
+```
+
+**Parent object:** [OutputTaskSetting]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html) object
+
+**Example:**
```json
{
@@ -21,7 +31,15 @@ Parameter `Name` represents the name of a `OutputTaskSetting` object, which serv
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Name` parameter.
+> - To use it, embed this parameter within a [OutputTaskSetting]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+
+## Parameter Details
| Parameter Details |
| :----------------------------------- |
diff --git a/parameters/reference/output-task-setting/output-condition.md b/parameters/reference/output-task-setting/output-condition.md
index 0d5452e..b1c373a 100644
--- a/parameters/reference/output-task-setting/output-condition.md
+++ b/parameters/reference/output-task-setting/output-condition.md
@@ -3,17 +3,30 @@ layout: default-layout
title: OutputCondition - Dynamsoft Capture Vision OutputSetting Object
description: The parameter OutputCondition of OutputSetting object defines the OutputCondition information of the ROIs.
keywords: OutputCondition
-needAutoGenerateSidebar: true
-noTitleIndex: true
-needGenerateH3Content: true
-permalink: /parameters/reference/output-task-setting/output-condition.html
---
# OutputCondition
-The parameter `OutputCondition` defines how the [`OutputTaskSetting`](../../file/task-settings/output-task-setting.md) object outputs results that satisfy multiple filter conditions across products.
+## Overview
-## Example
+The parameter `OutputCondition` defines how the [`OutputTaskSetting`](../../file/task-settings/output-task-setting.md) object outputs results that satisfy multiple filter conditions across products. It allows you to configure complex filtering logic by combining results from multiple tasks and TargetROIDef objects using logical operators (AND/OR).
+
+**Use Cases:**
+- Filter outputs based on conditions from descendant TargetROIDef tasks
+- Combine results from multiple processing tasks with logical operators
+- Reference specific atomic result types from previous tasks
+
+## JSON Structure
+
+**Location in template:**
+```
+OutputTaskSettingOptions[i]
+ └── OutputCondition
+```
+
+**Parent object:** [OutputTaskSetting]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html) object
+
+**Example:**
```json
{
@@ -23,7 +36,6 @@ The parameter `OutputCondition` defines how the [`OutputTaskSetting`](../../file
"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" ]
@@ -35,83 +47,117 @@ The parameter `OutputCondition` defines how the [`OutputTaskSetting`](../../file
}
```
-## Parameter Summary
+**Example Explanation:**
-### TaskResultArray
+This configuration filters output results where:
+- The top-level `Operator` is "AND", requiring all conditions in `TaskResultArray` to be met
+- Results from task "B_task" on TargetROIDef "B" must exist
+- These results must have backward references to task "A_task"
+- The referenced results must be one of the specified atomic result types (text lines, barcodes, frames, table cells, or color regions)
+
+> [!NOTE]
+> - This snippet shows only the `OutputCondition` parameter.
+> - To use it, embed this parameter within a [OutputTaskSetting]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
-The parameter `TaskResultArray` configures multiple tasks of descendant `TargetROIDef` objects to filter out the results of the tasks of the reference `TargetROIDef`.
-### Operator
+## Parameter Details
-The parameter `Operator` defines the type of filtered combination of results from multiple tasks within a `TargetROIDef` object or across multiple `TargetROIDef` objects.
+### Operator (Top-Level)
-| Operator Parameter Summary |
+The top-level `Operator` parameter defines how to combine the conditions from multiple items in the `TaskResultArray`.
+
+| Operator Parameter Details |
| :------------------- |
| **Type**
*String* |
| **Range**
One of the following values: "OR", "AND" |
| **Default Value**
"AND"|
+**Explanation:**
+- **"AND"**: All conditions in `TaskResultArray` must be satisfied
+- **"OR"**: At least one condition in `TaskResultArray` must be satisfied
+
+### TaskResultArray
+
+The parameter `TaskResultArray` is an array that configures multiple filtering conditions based on tasks from descendant `TargetROIDef` objects. Each array element represents one filtering condition.
+
+**Type:** Array of objects
+
+Each object in the array contains the following parameters:
+
#### TargetROIDefName
-The parameter `TargetROIDefName` configures the name of descendant `TargetROIDef` object.
+Specifies the name of the descendant `TargetROIDef` object to reference.
-| TargetROIDefName Parameter Summary |
+| TargetROIDefName Parameter Details |
| :------------------- |
| **Type**
*String* |
-| **Range**
One of the names of descendant `TargetROIDef` object |
-| **Default Value**
mandatory|
+| **Range**
Must be one of the descendant `TargetROIDef` object names defined in your template |
+| **Default Value**
Mandatory (no default)|
#### TaskSettingNameArray
-The parameter `TaskSettingNameArray` specifies the task name array on the descendant `TargetROIDef` object.
+Specifies which tasks on the descendant `TargetROIDef` object to check for results.
-| TaskSettingNameArray Parameter Summary |
+| TaskSettingNameArray Parameter Details |
| :------------------- |
-| **Type**
*String[]* |
-| **Range**
Each member of the array should be one of the task in the descendant `TargetROIDef` object. |
+| **Type**
*String[]* (Array of strings) |
+| **Range**
Each member must be a valid task name in the specified descendant `TargetROIDef` object |
| **Default Value**
null|
+#### Operator (Task-Level)
+
+Defines how to combine multiple task results within this specific condition.
+
+| Operator Parameter Details |
+| :------------------- |
+| **Type**
*String* |
+| **Range**
One of the following values: "OR", "AND" |
+| **Default Value**
"AND"|
+
+**Note:** This is different from the top-level `Operator`. The task-level operator combines results within a single `TaskResultArray` item, while the top-level operator combines across multiple array items.
+
#### BackwardReferenceOutput
-
-
-
- | Child Parameter Name |
- Child Parameter Summary |
-
-
-
- | ReferenceTaskNameArray |
- Description
Specifies the task name array on the TargetROIDef object.
- |
-
-
- Type
String[]
- |
-
-
- Range
Each member of the array should be one of the task in the reference `TargetROIDef` object.
- |
-
-
- Default Value
null
- |
-
-
- | ReferenceResultTypeArray |
- Description
Specifies the type of atomic results produced by tasks (except OutputTask) on the TargetROIDef object.
- |
-
-
- Type
String[]
- |
-
-
- Range
Each member should be one of the `AtomicResultType`, which are `ART_TEXT_LINE`, `ART_BARCODE`, `ART_FRAME` and `ART_COLOUR_REGION`
- |
-
-
- Default Value
["ART_TEXT_LINE","ART_BARCODE","ART_FRAME"]
- |
-
-
+Configures backward reference filtering based on results from the reference (parent) `TargetROIDef` object.
+
+##### ReferenceTaskNameArray
+
+Specifies which tasks on the reference `TargetROIDef` object to check for backward references.
+
+| ReferenceTaskNameArray Parameter Details |
+| :------------------- |
+| **Type**
*String[]* (Array of strings) |
+| **Range**
Each member must be a valid task name in the reference `TargetROIDef` object |
+| **Default Value**
null|
+
+##### ReferenceResultTypeArray
+
+Specifies which types of atomic results to accept from the referenced tasks.
+
+| ReferenceResultTypeArray Parameter Details |
+| :------------------- |
+| **Type**
*String[]* (Array of strings) |
+| **Range**
Each member must be one of the following `AtomicResultType` values:
- `"ART_TEXT_LINE"`: Text line results
- `"ART_BARCODE"`: Barcode results
- `"ART_FRAME"`: Frame results
- `"ART_TABLE_CELL"`: Table cell results
- `"ART_COLOUR_REGION"`: Color region results |
+| **Default Value**
["ART_TEXT_LINE","ART_BARCODE","ART_FRAME"]|
+
+## Terminology
+
+- **Reference TargetROIDef**: The parent or current `TargetROIDef` object that contains the `OutputTaskSetting` with this `OutputCondition`
+- **Descendant TargetROIDef**: Child `TargetROIDef` objects that are referenced in the `TaskResultArray`
+- **Backward Reference**: A link from a descendant task result back to a parent task result
+
+## Best Practices
+
+1. **Use meaningful names**: Choose descriptive names for TargetROIDef and task settings to make your configuration easier to understand
+2. **Start simple**: Begin with a single condition and "AND" operator, then add complexity as needed
+3. **Specify result types**: Explicitly set `ReferenceResultTypeArray` to only include the atomic result types you actually need
+4. **Test conditions**: Verify that your filter conditions work as expected with sample data before deploying
+
+## See Also
+
+- [OutputTaskSetting]({{ site.dcvb_parameters }}file/task-settings/output-task-setting.html)
+- [TargetROIDef]({{ site.dcvb_parameters }}file/target-roi-definition/index.html)
+- [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
diff --git a/parameters/reference/semantic-processing/index.md b/parameters/reference/semantic-processing/index.md
deleted file mode 100644
index 316f9d5..0000000
--- a/parameters/reference/semantic-processing/index.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-layout: default-layout
-title: Index - SemanticProcessing Parameters
-description: The index of SemanticProcessing parameters.
-keywords: SemanticProcessing, parameter reference, parameter
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-permalink: /parameters/reference/semantic-processing/index.html
----
-
-# SemanticProcessing Parameters
-
-| Parameter Name | Description |
-| -------------- | ----------- |
-| [`Name`](name.md) | Defines the name of a `SemanticProcessing` object, which serves as its unique identifier. |
-| [`ReferenceObjectFilter`](reference-object-filter.md) | Sets a [ReferenceObjectFilter](#referenceobjectfilter) object to define the filter conditions. |
-| [`TaskSettingsNameArray`](task-setting-name-array.md) | Represents the collection of task setting object names, used to refer to the `CodeParserTaskSetting` objects. |
diff --git a/parameters/reference/semantic-processing/name.md b/parameters/reference/semantic-processing/name.md
index 0088e08..a7ab58c 100644
--- a/parameters/reference/semantic-processing/name.md
+++ b/parameters/reference/semantic-processing/name.md
@@ -3,16 +3,23 @@ layout: default-layout
title: Name - Dynamsoft Capture Vision semantic processing object
description: The parameter Name defines the unique identifier of SemanticProcessing object.
keywords: top-level object, name, unique identifier, semantic processing
-needAutoGenerateSidebar: true
-noTitleIndex: true
needGenerateH3Content: true
---
-
# Name
Parameter `Name` represents the name of a `SemanticProcessing` object, which serves as its unique identifier.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+SemanticProcessingOptions[i]
+ └── Name
+```
+
+**Parent object:** [SemanticProcessing]({{ site.dcvb_parameters }}file/semantic-processing/index.html) object
+
+**Example:**
```json
{
@@ -20,7 +27,14 @@ Parameter `Name` represents the name of a `SemanticProcessing` object, which ser
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `Name` parameter.
+> - To use it, embed this parameter within a [SemanticProcessing]({{ site.dcvb_parameters }}file/semantic-processing/index.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
| Parameter Details |
| :----------------------------------- |
diff --git a/parameters/reference/semantic-processing/reference-object-filter.md b/parameters/reference/semantic-processing/reference-object-filter.md
index 2de623d..2c9419b 100644
--- a/parameters/reference/semantic-processing/reference-object-filter.md
+++ b/parameters/reference/semantic-processing/reference-object-filter.md
@@ -3,64 +3,84 @@ layout: default-layout
title: ReferenceObjectFilter - Dynamsoft Capture Vision Semantic Processing object
description: The parameter ReferenceObjectFilter defines a group of filter conditions for figuring out the `reference objects`.
keywords: referenceobjectfilter
-needAutoGenerateSidebar: true
-noTitleIndex: true
needGenerateH3Content: true
---
-
# ReferenceObjectFilter
Parameter `ReferenceObjectFilter` is a group of filter conditions for figuring out the `reference objects`.
+## JSON Structure
+
+**Location in template:**
+```
+SemanticProcessingOptions[i]
+ └── ReferenceObjectFilter
+```
+
+**Parent object:** [SemanticProcessing]({{ site.dcvb_parameters }}file/semantic-processing/index.html) object
+
+**Example:**
+
```json
-"ReferenceObjectFilter" :
{
- "ReferenceTargetROIDefNameArray": ["TR_0", "TR_1"],
- "AtomicResultTypeArray" : ["ART_TEXT_LINE","ART_BARCODE","ART_FRAME","ART_TABLE_CELL"],
- "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",
- },
- "TextLineFilteringCondition":
+ "ReferenceObjectFilter":
{
- "LineNumbers": "1,3-5",
- "LineStringRegExPattern": "Sodium[(\w| )]*",
- "RegionState": "default",
+ "ReferenceTargetROIDefNameArray": ["TR_0", "TR_1"],
+ "AtomicResultTypeArray" : ["ART_TEXT_LINE","ART_BARCODE","ART_FRAME","ART_TABLE_CELL"],
+ "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",
+ },
+ "TextLineFilteringCondition":
+ {
+ "LineNumbers": "1,3-5",
+ "LineStringRegExPattern": "Sodium[(\w| )]*",
+ "RegionState": "default",
+ }
}
}
```
-## ReferenceTargetROIDefNameArray
+> [!NOTE]
+> - This snippet shows only the `ReferenceObjectFilter` parameter.
+> - To use it, embed this parameter within a [SemanticProcessing]({{ site.dcvb_parameters }}file/semantic-processing/index.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
+
+### ReferenceTargetROIDefNameArray
Filter the reference object by specifying `TargetROI` names.
-| ReferenceTargetROIDefNameArray Parameter Summary |
+| ReferenceTargetROIDefNameArray Parameter Details |
| :------------------- |
| **Type**
*String[]* |
| **Range**
Each member should be a name of `TargetROI` that defined in `TargetROIDefOptions`. |
| **Default Value**
null |
-## AtomicResultTypeArray
+### 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 |
+| AtomicResultTypeArray Parameter Details |
| :------------------- |
| **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"] |
-## BarcodeFilteringCondition
+### BarcodeFilteringCondition
One of the filter conditions. Filter the reference objects with the decoded barcode information. The parameter `BarcodeFilteringCondition` includes the following child parameters:
@@ -103,7 +123,7 @@ One of the filter conditions. Filter the reference objects with the decoded barc
|
-## FrameFilteringCondition
+### FrameFilteringCondition
One of the filter conditions. Filter the reference objects with the frame information. The parameter `FrameFilteringCondition` includes the following child parameters:
@@ -169,7 +189,7 @@ One of the filter conditions. Filter the reference objects with the frame inform
-## TextLineFilteringCondition
+### TextLineFilteringCondition
One of the filter conditions. Filter the reference objects with the text line content. The parameter `TextLineFilteringCondition` includes the following child parameters:
diff --git a/parameters/reference/semantic-processing/task-setting-name-array.md b/parameters/reference/semantic-processing/task-setting-name-array.md
index c6b387a..f9e942c 100644
--- a/parameters/reference/semantic-processing/task-setting-name-array.md
+++ b/parameters/reference/semantic-processing/task-setting-name-array.md
@@ -3,16 +3,23 @@ layout: default-layout
title: TaskSettingNameArray - Dynamsoft Capture Vision Semantic Processing Parameters
description: The parameter TaskSettingNameArray defines the collection of CodeParserTaskSetting object names.
keywords: task settings, semantic processing
-needAutoGenerateSidebar: true
-noTitleIndex: true
needGenerateH3Content: true
---
-
# TaskSettingNameArray
Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the [`CodeParserTaskSetting`](../../file/task-settings/code-parser-task-settings.md) objects.
-## Example
+## JSON Structure
+
+**Location in template:**
+```
+SemanticProcessingOptions[i]
+ └── TaskSettingNameArray
+```
+
+**Parent object:** [SemanticProcessing]({{ site.dcvb_parameters }}file/semantic-processing.html) object
+
+**Example:**
```json
{
@@ -20,9 +27,16 @@ Parameter `TaskSettingNameArray` represents the collection of task setting objec
}
```
-## Parameter Summary
+> [!NOTE]
+> - This snippet shows only the `TaskSettingNameArray` parameter.
+> - To use it, embed this parameter within a [SemanticProcessing]({{ site.dcvb_parameters }}file/semantic-processing.html) object.
+> - For the complete JSON structure, see:
+> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
+> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)
+
+## Parameter Details
-| TaskSettingNameArray Parameter Summary |
+| TaskSettingNameArray Parameter Details |
| :----------------------------------- |
| **Type**
