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
2 changes: 2 additions & 0 deletions _includes/sidelist-parameters-organization.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@
<ul>
<li><a href="{{ site.dcvb_parameters_reference }}label-recognizer-task-settings/stage-localize-text-lines.html#stage" class="otherLinkColour">Stage</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}label-recognizer-task-settings/localization-modes.html" class="otherLinkColour">LocalizationModes</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}label-recognizer-task-settings/orientation-detection-modes.html" class="otherLinkColour">OrientationDetectionModes</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -425,6 +426,7 @@
<ul>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/all-module-deviation.html" class="otherLinkColour">AllModuleDeviation</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/australian-post-encoding-table.html" class="otherLinkColour">AustralianPostEncodingTable</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/auto-detect-color-inversion.html" class="otherLinkColour">AutoDetectColorInversion</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-angle-range-array.html" class="otherLinkColour">BarcodeAngleRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-bytes-length-range-array.html" class="otherLinkColour">BarcodeBytesLengthRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-format-ids.html" class="otherLinkColour">BarcodeFormatIds</a></li>
Expand Down
1 change: 0 additions & 1 deletion architecture/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: An explanation of the image input mechanism in the Dynamsoft Captur
needAutoGenerateSidebar: true
needGenerateH3Content: true
noTitleIndex: false
permalink: /architecture/input.html
---

# Input
Expand Down
1 change: 0 additions & 1 deletion architecture/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: An explanation of the output mechanism in the Dynamsoft Capture Vis
needAutoGenerateSidebar: true
needGenerateH3Content: true
noTitleIndex: false
permalink: /architecture/output.html
---

# Output
Expand Down
1 change: 0 additions & 1 deletion architecture/semantic-processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: An explanation of Semantic Processing in the Dynamsoft Capture Visi
needAutoGenerateSidebar: true
needGenerateH3Content: true
noTitleIndex: true
permalink: /architecture/semantic-processing.html
---

# Semantic Processing
Expand Down
1 change: 1 addition & 0 deletions parameters/file/auxiliary/barcode-format-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ noTitleIndex: true
"Name":"BFS_1",
"AllModuleDeviation" : 0,
"AustralianPostEncodingTable" : "C",
"AutoDetectColorInversion": 0,
"EnableAddOnCode": 0,
"BarcodeAngleRangeArray" : [
{
Expand Down
20 changes: 19 additions & 1 deletion parameters/file/task-settings/label-recognizer-task-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,25 @@ The `LabelRecognizerTaskSetting` object is used to configure settings for a labe
"ImageParameterName": "ip_default",
"StageArray": [
{
"Stage": "SST_LOCALIZE_TEXT_LINES"
"Stage": "SST_LOCALIZE_TEXT_LINES",
"LocalizationModes": [
{
"Mode": "LM_NEURAL_NETWORK",
"ModelNameArray": ["MRZLocalization"]
},
{
"Mode": "LM_GENERAL"
}
],
"OrientationDetectionModes": [
{
"Mode": "ODM_SPATIAL_REFERENCES"
},
{
"Mode": "ODM_CHARS_ORIENTATION_NEURAL_NETWORK",
"ModelNameArray": ["TextLineOrientationCls"]
}
]
}
]
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
layout: default-layout
title: AutoDetectColorInversion - Dynamsoft Barcode Reader Parameters
description: The parameter AutoDetectColorInversion of Dynamsoft Barcode Reader defines whether to automatically detect and decode barcodes with inverted foreground and background colors.
keywords: AutoDetectColorInversion, inverted, parameter reference, parameter
---

# AutoDetectColorInversion

Parameter `AutoDetectColorInversion` defines whether to automatically detect and decode barcodes that have inverted foreground and background colors (i.e., light modules on a dark background) without requiring global grayscale inversion via `GrayscaleTransformationModes`.

**Remarks**

- Introduced in version 11.6.1000.

## JSON Structure

**Location in template:**
```
BarcodeFormatSpecificationOptions[i]
└── AutoDetectColorInversion
```

**Parent object:** [BarcodeFormatSpecification]({{ site.dcvb_parameters }}file/auxiliary/barcode-format-specification.html) object

**Example:**

```json
{
"BarcodeFormatIds": ["BF_DATAMATRIX"],
"AutoDetectColorInversion": 0
}
```

> [!NOTE]
> - This snippet shows only the `AutoDetectColorInversion` parameter.
> - To use it, embed this parameter within a [BarcodeFormatSpecification]({{ site.dcvb_parameters }}file/auxiliary/barcode-format-specification.html) object.
> - The `BarcodeFormatIds` in the same `BarcodeFormatSpecification` determines which barcode formats this setting applies to.
> - For the complete JSON structure, see:
> - [Full JSON Structure]({{ site.dcvb_parameters }}file/index.html#full-json-structure)
> - [Minimal Valid JSON]({{ site.dcvb_parameters }}file/index.html#minimal-valid-json-example)

## Parameter Details

The structure of the `AutoDetectColorInversion` is shown as follow:

| AutoDetectColorInversion Parameter Details |
| :--------------------------------- |
| **Type**<br>*int* |
| **Range**<br>[0, 1] |
| **Default Value**<br>0 |

**Remarks**

- 0: Disabled. The SDK does not perform additional inverted-color detection at the barcode-candidate level. Whether normal (dark-on-light) or inverted (light-on-dark) barcodes can be decoded depends entirely on the [`GrayscaleTransformationModes`]({{ site.dcvb_parameters_reference }}image-parameter/grayscale-transformation-modes.html) setting.
- 1: Enabled. In addition to the behavior determined by `GrayscaleTransformationModes`, the SDK automatically detects whether a candidate barcode region has inverted colors and decodes it accordingly. This means both normal and inverted barcodes can be decoded regardless of the `GrayscaleTransformationModes` setting.

### Supported Barcode Formats

In the current version, the following barcode formats support automatic color-inversion detection:

| Barcode Format | Supported Since |
|---|---|
| `BF_DATAMATRIX` | v11.6.1000 |

Support for additional formats (e.g., QR Code, PDF417, Aztec) is planned for future releases.

### Difference from GrayscaleTransformationModes

This parameter works at the **candidate-barcode level** during decoding, which is fundamentally different from the **image-level** [`GrayscaleTransformationModes`]({{ site.dcvb_parameters_reference }}image-parameter/grayscale-transformation-modes.html):

| | `GrayscaleTransformationModes` | `AutoDetectColorInversion` |
|---|---|---|
| **Scope** | Entire image | Per candidate barcode region |
| **Timing** | Before localization | During localization |
| **Granularity** | Affects all barcode types globally | Per-format via `BarcodeFormatIds` |
| **Performance cost** | High (processes entire image twice when both `GTM_ORIGINAL` and `GTM_INVERTED` are set) | Low (only checks targeted candidate regions) |

**When to use which:**
- Use `AutoDetectColorInversion` when only certain barcode formats may be inverted, while other barcodes on the same image are normal. This is more efficient and precise.
- Use `GrayscaleTransformationModes` with `GTM_INVERTED` when the entire image has inverted colors, or when you need to handle inverted barcodes of formats not yet supported by `AutoDetectColorInversion`.
- The two parameters can be used together. `GrayscaleTransformationModes` is applied first at the image level, then `AutoDetectColorInversion` performs additional per-region detection during decoding.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: ImageROIProcessingNameArray - Dynamsoft Capture Vision Parameters
description: Reference for the ImageROIProcessingNameArray parameter in the Dynamsoft Capture Vision CaptureVisionTemplate object, which lists the names of TargetROIDef objects that define the recognition tasks (barcode reading, label recognition, document detection) to run on image regions of interest.
keywords: image ROI processing, TargetROIDef, CaptureVisionTemplate
permalink: /parameters/reference/capture-vision-template/image-roi-processing-name-array.html
---
# ImageROIProcessingNameArray

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: ImageSourceName - Dynamsoft Capture Vision Parameters
description: The parameter ImageSourceName of Dynamsoft Capture Vision defines the name of the ImageSource object.
keywords: image source, CaptureVisionTemplate
permalink: /parameters/reference/capture-vision-template/image-source-name.html
---
# ImageSourceName

Expand Down
20 changes: 18 additions & 2 deletions parameters/reference/capture-vision-template/max-parallel-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: MaxParallelTasks - Dynamsoft Capture Vision Parameters
description: The parameter MaxParallelTasks defines the maximum number of parallel tasks for the DCV runtime.
keywords: Max parallel tasks, CaptureVisionTemplate
permalink: /parameters/reference/capture-vision-template/max-parallel-tasks.html
---
# MaxParallelTasks

Expand Down Expand Up @@ -41,4 +40,21 @@ CaptureVisionTemplates[i]
| **Type**<br>*int* |
| **Range**<br>-1, 0, [1, 256] |
| **Default Value**<br>4 |
| **Remarks** <br>1) 0: Only open the management thread, the execution task thread and the management thread are the same thread.<br>2) -1: Do not open the management thread or the task thread, that is, run in the thread that calls StartCapturing. |
| **Remarks** <br>Controls the total number of concurrent thread slots used by the CVR thread pool. |

## Behavior

- Each DLR/DDN task occupies one thread slot.
- For DBR tasks, each localization work and each decoding work occupies one thread slot.
- When `MaxParallelTasks <= 1`, DBR runs in single-threaded mode.

In single-threaded mode for DBR, processing is executed in sequence:

1. Complete one `LocalizationMode` and produce localized barcode regions.
2. Apply all configured `DeblurMode`s to each localized barcode region.
3. Continue with the next `LocalizationMode`.


**Remarks**

- Updated semantic definition from "maximum parallel tasks" to "maximum concurrent thread slots in the CVR thread pool" in version 3.6.1000.
1 change: 0 additions & 1 deletion parameters/reference/capture-vision-template/name.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: Name - Dynamsoft Capture Vision Parameter Reference CaptureVisionTemplate Object.
description: The parameter Name defines the unique identifier of CaptureVisionTemplate object.
keywords: top-level object, name, unique identifier
permalink: /parameters/reference/capture-vision-template/name.html
---
# Name

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: OutputOriginalImage - Dynamsoft Capture Vision Parameters
description: The parameter OutputOriginalImage indicates whether DCV finally outputs the original input image.
keywords: original image, captured results, CaptureVisionTemplate
permalink: /parameters/reference/capture-vision-template/output-original-image.html
---
# OutputOriginalImage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: SemanticProcessingNameArray - Dynamsoft Capture Vision Parameters
description: Reference for the SemanticProcessingNameArray parameter in the Dynamsoft Capture Vision CaptureVisionTemplate object, which lists the names of SemanticProcessing objects to execute - enabling post-processing code parsing tasks (e.g. VIN or MRZ parsing) after image ROI processing.
keywords: sematic processing, CaptureVisionTemplate
permalink: /parameters/reference/capture-vision-template/semantic-processing-name-array.html
---
# SemanticProcessingNameArray

Expand Down
1 change: 0 additions & 1 deletion parameters/reference/capture-vision-template/timeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: Timeout - Dynamsoft Capture Vision Parameters
description: The parameter Timeout defines the maximum amount of time (in milliseconds) that the recognition tasks should take per page.
keywords: timeout, CaptureVisionTemplate
permalink: /parameters/reference/capture-vision-template/timeout.html
---
# Timeout

Expand Down
1 change: 0 additions & 1 deletion parameters/reference/code-parser-task-settings/name.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: Name - Dynamsoft Capture Vision Parameter Reference CodeParserTaskSetting Object.
description: The parameter Name defines the unique identifier of CodeParserTaskSetting object.
keywords: top-level object, name, unique identifier
permalink: /parameters/reference/code-parser-task-settings/name.html
---
# Name

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default-layout
title: ResourcesPath - Dynamsoft Capture Vision Parameter Reference
description: Reference for the ResourcesPath parameter in the Dynamsoft Capture Vision CodeParserTaskSetting object, which specifies the directory (absolute or relative) containing the .dcpres resource files needed for code parsing.
permalink: /parameters/reference/code-parser-task-settings/resources-path.html
---
# ResourcesPath

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,8 @@ Transforms the image to inverted grayscale.

### GTM_AUTO

Let the library choose automatically for grayscale transformation.
Let the library choose automatically for grayscale transformation.

## See Also

- [`AutoDetectColorInversion`]({{ site.dcvb_parameters_reference }}barcode-format-specification/auto-detect-color-inversion.html) - A lighter-weight alternative that detects inverted colors per barcode candidate region during decoding, rather than inverting the entire image. It is configured per barcode format in `BarcodeFormatSpecification` and is more efficient when only certain barcode formats may be inverted.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: DirectoryPath - ImageSource - Dynamsoft Capture Vision Parameters
description: Reference for the DirectoryPath parameter in the Dynamsoft Capture Vision ImageSource object, which specifies the local directory path from which image files are fetched for processing.
keywords: Directory path
permalink: /parameters/reference/image-source-options/directory-path.html
---
# DirectoryPath

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: PDFReadingMode - Dynamsoft Capture Vision Parameters
description: Reference for the PDFReadingMode parameter in the Dynamsoft Capture Vision ImageSource object, which controls how PDF files are rendered into images, including the reading mode (raster/vector/auto), DPI, and raster data source.
keywords: PDF reading mode, ISA
permalink: /parameters/reference/image-source-options/pdf-reading-mode.html
---
# PDFReadingMode

Expand Down
1 change: 0 additions & 1 deletion parameters/reference/image-source-options/recursive.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: Recursive - Dynamsoft Capture Vision Parameters
description: Reference for the Recursive parameter in the Dynamsoft Capture Vision ImageSource object, which indicates whether image files are fetched from subdirectories recursively (1) or only from the top-level directory (0).
keywords: Recursive, ISA
permalink: /parameters/reference/image-source-options/recursive.html
---
# Recursive

Expand Down
1 change: 0 additions & 1 deletion parameters/reference/image-source-options/type.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: default-layout
title: Type - Dynamsoft Capture Vision Parameters
description: Reference for the Type parameter in the Dynamsoft Capture Vision ImageSource object, which specifies the image source type (IST_DIRECTORY_FETCHER, IST_CAMERA_ENHANCER, or IST_SCANNER_CONNECTOR) so CVR can create the correct image source instance.
keywords: Type, ISA
permalink: /parameters/reference/image-source-options/type.html
---
# Type

Expand Down
Loading