Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions _includes/sidelist-parameters-reference-v2.0.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<li><a href="{{ site.parameters_reference_ddn }}" class="otherLinkColour">Parameter Reference</a>
<ul>
<li><a class="otherLinkColour ">Capture Vision Template</a>
<ul>
<li><a href="{{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html" class="otherLinkColour">ImageROIProcessingNameArray</a></li>
<li><a href="{{ site.parameters_reference }}capture-vision-template/image-source-name.html" class="otherLinkColour">ImageSourceName</a></li>
<li><a href="{{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html" class="otherLinkColour">MaxParallelTasks</a></li>
<li><a href="{{ site.parameters_reference }}capture-vision-template/output-raw-Image.html" class="otherLinkColour">OutputRawImage</a></li>
<li><a href="{{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html" class="otherLinkColour">SemanticProcessingNameArray</a></li>
<li><a href="{{ site.parameters_reference }}capture-vision-template/timeout.html" class="otherLinkColour">Timeout</a></li>
</ul>
</li>
<li><a class="otherLinkColour ">Target ROI Def</a>
<ul>
<li><a href="{{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html" class="otherLinkColour">BaseTargetROIDefName</a></li>
<li><a href="{{ site.parameters_reference }}target-roi-def/location.html" class="otherLinkColour">Location</a></li>
<li><a href="{{ site.parameters_reference }}target-roi-def/pause-flag.html" class="otherLinkColour">PauseFlag</a></li>
<li><a href="{{ site.parameters_reference }}target-roi-def/task-setting-name-array.html" class="otherLinkColour">TaskSettingNameArray</a></li>
</ul>
</li>
<li><a class="otherLinkColour ">Document Normalizer Task Setting</a>
<ul>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html" class="otherLinkColour">BaseDocumentNormalizerTaskSettingName</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/brightness.html" class="otherLinkColour">Brightness</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html" class="otherLinkColour">ColourMode</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/content-type.html" class="otherLinkColour">ContentType</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/contrast.html" class="otherLinkColour">Contrast</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range-array.html" class="otherLinkColour">CornerAngleRangeArray</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html" class="otherLinkColour">DeskewMode</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html" class="otherLinkColour">LineExtractionModes</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/page-size.html" class="otherLinkColour">PageSize</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html" class="otherLinkColour">QuadrilateralDetectionModes</a></li>
</ul>
</li>
<li><a class="otherLinkColour ">ImageParameter</a>
<ul>
<li><a href="{{ site.parameters_reference }}image-parameter/base-image-parameter-name.html" class="otherLinkColour">BaseImageParameterName</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/binarization-modes.html" class="otherLinkColour">BinarizationModes</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/colour-channel-usage-type.html" class="otherLinkColour">ColourChannelUsageType</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/colour-conversion-modes.html" class="otherLinkColour">ColourConversionModes</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html" class="otherLinkColour">GrayscaleEnhancementModes</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html" class="otherLinkColour">GrayscaleTransformationModes</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/if-erase-text-zone.html" class="otherLinkColour">IfEraseTextZone</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/region-predetection-modes.html" class="otherLinkColour">RegionPredetectionModes</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/scale-down-threshold.html" class="otherLinkColour">ScaleDownThreshold</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/scale-up-modes.html" class="otherLinkColour">ScaleUpModes</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/text-detection-mode.html" class="otherLinkColour">TextDetectionMode</a></li>
<li><a href="{{ site.parameters_reference }}image-parameter/texture-detection-modes.html" class="otherLinkColour">TextureDetectionModes</a></li>
</ul>
</li>
<li><a class="otherLinkColour ">Image Source</a>
<ul>
<li><a href="{{ site.parameters_reference }}image-source-options/file-filter.html" class="otherLinkColour">FileFilter</a></li>
<li><a href="{{ site.parameters_reference }}image-source-options/pdf-reading-mode.html" class="otherLinkColour">PDFReadingMode</a></li>
<li><a href="{{ site.parameters_reference }}image-source-options/recursive.html" class="otherLinkColour">Recursive</a></li>
<li><a href="{{ site.parameters_reference }}image-source-options/type.html" class="otherLinkColour">Type</a></li>
</ul>
</li>
<li><a class="otherLinkColour ">Global Parameter</a>
<ul>
<li><a href="{{ site.parameters_reference }}global-parameter/max-total-image-dimension.html" class="otherLinkColour">MaxTotalImageDimension</a></li>
</ul>
</li>
<li><a class="otherLinkColour ">Shared Parameter</a>
<ul>
<li><a href="{{ site.parameters_reference }}shared-parameter/directory-path.html" class="otherLinkColour">DirectoryPath</a></li>
<li><a href="{{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html" class="otherLinkColour">MaxThreadsInOneTask</a></li>
<li><a href="{{ site.parameters_reference }}shared-parameter/name.html" class="otherLinkColour">Name</a></li>
<li><a href="{{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html" class="otherLinkColour">SectionImageParameterArray</a></li>
<li><a href="{{ site.parameters_reference }}shared-parameter/start-section.html" class="otherLinkColour">StartSection</a></li>
<li><a href="{{ site.parameters_reference }}shared-parameter/terminate-setting.html" class="otherLinkColour">TerminateSetting</a></li>
</ul>
</li>
</ul>
</li>
2 changes: 1 addition & 1 deletion _includes/sidelist-parameters-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html" class="otherLinkColour">ColourMode</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/content-type.html" class="otherLinkColour">ContentType</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/contrast.html" class="otherLinkColour">Contrast</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range-array.html" class="otherLinkColour">CornerAngleRangeArray</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range.html" class="otherLinkColour">CornerAngleRange</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html" class="otherLinkColour">DeskewMode</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html" class="otherLinkColour">LineExtractionModes</a></li>
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/page-size.html" class="otherLinkColour">PageSize</a></li>
Expand Down
87 changes: 87 additions & 0 deletions parameters-new/reference/index-v2.0.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: Dynamsoft Document Normalizer Parameter Reference - Main Page
description: Dynamsoft Document Normalizer Parameter Reference - Main Page
keywords: parameter reference, parameters
needAutoGenerateSidebar: false
permalink: /parameters/reference/index.html
---

# Parameter Reference

## Capture Vision Template

| Parameter Name | Description |
| ---------------------------------------------------------------------------- | ----------- |
| [`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. |
| [`ImageSourceName`]({{ site.parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. |
| [`MaxParallelTasks`]({{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. |
| [`OutputRawImage`]({{ site.parameters_reference }}capture-vision-template/output-raw-Image.html) | Indicates whether DCV finally outputs the raw input image. |
| [`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. |
| [`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. |

## Target ROI Def

| Parameter Name | Description |
| ------------------------------------------------------------------------------------- | ----------- |
| [`BaseTargetROIDefName`]({{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. |
| [`Location`]({{ site.parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. |
| [`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. |
| [`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. |

## Document Normalizer Task Setting

| Parameter Name | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`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. |
| [`Brightness`]({{ site.parameters_reference }}document-normalizer-task-settings/brightness.html) | Defines the brightness of the normalized image. |
| [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. |
| [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. |
| [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. |
| [`CornerAngleRangeArray`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range-array.html) | Defines the range of angles (in degrees) of the extracted corners. |
| [`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. |
| [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. |
| [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. |
| [`QuadrilateralDetectionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html) | Defines the quadrilateral detection process on an image. |

## ImageParameter

| Parameter Name | Description |
| ---------------------------------------------------------------------------------------------------- | ----------- |
| [`BaseImageParameterName`]({{ site.parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. |
| [`BinarizationModes`]({{ site.parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization |
| [`ColourChannelUsageType`]({{ site.parameters_reference }}image-parameter/colour-channel-usage-type.html) | Defines how to use the colour channel from the source image buffer. |
| [`ColourConversionModes`]({{ site.parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. |
| [`GrayscaleEnhancementModes`]({{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. |
| [`GrayscaleTransformationModes`]({{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. |
| [`IfEraseTextZone`]({{ site.parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. |
| [`RegionPredetectionModes`]({{ site.parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. |
| [`ScaleDownThreshold`]({{ site.parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. |
| [`ScaleUpModes`]({{ site.parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. |
| [`TextDetectionMode`]({{ site.parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. |
| [`TextureDetectionModes`]({{ site.parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. |

## Image Source

| Parameter Name | Description |
| ------------------------------------------------------------------------ | ----------- |
| [`FileFilter`]({{ site.parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. |
| [`PDFReadingMode`]({{ site.parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. |
| [`Recursive`]({{ site.parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. |
| [`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. |

## Global Parameter

| Parameter Name | Description |
| ----------------------------------------------------------------------------------------- | ----------- |
| [`MaxTotalImageDimension`]({{ site.parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory |

## Shared Parameter

| Parameter Name | Description |
| ------------------------------------------------------------------------------------------------- | ----------- |
| [`DirectoryPath`]({{ site.parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. |
| [`MaxThreadsInOneTask`]({{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. |
| [`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. |
| [`SectionImageParameterArray`]({{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. |
| [`StartSection`]({{ site.parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. |
| [`TerminateSetting`]({{ site.parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. |
Loading