diff --git a/_includes/sidelist-parameters-organization.html b/_includes/sidelist-parameters-organization.html index 097bf45..7b1b0d2 100644 --- a/_includes/sidelist-parameters-organization.html +++ b/_includes/sidelist-parameters-organization.html @@ -427,13 +427,14 @@
  • AustralianPostEncodingTable
  • BarcodeAngleRangeArray
  • BarcodeBytesLengthRangeArray
    • -
  • BarcodeFormatIds
    • +
  • BarcodeFormatIds
  • BarcodeHeightRangeArray
  • BarcodeTextLengthRangeArray
  • BarcodeTextRegExPattern
  • BarcodeWidthRangeArray
  • BarcodeZoneBarCountRangeArray
  • BarcodeZoneMinDistanceToImageBorders
    • +
  • BarcodeZoneWidthToHeightRatioRangeArray
  • Code128Subset
  • DataMatrixModuleIsotropic
  • DataMatrixSizeOptions
    • diff --git a/parameters/file/auxiliary/barcode-format-specification.md b/parameters/file/auxiliary/barcode-format-specification.md index 22cca8f..7696987 100644 --- a/parameters/file/auxiliary/barcode-format-specification.md +++ b/parameters/file/auxiliary/barcode-format-specification.md @@ -61,9 +61,14 @@ noTitleIndex: true } ], "BarcodeZoneMinDistanceToImageBorders" : 1, + "BarcodeZoneWidthToHeightRatioRangeArray": [ + { + "MinValue": 100, + "MaxValue": 200 + } + ], "Code128Subset" : "A", "DataMatrixSizeOptions": ["DMS_DEFAULT"], - "DataMatrixModuleIsotropic": 1, "DeformationResistingModes" : [ { "Mode": "DRM_GENERAL", @@ -75,7 +80,6 @@ noTitleIndex: true "IncludeImpliedAI01": 0, "HeadModuleRatio" : "211412", "MinQuietZoneWidth" : 1, - "MinRatioOfBarcodeZoneWidthToHeight" : 100, "MinResultConfidence" : 30, "MirrorMode" : "MM_NORMAL", "ModuleSizeRangeArray" : [ diff --git a/parameters/reference/barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.md b/parameters/reference/barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.md new file mode 100644 index 0000000..d8f0b90 --- /dev/null +++ b/parameters/reference/barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.md @@ -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). + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Child Parameter NameChild Parameter Summary
    MinValue
    		Description
    Defines the minimum width-to-height ratio of the barcode zone, expressed as a percentage.
    Type
    int
    Range
    [0, 10000] +
    MaxValue
    		Description
    Defines the maximum width-to-height ratio of the barcode zone, expressed as a percentage.
    Type
    int
    Range
    [0, 10000] +
    + +### 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": [] +} +``` diff --git a/parameters/reference/barcode-format-specification/data-matrix-module-isotropic.md b/parameters/reference/barcode-format-specification/data-matrix-module-isotropic.md index 3f407e0..0fe6727 100644 --- a/parameters/reference/barcode-format-specification/data-matrix-module-isotropic.md +++ b/parameters/reference/barcode-format-specification/data-matrix-module-isotropic.md @@ -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**
    *int* | -| **Range**
    [0, 1] | -| **Default Value**
    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). diff --git a/parameters/reference/barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.md b/parameters/reference/barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.md index de09299..1cbcc50 100644 --- a/parameters/reference/barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.md +++ b/parameters/reference/barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.md @@ -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**
    *int* | -| **Range**
    [0, 10000] | -| **Default Value**
    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. diff --git a/parameters/reference/barcode-reader-task-settings/deblur-modes.md b/parameters/reference/barcode-reader-task-settings/deblur-modes.md index 0e46a06..90f63de 100644 --- a/parameters/reference/barcode-reader-task-settings/deblur-modes.md +++ b/parameters/reference/barcode-reader-task-settings/deblur-modes.md @@ -120,7 +120,7 @@ The mode arguments of the deblur mode object are shown as follows: - Range
    Each element is the name of a `CaptureVisionModel` object.
    Candidate values: "OneDDeblur", "EAN13Decoder", "Code128Decoder". + Range
    Each element is the name of a `CaptureVisionModel` object.
    Candidate values: "OneDDeblur", "EAN13Decoder", "Code128Decoder", "Code39ITFDecoder", "DataMatrixQRCodeDeblur", "PDF417Deblur".
    "OneDDeblur": for OneD barcodes.
    "EAN13Decoder": for EAN13 barcodes.
    "Code128Decoder": for Code128 barcodes.
    "Code39ITFDecoder": for Code39 and ITF barcodes. Introduced in version 11.4.1000.
    "DataMatrixQRCodeDeblur": for DataMatrix and QRCode barcodes. Introduced in version 11.4.1000.
    "PDF417Deblur": for PDF417 barcodes. Introduced in version 11.4.1000. @@ -132,7 +132,7 @@ The mode arguments of the deblur mode object are shown as follows: - Remarks
    Introduced in version 11.2.1000.
    When set to null, all "OneDDeblur", "EAN13Decoder", "Code128Decoder" models will be used by default. + Remarks
    Introduced in version 11.2.1000.
    When set to null in version 11.2.1000, "OneDDeblur", "EAN13Decoder", "Code128Decoder" models will be used by default.
    When set to null in version 11.4.1000, "OneDDeblur", "EAN13Decoder", "Code128Decoder", "Code39ITFDecoder", "DataMatrixQRCodeDeblur", "PDF417Deblur" models will be used by default. diff --git a/parameters/reference/barcode-reader-task-settings/localization-modes.md b/parameters/reference/barcode-reader-task-settings/localization-modes.md index dd4a8e4..daf8f5b 100644 --- a/parameters/reference/barcode-reader-task-settings/localization-modes.md +++ b/parameters/reference/barcode-reader-task-settings/localization-modes.md @@ -214,7 +214,7 @@ The mode arguments of the localization mode object are shown as follows: - Range
    Each element is the name of a model.
    Candidate values: "OneDLocalization", "DataMatrixQRCodeLocalization". + Range
    Each element is the name of a model.
    Candidate values: "OneDLocalization", "DataMatrixQRCodeLocalization", "PDF417Localization".
    "OneDLocalization": for OneD barcodes.
    "DataMatrixQRCodeLocalization": for DataMatrix and QRCode barcodes.
    "PDF417Localization": for PDF417 barcodes. Introduced in version 11.4.1000. @@ -226,7 +226,7 @@ The mode arguments of the localization mode object are shown as follows: - Remarks
    Introduced in version 11.2.1000.
    When set to null, both "OneDLocalization" and "DataMatrixQRCodeLocalization" models will be used by default. + Remarks
    Introduced in version 11.2.1000.
    When set to null in version 11.2.1000, "OneDLocalization", "DataMatrixQRCodeLocalization" models will be used by default.
    When set to null in version 11.4.1000, "OneDLocalization", "DataMatrixQRCodeLocalization", "PDF417Localization" models will be used by default.