From 54561c013d44f1810fab28f908476f06ae1e54d7 Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Tue, 8 Apr 2025 14:08:35 +0800 Subject: [PATCH 1/2] update to internal commit 2d6acb1e --- .../candidate-quad-edges-unit-v2.0.20.md | 65 ---- .../api-reference/corners-unit-v2.0.20.md | 65 ---- .../detected-quads-result-v2.0.0.md | 167 ---------- .../detected-quads-result-v2.0.20.md | 167 ---------- .../detected-quads-unit-v2.0.20.md | 62 ---- .../document-normalizer-module-v2.0.20.md | 46 --- .../cplusplus/api-reference/index-v2.0.0.md | 123 -------- .../cplusplus/api-reference/index-v2.2.0.md | 155 ---------- programming/cplusplus/api-reference/index.md | 155 ---------- .../api-reference/long-lines-unit-v2.0.0.md | 65 ---- .../api-reference/long-lines-unit-v2.0.20.md | 63 ---- .../normalized-image-unit-v2.0.20.md | 58 ---- .../normalized-images-result-v2.0.0.md | 168 ---------- .../normalized-images-result-v2.0.20.md | 168 ---------- ...ed-document-normalizer-settings-v2.2.10.md | 164 ---------- programming/index.md | 13 - .../candidate-quad-edges-unit.md | 2 +- .../python/api-reference/corners-unit.md | 2 +- .../api-reference/deskewed-image-element.md | 63 ++++ .../deskewed-image-result-item.md | 89 ++++++ .../api-reference/deskewed-image-unit.md | 65 ++++ .../detected-quad-element-v2.5.2100.md | 47 +++ .../api-reference/detected-quad-element.md | 21 ++ .../detected-quad-result-item-v2.5.2100.md | 55 ++++ .../detected-quad-result-item.md | 18 ++ .../api-reference/detected-quads-result.md | 2 +- .../api-reference/detected-quads-unit.md | 1 - .../api-reference/enhanced-image-element.md | 46 +++ .../enhanced-image-result-item.md | 55 ++++ .../api-reference/enhanced-image-unit.md | 63 ++++ .../api-reference/enum-image-colour-mode.md | 20 ++ programming/python/api-reference/index.md | 104 ------- .../python/api-reference/logic-lines-unit.md | 125 ++++++++ .../api-reference/normalized-images-result.md | 2 +- .../processed-document-result.md | 76 +++++ ...-document-normalizer-settings-v2.5.2100.md | 154 ++++++++++ ...simplified-document-normalizer-settings.md | 10 +- programming/python/index.md | 57 ---- programming/python/release-notes/dotnet-2.md | 15 - programming/python/release-notes/index.md | 11 - .../python/user-guide/getting-started.md | 289 ------------------ 41 files changed, 905 insertions(+), 2191 deletions(-) delete mode 100644 programming/cplusplus/api-reference/candidate-quad-edges-unit-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/corners-unit-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/detected-quads-result-v2.0.0.md delete mode 100644 programming/cplusplus/api-reference/detected-quads-result-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/detected-quads-unit-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/document-normalizer-module-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/index-v2.0.0.md delete mode 100644 programming/cplusplus/api-reference/index-v2.2.0.md delete mode 100644 programming/cplusplus/api-reference/index.md delete mode 100644 programming/cplusplus/api-reference/long-lines-unit-v2.0.0.md delete mode 100644 programming/cplusplus/api-reference/long-lines-unit-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/normalized-image-unit-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/normalized-images-result-v2.0.0.md delete mode 100644 programming/cplusplus/api-reference/normalized-images-result-v2.0.20.md delete mode 100644 programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.2.10.md delete mode 100644 programming/index.md create mode 100644 programming/python/api-reference/deskewed-image-element.md create mode 100644 programming/python/api-reference/deskewed-image-result-item.md create mode 100644 programming/python/api-reference/deskewed-image-unit.md create mode 100644 programming/python/api-reference/detected-quad-element-v2.5.2100.md create mode 100644 programming/python/api-reference/detected-quad-result-item-v2.5.2100.md create mode 100644 programming/python/api-reference/enhanced-image-element.md create mode 100644 programming/python/api-reference/enhanced-image-result-item.md create mode 100644 programming/python/api-reference/enhanced-image-unit.md create mode 100644 programming/python/api-reference/enum-image-colour-mode.md delete mode 100644 programming/python/api-reference/index.md create mode 100644 programming/python/api-reference/logic-lines-unit.md create mode 100644 programming/python/api-reference/processed-document-result.md create mode 100644 programming/python/api-reference/simplified-document-normalizer-settings-v2.5.2100.md delete mode 100644 programming/python/index.md delete mode 100644 programming/python/release-notes/dotnet-2.md delete mode 100644 programming/python/release-notes/index.md delete mode 100644 programming/python/user-guide/getting-started.md diff --git a/programming/cplusplus/api-reference/candidate-quad-edges-unit-v2.0.20.md b/programming/cplusplus/api-reference/candidate-quad-edges-unit-v2.0.20.md deleted file mode 100644 index 5df4ea9..0000000 --- a/programming/cplusplus/api-reference/candidate-quad-edges-unit-v2.0.20.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default-layout -title: CCandidateQuadEdgesUnit Class -description: This page shows CCandidateQuadEdgesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetCandidateQuadEdge, CCandidateQuadEdgesUnit, api reference -permalink: /programming/cplusplus/api-reference/candidate-quad-edges-unit-v2.0.20.html ---- - -# CCandidateQuadEdgesUnit Class - -The CCandidateQuadEdgesUnit class represents an intermediate result unit whose type is candidate quad edges. - -## Definition - -*Namespace:* dynamsoft::ddn::intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CCandidateQuadEdgesUnit: CIntermediateResultUnit -``` - -*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CCandidateQuadEdgesUnit - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the count of CandidateQuadEdge objects in current object.| -| [`GetCandidateQuadEdge`](#getcandidatequadedge) | Gets a CandidateQuadEdge object from current object by specifying a index. | - -### GetCount - -Gets the count of CandidateQuadEdge objects in current object. - -```cpp -int GetCount() -``` - -**Return Value** - -The count of CandidateQuadEdge objects in current object. - -### GetCandidateQuadEdge - -Gets a CandidateQuadEdge object from current object by specifying a index. - -```cpp -int GetCandidateQuadEdge(int index, CEdge* edge) -``` - -**Parameters** - -`[in] index` The index of the CandidateQuadEdge object. - -`[in, out] edge` The CandidateQuadEdge object got by the specific index. - -**Return Value** - -Returns the error code. - -**See Also** - -* [CEdge]({{ site.dcv_cpp_api }}core/basic-structures/edge.html) -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) diff --git a/programming/cplusplus/api-reference/corners-unit-v2.0.20.md b/programming/cplusplus/api-reference/corners-unit-v2.0.20.md deleted file mode 100644 index 2fd31a3..0000000 --- a/programming/cplusplus/api-reference/corners-unit-v2.0.20.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default-layout -title: CCornersUnit Class -description: This page shows CCornersUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetCorner, CCornersUnit, api reference -permalink: /programming/cplusplus/api-reference/corners-unit-v2.0.20.html ---- - -# CCornersUnit Class - -The CCornersUnit class represents an intermediate result unit whose type is corners. - -## Definition - -*Namespace:* dynamsoft::ddn::intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CCornersUnit: CIntermediateResultUnit -``` - -*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CCornersUnit - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the count of Corner objects in current object.| -| [`GetCorner`](#getcorner) | Gets a Corner object from current object by specifying a index. | - -### GetCount - -Gets the count of Corner objects in current object. - -```cpp -int GetCount() -``` - -**Return Value** - -The count of Corner objects in current object. - -### GetCorner - -Gets a Corner object from current object by specifying a index. - -```cpp -int GetCorner(int index, CCorner* corner) -``` - -**Parameters** - -`[in] index` The index of the Corner object. - -`[in, out] corner` The Corner object got by the specific index. - -**Return Value** - -Returns the error code. - -**See Also** - -* [CCorner]({{ site.dcv_cpp_api }}core/basic-structures/corner.html) -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) diff --git a/programming/cplusplus/api-reference/detected-quads-result-v2.0.0.md b/programming/cplusplus/api-reference/detected-quads-result-v2.0.0.md deleted file mode 100644 index 42fb6a3..0000000 --- a/programming/cplusplus/api-reference/detected-quads-result-v2.0.0.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -layout: default-layout -title: CDetectedQuadsResult Class -description: This page shows CDetectedQuadsResult class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetErrorCode, GetErrorString, GetItem, GetSourceImageHashId, GetSourceImageTag, CDetectedQuadsResult, api reference -permalink: /programming/cplusplus/api-reference/detected-quads-result-v2.0.0.html ---- - -# CDetectedQuadsResult Class - -The CDetectedQuadsResult class stores a captured result whose type is detected quads. - -## Definition - -*Namespace:* dynamsoft::ddn - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CDetectedQuadsResult -``` - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the number of detected quadrilaterals. | -| [`GetErrorCode`](#geterrorcode) | Gets the error code of the detection operation. | -| [`GetErrorString`](#geterrorstring) | Gets the error message of the detection operation. | -| [`GetItem`](#getitem) | Gets the detected quadrilateral item at a specified index. | -| [`HasItem`](#hasitem) | Check if the item is present in the array.| -| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the detected quads.| -| [`GetRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.| -| [`GetSourceImageHashId`](#getsourceimagehashid) | Gets the hash ID of the source image. | -| [`GetSourceImageTag`](#getsourceimagetag) | Gets the tag of the source image. | - -### GetCount - -Gets the number of detected quadrilaterals. - -```cpp -int GetCount() -``` - -**Return value** - -Returns the number of detected quadrilaterals. - -### GetErrorCode - -Gets the error code of the detection operation. - -```cpp -int GetErrorCode() -``` - -**Return value** - -Returns the error code. - -**See Also** - -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) - -### GetErrorString - -Gets the error message of the detection operation. - -```cpp -const char* GetErrorString() -``` - -**Return value** - -Returns a pointer to a null-terminated string that represents the error message. - -### GetItem - -Gets the detected quadrilateral item at a specified index. - -```cpp -const CDetectedQuadResultItem* GetItem(int index) const -``` - -**Parameters** - -`[in] index` The index of the detected quadrilateral to retrieve. - -**Return value** - -Returns a pointer to a CDetectedQuadResultItem object that represents the detected quadrilateral at the specified index. - -**See Also** - -* [CDetectedQuadResultItem](detected-quad-result-item.md) - -### HasItem - -Check if the item is present in the array. - -```cpp -bool HasItem(const CDetectedQuadResultItem* item) const -``` - -**Parameters** - -`[in] item` The specific item to check. - -**Return value** - -Returns a bool value indicating whether the item is present in the array or not. - -### RemoveItem - -Remove a specific item from the array in the detected quads. - -```cpp -int RemoveItem(const CDetectedQuadResultItem* item) -``` - -**Parameters** - -`[in] item` The specific item to remove. - -**Return value** - -Return value indicating whether the deletion was successful or not. - -### GetRotationTransformMatrix - -Get the rotation transformation matrix of the original image relative to the rotated image. - -```cpp -void GetRotationTransformMatrix(double matrix[9]) const; -``` - -**Parameters** - -`[out] matrix` A double array which represents the rotation transform matrix. - -### GetSourceImageHashId - -Gets the hash ID of the source image. - -```cpp -const char* GetSourceImageHashId() -``` - -**Return value** - -Returns a pointer to a null-terminated string that represents the hash ID of the source image. - -### GetSourceImageTag - -Gets the tag of the source image. - -```cpp -const CImageTag* GetSourceImageTag() -``` - -**Return value** - -Returns a pointer to a CImageTag object that represents the tag of the source image. - -**See Also** - -* [CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) diff --git a/programming/cplusplus/api-reference/detected-quads-result-v2.0.20.md b/programming/cplusplus/api-reference/detected-quads-result-v2.0.20.md deleted file mode 100644 index de5606f..0000000 --- a/programming/cplusplus/api-reference/detected-quads-result-v2.0.20.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -layout: default-layout -title: CDetectedQuadsResult Class -description: This page shows CDetectedQuadsResult class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetItemsCount, GetErrorCode, GetErrorString, GetItem, GetOriginalImageHashId, GetOriginalImageTag, CDetectedQuadsResult, api reference -permalink: /programming/cplusplus/api-reference/detected-quads-result-v2.0.20.html ---- - -# CDetectedQuadsResult Class - -The CDetectedQuadsResult class stores a captured result whose type is detected quads. - -## Definition - -*Namespace:* dynamsoft::ddn - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CDetectedQuadsResult -``` - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetItemsCount`](#getitemscount) | Gets the number of detected quadrilaterals. | -| [`GetErrorCode`](#geterrorcode) | Gets the error code of the detection operation. | -| [`GetErrorString`](#geterrorstring) | Gets the error message of the detection operation. | -| [`GetItem`](#getitem) | Gets the detected quadrilateral item at a specified index. | -| [`HasItem`](#hasitem) | Check if the item is present in the array.| -| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the detected quads.| -| [`GetRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.| -| [`GetOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the original image. | -| [`GetOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image. | - -### GetItemsCount - -Gets the number of detected quadrilaterals. - -```cpp -int GetItemsCount() -``` - -**Return value** - -Returns the number of detected quadrilaterals. - -### GetErrorCode - -Gets the error code of the detection operation. - -```cpp -int GetErrorCode() -``` - -**Return value** - -Returns the error code. - -**See Also** - -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) - -### GetErrorString - -Gets the error message of the detection operation. - -```cpp -const char* GetErrorString() -``` - -**Return value** - -Returns a pointer to a null-terminated string that represents the error message. - -### GetItem - -Gets the detected quadrilateral item at a specified index. - -```cpp -const CDetectedQuadResultItem* GetItem(int index) const -``` - -**Parameters** - -`[in] index` The index of the detected quadrilateral to retrieve. - -**Return value** - -Returns a pointer to a CDetectedQuadResultItem object that represents the detected quadrilateral at the specified index. - -**See Also** - -* [CDetectedQuadResultItem](detected-quad-result-item.md) - -### HasItem - -Check if the item is present in the array. - -```cpp -bool HasItem(const CDetectedQuadResultItem* item) const -``` - -**Parameters** - -`[in] item` The specific item to check. - -**Return value** - -Returns a bool value indicating whether the item is present in the array or not. - -### RemoveItem - -Remove a specific item from the array in the detected quads. - -```cpp -int RemoveItem(const CDetectedQuadResultItem* item) -``` - -**Parameters** - -`[in] item` The specific item to remove. - -**Return value** - -Return value indicating whether the deletion was successful or not. - -### GetRotationTransformMatrix - -Get the rotation transformation matrix of the original image relative to the rotated image. - -```cpp -void GetRotationTransformMatrix(double matrix[9]) const; -``` - -**Parameters** - -`[out] matrix` A double array which represents the rotation transform matrix. - -### GetOriginalImageHashId - -Gets the hash ID of the original image. - -```cpp -const char* GetOriginalImageHashId() -``` - -**Return value** - -Returns a pointer to a null-terminated string that represents the hash ID of the original image. - -### GetOriginalImageTag - -Gets the tag of the original image. - -```cpp -const CImageTag* GetOriginalImageTag() -``` - -**Return value** - -Returns a pointer to a CImageTag object that represents the tag of the original image. - -**See Also** - -* [CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) diff --git a/programming/cplusplus/api-reference/detected-quads-unit-v2.0.20.md b/programming/cplusplus/api-reference/detected-quads-unit-v2.0.20.md deleted file mode 100644 index aa423a4..0000000 --- a/programming/cplusplus/api-reference/detected-quads-unit-v2.0.20.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default-layout -title: CDetectedQuadsUnit Class -description: This page shows CDetectedQuadsUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetDetectedQuad, CDetectedQuadsUnit, api reference -permalink: /programming/cplusplus/api-reference/detected-quads-unit-v2.0.20.html ---- - -# CDetectedQuadsUnit Class - -The CDetectedQuadsUnit class represents an intermediate result unit whose type is detected quads. - -## Definition - -*Namespace:* dynamsoft::ddn::intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CDetectedQuadsUnit: CIntermediateResultUnit -``` - -*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CDetectedQuadsUnit - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the count of DetectedQuad objects in current object.| -| [`GetDetectedQuad`](#getdetectedquad) | Gets a DetectedQuad object from current object by specifying a index. | - -### GetCount - -Gets the count of DetectedQuad objects in current object. - -```cpp -int GetCount() -``` - -**Return Value** - -The count of DetectedQuad objects in current object. - -### GetDetectedQuad - -Gets a DetectedQuad object from current object by specifying a index. - -```cpp -const CDetectedQuadElement* GetDetectedQuad(int index) -``` - -**Parameters** - -`[in] index` The index of the DetectedQuad object. - -**Return Value** - -Returns the DetectedQuad object got by the specific index. - -**See Also** - -* [CDetectedQuadElement]({{cpp_api}}detected-quad-element.html) diff --git a/programming/cplusplus/api-reference/document-normalizer-module-v2.0.20.md b/programming/cplusplus/api-reference/document-normalizer-module-v2.0.20.md deleted file mode 100644 index 4e5089c..0000000 --- a/programming/cplusplus/api-reference/document-normalizer-module-v2.0.20.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default-layout -title: class CDocumentNormalizerModule - Dynamsoft Document Normalizer Classes -description: This page shows the C++ edition of the class CDocumentNormalizerModule in Document Normalizer Module. -keywords: document normalizer module, c++ -needAutoGenerateSidebar: true -needGenerateH3Content: true -breadcrumbText: C++ CDocumentNormalizerModule Class -permalink: /programming/cplusplus/api-reference/document-normalizer-module-v2.0.20.html ---- - -# CDocumentNormalizerModule - -The `CDocumentNormalizerModule` class defines general functions in the document normalizer module. - -## Definition - -*Namespace:* dynamsoft::ddn - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CDocumentNormalizerModule -``` - -## Methods Summary - -| Method | Description | -| --------------------------------------------------------- | -------------------------------------------------- | -| [GetVersion](#getversion) | Returns the version of the document normalizer module. | - -## GetVersion - -Returns the version of the document normalizer module. - -```cpp -static const char* GetVersion(); -``` - -**Parameters** - -None. - -**Return Value** - -Returns a const char pointer representing the version of the document normalizer module. diff --git a/programming/cplusplus/api-reference/index-v2.0.0.md b/programming/cplusplus/api-reference/index-v2.0.0.md deleted file mode 100644 index 7e14533..0000000 --- a/programming/cplusplus/api-reference/index-v2.0.0.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer C++ API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer SDK API Reference for C++ Language. -keywords: CDocumentNormalizer, api reference, C++ -permalink: /programming/cplusplus/api-reference/index-v2.0.0.html ---- - -# API Reference - C++ - -## Primary Class - -- [`CCaptureVisionRouter`]({{ site.dcv_cpp_api }}capture-vision-router/capture-vision-router.html) - -## Input - -- [`CDirectoryFetcher`]({{ site.dcv_cpp_api }}utility/directory-fetcher.html) -- [`CFileFetcher`]({{ site.dcv_cpp_api }}utility/file-fetcher.html) -- [`CImageSourceAdapter`]({{ site.dcv_cpp_api }}core/basic-structures/image-source-adapter.html) -- [`CProactiveImageSourceAdapter`]({{ site.dcv_cpp_api }}utility/proactive-image-source-adapter.html) - -## Final Results - -- [`CCapturedResultReceiver`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-receiver.html) -- [`CCapturedResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -- [`CCapturedResult`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result.html) -- [`CDetectedQuadResultItem`]({{ site.ddn_cpp_api }}detected-quad-result-item.html) -- [`CDetectedQuadsResult`]({{ site.ddn_cpp_api }}detected-quads-result.html) -- [`CNormalizedImageResultItem`]({{ site.ddn_cpp_api }}normalized-image-result-item.html) -- [`CNormalizedImagesResult`]({{ site.ddn_cpp_api }}normalized-images-result.html) -- [`CRawImageResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/raw-image-result-item.html) - -## Final Results Filters - -- [`CCapturedResultFilter`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-filter.html) -- [`CMultiFrameResultCrossFilter`]({{ site.dcv_cpp_api }}utility/multi-frame-result-cross-filter.html) - -## Intermediate Results - -- [`CIntermediateResultManager`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-manager.html) -- [`CIntermediateResultReceiver`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-receiver.html) -- [`CObservationParameters`]({{ site.dcv_cpp_api }}core/intermediate-results/observed-parameters.html) -- [`IntermediateResultExtraInfo`]({{ site.dcv_cpp_api }}core/structs/intermediate-result-extra-info.html) -- [`CIntermediateResult`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result.html) -- [`CIntermediateResultUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -- [`CPredetectedRegionsUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/predetected-regions-unit.html) -- [`CDetectedQuadsUnit`]({{ site.ddn_cpp_api }}detected-quads-unit.html) -- [`CNormalizedImagesUnit`]({{ site.ddn_cpp_api }}normalized-image-unit.html) -- [`CRegionObjectElement`]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -- [`CPredetectedRegionElement`]({{ site.dcv_cpp_api }}core/intermediate-results/predetected-region-element.html) -- [`CDetectedQuadElement`]({{ site.ddn_cpp_api }}detected-quad-element.html) -- [`CNormalizedImageElement`]({{ site.ddn_cpp_api }}normalized-image-element.html) -- [`CBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/binary-image-unit.html) -- [`CCandidateQuadEdgesUnit`]({{ site.ddn_cpp_api }}candidate-quad-edges-unit.html) -- [`CColourImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/colour-image-unit.html) -- [`CContoursUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/contours-unit.html) -- [`CCornersUnit`]({{ site.ddn_cpp_api }}corners-unit.html) -- [`CEnhancedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/enhanced-grayscale-image-unit.html) -- [`CGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/grayscale-image-unit.html) -- [`CLineSegmentsUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/line-segments-unit.html) -- [`CLongLinesUnit`]({{ site.ddn_cpp_api }}long-lines-unit.html) -- [`CScaledDownColourImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/scaled-down-colour-image-unit.html) -- [`CTextRemovedBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/text-removed-binary-image-unit.html) -- [`CTextZonesUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/text-zones-unit.html) -- [`CTextureDetectionResultUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-detection-result-unit.html) -- [`CTextureRemovedBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-removed-binary-image-unit.html) -- [`CTextureRemovedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-removed-grayscale-image-unit.html) -- [`CTransformedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/transformed-grayscale-image-unit.html) - -## Settings - -- [`SimplifiedCaptureVisionSettings`]({{ site.dcv_cpp_api }}capture-vision-router/structs/simplified-capture-vision-settings.html) -- [`CPresetTemplate`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) - -## State Listener - -- [`CCaptureStateListener`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/capture-state-listener.html) -- [`CImageSourceStateListener`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/image-source-state-listener.html) - -## [`CLicenseManager`]({{ site.dcv_cpp_api }}license/license-manager.html) - -## Basic Structure - -- [`CContour`]({{ site.dcv_cpp_api }}core/basic-structures/contour.html) -- [`CCorner`]({{ site.dcv_cpp_api }}core/basic-structures/corner.html) -- [`CEdge`]({{ site.dcv_cpp_api }}core/basic-structures/edge.html) -- [`CFileImageTag`]({{ site.dcv_cpp_api }}core/basic-structures/file-image-tag.html) -- [`CImageData`]({{ site.dcv_cpp_api }}core/basic-structures/image-data.html) -- [`CImageTag`]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) -- [`CLineSegment`]({{ site.dcv_cpp_api }}core/basic-structures/line-segment.html) -- [`CPDFReadingParameter`]({{ site.dcv_cpp_api }}core/basic-structures/pdf-reading-parameter.html) -- [`CPoint`]({{ site.dcv_cpp_api }}core/basic-structures/point.html) -- [`CQuadrilateral`]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html) -- [`CRect`]({{ site.dcv_cpp_api }}core/basic-structures/rect.html) -- [`CVideoFrameTag`]({{ site.dcv_cpp_api }}core/basic-structures/video-frame-tag.html) - -## Modules - -- [`CCaptureVisionRouterModule`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html) -- [`CDocumentNormalizerModule`]({{ site.ddn_cpp_api }}document-normalizer-module.html) -- [`CCoreModule`]({{ site.dcv_cpp_api }}core/basic-structures/core-module.html) -- [`CLicenseModule`]({{ site.dcv_cpp_api }}license/license-module.html) -- [`CUtilityModule`]({{ site.dcv_cpp_api }}utility/utility-module.html) -- [`CImageProcessingModule`]({{ site.dcv_cpp_api }}image-processing/image-processing-module.html) - -## Enumerations - -- [`BufferOverflowProtectionMode`]({{ site.dcv_enumerations }}core/buffer-overflow-protection-mode.html?src=cpp&&lang=cpp) -- [`CapturedResultItemType`]({{ site.dcv_enumerations }}core/captured-result-item-type.html?src=cpp&&lang=cpp) -- [`CornerType`]({{ site.dcv_enumerations }}core/corner-type.html?src=cpp&&lang=cpp) -- [`ErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) -- [`GrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?src=cpp&&lang=cpp) -- [`ImageCaptureDistanceMode`]({{ site.dcv_enumerations }}core/image-capture-distance-mode.html?src=cpp&&lang=cpp) -- [`ImagePixelFormat`]({{ site.dcv_enumerations }}core/image-pixel-format.html?src=cpp&&lang=cpp) -- [`ImageSourceState`]({{ site.dcv_enumerations }}capture-vision-router/image-source-state.html?src=cpp&&lang=cpp) -- [`ImageTagType`]({{ site.dcv_enumerations }}core/image-tag-type.html?src=cpp&&lang=cpp) -- [`IntermediateResultUnitType`]({{ site.dcv_enumerations }}core/intermediate-result-unit-type.html?src=cpp&&lang=cpp) -- [`PDFReadingMode`]({{ site.dcv_enumerations }}core/pdf-reading-mode.html?src=cpp&&lang=cpp) -- [`RegionObjectElementType`]({{ site.dcv_enumerations }}core/region-object-element-type.html?src=cpp&&lang=cpp) -- [`SectionType`]({{ site.dcv_enumerations }}core/section-type.html?src=cpp&&lang=cpp) -- [`TargetType`]({{ site.dcv_enumerations }}core/target-type.html?src=cpp&&lang=cpp) -- [`VideoFrameQuality`]({{ site.dcv_enumerations }}core/video-frame-quality.html?src=cpp&&lang=cpp) -- [`ColourChannelUsageType`]({{ site.enumerations}}core/colour-channel-usage-type.html?src=cpp&&lang=cpp) diff --git a/programming/cplusplus/api-reference/index-v2.2.0.md b/programming/cplusplus/api-reference/index-v2.2.0.md deleted file mode 100644 index 6706aa3..0000000 --- a/programming/cplusplus/api-reference/index-v2.2.0.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer C++ API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer SDK API Reference for C++ Language. -keywords: CDocumentNormalizer, api reference, C++ -permalink: /programming/cplusplus/api-reference/index-v2.2.0.html ---- - -# API Reference - C++ - -## DynamsoftCaptureVisionRouter - -### [CCaptureVisionRouter]({{ site.dcv_cpp_api }}capture-vision-router/capture-vision-router.html) - -- [`Constructor and Destructor`]({{ site.dcv_cpp_api }}capture-vision-router/instantiate.html) -- [`Single-File Processing`]({{ site.dcv_cpp_api }}capture-vision-router/single-file-processing.html) -- [`Multiple-File Processing`]({{ site.dcv_cpp_api }}capture-vision-router/multiple-file-processing.html) -- [`Settings`]({{ site.dcv_cpp_api }}capture-vision-router/settings.html) -- [`Intermediate Result`]({{ site.dcv_cpp_api }}capture-vision-router/intermediate-result.html) -- [`Auxiliary Methods`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-methods.html) - -### Classes - -- [`CCaptureStateListener`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/capture-state-listener.html) -- [`CCaptureVisionRouterModule`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html) -- [`CCapturedResultFilter`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) -- [`CCapturedResultReceiver`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) -- [`CImageSourceStateListener`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/image-source-state-listener.html) -- [`CIntermediateResultManager`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) -- [`CIntermediateResultReceiver`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) -- [`CPresetTemplate`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) - -### Structs - -- [`SimplifiedCaptureVisionSettings`]({{ site.dcv_cpp_api }}capture-vision-router/structs/simplified-capture-vision-settings.html) - -### Enums - -- [`CaptureState`]({{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=cpp) -- [`ImageSourceState`]({{ site.dcv_enumerations }}capture-vision-router/image-source-state.html?lang=cpp) - -## DynamsoftDocumentNormalizer - -### Classes - -- [`CCandidateQuadEdgesUnit`]({{ site.ddn_cpp_api }}candidate-quad-edges-unit.html) -- [`CCornersUnit`]({{ site.ddn_cpp_api }}corners-unit.html) -- [`CDetectedQuadElement`]({{ site.ddn_cpp_api }}detected-quad-element.html) -- [`CDetectedQuadResultItem`]({{ site.ddn_cpp_api }}detected-quad-result-item.html) -- [`CDetectedQuadsResult`]({{ site.ddn_cpp_api }}detected-quads-result.html) -- [`CDetectedQuadsUnit`]({{ site.ddn_cpp_api }}detected-quads-unit.html) -- [`CDocumentNormalizerModule`]({{ site.ddn_cpp_api }}document-normalizer-module.html) -- [`CLongLinesUnit`]({{ site.ddn_cpp_api }}long-lines-unit.html) -- [`CNormalizedImageElement`]({{ site.ddn_cpp_api }}normalized-image-element.html) -- [`CNormalizedImageResultItem`]({{ site.ddn_cpp_api }}normalized-image-result-item.html) -- [`CNormalizedImagesResult`]({{ site.ddn_cpp_api }}normalized-images-result.html) -- [`CNormalizedImagesUnit`]({{ site.ddn_cpp_api }}normalized-image-unit.html) - -### Structs - -- [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_cpp_api }}simplified-document-normalizer-settings.html) - -### Enums - -- [`ImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=cpp) - -## DynamsoftCore - -### Classes - -- [`CAbstractIntermediateResultReceiver`]({{ site.dcv_cpp_api }}core/intermediate-results/abstract-intermediate-result-receiver.html) -- [`CBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/binary-image-unit.html) -- [`CCapturedResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -- [`CCapturedResult`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result.html) -- [`CColourImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/colour-image-unit.html) -- [`CContoursUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/contours-unit.html) -- [`CContour`]({{ site.dcv_cpp_api }}core/basic-structures/contour.html) -- [`CCoreModule`]({{ site.dcv_cpp_api }}core/basic-structures/core-module.html) -- [`CCorner`]({{ site.dcv_cpp_api }}core/basic-structures/corner.html) -- [`CEdge`]({{ site.dcv_cpp_api }}core/basic-structures/edge.html) -- [`CEnhancedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/enhanced-grayscale-image-unit.html) -- [`CFileImageTag`]({{ site.dcv_cpp_api }}core/basic-structures/file-image-tag.html) -- [`CGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/grayscale-image-unit.html) -- [`CImageData`]({{ site.dcv_cpp_api }}core/basic-structures/image-data.html) -- [`CImageSourceAdapter`]({{ site.dcv_cpp_api }}core/basic-structures/image-source-adapter.html) -- [`CImageSourceErrorListener`]({{ site.dcv_cpp_api }}core/basic-structures/image-source-error-listener.html) -- [`CImageTag`]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) -- [`CIntermediateResultUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -- [`CIntermediateResult`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result.html) -- [`CLineSegmentsUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/line-segments-unit.html) -- [`CLineSegment`]({{ site.dcv_cpp_api }}core/basic-structures/line-segment.html) -- [`CObservationParameters`]({{ site.dcv_cpp_api }}core/intermediate-results/observed-parameters.html) -- [`COriginalImageResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/original-image-result-item.html) -- [`CPDFReadingParameter`]({{ site.dcv_cpp_api }}core/basic-structures/pdf-reading-parameter.html) -- [`CPoint`]({{ site.dcv_cpp_api }}core/basic-structures/point.html) -- [`CPredetectedRegionElement`]({{ site.dcv_cpp_api }}core/intermediate-results/predetected-region-element.html) -- [`CPredetectedRegionsUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/predetected-regions-unit.html) -- [`CQuadrilateral`]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html) -- [`CRect`]({{ site.dcv_cpp_api }}core/basic-structures/rect.html) -- [`CRegionObjectElement`]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -- [`CScaledDownColourImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/scaled-down-colour-image-unit.html) -- [`CShortLinesUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/short-lines-unit.html) -- [`CTextRemovedBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/text-removed-binary-image-unit.html) -- [`CTextZone`]({{ site.dcv_cpp_api }}core/intermediate-results/text-zone.html) -- [`CTextZonesUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/text-zones-unit.html) -- [`CTextureDetectionResultUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-detection-result-unit.html) -- [`CTextureRemovedBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-removed-binary-image-unit.html) -- [`CTextureRemovedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-removed-grayscale-image-unit.html) -- [`CTransformedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/transformed-grayscale-image-unit.html) -- [`CVector4`]({{ site.dcv_cpp_api }}core/basic-structures/vector4.html) -- [`CVideoFrameTag`]({{ site.dcv_cpp_api }}core/basic-structures/video-frame-tag.html) - -### Structs - -- [`IntermediateResultExtraInfo`]({{ site.dcv_cpp_api }}core/structs/intermediate-result-extra-info.html) - -### Enums - -- [`BufferOverflowProtectionMode`]({{ site.dcv_enumerations }}core/buffer-overflow-protection-mode.html?lang=cpp) -- [`CapturedResultItemType`]({{ site.dcv_enumerations }}core/captured-result-item-type.html?lang=cpp) -- [`ColourChannelUsageType`]({{ site.dcv_enumerations }}core/colour-channel-usage-type.html?lang=cpp) -- [`CornerType`]({{ site.dcv_enumerations }}core/corner-type.html?lang=cpp) -- [`ErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=cpp) -- [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations }}core/grayscale-enhancement-mode.html?lang=cpp) -- [`GrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=cpp) -- [`ImageCaptureDistanceMode`]({{ site.dcv_enumerations }}core/image-capture-distance-mode.html?lang=cpp) -- [`ImagePixelFormat`]({{ site.dcv_enumerations }}core/image-pixel-format.html?lang=cpp) -- [`ImageTagType`]({{ site.dcv_enumerations }}core/image-tag-type.html?lang=cpp) -- [`IntermediateResultUnitType`]({{ site.dcv_enumerations }}core/intermediate-result-unit-type.html?lang=cpp) -- [`PDFReadingMode`]({{ site.dcv_enumerations }}core/pdf-reading-mode.html?lang=cpp) -- [`RasterDataSource`]({{ site.dcv_enumerations }}core/raster-data-source.html?lang=cpp) -- [`RegionObjectElementType`]({{ site.dcv_enumerations }}core/region-object-element-type.html?lang=cpp) -- [`SectionType`]({{ site.dcv_enumerations }}core/section-type.html?lang=cpp) -- [`TargetType`]({{ site.dcv_enumerations }}core/target-type.html?lang=cpp) -- [`VideoFrameQuality`]({{ site.dcv_enumerations }}core/video-frame-quality.html?lang=cpp) - -## DynamsoftUtility - -- [`CDirectoryFetcher`]({{ site.dcv_cpp_api }}utility/directory-fetcher.html) -- [`CFileFetcher`]({{ site.dcv_cpp_api }}utility/file-fetcher.html) -- [`CImageManager`]({{ site.dcv_cpp_api }}utility/image-manager.html) -- [`CMultiFrameResultCrossFilter`]({{ site.dcv_cpp_api }}utility/multi-frame-result-cross-filter.html) -- [`CProactiveImageSourceAdapter`]({{ site.dcv_cpp_api }}utility/proactive-image-source-adapter.html) -- [`CUtilityModule`]({{ site.dcv_cpp_api }}utility/utility-module.html) - -## DynamsoftLicense - -- [`CLicenseManager`]({{ site.dcv_cpp_api }}license/license-manager.html) -- [`CLicenseModule`]({{ site.dcv_cpp_api }}license/license-module.html) - - -## DynamsoftImageProcessing - -- [`CImageProcessingModule`]({{ site.dcv_cpp_api }}image-processing/image-processing-module.html) - diff --git a/programming/cplusplus/api-reference/index.md b/programming/cplusplus/api-reference/index.md deleted file mode 100644 index 0318574..0000000 --- a/programming/cplusplus/api-reference/index.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer C++ API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer SDK API Reference for C++ Language. -keywords: CDocumentNormalizer, api reference, C++ -permalink: /programming/cplusplus/api-reference/index.html ---- - -# API Reference - C++ - -## DynamsoftCaptureVisionRouter - -### [CCaptureVisionRouter]({{ site.dcv_cpp_api }}capture-vision-router/capture-vision-router.html) - -- [`Constructor and Destructor`]({{ site.dcv_cpp_api }}capture-vision-router/instantiate.html) -- [`Single-File Processing`]({{ site.dcv_cpp_api }}capture-vision-router/single-file-processing.html) -- [`Multiple-File Processing`]({{ site.dcv_cpp_api }}capture-vision-router/multiple-file-processing.html) -- [`Settings`]({{ site.dcv_cpp_api }}capture-vision-router/settings.html) -- [`Intermediate Result`]({{ site.dcv_cpp_api }}capture-vision-router/intermediate-result.html) -- [`Auxiliary Methods`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-methods.html) - -### Classes - -- [`CCaptureStateListener`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/capture-state-listener.html) -- [`CCaptureVisionRouterModule`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html) -- [`CCapturedResult`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/captured-result.html) -- [`CCapturedResultFilter`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) -- [`CCapturedResultReceiver`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) -- [`CImageSourceStateListener`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/image-source-state-listener.html) -- [`CIntermediateResultManager`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) -- [`CIntermediateResultReceiver`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) -- [`CPresetTemplate`]({{ site.dcv_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) - -### Structs - -- [`SimplifiedCaptureVisionSettings`]({{ site.dcv_cpp_api }}capture-vision-router/structs/simplified-capture-vision-settings.html) - -### Enums - -- [`CaptureState`]({{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=cpp) -- [`ImageSourceState`]({{ site.dcv_enumerations }}capture-vision-router/image-source-state.html?lang=cpp) - -## DynamsoftDocumentNormalizer - -### Classes - -- [`CCandidateQuadEdgesUnit`]({{ site.ddn_cpp_api }}candidate-quad-edges-unit.html) -- [`CCornersUnit`]({{ site.ddn_cpp_api }}corners-unit.html) -- [`CDetectedQuadElement`]({{ site.ddn_cpp_api }}detected-quad-element.html) -- [`CDetectedQuadResultItem`]({{ site.ddn_cpp_api }}detected-quad-result-item.html) -- [`CDetectedQuadsResult`]({{ site.ddn_cpp_api }}detected-quads-result.html) -- [`CDetectedQuadsUnit`]({{ site.ddn_cpp_api }}detected-quads-unit.html) -- [`CDocumentNormalizerModule`]({{ site.ddn_cpp_api }}document-normalizer-module.html) -- [`CLongLinesUnit`]({{ site.ddn_cpp_api }}long-lines-unit.html) -- [`CNormalizedImageElement`]({{ site.ddn_cpp_api }}normalized-image-element.html) -- [`CNormalizedImageResultItem`]({{ site.ddn_cpp_api }}normalized-image-result-item.html) -- [`CNormalizedImagesResult`]({{ site.ddn_cpp_api }}normalized-images-result.html) -- [`CNormalizedImagesUnit`]({{ site.ddn_cpp_api }}normalized-image-unit.html) - -### Structs - -- [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_cpp_api }}simplified-document-normalizer-settings.html) - -### Enums - -- [`ImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=cpp) - -## DynamsoftCore - -### Classes - -- [`CAbstractIntermediateResultReceiver`]({{ site.dcv_cpp_api }}core/intermediate-results/abstract-intermediate-result-receiver.html) -- [`CBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/binary-image-unit.html) -- [`CCapturedResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -- [`CColourImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/colour-image-unit.html) -- [`CContoursUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/contours-unit.html) -- [`CContour`]({{ site.dcv_cpp_api }}core/basic-structures/contour.html) -- [`CCoreModule`]({{ site.dcv_cpp_api }}core/basic-structures/core-module.html) -- [`CCorner`]({{ site.dcv_cpp_api }}core/basic-structures/corner.html) -- [`CEdge`]({{ site.dcv_cpp_api }}core/basic-structures/edge.html) -- [`CEnhancedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/enhanced-grayscale-image-unit.html) -- [`CFileImageTag`]({{ site.dcv_cpp_api }}core/basic-structures/file-image-tag.html) -- [`CGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/grayscale-image-unit.html) -- [`CImageData`]({{ site.dcv_cpp_api }}core/basic-structures/image-data.html) -- [`CImageSourceAdapter`]({{ site.dcv_cpp_api }}core/basic-structures/image-source-adapter.html) -- [`CImageSourceErrorListener`]({{ site.dcv_cpp_api }}core/basic-structures/image-source-error-listener.html) -- [`CImageTag`]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) -- [`CIntermediateResultUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -- [`CIntermediateResult`]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result.html) -- [`CLineSegmentsUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/line-segments-unit.html) -- [`CLineSegment`]({{ site.dcv_cpp_api }}core/basic-structures/line-segment.html) -- [`CObservationParameters`]({{ site.dcv_cpp_api }}core/intermediate-results/observed-parameters.html) -- [`COriginalImageResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/original-image-result-item.html) -- [`CPDFReadingParameter`]({{ site.dcv_cpp_api }}core/basic-structures/pdf-reading-parameter.html) -- [`CPoint`]({{ site.dcv_cpp_api }}core/basic-structures/point.html) -- [`CPredetectedRegionElement`]({{ site.dcv_cpp_api }}core/intermediate-results/predetected-region-element.html) -- [`CPredetectedRegionsUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/predetected-regions-unit.html) -- [`CQuadrilateral`]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html) -- [`CRect`]({{ site.dcv_cpp_api }}core/basic-structures/rect.html) -- [`CRegionObjectElement`]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -- [`CScaledDownColourImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/scaled-down-colour-image-unit.html) -- [`CShortLinesUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/short-lines-unit.html) -- [`CTextRemovedBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/text-removed-binary-image-unit.html) -- [`CTextZone`]({{ site.dcv_cpp_api }}core/intermediate-results/text-zone.html) -- [`CTextZonesUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/text-zones-unit.html) -- [`CTextureDetectionResultUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-detection-result-unit.html) -- [`CTextureRemovedBinaryImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-removed-binary-image-unit.html) -- [`CTextureRemovedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/texture-removed-grayscale-image-unit.html) -- [`CTransformedGrayscaleImageUnit`]({{ site.dcv_cpp_api }}core/intermediate-results/transformed-grayscale-image-unit.html) -- [`CVector4`]({{ site.dcv_cpp_api }}core/basic-structures/vector4.html) -- [`CVideoFrameTag`]({{ site.dcv_cpp_api }}core/basic-structures/video-frame-tag.html) - -### Structs - -- [`IntermediateResultExtraInfo`]({{ site.dcv_cpp_api }}core/structs/intermediate-result-extra-info.html) - -### Enums - -- [`BufferOverflowProtectionMode`]({{ site.dcv_enumerations }}core/buffer-overflow-protection-mode.html?lang=cpp) -- [`CapturedResultItemType`]({{ site.dcv_enumerations }}core/captured-result-item-type.html?lang=cpp) -- [`ColourChannelUsageType`]({{ site.dcv_enumerations }}core/colour-channel-usage-type.html?lang=cpp) -- [`CornerType`]({{ site.dcv_enumerations }}core/corner-type.html?lang=cpp) -- [`ErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=cpp) -- [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations }}core/grayscale-enhancement-mode.html?lang=cpp) -- [`GrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=cpp) -- [`ImageCaptureDistanceMode`]({{ site.dcv_enumerations }}core/image-capture-distance-mode.html?lang=cpp) -- [`ImagePixelFormat`]({{ site.dcv_enumerations }}core/image-pixel-format.html?lang=cpp) -- [`ImageTagType`]({{ site.dcv_enumerations }}core/image-tag-type.html?lang=cpp) -- [`IntermediateResultUnitType`]({{ site.dcv_enumerations }}core/intermediate-result-unit-type.html?lang=cpp) -- [`PDFReadingMode`]({{ site.dcv_enumerations }}core/pdf-reading-mode.html?lang=cpp) -- [`RasterDataSource`]({{ site.dcv_enumerations }}core/raster-data-source.html?lang=cpp) -- [`RegionObjectElementType`]({{ site.dcv_enumerations }}core/region-object-element-type.html?lang=cpp) -- [`SectionType`]({{ site.dcv_enumerations }}core/section-type.html?lang=cpp) -- [`TargetType`]({{ site.dcv_enumerations }}core/target-type.html?lang=cpp) -- [`VideoFrameQuality`]({{ site.dcv_enumerations }}core/video-frame-quality.html?lang=cpp) - -## DynamsoftUtility - -- [`CDirectoryFetcher`]({{ site.dcv_cpp_api }}utility/directory-fetcher.html) -- [`CFileFetcher`]({{ site.dcv_cpp_api }}utility/file-fetcher.html) -- [`CImageManager`]({{ site.dcv_cpp_api }}utility/image-manager.html) -- [`CMultiFrameResultCrossFilter`]({{ site.dcv_cpp_api }}utility/multi-frame-result-cross-filter.html) -- [`CProactiveImageSourceAdapter`]({{ site.dcv_cpp_api }}utility/proactive-image-source-adapter.html) -- [`CUtilityModule`]({{ site.dcv_cpp_api }}utility/utility-module.html) - -## DynamsoftLicense - -- [`CLicenseManager`]({{ site.dcv_cpp_api }}license/license-manager.html) -- [`CLicenseModule`]({{ site.dcv_cpp_api }}license/license-module.html) - - -## DynamsoftImageProcessing - -- [`CImageProcessingModule`]({{ site.dcv_cpp_api }}image-processing/image-processing-module.html) - diff --git a/programming/cplusplus/api-reference/long-lines-unit-v2.0.0.md b/programming/cplusplus/api-reference/long-lines-unit-v2.0.0.md deleted file mode 100644 index bb41eb4..0000000 --- a/programming/cplusplus/api-reference/long-lines-unit-v2.0.0.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default-layout -title: CLongLinesUnit Class -description: This page shows CLongLinesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetLongLine, CLongLinesUnit, api reference -permalink: /programming/cplusplus/api-reference/long-lines-unit-v2.0.0.html ---- - -# CLongLinesUnit Class - -The CLongLinesUnit class represents an intermediate result unit whose type is long lines. Short line segments that are located in the same line are extended and merged to form a long line segment. - -## Definition - -*Namespace:* dynamsoft::ddn::intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CLongLinesUnit: CIntermediateResultUnit -``` - -*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLongLinesUnit - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the count of LongLine objects in current object.| -| [`GetLongLine`](#getlongline) | Gets a LongLine object from current object by specifying a index. | - -### GetCount - -Gets the count of LongLine objects in current object. - -```cpp -int GetCount() -``` - -**Return Value** - -The count of LongLine objects in current object. - -### GetLongLine - -Gets a LongLine object from current object by specifying a index. - -```cpp -int GetLongLine(int index, CLineSegment* line) -``` - -**Parameters** - -`[in] index` The index of the LongLine object. - -`[in, out] line` The LongLine object got by the specific index. - -**Return Value** - -Returns the error code. - -**See Also** - -* [CLineSegment]({{ site.dcv_cpp_api }}core/basic-structures/line-segment.html) -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) diff --git a/programming/cplusplus/api-reference/long-lines-unit-v2.0.20.md b/programming/cplusplus/api-reference/long-lines-unit-v2.0.20.md deleted file mode 100644 index db15c07..0000000 --- a/programming/cplusplus/api-reference/long-lines-unit-v2.0.20.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default-layout -title: CLongLinesUnit Class -description: This page shows CLongLinesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetLongLine, CLongLinesUnit, api reference -permalink: /programming/cplusplus/api-reference/long-lines-unit-v2.0.20.html ---- - -# CLongLinesUnit Class - -The CLongLinesUnit class represents an intermediate result unit whose type is long lines. Short line segments that are located in the same line are extended and merged to form a long line segment. - -## Definition - -*Namespace:* dynamsoft::ddn::intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CLongLinesUnit: CIntermediateResultUnit -``` - -*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLongLinesUnit - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the count of LongLine objects in current object.| -| [`GetLongLine`](#getlongline) | Gets a LongLine object from current object by specifying a index. | - -### GetCount - -Gets the count of LongLine objects in current object. - -```cpp -int GetCount() -``` - -**Return Value** - -The count of LongLine objects in current object. - -### GetLongLine - -Gets a LongLine object from current object by specifying a index. - -```cpp -const CLineSegment* GetLongLine(int index) const = 0; -``` - -**Parameters** - -`[in] index` The index of the LongLine object. - -**Return Value** - -Returns the LongLine object. - -**See Also** - -* [CLineSegment]({{ site.dcv_cpp_api }}core/basic-structures/line-segment.html) -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) diff --git a/programming/cplusplus/api-reference/normalized-image-unit-v2.0.20.md b/programming/cplusplus/api-reference/normalized-image-unit-v2.0.20.md deleted file mode 100644 index f3a9a20..0000000 --- a/programming/cplusplus/api-reference/normalized-image-unit-v2.0.20.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default-layout -title: CNormalizedImagesUnit Class -description: This page shows CNormalizedImagesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetNormalizedImage, CNormalizedImagesUnit, api reference -permalink: /programming/cplusplus/api-reference/normalized-image-unit-v2.0.20.html ---- - -# CNormalizedImagesUnit Class - -The CNormalizedImagesUnit class represents an intermediate result unit whose type is normalized images. - -## Definition - -*Namespace:* dynamsoft::ddn::intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CNormalizedImagesUnit: CIntermediateResultUnit -``` - -*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CNormalizedImagesUnit - -## Methods - -| Method | Description | -|--------|-------------| -| [`GetCount`](#getcount) | Gets the count of `CNormalizedImageElement` objects in current object. | -| [`GetNormalizedImage`](#getnormalizedimage) | Gets a NormalizedImage object from current object. | - -### GetCount - -Gets the count of `CNormalizedImageElement` objects in current object. - -```cpp -int GetCount() -``` - -**Return Value** - -The count of `CNormalizedImageElement` objects in current object. - -### GetNormalizedImage - -Gets a NormalizedImage object from current object. - -```cpp -const CNormalizedImageElement* GetNormalizedImage(int index) -``` - -**Return Value** - -Returns the NormalizedImage object. - -**See Also** - -* [CNormalizedImageElement]({{cpp_api}}normalized-image-element.html) diff --git a/programming/cplusplus/api-reference/normalized-images-result-v2.0.0.md b/programming/cplusplus/api-reference/normalized-images-result-v2.0.0.md deleted file mode 100644 index 008ef73..0000000 --- a/programming/cplusplus/api-reference/normalized-images-result-v2.0.0.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -layout: default-layout -title: CNormalizedImagesResult Class -description: This page shows CNormalizedImagesResult class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetCount, GetErrorCode, GetErrorString, GetItem, GetSourceImageHashId, GetSourceImageTag, CNormalizedImagesResult, api reference -permalink: /programming/cplusplus/api-reference/normalized-images-result-v2.0.0.html ---- - -# CNormalizedImagesResult - -The CNormalizedImagesResult class stores a collection of captured result items whose type are normalized images. - -## Definition - -*Namespace:* dynamsoft::ddn - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CNormalizedImagesResult: public CRegionObjectElement -``` - -## Methods - -| Method | Description | -|----------------------|-------------| -| [`GetCount`](#getcount) | Gets the number of normalized images in the result. | -| [`GetErrorCode`](#geterrorcode) | Gets the error code of the operation. | -| [`GetErrorString`](#geterrorstring) | Gets the error message of the operation. | -| [`GetItem`](#getitem) | Gets a specific normalized image from the result. | -| [`HasItem`](#hasitem) | Check if the item is present in the array.| -| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the normalized images.| -| [`GetRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.| -| [`GetSourceImageHashId`](#getsourceimagehashid) | Gets the hash ID of the original image, from which you get the normalized image. | -| [`GetSourceImageTag`](#getsourceimagetag) | Gets the tag of the original image, from which you get the normalized image. | - -### GetCount - -Gets the number of normalized images in the result. - -```cpp -int GetCount() -``` - -**Return value** - -Returns the number of normalized images in the result. - -### GetErrorCode - -Gets the error code of the operation. - -```cpp -int GetErrorCode() -``` - -**Return value** - -Returns the error code of the operation. A non-zero value indicates an error occurred. - -**See Also** - -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) - -### GetErrorString - -Gets the error message of the operation. - -```cpp -const char* GetErrorString() -``` - -**Return value** - -Returns the error message of the operation. - -### GetItem - -Gets a specific normalized image from the result. - -```cpp -const CNormalizedImageResultItem* GetItem(int index) -``` - -**Parameters** - -`[in] index` The index of the normalized image to get. - -**Return value** - -Returns a pointer to the normalized image at the specified index. If the index is out of range, returns nullptr. - -**See Also** - -* [CNormalizedImageResultItem](normalized-image-result-item.md) - -### HasItem - -Check if the item is present in the array. - -```cpp -bool HasItem(const CNormalizedImageResultItem* item) const -``` - -**Parameters** - -`[in] item` The specific item to check. - -**Return value** - -Returns a bool value indicating whether the item is present in the array or not. - -### RemoveItem - -Remove a specific item from the array in the normalized images. - -```cpp -int RemoveItem(const CNormalizedImageResultItem* item) -``` - -**Parameters** - -`[in] item` The specific item to remove. - -**Return value** - -Return value indicating whether the deletion was successful or not. - -### GetRotationTransformMatrix - -Get the rotation transformation matrix of the original image relative to the rotated image. - -```cpp -void GetRotationTransformMatrix(double matrix[9]) const; -``` - -**Parameters** - -`[out] matrix` A double array which represents the rotation transform matrix. - - -### GetSourceImageHashId - -Gets the hash ID of the source image that was normalized. - -```cpp -const char* GetSourceImageHashId() -``` - -**Return value** - -Returns the hash ID of the source image that was normalized. - -### GetSourceImageTag - -Gets the tag of the source image that was normalized. - -```cpp -const CImageTag* GetSourceImageTag() -``` - -**Return value** - -Returns a pointer to the tag of the source image that was normalized. - -**See Also** - -* [CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) diff --git a/programming/cplusplus/api-reference/normalized-images-result-v2.0.20.md b/programming/cplusplus/api-reference/normalized-images-result-v2.0.20.md deleted file mode 100644 index 42e26e6..0000000 --- a/programming/cplusplus/api-reference/normalized-images-result-v2.0.20.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -layout: default-layout -title: CNormalizedImagesResult Class -description: This page shows CNormalizedImagesResult class definition of Dynamsoft Document Normalizer SDK C++ Edition. -keywords: GetItemsCount, GetErrorCode, GetErrorString, GetItem, GetOriginalImageHashId, GetOriginalImageTag, CNormalizedImagesResult, api reference -permalink: /programming/cplusplus/api-reference/normalized-images-result-v2.0.20.html ---- - -# CNormalizedImagesResult - -The CNormalizedImagesResult class stores a collection of captured result items whose type are normalized images. - -## Definition - -*Namespace:* dynamsoft::ddn - -*Assembly:* DynamsoftDocumentNormalizer - -```cpp -class CNormalizedImagesResult: public CRegionObjectElement -``` - -## Methods - -| Method | Description | -|----------------------|-------------| -| [`GetItemsCount`](#getitemscount) | Gets the number of normalized images in the result. | -| [`GetErrorCode`](#geterrorcode) | Gets the error code of the operation. | -| [`GetErrorString`](#geterrorstring) | Gets the error message of the operation. | -| [`GetItem`](#getitem) | Gets a specific normalized image from the result. | -| [`HasItem`](#hasitem) | Check if the item is present in the array.| -| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the normalized images.| -| [`GetRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.| -| [`GetOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the original image, from which you get the normalized image. | -| [`GetOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image, from which you get the normalized image. | - -### GetItemsCount - -Gets the number of normalized images in the result. - -```cpp -int GetItemsCount() -``` - -**Return value** - -Returns the number of normalized images in the result. - -### GetErrorCode - -Gets the error code of the operation. - -```cpp -int GetErrorCode() -``` - -**Return value** - -Returns the error code of the operation. A non-zero value indicates an error occurred. - -**See Also** - -* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp) - -### GetErrorString - -Gets the error message of the operation. - -```cpp -const char* GetErrorString() -``` - -**Return value** - -Returns the error message of the operation. - -### GetItem - -Gets a specific normalized image from the result. - -```cpp -const CNormalizedImageResultItem* GetItem(int index) -``` - -**Parameters** - -`[in] index` The index of the normalized image to get. - -**Return value** - -Returns a pointer to the normalized image at the specified index. If the index is out of range, returns nullptr. - -**See Also** - -* [CNormalizedImageResultItem](normalized-image-result-item.md) - -### HasItem - -Check if the item is present in the array. - -```cpp -bool HasItem(const CNormalizedImageResultItem* item) const -``` - -**Parameters** - -`[in] item` The specific item to check. - -**Return value** - -Returns a bool value indicating whether the item is present in the array or not. - -### RemoveItem - -Remove a specific item from the array in the normalized images. - -```cpp -int RemoveItem(const CNormalizedImageResultItem* item) -``` - -**Parameters** - -`[in] item` The specific item to remove. - -**Return value** - -Return value indicating whether the deletion was successful or not. - -### GetRotationTransformMatrix - -Get the rotation transformation matrix of the original image relative to the rotated image. - -```cpp -void GetRotationTransformMatrix(double matrix[9]) const; -``` - -**Parameters** - -`[out] matrix` A double array which represents the rotation transform matrix. - - -### GetOriginalImageHashId - -Gets the hash ID of the original image that was normalized. - -```cpp -const char* GetOriginalImageHashId() -``` - -**Return value** - -Returns the hash ID of the original image that was normalized. - -### GetOriginalImageTag - -Gets the tag of the original image that was normalized. - -```cpp -const CImageTag* GetOriginalImageTag() -``` - -**Return value** - -Returns a pointer to the tag of the original image that was normalized. - -**See Also** - -* [CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) diff --git a/programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.2.10.md b/programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.2.10.md deleted file mode 100644 index ce82c68..0000000 --- a/programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.2.10.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -layout: default-layout -title: struct SimplifiedDocumentNormalizerSettings - Dynamsoft Capture Vision C++ Edition API Reference -description: This page shows the SimplifiedDocumentNormalizerSettings struct of the CCaptureVisionRouter class of the Dynamsoft Capture Vision C++ Edition. -keywords: struct, c++, SimplifiedDocumentNormalizerSettings -needAutoGenerateSidebar: true -needGenerateH3Content: true -breadcrumbText: CVR C++ SimplifiedDocumentNormalizerSettings Struct ---- - -# SimplifiedDocumentNormalizerSettings - -The `SimplifiedDocumentNormalizerSettings` struct contains settings for document normalization. It is a sub-parameter of `SimplifiedCaptureVisionSettings` - -```cpp -typedef struct tagSimplifiedDocumentNormalizerSettings -{ - GrayscaleTransformationMode grayscaleTransformationModes[8]; - GrayscaleEnhancementMode grayscaleEnhancementModes[8]; - ImageColourMode colourMode; - int pageSize[2]; - int brightness; - int contrast; - int maxThreadsInOneTask; - int scaleDownThreshold; - char reserved[512]; -} SimplifiedDocumentNormalizerSettings; - -``` - -## Attributes Summary - -| Attribute | Type | -| --------- | ---- | -| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *GrayscaleTransformationMode[8]* | -| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *GrayscaleEnhancementMode[8]* | -| [`colourMode`](#colourmode) | *int* | -| [`pageSize`](#pagesize) | *int[2]* | -| [`brightness`](#brightness) | *int* | -| [`contrast`](#contrast) | *int* | -| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | -| [`scaleDownThreshold`](#scaledownthreshold) | *int* | -| [`reserved`](#reserved) | *char[508]* | - -### grayscaleTransformationModes - -Set the grayscale transformation modes with an array of enumeration `GrayscaleTransformationMode`. View the reference page of `GrayscaleTransformationMode` for more detail about grayscale transformation modes. - -```cpp -GrayscaleTransformationMode grayscaleTransformationModes[8]; -``` - -### grayscaleEnhancementModes - -Set the grayscale enhancement modes with an array of enumeration `GrayscaleEnhancementMode`. View the reference page of `GrayscaleEnhancementMode` for more detail about grayscale enhancement modes. - -```cpp -GrayscaleEnhancementMode grayscaleEnhancementModes[8]; -``` - -### colourMode - -Set the output image colour mode. - -```cpp -ImageColourMode colourMode; -``` - -**Value Range** - -"ICM_BINARY", "ICM_GRAYSCALE", "ICM_COLOUR" - -**Default value** - -"ICM_COLOUR" - -### pageSize - -Set the page size (width by height in pixels) of the normalized image. - -```cpp -int pageSize[2]; -``` - - -### brightness - -Set the brightness of the normalized image. - -```cpp -int brightness; -``` - -**Value Range** - -[-100,100] - -**Default value** - -0 - -### contrast - -Set the contrast of the normalized image. - -```cpp -int contrast -``` - -**Value Range** - -[-100,100] - -**Default value** - -0 - -### maxThreadsInOneTask - -Set the maximum available threads count in one document normalization task. - -```cpp -int maxThreadsInOneTask; -``` - -**Value Range** - -[1, 256] - -**Default value** - -4 - -**Remarks** - -To keep a balance between speed and quality, the library concurrently runs four different threads by default. - -### scaleDownThreshold - -Sets the threshold for the image shrinking. - -```cpp -int scaleDownThreshold; -``` - -**Value Range** - -[512, 0x7fffffff] - -**Default Value** - -2300 - -**Remarks** - -If the shorter edge size is larger than the given threshold value, the library will calculate the required height and width of the barcode image and shrink the image to that size before detection. Otherwise, the library will perform document detection on the original image. - -### reserved - -Reserved for future use. - -```cpp -char reserved[508]; -``` diff --git a/programming/index.md b/programming/index.md deleted file mode 100644 index a71dd02..0000000 --- a/programming/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Dynamsoft Document Normalizer - Programming -keywords: programming, documentation -description: Dynamsoft Document Normalizer - Programming -permalink: /programming/index.html ---- - -# Programming - -- [C++]({{ site.ddn_cpp}}) -- [C]({{ site.ddn_c}}) -- [.NET]({{ site.ddn_dotnet}}) -- [Python]({{ site.ddn_python}}) diff --git a/programming/python/api-reference/candidate-quad-edges-unit.md b/programming/python/api-reference/candidate-quad-edges-unit.md index 3e63de0..6fe8261 100644 --- a/programming/python/api-reference/candidate-quad-edges-unit.md +++ b/programming/python/api-reference/candidate-quad-edges-unit.md @@ -62,7 +62,7 @@ Returns a tuple containing following elements: **See Also** -[ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) [Edge]({{ site.dcv_python_api }}core/basic-classes/edge.html) diff --git a/programming/python/api-reference/corners-unit.md b/programming/python/api-reference/corners-unit.md index 91f4ffd..57c1e0e 100644 --- a/programming/python/api-reference/corners-unit.md +++ b/programming/python/api-reference/corners-unit.md @@ -62,7 +62,7 @@ Returns a tuple containing following elements: **See Also** -[ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) [Corner]({{ site.dcv_python_api }}core/basic-classes/corner.html) diff --git a/programming/python/api-reference/deskewed-image-element.md b/programming/python/api-reference/deskewed-image-element.md new file mode 100644 index 0000000..5351bff --- /dev/null +++ b/programming/python/api-reference/deskewed-image-element.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: DeskewedImageElement Class +description: This page shows DeskewedImageElement class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: set_image_data, get_source_deskew_quad, DeskewedImageElement, api reference +--- + +# DeskewedImageElement Class + +The `DeskewedImageElement` class stores an intermediate result whose type is Deskewed image. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class DeskewedImageElement(RegionObjectElement): +``` + +*Inheritance:* [RegionObjectElement]({{ site.dcv_python_api }}core/intermediate-results/region-object-element.html) -> DeskewedImageElement + +## Methods + +| Method | Description | +|--------|-------------| +| [`set_image_data`](#set_image_data) | Sets the image data of the deskewed image element. | +| [`get_source_deskew_quad`](#get_source_deskew_quad) | Gets the quadrilateral used for deskewing the image. | + +### set_image_data + +Sets the image data of the deskewed image element. + +```python +def set_image_data(self, image_data: ImageData) -> int: +``` + +**Parameters** + +`image_data` The image data to set. + +**Return Value** + +Returns 0 if succeeds, nonzero otherwise. + +**See Also** + +* [ImageData]({{ site.dcv_python_api }}core/basic-classes/image-data.html) + +### get_source_deskew_quad + +Gets the quadrilateral used for deskewing the image. + +```python +def get_source_deskew_quad(self) -> Quadrilateral: +``` + +**Return Value** + +Returns A `Quadrilateral` object representing the four corners of the quadrilateral used to deskew the image. + +**See Also** + +* [Quadrilateral]({{ site.dcv_python_api }}core/basic-classes/quadrilateral.html) diff --git a/programming/python/api-reference/deskewed-image-result-item.md b/programming/python/api-reference/deskewed-image-result-item.md new file mode 100644 index 0000000..9c31c3d --- /dev/null +++ b/programming/python/api-reference/deskewed-image-result-item.md @@ -0,0 +1,89 @@ +--- +layout: default-layout +title: DeskewedImageResultItem Class +description: This page shows DeskewedImageResultItem class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: get_image_data, get_source_deskew_quad, get_cross_verification_status, get_original_to_local_matrix, DeskewedImageResultItem, api reference +--- + +# DeskewedImageResultItem Class + +The `DeskewedImageResultItem` class stores a captured result item whose type is Deskewed image. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class DeskewedImageResultItem(CapturedResultItem): +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcv_python_api }}core/basic-classes/captured-result-item.html) -> DeskewedImageResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_image_data`](#get_image_data) | Gets the ImageData of current object. | +| [`get_source_deskew_quad`](#get_source_deskew_quad)| Gets the quadrilateral used for deskewing the image. | +| [`get_cross_verification_status`](get_cross_verification_status)| Gets the status of current object as a verified deskewed image. | +| [`get_original_to_local_matrix`](get_original_to_local_matrix) | Gets the transformation matrix from the original image coordinate system to the local coordinate system. | + +### get_image_data + +Gets the ImageData of current object. + +```python +def get_image_data(self) -> ImageData: +``` + +**Return Value** + +The image data. + +**See Also** + +* [ImageData]({{ site.dcv_python_api }}core/basic-classes/image-data.html) + +### get_source_deskew_quad + +Gets the quadrilateral used for deskewing the image. + +```python +def get_source_deskew_quad(self) -> Quadrilateral: +``` + +**Return Value** + +A `Quadrilateral` object representing the four corners of the quadrilateral used to deskew the image. + +**See Also** + +* [Quadrilateral]({{ site.dcv_python_api }}core/basic-classes/quadrilateral.html) + +### get_cross_verification_status + +Gets the status of current object as a verified deskewed image. + +```python +def get_cross_verification_status(self) -> EnumCrossVerificationStatus: +``` + +**Return Value** + +Return the status of current object as a verified deskewed image. + +**See Also** + +[EnumCrossVerificationStatus]({{ site.dcv_python_api }}core/enum-cross-verification-status.html) + +### get_original_to_local_matrix + +Gets the transformation matrix from the original image coordinate system to the local coordinate system. + +```python +def get_original_to_local_matrix(self) -> List[float]: +``` + +**Parameters** + +A double array of size 9, representing the 3x3 transformation matrix that converts coordinates from the original image to the local image. \ No newline at end of file diff --git a/programming/python/api-reference/deskewed-image-unit.md b/programming/python/api-reference/deskewed-image-unit.md new file mode 100644 index 0000000..330b5d5 --- /dev/null +++ b/programming/python/api-reference/deskewed-image-unit.md @@ -0,0 +1,65 @@ +--- +layout: default-layout +title: DeskewedImageUnit Class +description: This page shows DeskewedImageUnit class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: get_deskewed_image, set_deskewed_image, DeskewedImageUnit, api reference +--- + +# DeskewedImageUnit Class + +The `DeskewedImageUnit` class represents an intermediate result unit whose type is Deskewed images. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class DeskewedImageUnit(IntermediateResultUnit): +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcv_python_api }}core/intermediate-results/intermediate-result-unit.html) -> DeskewedImageUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_deskewed_image`](#get_deskewed_image) | Gets a `DeskewedImageElement` object from current object. | +| [`set_deskewed_image`](#set_deskewed_image) | Sets the deskewed image. | + +### get_deskewed_image + +Gets a `DeskewedImageElement` object from current unit. + +```python +def get_deskewed_image(self) -> DeskewedImageElement: +``` + +**Return Value** + +Returns the `DeskewedImageElement` object. + +**See Also** + +* [DeskewedImageElement]({{ site.ddn_cpp_api }}deskewed-image-element.html) + +### set_deskewed_image + +Sets the deskewed image. + +```python +def set_deskewed_image(self, element: DeskewedImageElement, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int: +``` + +**Parameters** + +`element` The deskewed image to be set. + +`matrix_to_original_image` The matrix to original image. + +**Return value** + +Returns 0 if successful, otherwise returns a negative value. + +**See Also** + +* [DeskewedImageElement]({{ site.ddn_cpp_api }}deskewed-image-element.html) diff --git a/programming/python/api-reference/detected-quad-element-v2.5.2100.md b/programming/python/api-reference/detected-quad-element-v2.5.2100.md new file mode 100644 index 0000000..5481dee --- /dev/null +++ b/programming/python/api-reference/detected-quad-element-v2.5.2100.md @@ -0,0 +1,47 @@ +--- +layout: default-layout +title: DetectedQuadElement Class +description: This page shows DetectedQuadElement class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: get_confidence_as_document_boundary, DetectedQuadElement, api reference +--- + +# DetectedQuadElement Class + +The `DetectedQuadElement` class stores an intermediate result whose type is detected quad. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class DetectedQuadElement(RegionObjectElement) +``` + +*Inheritance:* [RegionObjectElement]({{ site.dcv_python_api }}core/intermediate-results/region-object-element.html) -> DetectedQuadElement + +## Methods + +| Method | Description | +|--------|-------------| +| [`__init__`](#__init__) | Initializes a new instance of the `DetectedQuadElement` class. | +| [`get_confidence_as_document_boundary`](#get_confidence_as_document_boundary) | Gets the confidence as document boundary of current object. | + +### \_\_init\_\_ + +Initializes a new instance of the `DetectedQuadElement` class. + +```python +def __init__(self, *args, **kwargs): +``` + +### get_confidence_as_document_boundary + +Gets the confidence as document boundary of current object. + +```python +def get_confidence_as_document_boundary(self) -> int: +``` + +**Return Value** + +The confidence as document boundary of current object. diff --git a/programming/python/api-reference/detected-quad-element.md b/programming/python/api-reference/detected-quad-element.md index 5481dee..079e903 100644 --- a/programming/python/api-reference/detected-quad-element.md +++ b/programming/python/api-reference/detected-quad-element.md @@ -25,6 +25,7 @@ class DetectedQuadElement(RegionObjectElement) |--------|-------------| | [`__init__`](#__init__) | Initializes a new instance of the `DetectedQuadElement` class. | | [`get_confidence_as_document_boundary`](#get_confidence_as_document_boundary) | Gets the confidence as document boundary of current object. | +| [`set_location`](#set_location) | Sets the location of the detected quad element. | ### \_\_init\_\_ @@ -45,3 +46,23 @@ def get_confidence_as_document_boundary(self) -> int: **Return Value** The confidence as document boundary of current object. + +### set_location + +Sets the location of the detected quad element. + +```python +def set_location(self, location: Quadrilateral) -> int: +``` + +**Parameters** + +`location` The location of the detected quad element. + +**Return Value** + +Returns 0 if success, otherwise an error code. + +**See Also** + +* [Quadrilateral]({{ site.dcv_python_api }}core/basic-classes/quadrilateral.html) diff --git a/programming/python/api-reference/detected-quad-result-item-v2.5.2100.md b/programming/python/api-reference/detected-quad-result-item-v2.5.2100.md new file mode 100644 index 0000000..25d8f3f --- /dev/null +++ b/programming/python/api-reference/detected-quad-result-item-v2.5.2100.md @@ -0,0 +1,55 @@ +--- +layout: default-layout +title: DetectedQuadResultItem Class - Dynamsoft Document Normalizer Module Python Edition API Reference +description: Definition of DetectedQuadResultItem class in Dynamsoft Document Normalizer Module Python Edition. +keywords: get_location, get_confidence_as_document_boundary, DetectedQuadResultItem, api reference +--- + +# DetectedQuadResultItem Class + +The `DetectedQuadResultItem` class stores a captured result whose type is detected quad. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class DetectedQuadResultItem(dynamsoft_core.CapturedResultItem) +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcv_python_api }}core/basic-classes/captured-result-item.html) -> DetectedQuadResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_location`](#get_location) | Gets the location of current object. | +| [`get_confidence_as_document_boundary`](#get_confidence_as_document_boundary) | Gets the confidence of current object as a document boundary. | + +### get_location + +Gets the location of current object. + +```python +def get_location(self) -> Quadrilateral: +``` + +**Return Value** + +The location of current object. + +**See Also** + +[Quadrilateral]({{ site.dcv_python_api }}core/basic-classes/quadrilateral.html) + +### get_confidence_as_document_boundary + +Gets the confidence of current object as a document boundary. + +```python +def get_confidence_as_document_boundary(self) -> int: +``` + +**Return Value** + +The confidence as document boundary of the detected quad result. diff --git a/programming/python/api-reference/detected-quad-result-item.md b/programming/python/api-reference/detected-quad-result-item.md index 25d8f3f..4bc604f 100644 --- a/programming/python/api-reference/detected-quad-result-item.md +++ b/programming/python/api-reference/detected-quad-result-item.md @@ -25,6 +25,7 @@ class DetectedQuadResultItem(dynamsoft_core.CapturedResultItem) |--------|-------------| | [`get_location`](#get_location) | Gets the location of current object. | | [`get_confidence_as_document_boundary`](#get_confidence_as_document_boundary) | Gets the confidence of current object as a document boundary. | +| [`get_cross_verification_status`](#get_cross_verification_status) | Gets the status of current object as a verified document boundary. | ### get_location @@ -53,3 +54,20 @@ def get_confidence_as_document_boundary(self) -> int: **Return Value** The confidence as document boundary of the detected quad result. + +### get_cross_verification_status + +Gets the status of current object as a verified document boundary. + +```python +def get_cross_verification_status(self) -> EnumCrossVerificationStatus: +``` + +**Return Value** + +The status of current object as a verified document boundary. + +**See Also** + +[EnumCrossVerificationStatus]({{ site.dcv_python_api }}core/enum-cross-verification-status.html) + diff --git a/programming/python/api-reference/detected-quads-result.md b/programming/python/api-reference/detected-quads-result.md index 59fd2fa..8fe43b9 100644 --- a/programming/python/api-reference/detected-quads-result.md +++ b/programming/python/api-reference/detected-quads-result.md @@ -42,7 +42,7 @@ Returns the error code. **See Also** -[EnumErrorCode]({{ site.dcv_enumerations }}core/error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) ### get_error_string diff --git a/programming/python/api-reference/detected-quads-unit.md b/programming/python/api-reference/detected-quads-unit.md index ca01413..5874e8c 100644 --- a/programming/python/api-reference/detected-quads-unit.md +++ b/programming/python/api-reference/detected-quads-unit.md @@ -25,7 +25,6 @@ class DetectedQuadsUnit(IntermediateResultUnit) |--------|-------------| | [`get_count`](#get_count) | Gets the count of `DetectedQuadElement` objects in current object.| | [`get_detected_quad`](#get_detected_quad) | Gets a `DetectedQuadElement` object from current object by specifying a index. | -| [`operator[]`](#operator) | Gets a `DetectedQuadElement` object from current object by specifying a index.| | [`remove_all_detected_quads`](#remove_all_detected_quads) | Removes all the detected quads in current object. | | [`remove_detected_quad`](#remove_detected_quad) | Removes a detected quad from current object by specifying an index. | | [`add_detected_quad`](#add_detected_quad) | Adds a detected quad to current object. | diff --git a/programming/python/api-reference/enhanced-image-element.md b/programming/python/api-reference/enhanced-image-element.md new file mode 100644 index 0000000..c4cc244 --- /dev/null +++ b/programming/python/api-reference/enhanced-image-element.md @@ -0,0 +1,46 @@ +--- +layout: default-layout +title: EnhancedImageElement Class +description: This page shows EnhancedImageElement class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: set_image_data, EnhancedImageElement, api reference +--- + +# EnhancedImageElement Class + +The `EnhancedImageElement` class stores an intermediate result whose type is Enhanced image. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class EnhancedImageElement(RegionObjectElement): +``` + +*Inheritance:* [RegionObjectElement]({{ site.dcv_python_api }}core/intermediate-results/region-object-element.html) -> EnhancedImageElement + +## Methods + +| Method | Description | +|--------|-------------| +| [`set_image_data`](#set_image_data) | Sets the image data of the Enhanced image element. | + +### set_image_data + +Sets the image data of the Enhanced image element. + +```python +def set_image_data(self, image_data: ImageData) -> int: +``` + +**Parameters** + +`image_data` The image data to set. + +**Return Value** + +Returns 0 if succeeds, nonzero otherwise. + +**See Also** + +* [ImageData]({{ site.dcv_python_api }}core/basic-classes/image-data.html) diff --git a/programming/python/api-reference/enhanced-image-result-item.md b/programming/python/api-reference/enhanced-image-result-item.md new file mode 100644 index 0000000..4743919 --- /dev/null +++ b/programming/python/api-reference/enhanced-image-result-item.md @@ -0,0 +1,55 @@ +--- +layout: default-layout +title: EnhancedImageResultItem Class +description: This page shows EnhancedImageResultItem class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: get_image_data, get_original_to_local_matrix, EnhancedImageResultItem, api reference +--- + +# EnhancedImageResultItem Class + +The `EnhancedImageResultItem` class stores a captured result item whose type is Enhanced image. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class EnhancedImageResultItem(CapturedResultItem): +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcv_python_api }}core/basic-classes/captured-result-item.html) -> EnhancedImageResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_image_data`](#get_image_data) | Gets the ImageData of current object. | +| [`get_original_to_local_matrix`](get_original_to_local_matrix) | Gets the transformation matrix from the original image coordinate system to the local coordinate system. | + +### get_image_data + +Gets the ImageData of current object. + +```python +def get_image_data(self) -> ImageData: +``` + +**Return Value** + +The image data. + +**See Also** + +* [ImageData]({{ site.dcv_python_api }}core/basic-classes/image-data.html) + +### get_original_to_local_matrix + +Gets the transformation matrix from the original image coordinate system to the local coordinate system. + +```python +def get_original_to_local_matrix(self) -> List[float]: +``` + +**Parameters** + +A double array of size 9, representing the 3x3 transformation matrix that converts coordinates from the original image to the local image. \ No newline at end of file diff --git a/programming/python/api-reference/enhanced-image-unit.md b/programming/python/api-reference/enhanced-image-unit.md new file mode 100644 index 0000000..4ca5e0d --- /dev/null +++ b/programming/python/api-reference/enhanced-image-unit.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: EnhancedImageUnit Class +description: This page shows EnhancedImageUnit class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: get_enhanced_image, set_enhanced_image, EnhancedImageUnit, api reference +--- + +# EnhancedImageUnit Class + +The `EnhancedImageUnit` class represents an intermediate result unit whose type is enhanced images. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class EnhancedImageUnit(IntermediateResultUnit): +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcv_python_api }}core/intermediate-results/intermediate-result-unit.html) -> EnhancedImageUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_enhanced_image`](#get_enhanced_image) | Gets an `EnhancedImageElement` object from current object. | +| [`set_enhanced_image`](#set_enhanced_image) | Sets the enhanced image. | + +### get_enhanced_image + +Gets an `EnhancedImageElement` object from current unit. + +```python +def get_enhanced_image(self) -> EnhancedImageElement: +``` + +**Return Value** + +Returns the `EnhancedImageElement` object. + +**See Also** + +* [EnhancedImageElement]({{ site.ddn_python_api }}enhanced-image-element.html) + +### set_enhanced_image + +Sets the enhanced image. + +```python +def set_enhanced_image(self, element: EnhancedImageElement) -> int: +``` + +**Parameters** + +`element` The enhanced image to be set. + +**Return value** + +Returns 0 if successful, otherwise returns a negative value. + +**See Also** + +* [EnhancedImageElement]({{ site.ddn_python_api }}enhanced-image-element.html) diff --git a/programming/python/api-reference/enum-image-colour-mode.md b/programming/python/api-reference/enum-image-colour-mode.md new file mode 100644 index 0000000..0058f69 --- /dev/null +++ b/programming/python/api-reference/enum-image-colour-mode.md @@ -0,0 +1,20 @@ +--- +layout: default-layout +title: EnumImageColourMode - Dynamsoft Document Normalizer Python Enumerations +description: The enumeration EnumImageColourMode of Dynamsoft Document Normalizer describes the mapping status of a parsed field. +keywords: Mapping status +--- + +# Enumeration ImageColourMode + +`EnumImageColourMode` describes the output colour mode of the normalized image. + +```python +class EnumImageColourMode(IntEnum): + # Output image in colour mode. + ICM_COLOUR = 0, + # Output image in grayscale mode. + ICM_GRAYSCALE = 1, + # Output image in binary mode. + ICM_BINARY = 2 +``` \ No newline at end of file diff --git a/programming/python/api-reference/index.md b/programming/python/api-reference/index.md deleted file mode 100644 index 0a7cb8d..0000000 --- a/programming/python/api-reference/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Python Edition API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer SDK API Reference for Python Edition. -keywords: CDocumentNormalizer, api reference, python ---- - -# API Reference - Python - -## DynamsoftCaptureVisionRouter - -### [CaptureVisionRouter]({{ site.dcv_python_api }}capture-vision-router/capture-vision-router.html) - -- [`Constructor`]({{ site.dcv_python_api }}capture-vision-router/instantiate.html) -- [`Single-File Processing`]({{ site.dcv_python_api }}capture-vision-router/single-file-processing.html) -- [`Multiple-File Processing`]({{ site.dcv_python_api }}capture-vision-router/multiple-file-processing.html) -- [`Settings`]({{ site.dcv_python_api }}capture-vision-router/settings.html) -- [`Buffered Items`]({{ site.dcv_python_api }}capture-vision-router/buffered-items.html) - -### Classes - -- [`BufferedItemsManager`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/buffered-items-manager.html) -- [`CaptureStateListener`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/capture-state-listener.html) -- [`CaptureVisionRouterModule`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html) -- [`CapturedResultFilter`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) -- [`CapturedResultReceiver`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) -- [`CapturedResult`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/captured-result.html) -- [`ImageSourceStateListener`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/image-source-state-listener.html) -- [`SimplifiedCaptureVisionSettings`]({{ site.dcv_python_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) - -### Enums - -- [`EnumCaptureState`]({{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=python) -- [`EnumImageSourceState`]({{ site.dcv_enumerations }}capture-vision-router/image-source-state.html?lang=python) -- [`EnumPresetTemplate`]({{ site.dcv_enumerations }}capture-vision-router/preset-template.html?lang=python) - -## DynamsoftDocumentNormalizer - -### Classes - -- [`DetectedQuadResultItem`]({{ site.ddn_python_api }}detected-quad-result-item.html) -- [`DetectedQuadsResult`]({{ site.ddn_python_api }}detected-quads-result.html) -- [`DocumentNormalizerModule`]({{ site.ddn_python_api }}document-normalizer-module.html) -- [`NormalizedImageResultItem`]({{ site.ddn_python_api }}normalized-image-result-item.html) -- [`NormalizedImagesResult`]({{ site.ddn_python_api }}normalized-images-result.html) -- [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_python_api }}simplified-document-normalizer-settings.html) - - -### Enums - -- [`EnumImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=python) - -## DynamsoftCore - -### Classes - -- [`CapturedResultItem`]({{ site.dcv_python_api }}core/basic-classes/captured-result-item.html) -- [`CoreModule`]({{ site.dcv_python_api }}core/basic-classes/core-module.html) -- [`FileImageTag`]({{ site.dcv_python_api }}core/basic-classes/file-image-tag.html) -- [`ImageData`]({{ site.dcv_python_api }}core/basic-classes/image-data.html) -- [`ImageSourceAdapter`]({{ site.dcv_python_api }}core/basic-classes/image-source-adapter.html) -- [`ImageSourceErrorListener`]({{ site.dcv_python_api }}core/basic-classes/image-source-error-listener.html) -- [`ImageTag`]({{ site.dcv_python_api }}core/basic-classes/image-tag.html) -- [`OriginalImageResultItem`]({{ site.dcv_python_api }}core/basic-classes/original-image-result-item.html) -- [`PDFReadingParameter`]({{ site.dcv_python_api }}core/basic-classes/pdf-reading-parameter.html) -- [`Point`]({{ site.dcv_python_api }}core/basic-classes/point.html) -- [`Quadrilateral`]({{ site.dcv_python_api }}core/basic-classes/quadrilateral.html) -- [`Rect`]({{ site.dcv_python_api }}core/basic-classes/rect.html) -- [`VideoFrameTag`]({{ site.dcv_python_api }}core/basic-classes/video-frame-tag.html) - -### Enums - -- [`EnumBufferOverflowProtectionMode`]({{ site.dcv_enumerations }}core/buffer-overflow-protection-mode.html?lang=python) -- [`EnumCapturedResultItemType`]({{ site.dcv_enumerations }}core/captured-result-item-type.html?lang=python) -- [`EnumColourChannelUsageType`]({{ site.dcv_enumerations }}core/colour-channel-usage-type.html?lang=python) -- [`EnumErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=python) -- [`EnumGrayscaleEnhancementMode`]({{ site.dcv_enumerations }}core/grayscale-enhancement-mode.html?lang=python) -- [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=python) -- [`EnumImageCaptureDistanceMode`]({{ site.dcv_enumerations }}core/image-capture-distance-mode.html?lang=python) -- [`EnumImagePixelFormat`]({{ site.dcv_enumerations }}core/image-pixel-format.html?lang=python) -- [`EnumImageTagType`]({{ site.dcv_enumerations }}core/image-tag-type.html?lang=python) -- [`EnumPDFReadingMode`]({{ site.dcv_enumerations }}core/pdf-reading-mode.html?lang=python) -- [`EnumRasterDataSource`]({{ site.dcv_enumerations }}core/raster-data-source.html?lang=python) -- [`EnumVideoFrameQuality`]({{ site.dcv_enumerations }}core/video-frame-quality.html?lang=python) - -## DynamsoftUtility - -- [`DirectoryFetcher`]({{ site.dcv_python_api }}utility/directory-fetcher.html) -- [`FileFetcher`]({{ site.dcv_python_api }}utility/file-fetcher.html) -- [`ImageManager`]({{ site.dcv_python_api }}utility/image-manager.html) -- [`MultiFrameResultCrossFilter`]({{ site.dcv_python_api }}utility/multi-frame-result-cross-filter.html) -- [`ProactiveImageSourceAdapter`]({{ site.dcv_python_api }}utility/proactive-image-source-adapter.html) -- [`UtilityModule`]({{ site.dcv_python_api }}utility/utility-module.html) - -## DynamsoftLicense - -- [`LicenseManager`]({{ site.dcv_python_api }}license/license-manager.html) -- [`LicenseModule`]({{ site.dcv_python_api }}license/license-module.html) - - -## DynamsoftImageProcessing - -- [`ImageProcessingModule`]({{ site.dcv_python_api }}image-processing/image-processing-module.html) - diff --git a/programming/python/api-reference/logic-lines-unit.md b/programming/python/api-reference/logic-lines-unit.md new file mode 100644 index 0000000..34c9ca1 --- /dev/null +++ b/programming/python/api-reference/logic-lines-unit.md @@ -0,0 +1,125 @@ +--- +layout: default-layout +title: LogicLinesUnit Class +description: This page shows LogicLinesUnit class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: get_count, get_logic_line, LogicLinesUnit, api reference +--- + +# LogicLinesUnit Class + +The `LogicLinesUnit` class represents an intermediate result unit whose type is logic lines. Logic lines are formed by combining long lines that meet certain conditions. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class LogicLinesUnit(IntermediateResultUnit): +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcv_python_api }}core/intermediate-results/intermediate-result-unit.html) -> LogicLinesUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_count`](#get_count) | Gets the count of `LogicLine` objects in current object.| +| [`get_logic_line`](#get_logic_line) | Gets a `LogicLine` object from current object by specifying a index. | +| [`remove_all_logic_lines`](#remove_all_logic_lines) | Removes all the `LogicLines` in current object. | +| [`remove_logic_line`](#remove_logic_line) | Removes a `LogicLine` from current object by specifying an index. | +| [`add_logic_line`](#add_logic_line) | Adds a `LogicLine` to current object. | +| [`set_logic_line`](#set_logic_line) | Sets the `LogicLine` at the specified index. | + +### get_count + +Gets the count of `LogicLine` objects in current object. + +```python +def get_count(self) -> int: +``` + +**Return Value** + +The count of `LogicLine` objects in current object. + +### get_logic_line + +Gets a `LogicLine` object from current object by specifying a index. + +```python +def get_logic_line(self, index: int) -> LineSegment: +``` + +**Parameters** + +`index` The index of the `LogicLine` object. + +**Return Value** + +Returns the `LogicLine` object. + +**See Also** + +* [LineSegment]({{ site.dcvb_python_api }}core/basic-classes/line-segment.html) + +### remove_all_logic_lines + +Removes all the LogicLines in current object. + +```python +def remove_all_logic_lines(self) -> None: +``` + +### remove_logic_line + +Removes a `LogicLine` from current object by specifying an index. + +```python +def remove_logic_line(self, index: int) -> int: +``` + +**Parameters** + +`index` The index of the `LogicLine` to be removed. + +**Return Value** + +Returns 0 if successful, otherwise returns a negative value. + +### add_logic_line + +Adds a `LogicLine` to current object. + +```python +def add_logic_line(self, line: LineSegment, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int: +``` + +**Parameters** + +`line` The `LogicLine` to be added. + +`matrix_to_original_image` The matrix to the original image. + +**Return Value** + +Returns 0 if successful, otherwise returns a negative value. + +### set_logic_line + +Sets the `LogicLine` at the specified index. + +```python +def set_logic_line(self, index: int, line: LineSegment, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int: +``` + +**Parameters** + +`index` The index of the LogicLine to be set. + +`line` The LogicLine to be added. + +`matrix_to_original_image` The matrix to the original image. + +**Return Value** + +Returns 0 if successful, otherwise returns a negative value. diff --git a/programming/python/api-reference/normalized-images-result.md b/programming/python/api-reference/normalized-images-result.md index 94deb80..66e9704 100644 --- a/programming/python/api-reference/normalized-images-result.md +++ b/programming/python/api-reference/normalized-images-result.md @@ -42,7 +42,7 @@ Returns the error code of the operation. A non-zero value indicates an error occ **See Also** -[EnumErrorCode]({{ site.dcv_enumerations }}core/error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) ### get_error_string diff --git a/programming/python/api-reference/processed-document-result.md b/programming/python/api-reference/processed-document-result.md new file mode 100644 index 0000000..281cf1a --- /dev/null +++ b/programming/python/api-reference/processed-document-result.md @@ -0,0 +1,76 @@ +--- +layout: default-layout +title: ProcessedDocumentResult Class +description: This page shows ProcessedDocumentResult class definition of Dynamsoft Document Normalizer SDK Python Edition. +keywords: ProcessedDocumentResult, api reference +--- + +# ProcessedDocumentResult Class + +The `ProcessedDocumentResult` class is a base class for storing processed document results, including detected quads, deskewed images, and enhanced images. It inherits from `CapturedResultBase`. + +## Definition + +*Module:* dynamsoft_document_normalizer + +```python +class ProcessedDocumentResult(CapturedResultBase): +``` + +*Inheritance:* [CapturedResultBase]({{ site.dcv_python_api }}core/basic-classes/captured-result-base.html) -> ProcessedDocumentResult + +## Methods + +| Method | Description | +|--------|-------------| +| [`get_deskewed_image_result_items`](#get_deskewed_image_result_items) | Retrieves the deskewed image result items. | +| [`get_detected_quad_result_items`](#get_detected_quad_result_items) | Retrieves the detected quad result items. | +| [`get_enhanced_image_result_items`](#get_enhanced_image_result_items) | Retrieves the enhanced image result items. | + +### get_deskewed_image_result_items + +Retrieves the deskewed image result items. + +```python +def get_deskewed_image_result_items(self) -> List[DeskewedImageResultItem]: +``` + +**Return Value** + +Returns a list of `DeskewedImageResultItem` object representing the deskewed image result items. + +**See Also** + +* [DeskewedImageResultItem]({{ site.ddn_python_api }}deskewed-image-result-item.html) + +### get_detected_quad_result_items + +Retrieves the detected quad result items. + +```python +def get_detected_quad_result_items(self) -> List[DetectedQuadResultItem]: +``` + +**Return Value** + +Returns a list of `DetectedQuadResultItem` object representing the detected quad results. + +**See Also** + +* [DetectedQuadResultItem]({{ site.ddn_python_api }}detected-quad-result-item.html) + +### get_enhanced_image_result_items + +Retrieves the enhanced image result items. + +```python +def get_enhanced_image_result_items(self) -> List[EnhancedImageResultItem]: +``` + +**Return Value** + +Returns a list of `EnhancedImageResultItem` object representing the enhanced image results. + +**See Also** + +* [EnhancedImageResultItem]({{ site.ddn_python_api }}enhanced-image-result-item.html) diff --git a/programming/python/api-reference/simplified-document-normalizer-settings-v2.5.2100.md b/programming/python/api-reference/simplified-document-normalizer-settings-v2.5.2100.md new file mode 100644 index 0000000..e116550 --- /dev/null +++ b/programming/python/api-reference/simplified-document-normalizer-settings-v2.5.2100.md @@ -0,0 +1,154 @@ +--- +layout: default-layout +title: SimplifiedDocumentNormalizerSettings Class - Dynamsoft Document Normalizer Module Python Edition API Reference +description: Definition of the SimplifiedDocumentNormalizerSettings class in Dynamsoft Document Normalizer Module Python Edition. +keywords: class, python, SimplifiedDocumentNormalizerSettings +needAutoGenerateSidebar: true +needGenerateH3Content: true +--- + +# SimplifiedDocumentNormalizerSettings + +The `SimplifiedDocumentNormalizerSettings` class contains settings for document normalization. It is a sub-parameter of `SimplifiedCaptureVisionSettings` + +```python +class SimplifiedDocumentNormalizerSettings +``` + +## Properties Summary + +| Property | Type | +| --------- | ---- | +| [`grayscale_transformation_modes`](#grayscale_transformation_modes) | *List[int]* | +| [`grayscale_enhancement_modes`](#grayscale_enhancement_modes) | *List[int]* | +| [`colour_mode`](#colour_mode) | *int* | +| [`page_size`](#page_size) | *List[int]* | +| [`brightness`](#brightness) | *int* | +| [`contrast`](#contrast) | *int* | +| [`max_threads_in_one_task`](#max_threads_in_one_task) | *int* | +| [`scale_down_threshold`](#scale_down_threshold) | *int* | +| [`min_quadrilateral_area_ratio`](#min_quadrilateral_area_ratio) | *int* | +| [`expected_documents_count`](#expected_documents_count) | *int* | + +### grayscale_transformation_modes + +Specifies how grayscale transformations should be applied, including whether to process inverted grayscale images and the specific transformation mode to use. + +It is a list of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=python) enumeration. + +View the parameter reference page of `GrayscaleTransformationModes` for more detail about grayscale transformation modes. + +### grayscale_enhancement_modes + +Specifies how to enhance the quality of the grayscale image. + +It is a list of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleEnhancementMode`]({{ site.dcv_enumerations }}core/grayscale-enhancement-mode.html?lang=python) enumeration. + +View the parameter reference page of `GrayscaleEnhancementModes` for more detail about grayscale enhancement modes. + +### colour_mode + +Specifies the colour mode of the output image. + +It is a value of the [`EnumImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=python) enumeration. + +View the parameter reference page of `ColourMode` for more detail about colour mode. + +**Default value** + +0, which means output image in colour mode. + +### page_size + +Specifies the page size (width by height in pixels) of the normalized image. + +### brightness + +Specifies the brightness of the normalized image. + +**Value Range** + +[-100,100] + +**Default value** + +0 + +### contrast + +Specifies the contrast of the normalized image. + +**Value Range** + +[-100,100] + +**Default value** + +0 + +### max_threads_in_one_task + +Specifies the maximum available threads count in one document normalization task. + +**Value Range** + +[1, 256] + +**Default value** + +4 + +### scale_down_threshold + +Specifies the threshold for the image shrinking. + +**Value Range** + +[512, 0x7fffffff] + +**Default Value** + +2300 + +**Remarks** + +If the shorter edge size is larger than the given threshold value, the library will calculate the required height and width of the barcode image and shrink the image to that size before detection. Otherwise, the library will perform document detection on the original image. + +### min_quadrilateral_area_ratio + +Specifies the minimum ratio between the target quadrilateral area and the total image area. Only those exceeding this value will be output (measured in percentages). + +**Value Range** + +[0, 100] + +**Default Value** + +0, which means no limitation. + +### expected_documents_count + +Specifies the number of documents expected to be detected. + +**Value Range** + +[0, 0x7fffffff] + +**Default Value** + +0, which means the count is unknown. The library will try to find at least 1 document. + +## Methods + +| Method | Description | +|------- | ---- | +| [`__init__`](#__init__) | Initializes a new instance of the `SimplifiedDocumentNormalizerSettings` class. | + +### \_\_init\_\_ + +Initializes a new instance of the `SimplifiedDocumentNormalizerSettings` class. + +```python +def __init__(self): +``` + diff --git a/programming/python/api-reference/simplified-document-normalizer-settings.md b/programming/python/api-reference/simplified-document-normalizer-settings.md index e116550..e2a0e43 100644 --- a/programming/python/api-reference/simplified-document-normalizer-settings.md +++ b/programming/python/api-reference/simplified-document-normalizer-settings.md @@ -3,8 +3,6 @@ layout: default-layout title: SimplifiedDocumentNormalizerSettings Class - Dynamsoft Document Normalizer Module Python Edition API Reference description: Definition of the SimplifiedDocumentNormalizerSettings class in Dynamsoft Document Normalizer Module Python Edition. keywords: class, python, SimplifiedDocumentNormalizerSettings -needAutoGenerateSidebar: true -needGenerateH3Content: true --- # SimplifiedDocumentNormalizerSettings @@ -34,7 +32,7 @@ class SimplifiedDocumentNormalizerSettings Specifies how grayscale transformations should be applied, including whether to process inverted grayscale images and the specific transformation mode to use. -It is a list of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=python) enumeration. +It is a list of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleTransformationMode`]({{ site.dcv_python_api }}core/enum-grayscale-transformation-mode.html?lang=python) enumeration. View the parameter reference page of `GrayscaleTransformationModes` for more detail about grayscale transformation modes. @@ -42,7 +40,7 @@ View the parameter reference page of `GrayscaleEnhancementModes` for more detail about grayscale enhancement modes. @@ -50,7 +48,7 @@ View the parameter reference page of `ColourMode` for more detail about colour mode. @@ -136,7 +134,7 @@ Specifies the number of documents expected to be detected. **Default Value** -0, which means the count is unknown. The library will try to find at least 1 document. +1. ## Methods diff --git a/programming/python/index.md b/programming/python/index.md deleted file mode 100644 index 7ff0020..0000000 --- a/programming/python/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Introduction - Dynamsoft Document Normalizer Python Edition -keywords: python, cplusplus, documentation -description: This page introduces the Python Edition of Dynamsoft Document Normalizer -needAutoGenerateSidebar: false ---- - -# Dynamsoft Document Normalizer Documentation for Python Edition - -Dynamsoft Document Normalizer (DDN) SDK Python Edition is a document normalization tool designed specifically for .NET developers. - -Leveraging the efficiency and flexibility of the .NET language, DDN Python Edition provides rich APIs for developers to easily integrate document normalization functionality into your .NET applications. Please take a look at [API Reference](api-reference/index.md) to see details. - -In addition, DDN Python Edition provides cross-platform support, running on multiple operating systems such as Windows, Linux, and Mac, to meet the needs of different development environments - -As one of the functional products of the Dynamsoft Capture Vision (DCV) framework, DDN is also designed to seamlessly integrate with other DCV components and provide developers with a comprehensive set of image processing tools, which cover image capturing, content understanding, result parsing, and interactive workflow. If you are building such a document capturing and processing solution, take a look at Introduction to Dynamsoft Capture Vision. - -Furthermore, DDN provides a powerful parameter system in order to cope with various scenarios. Read Parameter Reference for details. - -## Getting Started with DDN Python Edition - -The best way to start with the Dynamsoft Document Normalizer Python Edition, is following the [`User Guide`](user-guide/getting-started.md) to build your first document normalization application. Please note that the system requirements is as below: - -### System Requirements - -- Windows: - - Supported Versions: Windows 7 and higher, or Windows Server 2003 and higher - - Architecture: x64 and x86 - - Development Environment: Visual Studio 2012 or higher. - -- Linux: - - Supported Distributions: Ubuntu 14.04.4+ LTS, Debian 8+, CentOS 6+ - - Architectures: x64 - - Minimum GLIBC Version: GLIBC_2.18 or higher - -- Supported .NET versions - - .NET Framework 3.5 and above - - .NET 6, 7, 8 - -## License Subscription - -To develop and run your application with Dynamsoft Document Normalizer SDK, you need an active license key: -* Request a 30-day free trial license - -## Other Edition - -DDN is designed to provide document border detection and document normalization functionality for web, desktop and mobile applications. If you are developing with other programming languages, please checkout following editions: - -* Dynamsoft Document Normalizer Documentation for Javascript -* Dynamsoft Document Normalizer Documentation for Android -* Dynamsoft Document Normalizer Documentation for iOS -* Dynamsoft Document Normalizer Documentation for Xamarin.Forms -* Dynamsoft Document Normalizer Documentation for C++ - -## Contact Us - -Feel free to contact us if you have any questions. diff --git a/programming/python/release-notes/dotnet-2.md b/programming/python/release-notes/dotnet-2.md deleted file mode 100644 index 2db75b9..0000000 --- a/programming/python/release-notes/dotnet-2.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default-layout -title: Release Notes for Python Edition - v2.x -description: This is the release notes page of Dynamsoft Document Normalizer SDK Python Edition for version 2.x. -keywords: release notes, python, -needGenerateH3Content: false ---- - -# Release Notes for Python Edition - v2.x - -## 2.4.10 (08/27/2024) - -### Highlights - -{%- include release-notes/python-highlight-2.4.10.md -%} diff --git a/programming/python/release-notes/index.md b/programming/python/release-notes/index.md deleted file mode 100644 index 6989385..0000000 --- a/programming/python/release-notes/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Python Edition - Release Notes -description: This is the release notes page of Dynamsoft Document Normalizer SDK Python Edition. -keywords: release notes, python -needAutoGenerateSidebar: false ---- - -# Release Notes - Python Edition - -- [2.4.10 (08/27/2024)](python-2.md#2410-08272024) diff --git a/programming/python/user-guide/getting-started.md b/programming/python/user-guide/getting-started.md deleted file mode 100644 index 41f796e..0000000 --- a/programming/python/user-guide/getting-started.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -layout: default-layout -title: User Guide - Dynamsoft Document Normalizer SDK Python Edition -description: This is the user guide of Dynamsoft Document Normalizer SDK Python Edition. -keywords: user guide, python -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Getting Started with Dynamsoft Document Normalizer SDK Python Edition - -In this guide, you will learn step by step on how to build a document normalization application with Dynamsoft Document Normalizer SDK using C#. - -- [Getting Started with Dynamsoft Document Normalizer SDK Python Edition](#getting-started-with-dynamsoft-document-normalizer-sdk-python-edition) - - [System Requirements](#system-requirements) - - [Build Your First Application](#build-your-first-application) - - [Create a New Project](#create-a-new-project) - - [Install the NuGet Package](#install-the-nuget-package) - - [Import the Namespace](#import-the-namespace) - - [Initialize the License Key](#initialize-the-license-key) - - [Create a CaptureVisionRouter Instance](#create-a-capturevisionrouter-instance) - - [Invoke the Document Capturing](#invoke-the-document-capturing) - - [Filter and Get Document Detection and Normalization Results](#filter-and-get-document-detection-and-normalization-results) - - [Build and Run the Project](#build-and-run-the-project) - - [Process Multiple Images](#process-multiple-images) - - [Import the Additional Namespace.](#import-the-additional-namespace) - - [Create an ImageSource as the Input](#create-an-imagesource-as-the-input) - - [Implement a CapturedResultReceiver as the Output Listener](#implement-a-capturedresultreceiver-as-the-output-listener) - - [Handle Capture Stoppage by Implementing a ImageSource State Listener](#handle-capture-stoppage-by-implementing-a-imagesource-state-listener) - - [Register the Input, Output Listener and ImageSource State Listener to the CaptureVisionRouter Instance](#register-the-input-output-listener-and-imagesource-state-listener-to-the-capturevisionrouter-instance) - - [Start the Capturing Process](#start-the-capturing-process) - - [Build and Run the Project Again](#build-and-run-the-project-again) - -## System Requirements - -To find out whether your environment is supported, please read the [System Requirements]({{ site.ddn_python }}index.html#system-requirements). - -## Build Your First Application - -Let's start by creating a console application which demonstrates how to use the minimum code to detect and normalize a document from an image file. - -> You can download the entire source code from here. - -### Create a New Project - -Start Visual Studio or your preferred C# IDE. - -Create a new C# Console Application project. - -### Install the NuGet Package - -In the Solution Explorer, right-click on your project and select Manage NuGet Packages. - -Search for and install the `Dynamsoft.DotNet.DocumentNormalizer.Bundle` nuget package. - -> If you prefer to use the offline packages, please -> -> Download the `python Package` now and extract it into a directory of your choice. -> -> Add the extracted `.\Dynamsoft\Packages` directory as a new package source -> -> Install following packages from the added package source: -> * Dynamsoft.DotNet.DocumentNormalizer -> * Dynamsoft.DotNet.CaptureVisionRouter -> * Dynamsoft.DotNet.Core -> * Dynamsoft.DotNet.ImageProcessing -> * Dynamsoft.DotNet.License -> * Dynamsoft.DotNet.Utility - -### Import the Namespace - -Open the `Program.cs` file and add the following namespaces. - -```python -using Dynamsoft.DDN -using Dynamsoft.Core -using Dynamsoft.CVR -using Dynamsoft.License -``` - -### Initialize the License Key - -Open the `Program.cs` file and add the following code inside the `Main` method to initialize the license for using the SDK in the application: - -```python -int error_code = 1 -string errorMsg -error_code = LicenseManager.init_license("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", out errorMsg) -if (error_code != (int)EnumErrorCode.EC_OK && error_code != (int)EnumErrorCode.EC_LICENSE_CACHE_USED) - Console.WriteLine("License initialization error: " + errorMsg) -``` - -> The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. When it expires, you can request a 30-day trial license via the Request a Trial License link. - -### Create a CaptureVisionRouter Instance - -```python -using (CaptureVisionRouter cvr = new CaptureVisionRouter()) -{ - //code for invoking the document capturing -} -``` - -### Invoke the Document Capturing - -```python -using (CaptureVisionRouter cvr = new CaptureVisionRouter()) -{ - string imageFile = "[PATH-TO-THE-IMAGE-FILE]" - CapturedResult? result = cvr.Capture(imageFile, PresetTemplate.PT_DETECT_AND_NORMALIZE_DOCUMENT) - //code for filtering and getting document detection and normalization results -} -``` - -> Please change the `[PATH-TO-THE-IMAGE-FILE]` to a real image file path. -> -> Sample images are also available in the `\Dynamsoft\Resources\DocumentNormalizer\Images` directory within the downloaded `python Package`. - -### Filter and Get Document Detection and Normalization Results - -```python -if (result == null) -{ - Console.WriteLine("No Result.") -} -else if(result.get_error_code() != 0) -{ - Console.WriteLine("Error: " + result.get_error_code() + ", " + result.get_error_string()) -} -else -{ - NormalizedImagesResult? normalizedImagesResult = result.get_normalized_images_result() - if (normalizedImagesResult != null) - { - NormalizedImageResultItem[] items = normalizedImagesResult.get_items() - Console.WriteLine("Detected and Normalized " + items.Length + " documents") - foreach (NormalizedImageResultItem normalizedItem in items) - { - string outPath = "normalizedResult_" + Array.IndexOf(items, normalizedItem) + ".png" - ImageManager imageManager = new ImageManager() - var image = normalizedItem.get_image_data() - if (image != null) - { - error_code = imageManager.save_to_file(image, outPath) - if (error_code == 0) - { - Console.WriteLine("Document " + Array.IndexOf(items, normalizedItem) + " file: " + outPath) - } - } - } - } -} -``` - -### Build and Run the Project - -Save the `Program.cs` file and then compile and run the program using your IDE (such as Visual Studio). You will see the output message in the console like - -``` -Detected and Normalized 1 documents -Document 1 file: normalizedResult_1.png -``` - -## Process Multiple Images - -If, instead of processing one single image, you need to process many images at once, you can follow these steps: - -> These steps follow the step [Create a CaptureVisionRouter Instance](#create-a-capturevisionrouter-instance) mentioned above. - -> You can download the entire source code from here. - -### Import the Additional Namespace. - -```python -using Dynamsoft.Utility -``` - -### Create an ImageSource as the Input - -An `ImageSource` is required when crreating a multi-image processing application. You can either utilize ready-made image sources such as [`FileFetcher`]({{ site.dcv_python_api }}utility/file-fetcher.html) and [`DirectoryFetcher`]({{ site.dcv_python_api }}utility/directory-fetcher.html), or customize your own image source based on the base class [`ImageSourceAdapter`]({{ site.dcv_python_api }}core/basic-classes/image-source-adapter.html). - -In this sample, we will use the `DirectoryFetcher` to retrieve images from a local directory. - -```python -DirectoryFetcher fetcher = new DirectoryFetcher() -fetcher.set_directory("[THE DIRECTORY THAT HOLDS THE IMAGES]") -``` - -> Please change the `[THE DIRECTORY THAT HOLDS THE IMAGES]` to full path of the directory holding image files. -> -> Sample images are also available in the `\Dynamsoft\Resources\DocumentNormalizer\Images` directory within the downloaded `python Package`. - -### Implement a CapturedResultReceiver as the Output Listener - -Create a class `MyCapturedResultReceiver` to implement the `CapturedResultReceiver` class, and get the barocde results in `on_normalized_images_received` callback function. - -```python -class MyCapturedResultReceiver(CapturedResultReceiver) -{ - public override void on_normalized_images_received(NormalizedImagesResult result) - { - FileImageTag? tag = (FileImageTag?)result.get_original_image_tag() - Console.WriteLine("File: " + tag.get_file_path()) - if (result.get_error_code() != (int)EnumErrorCode.EC_OK) - { - Console.WriteLine("Error: " + result.get_error_string()) - } - else - { - NormalizedImagesResult? normalizedImagesResult = result.get_normalized_images_result() - if (normalizedImagesResult != null) - { - NormalizedImageResultItem[] items = normalizedImagesResult.get_items() - Console.WriteLine("Detected and Normalized " + items.Length + " documents") - foreach (NormalizedImageResultItem normalizedItem in items) - { - string outPath = "normalizedResult_" + Array.IndexOf(items, normalizedItem) + ".png" - ImageManager imageManager = new ImageManager() - var image = normalizedItem.get_image_data() - if (image != null) - { - error_code = imageManager.save_to_file(image, outPath) - if (error_code == 0) - { - Console.WriteLine("Document " + Array.IndexOf(items, normalizedItem) + " file: " + outPath) - } - } - } - } - } - Console.WriteLine() - } -} -``` - -### Handle Capture Stoppage by Implementing a ImageSource State Listener - -Create a class `MyImageSourceStateListener` to implement the `ImageSourceStateListener` class, and call stop_capturing in `on_image_source_state_received` callback function when the state is `ISS_EXHAUSTED`. - -```python -class MyImageSourceStateListener(ImageSourceStateListener) -{ - private CaptureVisionRouter? cvr = null - public MyImageSourceStateListener(CaptureVisionRouter cvr) - { - this.cvr = cvr - } - public void on_image_source_state_received(EnumImageSourceState state) - { - if (state == EnumImageSourceState.ISS_EXHAUSTED) - { - if (cvr != null) - { - cvr.stop_capturing() - } - } - } -} -``` - -### Register the Input, Output Listener and ImageSource State Listener to the CaptureVisionRouter Instance - -```python -cvr.set_input(fetcher) -CapturedResultReceiver receiver = new MyCapturedResultReceiver() -cvr.add_result_receiver(receiver) -MyImageSourceStateListener listener = new MyImageSourceStateListener(cvr) -cvr.add_image_source_state_listener(listener) -``` - -### Start the Capturing Process - -Call the method `start_capturing()` to start processing all the images in the specified folder. - -```python -error_code = cvr.start_capturing(PresetTemplate.PT_DETECT_AND_NORMALIZE_DOCUMENT, true, out errorMsg) -if (error_code != (int)EnumErrorCode.EC_OK) -{ - Console.WriteLine("error: " + errorMsg) -} -``` - -During the process, the callback function `on_normalized_images_received()` is triggered each time processing of an image is finished. After all images are processed, the listener function `on_image_source_state_received()` will be triggered while the image source state is `ISS_EXHAUSTED` and the process is stopped with the method `stop_capturing()`. - -### Build and Run the Project Again - -Please refer to [Build and Run the Project](#build-and-run-the-project). - From 7b3a81aa92e475cb93af517e8664d61e2dff342b Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Tue, 8 Apr 2025 14:40:50 +0800 Subject: [PATCH 2/2] update to internal commit 59beb644 --- .../python/api-reference/candidate-quad-edges-unit.md | 2 +- programming/python/api-reference/corners-unit.md | 2 +- programming/python/api-reference/detected-quads-result.md | 2 +- .../python/api-reference/normalized-images-result.md | 2 +- .../simplified-document-normalizer-settings.md | 6 +++--- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/programming/python/api-reference/candidate-quad-edges-unit.md b/programming/python/api-reference/candidate-quad-edges-unit.md index 6fe8261..d2a7389 100644 --- a/programming/python/api-reference/candidate-quad-edges-unit.md +++ b/programming/python/api-reference/candidate-quad-edges-unit.md @@ -62,7 +62,7 @@ Returns a tuple containing following elements: **See Also** -[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html) [Edge]({{ site.dcv_python_api }}core/basic-classes/edge.html) diff --git a/programming/python/api-reference/corners-unit.md b/programming/python/api-reference/corners-unit.md index 57c1e0e..76ca2b5 100644 --- a/programming/python/api-reference/corners-unit.md +++ b/programming/python/api-reference/corners-unit.md @@ -62,7 +62,7 @@ Returns a tuple containing following elements: **See Also** -[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html) [Corner]({{ site.dcv_python_api }}core/basic-classes/corner.html) diff --git a/programming/python/api-reference/detected-quads-result.md b/programming/python/api-reference/detected-quads-result.md index 8fe43b9..cf902cc 100644 --- a/programming/python/api-reference/detected-quads-result.md +++ b/programming/python/api-reference/detected-quads-result.md @@ -42,7 +42,7 @@ Returns the error code. **See Also** -[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html) ### get_error_string diff --git a/programming/python/api-reference/normalized-images-result.md b/programming/python/api-reference/normalized-images-result.md index 66e9704..80f5931 100644 --- a/programming/python/api-reference/normalized-images-result.md +++ b/programming/python/api-reference/normalized-images-result.md @@ -42,7 +42,7 @@ Returns the error code of the operation. A non-zero value indicates an error occ **See Also** -[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html?lang=python) +[EnumErrorCode]({{ site.dcv_python_api }}core/enum-error-code.html) ### get_error_string diff --git a/programming/python/api-reference/simplified-document-normalizer-settings.md b/programming/python/api-reference/simplified-document-normalizer-settings.md index e2a0e43..d75207c 100644 --- a/programming/python/api-reference/simplified-document-normalizer-settings.md +++ b/programming/python/api-reference/simplified-document-normalizer-settings.md @@ -32,7 +32,7 @@ class SimplifiedDocumentNormalizerSettings Specifies how grayscale transformations should be applied, including whether to process inverted grayscale images and the specific transformation mode to use. -It is a list of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleTransformationMode`]({{ site.dcv_python_api }}core/enum-grayscale-transformation-mode.html?lang=python) enumeration. +It is a list of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleTransformationMode`]({{ site.dcv_python_api }}core/enum-grayscale-transformation-mode.html) enumeration. View the parameter reference page of `GrayscaleTransformationModes` for more detail about grayscale transformation modes. @@ -40,7 +40,7 @@ View the parameter reference page of `GrayscaleEnhancementModes` for more detail about grayscale enhancement modes. @@ -48,7 +48,7 @@ View the parameter reference page of `ColourMode` for more detail about colour mode.