Skip to content

Commit 588e9a7

Browse files
a362758199a362758199
committed
update for v2.0.10
1 parent 63098e7 commit 588e9a7

File tree

2 files changed

+88
-1
lines changed

2 files changed

+88
-1
lines changed

‎parameters-new/reference/index-v2.0.0.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Dynamsoft Document Normalizer Parameter Reference - Main Page
3+
description: Dynamsoft Document Normalizer Parameter Reference - Main Page
4+
keywords: parameter reference, parameters
5+
needAutoGenerateSidebar: false
6+
permalink: /parameters/reference/index.html
7+
---
8+
9+
# Parameter Reference
10+
11+
## Capture Vision Template
12+
13+
| Parameter Name | Description |
14+
| ---------------------------------------------------------------------------- | ----------- |
15+
| [`ImageROIProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. |
16+
| [`ImageSourceName`]({{ site.parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. |
17+
| [`MaxParallelTasks`]({{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. |
18+
| [`OutputRawImage`]({{ site.parameters_reference }}capture-vision-template/output-raw-Image.html) | Indicates whether DCV finally outputs the raw input image. |
19+
| [`SemanticProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. |
20+
| [`Timeout`]({{ site.parameters_reference }}capture-vision-template/timeout.html) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. |
21+
22+
## Target ROI Def
23+
24+
| Parameter Name | Description |
25+
| ------------------------------------------------------------------------------------- | ----------- |
26+
| [`BaseTargetROIDefName`]({{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. |
27+
| [`Location`]({{ site.parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. |
28+
| [`PauseFlag`]({{ site.parameters_reference }}target-roi-def/pause-flag.html) | Indicates that the region results generated by this `TargetROIDef` will not be used by other `TargetROIDef` objects that depend on it to calculate the target regions, unless the user explicitly performs an update operation. |
29+
| [`TaskSettingNameArray`]({{ site.parameters_reference }}target-roi-def/task-setting-name-array.html) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `DocumentNormalizerTaskSetting` objects. |
30+
31+
## Document Normalizer Task Setting
32+
33+
| Parameter Name | Description |
34+
| ------------------------------------------------------------------------------------------------------------------------- | ----------- |
35+
| [`BaseDocumentNormalizerTaskSettingName`]({{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. |
36+
| [`Brightness`]({{ site.parameters_reference }}document-normalizer-task-settings/brightness.html) | Defines the brightness of the normalized image. |
37+
| [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. |
38+
| [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. |
39+
| [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. |
40+
| [`CornerAngleRangeArray`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range-array.html) | Defines the range of angles (in degrees) of the extracted corners. |
41+
| [`DeskewMode`]({{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. |
42+
| [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. |
43+
| [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. |
44+
| [`QuadrilateralDetectionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html) | Defines the quadrilateral detection process on an image. |
45+
46+
## ImageParameter
47+
48+
| Parameter Name | Description |
49+
| ---------------------------------------------------------------------------------------------------- | ----------- |
50+
| [`BaseImageParameterName`]({{ site.parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. |
51+
| [`BinarizationModes`]({{ site.parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization |
52+
| [`ColourChannelUsageType`]({{ site.parameters_reference }}image-parameter/colour-channel-usage-type.html) | Defines how to use the colour channel from the source image buffer. |
53+
| [`ColourConversionModes`]({{ site.parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. |
54+
| [`GrayscaleEnhancementModes`]({{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. |
55+
| [`GrayscaleTransformationModes`]({{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. |
56+
| [`IfEraseTextZone`]({{ site.parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. |
57+
| [`RegionPredetectionModes`]({{ site.parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. |
58+
| [`ScaleDownThreshold`]({{ site.parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. |
59+
| [`ScaleUpModes`]({{ site.parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. |
60+
| [`TextDetectionMode`]({{ site.parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. |
61+
| [`TextureDetectionModes`]({{ site.parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. |
62+
63+
## Image Source
64+
65+
| Parameter Name | Description |
66+
| ------------------------------------------------------------------------ | ----------- |
67+
| [`FileFilter`]({{ site.parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. |
68+
| [`PDFReadingMode`]({{ site.parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. |
69+
| [`Recursive`]({{ site.parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. |
70+
| [`Type`]({{ site.parameters_reference }}image-source-options/type.html) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. |
71+
72+
## Global Parameter
73+
74+
| Parameter Name | Description |
75+
| ----------------------------------------------------------------------------------------- | ----------- |
76+
| [`MaxTotalImageDimension`]({{ site.parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory |
77+
78+
## Shared Parameter
79+
80+
| Parameter Name | Description |
81+
| ------------------------------------------------------------------------------------------------- | ----------- |
82+
| [`DirectoryPath`]({{ site.parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. |
83+
| [`MaxThreadsInOneTask`]({{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. |
84+
| [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. |
85+
| [`SectionImageParameterArray`]({{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. |
86+
| [`StartSection`]({{ site.parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. |
87+
| [`TerminateSetting`]({{ site.parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. |

‎parameters-new/reference/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ permalink: /parameters/reference/index.html
3737
| [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. |
3838
| [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. |
3939
| [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. |
40-
| [`CornerAngleRangeArray`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range-array.html) | Defines the range of angles (in degrees) of the extracted corners. |
40+
| [`CornerAngleRange`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range-array.html) | Defines the range of angles (in degrees) of the extracted corners. |
4141
| [`DeskewMode`]({{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. |
4242
| [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. |
4343
| [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. |

0 commit comments

Comments
 (0)