Skip to content

Commit 0b1ab7c

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #106 from dynamsoft-docs/preview
update to internal commit 941df0ce
2 parents 78e0733 + 6ffdbd4 commit 0b1ab7c

27 files changed

+341
-760
lines changed

‎_data/full_tree.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
tree_file_list:
22
- sidelist-full-tree.html
33
- sidelist-architecture.html
4-
- sidelist-parameter-reference.html
54
- sidelist-parameters-organization.html
65
- sidelist-understanding.html

‎_includes/sidelist-full-tree.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<li><a target="_blank" href="{{ site.dcvb_python }}" class="otherLinkColour refreshLink">Python</a></li>
1616
<li><a target="_blank" href="{{ site.dcvb_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
1717
<li><a target="_blank" href="{{ site.dcvb_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
18+
<li><a target="_blank" href="{{ site.dcvb_java }}" class="otherLinkColour refreshLink">Java</a></li>
1819
</ul>
1920
</li>
2021
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-understanding.html" -%}

‎_includes/sidelist-parameter-reference.html‎

Lines changed: 0 additions & 303 deletions
This file was deleted.

‎_includes/sidelist-parameters-organization.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@
181181
<li><a href="{{ site.dcvb_parameters_reference }}label-recognizer-task-settings/stage-localize-text-lines.html" class="otherLinkColour">LocalizeTextLinesStage Object</a>
182182
<ul>
183183
<li><a href="{{ site.dcvb_parameters_reference }}label-recognizer-task-settings/stage-localize-text-lines.html#stage" class="otherLinkColour">Stage</a></li>
184+
<li><a href="{{ site.dcvb_parameters_reference }}label-recognizer-task-settings/localization-modes.html" class="otherLinkColour">LocalizationModes</a></li>
184185
</ul>
185186
</li>
186187
</ul>
@@ -438,7 +439,9 @@
438439
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/enable-addon-code.html" class="otherLinkColour">EnableAddOnCode</a></li>
439440
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/enable-data-matrix-ecc000-140.html" class="otherLinkColour">EnableDataMatrixECC000-140</a></li>
440441
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/enable-qr-code-model-1.html" class="otherLinkColour">EnableQRCodeModel1</a></li>
442+
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/expected-barcodes-count.html" class="otherLinkColour">ExpectedBarcodesCount</a></li>
441443
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/find-uneven-module-barcode.html" class="otherLinkColour">FindUnevenModuleBarcode</a></li>
444+
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/has-vertical-quietzone.html" class="otherLinkColour">HasVerticalQuietZone</a></li>
442445
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/head-module-ratio.html" class="otherLinkColour">HeadModuleRatio</a></li>
443446
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/include-implied-ai01.html" class="otherLinkColour">IncludeImpliedAI01</a></li>
444447
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/include-trailing-check-digit.html" class="otherLinkColour">IncludeTrailingCheckDigit</a></li>
@@ -497,7 +500,8 @@
497500
</li>
498501
<li><a href="{{ site.dcvb_parameters }}file/auxiliary/global-parameter.html" class="otherLinkColour">Global Parameter</a>
499502
<ul>
500-
<li><a href="{{ site.dcvb_parameters_reference }}global-parameter/max-total-image-dimension.html" class="otherLinkColour">MaxTotalImageDimension</a></li>
503+
<li><a href="{{ site.dcvb_parameters }}file/auxiliary/global-parameter.html#maxtotalimagedimension" class="otherLinkColour">MaxTotalImageDimension</a></li>
504+
<li><a href="{{ site.dcvb_parameters }}file/auxiliary/global-parameter.html#intraopnumthreads" class="otherLinkColour">IntraOpNumThreads</a></li>
501505
</ul>
502506
</li>
503507
<li><a href="{{ site.dcvb_parameters }}file/semantic-processing/index.html" class="otherLinkColour">SemanticProcessing Object</a>

‎parameters/file/assets/capture-vision-model.png‎

25.8 KB
Loading

‎parameters/file/auxiliary/global-parameter.md‎

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,43 @@ noTitleIndex: true
99

1010
# GlobalParameter Object
1111

12-
Currently, the `MaxTotalImageDimension` is the only parameter under `GlobalParameter`.
12+
A `GlobalParameter` object defines the global parameters for Dynamsoft Capture Vision. The available global parameters are listed below.
1313

14-
## MaxTotalImageDimension
15-
16-
Parameter [`MaxTotalImageDimension`](../../reference/global-parameter/max-total-image-dimension.md) defines the maximum total dimension of the images that read in the memory.
14+
## Example
1715

1816
```json
1917
{
20-
"MaxTotalImageDimension":0
18+
"GlobalParameter":{
19+
"MaxTotalImageDimension": 0,
20+
"IntraOpNumThreads": 0
21+
}
2122
}
2223
```
24+
25+
## Available Parameters
26+
27+
### MaxTotalImageDimension
28+
29+
Defines the maximum value of total dimension (in million pixel) of source images the library can process concurrently.
30+
31+
| Parameter Summary |
32+
| :---------------- |
33+
| **Type**<br>*int* |
34+
| **Range**<br>[0, 0x7fffffff] |
35+
| **Default Value**<br>0 |
36+
| **Remarks**<br>0 means no limitation. |
37+
38+
### IntraOpNumThreads
39+
40+
Sets the global number of threads used internally for model execution.
41+
42+
| Parameter Summary |
43+
| :---------------- |
44+
| **Type**<br>*int* |
45+
| **Range**<br>[0, 256] |
46+
| **Default Value**<br>4 |
47+
| **Remarks**<br>0 means the library automatically decides the number of threads to use based on the system's CPU core count. |
48+
49+
**Remarks**
50+
51+
- Introduced in Dynamsoft Barcode Reader SDK version 11.2.1000 and Dynamsoft Capture Vision version 3.2.1000.

‎parameters/file/task-settings/document-normalizer-task-settings-v.2.4.2200.md‎

Lines changed: 0 additions & 89 deletions
This file was deleted.

‎parameters/reference/barcode-format-specification/expected-barcodes-count.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default-layout
3+
title: ExpectedBarcodesCount - Dynamsoft Barcode Reader Parameters
4+
description: The parameter ExpectedBarcodesCount of BarcodeFormatSpecification defines the expected number of barcodes for a specific format.
5+
keywords: Expected barcodes count
6+
---
7+
8+
# ExpectedBarcodesCount
9+
10+
Parameter `ExpectedBarcodesCount` of `BarcodeFormatSpecification` defines the expected number of barcodes for a specific format.
11+
12+
**Remarks**
13+
14+
- Introduced in version 11.2.1000.
15+
16+
## Example
17+
18+
```json
19+
{
20+
"ExpectedBarcodesCount": 0
21+
}
22+
```
23+
24+
## Parameter Summary
25+
26+
| ExpectedBarcodesCount Parameter Summary |
27+
| :--------------------------------- |
28+
| **Type**<br>*int* |
29+
| **Range**<br>[1, 0x7fffffff] |
30+
| **Default Value**<br>0x7fffffff |
31+

‎parameters/reference/barcode-format-specification/has-vertical-quietzone.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default-layout
3+
title: HasVerticalQuietZone - Dynamsoft Barcode Reader Parameters
4+
description: The parameter Code128Subset of Dynamsoft Barcode Reader defines whether there is a sufficient vertical quiet zone above and below the barcode.
5+
keywords: HasVerticalQuietZone , parameter reference, parameter
6+
---
7+
8+
# HasVerticalQuietZone
9+
10+
Parameter `HasVerticalQuietZone` defines whether there is a sufficient vertical quiet zone above and below the barcode.
11+
12+
**Remarks**
13+
14+
- Introduced in version 11.2.1000.
15+
16+
## Example
17+
18+
```json
19+
{
20+
"HasVerticalQuietZone": 0
21+
}
22+
```
23+
24+
## Parameter Summary
25+
26+
The structure of the `HasVerticalQuietZone` is shown as follow:
27+
28+
| HasVerticalQuietZone Parameter Summary |
29+
| :--------------------------------- |
30+
| **Type**<br>*int* |
31+
| **Range**<br>[0, 1] |
32+
| **Default Value**<br> 1|
33+
34+
**Remarks**
35+
36+
- 0: Do not require a sufficient vertical quiet zone above and below the barcode.
37+
- 1: Require a sufficient vertical quiet zone above and below the barcode.

‎parameters/reference/barcode-format-specification/include-trailing-check-digit.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,12 @@ The structure of the `IncludeTrailingCheckDigit` is shown as follow:
2525
| :--------------------------------- |
2626
| **Type**<br>*int* |
2727
| **Range**<br>[0, 1] |
28-
| **Default Value**<br>1 |
28+
| **Default Value**<br>0 |
2929

3030
**Remarks**
3131

3232
- 0: exclude.
3333
- 1: include.
3434
- This parameter is valid only for Code 128.
35-
36-
**Availability**
37-
38-
Introduced in version 11.0.4000.
35+
- Introduced in version 11.0.4000.
36+
- Changed the default value to 0 from 1 in version 11.2.1000

0 commit comments

Comments
 (0)