Skip to content

Commit 47f3c1b

Browse files
Merge pull request #38 from dynamsoft-docs/preview
update to internal commit 32ee139a
2 parents 194961a + a3df7c1 commit 47f3c1b

File tree

120 files changed

+1840
-571
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+1840
-571
lines changed

_config.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,16 @@ dlr_java: /label-recognition/docs/server/programming/java/
3131
dlr_java_api: /label-recognition/docs/server/programming/java/api-reference/
3232
dlr_java_release_notes: /label-recognition/docs/server/programming/java/release-notes/
3333

34+
dlr_python: /label-recognition/docs/server/programming/python/
35+
dlr_python_api: /label-recognition/docs/server/programming/python/api-reference/
36+
dlr_python_release_notes: /label-recognition/docs/server/programming/python/release-notes/
37+
3438
dcv_enumerations: /capture-vision/docs/core/enums/
3539
dcv_parameters_reference: /capture-vision/docs/core/parameters/reference/
3640

3741
dcv_cpp_api: /capture-vision/docs/server/programming/cplusplus/api-reference/
3842
dcv_dotnet_api: /capture-vision/docs/server/programming/dotnet/api-reference/
43+
dcv_python_api: /capture-vision/docs/server/programming/python/api-reference/
3944
dcv_arch: /capture-vision/docs/core/architecture/
4045
dcv_introduction: /capture-vision/docs/core/introduction/
4146

@@ -47,7 +52,8 @@ dbr_icon: /label-recognition/docs/server/server/assets/img-icon/icon-dbr.svg
4752
dwt_icon: /label-recognition/docs/assets/img-icon/icon-dwt.svg
4853
dnt_icon: /label-recognition/docs/server/assets/img-icon/icon-dnt.svg
4954

50-
useVersionTree: true
55+
useVersionTree: false
56+
isDCV: true
5157

5258
baseurl: "/label-recognition/docs/server"
5359

_data/full_tree.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ tree_file_list:
1616
- sidelist-programming/programming-dotnet.html
1717
- sidelist-programming/programming-java-v1.2.1.html
1818
- sidelist-programming/programming-java.html
19+
- sidelist-programming/programming-python.html
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
This is the first release of the Python Edition of `DynamsoftLabelRecognizer` SDK integrated with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually.
3+
4+
* `DynamsoftCaptureVision` architecture consists of:
5+
* `ImageSourceAdapter(ISA)`, the standard input interface for you to convert image data from different sources into the standard input image data. In addition, `ISA` incorporates an image buffer management system that allows instant access to the buffered image data.
6+
* `CaptureVisionRouter (CVR)`, an engine for you to update templates, retrieve images from `ISA`, coordinate corresponding functional products and dispatch the results to the receivers.
7+
* Functional products that perform image processing, content understanding and semantic processing. The functional products are pluggable and passively called by CVR when they are required.
8+
* Result receiver interfaces. You can implement `CapturedResultReceiver (CRR)` to receive the `CapturedResults` that output when the processing on an image is finalized.
9+
* The parameter template system has been comprehensively upgraded.
10+
* Multiple algorithm task settings are available. You can define barcode decoding, label recognizing, document scanning and semantic processing tasks in one template file.
11+
* Extended the feature of the ROI system. By configuring the `target ROI` parameters, you can not only specify an `ROI` on the original image but also define the dependencies of the algorithm tasks. This feature enables you to customize the workflow when processing complex scenarios.
12+
* The image processing parameters are separated from the task parameters so that the template settings become more clear and concise.
13+
* The `intermediate result` system has been improved.
14+
* Achieved the `intermediate result` sharing between different functional products. The results that have the same image source and processing parameters are directly reused, which speeds up the image processing workflow. You don’t need to add any additional code to enable the `intermediate result` sharing. The library can recognize all the reusable results automatically based on the template file you uploaded.
15+

_includes/sidelist-full-tree.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,7 @@
1414
<a href="{{ site.dlr_c }}" class="otherLinkColour">C Edition Introduction</a>
1515
</li>
1616
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-c.html" -%}
17+
<li lang="python">
18+
<a href="{{ site.dlr_python }}" class="otherLinkColour">Python Edition Introduction</a>
19+
</li>
20+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-python.html" -%}

_includes/sidelist-programming/programming-c.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,13 @@
3030
<li><a href="{{ site.dlr_c_cplusplus_release_notes }}c-cpp-2.html?src=c" class="otherLinkColour">Version 2.x</a></li>
3131
<li><a href="{{ site.dlr_c_cplusplus_release_notes }}c-cpp-1.html?src=c" class="otherLinkColour">Version 1.x</a></li>
3232
</ul>
33+
</li>
34+
<li lang="c" class="category">OTHER EDITIONS</li>
35+
<li lang="c"><a class="otherLinkColour">Choose a Language</a>
36+
<ul>
37+
<li><a target="_blank" href="{{ site.dlr_python }}" class="otherLinkColour refreshLink">Python</a></li>
38+
<li><a target="_blank" href="{{ site.dlr_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
39+
<li><a target="_blank" href="{{ site.dlr_java }}" class="otherLinkColour refreshLink">Java</a></li>
40+
<li><a target="_blank" href="{{ site.dlr_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
41+
</ul>
3342
</li>

_includes/sidelist-programming/programming-cpp.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,4 +211,13 @@
211211
<li><a href="{{ site.dlr_c_cplusplus_release_notes }}c-cpp-1.html?src=cpp" class="otherLinkColour">Version 1.x</a></li>
212212
</ul>
213213
</li>
214-
<li lang="cplusplus"><a href="{{ site.dlr_cpp }}upgrade-instruction.html" class="otherLinkColour">Upgrade Instructions</a></li>
214+
<li lang="cplusplus"><a href="{{ site.dlr_cpp }}upgrade-instruction.html" class="otherLinkColour">Upgrade Instructions</a></li>
215+
<li lang="cplusplus" class="category">OTHER EDITIONS</li>
216+
<li lang="cplusplus"><a class="otherLinkColour">Choose a Language</a>
217+
<ul>
218+
<li><a target="_blank" href="{{ site.dlr_python }}" class="otherLinkColour refreshLink">Python</a></li>
219+
<li><a target="_blank" href="{{ site.dlr_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
220+
<li><a target="_blank" href="{{ site.dlr_java }}" class="otherLinkColour refreshLink">Java</a></li>
221+
<li><a target="_blank" href="{{ site.dlr_c }}" class="otherLinkColour refreshLink">C</a></li>
222+
</ul>
223+
</li>

_includes/sidelist-programming/programming-dotnet.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,13 @@
122122
<li><a href="{{ site.dlr_dotnet_release_notes }}dotnet-2.html" class="otherLinkColour">Version 2.x</a></li>
123123
<li><a href="{{ site.dlr_dotnet_release_notes }}dotnet-1.html" class="otherLinkColour">Version 1.x</a></li>
124124
</ul>
125+
</li>
126+
<li lang="dotnet" class="category">OTHER EDITIONS</li>
127+
<li lang="dotnet"><a class="otherLinkColour">Choose a Language</a>
128+
<ul>
129+
<li><a target="_blank" href="{{ site.dlr_python }}" class="otherLinkColour refreshLink">Python</a></li>
130+
<li><a target="_blank" href="{{ site.dlr_java }}" class="otherLinkColour refreshLink">Java</a></li>
131+
<li><a target="_blank" href="{{ site.dlr_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
132+
<li><a target="_blank" href="{{ site.dlr_c }}" class="otherLinkColour refreshLink">C</a></li>
133+
</ul>
125134
</li>

_includes/sidelist-programming/programming-java.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,13 @@
2929
<li><a href="{{ site.dlr_java_release_notes }}java-2.html" class="otherLinkColour">Version 2.x</a></li>
3030
<li><a href="{{ site.dlr_java_release_notes }}java-1.html" class="otherLinkColour">Version 1.x</a></li>
3131
</ul>
32+
</li>
33+
<li lang="java" class="category">OTHER EDITIONS</li>
34+
<li lang="java"><a class="otherLinkColour">Choose a Language</a>
35+
<ul>
36+
<li><a target="_blank" href="{{ site.dlr_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
37+
<li><a target="_blank" href="{{ site.dlr_python }}" class="otherLinkColour refreshLink">Python</a></li>
38+
<li><a target="_blank" href="{{ site.dlr_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
39+
<li><a target="_blank" href="{{ site.dlr_c }}" class="otherLinkColour refreshLink">C</a></li>
40+
</ul>
3241
</li>
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
<li lang="python" class="category">DEVELOPMENT</li>
2+
<li lang="python" ><a href="{{ site.dlr_python }}user-guide.html" class="otherLinkColour">User Guide</a></li>
3+
<li lang="python"><a href="{{ site.dlr_python_api }}" class="otherLinkColour">API Reference</a>
4+
<ul>
5+
<li><a>DynamsoftCaptureVisionRouter</a>
6+
<ul>
7+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/capture-vision-router.html" class="otherLinkColour">CaptureVisionRouter</a>
8+
<ul>
9+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/instantiate.html" class="otherLinkColour">Constructor</a></li>
10+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/single-file-processing.html" class="otherLinkColour">Single-File Processing</a></li>
11+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/multiple-file-processing.html" class="otherLinkColour">Multiple-File Processing</a></li>
12+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/settings.html" class="otherLinkColour">Settings</a></li>
13+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/buffered-items.html" class="otherLinkColour">Buffered Items</a></li>
14+
</ul>
15+
</li>
16+
<li><a>Classes</a>
17+
<ul>
18+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
19+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html" class="otherLinkColour">CapturedResultFilter</a></li>
20+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a></li>
21+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html" class="otherLinkColour">CaptureVisionRouterModule</a></li>
22+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
23+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/capture-state-listener.html" class="otherLinkColour">CaptureStateListener</a></li>
24+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/image-source-state-listener.html" class="otherLinkColour">ImageSourceStateListener</a></li>
25+
<li><a href="{{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/buffered-items-manager.html" class="otherLinkColour">BufferedItemsManager</a></li>
26+
</ul>
27+
</li>
28+
<li><a>Enums</a>
29+
<ul>
30+
<li><a href="{{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=python" class="otherLinkColour">EnumCaptureState</a></li>
31+
<li><a href="{{ site.dcv_enumerations }}capture-vision-router/image-source-state.html?lang=python" class="otherLinkColour">EnumImageSourceState</a></li>
32+
<li><a href="{{ site.dcv_enumerations }}capture-vision-router/preset-template.html?lang=python" class="otherLinkColour">EnumPresetTemplate</a></li>
33+
</ul>
34+
</li>
35+
</ul>
36+
</li>
37+
<li><a>DynamsoftLabelRecognizer</a>
38+
<ul>
39+
<li><a>Classes</a>
40+
<ul>
41+
<li><a href="{{ site.dlr_python_api }}buffered-character-item-set.html" class="otherLinkColour">BufferedCharacterItemSet</a></li>
42+
<li><a href="{{ site.dlr_python_api }}buffered-character-item.html" class="otherLinkColour">BufferedCharacterItem</a></li>
43+
<li><a href="{{ site.dlr_python_api }}character-cluster.html" class="otherLinkColour">CharacterCluster</a></li>
44+
<li><a href="{{ site.dlr_python_api }}character-result.html" class="otherLinkColour">CharacterResult</a></li>
45+
<li><a href="{{ site.dlr_python_api }}label-recognizer-module.html" class="otherLinkColour">LabelRecognizerModule</a></li>
46+
<li><a href="{{ site.dlr_python_api }}recognized-text-lines-result.html" class="otherLinkColour">RecognizedTextLinesResult</a></li>
47+
<li><a href="{{ site.dlr_python_api }}text-line-result-item.html" class="otherLinkColour">TextLineResultItem</a></li>
48+
<li><a href="{{ site.dlr_python_api }}simplified-label-recognizer-settings.html" class="otherLinkColour">SimplifiedLabelRecognizerSettings</a></li>
49+
</ul>
50+
</li>
51+
</ul>
52+
</li>
53+
<li><a>DynamsoftCore</a>
54+
<ul>
55+
<li><a>Classes</a>
56+
<ul>
57+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
58+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/core-module.html" class="otherLinkColour">CoreModule</a></li>
59+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/file-image-tag.html" class="otherLinkColour">FileImageTag</a></li>
60+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/image-data.html" class="otherLinkColour">ImageData</a></li>
61+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/image-source-adapter.html" class="otherLinkColour">ImageSourceAdapter</a></li>
62+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/image-source-error-listener.html" class="otherLinkColour">ImageSourceErrorListener</a></li>
63+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/image-tag.html" class="otherLinkColour">ImageTag</a></li>
64+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/original-image-result-item.html" class="otherLinkColour">OriginalImageResultItem</a></li>
65+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/pdf-reading-parameter.html" class="otherLinkColour">PDFReadingParameter</a></li>
66+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/point.html" class="otherLinkColour">Point</a></li>
67+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/quadrilateral.html" class="otherLinkColour">Quadrilateral</a></li>
68+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/rect.html" class="otherLinkColour">Rect</a></li>
69+
<li><a href="{{ site.dcv_python_api }}core/basic-classes/video-frame-tag.html" class="otherLinkColour">VideoFrameTag</a></li>
70+
</ul>
71+
</li>
72+
<li><a>Enums</a>
73+
<ul>
74+
<li><a href="{{ site.dcv_enumerations }}core/buffer-overflow-protection-mode.html?lang=python" class="otherLinkColour">EnumBufferOverflowProtectionMode</a></li>
75+
<li><a href="{{ site.dcv_enumerations }}core/captured-result-item-type.html?lang=python" class="otherLinkColour">EnumCapturedResultItemType</a></li>
76+
<li><a href="{{ site.dcv_enumerations }}core/colour-channel-usage-type.html?lang=python" class="otherLinkColour">EnumColourChannelUsageType</a></li>
77+
<li><a href="{{ site.dcv_enumerations }}core/error-code.html?lang=python" class="otherLinkColour">EnumErrorCode</a></li>
78+
<li><a href="{{ site.dcv_enumerations }}core/grayscale-enhancement-mode.html?lang=python" class="otherLinkColour">EnumGrayscaleEnhancementMode</a></li>
79+
<li><a href="{{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=python" class="otherLinkColour">EnumGrayscaleTransformationMode</a></li>
80+
<li><a href="{{ site.dcv_enumerations }}core/image-capture-distance-mode.html?lang=python" class="otherLinkColour">EnumImageCaptureDistanceMode</a></li>
81+
<li><a href="{{ site.dcv_enumerations }}core/image-pixel-format.html?lang=python" class="otherLinkColour">EnumImagePixelFormat</a></li>
82+
<li><a href="{{ site.dcv_enumerations }}core/image-tag-type.html?lang=python" class="otherLinkColour">EnumImageTagType</a></li>
83+
<li><a href="{{ site.dcv_enumerations }}core/pdf-reading-mode.html?lang=python" class="otherLinkColour">EnumPDFReadingMode</a></li>
84+
<li><a href="{{ site.dcv_enumerations }}core/raster-data-source.html?lang=python" class="otherLinkColour">EnumRasterDataSource</a></li>
85+
<li><a href="{{ site.dcv_enumerations }}core/video-frame-quality.html?lang=python" class="otherLinkColour">EnumVideoFrameQuality</a></li>
86+
</ul>
87+
</li>
88+
</ul>
89+
</li>
90+
<li><a>DynamsoftUtility</a>
91+
<ul>
92+
<li><a href="{{ site.dcv_python_api }}utility/directory-fetcher.html" class="otherLinkColour">DirectoryFetcher</a></li>
93+
<li><a href="{{ site.dcv_python_api }}utility/file-fetcher.html" class="otherLinkColour">FileFetcher</a></li>
94+
<li><a href="{{ site.dcv_python_api }}utility/image-manager.html" class="otherLinkColour">ImageManager</a></li>
95+
<li><a href="{{ site.dcv_python_api }}utility/multi-frame-result-cross-filter.html" class="otherLinkColour">MultiFrameResultCrossFilter</a></li>
96+
<li><a href="{{ site.dcv_python_api }}utility/proactive-image-source-adapter.html" class="otherLinkColour">ProactiveImageSourceAdapter</a></li>
97+
<li><a href="{{ site.dcv_python_api }}utility/utility-module.html" class="otherLinkColour">UtilityModule</a></li>
98+
</ul>
99+
</li>
100+
<li><a>DynamsoftLicense</a>
101+
<ul>
102+
<li><a href="{{ site.dcv_python_api }}license/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
103+
<li><a href="{{ site.dcv_python_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
104+
</ul>
105+
</li>
106+
<li><a>DynamsoftImageProcessing</a>
107+
<ul>
108+
<li><a href="{{ site.dcv_python_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>
109+
</ul>
110+
</li>
111+
</ul>
112+
</li>
113+
<li lang="python" class="category">USEFUL RESOURCES</li>
114+
115+
<li lang="python"><a href="{{ site.dlr_python_release_notes }}" class="otherLinkColour">Release Notes</a>
116+
<ul>
117+
<li><a href="{{ site.dlr_python_release_notes }}python-3.html" class="otherLinkColour">Version 3.x</a></li>
118+
</ul>
119+
</li>
120+
121+
<li lang="python" class="category">OTHER EDITIONS</li>
122+
<li lang="python"><a class="otherLinkColour">Choose a Language</a>
123+
<ul>
124+
<li><a target="_blank" href="{{ site.dlr_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
125+
<li><a target="_blank" href="{{ site.dlr_java }}" class="otherLinkColour refreshLink">Java</a></li>
126+
<li><a target="_blank" href="{{ site.dlr_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
127+
<li><a target="_blank" href="{{ site.dlr_c }}" class="otherLinkColour refreshLink">C</a></li>
128+
</ul>
129+
</li>

0 commit comments

Comments
 (0)