From 7343182292845c1ecbc034f29347c7b0eddb9504 Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 28 Nov 2024 14:13:49 +0800 Subject: [PATCH] update to internal commit d894538a --- .../detected-quad-result-item-v2.4.2200.md | 58 +++++ .../detected-quad-result-item.md | 20 +- .../api-reference/logic-lines-unit.md | 129 +++++++++++ .../normalized-image-result-item-v2.4.2000.md | 63 ++++++ .../normalized-image-result-item.md | 19 +- ...-document-normalizer-settings-v2.4.2000.md | 200 ++++++++++++++++++ ...simplified-document-normalizer-settings.md | 4 +- 7 files changed, 487 insertions(+), 6 deletions(-) create mode 100644 programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.md create mode 100644 programming/cplusplus/api-reference/logic-lines-unit.md create mode 100644 programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.md create mode 100644 programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.4.2000.md diff --git a/programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.md b/programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.md new file mode 100644 index 0000000..3e35535 --- /dev/null +++ b/programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.md @@ -0,0 +1,58 @@ +--- +layout: default-layout +title: CDetectedQuadResultItem Class +description: This page shows CDetectedQuadResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition. +keywords: GetLocation, GetConfidenceAsDocumentBoundary, GetRotationTransformMatrix, CDetectedQuadResultItem, api reference +permalink: /programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.html +--- + +# CDetectedQuadResultItem Class + +The CDetectedQuadResultItem class stores a captured result whose type is detected quad. + +## Definition + +*Namespace:* dynamsoft::ddn + +*Assembly:* DynamsoftDocumentNormalizer + +```cpp +class CDetectedQuadResultItem: CCapturedResultItem +``` + +*Inheritance:* [CCapturedResultItem]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -> CDetectedQuadResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`GetLocation`](#getlocation) | Gets the location of current object. | +| [`GetConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence of current object as a document boundary. | + +### GetLocation + +Gets the location of current object. + +```cpp +const CQuadrilateral GetLocation() +``` + +**Return Value** + +The location of current object. + +**See Also** + +* [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html) + +### GetConfidenceAsDocumentBoundary + +Gets the confidence of current object as a document boundary. + +```cpp +int GetConfidenceAsDocumentBoundary() +``` + +**Return Value** + +The confidence as document boundary of the detected quad result. diff --git a/programming/cplusplus/api-reference/detected-quad-result-item.md b/programming/cplusplus/api-reference/detected-quad-result-item.md index 6e69670..33378e0 100644 --- a/programming/cplusplus/api-reference/detected-quad-result-item.md +++ b/programming/cplusplus/api-reference/detected-quad-result-item.md @@ -3,12 +3,11 @@ layout: default-layout title: CDetectedQuadResultItem Class description: This page shows CDetectedQuadResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition. keywords: GetLocation, GetConfidenceAsDocumentBoundary, GetRotationTransformMatrix, CDetectedQuadResultItem, api reference -permalink: /programming/cplusplus/api-reference/detected-quad-result-item.html --- # CDetectedQuadResultItem Class -The CDetectedQuadResultItem class stores a captured result whose type is detected quad. +The `CDetectedQuadResultItem` class stores a captured result whose type is detected quad. ## Definition @@ -28,6 +27,7 @@ class CDetectedQuadResultItem: CCapturedResultItem |--------|-------------| | [`GetLocation`](#getlocation) | Gets the location of current object. | | [`GetConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence of current object as a document boundary. | +| [`GetCrossVerificationStatus`](#getcrossverificationstatus) | Gets the status of current object as a verified document boundary. | ### GetLocation @@ -56,3 +56,19 @@ int GetConfidenceAsDocumentBoundary() **Return Value** The confidence as document boundary of the detected quad result. + +### GetCrossVerificationStatus + +Gets the status of current object as a verified document boundary. + +```cpp +virtual CrossVerificationStatus GetCrossVerificationStatus() const = 0; +``` + +**Return Value** + +The `CrossVerificationStatus` of the detected quad result. + +**See Also** + +* [CrossVerificationStatus]({{ site.dcv_enumerations }}core/cross-verification-status.html?lang=cpp) diff --git a/programming/cplusplus/api-reference/logic-lines-unit.md b/programming/cplusplus/api-reference/logic-lines-unit.md new file mode 100644 index 0000000..aec1d3e --- /dev/null +++ b/programming/cplusplus/api-reference/logic-lines-unit.md @@ -0,0 +1,129 @@ +--- +layout: default-layout +title: CLogicLinesUnit Class +description: This page shows CLogicLinesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition. +keywords: GetCount, GetLogicLine, CLogicLinesUnit, api reference +permalink: /programming/cplusplus/api-reference/logic-lines-unit.html +--- + +# CLogicLinesUnit Class + +The CLogicLinesUnit class represents an intermediate result unit whose type is logic lines. Logic lines are formed by combining long lines that meet certain conditions. + +## Definition + +*Namespace:* dynamsoft::ddn::intermediate_results + +*Assembly:* DynamsoftDocumentNormalizer + +```cpp +class CLogicLinesUnit: CIntermediateResultUnit +``` + +*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLogicLinesUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`GetCount`](#getcount) | Gets the count of LogicLine objects in current object.| +| [`GetLogicLine`](#getlogicline) | Gets a LogicLine object from current object by specifying a index. | +| [`RemoveAllLogicLines`](#removealllogiclines) | Removes all the LogicLines in current object. | +| [`RemoveLogicLine`](#removelogicline) | Removes a LogicLine from current object by specifying an index. | +| [`AddLogicLine`](#addlogicline) | Adds a LogicLine to current object. | +| [`SetLogicLine`](#setlogicline) | Sets the LogicLine at the specified index. | + +### GetCount + +Gets the count of LogicLine objects in current object. + +```cpp +int GetCount() +``` + +**Return Value** + +The count of LogicLine objects in current object. + +### GetLogicLine + +Gets a LogicLine object from current object by specifying a index. + +```cpp +const CLineSegment* GetLogicLine(int index) const = 0; +``` + +**Parameters** + +`[in] index` The index of the LogicLine object. + +**Return Value** + +Returns the LogicLine 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) + +### RemoveAllLogicLines + +Removes all the LogicLines in current object. + +```cpp +virtual void RemoveAllLogicLines() = 0 +``` + +### RemoveLogicLine + +Removes a LogicLine from current object by specifying an index. + +```cpp +virtual int RemoveLogicLine(int index) = 0 +``` + +**Parameters** + +`[in] index` The index of the LogicLine to be removed. + +**Return Value** + +Returns 0 if successful, otherwise returns a negative value. + +### AddLogicLine + +Adds a LogicLine to current object. + +```cpp +virtual int AddLogicLine(const CLineSegment& logicline, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0 +``` + +**Parameters** + +`[in] line` The LogicLine to be added. + +`[in] matrixToOriginalImage` The matrix to the original image. + +**Return Value** + +Returns 0 if successful, otherwise returns a negative value. + +### SetLogicLine + +Sets the LogicLine at the specified index. + +```cpp +virtual int SetLogicLine(int index, const CLineSegment& logicline, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0; +``` + +**Parameters** + +`[in] index` The index of the LogicLine to be set. + +`[in] line` The LogicLine to be added. + +`[in] matrixToOriginalImage` The matrix to the original image. + +**Return Value** + +Returns 0 if successful, otherwise returns a negative value. diff --git a/programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.md b/programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.md new file mode 100644 index 0000000..6187968 --- /dev/null +++ b/programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: CNormalizedImageResultItem Class +description: This page shows CNormalizedImageResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition. +keywords: GetImageData, SaveToFile, CNormalizedImageResultItem, api reference +permalink: /programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.html +--- + +# CNormalizedImageResultItem Class + +The CNormalizedImageResultItem class stores a captured result item whose type is normalized image. + +## Definition + +*Namespace:* dynamsoft::ddn + +*Assembly:* DynamsoftDocumentNormalizer + +```cpp +class CNormalizedImageResultItem: CCapturedResultItem +``` + +*Inheritance:* [CCapturedResultItem]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -> CNormalizedImageResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`GetImageData`](#getimagedata) | Gets the ImageData of current object. | +| [`GetLocation`](#getlocation) | Get the quadrilateral from which you get the normalized image result item. | + +### GetImageData + +Gets the ImageData of current object. + +```cpp +const CImageData* GetImageData() +``` + +**Return Value** + +The image data. + +**See Also** + +* [CImageData]({{ site.dcv_cpp_api }}core/basic-structures/image-data.html) + +### GetLocation + +Gets the location of current object. + +```cpp +const CQuadrilateral GetLocation() +``` + +**Return Value** + +The location of current object. + +**See Also** + +* [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html) + diff --git a/programming/cplusplus/api-reference/normalized-image-result-item.md b/programming/cplusplus/api-reference/normalized-image-result-item.md index 0d334a1..e376dca 100644 --- a/programming/cplusplus/api-reference/normalized-image-result-item.md +++ b/programming/cplusplus/api-reference/normalized-image-result-item.md @@ -3,12 +3,11 @@ layout: default-layout title: CNormalizedImageResultItem Class description: This page shows CNormalizedImageResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition. keywords: GetImageData, SaveToFile, CNormalizedImageResultItem, api reference -permalink: /programming/cplusplus/api-reference/normalized-image-result-item.html --- # CNormalizedImageResultItem Class -The CNormalizedImageResultItem class stores a captured result item whose type is normalized image. +The `CNormalizedImageResultItem` class stores a captured result item whose type is normalized image. ## Definition @@ -28,6 +27,7 @@ class CNormalizedImageResultItem: CCapturedResultItem |--------|-------------| | [`GetImageData`](#getimagedata) | Gets the ImageData of current object. | | [`GetLocation`](#getlocation) | Get the quadrilateral from which you get the normalized image result item. | +| [`GetCrossVerificationStatus`](#getcrossverificationstatus) | Gets the status of current object as a verified normalized image. | ### GetImageData @@ -61,3 +61,18 @@ The location of current object. * [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html) +### GetCrossVerificationStatus + +Gets the status of current object as a verified normalized image. + +```cpp +virtual CrossVerificationStatus GetCrossVerificationStatus() const = 0 +``` + +**Return Value** + +The `CrossVerificationStatus` of the normalized image result. + +**See Also** + +* [CrossVerificationStatus]({{ site.dcv_enumerations }}core/cross-verification-status.html?lang=cpp) diff --git a/programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.4.2000.md b/programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.4.2000.md new file mode 100644 index 0000000..c2e7512 --- /dev/null +++ b/programming/cplusplus/api-reference/simplified-document-normalizer-settings-v2.4.2000.md @@ -0,0 +1,200 @@ +--- +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; + int minQuadrilateralAreaRatio; + int expectedDocumentsCount; + char reserved[504]; +} 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* | +| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | +| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | +| [`reserved`](#reserved) | *char[504]* | + +### 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. + +### minQuadrilateralAreaRatio + +Set the minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages). + +```cpp +int minQuadrilateralAreaRatio; +``` + +**Value Range** + +[0, 100] + +**Default Value** + +0 + +### expectedDocumentsCount + +Set the number of documents expected to be detected. + +```cpp +int expectedDocumentsCount; +``` + +**Value Range** + +[0, 0x7fffffff] + +**Default Value** + +0 + +### reserved + +Reserved for future use. + +```cpp +char reserved[504]; +``` diff --git a/programming/cplusplus/api-reference/simplified-document-normalizer-settings.md b/programming/cplusplus/api-reference/simplified-document-normalizer-settings.md index 0b4c40b..25bd524 100644 --- a/programming/cplusplus/api-reference/simplified-document-normalizer-settings.md +++ b/programming/cplusplus/api-reference/simplified-document-normalizer-settings.md @@ -161,7 +161,7 @@ If the shorter edge size is larger than the given threshold value, the library w ### minQuadrilateralAreaRatio -Set the minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages). +Set the minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages). ```cpp int minQuadrilateralAreaRatio; @@ -189,7 +189,7 @@ int expectedDocumentsCount; **Default Value** -0 +1 ### reserved