You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The ImageParameter object is designed to configure and organize parameters for image processing stages, including but not limited to convert color-to-grayscale stage, enhance grayscale image stage, binarize image stage, detect text zone stage, and detect texture stage. You can configure detailed parameters for each stage.
10
+
The `ImageParameter` object is designed to configure and organize parameters for image processing stages, including convert color-to-grayscale, enhance grayscale, binarize image, detect text zones, and detect texture stages. You can configure detailed parameters for each stage.
Each algorithm section of the funtional products has a default `ImageParameter` settings. You can either skip the ImageParameter settings to implement the default settings or define your own `ImageParameter` objects and specify them in the sections you want to customize.
71
-
72
-
### Define an ImageParameter Object
73
-
74
-
`ImageParameter` objects are configured under `ImageParameterOptions` and each object has a unique name as its identifier.
40
+
## Parameters
41
+
42
+
| Parameter Name | Type | Required/Optional | Description |
|[`Name`]({{site.dcvb_parameters_reference}}image-parameter/name.html)| String | Required | The unique identifier for this `ImageParameter` object. |
45
+
|[`BaseImageParameterName`]({{site.dcvb_parameters_reference}}image-parameter/base-image-parameter-name.html)| String | Optional | The name of another `ImageParameter` object to inherit settings from. |
46
+
|[`ApplicableStages`]({{site.dcvb_parameters_reference}}image-parameter/applicable-stages.html)| Array | Optional | An array of stage objects defining the image processing pipeline. |
47
+
48
+
## Usage
49
+
50
+
Each functional product has default `ImageParameter` settings. You can either use the defaults or define custom `ImageParameter` objects for specific sections.
51
+
52
+
### Defining ImageParameter Objects
53
+
54
+
`ImageParameter` objects are configured under `ImageParameterOptions`, each with a unique name:
75
55
76
56
```json
77
57
{
@@ -86,7 +66,7 @@ Each algorithm section of the funtional products has a default `ImageParameter`
86
66
}
87
67
```
88
68
89
-
You can define a new `ImageParameter`object based on an existing `ImageParameter` object. For example:
69
+
You can create a new `ImageParameter` based on an existing one using inheritance:
90
70
91
71
```json
92
72
{
@@ -96,20 +76,19 @@ You can define a new `ImageParameter` object based on an existing `ImageParamete
96
76
},
97
77
{
98
78
"Name": "IP_1",
99
-
"BaseImageParameterName": "IP_0"
79
+
"BaseImageParameterName": "IP_0"
100
80
}
101
81
]
102
82
}
103
83
```
104
84
105
-
### Specify an ImageParameter for Task Sections
85
+
### Referencing in Task Settings
106
86
107
-
`ImageParameter`is referenced in task settings under `SectionImageParameterArray` with their names. For example:
87
+
Reference `ImageParameter`objects in task settings by name:
108
88
109
89
```json
110
90
{
111
-
"SectionArray":
112
-
[
91
+
"SectionArray": [
113
92
{
114
93
"Section": "ST_REGION_PREDETECTION",
115
94
"ImageParameterName": "IP_0"
@@ -126,30 +105,35 @@ You can define a new `ImageParameter` object based on an existing `ImageParamete
126
105
}
127
106
```
128
107
129
-
## Summary of ImageParameter Top-level Parameters
130
-
131
-
View the parameter references for the details of each `ImageParameter` parameters.
|[`BaseImageParameterName`](../reference/image-parameter/base-image-parameter-name.md)| Represents the name of another `ImageParameter` object to inherit from. |
136
-
|[`Name`](../reference/image-parameter/name.md)| Defines the name of a `ImageParameter` object, which serves as its unique identifier. |
137
-
|[`ApplicableStages`](../reference/image-parameter/applicable-stages.md)| Defines the applicable stage parameters with an array of stage objects. |
138
-
139
108
## Available Stages
140
109
141
110
| Stage Name | Description |
142
111
| ---------- | ----------- |
143
-
|[`SST_SCALE_IMAGE`](../reference/image-parameter/stage-scale-image.md)| The stage for scaling up or down the image. |
144
-
|[`SST_CONVERT_TO_GRAYSCALE`](../reference/image-parameter/stage-convert-to-grayscale.md)| The stage for converting a colour image to a grayscale image. |
145
-
|[`SST_TRANSFORM_GRAYSCALE`](../reference/image-parameter/stage-transform-grayscale.md)| The stage for transforming the grayscale image. Generally used when processing inverted barcodes or text lines. |
146
-
|[`SST_ENHANCE_GRAYSCALE`](../reference/image-parameter/stage-enhance-grayscale.md)| The stage for enhancing the quality of the grayscale image. |
147
-
|[`SST_BINARIZE_IMAGE`](../reference/image-parameter/stage-binarize-image.md)| The stage for binarizing the image. |
148
-
|[`SST_DETECT_TEXTURE`](../reference/image-parameter/stage-detect-texture.md)| The stage for detecting texture on the image. |
149
-
|[`SST_REMOVE_TEXTURE_FROM_GRAYSCALE`](../reference/image-parameter/stage-remove-texture-from-grayscale.md)| The stage for removing texture from the grayscale image. |
150
-
|[`SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`](../reference/image-parameter/stage-binarize-texture-removed-grayscale.md)| The stage for binarizing the texture removed grayscale image. |
151
-
|[`SST_FIND_CONTOURS`](../reference/image-parameter/stage-find-contours.md)| The stage for finding contours in the image. |
152
-
|[`SST_DETECT_SHORTLINES`](../reference/image-parameter/stage-detect-shortlines.md)| The stage for detecting short lines for document boundary detection. |
153
-
|[`SST_ASSEMBLE_LINES`](../reference/image-parameter/stage-assemble-lines.md)| The stage for assembling lines. |
154
-
|[`SST_DETECT_TEXT_ZONES`](../reference/image-parameter/stage-detect-text-zones.md)| The stage for detecting text zones on the image. |
155
-
|[`SST_REMOVE_TEXT_ZONES_FROM_BINARY`](../reference/image-parameter/stage-remove-text-zones-from-binary.md)| The stage for removing text zones from the binary image. |
112
+
|[`SST_SCALE_IMAGE`]({{site.dcvb_parameters_reference}}image-parameter/stage-scale-image.html)| Scales the image up or down. |
113
+
|[`SST_CONVERT_TO_GRAYSCALE`]({{site.dcvb_parameters_reference}}image-parameter/stage-convert-to-grayscale.html)| Converts a color image to grayscale. |
114
+
|[`SST_TRANSFORM_GRAYSCALE`]({{site.dcvb_parameters_reference}}image-parameter/stage-transform-grayscale.html)| Transforms the grayscale image (e.g., for inverted barcodes). |
|[`SST_BINARIZE_IMAGE`]({{site.dcvb_parameters_reference}}image-parameter/stage-binarize-image.html)| Converts grayscale to binary image. |
117
+
|[`SST_DETECT_TEXTURE`]({{site.dcvb_parameters_reference}}image-parameter/stage-detect-texture.html)| Detects texture patterns in the image. |
118
+
|[`SST_REMOVE_TEXTURE_FROM_GRAYSCALE`]({{site.dcvb_parameters_reference}}image-parameter/stage-remove-texture-from-grayscale.html)| Removes texture from grayscale image. |
119
+
|[`SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`]({{site.dcvb_parameters_reference}}image-parameter/stage-binarize-texture-removed-grayscale.html)| Binarizes the texture-removed grayscale image. |
120
+
|[`SST_FIND_CONTOURS`]({{site.dcvb_parameters_reference}}image-parameter/stage-find-contours.html)| Finds contours in the image. |
121
+
|[`SST_DETECT_SHORTLINES`]({{site.dcvb_parameters_reference}}image-parameter/stage-detect-shortlines.html)| Detects short lines for document boundary detection. |
|[`SST_DETECT_TEXT_ZONES`]({{site.dcvb_parameters_reference}}image-parameter/stage-detect-text-zones.html)| Detects text zones in the image. |
124
+
|[`SST_REMOVE_TEXT_ZONES_FROM_BINARY`]({{site.dcvb_parameters_reference}}image-parameter/stage-remove-text-zones-from-binary.html)| Removes text zones from binary image. |
125
+
126
+
## Stage Parameters
127
+
128
+
Each stage can have associated parameters for fine-tuning:
|`Name`| Represents the name of the ImageSource object, which serves as its unique identifier. |
37
-
|`Type`| Indicates the type of the `ImageSource` object, which helps CVR create the correct type of image source. |
38
-
|`DirectoryPath`| Specifies a local directory, the files within which are fetched as images to process. |
39
-
|`FileFilter`| Specifies a file name filter string, which determines which files are fetched. |
40
-
|`Recursive`| Indicates whether to fetch files recursively. |
41
-
|`PDFReadingMode`| Defines how to handle PDF files. |
42
-
|`Pages`| Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching.|
36
+
|[`Name`]({{ site.dcvb_parameters_reference }}image-source-options/name.html)| Represents the name of the ImageSource object, which serves as its unique identifier. |
37
+
|[`Type`]({{ site.dcvb_parameters_reference }}image-source-options/type.html)| Indicates the type of the `ImageSource` object, which helps CVR create the correct type of image source. |
38
+
|[`DirectoryPath`]({{ site.dcvb_parameters_reference }}image-source-options/directory-path.html)| Specifies a local directory, the files within which are fetched as images to process. |
39
+
|[`FileFilter`]({{ site.dcvb_parameters_reference }}image-source-options/file-filter.html)| Specifies a file name filter string, which determines which files are fetched. |
40
+
|[`Recursive`]({{ site.dcvb_parameters_reference }}image-source-options/recursive.html)| Indicates whether to fetch files recursively. |
41
+
|[`PDFReadingMode`]({{ site.dcvb_parameters_reference }}image-source-options/pdf-reading-mode.html)| Defines how to handle PDF files. |
42
+
|[`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. |
0 commit comments