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
3 changes: 2 additions & 1 deletion _includes/sidelist-parameters-organization.html
Original file line number Diff line number Diff line change
Expand Up @@ -427,13 +427,14 @@
<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/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-reader-specification/barcode-format-ids.html" class="otherLinkColour">BarcodeFormatIds</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-format-ids.html" class="otherLinkColour">BarcodeFormatIds</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-height-range-array.html" class="otherLinkColour">BarcodeHeightRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-text-length-range-array.html" class="otherLinkColour">BarcodeTextLengthRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-text-regex-pattern.html" class="otherLinkColour">BarcodeTextRegExPattern</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-width-range-array.html" class="otherLinkColour">BarcodeWidthRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-bar-count-range-array.html" class="otherLinkColour">BarcodeZoneBarCountRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-min-distance-to-image-borders.html" class="otherLinkColour">BarcodeZoneMinDistanceToImageBorders</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.html" class="otherLinkColour">BarcodeZoneWidthToHeightRatioRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/code128-subset.html" class="otherLinkColour">Code128Subset</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/data-matrix-module-isotropic.html" class="otherLinkColour">DataMatrixModuleIsotropic</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/data-matrix-size-options.html" class="otherLinkColour">DataMatrixSizeOptions</a></li>
Expand Down
8 changes: 6 additions & 2 deletions parameters/file/auxiliary/barcode-format-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,14 @@ noTitleIndex: true
}
],
"BarcodeZoneMinDistanceToImageBorders" : 1,
"BarcodeZoneWidthToHeightRatioRangeArray": [
{
"MinValue": 100,
"MaxValue": 200
}
],
"Code128Subset" : "A",
"DataMatrixSizeOptions": ["DMS_DEFAULT"],
"DataMatrixModuleIsotropic": 1,
"DeformationResistingModes" : [
{
"Mode": "DRM_GENERAL",
Expand All @@ -75,7 +80,6 @@ noTitleIndex: true
"IncludeImpliedAI01": 0,
"HeadModuleRatio" : "211412",
"MinQuietZoneWidth" : 1,
"MinRatioOfBarcodeZoneWidthToHeight" : 100,
"MinResultConfidence" : 30,
"MirrorMode" : "MM_NORMAL",
"ModuleSizeRangeArray" : [
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
layout: default-layout
title: BarcodeZoneWidthToHeightRatioRangeArray - Dynamsoft Barcode Reader Parameters
description: The parameter BarcodeZoneWidthToHeightRatioRangeArray of Dynamsoft Barcode Reader defines the allowed width-to-height ratio range of the barcode zone for barcode searching.
keywords: BarcodeZoneWidthToHeightRatioRangeArray, parameter reference, parameter
---

# BarcodeZoneWidthToHeightRatioRangeArray

Parameter `BarcodeZoneWidthToHeightRatioRangeArray` defines the allowed width-to-height ratio range of the barcode zone for barcode searching.

**Remarks**

- Introduced in version 11.4.1000.

## JSON Structure

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

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

**Example:**

```json
{
"BarcodeZoneWidthToHeightRatioRangeArray": [
{
"MinValue": 100,
"MaxValue": 200
}
]
}
```

> [!NOTE]
> - This snippet shows only the `BarcodeZoneWidthToHeightRatioRangeArray` parameter.
> - To use it, embed this parameter within a [BarcodeFormatSpecification]({{ site.dcvb_parameters }}file/auxiliary/barcode-format-specification.html) object.
> - 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

Parameter `BarcodeZoneWidthToHeightRatioRangeArray` consists of a group of width-to-height ratio range objects. Each object includes the minimum and maximum value of the ratio range, expressed as a percentage (width/height × 100).

<table style = "text-align:left">
<thead>
<tr>
<th nowrap="nowrap">Child Parameter Name</th>
<th nowrap="nowrap">Child Parameter Summary</th>
</tr>
</thead>
<tr>
<td rowspan = "3" style="vertical-align:text-top">MinValue<br></td>
<td><b>Description</b><br>Defines the minimum width-to-height ratio of the barcode zone, expressed as a percentage.</td>
</tr>
<tr>
<td><b>Type</b><br><i>int</i></td>
</tr>
<tr>
<td><b>Range</b><br>[0, 10000]
</td>
</tr>
<tr>
<td rowspan = "3" style="vertical-align:text-top">MaxValue<br></td>
<td><b>Description</b><br>Defines the maximum width-to-height ratio of the barcode zone, expressed as a percentage.</td>
</tr>
<tr>
<td><b>Type</b><br><i>int</i></td>
</tr>
<tr>
<td><b>Range</b><br>[0, 10000]
</td>
</tr>
</table>

### Default Settings

If the `BarcodeZoneWidthToHeightRatioRangeArray` is not configured in your template file, the following settings will be used as the default settings. An empty array means no restriction on the width-to-height ratio.

```json
{
"BarcodeZoneWidthToHeightRatioRangeArray": []
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,45 +7,5 @@ keywords: DataMatrixModuleIsotropic, parameter reference, parameter

# DataMatrixModuleIsotropic

Parameter `DataMatrixModuleIsotropic` specifies whether the Data Matrix modules are isotropic, meaning they have equal scaling in all directions.
Removed in version 11.4.1000. Please use [`BarcodeZoneWidthToHeightRatioRangeArray`]({{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.html) instead.

## JSON Structure

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

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

**Example:**

```json
{
"DataMatrixModuleIsotropic": 1
}
```

> [!NOTE]
> - This snippet shows only the `DataMatrixModuleIsotropic` parameter.
> - To use it, embed this parameter within a [BarcodeFormatSpecification]({{ site.dcvb_parameters }}file/auxiliary/barcode-format-specification.html) object.
> - 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 `DataMatrixModuleIsotropic` is shown as follow:

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

**Remarks**

- It is valid only for DataMatrix.
- 0: Modules are not required to be isotropic.
- 1: Modules must be isotropic (equal scaling in all directions).
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,4 @@ keywords: MinRatioOfBarcodeZoneWidthToHeight , parameter reference, parameter

# MinRatioOfBarcodeZoneWidthToHeight

Parameter `MinRatioOfBarcodeZoneWidthToHeight` defines the minimum ratio (width/height as a percentage) of the barcode zone.

## JSON Structure

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

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

**Example:**

```json
{
"MinRatioOfBarcodeZoneWidthToHeight": 100
}
```

> [!NOTE]
> - This snippet shows only the `MinRatioOfBarcodeZoneWidthToHeight` parameter.
> - To use it, embed this parameter within a [BarcodeFormatSpecification]({{ site.dcvb_parameters }}file/auxiliary/barcode-format-specification.html) object.
> - 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 `MinRatioOfBarcodeZoneWidthToHeight` is shown as follow:

| MinRatioOfBarcodeZoneWidthToHeight Parameter Details |
| :--------------------------------- |
| **Type**<br>*int* |
| **Range**<br>[0, 10000] |
| **Default Value**<br> 0 |
Removed in version 11.4.1000. Please use [`BarcodeZoneWidthToHeightRatioRangeArray`]({{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.html) instead.
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ The mode arguments of the deblur mode object are shown as follows:
</td>
</tr>
<tr>
<td><b>Range</b><br>Each element is the name of a `CaptureVisionModel` object.<br>Candidate values: "OneDDeblur", "EAN13Decoder", "Code128Decoder".
<td><b>Range</b><br>Each element is the name of a `CaptureVisionModel` object.<br>Candidate values: "OneDDeblur", "EAN13Decoder", "Code128Decoder", "Code39ITFDecoder", "DataMatrixQRCodeDeblur", "PDF417Deblur".<br>"OneDDeblur": for OneD barcodes.<br>"EAN13Decoder": for EAN13 barcodes.<br>"Code128Decoder": for Code128 barcodes.<br>"Code39ITFDecoder": for Code39 and ITF barcodes. Introduced in version 11.4.1000.<br>"DataMatrixQRCodeDeblur": for DataMatrix and QRCode barcodes. Introduced in version 11.4.1000.<br>"PDF417Deblur": for PDF417 barcodes. Introduced in version 11.4.1000.
</td>
</tr>
<tr>
Expand All @@ -132,7 +132,7 @@ The mode arguments of the deblur mode object are shown as follows:
</td>
</tr>
<tr>
<td><b>Remarks</b><br>Introduced in version 11.2.1000.<br>When set to null, all "OneDDeblur", "EAN13Decoder", "Code128Decoder" models will be used by default.
<td><b>Remarks</b><br>Introduced in version 11.2.1000.<br>When set to null in version 11.2.1000, "OneDDeblur", "EAN13Decoder", "Code128Decoder" models will be used by default.<br>When set to null in version 11.4.1000, "OneDDeblur", "EAN13Decoder", "Code128Decoder", "Code39ITFDecoder", "DataMatrixQRCodeDeblur", "PDF417Deblur" models will be used by default.
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ The mode arguments of the localization mode object are shown as follows:
</td>
</tr>
<tr>
<td><b>Range</b><br>Each element is the name of a model.<br>Candidate values: "OneDLocalization", "DataMatrixQRCodeLocalization".
<td><b>Range</b><br>Each element is the name of a model.<br>Candidate values: "OneDLocalization", "DataMatrixQRCodeLocalization", "PDF417Localization".<br>"OneDLocalization": for OneD barcodes.<br>"DataMatrixQRCodeLocalization": for DataMatrix and QRCode barcodes.<br>"PDF417Localization": for PDF417 barcodes. Introduced in version 11.4.1000.
</td>
</tr>
<tr>
Expand All @@ -226,7 +226,7 @@ The mode arguments of the localization mode object are shown as follows:
</td>
</tr>
<tr>
<td><b>Remarks</b><br>Introduced in version 11.2.1000.<br>When set to null, both "OneDLocalization" and "DataMatrixQRCodeLocalization" models will be used by default.
<td><b>Remarks</b><br>Introduced in version 11.2.1000.<br>When set to null in version 11.2.1000, "OneDLocalization", "DataMatrixQRCodeLocalization" models will be used by default.<br>When set to null in version 11.4.1000, "OneDLocalization", "DataMatrixQRCodeLocalization", "PDF417Localization" models will be used by default.
</td>
</tr>
</table>
Expand Down