diff --git a/parameters/reference/barcode-format-specification/index.md b/parameters/reference/barcode-format-specification/index.md new file mode 100644 index 0000000..99890ff --- /dev/null +++ b/parameters/reference/barcode-format-specification/index.md @@ -0,0 +1,84 @@ +--- +layout: default-layout +title: BarcodeFormatSpecification Parameters - Dynamsoft Capture Vision +description: Reference index for BarcodeFormatSpecification object in Dynamsoft Capture Vision parameters, which defines format-specific decoding rules and constraints. +keywords: BarcodeFormatSpecification, barcode format, parameter reference +needAutoGenerateSidebar: true +noTitleIndex: true +needGenerateH3Content: true +--- + +# BarcodeFormatSpecification Parameters + +The `BarcodeFormatSpecification` object defines format-specific decoding rules and constraints used by barcode reading tasks. + +## Example JSON + +```json +{ + "BarcodeFormatSpecificationOptions": [ + { + "Name": "BFS_0", + "BarcodeFormatIds": ["BF_QR_CODE"], + "ExpectedBarcodesCount": 512, + "MirrorMode": "MM_NORMAL", + "MinResultConfidence": 30 + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `BarcodeFormatSpecification` object inside `BarcodeFormatSpecificationOptions`. + +```text +BarcodeFormatSpecification +├── Name +├── BarcodeFormatIds +└── Format-specific parameters like ExpectedBarcodesCount +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the `BarcodeFormatSpecification` object. | +| [`BarcodeFormatIds`](barcode-format-ids.md) | Specifies which barcode format(s) this specification applies to. | +| [`ExpectedBarcodesCount`](expected-barcodes-count.md) | Expected number of barcodes to decode. | +| [`MirrorMode`](mirror-mode.md) | Controls barcode mirroring handling. | +| [`MinResultConfidence`](min-result-confidence.md) | Minimum confidence threshold for accepted results. | +| [`StandardFormat`](standard-format.md) | Indicates whether standard format constraints are applied. | +| [`PartitionModes`](partition-modes.md) | Defines partitioning strategies during decoding. | +| [`VerifyCheckDigit`](verify-check-digit.md) | Defines whether to verify check digits. | +| [`IncludeTrailingCheckDigit`](include-trailing-check-digit.md) | Defines whether to include trailing check digits in text results. | +| [`IncludeImpliedAI01`](include-implied-ai01.md) | Defines whether to include implied AI(01) for GS1 parsing. | +| [`Code128Subset`](code128-subset.md) | Specifies the subset strategy for Code 128 decoding. | +| [`MsiCodeCheckDigitCalculation`](msi-code-check-digit-calculation.md) | Specifies MSI check digit calculation rules. | +| [`RequireStartStopChars`](require-start-stop-chars.md) | Defines whether start/stop characters are required. | +| [`EnableAddOnCode`](enable-addon-code.md) | Defines whether add-on codes are decoded with primary barcodes. | +| [`EnableDataMatrixECC000140`](enable-data-matrix-ecc000-140.md) | Defines whether DataMatrix ECC000-140 variants are enabled. | +| [`DataMatrixModuleIsotropic`](data-matrix-module-isotropic.md) | Controls isotropic module assumption for DataMatrix. | +| [`DataMatrixSizeOptions`](data-matrix-size-options.md) | Specifies acceptable DataMatrix symbol size options. | +| [`EnableQRCodeModel1`](enable-qr-code-model-1.md) | Defines whether QR Code Model 1 decoding is enabled. | +| [`AustralianPostEncodingTable`](australian-post-encoding-table.md) | Specifies encoding table selection for Australian Post barcodes. | +| [`ReturnPartialBarcodeValue`](return-partial-barcode-value.md) | Defines whether partial barcode values can be returned. | +| [`FindUnevenModuleBarcode`](find-uneven-module-barcode.md) | Defines whether to detect barcodes with uneven modules. | +| [`AutoDetectColorInversion`](auto-detect-color-inversion.md) | Defines whether to auto-detect foreground/background inversion. | +| [`HasVerticalQuietZone`](has-vertical-quietzone.md) | Defines whether vertical quiet zone is required/assumed. | +| [`HeadModuleRatio`](head-module-ratio.md) | Defines ratio constraints for leading modules. | +| [`TailModuleRatio`](tail-module-ratio.md) | Defines ratio constraints for trailing modules. | +| [`MinQuietZoneWidth`](min-quiet-zone-width.md) | Minimum quiet-zone width requirement. | +| [`MinRatioOfBarcodeZoneWidthToHeight`](min-ratio-of-barcode-zone-width-to-height.md) | Minimum width-to-height ratio for barcode zones. | +| [`BarcodeZoneMinDistanceToImageBorders`](barcode-zone-min-distance-to-image-borders.md) | Minimum distance from barcode zone to image borders. | +| [`BarcodeZoneWidthToHeightRatioRangeArray`](barcode-zone-width-to-height-ratio-range-array.md) | Acceptable barcode-zone width/height ratio range(s). | +| [`BarcodeZoneBarCountRangeArray`](barcode-zone-bar-count-range-array.md) | Acceptable barcode bar-count range(s). | +| [`BarcodeWidthRangeArray`](barcode-width-range-array.md) | Acceptable barcode width range(s). | +| [`BarcodeHeightRangeArray`](barcode-height-range-array.md) | Acceptable barcode height range(s). | +| [`BarcodeAngleRangeArray`](barcode-angle-range-array.md) | Acceptable barcode angle range(s). | +| [`BarcodeTextLengthRangeArray`](barcode-text-length-range-array.md) | Acceptable decoded-text length range(s). | +| [`BarcodeBytesLengthRangeArray`](barcode-bytes-length-range-array.md) | Acceptable decoded-byte length range(s). | +| [`BarcodeTextRegexPattern`](barcode-text-regex-pattern.md) | Regex pattern to validate decoded barcode text. | +| [`ModuleSizeRangeArray`](module-size-range-array.md) | Acceptable module-size range(s). | +| [`PatchCodeSearchingMargins`](patch-code-searching-margins.md) | Search margins for Patch Code localization. | +| [`AllModuleDeviation`](all-module-deviation.md) | Allowed deviation threshold for module consistency checks. | diff --git a/parameters/reference/barcode-reader-task-settings/index.md b/parameters/reference/barcode-reader-task-settings/index.md new file mode 100644 index 0000000..3d4ee8c --- /dev/null +++ b/parameters/reference/barcode-reader-task-settings/index.md @@ -0,0 +1,184 @@ +--- +layout: default-layout +title: BarcodeReaderTaskSetting Parameters - Dynamsoft Capture Vision +description: Reference index for BarcodeReaderTaskSetting object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "BarcodeReaderTaskSettingOptions": [ + { + "Name": "BR_0", + "MaxThreadsInOneTask": 4, + "ExpectedBarcodesCount": 512, + "BarcodeFormatIds": ["BF_ALL"], + "BarcodeFormatSpecificationNameArray": null, + "DPMCodeReadingModes": [ + { + "Mode": "DPMCRM_SKIP" + } + ], + "SectionArray": [ + { + "Section": "ST_REGION_PREDETECTION", + "ImageParameterName": "ip_dbrDefault", + "StageArray": [ + { + "Stage": "SST_PREDETECT_REGIONS", + "RegionPredetectionModes": [] + } + ] + }, + { + "Section": "ST_BARCODE_LOCALIZATION", + "ImageParameterName": "ip_dbrDefault", + "StageArray": [ + { + "Stage": "SST_LOCALIZE_CANDIDATE_BARCODES", + "LocalizationModes": [] + }, + { + "Stage": "SST_LOCALIZE_BARCODES" + } + ] + }, + { + "Section": "ST_BARCODE_DECODING", + "ImageParameterName": "ip_dbrDefault", + "StageArray": [ + { + "Stage": "SST_COMPLEMENT_BARCODE", + "BarcodeComplementModes": [] + }, + { + "Stage": "SST_RESIST_DEFORMATION", + "DeformationResistingModes": [] + }, + { + "Stage": "SST_SCALE_BARCODE_IMAGE", + "BarcodeScaleModes": [] + }, + { + "Stage": "SST_DECODE_BARCODES", + "DeblurModes": [], + "ReturnBarcodeZoneClarity": 0 + } + ] + } + ], + "TextResultOrderModes": [ + { + "Mode": "TROM_CONFIDENCE" + } + ], + "BaseBarcodeReaderTaskSettingName": "" + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `BarcodeReaderTaskSetting` object inside `BarcodeReaderTaskSettingOptions`. + +```text +BarcodeReaderTaskSetting +├── Name +├── MaxThreadsInOneTask +├── ExpectedBarcodesCount +├── BarcodeFormatIds +├── BarcodeFormatSpecificationNameArray +├── DPMCodeReadingModes +├── TextResultOrderModes +├── BaseBarcodeReaderTaskSettingName +└── SectionArray[] + ├── item (Section = ST_REGION_PREDETECTION) + │ ├── Section + │ ├── ImageParameterName + │ └── StageArray[] + │ └── item (Stage = SST_PREDETECT_REGIONS) + │ ├── Stage + │ └── RegionPredetectionModes + ├── item (Section = ST_BARCODE_LOCALIZATION) + │ ├── Section + │ ├── ImageParameterName + │ └── StageArray[] + │ ├── item (Stage = SST_LOCALIZE_CANDIDATE_BARCODES) + │ │ ├── Stage + │ │ └── LocalizationModes + │ └── item (Stage = SST_LOCALIZE_BARCODES) + │ └── Stage + └── item (Section = ST_BARCODE_DECODING) + ├── Section + ├── ImageParameterName + └── StageArray[] + ├── item (Stage = SST_RESIST_DEFORMATION) + │ ├── Stage + │ └── DeformationResistingModes + ├── item (Stage = SST_COMPLEMENT_BARCODE) + │ ├── Stage + │ └── BarcodeComplementModes + ├── item (Stage = SST_SCALE_BARCODE_IMAGE) + │ ├── Stage + │ └── BarcodeScaleModes + └── item (Stage = SST_DECODE_BARCODES) + ├── Stage + ├── DeblurModes + └── ReturnBarcodeZoneClarity +``` + +> [!IMPORTANT] +> `Stage` values are constrained by the parent `Section` value, and stage-scoped parameters are constrained by the `Stage` value. + +## Top-Level Parameters + +| Parameter Name | Description | +| -------------- | ----------- | +| [`Name`](name.md) | The unique identifier for this `BarcodeReaderTaskSetting` object. | +| [`BarcodeFormatIds`](barcode-format-ids.md) | Specifies which barcode formats to read. | +| [`BarcodeFormatSpecificationNameArray`](barcode-format-specification-name-array.md) | Names of referenced `BarcodeFormatSpecification` objects for format-specific settings. | +| [`ExpectedBarcodesCount`](expected-barcodes-count.md) | Expected number of barcodes to detect per image. | +| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | Maximum number of parallel threads for this task. | +| [`SectionArray`](section-array.md) | Defines processing sections (region predetection, localization, decoding) and their stages. | +| [`DPMCodeReadingModes`](dpm-code-reading-modes.md) | Modes and priority for reading Direct Part Mark (DPM) codes. | +| [`TextResultOrderModes`](text-result-order-modes.md) | Order in which barcode results are returned. | +| [`BaseBarcodeReaderTaskSettingName`](base-barcode-reader-task-setting-name.md) | Name of another `BarcodeReaderTaskSetting` object to inherit parameters from. | + +## Nested Parameter Quick Links + +### Actual Nested Parameters in the Tree + +| Parameter Name | Description | +|:--------------|:------------| +| [`RegionPredetectionModes`](../image-parameter/region-predetection-modes.md) | Controls how to find a region of interest (ROI) within the image or frame. | +| [`LocalizationModes`](localization-modes.md) | Determines how to localize barcodes. | +| [`DeformationResistingModes`](deformation-resisting-modes.md) | Defines how to handle distorted and deformed barcodes. | +| [`BarcodeComplementModes`](barcode-complement-modes.md) | Defines how to complement the missing parts of a barcode. | +| [`BarcodeScaleModes`](barcode-scale-modes.md) | Defines the scaling mode applied during barcode recognition. | +| [`DeblurModes`](deblur-modes.md) | Defines the mode and priority for deblurring. | +| [`ReturnBarcodeZoneClarity`](return-barcode-zone-clarity.md) | Defines whether to return the clarity of the barcode zone. | + +### Conceptual Section/Stage Objects + +| Object | Description | +|:-------|:------------| +| [`SectionRegionPredetection`](section-region-predetection.md) | Section object for `Section = ST_REGION_PREDETECTION`. | +| [`StagePredetectRegions`](stage-predetect-regions.md) | Stage object under `Section = ST_REGION_PREDETECTION` with `Stage = SST_PREDETECT_REGIONS`. | +| [`SectionBarcodeLocalization`](section-barcode-localization.md) | Section object for `Section = ST_BARCODE_LOCALIZATION`. | +| [`StageLocalizeCandidateBarcodes`](stage-localize-candidate-barcodes.md) | Stage object under `Section = ST_BARCODE_LOCALIZATION` with `Stage = SST_LOCALIZE_CANDIDATE_BARCODES`. | +| [`StageLocalizeBarcodes`](stage-localize-barcodes.md) | Stage object under `Section = ST_BARCODE_LOCALIZATION` with `Stage = SST_LOCALIZE_BARCODES`. | +| [`SectionBarcodeDecoding`](section-barcode-decoding.md) | Section object for `Section = ST_BARCODE_DECODING`. | +| [`StageResistDeformation`](stage-resist-deformation.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_RESIST_DEFORMATION`. | +| [`StageComplementBarcode`](stage-complement-barcode.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_COMPLEMENT_BARCODE`. | +| [`StageScaleBarcodeImage`](stage-scale-barcode-image.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_SCALE_BARCODE_IMAGE`. | +| [`StageDecodeBarcodes`](stage-decode-barcodes.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_DECODE_BARCODES`. | diff --git a/parameters/reference/capture-vision-template/index.md b/parameters/reference/capture-vision-template/index.md new file mode 100644 index 0000000..f19aab8 --- /dev/null +++ b/parameters/reference/capture-vision-template/index.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: CaptureVisionTemplate Parameters - Dynamsoft Capture Vision +description: Reference index for CaptureVisionTemplate object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "CaptureVisionTemplates": [ + { + "Name": "CV_0", + "ImageSourceName": "ISA_0", + "ImageROIProcessingNameArray": ["TA_0"], + "SemanticProcessingNameArray": ["SP_0"], + "OutputOriginalImage": 0, + "MaxParallelTasks": 4, + "MinImageCaptureInterval": 0, + "Timeout": 500 + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `CaptureVisionTemplate` object inside `CaptureVisionTemplates`. + +```text +CaptureVisionTemplate +├── Name +├── ImageSourceName +├── ImageROIProcessingNameArray +├── SemanticProcessingNameArray +├── OutputOriginalImage +├── MaxParallelTasks +├── MinImageCaptureInterval +└── Timeout +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the CaptureVisionTemplate object. | +| [`ImageSourceName`](image-source-name.md) | The name of the ImageSource object to use. | +| [`ImageROIProcessingNameArray`](image-roi-processing-name-array.md) | The names of TargetROIDef objects for ROI processing. | +| [`SemanticProcessingNameArray`](semantic-processing-name-array.md) | The names of SemanticProcessing objects for semantic processing. | +| [`OutputOriginalImage`](output-original-Image.md) | Whether to output the original image. | +| [`MaxParallelTasks`](max-parallel-tasks.md) | The maximum number of parallel tasks. | +| [`MinImageCaptureInterval`](min-image-capture-interval.md) | The minimum interval between image captures. | +| [`Timeout`](timeout.md) | The timeout for each capture. | + + diff --git a/parameters/reference/code-parser-task-settings/index.md b/parameters/reference/code-parser-task-settings/index.md new file mode 100644 index 0000000..d41107b --- /dev/null +++ b/parameters/reference/code-parser-task-settings/index.md @@ -0,0 +1,48 @@ +--- +layout: default-layout +title: CodeParserTaskSetting Parameters - Dynamsoft Capture Vision +description: Reference index for CodeParserTaskSetting object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "CodeParserTaskSettingOptions": [ + { + "Name": "CPT1_PARSE_VIN", + "CodeSpecifications": ["VIN"], + "ResourcesPath": "../VIN/" + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `CodeParserTaskSetting` object inside `CodeParserTaskSettingOptions`. + +```text +CodeParserTaskSetting +├── Name +├── CodeSpecifications +└── ResourcesPath +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the CodeParserTaskSetting object. | +| [`CodeSpecifications`](code-specifications.md) | The code specifications for parsing. | +| [`ResourcesPath`](resources-path.md) | The path to the resources directory for code parsing. | + + diff --git a/parameters/reference/document-normalizer-task-settings/index.md b/parameters/reference/document-normalizer-task-settings/index.md new file mode 100644 index 0000000..fc90eb2 --- /dev/null +++ b/parameters/reference/document-normalizer-task-settings/index.md @@ -0,0 +1,194 @@ +--- +layout: default-layout +title: DocumentNormalizerTaskSetting Parameters - Dynamsoft Capture Vision +description: Reference index for DocumentNormalizerTaskSetting object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "DocumentNormalizerTaskSettingOptions": [ + { + "Name": "ddn_task_default", + "MaxThreadsInOneTask": 4, + "ExpectedDocumentsCount": 1, + "BaseDocumentNormalizerTaskSettingName": "", + "SectionArray": [ + { + "Section": "ST_REGION_PREDETECTION", + "ImageParameterName": "ip_default", + "StageArray": [ + { + "Stage": "SST_PREDETECT_REGIONS", + "RegionPredetectionModes": [] + } + ] + }, + { + "Section": "ST_DOCUMENT_DETECTION", + "ContentType": "CT_DOCUMENT", + "ImageParameterName": "ip_default", + "StageArray": [ + { "Stage": "SST_ASSEMBLE_LONG_LINES" }, + { "Stage": "SST_ASSEMBLE_LOGICAL_LINES" }, + { + "Stage": "SST_DETECT_CORNERS", + "CornerAngleRange": { + "MaxValue": 110, + "MinValue": 70 + } + }, + { "Stage": "SST_DETECT_EDGES" }, + { + "Stage": "SST_DETECT_QUADS", + "QuadrilateralDetectionModes": [ + { + "Mode": "QDM_GENERAL" + } + ] + } + ] + }, + { + "Section": "ST_DOCUMENT_DESKEWING", + "ImageParameterName": "ip_default", + "StageArray": [ + { + "Stage": "SST_DESKEW_IMAGE", + "DeskewMode": { + "ContentDirection": 0, + "Mode": "DSM_PERSPECTIVE_CORRECTION" + }, + "PageSize": [-1, -1] + } + ] + }, + { + "Section": "ST_IMAGE_ENHANCEMENT", + "ImageParameterName": "ip_0", + "StageArray": [ + { + "Stage": "SST_ENHANCE_IMAGE", + "ColourMode": "ICM_COLOUR", + "Brightness": 0, + "Contrast": 0 + } + ] + } + ] + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `DocumentNormalizerTaskSetting` object inside `DocumentNormalizerTaskSettingOptions`. + +```text +DocumentNormalizerTaskSetting +├── Name +├── MaxThreadsInOneTask +├── ExpectedDocumentsCount +├── BaseDocumentNormalizerTaskSettingName +└── SectionArray[] + ├── item (Section = ST_REGION_PREDETECTION) + │ ├── Section + │ ├── ImageParameterName + │ └── StageArray[] + │ └── item (Stage = SST_PREDETECT_REGIONS) + │ ├── Stage + │ └── RegionPredetectionModes + ├── item (Section = ST_DOCUMENT_DETECTION) + │ ├── Section + │ ├── ContentType + │ ├── ImageParameterName + │ └── StageArray[] + │ ├── item (Stage = SST_ASSEMBLE_LONG_LINES) + │ │ └── Stage + │ ├── item (Stage = SST_ASSEMBLE_LOGICAL_LINES) + │ │ └── Stage + │ ├── item (Stage = SST_DETECT_CORNERS) + │ │ ├── Stage + │ │ └── CornerAngleRange + │ ├── item (Stage = SST_DETECT_EDGES) + │ │ └── Stage + │ └── item (Stage = SST_DETECT_QUADS) + │ ├── Stage + │ └── QuadrilateralDetectionModes + ├── item (Section = ST_DOCUMENT_DESKEWING) + │ ├── Section + │ ├── ImageParameterName + │ └── StageArray[] + │ └── item (Stage = SST_DESKEW_IMAGE) + │ ├── Stage + │ ├── DeskewMode + │ └── PageSize + └── item (Section = ST_IMAGE_ENHANCEMENT) + ├── Section + ├── ImageParameterName + └── StageArray[] + └── item (Stage = SST_ENHANCE_IMAGE) + ├── Stage + ├── ColourMode + ├── Brightness + └── Contrast +``` + +> [!IMPORTANT] +> `Stage` values are constrained by the parent `Section` value, and stage-scoped parameters are constrained by the `Stage` value. + + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the DocumentNormalizerTaskSetting object. | +| [`BaseDocumentNormalizerTaskSettingName`](base-document-normalizer-task-setting-name.md) | The name of another DocumentNormalizerTaskSetting to inherit from. | +| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | The maximum threads in one task. | +| [`ExpectedDocumentsCount`](expected-documents-count.md) | The expected number of documents to detect. | +| [`SectionArray`](section-array.md) | The sections of the document normalizer task. | + +## Nested Parameter Quick Links + +### Actual Nested Parameters in the Tree + +| Parameter Name | Description | +|:---------------|:------------| +| [`RegionPredetectionModes`](../image-parameter/region-predetection-modes.md) | Controls how to find a region of interest (ROI) within the image or frame. | +| [`ContentType`](content-type.md) | The content type of the document. | +| [`CornerAngleRange`](corner-angle-range.md) | The acceptable corner angle range for document detection. | +| [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.md) | The modes for detecting document quadrilaterals. | +| [`DeskewMode`](deskew-mode.md) | The mode for deskewing the document. | +| [`PageSize`](page-size.md) | The page size for normalization. | +| [`ColourMode`](colour-mode.md) | The colour mode for the normalized image. | +| [`Brightness`](brightness.md) | The brightness of the normalized image. | +| [`Contrast`](contrast.md) | The contrast of the normalized image. | + +### Conceptual Section/Stage Objects + +| Object | Description | +|:-------|:------------| +| [`SectionRegionsPredetection`](section-regions-predetection.md) | Section object for `Section = ST_REGION_PREDETECTION`. | +| [`StagePredetectRegions`](stage-predetect-regions.md) | Stage object under `Section = ST_REGION_PREDETECTION` with `Stage = SST_PREDETECT_REGIONS`. | +| [`SectionDocumentDetection`](section-document-detection.md) | Section object for `Section = ST_DOCUMENT_DETECTION`. | +| [`StageAssembleLongLines`](stage-assemble-long-lines.md) | Stage object under `Section = ST_DOCUMENT_DETECTION` with `Stage = SST_ASSEMBLE_LONG_LINES`. | +| [`StageAssembleLogicalLines`](stage-assemble-logical-lines.md) | Stage object under `Section = ST_DOCUMENT_DETECTION` with `Stage = SST_ASSEMBLE_LOGICAL_LINES`. | +| [`StageDetectCorners`](stage-detect-corners.md) | Stage object under `Section = ST_DOCUMENT_DETECTION` with `Stage = SST_DETECT_CORNERS`. | +| [`StageDetectEdges`](stage-detect-edges.md) | Stage object under `Section = ST_DOCUMENT_DETECTION` with `Stage = SST_DETECT_EDGES`. | +| [`StageDetectQuads`](stage-detect-quads.md) | Stage object under `Section = ST_DOCUMENT_DETECTION` with `Stage = SST_DETECT_QUADS`. | +| [`SectionDocumentDeskewing`](section-document-deskewing.md) | Section object for `Section = ST_DOCUMENT_DESKEWING`. | +| [`StageDeskewImage`](stage-deskew-image.md) | Stage object under `Section = ST_DOCUMENT_DESKEWING` with `Stage = SST_DESKEW_IMAGE`. | +| [`SectionImageEnhancement`](section-image-enhancement.md) | Section object for `Section = ST_IMAGE_ENHANCEMENT`. | +| [`StageEnhanceImage`](stage-enhance-image.md) | Stage object under `Section = ST_IMAGE_ENHANCEMENT` with `Stage = SST_ENHANCE_IMAGE`. | + + diff --git a/parameters/reference/image-parameter/index.md b/parameters/reference/image-parameter/index.md new file mode 100644 index 0000000..0ca8759 --- /dev/null +++ b/parameters/reference/image-parameter/index.md @@ -0,0 +1,117 @@ +--- +layout: default-layout +title: ImageParameter Parameters - Dynamsoft Capture Vision +description: Reference index for ImageParameter object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "ImageParameterOptions": [ + { + "Name": "ip_default", + "BaseImageParameterName": "", + "ApplicableStages": [ + { + "Stage": "SST_CONVERT_TO_GRAYSCALE", + "ColourConversionModes": [] + }, + { + "Stage": "SST_BINARIZE_IMAGE", + "BinarizationModes": [] + }, + { + "Stage": "SST_SCALE_IMAGE", + "ImageScaleSettings": { + "ScaledDownThreshold": 2300, + "ScaledUpThreshold": 500 + } + } + ] + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `ImageParameter` object inside `ImageParameterOptions`. + +`ApplicableStages` defines stage objects. Stage-scoped parameters are constrained by the `Stage` value in each item. + +```text +ImageParameter +├── Name +├── BaseImageParameterName +└── ApplicableStages[] + └── item + ├── Stage + └── stage-scoped parameters + ├── BinarizationModes + ├── ColourConversionModes + ├── GrayscaleEnhancementModes + ├── GrayscaleTransformationModes + ├── RegionPredetectionModes + ├── TextDetectionMode + ├── TextureDetectionModes + ├── ShortlineDetectionMode + ├── LineAssemblyMode + ├── IfEraseTextZone + └── ImageScaleSettings +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the ImageParameter object. | +| [`BaseImageParameterName`](base-image-parameter-name.md) | The name of another ImageParameter to inherit from. | +| [`ApplicableStages`](applicable-stages.md) | The stages that this ImageParameter applies to. | + +## Nested Parameter Quick Links + +### Actual Nested Parameters in the Tree + +| Parameter Name | Description | +|:---------------|:------------| +| [`BinarizationModes`](binarization-modes.md) | The modes for image binarization. | +| [`ColourConversionModes`](colour-conversion-modes.md) | The modes for colour-to-grayscale conversion. | +| [`GrayscaleEnhancementModes`](grayscale-enhancement-modes.md) | The modes for grayscale enhancement. | +| [`GrayscaleTransformationModes`](grayscale-transformation-modes.md) | The modes for grayscale transformation. | +| [`IfEraseTextZone`](if-erase-text-zone.md) | Whether to erase text zones. | +| [`ImageScaleSettings`](image-scale-settings.md) | The settings for image scaling. | +| [`LineAssemblyMode`](line-assembly-mode.md) | The mode for line assembly. | +| [`RegionPredetectionModes`](region-predetection-modes.md) | The modes for region predetection. | +| [`ShortlineDetectionMode`](shortline-detection-mode.md) | The mode for shortline detection. | +| [`TextDetectionMode`](text-detection-mode.md) | The mode for text detection. | +| [`TextureDetectionModes`](texture-detection-modes.md) | The modes for texture detection. | + +### Conceptual Stage Objects + +| Object | Description | +|:-------|:------------| +| [`StageInputColorImage`](stage-input-color-image.md) | Stage object with `Stage = SST_INPUT_COLOR_IMAGE`. | +| [`StageConvertToGrayscale`](stage-convert-to-grayscale.md) | Stage object with `Stage = SST_CONVERT_TO_GRAYSCALE`. | +| [`StageTransformGrayscale`](stage-transform-grayscale.md) | Stage object with `Stage = SST_TRANSFORM_GRAYSCALE`. | +| [`StageEnhanceGrayscale`](stage-enhance-grayscale.md) | Stage object with `Stage = SST_ENHANCE_GRAYSCALE`. | +| [`StageBinarizeImage`](stage-binarize-image.md) | Stage object with `Stage = SST_BINARIZE_IMAGE`. | +| [`StageDetectTexture`](stage-detect-texture.md) | Stage object with `Stage = SST_DETECT_TEXTURE`. | +| [`StageRemoveTextureFromGrayscale`](stage-remove-texture-from-grayscale.md) | Stage object with `Stage = SST_REMOVE_TEXTURE_FROM_GRAYSCALE`. | +| [`StageBinarizeTextureRemovedGrayscale`](stage-binarize-texture-removed-grayscale.md) | Stage object with `Stage = SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`. | +| [`StageDetectTextZones`](stage-detect-text-zones.md) | Stage object with `Stage = SST_DETECT_TEXT_ZONES`. | +| [`StageRemoveTextZonesFromBinary`](stage-remove-text-zones-from-binary.md) | Stage object with `Stage = SST_REMOVE_TEXT_ZONES_FROM_BINARY`. | +| [`StageDetectShortlines`](stage-detect-shortlines.md) | Stage object with `Stage = SST_DETECT_SHORTLINES`. | +| [`StageFindContours`](stage-find-contours.md) | Stage object with `Stage = SST_FIND_CONTOURS`. | +| [`StageAssembleLines`](stage-assemble-lines.md) | Stage object with `Stage = SST_ASSEMBLE_LINES`. | +| [`StageScaleImage`](stage-scale-image.md) | Stage object with `Stage = SST_SCALE_IMAGE`. | + + diff --git a/parameters/reference/image-source-options/index.md b/parameters/reference/image-source-options/index.md new file mode 100644 index 0000000..dc389ae --- /dev/null +++ b/parameters/reference/image-source-options/index.md @@ -0,0 +1,64 @@ +--- +layout: default-layout +title: ImageSourceOptions Parameters - Dynamsoft Capture Vision +description: Reference index for ImageSourceOption object in Dynamsoft Capture Vision parameters, which configure image input sources such as directories, scanners, and cameras. +keywords: ImageSourceOptions, image source, parameter reference +needAutoGenerateSidebar: true +noTitleIndex: true +needGenerateH3Content: true +--- + +# ImageSourceOption Parameters + +The `ImageSourceOption` object defines the input source for Dynamsoft Capture Vision, including image directories, scanners, cameras, and other sources. + +## Example JSON + +```json +{ + "ImageSourceOptions": [ + { + "Name": "DirectoryFetcher_0", + "Type": "IST_DIRECTORY_FETCHER", + "DirectoryPath": "C:\\Users\\Admin\\Pictures\\", + "FileFilter": "", + "Recursive": 1, + "PDFReadingMode": { + "Mode": "PDFRM_RASTER", + "DPI": 300, + "TargetType": "TT_PAGE" + }, + "Pages": [0, 3, 5, 7, 10] + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `ImageSourceOptions` object inside `ImageSourceOptions`. + +```text +ImageSourceOption +├── Name +├── Type +├── DirectoryPath +├── FileFilter +├── Recursive +├── PDFReadingMode +└── Pages +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the `ImageSourceOption` object. | +| [`Type`](type.md) | The type of image source. | +| [`DirectoryPath`](directory-path.md) | The path to the image directory. | +| [`FileFilter`](file-filter.md) | The file filter for selecting images. | +| [`Recursive`](recursive.md) | Whether to search subdirectories recursively. | +| [`PDFReadingMode`](pdf-reading-mode.md) | The mode for reading PDF files. | +| [`Pages`](pages.md) | The pages to process from multi-page files. | + + diff --git a/parameters/reference/label-recognizer-task-settings/index.md b/parameters/reference/label-recognizer-task-settings/index.md new file mode 100644 index 0000000..5c1fdcc --- /dev/null +++ b/parameters/reference/label-recognizer-task-settings/index.md @@ -0,0 +1,160 @@ +--- +layout: default-layout +title: LabelRecognizerTaskSetting Parameters - Dynamsoft Capture Vision +description: Reference index for LabelRecognizerTaskSetting object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "LabelRecognizerTaskSettingOptions": [ + { + "Name": "dlr_task_default", + "MaxThreadsInOneTask": 4, + "TextLineSpecificationNameArray": ["tls_default"], + "BaseLabelRecognizerTaskSettingName": "", + "SectionArray": [ + { + "Section": "ST_REGION_PREDETECTION", + "ImageParameterName": "ip_default", + "StageArray": [ + { + "Stage": "SST_PREDETECT_REGIONS", + "RegionPredetectionModes": [] + } + ] + }, + { + "Section": "ST_TEXT_LINE_LOCALIZATION", + "ImageParameterName": "ip_default", + "StageArray": [ + { + "Stage": "SST_LOCALIZE_TEXT_LINES", + "LocalizationModes": [], + "OrientationDetectionModes": [] + } + ] + }, + { + "Section": "ST_TEXT_LINE_RECOGNITION", + "ImageParameterName": "ip_default", + "StageArray": [ + { + "Stage": "SST_RECOGNIZE_RAW_TEXT_LINES", + "DictionaryPath": "", + "DictionaryCorrectionThresholds": [], + "ConfusableCharactersPath": "ConfusableChars.data", + "ClusterSamplesCountThreshold": 0, + "OverlappingCharactersPath": "OverlappingChars.data", + "EnableRegexForceCorrection": 1 + }, + { + "Stage": "SST_ASSEMBLE_TEXT_LINES", + "StringLengthRange": [3, 200], + "StringRegexPattern": "" + } + ] + } + ] + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `LabelRecognizerTaskSetting` object inside `LabelRecognizerTaskSettingOptions`. + +```text +LabelRecognizerTaskSetting +├── Name +├── MaxThreadsInOneTask +├── TextLineSpecificationNameArray +├── BaseLabelRecognizerTaskSettingName +└── SectionArray[] + ├── item (Section = ST_REGION_PREDETECTION) + │ ├── Section + │ ├── ImageParameterName + │ └── StageArray[] + │ └── item (Stage = SST_PREDETECT_REGIONS) + │ ├── Stage + │ └── RegionPredetectionModes + ├── item (Section = ST_TEXT_LINE_LOCALIZATION) + │ ├── Section + │ ├── ImageParameterName + │ └── StageArray[] + │ └── item (Stage = SST_LOCALIZE_TEXT_LINES) + │ ├── Stage + │ ├── LocalizationModes + │ └── OrientationDetectionModes + └── item (Section = ST_TEXT_LINE_RECOGNITION) + ├── Section + ├── ImageParameterName + └── StageArray[] + ├── item (Stage = SST_RECOGNIZE_RAW_TEXT_LINES) + │ ├── Stage + │ ├── DictionaryPath + │ ├── DictionaryCorrectionThresholds + │ ├── ConfusableCharactersPath + │ ├── ClusterSamplesCountThreshold + │ ├── OverlappingCharactersPath + │ └── EnableRegexForceCorrection + └── item (Stage = SST_ASSEMBLE_TEXT_LINES) + ├── Stage + ├── StringLengthRange + └── StringRegexPattern +``` + +> [!IMPORTANT] +> `Stage` values are constrained by the parent `Section` value, and stage-scoped parameters are constrained by the `Stage` value. + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the LabelRecognizerTaskSetting object. | +| [`BaseLabelRecognizerTaskSettingName`](base-label-recognizer-task-setting-name.md) | The name of another LabelRecognizerTaskSetting to inherit from. | +| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | The maximum threads in one task. | +| [`TextLineSpecificationNameArray`](text-line-specification-name-array.md) | The names of TextLineSpecification objects to reference. | +| [`SectionArray`](section-array.md) | The sections of the label recognizer task. | + +## Nested Parameter Quick Links + +### Actual Nested Parameters in the Tree + +| Parameter Name | Description | +|:---------------|:------------| +| [`RegionPredetectionModes`](../image-parameter/region-predetection-modes.md) | Controls how to find a region of interest (ROI) within the image or frame. | +| [`LocalizationModes`](localization-modes.md) | The modes for text line localization. | +| [`OrientationDetectionModes`](orientation-detection-modes.md) | The modes for orientation detection. | +| [`DictionaryPath`](dictionary-path.md) | The path to the dictionary file. | +| [`DictionaryCorrectionThresholds`](dictionary-correction-thresholds.md) | The thresholds for dictionary-based correction. | +| [`ConfusableCharactersPath`](confusable-characters-path.md) | The path to confusable characters definition. | +| [`ClusterSamplesCountThreshold`](cluster-samples-count-threshold.md) | The threshold for cluster samples count. | +| [`OverlappingCharactersPath`](overlapping-characters-path.md) | The path to overlapping characters definition. | +| [`EnableRegexForceCorrection`](enable-regex-force-correction.md) | Whether to enable regex-based force correction. | +| [`StringLengthRange`](string-length-range.md) | The expected string length range. | +| [`StringRegexPattern`](string-regex-pattern.md) | The regex pattern for validating recognized strings. | + +### Conceptual Section/Stage Objects + +| Object | Description | +|:-------|:------------| +| [`SectionRegionsPredetection`](section-regions-predetection.md) | Section object for `Section = ST_REGION_PREDETECTION`. | +| [`StagePredetectRegions`](stage-predetect-regions.md) | Stage object under `Section = ST_REGION_PREDETECTION` with `Stage = SST_PREDETECT_REGIONS`. | +| [`SectionTextLinesLocalization`](section-text-lines-localization.md) | Section object for `Section = ST_TEXT_LINE_LOCALIZATION`. | +| [`StageLocalizeTextLines`](stage-localize-text-lines.md) | Stage object under `Section = ST_TEXT_LINE_LOCALIZATION` with `Stage = SST_LOCALIZE_TEXT_LINES`. | +| [`SectionTextLinesRecognition`](section-text-lines-recognition.md) | Section object for `Section = ST_TEXT_LINE_RECOGNITION`. | +| [`StageRecognizeRawTextLines`](stage-recognize-raw-text-lines.md) | Stage object under `Section = ST_TEXT_LINE_RECOGNITION` with `Stage = SST_RECOGNIZE_RAW_TEXT_LINES`. | +| [`StageAssembleTextLines`](stage-assemble-text-lines.md) | Stage object under `Section = ST_TEXT_LINE_RECOGNITION` with `Stage = SST_ASSEMBLE_TEXT_LINES`. | + + diff --git a/parameters/reference/output-task-setting/index.md b/parameters/reference/output-task-setting/index.md new file mode 100644 index 0000000..dfa66d5 --- /dev/null +++ b/parameters/reference/output-task-setting/index.md @@ -0,0 +1,54 @@ +--- +layout: default-layout +title: OutputTaskSetting Parameters - Dynamsoft Capture Vision +description: Reference index for OutputTaskSetting object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "OutputTaskSettingOptions": [ + { + "Name": "output_task", + "OutputCondition": { + "TaskResultArray": [ + { + "TargetROIDefName": "B", + "TaskSettingNameArray": ["B_task"], + "Operator": "AND" + } + ], + "Operator": "AND" + } + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `OutputTaskSetting` object inside `OutputTaskSettingOptions`. + +```text +OutputTaskSetting +├── Name +└── OutputCondition +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the OutputTaskSetting object. | +| [`OutputCondition`](output-condition.md) | The condition for outputting results. | + + diff --git a/parameters/reference/semantic-processing/index.md b/parameters/reference/semantic-processing/index.md new file mode 100644 index 0000000..f9f97e6 --- /dev/null +++ b/parameters/reference/semantic-processing/index.md @@ -0,0 +1,50 @@ +--- +layout: default-layout +title: SemanticProcessing Parameters - Dynamsoft Capture Vision +description: Reference index for SemanticProcessing object in Dynamsoft Capture Vision parameters, which defines semantic processing tasks and their input data filters. +keywords: SemanticProcessing, semantic processing, parameter reference +needAutoGenerateSidebar: true +noTitleIndex: true +needGenerateH3Content: true +--- + +# SemanticProcessing Parameters + +The `SemanticProcessing` object specifies tasks to analyze and extract information from image ROI processing results. + +## Example JSON + +```json +{ + "SemanticProcessingOptions": [ + { + "Name": "SP1_PARSE_VIN", + "ReferenceObjectFilter": { + "AtomicResultTypeArray": [ + "ART_BARCODE" + ] + }, + "TaskSettingNameArray": ["CPT1_PARSE_VIN"] + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `SemanticProcessing` object inside `SemanticProcessingOptions`. + +```text +SemanticProcessing +├── Name +├── ReferenceObjectFilter +└── TaskSettingNameArray +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique identifier for this `SemanticProcessing` object. | +| [`ReferenceObjectFilter`](reference-object-filter.md) | Defines filter conditions used to select source results for semantic processing. | +| [`TaskSettingNameArray`](task-setting-name-array.md) | The names of referenced `CodeParserTaskSetting` objects to execute. | diff --git a/parameters/reference/target-roi-def/index.md b/parameters/reference/target-roi-def/index.md new file mode 100644 index 0000000..ba8fd7c --- /dev/null +++ b/parameters/reference/target-roi-def/index.md @@ -0,0 +1,85 @@ +--- +layout: default-layout +title: TargetROIDef Parameters - Dynamsoft Capture Vision +description: Reference index for TargetROIDef object in Dynamsoft Capture Vision parameters, 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. + +## Example JSON + +```json +{ + "TargetROIDefOptions": [ + { + "Name": "roi_a", + "BaseTargetROIDefName": "", + "TaskSettingNameArray": ["dbr_task"], + "PauseFlag": 0, + "EnableResultsDeduplication": 1, + "Location": { + "ReferenceObjectFilter": { + "ReferenceTargetROIDefNameArray": ["roi_root"], + "ReferenceTaskSettingNameArray": ["dbr_root"], + "ReferenceResultType": "RRT_ORIGINAL_IMAGE" + }, + "Offset": { + "MeasuredByPercentage": 1, + "FirstPoint": [0, 0], + "SecondPoint": [100, 100] + } + } + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `TargetROIDef` object inside `TargetROIDefOptions`. + +```text +TargetROIDef +├── Name +├── BaseTargetROIDefName +├── TaskSettingNameArray +├── PauseFlag +├── EnableResultsDeduplication +└── Location + ├── ReferenceObjectFilter + └── Offset +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the TargetROIDef object. | +| [`BaseTargetROIDefName`](base-target-roidef-name.md) | The name of another TargetROIDef to inherit from. | +| [`TaskSettingNameArray`](task-setting-name-array.md) | The names of task setting objects to apply. | +| [`PauseFlag`](pause-flag.md) | Whether to pause processing at this ROI. | +| [`EnableResultsDeduplication`](enable-results-deduplication.md) | Whether to enable deduplication of results. | +| [`Location`](location.md) | The location definition of the target ROI. | + +## Nested Parameter Quick Links + +### Actual Nested Parameters in the Tree + +| Parameter Name | Description | +|:---------------|:------------| +| [`ReferenceObjectFilter`](location/reference-object-filter/index.md) | Filters which reference objects are used when computing the ROI location. | +| [`Offset`](location/offset/index.md) | Defines the offset from the reference object to the target ROI. | + +### Conceptual Location Objects + +| Object | Description | +|:-------|:------------| +| [`Location`](location.md) | Container object that combines reference filtering and offset definition. | + + diff --git a/parameters/reference/target-roi-def/location/offset/index.md b/parameters/reference/target-roi-def/location/offset/index.md index 097e2c5..ccaeb85 100644 --- a/parameters/reference/target-roi-def/location/offset/index.md +++ b/parameters/reference/target-roi-def/location/offset/index.md @@ -25,7 +25,7 @@ Parameter `Offset` is an object that defines how the location is offset from the } ``` -| Name | Description | +| Parameter Name | Description | | ---- | ----------- | | [`ReferenceObjectOriginIndex`](offset-parameter-details.md#referenceobjectoriginindex) | Defines which point of the reference object will be set as the origin of the coordinate system. | | [`ReferenceObjectType`](offset-parameter-details.md#referenceobjecttype) | Defines which coordinate system to use when configuring offset parameters basd on the reference objects. | diff --git a/parameters/reference/target-roi-def/location/reference-object-filter/index.md b/parameters/reference/target-roi-def/location/reference-object-filter/index.md index 0f4ae42..c0e2b9f 100644 --- a/parameters/reference/target-roi-def/location/reference-object-filter/index.md +++ b/parameters/reference/target-roi-def/location/reference-object-filter/index.md @@ -27,7 +27,7 @@ Parameter `ReferenceObjectFilter` is a group of filter conditions for figuring o } ``` -| Name | Description | +| Parameter Name | Description | | ---- | ----------- | | [`ReferenceTargetROIDefNameArray`](reference-object-filter-parameter-details.md#referencetargetroidefnamearray) | Filter the reference object by specifying `TargetROI` names. | | [`AtomicResultTypeArray`](reference-object-filter-parameter-details.md#atomicresulttypearray) | Filter the reference object by specifying the type of atomic results. | diff --git a/parameters/reference/text-line-specification/index.md b/parameters/reference/text-line-specification/index.md new file mode 100644 index 0000000..129c56c --- /dev/null +++ b/parameters/reference/text-line-specification/index.md @@ -0,0 +1,110 @@ +--- +layout: default-layout +title: TextLineSpecification Parameters - Dynamsoft Capture Vision +description: Reference index for TextLineSpecification object in Dynamsoft Capture Vision parameters, which define configurations for specified text lines including character models, regex patterns, and recognition settings. +keywords: TextLineSpecification, text line, parameter reference +needAutoGenerateSidebar: true +noTitleIndex: true +needGenerateH3Content: true +--- + +# TextLineSpecification Parameters + +The `TextLineSpecification` object defines configurations for specified text lines, including character models, recognition patterns, and output settings. + +## Example JSON + +```json +{ + "TextLineSpecificationOptions": [ + { + "Name": "tls_default", + "BaseTextLineSpecificationName": "", + "ApplicableTextLineNumbers": [0], + "CharacterModelName": "", + "TextLineRecModelName": "", + "CharHeightRange": [5, 1000], + "CharacterNormalizationModes": [], + "BinarizationModes": [], + "GrayscaleEnhancementModes": [], + "StringLengthRange": [3, 200], + "StringRegexPattern": "", + "OutputResults": 1, + "ConcatResults": 0, + "ConcatSeparator": "", + "ConcatStringLengthRange": [0, 0], + "ConcatStringRegexPattern": "", + "ExpectedGroupsCount": 1, + "SubGroups": [], + "ReferenceGroupName": "", + "TextLinesCount": 1, + "Position": { "Left": -1, "Top": -1, "Right": -1, "Bottom": -1 }, + "ConfusableCharactersCorrection": { + "ConfusionSet": "", + "FontName": "", + "Height": 0, + "Width": 0 + } + } + ] +} +``` + +## Hierarchical Structure + +This tree shows one `TextLineSpecification` object inside `TextLineSpecificationOptions`. + +```text +TextLineSpecification +├── Name +├── BaseTextLineSpecificationName +├── ApplicableTextLineNumbers +├── CharacterModelName +├── TextLineRecModelName +├── CharHeightRange +├── CharacterNormalizationModes +├── BinarizationModes +├── GrayscaleEnhancementModes +├── StringLengthRange +├── StringRegexPattern +├── OutputResults +├── ConcatResults +├── ConcatSeparator +├── ConcatStringLengthRange +├── ConcatStringRegexPattern +├── ExpectedGroupsCount +├── SubGroups +├── ReferenceGroupName +├── TextLinesCount +├── Position +└── ConfusableCharactersCorrection +``` + +## Top-Level Parameters + +| Parameter Name | Description | +|:---------------|:------------| +| [`Name`](name.md) | The unique name of the TextLineSpecification object. | +| [`BaseTextLineSpecificationName`](base-text-line-specification-name.md) | The name of another TextLineSpecification to inherit from. | +| [`ApplicableTextLineNumbers`](applicable-text-line-numbers.md) | The text line numbers this specification applies to. | +| [`CharacterModelName`](character-model-name.md) | The name of the character recognition model. | +| [`TextLineRecModelName`](text-line-rec-model-name.md) | The name of the text line recognition model. | +| [`CharHeightRange`](char-height-range.md) | The expected character height range. | +| [`CharacterNormalizationModes`](character-normalization-modes.md) | The modes for character normalization. | +| [`BinarizationModes`](binarization-modes.md) | The modes for binarization. | +| [`GrayscaleEnhancementModes`](grayscale-enhancement-modes.md) | The modes for grayscale enhancement. | +| [`StringLengthRange`](string-length-range.md) | The expected string length range. | +| [`StringRegexPattern`](string-regex-pattern.md) | The regex pattern for validating recognized strings. | +| [`OutputResults`](output-results.md) | Whether to output results for this specification. | +| [`ConcatResults`](concat-results.md) | Whether to concatenate results. | +| [`ConcatSeparator`](concat-separator.md) | The separator for concatenated results. | +| [`ConcatStringLengthRange`](concat-string-length-range.md) | The length range for concatenated strings. | +| [`ConcatStringRegexPattern`](concat-string-regex-pattern.md) | The regex pattern for concatenated strings. | +| [`ExpectedGroupsCount`](expected-groups-count.md) | The expected number of text line groups. | +| [`SubGroups`](sub-groups.md) | The sub-group definitions. | +| [`ReferenceGroupName`](reference-group-name.md) | The name of the reference group. | +| [`TextLinesCount`](text-lines-count.md) | The expected number of text lines. | +| [`Position`](position.md) | The position of the text line. | +| [`ConfusableCharactersCorrection`](confusable-characters-correction.md) | The settings for confusable characters correction. | + + diff --git a/parameters/reference/text-line-specification/string-regex-pattern.md b/parameters/reference/text-line-specification/string-regex-pattern.md index 6def027..a4072ca 100644 --- a/parameters/reference/text-line-specification/string-regex-pattern.md +++ b/parameters/reference/text-line-specification/string-regex-pattern.md @@ -69,4 +69,4 @@ Supported regular expressions pattern syntax: | {(,`max`)} | The preceding atom matches at least 0 characters, but not more than `max`. | | {(`min`,`max`)} | The preceding atom matches at least `min` characters, but not more than `max`. | | [(`string1`,`string2`,...)] | any case insensitive string that is one of the listed strings separated by commas (,). For example: [(CAN,USA)] matches CAN, USA or can. | -| [(`minnumericstring`-`maxnumericstring`)] | a numeric string that is between `minnumericstring` and `maxnumericstring`. For example: [(01-12)] matches 01, 02, 03, ... until 12). | +| [(`minnumericstring`-`maxnumericstring`)] | a numeric string that is between `minnumericstring` and `maxnumericstring`. For example: [(01-12)] matches 01, 02, 03, ... until 12. |