Skip to content
Open
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
58 changes: 58 additions & 0 deletions parameters/reference/barcode-reader-task-settings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: default-layout
title: BarcodeReaderTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for BarcodeReaderTaskSetting parameters in Dynamsoft Capture Vision, including barcode format, localization, deformation resisting, deblur, and DPM code reading settings.
keywords: BarcodeReaderTaskSetting, barcode reader, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# BarcodeReaderTaskSetting Parameters

The `BarcodeReaderTaskSetting` object configures settings for barcode reading tasks performed on images in Dynamsoft Capture Vision. Below is the full list of available parameters.

## General

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The name of the BarcodeReaderTaskSetting object. |
| [`BaseBarcodeReaderTaskSettingName`](base-barcode-reader-task-setting-name.html) | The name of another BarcodeReaderTaskSetting object to inherit from. |
| [`MaxThreadsInOneTask`](max-threads-in-one-task.html) | The maximum threads in one barcode reading task. |

## Barcode Format & Result

| Parameter | Description |
|:----------|:------------|
| [`BarcodeFormatIds`](barcode-format-ids.html) | The target barcode formats to read. |
| [`BarcodeFormatSpecificationNameArray`](barcode-format-specification-name-array.html) | The names of BarcodeFormatSpecification objects to reference. |
| [`ExpectedBarcodesCount`](expected-barcodes-count.html) | The expected number of barcodes to read. |
| [`ReturnBarcodeZoneClarity`](return-barcode-zone-clarity.html) | Whether to return the clarity of the barcode zone. |
| [`TextResultOrderModes`](text-result-order-modes.html) | The order modes for text results. |
| [`BarcodeComplementModes`](barcode-complement-modes.html) | The modes for complementing incomplete barcodes. |
| [`BarcodeScaleModes`](barcode-scale-modes.html) | The modes for scaling barcodes. |

## Processing Modes

| Parameter | Description |
|:----------|:------------|
| [`LocalizationModes`](localization-modes.html) | The modes for barcode localization. |
| [`DeblurModes`](deblur-modes.html) | The modes for deblurring barcode zones. |
| [`DeformationResistingModes`](deformation-resisting-modes.html) | The modes for resisting barcode deformation. |
| [`DPMCodeReadingModes`](dpm-code-reading-modes.html) | The modes for reading DPM (Direct Part Marking) codes. |

## Section & Stage Configuration

| Parameter | Description |
|:----------|:------------|
| [`SectionArray`](section-array.html) | The sections of the barcode reading task. |
| [`SectionRegionPredetection`](section-region-predetection.html) | Region predetection section settings. |
| [`SectionBarcodeLocalization`](section-barcode-localization.html) | Barcode localization section settings. |
| [`SectionBarcodeDecoding`](section-barcode-decoding.html) | Barcode decoding section settings. |
| [`StagePredetectRegions`](stage-predetect-regions.html) | Stage for predetecting regions. |
| [`StageLocalizeCandidateBarcodes`](stage-localize-candidate-barcodes.html) | Stage for localizing candidate barcodes. |
| [`StageLocalizeBarcodes`](stage-localize-barcodes.html) | Stage for localizing barcodes. |
| [`StageScaleBarcodeImage`](stage-scale-barcode-image.html) | Stage for scaling barcode images. |
| [`StageResistDeformation`](stage-resist-deformation.html) | Stage for resisting deformation. |
| [`StageComplementBarcode`](stage-complement-barcode.html) | Stage for complementing barcodes. |
| [`StageDecodeBarcodes`](stage-decode-barcodes.html) | Stage for decoding barcodes. |
24 changes: 24 additions & 0 deletions parameters/reference/capture-vision-template/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
layout: default-layout
title: CaptureVisionTemplate Parameters - Dynamsoft Capture Vision
description: Reference index for CaptureVisionTemplate parameters in Dynamsoft Capture Vision, the entry object of a parameter template that coordinates image sources, ROI processing, and semantic processing.
keywords: CaptureVisionTemplate, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# CaptureVisionTemplate Parameters

The `CaptureVisionTemplate` object is the entry object of a parameter template in Dynamsoft Capture Vision. It coordinates image sources, ROI processing, and semantic processing tasks.

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the CaptureVisionTemplate object. |
| [`ImageSourceName`](image-source-name.html) | The name of the ImageSource object to use. |
| [`ImageROIProcessingNameArray`](image-roi-processing-name-array.html) | The names of TargetROIDef objects for ROI processing. |
| [`SemanticProcessingNameArray`](semantic-processing-name-array.html) | The names of SemanticProcessing objects for semantic processing. |
| [`MaxParallelTasks`](max-parallel-tasks.html) | The maximum number of parallel tasks. |
| [`MinImageCaptureInterval`](min-image-capture-interval.html) | The minimum interval between image captures. |
| [`OutputOriginalImage`](output-original-Image.html) | Whether to output the original image. |
| [`Timeout`](timeout.html) | The timeout for each capture. |
19 changes: 19 additions & 0 deletions parameters/reference/code-parser-task-settings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: default-layout
title: CodeParserTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for CodeParserTaskSetting parameters in Dynamsoft Capture Vision, which configure code parsing tasks such as passport MRZ, driving license, and other structured data.
keywords: CodeParserTaskSetting, code parser, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# CodeParserTaskSetting Parameters

The `CodeParserTaskSetting` object configures code parsing tasks such as passport MRZ, driving license, and other structured data parsing in Dynamsoft Capture Vision.

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the CodeParserTaskSetting object. |
| [`CodeSpecifications`](code-specifications.html) | The code specifications for parsing. |
| [`ResourcesPath`](resources-path.html) | The path to the resources directory for code parsing. |
58 changes: 58 additions & 0 deletions parameters/reference/document-normalizer-task-settings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: default-layout
title: DocumentNormalizerTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for DocumentNormalizerTaskSetting parameters in Dynamsoft Capture Vision, including document detection, deskewing, image enhancement, and normalization settings.
keywords: DocumentNormalizerTaskSetting, document normalizer, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# DocumentNormalizerTaskSetting Parameters

The `DocumentNormalizerTaskSetting` object configures the settings for document detection and normalization in Dynamsoft Capture Vision.

## General

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the DocumentNormalizerTaskSetting object. |
| [`BaseDocumentNormalizerTaskSettingName`](base-document-normalizer-task-setting-name.html) | The name of another DocumentNormalizerTaskSetting to inherit from. |
| [`MaxThreadsInOneTask`](max-threads-in-one-task.html) | The maximum threads in one task. |
| [`ExpectedDocumentsCount`](expected-documents-count.html) | The expected number of documents to detect. |

## Document Properties

| Parameter | Description |
|:----------|:------------|
| [`ContentType`](content-type.html) | The content type of the document. |
| [`ColourMode`](colour-mode.html) | The colour mode for the normalized image. |
| [`Brightness`](brightness.html) | The brightness of the normalized image. |
| [`Contrast`](contrast.html) | The contrast of the normalized image. |
| [`PageSize`](page-size.html) | The page size for normalization. |
| [`CornerAngleRange`](corner-angle-range.html) | The acceptable corner angle range for document detection. |
| [`DeskewMode`](deskew-mode.html) | The mode for deskewing the document. |

## Detection Modes

| Parameter | Description |
|:----------|:------------|
| [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.html) | The modes for detecting document quadrilaterals. |

## Section & Stage Configuration

| Parameter | Description |
|:----------|:------------|
| [`SectionArray`](section-array.html) | The sections of the document normalizer task. |
| [`SectionRegionsPredetection`](section-regions-predetection.html) | Region predetection section settings. |
| [`SectionDocumentDetection`](section-document-detection.html) | Document detection section settings. |
| [`SectionDocumentDeskewing`](section-document-deskewing.html) | Document deskewing section settings. |
| [`SectionImageEnhancement`](section-image-enhancement.html) | Image enhancement section settings. |
| [`StagePredetectRegions`](stage-predetect-regions.html) | Stage for predetecting regions. |
| [`StageDetectCorners`](stage-detect-corners.html) | Stage for detecting corners. |
| [`StageDetectEdges`](stage-detect-edges.html) | Stage for detecting edges. |
| [`StageDetectQuads`](stage-detect-quads.html) | Stage for detecting quadrilaterals. |
| [`StageAssembleLongLines`](stage-assemble-long-lines.html) | Stage for assembling long lines. |
| [`StageAssembleLogicalLines`](stage-assemble-logical-lines.html) | Stage for assembling logical lines. |
| [`StageDeskewImage`](stage-deskew-image.html) | Stage for deskewing the image. |
| [`StageEnhanceImage`](stage-enhance-image.html) | Stage for enhancing the image. |
56 changes: 56 additions & 0 deletions parameters/reference/image-parameter/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
layout: default-layout
title: ImageParameter Parameters - Dynamsoft Capture Vision
description: Reference index for ImageParameter parameters in Dynamsoft Capture Vision, covering image processing stages including grayscale conversion, binarization, texture detection, text zone detection, and shortline detection.
keywords: ImageParameter, image processing, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# ImageParameter Parameters

The `ImageParameter` object configures parameters for image processing stages in Dynamsoft Capture Vision, including grayscale conversion, enhancement, binarization, texture detection, and more.

## General

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the ImageParameter object. |
| [`BaseImageParameterName`](base-image-parameter-name.html) | The name of another ImageParameter to inherit from. |
| [`ApplicableStages`](applicable-stages.html) | The stages that this ImageParameter applies to. |

## Processing Modes

| Parameter | Description |
|:----------|:------------|
| [`BinarizationModes`](binarization-modes.html) | The modes for image binarization. |
| [`ColourConversionModes`](colour-conversion-modes.html) | The modes for colour-to-grayscale conversion. |
| [`GrayscaleEnhancementModes`](grayscale-enhancement-modes.html) | The modes for grayscale enhancement. |
| [`GrayscaleTransformationModes`](grayscale-transformation-modes.html) | The modes for grayscale transformation. |
| [`RegionPredetectionModes`](region-predetection-modes.html) | The modes for region predetection. |
| [`TextDetectionMode`](text-detection-mode.html) | The mode for text detection. |
| [`TextureDetectionModes`](texture-detection-modes.html) | The modes for texture detection. |
| [`ShortlineDetectionMode`](shortline-detection-mode.html) | The mode for shortline detection. |
| [`LineAssemblyMode`](line-assembly-mode.html) | The mode for line assembly. |
| [`IfEraseTextZone`](if-erase-text-zone.html) | Whether to erase text zones. |
| [`ImageScaleSettings`](image-scale-settings.html) | The settings for image scaling. |

## Stage Configuration

| Parameter | Description |
|:----------|:------------|
| [`StageInputColorImage`](stage-input-color-image.html) | Stage for inputting color images. |
| [`StageConvertToGrayscale`](stage-convert-to-grayscale.html) | Stage for converting to grayscale. |
| [`StageTransformGrayscale`](stage-transform-grayscale.html) | Stage for transforming grayscale. |
| [`StageEnhanceGrayscale`](stage-enhance-grayscale.html) | Stage for enhancing grayscale. |
| [`StageBinarizeImage`](stage-binarize-image.html) | Stage for binarizing images. |
| [`StageDetectTexture`](stage-detect-texture.html) | Stage for detecting texture. |
| [`StageRemoveTextureFromGrayscale`](stage-remove-texture-from-grayscale.html) | Stage for removing texture from grayscale. |
| [`StageBinarizeTextureRemovedGrayscale`](stage-binarize-texture-removed-grayscale.html) | Stage for binarizing texture-removed grayscale. |
| [`StageDetectTextZones`](stage-detect-text-zones.html) | Stage for detecting text zones. |
| [`StageRemoveTextZonesFromBinary`](stage-remove-text-zones-from-binary.html) | Stage for removing text zones from binary. |
| [`StageDetectShortlines`](stage-detect-shortlines.html) | Stage for detecting shortlines. |
| [`StageFindContours`](stage-find-contours.html) | Stage for finding contours. |
| [`StageAssembleLines`](stage-assemble-lines.html) | Stage for assembling lines. |
| [`StageScaleImage`](stage-scale-image.html) | Stage for scaling images. |
23 changes: 23 additions & 0 deletions parameters/reference/image-source-options/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default-layout
title: ImageSourceOptions Parameters - Dynamsoft Capture Vision
description: Reference index for ImageSourceOptions parameters in Dynamsoft Capture Vision, which configure image input sources such as directories, scanners, and cameras.
keywords: ImageSourceOptions, image source, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# ImageSourceOptions Parameters

The `ImageSourceOptions` object defines the input source for Dynamsoft Capture Vision, including image directories, scanners, cameras, and other sources.

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the ImageSourceOptions object. |
| [`Type`](type.html) | The type of image source. |
| [`DirectoryPath`](directory-path.html) | The path to the image directory. |
| [`FileFilter`](file-filter.html) | The file filter for selecting images. |
| [`Recursive`](recursive.html) | Whether to search subdirectories recursively. |
| [`Pages`](pages.html) | The pages to process from multi-page files. |
| [`PDFReadingMode`](pdf-reading-mode.html) | The mode for reading PDF files. |
55 changes: 55 additions & 0 deletions parameters/reference/label-recognizer-task-settings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
layout: default-layout
title: LabelRecognizerTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for LabelRecognizerTaskSetting parameters in Dynamsoft Capture Vision, including text line localization, recognition, dictionary correction, and confusable characters settings.
keywords: LabelRecognizerTaskSetting, label recognizer, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# LabelRecognizerTaskSetting Parameters

The `LabelRecognizerTaskSetting` object configures settings for label recognition tasks in Dynamsoft Capture Vision, including text line localization, recognition, and correction.

## General

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the LabelRecognizerTaskSetting object. |
| [`BaseLabelRecognizerTaskSettingName`](base-label-recognizer-task-setting-name.html) | The name of another LabelRecognizerTaskSetting to inherit from. |
| [`MaxThreadsInOneTask`](max-threads-in-one-task.html) | The maximum threads in one task. |

## Text Recognition Settings

| Parameter | Description |
|:----------|:------------|
| [`TextLineSpecificationNameArray`](text-line-specification-name-array.html) | The names of TextLineSpecification objects to reference. |
| [`StringLengthRange`](string-length-range.html) | The expected string length range. |
| [`StringRegexPattern`](string-regex-pattern.html) | The regex pattern for validating recognized strings. |
| [`DictionaryPath`](dictionary-path.html) | The path to the dictionary file. |
| [`DictionaryCorrectionThresholds`](dictionary-correction-thresholds.html) | The thresholds for dictionary-based correction. |
| [`ConfusableCharactersPath`](confusable-characters-path.html) | The path to confusable characters definition. |
| [`OverlappingCharactersPath`](overlapping-characters-path.html) | The path to overlapping characters definition. |
| [`ClusterSamplesCountThreshold`](cluster-samples-count-threshold.html) | The threshold for cluster samples count. |
| [`EnableRegexForceCorrection`](enable-regex-force-correction.html) | Whether to enable regex-based force correction. |

## Processing Modes

| Parameter | Description |
|:----------|:------------|
| [`LocalizationModes`](localization-modes.html) | The modes for text line localization. |
| [`OrientationDetectionModes`](orientation-detection-modes.html) | The modes for orientation detection. |

## Section & Stage Configuration

| Parameter | Description |
|:----------|:------------|
| [`SectionArray`](section-array.html) | The sections of the label recognizer task. |
| [`SectionRegionsPredetection`](section-regions-predetection.html) | Region predetection section settings. |
| [`SectionTextLinesLocalization`](section-text-lines-localization.html) | Text line localization section settings. |
| [`SectionTextLinesRecognition`](section-text-lines-recognition.html) | Text line recognition section settings. |
| [`StagePredetectRegions`](stage-predetect-regions.html) | Stage for predetecting regions. |
| [`StageLocalizeTextLines`](stage-localize-text-lines.html) | Stage for localizing text lines. |
| [`StageAssembleTextLines`](stage-assemble-text-lines.html) | Stage for assembling text lines. |
| [`StageRecognizeRawTextLines`](stage-recognize-raw-text-lines.html) | Stage for recognizing raw text lines. |
18 changes: 18 additions & 0 deletions parameters/reference/output-task-setting/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default-layout
title: OutputTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for OutputTaskSetting parameters in Dynamsoft Capture Vision, which configure how to output expected results by filtering descendant TargetROIDef results.
keywords: OutputTaskSetting, output, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# OutputTaskSetting Parameters

The `OutputTaskSetting` object configures how to output the expected results of a `TargetROIDef` by filtering the results of descendant `TargetROIDef` objects.

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the OutputTaskSetting object. |
| [`OutputCondition`](output-condition.html) | The condition for outputting results. |
22 changes: 22 additions & 0 deletions parameters/reference/target-roi-def/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: default-layout
title: TargetROIDef Parameters - Dynamsoft Capture Vision
description: Reference index for TargetROIDef parameters in Dynamsoft Capture Vision, which specify regions of interest (ROIs) within an image and the recognition tasks to perform on them.
keywords: TargetROIDef, ROI, region of interest, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# TargetROIDef Parameters

The `TargetROIDef` object specifies one or more recognition tasks to be performed on regions of interest (ROIs) within an image.

| Parameter | Description |
|:----------|:------------|
| [`Name`](name.html) | The unique name of the TargetROIDef object. |
| [`BaseTargetROIDefName`](base-target-roidef-name.html) | The name of another TargetROIDef to inherit from. |
| [`Location`](location.html) | The location definition of the target ROI. |
| [`TaskSettingNameArray`](task-setting-name-array.html) | The names of task setting objects to apply. |
| [`PauseFlag`](pause-flag.html) | Whether to pause processing at this ROI. |
| [`EnableResultsDeduplication`](enable-results-deduplication.html) | Whether to enable deduplication of results. |
Loading