diff --git a/_config.yml b/_config.yml index fd0e61b..87ea8d2 100644 --- a/_config.yml +++ b/_config.yml @@ -3,42 +3,15 @@ repositoryUrl: https://github.com/dynamsoft-docs/document-normalizer-docs/blob/m docFullPath: https://www.dynamsoft.com/document-normalizer/docs/core firstLevelUrl: /document-normalizer/docs/core docHomePage: /document-normalizer/docs/core/ +needSearchIndex: true +searchNeedFilter: true introduction: /document-normalizer/docs/core/introduction/ -c: /document-normalizer/docs/server/programming/c/ -c_api: /document-normalizer/docs/server/programming/c/api-reference/ -c_release_notes: /document-normalizer/docs/server/programming/c/release-notes/ - -cpp: /document-normalizer/docs/server/programming/cplusplus/ -cpp_release_notes: /document-normalizer/docs/server/programming/cplusplus/release-notes/ - -dotnet: /document-normalizer/docs/server/programming/dotnet/ -dotnet_release_notes: /document-normalizer/docs/server/programming/dotnet/release-notes/ - -ios: /document-normalizer/docs/mobile/programming/ios/ -ios_release_notes: /document-normalizer/docs/mobile/programming/ios/release-notes/ - -android: /document-normalizer/docs/mobile/programming/android/ -android_release_notes: /document-normalizer/docs/mobile/programming/android/release-notes/ - -js: /document-normalizer/docs/web/programming/javascript/ -js_release_notes: /document-normalizer/docs/web/programming/javascript/release-notes/ - -xamarin: /document-normalizer/docs/mobile/programming/xamarin/ -xamarin_release_notes: /document-normalizer/docs/mobile/programming/xamarin/release-notes/ - -release_notes: /document-normalizer/docs/core/release-notes/ - -enumerations: /capture-vision/docs/core/enums/ -dcv_parameters: /capture-vision/docs/core/parameters/ -parameters_reference: /capture-vision/docs/core/parameters/reference/ -parameters_ddn: /document-normalizer/docs/core/parameters/ -parameters_reference_ddn: /document-normalizer/docs/core/parameters/reference/ -license: /document-normalizer/docs/core/license-activation/ useVersionTree: false isDCV: true +useJSVersionV3: true assets: /document-normalizer/docs/core/assets/ edit_icon: /document-normalizer/docs/core/assets/img-icon/edit-icon.png diff --git a/_data/full_tree.yml b/_data/full_tree.yml deleted file mode 100644 index a017e5f..0000000 --- a/_data/full_tree.yml +++ /dev/null @@ -1,13 +0,0 @@ -tree_file_list: - - sidelist-full-tree.html - - sidelist-development.html - - sidelist-development-v1.0.21.html - - sidelist-introduction.html - - sidelist-license.html - - sidelist-parameters-organization.html - - sidelist-parameters-reference.html - - sidelist-parameters-reference-v1.0.21.html - - sidelist-release-notes.html - - sidelist-useful.html - - sidelist-understanding.html - - sidelist-understanding-v1.0.21.html diff --git a/_data/product_version.yml b/_data/product_version.yml deleted file mode 100644 index 1506065..0000000 --- a/_data/product_version.yml +++ /dev/null @@ -1,23 +0,0 @@ -useGroupedVersion: true - -version_info_list: - - value: latest version - - value: 2.x - child: - - 2.2.10 - - 2.2.0 - - 2.0.21 - - 2.0.20 - - 2.0.11 - - 2.0.10 - - 2.0.0 - - value: 1.x - child: - - 1.0.21 - - 1.0.20 - - 1.0.12 - - 1.0.11 - - 1.0.10 - - 1.0.0 - - \ No newline at end of file diff --git a/_includes/ddnNav.html b/_includes/ddnNav.html deleted file mode 100644 index ec99f74..0000000 --- a/_includes/ddnNav.html +++ /dev/null @@ -1,59 +0,0 @@ - - -
-
-
-
-
- - Get Pricing - Download 30-Day Trial -
-
-
-
-
-
- -
Resource Base
-
-
-
-
-
-
-
- -
-
-
-
-
-
diff --git a/_includes/release-notes/product-highlight-1.0.0.md b/_includes/release-notes/product-highlight-1.0.0.md deleted file mode 100644 index 4fe4256..0000000 --- a/_includes/release-notes/product-highlight-1.0.0.md +++ /dev/null @@ -1,15 +0,0 @@ - -Dynamsoft Document Normalizer 1.0 version supports quad boundary detection and image correction features. - -- Detectable quads include but are not limited to: - - Document Pages - - Tables - - Cards like ID cards -- The following features are available when normalizing the image: - - Boundary cropping - - Deskew processing -- The following attributes of the output image can be adjusted: - - Colour mode - - Contrast - - Brightness - diff --git a/_includes/release-notes/product-highlight-2.0.0.md b/_includes/release-notes/product-highlight-2.0.0.md deleted file mode 100644 index 03b0d47..0000000 --- a/_includes/release-notes/product-highlight-2.0.0.md +++ /dev/null @@ -1,16 +0,0 @@ - -`DynamsoftDocumentNormalizer` SDK has been revamped to integrate 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. - -* `DynamsoftCaptureVision` architecture consists of: - * `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. - * `CaptureVisionRouter (CVR)`, an engine for you to update templates, retrieve images from `ISA`, coordinate corresponding functional products and dispatch the results to the receivers. - * 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. - * Result receiver interfaces. You can implement `CapturedResultReceiver (CRR)` to receive the `CapturedResults` that output when the processing on an image is finalized. You can also implement `IntermediateResultReceiver (IRR)` to get timely results from different stages of the workflow. -* The parameter template system has been comprehensively upgraded. - * Multiple algorithm task settings are available. You can define barcode decoding, label recognizing, document scanning and semantic processing tasks in one template file. - * 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. - * The image processing parameters are separated from the task parameters so that the template settings become more clear and concise. -* The `intermediate result` system has been improved. - * 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. - * The readability and interactivity of the `intermediate results` are enhanced. `IntermediateResultReceiver` allows you to receive up to 27 different types of `Intermediate results`. You can clearly read which stage of the algorithm each result is output from. In addition, `IntermediateResultManager` allows you to intervene in the workflows by modifying the `intermediate results`. - diff --git a/_includes/release-notes/product-highlight-2.2.0.md b/_includes/release-notes/product-highlight-2.2.0.md deleted file mode 100644 index fa9aaef..0000000 --- a/_includes/release-notes/product-highlight-2.2.0.md +++ /dev/null @@ -1,5 +0,0 @@ - -* Introduced the capability for users to influence the image processing process by altering intermediate results. Users can now clone, edit, and substitute intermediate result units within the callback function of each type. Subsequent operations will then proceed based on the updated unit. -* Introduced a feature for multi-condition filtering across products. Users can now specify filtering criteria for the task results of a `TargetROIDef` by implementing an `OutputTaskSetting` based on the task results of varying products from descendant `TargetROIDef` objects. -* Enhanced the `Offset` parameter in `TargetROIDef`. Users now have the capability to meticulously customize components of the coordinate system, including the origin, X-axis, and Y-axis, for precise offset calculation. - diff --git a/_includes/release-notes/product-highlight-2.4.0.md b/_includes/release-notes/product-highlight-2.4.0.md deleted file mode 100644 index bddd3ea..0000000 --- a/_includes/release-notes/product-highlight-2.4.0.md +++ /dev/null @@ -1,5 +0,0 @@ - -- Introduced two new parameters for quadrilateral filtering. - - Added a new parameter `MinQuadrilateralAreaRatio` to define the minimum targeting document area. The parameter is available via both the parameter template and the SimplifiedDocumentNormalizerSettings. - - Added a new parameter `ExpectedDocumentsCount` to define the expected document count for detection. The parameter is available via both the parameter template and the SimplifiedDocumentNormalizerSettings. - diff --git a/_includes/sidelist-development-v1.0.21.html b/_includes/sidelist-development-v1.0.21.html deleted file mode 100644 index ddb43f8..0000000 --- a/_includes/sidelist-development-v1.0.21.html +++ /dev/null @@ -1,18 +0,0 @@ -
  • DEVELOPMENT
    • -
  • - Web (Client Side)
    • -
  • - Mobile - -
    • -
  • - Server / Desktop - -
    • \ No newline at end of file diff --git a/_includes/sidelist-development-v2.2.0.html b/_includes/sidelist-development-v2.2.0.html deleted file mode 100644 index c4068a3..0000000 --- a/_includes/sidelist-development-v2.2.0.html +++ /dev/null @@ -1,17 +0,0 @@ -
  • DEVELOPMENT
    • -
  • - Web (Client Side)
    • -
  • - Mobile - -
    • -
  • - Server / Desktop - -
    • \ No newline at end of file diff --git a/_includes/sidelist-development.html b/_includes/sidelist-development.html deleted file mode 100644 index 9c4aade..0000000 --- a/_includes/sidelist-development.html +++ /dev/null @@ -1,18 +0,0 @@ -
  • DEVELOPMENT
    • -
  • - Web (Client Side)
    • -
  • - Mobile - -
    • -
  • - Server / Desktop - -
    • \ No newline at end of file diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html deleted file mode 100644 index ee5a5f9..0000000 --- a/_includes/sidelist-full-tree.html +++ /dev/null @@ -1,4 +0,0 @@ -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-development.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-understanding.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-useful.html" -%} \ No newline at end of file diff --git a/_includes/sidelist-introduction.html b/_includes/sidelist-introduction.html deleted file mode 100644 index 658cfae..0000000 --- a/_includes/sidelist-introduction.html +++ /dev/null @@ -1,2 +0,0 @@ -
  • Introduction -
    • \ No newline at end of file diff --git a/_includes/sidelist-license.html b/_includes/sidelist-license.html deleted file mode 100644 index e0a6737..0000000 --- a/_includes/sidelist-license.html +++ /dev/null @@ -1 +0,0 @@ -
  • License Activation
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-organization.html b/_includes/sidelist-parameters-organization.html deleted file mode 100644 index 48ef6cb..0000000 --- a/_includes/sidelist-parameters-organization.html +++ /dev/null @@ -1,27 +0,0 @@ -
  • Parameter - Organization - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v1.0.21.html b/_includes/sidelist-parameters-reference-v1.0.21.html deleted file mode 100644 index 3cec49e..0000000 --- a/_includes/sidelist-parameters-reference-v1.0.21.html +++ /dev/null @@ -1,25 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v2.0.0.html b/_includes/sidelist-parameters-reference-v2.0.0.html deleted file mode 100644 index eb1b11f..0000000 --- a/_includes/sidelist-parameters-reference-v2.0.0.html +++ /dev/null @@ -1,74 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v2.0.11.html b/_includes/sidelist-parameters-reference-v2.0.11.html deleted file mode 100644 index 3b34b15..0000000 --- a/_includes/sidelist-parameters-reference-v2.0.11.html +++ /dev/null @@ -1,74 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference-v2.2.10.html b/_includes/sidelist-parameters-reference-v2.2.10.html deleted file mode 100644 index dd727a4..0000000 --- a/_includes/sidelist-parameters-reference-v2.2.10.html +++ /dev/null @@ -1,75 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-parameters-reference.html b/_includes/sidelist-parameters-reference.html deleted file mode 100644 index dd727a4..0000000 --- a/_includes/sidelist-parameters-reference.html +++ /dev/null @@ -1,75 +0,0 @@ -
  • Parameter Reference - -
    • \ No newline at end of file diff --git a/_includes/sidelist-release-notes.html b/_includes/sidelist-release-notes.html deleted file mode 100644 index 73b2b48..0000000 --- a/_includes/sidelist-release-notes.html +++ /dev/null @@ -1,2 +0,0 @@ -
  • Release Notes -
    • diff --git a/_includes/sidelist-understanding-v1.0.21.html b/_includes/sidelist-understanding-v1.0.21.html deleted file mode 100644 index 53be4c8..0000000 --- a/_includes/sidelist-understanding-v1.0.21.html +++ /dev/null @@ -1,3 +0,0 @@ -
  • UNDERSTANDING DDN
    • -
  • Parameter Organization Structure
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-reference.html" -%} diff --git a/_includes/sidelist-understanding.html b/_includes/sidelist-understanding.html deleted file mode 100644 index 6022445..0000000 --- a/_includes/sidelist-understanding.html +++ /dev/null @@ -1,4 +0,0 @@ -
  • UNDERSTANDING DDN
    • - -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-organization.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-reference.html" -%} diff --git a/_includes/sidelist-useful.html b/_includes/sidelist-useful.html deleted file mode 100644 index 2e76650..0000000 --- a/_includes/sidelist-useful.html +++ /dev/null @@ -1,3 +0,0 @@ -
  • USEFUL RESOURCES
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-license.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%} diff --git a/_layouts/default-layout-OLD.html b/_layouts/default-layout-OLD.html deleted file mode 100644 index e8e9f67..0000000 --- a/_layouts/default-layout-OLD.html +++ /dev/null @@ -1,110 +0,0 @@ - - - -{%- include head.html -%} -{%- assign noTitleIndex = "" -%} -{%- if page.noTitleIndex or page.url contains 'release-notes' -%} - {%- assign noTitleIndex = "noTitleIndex" -%} -{%- endif -%} - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include ddnNav.html -%} -
    Table of contents
    -
    -
    -
    -
    - {%- include main-page-head.html -%} -
    -
    -
    - {{ content }} - -
    -
    -
    -

    This page is compatible for:

    -

    Version 1.0

    -
    -
    -

    Is this page helpful?

    - YesYes - NoNo -
    -
    - {%- if page.needAutoGenerateSidebar -%} -

    In this article:

    -
    - {%- endif -%} -
    -
    - -
    - -
    -
    -
    -
    -
    - {%- include liquid_autoGenerateHistoryList.html -%} - {%- include auto-version-list.html -%} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - {%- include livehelp.html -%} - - - - - - - - - - - - - - diff --git a/_layouts/home-page.html b/_layouts/home-page.html deleted file mode 100644 index 89aa900..0000000 --- a/_layouts/home-page.html +++ /dev/null @@ -1,50 +0,0 @@ - - - -{%- include head.html -%} - - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - -
    -
    -
    - - {{ content }} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - - diff --git a/_layouts/search-page-OLD.html b/_layouts/search-page-OLD.html deleted file mode 100644 index 51609d5..0000000 --- a/_layouts/search-page-OLD.html +++ /dev/null @@ -1,210 +0,0 @@ - - - -{%- include head.html -%} - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include ddnNav.html -%} -
    -
    -
    -
    -
    -
    -
    -

    Search

    - -
    -
    -
    -
    - -
    -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - {%- include livehelp.html -%} - - - \ No newline at end of file diff --git a/assets/js/ddnCoreVersionSearch.json b/assets/js/ddnCoreVersionSearch.json deleted file mode 100644 index f889f54..0000000 --- a/assets/js/ddnCoreVersionSearch.json +++ /dev/null @@ -1,182 +0,0 @@ -[ - { - "version": "2.4.10", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.4.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.4.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.4.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.40" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.40" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.4.10" - } - ] - } - }, - { - "version": "2.2.10", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - } - ] - } - }, - { - "version": "2.2.0", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.0" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.0" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.0" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.0" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.0" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.0" - } - ] - } - }, - { - "version": "2.0.21", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.20" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.20" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.20" - } - ] - } - }, - { - "version": "2.0.20", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.20" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.20" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.20" - } - ] - } - },{ - "version": "2.0.10", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.10" - } - ] - } - },{ - "version": "2.0.0", - "matchList": { - "dcvRepoCore": [ - { - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.0" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.0" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "10.0.0" - },{ - "path": "/parameters/reference/image-parameter", - "version": "3.0.0" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.0" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.0" - } - ] - } - } -] \ No newline at end of file diff --git a/index-v1.0.21.md b/index-v1.0.21.md deleted file mode 100644 index d12d27b..0000000 --- a/index-v1.0.21.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Documentation Homepage -keywords: homepage, documentation -breadcrumbText: HomePage -description: Documentation Homepage ---- - - -# Documentation HomePage - -* [Introduction]({{ site.introduction }}) - -
    -DEVELOPMENT -
    - -* [Web (Client Side)]({{ site.js }}) -* Mobile - * [Android]({{ site.android }}) - * [iOS]({{ site.ios }}) - * [Xamarin.Forms]({{ site.xamarin }}) -* Server / Desktop - * [C++]({{ site.cpp }}) - * [C]({{ site.c }}) - -
    -UNDERSTANDING DDN -
    - -* [Parameter Organization]({{ site.parameters_ddn }}parameter-organization-structure.html) -* [Parameter Reference]({{ site.parameters_reference_ddn }}) - -
    -USEFUL RESOURCES -
    - -* [Release Notes]({{ site.release_notes }}) -* [License Activation]({{ site.license }}) diff --git a/index-v2.2.0.md b/index-v2.2.0.md deleted file mode 100644 index 0accbcc..0000000 --- a/index-v2.2.0.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Documentation Homepage -keywords: homepage, documentation -breadcrumbText: HomePage -description: Homepage of Dynamsoft Document Normalizer ---- - -# Documentation HomePage - -* [Introduction]({{ site.introduction }}) - -
    -DEVELOPMENT -
    - -* [Web (Client Side)]({{ site.js }}) -* Mobile - * [Android]({{ site.android }}) - * [iOS]({{ site.ios }}) - * [Xamarin.Forms]({{ site.xamarin }}) -* Server / Desktop - * [C++]({{ site.cpp }}) - -
    -UNDERSTANDING DDN -
    - -* [Parameter Organization]({{ site.parameters_ddn }}parameter-organization-structure.html) -* [Parameter Reference]({{ site.parameters_reference_ddn }}) - -
    -USEFUL RESOURCES -
    - -* [Release Notes]({{ site.release_notes }}) -* [License Activation]({{ site.license }}) diff --git a/index.md b/index.md deleted file mode 100644 index eff252f..0000000 --- a/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Documentation Homepage -keywords: homepage, documentation -breadcrumbText: HomePage -description: Homepage of Dynamsoft Document Normalizer ---- - -# Documentation HomePage - -* [Introduction]({{ site.introduction }}) - -
    -DEVELOPMENT -
    - -* [Web (Client Side)]({{ site.js }}) -* Mobile - * [Android]({{ site.android }}) - * [iOS]({{ site.ios }}) - * [Xamarin.Forms]({{ site.xamarin }}) -* Server / Desktop - * [C++]({{ site.cpp }}) - * [.NET]({{ site.dotnet }}) - -
    -UNDERSTANDING DDN -
    - -* [Parameter Organization]({{ site.parameters_ddn }}parameter-organization-structure.html) -* [Parameter Reference]({{ site.parameters_reference_ddn }}) - -
    -USEFUL RESOURCES -
    - -* [Release Notes]({{ site.release_notes }}) -* [License Activation]({{ site.license }}) diff --git a/license-activation/index-v1.0.30.md b/license-activation/index-v1.0.30.md deleted file mode 100644 index 14544a8..0000000 --- a/license-activation/index-v1.0.30.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default-layout -title: License initialization - Dynamsoft Document Normalizer -description: This is the documentation - License initialization page of Dynamsoft Document Normalizer. -keywords: Document Normalizer, License initialization -needAutoGenerateSidebar: true -breadcrumbText: License Initialization ---- - -# License initialization - -## Get a trial key - -- A free public trial license is available for every new device for first use of Dynamsoft Document Normalizer. The public trial license is the default key used in samples. You can also find the public trial license on the following parts of this page. -- If your free key is expired, please visit Private Trial License Page to get a 30-day trial extension. - -## Get a full license - -- [Contact us](https://www.dynamsoft.com/company/contact/) to purchase a full license - -## Initialize the license - -The following code snippets are using the public trial license to initialize the license. You can replace the public trial license with your own license key. - -
    ->- JavaScript ->- Java-Android ->- Objective-C ->- Swift ->- C ->- C++ -> ->1. -```javascript -Dynamsoft.DDN.DocumentNormalizer.license = "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9"; -``` -2. -```java -LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", MainActivity.this, new LicenseVerificationListener() { - @Override - public void licenseVerificationCallback(boolean isSuccess, CoreException error) { - if(!isSuccess){ - error.printStackTrace(); - } - } -}); -``` -3. -```objc -[DynamsoftLicenseManager initLicense:@"DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" verificationDelegate: self]; -- (void)licenseVerificationCallback:(BOOL)isSuccess error:(NSError *)error{ - // Add your code to execute when license verification call back is handled. -} -``` -4. -```swift -DynamsoftLicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", verificationDelegate: self) -func licenseVerificationCallback(_ isSuccess: Bool, error: Error?) { - // Add your code to execute when license verification call back is handled. -} -``` -5. -```c -char errorMessage[256]; -DC_InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9", errorMessage, 256); -``` -6. -```cpp -char errorMessage[256]; -CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwNSJ9", errorMessage, 256); -``` diff --git a/license-activation/index.md b/license-activation/index.md deleted file mode 100644 index 549dd10..0000000 --- a/license-activation/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -layout: default-layout -title: License initialization - Dynamsoft Document Normalizer -description: This is the documentation - License initialization page of Dynamsoft Document Normalizer. -keywords: Document Normalizer, License initialization -needAutoGenerateSidebar: true -breadcrumbText: License Initialization ---- - -# License initialization - -## Get a trial key - -- A free public trial license is available for every new device for first use of Dynamsoft Document Normalizer. The public trial license is the default key used in samples. You can also find the public trial license on the following parts of this page. -- If your free key is expired, please visit Private Trial License Page to get a 30-day trial extension. - -## Get a full license - -- [Contact us](https://www.dynamsoft.com/company/contact/) to purchase a full license - -## Initialize the license - -The following code snippets are using the public trial license to initialize the license. You can replace the public trial license with your own license key. - -
    ->- JavaScript ->- Java-Android ->- Objective-C ->- Swift ->- C ->- C++ -> ->1. -```javascript -Dynamsoft.License.LicenseManager.initLicense("YOUR-LICENSE-KEY"); -``` -2. -```java -LicenseManager.initLicense("YOUR-LICENSE-KEY", MainActivity.this, new LicenseVerificationListener() { - @Override - public void onLicenseVerified(boolean b, Exception e) { - if(!b && e != null){ - e.printStackTrace(); - } - } -}); -``` -3. -```objc -[DSLicenseManager initLicense:@"YOUR-LICENSE-KEY" verificationDelegate:self]; -- (void)onLicenseVerified:(bool)isSuccess error:(NSError *)error{ - if(!isSuccess && error != nil){ - NSString* msg = error.userInfo[NSUnderlyingErrorKey]; - NSLog(@"%@", msg); - } -} -``` -4. -```swift -LicenseManager.initLicense("YOUR-LICENSE-KEY",verificationDelegate:self) -func onLicenseVerified(_ isSuccess: Bool, error: Error?) { - if(!isSuccess && error != nil){ - let err = error as NSError? - let msg = err!.userInfo[NSUnderlyingErrorKey] as? String - print(msg ?? "") - } -} -``` -5. -```c -char errorMessage[256]; -DC_InitLicense("YOUR-LICENSE-KEY", errorMessage, 256); -``` -6. -```cpp -char errorMessage[256]; -CLicenseManager::InitLicense("YOUR-LICENSE-KEY", errorMessage, 256); -``` diff --git a/parameters-new/reference/index-v2.0.0.md b/parameters-new/reference/index-v2.0.0.md deleted file mode 100644 index dca2e66..0000000 --- a/parameters-new/reference/index-v2.0.0.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Dynamsoft Document Normalizer Parameter Reference - Main Page -description: Dynamsoft Document Normalizer Parameter Reference - Main Page -keywords: parameter reference, parameters -needAutoGenerateSidebar: false -permalink: /parameters/reference/index-v2.0.0.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`ImageROIProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. | - | [`ImageSourceName`]({{ site.parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MaxParallelTasks`]({{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputRawImage`]({{ site.parameters_reference }}capture-vision-template/output-raw-Image.html) | Indicates whether DCV finally outputs the raw input image. | - | [`SemanticProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. | - | [`Timeout`]({{ site.parameters_reference }}capture-vision-template/timeout.html) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`BaseTargetROIDefName`]({{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`PauseFlag`]({{ site.parameters_reference }}target-roi-def/pause-flag.html) | Indicates that the region results generated by this `TargetROIDef` will not be used by other `TargetROIDef` objects that depend on it to calculate the target regions, unless the user explicitly performs an update operation. | - | [`TaskSettingNameArray`]({{ site.parameters_reference }}target-roi-def/task-setting-name-array.html) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `DocumentNormalizerTaskSetting` objects. | - -## Document Normalizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`BaseDocumentNormalizerTaskSettingName`]({{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | - | [`Brightness`]({{ site.parameters_reference }}document-normalizer-task-settings/brightness.html) | Defines the brightness of the normalized image. | - | [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. | - | [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. | - | [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. | - | [`CornerAngleRangeArray`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range.html) | Defines the range of angles (in degrees) of the extracted corners. | - | [`DeskewMode`]({{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | - | [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. | - | [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. | - | [`QuadrilateralDetectionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html) | Defines the quadrilateral detection process on an image. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`BaseImageParameterName`]({{ site.parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`RegionPredetectionModes`]({{ site.parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. | - | [`ScaleDownThreshold`]({{ site.parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`FileFilter`]({{ site.parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`PDFReadingMode`]({{ site.parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`Type`]({{ site.parameters_reference }}image-source-options/type.html) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`MaxTotalImageDimension`]({{ site.parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory | - -## Shared Parameter - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------- | ----------- | - | [`DirectoryPath`]({{ site.parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. | - | [`MaxThreadsInOneTask`]({{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`SectionImageParameterArray`]({{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | \ No newline at end of file diff --git a/parameters-new/reference/index-v2.0.11.md b/parameters-new/reference/index-v2.0.11.md deleted file mode 100644 index e34380c..0000000 --- a/parameters-new/reference/index-v2.0.11.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Dynamsoft Document Normalizer Parameter Reference - Main Page -description: Dynamsoft Document Normalizer Parameter Reference - Main Page -keywords: parameter reference, parameters -needAutoGenerateSidebar: false -permalink: /parameters/reference/index-v2.0.11.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`ImageROIProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. | - | [`ImageSourceName`]({{ site.parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MaxParallelTasks`]({{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputOriginalImage`]({{ site.parameters_reference }}capture-vision-template/output-original-Image.html) | Indicates whether DCV finally outputs the original input image. | - | [`SemanticProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. | - | [`Timeout`]({{ site.parameters_reference }}capture-vision-template/timeout.html) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`BaseTargetROIDefName`]({{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`PauseFlag`]({{ site.parameters_reference }}target-roi-def/pause-flag.html) | Indicates that the region results generated by this `TargetROIDef` will not be used by other `TargetROIDef` objects that depend on it to calculate the target regions, unless the user explicitly performs an update operation. | - | [`TaskSettingNameArray`]({{ site.parameters_reference }}target-roi-def/task-setting-name-array.html) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `DocumentNormalizerTaskSetting` objects. | - -## Document Normalizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`BaseDocumentNormalizerTaskSettingName`]({{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | - | [`Brightness`]({{ site.parameters_reference }}document-normalizer-task-settings/brightness.html) | Defines the brightness of the normalized image. | - | [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. | - | [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. | - | [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. | - | [`CornerAngleRange`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range.html) | Defines the range of angles (in degrees) of the extracted corners. | - | [`DeskewMode`]({{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | - | [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. | - | [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. | - | [`QuadrilateralDetectionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html) | Defines the quadrilateral detection process on an image. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`BaseImageParameterName`]({{ site.parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`RegionPredetectionModes`]({{ site.parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. | - | [`ScaleDownThreshold`]({{ site.parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`FileFilter`]({{ site.parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`PDFReadingMode`]({{ site.parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`Type`]({{ site.parameters_reference }}image-source-options/type.html) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`MaxTotalImageDimension`]({{ site.parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory | - -## Shared Parameter - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------- | ----------- | - | [`DirectoryPath`]({{ site.parameters_reference }}shared-parameter/directory-path.html) | Defines a path when the library have to read files. | - | [`MaxThreadsInOneTask`]({{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`SectionImageParameterArray`]({{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | \ No newline at end of file diff --git a/parameters-new/reference/index-v2.2.10.md b/parameters-new/reference/index-v2.2.10.md deleted file mode 100644 index 424e1bb..0000000 --- a/parameters-new/reference/index-v2.2.10.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Dynamsoft Document Normalizer Parameter Reference - Main Page -description: Dynamsoft Document Normalizer Parameter Reference - Main Page -keywords: parameter reference, parameters -needAutoGenerateSidebar: false -permalink: /parameters/reference/index-v2.2.10.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`ImageROIProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. | - | [`ImageSourceName`]({{ site.parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MinImageCaptureInterval`]({{ site.parameters_reference }}capture-vision-template/min-image-capture-interval.html) | Specifies the minimum time interval (in milliseconds) allowed between consecutive image captures. | - | [`MaxParallelTasks`]({{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputOriginalImage`]({{ site.parameters_reference }}capture-vision-template/output-original-Image.html) | Indicates whether DCV finally outputs the original input image. | - | [`SemanticProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. | - | [`Timeout`]({{ site.parameters_reference }}capture-vision-template/timeout.html) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`BaseTargetROIDefName`]({{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`PauseFlag`]({{ site.parameters_reference }}target-roi-def/pause-flag.html) | Indicates that the region results generated by this `TargetROIDef` will not be used by other `TargetROIDef` objects that depend on it to calculate the target regions, unless the user explicitly performs an update operation. | - | [`TaskSettingNameArray`]({{ site.parameters_reference }}target-roi-def/task-setting-name-array.html) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `DocumentNormalizerTaskSetting` objects. | - -## Document Normalizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`BaseDocumentNormalizerTaskSettingName`]({{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | - | [`Brightness`]({{ site.parameters_reference }}document-normalizer-task-settings/brightness.html) | Defines the brightness of the normalized image. | - | [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. | - | [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. | - | [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. | - | [`CornerAngleRange`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range.html) | Defines the range of angles (in degrees) of the extracted corners. | - | [`DeskewMode`]({{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | - | [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. | - | [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. | - | [`QuadrilateralDetectionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html) | Defines the quadrilateral detection process on an image. | - | [`MaxThreadsInOneTask`]({{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`SectionImageParameterArray`]({{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`BaseImageParameterName`]({{ site.parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`RegionPredetectionModes`]({{ site.parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. | - | [`ScaleDownThreshold`]({{ site.parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`FileFilter`]({{ site.parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`Pages`]({{ site.parameters_reference }}image-source-options/pages.html) | Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. | - | [`PDFReadingMode`]({{ site.parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`Type`]({{ site.parameters_reference }}image-source-options/type.html) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`MaxTotalImageDimension`]({{ site.parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory | diff --git a/parameters-new/reference/index.md b/parameters-new/reference/index.md deleted file mode 100644 index c466d74..0000000 --- a/parameters-new/reference/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Dynamsoft Document Normalizer Parameter Reference - Main Page -description: Dynamsoft Document Normalizer Parameter Reference - Main Page -keywords: parameter reference, parameters -needAutoGenerateSidebar: false -permalink: /parameters/reference/index.html ---- - -# Parameter Reference - -## Capture Vision Template - - | Parameter Name | Description | - | ---------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`ImageROIProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html) | Defines the collection of image ROI processing object names, used to refer to the `TargetROIDef` objects. | - | [`ImageSourceName`]({{ site.parameters_reference }}capture-vision-template/image-source-name.html) | Indicates the input source name, used to refer to the `ImageSource` object. | - | [`MinImageCaptureInterval`]({{ site.parameters_reference }}capture-vision-template/min-image-capture-interval.html) | Specifies the minimum time interval (in milliseconds) allowed between consecutive image captures. | - | [`MaxParallelTasks`]({{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html) | Defines the maximum number of parallel tasks for the DCV runtime. | - | [`OutputOriginalImage`]({{ site.parameters_reference }}capture-vision-template/output-original-Image.html) | Indicates whether DCV finally outputs the original input image. | - | [`SemanticProcessingNameArray`]({{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html) | Represents the collection of semantic-processing object names, used to refer to the `SematicProcessing` objects. | - | [`Timeout`]({{ site.parameters_reference }}capture-vision-template/timeout.html) | Defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. | - -## Target ROI Def - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`BaseTargetROIDefName`]({{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html) | Represents the name of another `TargetROIDef` object to inherit from. | - | [`Location`]({{ site.parameters_reference }}target-roi-def/location.html) | Defines the location of the TargetROI with `reference objects` filter conditions and `offset` parameters. | - | [`PauseFlag`]({{ site.parameters_reference }}target-roi-def/pause-flag.html) | Indicates that the region results generated by this `TargetROIDef` will not be used by other `TargetROIDef` objects that depend on it to calculate the target regions, unless the user explicitly performs an update operation. | - | [`TaskSettingNameArray`]({{ site.parameters_reference }}target-roi-def/task-setting-name-array.html) | Parameter `TaskSettingNameArray` represents the collection of task setting object names, used to refer to the `DocumentNormalizerTaskSetting` objects. | - -## Document Normalizer Task Setting - - | Parameter Name | Description | - | ------------------------------------------------------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`BaseDocumentNormalizerTaskSettingName`]({{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html) | Represents the name of another `DocumentNormalizerTaskSetting` object to inherit from. | - | [`Brightness`]({{ site.parameters_reference }}document-normalizer-task-settings/brightness.html) | Defines the brightness of the normalized image. | - | [`ColourMode`]({{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html) | Defines the output colour mode of the normalized image. | - | [`ContentType`]({{ site.parameters_reference }}document-normalizer-task-settings/content-type.html) | Defines which contents are the targeting objects. | - | [`Contrast`]({{ site.parameters_reference }}document-normalizer-task-settings/contrast.html) | Defines the contrast of the normalized image. | - | [`CornerAngleRange`]({{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range.html) | Defines the range of angles (in degrees) of the extracted corners. | - | [`DeskewMode`]({{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html) | Defines the method in which the deskew process way used to apply the deskew process on the target normalized image. | - | [`ExpectedDocumentsCount`]({{ site.parameters_reference }}document-normalizer-task-settings/expected-documents-count.html) | Defines the the number of documents expected to be detected. | - | [`LineExtractionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html) | Defines the algorithm used to extract lines. | - | [`PageSize`]({{ site.parameters_reference }}document-normalizer-task-settings/page-size.html) | Defines the page size (width by height in pixels) of the normalized image. | - | [`QuadrilateralDetectionModes`]({{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html) | Defines the quadrilateral detection process on an image. | - | [`MaxThreadsInOneTask`]({{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html) | Defines the maximum threads that can be consumed in one task. | - | [`SectionImageParameterArray`]({{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html) | Defines the image processing algorithms that implemented in the task. | - | [`StartSection`]({{ site.parameters_reference }}shared-parameter/start-section.html) | Defines the start section of the algorithm task. | - | [`TerminateSetting`]({{ site.parameters_reference }}shared-parameter/terminate-setting.html) | Defines the terminate stages of the task. | - -## ImageParameter - - | Parameter Name | Description | - | ---------------------------------------------------------------------------------------------------- | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`BaseImageParameterName`]({{ site.parameters_reference }}image-parameter/base-image-parameter-name.html) | Represents the name of another `ImageParameter` object to inherit from. | - | [`BinarizationModes`]({{ site.parameters_reference }}image-parameter/binarization-modes.html) | Defines the process of binarization | - | [`ColourConversionModes`]({{ site.parameters_reference }}image-parameter/colour-conversion-modes.html) | Defines how to convert a colour image to a grayscale image. | - | [`GrayscaleEnhancementModes`]({{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html) | Defines the image processing methods to enhance the quality of the grayscale image. | - | [`GrayscaleTransformationModes`]({{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html) | Defines whether or not to invert the color of the grayscale image. | - | [`IfEraseTextZone`]({{ site.parameters_reference }}image-parameter/if-erase-text-zone.html) | Defines whether to erase the detected text zone. | - | [`RegionPredetectionModes`]({{ site.parameters_reference }}image-parameter/region-predetection-modes.html) | Defines how to find a region of interest (ROI) within the image or frame. | - | [`ScaleDownThreshold`]({{ site.parameters_reference }}image-parameter/scale-down-threshold.html) | Defines the threshold for image shrinking. | - | [`ScaleUpModes`]({{ site.parameters_reference }}image-parameter/scale-up-modes.html) | Defines the scale-up process when targets in the image are too small. | - | [`TextDetectionMode`]({{ site.parameters_reference }}image-parameter/text-detection-mode.html) | Defines how to detect the text area. | - | [`TextureDetectionModes`]({{ site.parameters_reference }}image-parameter/texture-detection-modes.html) | Defines how to detect texture on an image. | - -## Image Source - - | Parameter Name | Description | - | ------------------------------------------------------------------------ | ----------- | - | [`Name`]({{ site.parameters_reference }}shared-parameter/name.html) | Represents the name of the top-level objects in Dynamsoft Capture Vision Parameter Template, which serves as its unique identifier. | - | [`FileFilter`]({{ site.parameters_reference }}image-source-options/file-filter.html) | Defines a file name filter string, which determines which files are fetched. | - | [`Pages`]({{ site.parameters_reference }}image-source-options/pages.html) | Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. | - | [`PDFReadingMode`]({{ site.parameters_reference }}image-source-options/pdf-reading-mode.html) | Defines how to handle PDF files. | - | [`Recursive`]({{ site.parameters_reference }}image-source-options/recursive.html) | Defines whether to fetch files recursively. | - | [`Type`]({{ site.parameters_reference }}image-source-options/type.html) | Defines the type of the ImageSource object, which helps CVR create the correct type of image source. | - -## Global Parameter - - | Parameter Name | Description | - | ----------------------------------------------------------------------------------------- | ----------- | - | [`MaxTotalImageDimension`]({{ site.parameters_reference }}global-parameter/max-total-image-dimension.html) | Defines the maximum total dimension of the images that read in the memory | diff --git a/parameters/parameter-organization-structure-v1.0.21.md b/parameters/parameter-organization-structure-v1.0.21.md deleted file mode 100644 index 6ddbc1b..0000000 --- a/parameters/parameter-organization-structure-v1.0.21.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -layout: default-layout -title: Parameter Organization Structure -keywords: organization, parameters, documentation -description: Dynamsoft Document Normalizer - Parameter Organization Structure ---- - -# Parameter Organization Structure - -This article introduces the organization structure of all parameters. - -## Definitions - -Dynamsoft Document Normalizer uses a template to organize parameters. A template is a `JSON` object which contains following keys: - -| Key Name | Description | -| -------- | ----------- | -| GlobalParameter | A JSON Object which defines a [GlobalParameter Object](#globalparameter-object). | -| ImageParameterArray | A JSON Object array which defines multiple [ImageParameter Objects](#imageparameter-object). | -| NormalizerParameterArray | A JSON Object array which defines multiple [NormalizerParameter Objects](#normalizerparameter-object). | - -### GlobalParameter Object - -A GlobalParameter object contains following keys: - -| Key Name | Description | -| -------- | ----------- | -| Name | (Required) A string value which specifies the name of current GlobalParameter object. | -| MaxTotalImageDimension | (Optional) Sets the parameter [MaxTotalImageDimension](reference/max-total-image-dimension.md). | - -### ImageParameter Object - -An ImageParameter object contains following keys: - -| Key Name | Description | -| -------- | ----------- | -| Name | (Required) A string value which specifies the name of current ImageParameter object. The name value must be unique between all ImageParameter objects. | -| RegionPredetectionModes | (Optional) Sets the parameter [RegionPredetectionModes](reference/region-predetection-modes.md). | -| Timeout | (Optional) Sets the parameter [Timeout](reference/timeout.md). | -| ColourChannelUsageType | (Optional) Sets the parameter [ColourChannelUsageType](reference/colour-channel-usage-type.md). | -| MaxThreadCount | (Optional) Sets the parameter [MaxThreadCount](reference/max-thread-count.md). | -| ScaleDownThreshold | (Optional) Sets the parameter [ScaleDownThreshold](reference/scale-down-threshold.md). | -| ColourConversionModes | (Optional) Sets the parameter [ColourConversionModes](reference/colour-conversion-modes.md). | -| GrayscaleTransformationModes | (Optional) Sets the parameter [GrayscaleTransformationModes](reference/grayscale-transformation-modes.md). | -| GrayscaleEnhancementModes | (Optional) Sets the parameter [GrayscaleEnhancementModes](reference/grayscale-enhancement-modes.md). | -| BinarizationModes | (Optional) Sets the parameter [BinarizationModes](reference/binarization-modes.md). | -| TextureDetectionModes | (Optional) Sets the parameter [TextureDetectionModes](reference/texture-detection-modes.md). | -| TextFilterModes | (Optional) Sets the parameter [TextFilterModes](reference/text-filter-modes.md). | -| LineExtractionModes | (Optional) Sets the parameter [LineExtractionModes](reference/line-extraction-modes.md). | -| NormalizerParameterName | (Optional) A string value which is the name of a [NormalizerParameter Object](#normalizerparameter-object). | -| BaseImageParameterName | (Optional) A string value which is the name of an [ImageParameter Object](#imageparameter-object). When a parameter is not explicitly set in current ImageParameter Object, it will inherit the value from base ImageParameter Object. If BaseImageParameterName is also not set, this parameter is set with parameter's default value. | - -### NormalizerParameter Object - -A NormalizerParameter object contains following keys: - -| Key Name | Description | -| -------- | ----------- | -| Name | (Required) A string value which specifies the name of current NormalizerParameter object. The name value must be unique between all NormalizerParameter objects. | -| ContentType | (Optional) Sets the parameter [ContentType](reference/content-type.md). | -| InteriorAngleRangeArray | (Optional) Sets the parameter [InteriorAngleRangeArray](reference/interior-angle-range-array.md). | -| QuadrilateralDetectionModes | (Optional) Sets the parameter [QuadrilateralDetectionModes](reference/quadrilateral-detection-modes.md). | -| DeskewMode | (Optional) Sets the parameter [DeskewMode](reference/deskew-mode.md). | -| PageSize | (Optional) Sets the parameter [PageSize](reference/page-size.md). | -| ColourMode | (Optional) Sets the parameter [ColourMode](reference/colour-mode.md). | -| Brightness | (Optional) Sets the parameter [Brightness](reference/brightness.md). | -| Contrast | (Optional) Sets the parameter [Contrast](reference/contrast.md). | - -## Example - -```json -{ - "GlobalParameter":{ - "Name":"GP", - "MaxTotalImageDimension":0 - }, - "ImageParameterArray":[ - { - "Name":"IP-1", - "RegionPredetectionModes":[ - { - "Mode": "RPM_GENERAL" - } - ], - "Timeout": 10000, - "ColourChannelUsageType": "CCUT_AUTO", - "MaxThreadCount": 4, - "ScaleDownThreshold": 2300, - "ColourConversionModes":[ - { - "Mode": "CICM_GENERAL", - "BlueChannelWeight": -1, - "GreenChannelWeight": -1, - "RedChannelWeight": -1 - } - ], - "GrayscaleTransformationModes":[ - { - "Mode": "GTM_ORIGINAL" - } - ], - "GrayscaleEnhancementModes": [ - { - "Mode": "GEM_GENERAL" - } - ], - "BinarizationModes":[ - { - "Mode": "BM_LOCAL_BLOCK", - "BlockSizeX": 0, - "BlockSizeY": 0, - "EnableFillBinaryVacancy": 0, - "MorphOperation": "Close", - "MorphShape": "Rectangle", - "MorphOperationKernelSizeX": -1, - "MorphOperationKernelSizeY": -1, - "ThresholdCompensation": 10 - } - ], - "TextureDetectionModes":[ - { - "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION", - "Sensitivity": 5 - } - ], - "TextFilterModes": [ - { - "Mode": "TFM_GENERAL_CONTOUR", - "IfEraseTextZone": 0, - "MinImageDimension": 65536, - "Sensitivity": 0 - } - ], - "LineExtractionModes": [ - { - "Mode": "LEM_GENERAL" - } - ], - "NormalizerParameterName":"NP-1", - "BaseImageParameterName":"" - } - ], - "NormalizerParameterArray":[ - { - "Name":"NP-1", - "ContentType": "CT_DOCUMENT", - "InteriorAngleRangeArray": [ - { - "MinValue": 70, - "MaxValue": 110 - } - ], - "QuadrilateralDetectionModes": [ - { - "Mode": "QDM_GENERAL" - } - ], - "DeskewMode": { - "Mode": "DM_PERSPECTIVE_CORRECTION", - "ContentDirection": 0 - }, - "PageSize": [-1, -1], - "ColourMode": "ICM_BINARY", - "Brightness": 0, - "Contrast": 0 - } - ] -} -``` diff --git a/parameters/parameter-organization-structure.md b/parameters/parameter-organization-structure.md deleted file mode 100644 index fc7f076..0000000 --- a/parameters/parameter-organization-structure.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Parameters under Dynamsoft Capture Vision -description: Introduce the parameters design of Dynamsoft Capture Vision related to Dynamsoft Document Normalizer. -keywords: Parameter, Parameter Template, Parameter Template File, Dynamsoft Document Normalizer -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true ---- - -# Overview of Dynamsoft Capture Vision parameters Related to Dynamsoft Document Normalizer - -Starting in version 2.0, Dynamsoft Document Normalizer is restructured under Dynamsoft Capture Vision Framework. - -Dynamsoft Capture Vision (DCV) is designed for high scalability and flexibility, and its parameter system plays a crucial role in achieving this goal. The parameter system is highly configurable and can drive different behavior logic within the SDK. In this article, we will provide an overview of the parametric architecture design regarding the use of Dynamsoft Document Normalizer in the Dynamsoft Capture Vision framework. - -## Key Terms - -In order to eliminate ambiguity, we first define several key terms. - -1. **Parameter** - A parameter is designed to represent a particular aspect of the behavior of the SDK, and each parameter has its own name. For instance, the `ExpectedBarcodeCount` parameter is used to control the expected count of recognized barcodes. Parameters can be configured with specific values or ranges of values, which can be adjusted as required. - -2. **Parameter template** - A parameter template is a collection of parameters organized in a structured manner, expressed in JSON format. The name of the `CaptureVisionTemplate` object is also called "template name", which is a unique identifier assigned to each parameter template. In the DCV SDK, this name is used to load the relevant configurations and control runtime behavior. - -3. **Parameter template file** - A parameter template file is a JSON file that contains one or multiple parameter templates. - -## Organization of a Parameter Template File - -As shown in the example below, the organizational structure of a parameter template file consists of several top-level objects such as `CaptureVisionTemplates`, `ImageSourceOptions`,`TargetROIDefOptions` etc. - -```json -{ - "CaptureVisionTemplates": [ - { - "Name" : "CV_0", - "ImageSourceName": "ISA_0", - "ImageROIProcessingNameArray": ["TA_0" ], - "SemanticProcessingNameArray": ["SP_0"] - } - ], - "ImageSourceOptions": [ - { - "Name": "ISA_0" - } - ], - "TargetROIDefOptions" : [ - { - "Name" : "TA_0", - "TaskSettingNameArray": [ "LR_0", "BR_0", "DN_0" ] - } - ], - "ImageParameterOptions": [ - { - "Name": "IP_0" - } - ], - "DocumentNormalizerTaskSettingOptions": [ - { - "Name" : "DN_0" - } - ], - "GlobalParameter":{ - "MaxTotalImageDimension":0 - } -} -``` - -With the exception of GlobalParameter, all top-level objects in the parameter template file are arrays of the corresponding object. For example,`CaptureVisionTemplates` are an array of `CaptureVisionTemplate` objects, and `TargetROIDefOptions` are an array of `TargetROIDef` objects. - -Furthermore, to reuse the same parameter definitions, reduce the size of the parameter template file, and simplify the parameter configuration hierarchy, the reference relationship was adopted in the parameter template file design. For example, the value of the `ImageSource` parameter for the first object in `CaptureVisionTemplates` is `ISA_0`, which refers to the first object in `ImageSourceOptions`. - -Therefore, a parameter template starts with an object in `CaptureVisionTemplates` and recursively searches for the objects that are directly or indirectly referenced by it, and then combines them to form a specific set of parameters. Then, the parameter template may be applied to DCV through "template name" to control its internal execution logic. - -Next, we will focus on introducing some main objects and their relationships in a parameter template. - -## Structure of a Parameter Template - -The following table list the main objects type and description of a complete parameter template when using only Dynamsoft Document Normalizer: - -| Object Type | Description | -| :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| CaptureVisionTemplate | This is the entry object of a parameter template in DCV. The `Name` parameter represents the name of the parameter template, which serves as its unique identifier. | -| ImageSource | It defines the input for DCV, responsible for providing images to DCV. It can be defined as different image sources, including but not limited to image directories, scanners, cameras, etc. | -| TargetROIDef | It is used to specify one or more recognition tasks to be performed on some regions of interest (ROIs) within an image. | -| DocumentNormalizerTaskSetting | It is used to configure the document detection or normalization process of an image in DCV. | -| ImageParameter | It provides various image-processing features to adjust and enhance the input image for better recognition results. | - -For more details, please refer to [introduction of the capture vision template]({{ site.dcv_parameters }}file/capture-vision-template.html) - -## How to Apply DCV Parameters - -Dynamsoft Capture Vision (DCV) provides two methods to apply parameters: - -- `SimplifiedCaptureVisionSettings`: It is a structure that contains commonly used DCV parameters. To update DCV parameters using `SimplifiedCaptureVisionSettings`, you can follow these steps: - - 1. Call the `GetSimplifiedSettings` API to get the `SimplifiedCaptureVisionSettings` object named `dcv_settings` associated with the Dynamsoft Capture Vision Router instance. - 2. Modify the attributes of `dcv_settings`. - 3. Call the `UpdateSettings` API to apply the modified `dcv_settings`. - -- `JSON parameter template file/string` - It supports all DCV parameters. The related parameter setting APIs are: - - 1. `InitSettings/InitSettingsFromFile` - after calling this interface, each parameter template in the file/string will be converted into a single parameter template object. They will replace the previously associated parameter template objects on the Capture Vision Router instance. - - 2. `ResetSettings` - after calling this API, the internal associated parameter template objects are reset to the factory state. - -## Special Rules for DCV Parameter Configuration - -In this section, we will discuss some special rules for configuring the DCV parameter templates. Understanding these rules will help you efficiently configure a simple and user-friendly parameter template. - -### Default Value of Parameters - -Generally, the DCV parameter templates have been designed with many common scenarios in mind, so the default values of many parameters do not need to be modified. When configuring a custom template, you only need to configure required parameters and fine-tuning parameters related to business scenarios. Other optional parameters are automatically filled with default values. This simplifies your configuration and makes your templates easier to read. - -### Inherited Parameters - -Sometimes, we need to configure multiple templates to adapt to different scenarios, but only a few parameter values differ between each template. DCV provides a parameter configuration inheritance mechanism that further reduces the amount of configuration work. -For example, when configuring `IP_A` and `IP_B` objects in `ImageParameterOptions`, you can define a `BaseImageParameterName` parameter in the `IP_B` object with a value of `IP_A`. Then `IP_B` object will inherit all the parameter definitions of `IP_A`, and if `IP_B` defines a parameter with the same name but a different value, that parameter will adopt the value of `IP_B`. - -This allows you to create a new parameter template that inherits most of its configuration from an existing template, reducing the amount of repetitive configuration work needed. diff --git a/parameters/reference/assets/margin.png b/parameters/reference/assets/margin.png deleted file mode 100644 index 06aa3fd..0000000 Binary files a/parameters/reference/assets/margin.png and /dev/null differ diff --git a/parameters/reference/binarization-modes.md b/parameters/reference/binarization-modes.md deleted file mode 100644 index 0049d9e..0000000 --- a/parameters/reference/binarization-modes.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -layout: default-layout -title: BinarizationModes -keywords: binarizationmodes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - BinarizationModes ---- - - -# BinarizationModes - -This parameter helps control the binarization process, which converts a grayscale image to a binary image, and potentially result in a higher quality binary image. During binarization, the threshold is the key criteria. If a pixel's value is smaller than the threshold, it is set to 0. Otherwise, the pixel value is set to the maximum value (255 in the library). By default, the library automatically calculates the adaptive size of the neighbourhood area and then binarizes the grayscale image with the adaptive threshold based on a small neighbourhood area with an adaptive size around it. - -It consists of one or more modes, each mode is a way to implement the binarization. - -## Candidate Mode List - -- BM_LOCAL_BLOCK -- BM_THRESHOLD - -### BM_LOCAL_BLOCK - -Binarizes the image for each pixel based on a threshold which is calculated based on a small region around said pixel. This mode has the following arguments for further customization: - -- [`BlockSizeX`](#blocksizex) -- [`BlockSizeY`](#blocksizey) -- [`EnableFillBinaryVacancy`](#enablefillbinaryvacancy) -- [`MorphOperation`](#morphoperation) -- [`MorphOperationKernelSizeX`](#morphoperationkernelsizex) -- [`MorphOperationKernelSizeY`](#morphoperationkernelsizey) -- [`MorphShape`](#morphshape) -- [`ThresholdCompensation`](#thresholdcompensation) - -### BM_THRESHOLD - -Binarizes the image for each pixel based on a unified threshold. If the gray value of the pixel is less than the threshold, it will be black in the binary image, otherwise it will be white. This mode has the following arguments for further customization: - -- [`BinarizationThreshold`](#binarizationthreshold) -- [`MorphOperation`](#morphoperation) -- [`MorphOperationKernelSizeX`](#morphoperationkernelsizex) -- [`MorphOperationKernelSizeY`](#morphoperationkernelsizey) -- [`MorphShape`](#morphshape) - -## Setting Methods - -### As Json Parameter - -`BinarizationModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | BinarizationModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Sets a binarization mode. | -| BinarizationThreshold | A number from value range of BinarizationThreshold | (Optional) Sets the Argument [BinarizationThreshold](#binarizationthreshold). | -| BlockSizeX | A number from value range of BlockSizeX | (Optional) Sets the Argument [BlockSizeX](#blocksizex). | -| BlockSizeY | A number from value range of BlockSizeY | (Optional) Sets the Argument [BlockSizeY](#blocksizey). | -| EnableFillBinaryVacancy | A number from value range of EnableFillBinaryVacancy | (Optional) Sets the Argument [EnableFillBinaryVacancy](#enablefillbinaryvacancy). | -| MorphOperation | A string from value range of MorphOperation | (Optional) Sets the Argument [MorphOperation](#morphoperation). | -| MorphOperationKernelSizeX | A number from value range of MorphOperationKernelSizeX | (Optional) Sets the Argument [MorphOperationKernelSizeX](#morphoperationkernelsizex). | -| MorphOperationKernelSizeY | A number from value range of MorphOperationKernelSizeY | (Optional) Sets the Argument [MorphOperationKernelSizeY](#morphoperationkernelsizey). | -| MorphShape | A number from value range of MorphShape | (Optional) Sets the Argument [MorphShape](#morphshape). | -| ThresholdCompensation | A number from value range of ThresholdCompensation | (Optional) Sets the Argument [ThresholdCompensation](#thresholdcompensation). | - -**Default Value** - -```json -{ - "BinarizationModes":[ - { - "Mode": "BM_LOCAL_BLOCK", - "BlockSizeX": 0, - "BlockSizeY": 0, - "EnableFillBinaryVacancy": 0, - "MorphOperation": "Close", - "MorphShape": "Rectangle", - "MorphOperationKernelSizeX": -1, - "MorphOperationKernelSizeY": -1, - "ThresholdCompensation": 10 - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "BinarizationModes": [ - { - "Mode": "BM_LOCAL_BLOCK", - "BlockSizeX": 51, - "BlockSizeY": 51, - "EnableFillBinaryVacancy": 0 - }, - { - "Mode": "BM_THRESHOLD", - "BinarizationThreshold": 120, - "MorphOperation": "Close", - "MorphShape": "Rectangle", - "MorphOperationKernelSizeX": 3, - "MorphOperationKernelSizeY": 3 - } - ] -} -``` - -## Candidate Argument List - -- [`BinarizationThreshold`](#binarizationthreshold) -- [`BlockSizeX`](#blocksizex) -- [`BlockSizeY`](#blocksizey) -- [`EnableFillBinaryVacancy`](#enablefillbinaryvacancy) -- [`MorphOperation`](#morphoperation) -- [`MorphOperationKernelSizeX`](#morphoperationkernelsizex) -- [`MorphOperationKernelSizeY`](#morphoperationkernelsizey) -- [`MorphShape`](#morphshape) -- [`ThresholdCompensation`](#thresholdcompensation) - -### BinarizationThreshold - -Sets the binarization threshold. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [-1, 255] | -1 | BM_THRESHOLD | - -**Remarks** --1: The value will be set automatically by the SDK. - -### BlockSizeX - -Sets the horizontal block size for the binarization process. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 1000] | 0 | BM_LOCAL_BLOCK | - -**Remarks** -Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. - -- 0: the block size used for binarization will be set to a value which is calculated automatically. -- N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N. - -### BlockSizeY - -Sets the vertical block size for the binarization process. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 1000] | 0 | BM_LOCAL_BLOCK | - -**Remarks** -Block size refers to the size of a pixel neighborhood used to calculate a threshold value for the pixel. - -- 0: the block size used for binarization will be set to a value which is calculated automatically. -- N: - - 1 <= N <= 3: the block size used for binarization will be set to 3. - - N > 3: the block size used for binarization will be set to N. - -### EnableFillBinaryVacancy - -Sets whether to enable binary vacancy filling. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 1] | 0 | BM_LOCAL_BLOCK | - -**Remarks** - -- 0: disable. -- 1: enable. - -### MorphOperation - -Sets the morph operation for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | "Erode"
    "Dilate"
    "Open"
    "Close" | "Close" | - -**Remarks** - -- "Erode": Perform erosion process. -- "Dilate": Perform dilation process. -- "Open": Perform erosion first, then perform dilation. -- "Close": Perform dilation first, then perform erosion. - -For more information, please check out [Image Processing in OpenCV - Morphological Transformations](https://docs.opencv.org/master/d9/d61/tutorial_py_morphological_ops.html) for reference. - -### MorphOperationKernelSizeX - -Sets the horizontal kernel size for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - -**Remarks** - -- 0: The value will be set automatically by the SDK. -- -1: Skip the morph operation. - -### MorphOperationKernelSizeY - - Sets the vertical kernel size for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [-1, 1000] | -1 | - -**Remarks** - -- 0: The value will be set automatically by the SDK. -- -1: Skip the morph operation. - -### MorphShape - - Sets the morph shape for the morphology process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *string* | "Rectangle"
    "Cross"
    "Ellipse" | "Rectangle" | - -### ThresholdCompensation - -Constant subtracted from the mean or weighted mean used for calculating the threshold. Normally, it is positive but may be zero or negative as well. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [-255, 255] and -10000 | 10 | BM_LOCAL_BLOCK | - -**Remarks** - -- -10000: The library may try multiple values for current process. diff --git a/parameters/reference/brightness.md b/parameters/reference/brightness.md deleted file mode 100644 index 1549b63..0000000 --- a/parameters/reference/brightness.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: Brightness -keywords: Brightness, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - Brightness ---- - -# Brightness - -`Brightness` specifies the brightness of the normalized image. - -## Setting Methods - -### As Json Parameter - -`Brightness` as a JSON parameter is a number value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| NormalizerParameter | Brightness | *int* | [-100, 100] | 0 | - -**Example** - -```json -{ - "Brightness": 50, -} -``` diff --git a/parameters/reference/colour-channel-usage-type.md b/parameters/reference/colour-channel-usage-type.md deleted file mode 100644 index 39c49e0..0000000 --- a/parameters/reference/colour-channel-usage-type.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: ColourChannelUsageType -keywords: ColourChannelUsageType, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - ColourChannelUsageType ---- - -# ColourChannelUsageType - -`ColourChannelUsageType` specifies how to use the colour channel from the source image buffer. - -## Setting Methods - -### As Json Parameter - -`ColourChannelUsageType` as a JSON parameter is a string value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| ImageParameter | ColourChannelUsageType | *string* | "CCUT_AUTO"
    "CCUT_FULL_CHANNEL"
    "CCUT_NV21_Y_CHANNEL_ONLY"
    "CCUT_RGB_R_CHANNEL_ONLY"
    "CCUT_RGB_G_CHANNEL_ONLY"
    "CCUT_RGB_B_CHANNEL_ONLY" | "CCUT_AUTO" | - -**Example** - -```json -{ - "ColourChannelUsageType": "CCUT_NV21_Y_CHANNEL_ONLY", -} -``` diff --git a/parameters/reference/colour-conversion-modes.md b/parameters/reference/colour-conversion-modes.md deleted file mode 100644 index 2f59794..0000000 --- a/parameters/reference/colour-conversion-modes.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -layout: default-layout -title: ColourConversionModes -keywords: ColourConversionModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - ColourConversionModes ---- - -# ColourConversionModes - -This parameter helps control the process of colour conversion, i.e. converting a colour image to a grayscale image. If you input a colour image, the library will convert it to a grayscale image first for further processing. By default, the conversion will be based on the RGB channel with the default weights of each of the three channels. This parameter allows you to specify the referred colour channel (RGB or HSV) and the weight of each channel during the colour conversion. Assume your image has a very high contrast of one colour channel between the content area and background, you can use this parameter to put more weight on that specific colour channel to get a higher quality grayscale image. - -It consists of one or more modes, each mode represents a way to implement the convertion. - -## Candidate Mode List - -- CICM_GENERAL -- CICM_HSV - -### CICM_GENERAL - -Converts a colour image to a grayscale image using the general RGB conversion algorithm. This mode has the following arguments for further customization. - -- [BlueChannelWeight](#bluechannelweight) -- [GreenChannelWeight](#greenchannelweight) -- [RedChannelWeight](#redchannelweight) - -### CICM_HSV - -Converts a colour image to a grayscale image using one of the HSV channels. This mode has the following arguments for further customizing. - -- [ReferChannel](#referchannel) - -## Setting Methods - -### As JSON Parameter - -`ColourConversionModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | ColourConversionModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for colour convertion. | -| BlueChannelWeight | A number from value range of BlueChannelWeight | (Optional) Sets the Argument [BlueChannelWeight](#bluechannelweight). | -| GreenChannelWeight | A number from value range of GreenChannelWeight | (Optional) Sets the Argument [GreenChannelWeight](#greenchannelweight). | -| RedChannelWeight | A number from value range of RedChannelWeight | (Optional) Sets the Argument [RedChannelWeight](#redchannelweight). | -| ReferChannel | A string from value range of ReferChannel | (Optional) Sets the Argument [ReferChannel](#referchannel). | - -**Default Value** - -```json -{ - "ColourConversionModes":[ - { - "Mode": "CICM_GENERAL", - "BlueChannelWeight": -1, - "GreenChannelWeight": -1, - "RedChannelWeight": -1 - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "ColourConversionModes": [ - { - "Mode": "CICM_GENERAL", - "BlueChannelWeight": 1000, - "GreenChannelWeight": 0, - "RedChannelWeight": 0 - }, - { - "Mode": "CICM_GENERAL", - "BlueChannelWeight": 0, - "GreenChannelWeight": 500, - "RedChannelWeight": 500 - } - ] -} -``` - -## Candidate Argument List - -- [BlueChannelWeight](#bluechannelweight) -- [GreenChannelWeight](#greenchannelweight) -- [RedChannelWeight](#redchannelweight) -- [ReferChannel](#referchannel) - -### BlueChannelWeight - -Sets the weight value of Blue Colour Channel used for converting a colour image to a grayscale image. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [-1, 1000] | -1 | CICM_GENERAL | - -**Remarks** - -- -1: The weight value will be set automatically by the SDK. -- -1 will be used if the sum of BlueChannelWeight, GreenChannelWeight and RedChannelWeight is not 1000. - -### GreenChannelWeight - -Sets the weight value of Green Colour Channel used for converting a colour image to a grayscale image. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [-1, 1000] | -1 | CICM_GENERAL | - -**Remarks** - -- -1: The weight value will be set automatically by the SDK. -- -1 will be used if the sum of BlueChannelWeight, GreenChannelWeight and RedChannelWeight is not 1000. - -### RedChannelWeight - -Sets the weight value of Red Colour Channel used for converting a colour image to a grayscale image. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [-1, 1000] | -1 | CICM_GENERAL | - -**Remarks** - -- -1: The weight value will be set automatically by the SDK. -- -1 will be used if the sum of BlueChannelWeight, GreenChannelWeight and RedChannelWeight is not 1000. - -### ReferChannel - -Sets reference channel used for converting a colour image to a grayscale image by HSV algorithm. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | "H_CHANNEL"
    "S_CHANNEL"
    "V_CHANNEL" | "H_CHANNEL" | CICM_HSV | diff --git a/parameters/reference/colour-mode.md b/parameters/reference/colour-mode.md deleted file mode 100644 index 01ac991..0000000 --- a/parameters/reference/colour-mode.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: ColourMode -keywords: ColourMode, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - ColourMode ---- - -# ColourMode - -`ColourMode` specifies the colour mode (pixel type) of the normalized image. By default, the SDK produces normalized binary images, but you can choose to produce grayscale or colour normalized images. - -## Setting Methods - -### As Json Parameter - -`ColourMode` as a JSON parameter is a string value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| NormalizerParameter | ColourMode | *string* | "ICM_BINARY"
    "ICM_GRAYSCALE"
    "ICM_COLOUR" | "ICM_BINARY" | - -**Example** - -```json -{ - "ColourMode": "ICM_COLOUR", -} -``` diff --git a/parameters/reference/content-type.md b/parameters/reference/content-type.md deleted file mode 100644 index e855f52..0000000 --- a/parameters/reference/content-type.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: ContentType -keywords: ContentType, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - ContentType ---- - -# ContentType - -`ContentType` specifies the target content type to be normalized. Currently, DDN supports normalizing documents or table structures. - -## Setting Methods - -### As Json Parameter - -`ContentType` as a JSON parameter is a string value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| NormalizerParameter | ContentType | *string* | "CT_DOCUMENT"
    "CT_TABLE"
    "CT_UNKNOWN" | "CT_DOCUMENT" | - -**Example** - -```json -{ - "ContentType": "CT_TABLE", -} -``` diff --git a/parameters/reference/contrast.md b/parameters/reference/contrast.md deleted file mode 100644 index 6a0c2bc..0000000 --- a/parameters/reference/contrast.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: Contrast -keywords: Contrast, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - Contrast ---- - -# Contrast - -`Contrast` specifies the contrast of the normalized image. - -## Setting Methods - -### As Json Parameter - -`Contrast` as a JSON parameter is a number value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| NormalizerParameter | Contrast | *int* | [-100, 100] | 0 | - -**Example** - -```json -{ - "Contrast": 50, -} -``` diff --git a/parameters/reference/deskew-mode.md b/parameters/reference/deskew-mode.md deleted file mode 100644 index f1f6df9..0000000 --- a/parameters/reference/deskew-mode.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -layout: default-layout -title: DeskewMode -keywords: DeskewMode, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - DeskewMode ---- - -# DeskewMode - -`DeskewMode` specifies the method in which the deskew process way used to apply the deskew process on the target normalized image. It consisits one of one following candidate modes, each mode represents an implement. - -## Candidate Mode List - -- DM_PERSPECTIVE_CORRECTION - -### DM_PERSPECTIVE_CORRECTION - -Deskew the document by applying perspective correction process. This mode has the following arguments for further customizing. - -- [ContentDirection](#contentdirection) - -## Setting Methods - -### As JSON Parameter - -`DeskewMode` as a JSON parameter is a JSON Object defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | DeskewMode | A JSON Object defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for deskewing. | -| ContentDirection | A number from value range of ContentDirection | (Optional) Sets the Argument [ContentDirection](#contentdirection). | - -**JSON Parameter Example** - -```json -{ - "DeskewMode": { - "Mode": "DM_PERSPECTIVE_CORRECTION", - "ContentDirection": 0 - } -} -``` - -## Candidate Argument List - -- [ContentDirection](#contentdirection) - -### ContentDirection - -Sets the direction of the document to be normalized. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 2] | 0 | DM_PERSPECTIVE_CORRECTION | - -**Remarks** - -- 0: Direction unknown. -- 1: Vertical direction. -- 2: Horizontal direction. diff --git a/parameters/reference/grayscale-enhancement-modes.md b/parameters/reference/grayscale-enhancement-modes.md deleted file mode 100644 index afa8dbf..0000000 --- a/parameters/reference/grayscale-enhancement-modes.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -layout: default-layout -title: GrayscaleEnhancementModes -keywords: GrayscaleEnhancementModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - GrayscaleEnhancementModes ---- - -# GrayscaleEnhancementModes - -This parameter provides some image processing methods to enhance the quality of the grayscale image. By default, the library does no image preprocessing. Assume your image has distorted features that can be solved by common image processing methods, this parameter can help you get a higher quality grayscale image by shifting the order of the preprocessing algorithms used (if at all). - -It consists of one or more of the following modes, each mode representing a different preprocessing algorithm. - -## Candidate Mode List - -- GEM_GENERAL -- GEM_GRAY_EQUALIZE -- GEM_GRAY_SMOOTH -- GEM_SHARPEN_SMOOTH - -### GEM_GENERAL - -Takes the un-preprocessed grayscale image for the next stage of operations. - -### GEM_GRAY_EQUALIZE - -Preprocesses the grayscale image using the gray equalization algorithm. This mode can be used for images with low contrast between content and background colour. This mode has the following arguments for further customization. - -- [Sensitivity](#sensitivity) - -### GEM_GRAY_SMOOTH - -Preprocesses the grayscale image using the gray smoothing algorithm. This mode can be used for for images with noise or texture. This mode has the following arguments for further customization. - -- [SmoothBlockSizeX](#smoothblocksizex) -- [SmoothBlockSizeY](#smoothblocksizey) - -### GEM_SHARPEN_SMOOTH - -Preprocesses the grayscale image using the sharpening and smoothing algorithm. This mode can be used for blurry images. This mode has the following arguments for further customizing. - -- [SmoothBlockSizeX](#smoothblocksizex) -- [SmoothBlockSizeY](#smoothblocksizey) -- [SharpenBlockSizeX](#sharpenblocksizex) -- [SharpenBlockSizeY](#sharpenblocksizey) - -## Setting Methods - -### As JSON Parameter - -`GrayscaleEnhancementModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | GrayscaleEnhancementModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Sets a preprocessing mode. | -| Sensitivity | A number from value range of Sensitivity | (Optional) Sets the Argument [Sensitivity](#sensitivity). | -| SmoothBlockSizeX | A number from value range of SmoothBlockSizeX | (Optional) Sets the Argument [SmoothBlockSizeX](#smoothblocksizex). | -| SmoothBlockSizeY | A number from value range of SmoothBlockSizeY | (Optional) Sets the Argument [SmoothBlockSizeY](#smoothblocksizey). | -| SharpenBlockSizeX | A number from value range of SharpenBlockSizeX | (Optional) Sets the Argument [SmoothBlockSizeX](#sharpenblocksizex). | -| SharpenBlockSizeY | A number from value range of SharpenBlockSizeY | (Optional) Sets the Argument [SmoothBlockSizeY](#sharpenblocksizey). | - -**Default Value** - -```json -{ - "GrayscaleEnhancementModes": [ - { - "Mode": "GEM_GENERAL" - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "GrayscaleEnhancementModes": [ - { - "Mode": "GEM_GRAY_SMOOTH", - "SmoothBlockSizeX": 5, - "SmoothBlockSizeY": 5 - }, - { - "Mode": "GEM_GRAY_EQUALIZE", - "Sensitivity": 1 - } - ] -} -``` - -## Candidate Argument List - -- [Sensitivity](#sensitivity) -- [SmoothBlockSizeX](#smoothblocksizex) -- [SmoothBlockSizeY](#smoothblocksizey) -- [SharpenBlockSizeX](#sharpenblocksizex) -- [SharpenBlockSizeY](#sharpenblocksizey) - -### Sensitivity - -Sets the sensitivity to perform the equalization process. A larger value means a higher possibility that gray equalization will be activated. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [1, 9] | 5 | GEM_GRAY_EQUALIZE | - -### SmoothBlockSizeX - -Sets the horizontal block size(neighborhood pixel counts) for the smoothing process. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [3, 1000] | 3 | GEM_GRAY_SMOOTH
    GEM_SHARPEN_SMOOTH | - -### SmoothBlockSizeY - -Sets the vertical block size(neighborhood pixel counts) for the smoothing process. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [3, 1000] | 3 | GEM_GRAY_SMOOTH
    GEM_SHARPEN_SMOOT | - -### SharpenBlockSizeX - -Sets the horizontal block size(neighborhood pixel counts) for the sharpening process. - -| Value Type | Value Range | Default Value | -| ---------- | ----------- | ------------- | -| *int* | [3, 1000] | 3 | GEM_SHARPEN_SMOOTH | - -### SharpenBlockSizeY - -Sets the vertical block size(neighborhood pixel counts) for the sharpening process. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [3, 1000] | 3 | GEM_SHARPEN_SMOOTH | diff --git a/parameters/reference/grayscale-transformation-modes.md b/parameters/reference/grayscale-transformation-modes.md deleted file mode 100644 index 0d59731..0000000 --- a/parameters/reference/grayscale-transformation-modes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default-layout -title: GrayscaleTransformationModes -keywords: GrayscaleTransformationModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - GrayscaleTransformationModes ---- - -# GrayscaleTransformationModes - -`GrayscaleTransformationModes` helps control the colour mode of the grayscale image. - -It consists of one or more of the following modes, each mode representing a way to transform the grayscale image. - -## Candidate Mode List - -- GTM_ORIGINAL -- GTM_INVERTED -- GTM_AUTO - -### GTM_ORIGINAL - -Keeps the original grayscale. - -### GTM_INVERTED - -Transforms the image to inverted grayscale. - -### GTM_AUTO - -Let the library choose an algorithm automatically for grayscale transformation. - -## Setting Methods - -### As JSON Parameter - -`GrayscaleTransformationModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | GrayscaleTransformationModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for grayscale transformation. | - -**Default Value** - -```json -{ - "GrayscaleTransformationModes":[ - { - "Mode": "GTM_ORIGINAL" - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "GrayscaleTransformationModes": [ - { - "Mode": "GTM_ORIGINAL" - }, - { - "Mode": "GTM_INVERTED" - } - ] -} -``` diff --git a/parameters/reference/index-v1.0.20.md b/parameters/reference/index-v1.0.20.md deleted file mode 100644 index fd5c239..0000000 --- a/parameters/reference/index-v1.0.20.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Dynamsoft Document Normalizer - Parameter Reference -keywords: parameters, reference, documentation -description: Dynamsoft Document Normalizer - Parameter Reference ---- - -# Parameter Reference - -- [`BinarizationModes`](binarization-modes.md) -- [`Brightness`](brightness.md) -- [`ColourChannelUsageType`](colour-channel-usage-type.md) -- [`ColourConversionModes`](colour-conversion-modes.md) -- [`ColourMode`](colour-mode.md) -- [`ContentType`](content-type.md) -- [`Contrast`](contrast.md) -- [`DeskewMode`](deskew-mode.md) -- [`GrayscaleEnhancementModes`](grayscale-enhancement-modes.md) -- [`GrayscaleTransformationModes`](grayscale-transformation-modes.md) -- [`InteriorAngleRangeArray`](interior-angle-range-array.md) -- [`LineExtractionModes`](line-extraction-modes.md) -- [`MaxThreadCount`](max-thread-count.md) -- [`PageSize`](page-size.md) -- [`QuadrilateralDetectionModes`](quadrilateral-detection-modes.md) -- [`RegionPredetectionModes`](region-predetection-modes.md) -- [`ScaleDownThreshold`](scale-down-threshold.md) -- [`TextFilterModes`](text-filter-modes.md) -- [`TextureDetectionModes`](texture-detection-modes.md) -- [`Timeout`](timeout.md) diff --git a/parameters/reference/interior-angle-range-array.md b/parameters/reference/interior-angle-range-array.md deleted file mode 100644 index 8012e1a..0000000 --- a/parameters/reference/interior-angle-range-array.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default-layout -title: InteriorAngleRangeArray -keywords: InteriorAngleRangeArray, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - InteriorAngleRangeArray ---- - -# InteriorAngleRangeArray - -`InteriorAngleRangeArray` specifies the range of angles (in degrees) of the extracted corners. The corners refer to the corners of the quad or document. - -## Setting Methods - -### As JSON Parameter - -`InteriorAngleRangeArray` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| NormalizerParameter | InteriorAngleRangeArray | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | Key Default Value | -| -------- | --------- | ----------- | ----------------- | -| MinValue | A number from [0, 180] | Sets the minimum interior angle. | 70 | -| MaxValue | A number from [0, 180] | Sets the maximum interior angle. | 110 | - -**JSON Example** - -```json -{ - "InteriorAngleRangeArray": [ - { - "MinValue": 70, - "MaxValue": 110 - } - ] -} -``` diff --git a/parameters/reference/line-extraction-modes.md b/parameters/reference/line-extraction-modes.md deleted file mode 100644 index 1a8d5fb..0000000 --- a/parameters/reference/line-extraction-modes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default-layout -title: LineExtractionModes -keywords: LineExtractionModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - LineExtractionModes ---- - -# LineExtractionModes - -`LineExtractionModes` specifies the algorithm used to extract lines. - -It consists of one or both of the following modes, with each mode representing a different way to extract lines. - -## Candidate Mode List - -- LEM_GENERAL -- LEM_MARGIN_BASED - -### LEM_GENERAL - -Extracts lines using the general algorithm. - -### LEM_MARGIN_BASED - -Extracts lines based on the margin between the document content and the document border. Once the margin is found, the location of the document border is then calculated. - -
    -

    margin

    -

    Extracts Lines Based on Margin

    -
    - -## Setting Methods - -### As JSON Parameter - -`LineExtractionModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | LineExtractionModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for line extraction. | - -**Default Value** - -```json -{ - "LineExtractionModes": [ - { - "Mode": "LEM_GENERAL" - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "LineExtractionModes": [ - { - "Mode": "LEM_GENERAL" - }, - { - "Mode": "LEM_MARGIN_BASED" - } - ] -} -``` diff --git a/parameters/reference/max-thread-count.md b/parameters/reference/max-thread-count.md deleted file mode 100644 index 830c697..0000000 --- a/parameters/reference/max-thread-count.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: MaxThreadCount -keywords: MaxThreadCount, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - MaxThreadCount ---- - -# MaxThreadCount - -`MaxThreadCount` specifies the number of threads the image processing algorithm will use. - -## Setting Methods - -### As JSON Parameter - -`MaxThreadCount` as a JSON parameter is a number value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| ImageParameter | MaxThreadCount | *int* | [1, 4] | 4 | - -**Example** - -```json -{ - "MaxThreadCount": 1 -} -``` diff --git a/parameters/reference/max-total-image-dimension.md b/parameters/reference/max-total-image-dimension.md deleted file mode 100644 index 0a9c078..0000000 --- a/parameters/reference/max-total-image-dimension.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default-layout -title: MaxTotalImageDimension -keywords: MaxTotalImageDimension, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - MaxTotalImageDimension ---- - -# MaxTotalImageDimension - -`MaxTotalImageDimension` specifies the maximum value of the total dimension area (in millions of pixels) of the source images the library can process concurrently. For example, if the library is processing 10 images concurrently, and each image has dimensions of 1920x1080. Then the total area of all the images is (1920 * 1080 * 10 = 20,736,000 pixels). So if the MaxTotalImageDimension is set to a value of 20 (which would equate to 20 million pixels) then you can process only 9 of those images at a time. - -## Setting Methods - -### As JSON Parameter - -`MaxTotalImageDimension` as a JSON parameter is a number value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | --------------- | ----------------- | -| GlobalParameter | MaxTotalImageDimension | *int* | [0, 0x7fffffff] | 0 | - -**Remarks** - -- 0: no limitation on the total image dimension. - -**Example** - -```json -{ - "MaxTotalImageDimension": 0 -} -``` diff --git a/parameters/reference/page-size.md b/parameters/reference/page-size.md deleted file mode 100644 index a7913fc..0000000 --- a/parameters/reference/page-size.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: PageSize -keywords: PageSize, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - PageSize ---- - -# PageSize - -Sets the page size (width by height in pixels) of the normalized image. - -## Setting Methods - -### As Json Parameter - -`PageSize` as a JSON parameter is a string value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| NormalizerParameter | PageSize | *int array* | A value representing the page size defined as bellow | [-1, -1] | - -**Remarks** - -- A page size is defined as: [`TargetPageWidth`, `TargetPageHeight`] -- Allowed value range of `TargetPageWidth` and `TargetPageHeight`: [-1, 0x7fffffff] -- TargetPageWidth * TargetPageHeight < 100000000 -- If any of `TargetPageWidth` and `TargetPageHeight` is 0 or -1, the original width and height of the detected content will be used. - -**Example** - -```json -{ - "PageSize": [210, 297] -} -``` diff --git a/parameters/reference/quadrilateral-detection-modes.md b/parameters/reference/quadrilateral-detection-modes.md deleted file mode 100644 index 84d8a4e..0000000 --- a/parameters/reference/quadrilateral-detection-modes.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default-layout -title: QuadrilateralDetectionModes -keywords: QuadrilateralDetectionModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - QuadrilateralDetectionModes ---- - -# QuadrilateralDetectionModes - -`QuadrilateralDetectionModes` controls the quadrilateral detection process on an image. It currently includes only one mode. - -## Candidate Mode List - -- QDM_GENERAL - -### QDM_GENERAL - -Detects quadrilateral(s) using the general algorithm. - -## Setting Methods - -### As JSON Parameter - -`QuadrilateralDetectionModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| NormalizerParameter | QuadrilateralDetectionModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for quadrilateral detection. | - -**JSON Parameter Example** - -```json -{ - "QuadrilateralDetectionModes": [ - { - "Mode": "QDM_GENERAL" - } - ] -} -``` diff --git a/parameters/reference/region-predetection-modes.md b/parameters/reference/region-predetection-modes.md deleted file mode 100644 index d84a4fc..0000000 --- a/parameters/reference/region-predetection-modes.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -layout: default-layout -title: RegionPredetectionModes -keywords: RegionPredetectionModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - RegionPredetectionModes ---- - -# RegionPredetectionModes - -`RegionPredetectionModes` controls how to find a region of interest (ROI) within the image or frame. It consists of one or more modes, each mode representing a different way to find a region of interest. - -## Candidate Mode List - -- RPM_AUTO -- RPM_GENERAL -- RPM_GENERAL_RGB_CONTRAST -- RPM_GENERAL_GRAY_CONTRAST -- RPM_GENERAL_HSV_CONTRAST -- RPM_MANUAL_SPECIFICATION - -### RPM_AUTO - -Lets the library automatically choose an algorithm to detect the region of interest(s). - -### RPM_GENERAL - -Takes the whole image as a region of interest. - -### RPM_GENERAL_RGB_CONTRAST - -Detects the ROI using the general algorithm based on RGB colour contrast. This mode has the following arguments for further customization. - -- [ImageParameterName](#imageparametername) -- [MinImageDimension](#minimagedimension) -- [RelativeRegions](#relativeregions) -- [Sensitivity](#sensitivity) -- [SpatialIndexBlockSize](#spatialindexblocksize) - -### RPM_GENERAL_GRAY_CONTRAST - -Detects the ROI using the general algorithm based on gray contrast. This mode has the following arguments for further customization. - -- [ImageParameterName](#imageparametername) -- [MinImageDimension](#minimagedimension) -- [RelativeRegions](#relativeregions) -- [Sensitivity](#sensitivity) -- [SpatialIndexBlockSize](#spatialindexblocksize) - -### RPM_GENERAL_HSV_CONTRAST - -Detects the ROI using the general algorithm based on HSV colour contrast. This mode has the following arguments for further customization. - -- [AspectRatioRange](#aspectratiorange ) -- [FindAccurateBoundary](#findaccurateboundary) -- [ForeAndBackgroundColours](#foreandbackgroundcolours) -- [HeightRange](#heightrange) -- [ImageParameterName](#imageparametername) -- [MinImageDimension](#minimagedimension) -- [RelativeRegions](#relativeregions) -- [Sensitivity](#sensitivity) -- [SpatialIndexBlockSize](#spatialindexblocksize) -- [WidthRange](#widthrange) - -### RPM_MANUAL_SPECIFICATION - -Defines the ROI directly by specifying the region coordinates. This mode has the following arguments for further customizing. - -- [FirstPoint](#firstpoint) -- [FourthPoint](#fourthpoint) -- [ImageParameterName](#imageparametername) -- [MeasuredByPercentage](#measuredbypercentage) -- [RelativeRegions](#relativeregions) -- [SecondPoint](#secondpoint) -- [ThirdPoint](#thirdpoint) - -## Setting Methods - -### As JSON Parameter - -`RegionPredetectionModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | RegionPredetectionModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode to find a region. | -| AspectRatioRange | A string from value range of AspectRatioRange | (Optional) Sets the Argument [AspectRatioRange](#aspectratiorange). | -| FindAccurateBoundary | A number from value range of FindAccurateBoundary | (Optional) Sets the Argument [FindAccurateBoundary](#findaccurateboundary). | -| ForeAndBackgroundColours | A string from value range of ForeAndBackgroundColours | (Optional) Sets the Argument [ForeAndBackgroundColours](#foreandbackgroundcolours). | -| HeightRange | A string from value range of HeightRange | (Optional) Sets the Argument [HeightRange](#heightrange). | -| ImageParameterName | A string from value range of ImageParameterName | (Optional) Sets the Argument [ImageParameterName](#imageparametername). | -| MinImageDimension | A number from value range of MinImageDimension | (Optional) Sets the Argument [MinImageDimension](#minimagedimension). | -| RelativeRegions | A string from value range of RelativeRegions | (Optional) Sets the Argument [RelativeRegions](#relativeregions). | -| Sensitivity | A number from value range of Sensitivity | (Optional) Sets the Argument [Sensitivity](#sensitivity). | -| SpatialIndexBlockSize | A number from value range of SpatialIndexBlockSize | (Optional) Sets the Argument [SpatialIndexBlockSize](#spatialindexblocksize). | -| WidthRange | A string from value range of WidthRange | (Optional) Sets the Argument [WidthRange](#widthrange). | - -**Default Value** - -```json -{ - "RegionPredetectionModes":[ - { - "Mode": "RPM_GENERAL" - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "RegionPredetectionModes": [ - { - "Mode": "RPM_GENERAL_RGB_CONTRAST", - "Sensitivity": 5 - }, - { - "Mode": "RPM_GENERAL_HSV_CONTRAST", - "WidthRange": "[100, 200]" - } - ] -} -``` - -## Candidate Argument List - -- [AspectRatioRange](#aspectratiorange ) -- [FindAccurateBoundary](#findaccurateboundary) -- [FirstPoint](#firstpoint) -- [ForeAndBackgroundColours](#foreandbackgroundcolours) -- [FourthPoint](#fourthpoint) -- [HeightRange](#heightrange) -- [ImageParameterName](#imageparametername) -- [MeasuredByPercentage](#measuredbypercentage) -- [MinImageDimension](#minimagedimension) -- [RelativeRegions](#relativeregions) -- [SecondPoint](#secondpoint) -- [Sensitivity](#sensitivity) -- [SpatialIndexBlockSize](#spatialindexblocksize) -- [ThirdPoint](#thirdpoint) -- [WidthRange](#widthrange) - -### AspectRatioRange - -Specifies a set (or multiple sets) of aspect ratio range for filtering the predetected region. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | A string value representing aspect ratio range sets. | "" | RPM_GENERAL_HSV_CONTRAST | - -**Remarks** - -- A set of aspect ratio range is defined as [`MinAspectRatio`, `MaxAspectRatio`]. -- Using a "";"" to separate multiple sets. -- Value range of `MinAspectRatio`, `MaxAspectRatio`: [1,10000] -- Aspect ratio equals to *height/width\*100*, while the height and width is from the bounding rectangle of the predetected region. - -### FindAccurateBoundary - -Sets whether to enable finding accurate boundary. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 1] | 0 | `RPM_GENERAL_HSV_CONTRAST` | - -**Remarks** - -- 0: disable. -- 1: enable. - -### FirstPoint - -Sets the first point of the region, which is usually the top-left corner. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int array* | A value representing a point | [0, 0] | RPM_MANUAL_SPECIFICATION | - -**Remarks** - -- A point is defined as [`x-coordinate`, `y-coordinate`]. -- When [MeasuredByPercentage](#measuredbypercentage) = 0, the valid value range for `x-coordinate` and `y-coordinate` is [0, 0x7fffffff]. -- When [MeasuredByPercentage](#measuredbypercentage) = 1, the valid value range for `x-coordinate` and `y-coordinate` is [0, 100]. - -### ForeAndBackgroundColours - -Specifies a set (or multiple sets) of the foreground and background colours used for region predetection algorithm. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | A string value representing one or more colour sets. | "" | RPM_GENERAL_HSV_CONTRAST | - -**Remarks** - -- This argument is **mandatory** for RPM_GENERAL_HSV_CONTRAST mode. If there is no manual setting, no region can be detected. -- A set of the foreground and background colours is defined as [`ForegroundColour`, `BackgroundColour`, `Tolerance`]. -- Using a "";"" to separate multiple sets. -- `ForegroundColour`and `BackgroundColour` are the Hue values in the HSV colour space for defining the foreground and background colours of the regions you want to predetect. The value -1 means black, gray, white. -- `Tolerance` is the allowable deviation of the Hue value defined by `ForegroundColour`. -- Value range of `ForegroundColour`, `BackgroundColour`: [-1,360] -- Value range of `Tolerance`: [0, 360] - -### FourthPoint - -Sets the fourth point of the region, which is usually the top-left corner. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int array* | A value representing a point | [0, 0] | RPM_MANUAL_SPECIFICATION | - -**Remarks** - -- A point is defined as [`x-coordinate`, `y-coordinate`]. -- When [MeasuredByPercentage](#measuredbypercentage) = 0, the valid value range for `x-coordinate` and `y-coordinate` is [0, 0x7fffffff]. -- When [MeasuredByPercentage](#measuredbypercentage) = 1, the valid value range for `x-coordinate` and `y-coordinate` is [0, 100]. - -### HeightRange - -Specifies a set (or multiple sets) of height range for filtering the predetected region. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | A string value representing height range sets. | "" | RPM_GENERAL_HSV_CONTRAST | - -**Remarks** - -- A set of height is defined as [`MinHeight`, `MaxHeight`]. -- Using a "";"" to separate multiple sets. -- Value range of `MinHeight`, `MaxHeight`: [1, 0x7fffffff] -- The height value is the height of the bounding rectangle of the predetected region. - -### ImageParameterName - -Specifies the name of ImageParameter Object which defines the parameters used for predetected region results. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | A string value representing the name of an ImageParameter Object. | "" | RPM_GENERAL_HSV_CONTRAST
    RPM_GENERAL_RGB_CONTRAST
    RPM_GENERAL_GRAY_CONTRAST
    RPM_MANUAL_SPECIFICATION | - -**Remarks** - -Definition of An [ImageParameter Object](../parameter-organization-structure.md#imageparameter-object). - -### MeasuredByPercentage - -Sets whether or not to use percentages to measure the coordinate. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 1] | 1 | RPM_MANUAL_SPECIFICATION | - -### MinImageDimension - -Sets the minimum image dimension (in pixels) to enable region pre-detection. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [16384, 0x7fffffff] | 262144 | RPM_GENERAL_HSV_CONTRAST
    RPM_GENERAL_RGB_CONTRAST
    RPM_GENERAL_GRAY_CONTRAST | - -**Remarks** - -The library will enable the region pre-detection feature only when the image dimension is larger than the given value. - -### RelativeRegions - -Sets the regions relative to the predetected region. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | A string value representing one or more regions. | "" | RPM_GENERAL_HSV_CONTRAST
    RPM_GENERAL_RGB_CONTRAST
    RPM_GENERAL_GRAY_CONTRAST
    RPM_MANUAL_SPECIFICATION | - -**Remarks** - -- Each region need to be defined as [`Left`, `Top`, `Right`, `Bottom`, `Index`]. If you want to define multiple regions, you can use a "";"" to separate them. -- `Left`, `Top`, `Right`, `Bottom` are four percentage values relative to top-left corner of the predetected region. -- `Index` means the index of a specific colour set in [`ForeAndBackgroundColours`](#foreandbackgroundcolours) which the current region is applied to. If the value of `index` is set to -1, the current region will be applied to all colour sets in [`ForeAndBackgroundColours`](#foreandbackgroundcolours). -- Value range of `Left`, `Top`, `Right`, `Bottom`: [-10000,10000] -- Value range of `Index`: [-1, 0x7fffffff] - -### SecondPoint - -Sets the second point of the region, which is usually the top-left corner. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int array* | A value representing a point | [0, 0] | RPM_MANUAL_SPECIFICATION | - -**Remarks** - -- A point is defined as [`x-coordinate`, `y-coordinate`]. -- When [MeasuredByPercentage](#measuredbypercentage) = 0, the valid value range for `x-coordinate` and `y-coordinate` is [0, 0x7fffffff]. -- When [MeasuredByPercentage](#measuredbypercentage) = 1, the valid value range for `x-coordinate` and `y-coordinate` is [0, 100]. - -### Sensitivity - -Sets the sensitivity used for region predetection algorithm. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [1, 9] | 1 | RPM_GENERAL_HSV_CONTRAST
    RPM_GENERAL_RGB_CONTRAST
    RPM_GENERAL_GRAY_CONTRAST | - -**Remarks** - -A larger value means the library will take more effort to detect regions. - -### SpatialIndexBlockSize -Sets the spatial index block size used for region predetection algorithm. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [1, 32] | 5 | RPM_GENERAL_HSV_CONTRAST
    RPM_GENERAL_RGB_CONTRAST
    RPM_GENERAL_GRAY_CONTRAST | - -**Remarks** - -The block size used for region predetection would be 2 to the power of N. The allowed values of SpatialIndexBlockSize is the power number (N=1,2,3...). - -### ThirdPoint - -Sets the third point of the region, which is usually the top-left corner. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int array* | A value representing a point | [0, 0] | RPM_MANUAL_SPECIFICATION | - -**Remarks** - -- A point is defined as [`x-coordinate`, `y-coordinate`]. -- When [MeasuredByPercentage](#measuredbypercentage) = 0, the valid value range for `x-coordinate` and `y-coordinate` is [0, 0x7fffffff]. -- When [MeasuredByPercentage](#measuredbypercentage) = 1, the valid value range for `x-coordinate` and `y-coordinate` is [0, 100]. - -### WidthRange - -Specifies a set (or multiple sets) of width range for filtering the predetected region. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *string* | A string value representing width range sets. | "" | RPM_GENERAL_HSV_CONTRAST | - -**Remarks** - -- A set of width is defined as [`MinWidth`, `MaxWidth`]. -- Using a "";"" to separate multiple sets. -- Value range of `MinWidth`, `MaxWidth`: [1, 0x7fffffff] -- The width value is the width of the bounding rectangle of the predetected region. diff --git a/parameters/reference/scale-down-threshold.md b/parameters/reference/scale-down-threshold.md deleted file mode 100644 index 6438504..0000000 --- a/parameters/reference/scale-down-threshold.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: ScaleDownThreshold -keywords: ScaleDownThreshold, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - ScaleDownThreshold ---- - -# ScaleDownThreshold - -`ScaleDownThreshold` controls the threshold used when shrinking an image. If the shorter edge size is larger than the given value, the library will calculate the required height and width of the image and shrink the image to that size. - -## Setting Methods - -### As JSON Parameter - -`ScaleDownThreshold` as a JSON parameter is a number value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| ImageParameter | ScaleDownThreshold | *int* | [512, 0x7fffffff] | 2300 | - -**Example** - -```json -{ - "ScaleDownThreshold": 2300 -} -``` diff --git a/parameters/reference/text-filter-modes.md b/parameters/reference/text-filter-modes.md deleted file mode 100644 index 6ddc851..0000000 --- a/parameters/reference/text-filter-modes.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -layout: default-layout -title: TextFilterModes -keywords: TextFilterModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - TextFilterModes ---- - -# TextFilterModes - -`TextFilterModes` is used to control how to filter texts on an image. It currently consists of a single mode. - -## Candidate Mode List - -- TFM_GENERAL_CONTOUR - -### TFM_GENERAL_CONTOUR - -Filters text using the general algorithm based on contour. This mode has the following arguments for further customization. - -- [IfEraseTextZone](#iferasetextzone) -- [MinImageDimension](#minimagedimension) -- [Sensitivity](#sensitivity) - -## Setting Methods - -### As JSON Parameter - -`TextFilterModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | TextFilterModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for text filtering. | -| IfEraseTextZone | A number from value range of IfEraseTextZone | (Optional) Sets the Argument [IfEraseTextZone](#iferasetextzone). | -| MinImageDimension | A number from value range of MinImageDimension | (Optional) Sets the Argument [MinImageDimension](#minimagedimension). | -| Sensitivity | A number from value range of Sensitivity | (Optional) Sets the Argument [Sensitivity](#sensitivity). | - -**Default Value** - -```json -{ - "TextFilterModes": [ - { - "Mode": "TFM_GENERAL_CONTOUR", - "IfEraseTextZone": 0, - "MinImageDimension": 65536, - "Sensitivity": 0 - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "TextFilterModes": [ - { - "Mode": "TFM_GENERAL_CONTOUR", - "Sensitivity": 5 - } - ] -} -``` - -## Candidate Argument List - -- [IfEraseTextZone](#iferasetextzone) -- [MinImageDimension](#minimagedimension) -- [Sensitivity](#sensitivity) - -### IfEraseTextZone - -Sets whether to erase the detected text zone. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 1] | 0 | TFM_GENERAL_CONTOUR | - -**Remarks** - -- 0: Do not erase the text zone. -- 1: Erase the text zone. - -### MinImageDimension - -Sets the minimum image dimension (in pixels) to enable text filtering. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [65536, 0x7fffffff] | 65536 | TFM_GENERAL_CONTOUR | - -**Remarks** - -The library will enable the region pre-detection feature only when the image dimension is larger than the given value. - -### Sensitivity - -Sets the sensitivity used for text filtering. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [0, 9] | 0 | TFM_GENERAL_CONTOUR | - -**Remarks** - -- 0: automatically set by the library. -- A larger value means the library will take more effort to filter text. diff --git a/parameters/reference/texture-detection-modes.md b/parameters/reference/texture-detection-modes.md deleted file mode 100644 index dcd9cf1..0000000 --- a/parameters/reference/texture-detection-modes.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: default-layout -title: TextureDetectionModes -keywords: TextureDetectionModes, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - TextureDetectionModes ---- - -# TextureDetectionModes - -`TextureDetectionModes` controls how to detect texture on an image. It currently only supports a single mode for texture detection. - -## Candidate Mode List - -- TDM_GENERAL_WIDTH_CONCENTRATION - -### TDM_GENERAL_WIDTH_CONCENTRATION - -Detects texture using the general algorithm. This mode has the following arguments for further customization. - -- [Sensitivity](#sensitivity) - -## Setting Methods - -### As JSON Parameter - -`TextureDetectionModes` as a JSON parameter is a JSON Object array defined as below. - -| Parent Json Object | Key Name | Key Value | -| ------------------ | ------------------- | ---------- | -| ImageParameter | TextureDetectionModes | A JSON Object array while each Object is defined as below | - -| Key Name | Key Value | Description | -| -------- | --------- | ----------- | -| Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for text filtering. | -| Sensitivity | A number from value range of Sensitivity | (Optional) Sets the Argument [Sensitivity](#sensitivity). | - -**Default Value** - -```json -{ - "TextureDetectionModes":[ - { - "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION", - "Sensitivity": 5 - } - ] -} -``` - -**JSON Parameter Example** - -```json -{ - "TextureDetectionModes": [ - { - "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION", - "Sensitivity": 1 - }, - { - "Mode": "TDM_GENERAL_WIDTH_CONCENTRATION", - "Sensitivity": 9 - } - ] -} -``` - -## Candidate Argument List - -- [Sensitivity](#sensitivity) - -### Sensitivity - -Sets the sensitivity used for texture detection. - -| Value Type | Value Range | Default Value | Valid For | -| ---------- | ----------- | ------------- | --------- | -| *int* | [1, 9] | 5 | TDM_GENERAL_WIDTH_CONCENTRATION | - -**Remarks** - -A larger value means the library will take more effort to detect texture. diff --git a/parameters/reference/timeout.md b/parameters/reference/timeout.md deleted file mode 100644 index 2d51376..0000000 --- a/parameters/reference/timeout.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default-layout -title: Timeout -keywords: Timeout, parameters, reference, documentation -description: Dynamsoft Document Normalizer Parameter Reference - Timeout ---- - -# Timeout - -`Timeout` determines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. It does not include the time taken to load/decode an image (Tiff, PNG, etc) from disk into memory. - -## Setting Methods - -### As JSON Parameter - -`Timeout` as a JSON parameter is a number value defined as below. - -| Parent Json Object | Key Name | Key Value Type | Key Value Range | Key Default Value | -| ------------------ | -------- | -------------- | ----------- | ------------- | -| ImageParameter | Timeout | *int* | [0, 0x7fffffff] | 10000 | - -**Remarks** - -- 0: no limitation on the time cost. - -**Example** - -```json -{ - "Timeout": 500 -} -```