Merge pull request #40 from dynamsoft-docs/preview

update to internal commit c334f93c

Author: DMGithubPublisher

_config.yml

@@ -3,6 +3,8 @@ repositoryUrl: https://github.com/dynamsoft-docs/document-normalizer-docs-server
 docFullPath: https://www.dynamsoft.com/document-normalizer/docs/server/
 firstLevelUrl: /document-normalizer/docs/server
 docHomePage: /document-normalizer/docs/core/introduction/
+needSearchIndex: true
+searchNeedFilter: true
 
 ddn_c: /document-normalizer/docs/server/programming/c/
 ddn_c_api: /document-normalizer/docs/server/programming/c/api-reference/

programming/cplusplus/api-reference/deskewed-image-element.md

@@ -0,0 +1,61 @@
+---
+layout: default-layout
+title: CDeskewedImageElement Class
+description: This page shows CDeskewedImageElement class definition of Dynamsoft Document Normalizer SDK C++ Edition.
+keywords: GetImageData, CDeskewedImageElement, api reference
+---
+
+# CDeskewedImageElement Class
+
+The CDeskewedImageElement class stores an intermediate result whose type is Deskewed image.
+
+## Definition
+
+*Namespace:* dynamsoft::ddn::intermediate_results
+
+*Assembly:* DynamsoftDocumentNormalizer
+
+```cpp
+class CDeskewedImageElement: public CRegionObjectElement
+```
+
+*Inheritance:* [CRegionObjectElement]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -> CDeskewedImageElement
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| [`SetImageData`](#setimagedata) | Sets the image data of the deskewed image element. |
+| [`GetSourceDeskewQuad`](#getsourcedeskewquad) | Gets the quadrilateral used for deskewing the image. |
+
+### SetImageData
+
+Sets the image data of the deskewed image element.
+
+```cpp
+virtual int SetImageData(const CImageData* imgData) = 0;
+```
+
+**Parameters**
+
+`imgData`  The image data to set.
+
+**Return Value**
+
+Returns 0 if succeeds, nonzero otherwise. 
+
+**See Also**
+
+* [CImageData]({{ site.dcv_cpp_api }}core/basic-structures/image-data.html)
+
+### GetSourceDeskewQuad
+
+Gets the quadrilateral used for deskewing the image.
+
+```cpp
+virtual CQuadrilateral GetSourceDeskewQuad() const = 0;
+```
+
+**Return Value**
+
+Returns A `CQuadrilateral` object representing the four corners of the quadrilateral used to deskew the image.

programming/cplusplus/api-reference/deskewed-image-result-item.md

@@ -0,0 +1,100 @@
+---
+layout: default-layout
+title: CDeskewedImageResultItem Class
+description: This page shows CDeskewedImageResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition.
+keywords: GetImageData, SaveToFile, CDeskewedImageResultItem, api reference
+---
+
+# CDeskewedImageResultItem Class
+
+The CDeskewedImageResultItem class stores a captured result item whose type is Deskewed image.
+
+## Definition
+
+*Namespace:* dynamsoft::ddn
+
+*Assembly:* DynamsoftDocumentNormalizer
+
+```cpp
+class CDeskewedImageResultItem: CCapturedResultItem
+```
+
+*Inheritance:* [CCapturedResultItem]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -> CDeskewedImageResultItem
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| [`GetImageData`](#getimagedata) | Gets the ImageData of current object. |
+| [`GetSourceDeskewQuad`](#getsourcedeskewquad)| Gets the quadrilateral used for deskewing the image. |
+| [`GetCrossVerificationStatus`](getcrossverificationstatus)| Gets the status of current object as a verified deskewed image. |
+| [`SetCrossVerificationStatus`](setcrossverificationstatus)| Sets the status of current object. |
+| [`GetOriginalToLocalMatrix`](getoriginaltolocalmatrix) | Gets the transformation matrix from the original image coordinate system to the local coordinate system. |
+
+### 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)
+
+### GetSourceDeskewQuad
+
+Gets the quadrilateral used for deskewing the image.
+
+```cpp
+virtual CQuadrilateral GetSourceDeskewQuad() const = 0;
+```
+
+**Return Value**
+
+A `CQuadrilateral` object representing the four corners of the quadrilateral used to deskew the image.
+
+**See Also**
+
+* [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html)
+
+### GetCrossVerificationStatus
+
+Gets the status of current object as a verified deskewed image.
+
+```cpp
+virtual CrossVerificationStatus GetCrossVerificationStatus() const = 0;
+```
+
+**Return Value**
+
+Return the CrossVerificationStatus of the deskewed image result.
+
+### SetCrossVerificationStatus
+
+Sets the status of current object.
+
+```cpp
+virtual void SetCrossVerificationStatus(CrossVerificationStatus status) = 0;
+```
+
+**Parameters**
+
+`[in] status` The CrossVerificationStatus to be set.
+
+### GetOriginalToLocalMatrix
+
+Gets the transformation matrix from the original image coordinate system to the local coordinate system.
+
+```cpp
+virtual void GetOriginalToLocalMatrix(double matrix[9]) const = 0;
+```
+
+**Parameters**
+
+`[out] matrix` matrix A double array of size 9, representing the 3x3 transformation matrix that converts coordinates from the original image to the local image.

programming/cplusplus/api-reference/deskewed-image-unit.md

@@ -0,0 +1,64 @@
+---
+layout: default-layout
+title: CDeskewedImagesUnit Class
+description: This page shows CDeskewedImagesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition.
+keywords: GetDeskewedImage, CDeskewedImagesUnit, api reference
+permalink: /programming/cplusplus/api-reference/Deskewed-image-unit.html
+---
+
+# CDeskewedImagesUnit Class
+
+The CDeskewedImagesUnit class represents an intermediate result unit whose type is Deskewed images.
+
+## Definition
+
+*Namespace:* dynamsoft::ddn::intermediate_results
+
+*Assembly:* DynamsoftDocumentNormalizer
+
+```cpp
+class CDeskewedImagesUnit: CIntermediateResultUnit
+```
+
+*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CDeskewedImagesUnit
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| [`GetDeskewedImage`](#getdeskewedimage) | Gets a DeskewedImage object from current object. |
+| [`SetDeskewedImage`](#setdeskewedimage) | Sets the Deskewed image. |
+
+### GetDeskewedImage
+
+Gets a DeskewedImage object from current unit.
+
+```cpp
+virtual const CDeskewedImageElement* GetDeskewedImage() const = 0;
+```
+
+**Return Value**
+
+Returns the `CDeskewedImageElement` object.
+
+**See Also**
+
+* [CDeskewedImageElement]({{ site.ddn_cpp_api }}deskewed-image-element.html)
+
+### SetDeskewedImage
+
+Sets the Deskewed image.
+
+```cpp
+virtual int SetDeskewedImage(const CDeskewedImageElement* element, const double matrixToOriginalImage[9] =  IDENTITY_MATRIX) = 0;
+```
+
+**Parameters**
+
+`[in] element` The Deskewed image to be set.
+
+`[in] matrixToOriginalImage` The matrix to original image.
+
+**Return value**
+
+Returns 0 if successful, otherwise returns a negative value.

programming/cplusplus/api-reference/detected-quad-element-v2.6.1000.md

@@ -0,0 +1,40 @@
+---
+layout: default-layout
+title: CDetectedQuadElement Class
+description: This page shows CDetectedQuadElement class definition of Dynamsoft Document Normalizer SDK C++ Edition.
+keywords: GetConfidenceAsDocumentBoundary, CDetectedQuadElement, api reference
+---
+
+# CDetectedQuadElement Class
+
+The CDetectedQuadElement class stores an intermediate result whose type is detected quad.
+
+## Definition
+
+*Namespace:* dynamsoft::ddn::intermediate_results
+
+*Assembly:* DynamsoftDocumentNormalizer
+
+```cpp
+class CDetectedQuadElement: CRegionObjectElement
+```
+
+*Inheritance:* [CRegionObjectElement]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -> CDetectedQuadElement
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| [`GetConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence as document boundary of current object. |
+
+### GetConfidenceAsDocumentBoundary
+
+Gets the confidence as document boundary of current object.
+
+```cpp
+int GetConfidenceAsDocumentBoundary() 
+```
+
+**Return Value**
+
+The confidence as document boundary of current object.

programming/cplusplus/api-reference/detected-quad-element.md

@@ -3,7 +3,6 @@ layout: default-layout
 title: CDetectedQuadElement Class
 description: This page shows CDetectedQuadElement class definition of Dynamsoft Document Normalizer SDK C++ Edition.
 keywords: GetConfidenceAsDocumentBoundary, CDetectedQuadElement, api reference
-permalink: /programming/cplusplus/api-reference/detected-quad-element.html
 ---
 
 # CDetectedQuadElement Class
@@ -27,6 +26,7 @@ class CDetectedQuadElement: CRegionObjectElement
 | Method | Description |
 |--------|-------------|
 | [`GetConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence as document boundary of current object. |
+| [`SetLocation`](#setlocation) | Sets the location of the detected quad element. |
 
 ### GetConfidenceAsDocumentBoundary
 
@@ -39,3 +39,19 @@ int GetConfidenceAsDocumentBoundary()
 **Return Value**
 
 The confidence as document boundary of current object.
+
+### SetLocation
+
+Sets the location of the detected quad element.
+
+```cpp
+virtual int SetLocation(const CQuadrilateral& location) = 0;
+```
+
+**Parameters**
+
+`location` The location of the detected quad element.
+
+**Return Value**
+
+Returns 0 if success, otherwise an error code.

programming/cplusplus/api-reference/document-normalizer-module-v2.6.1000.md

@@ -0,0 +1,79 @@
+---
+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
+---
+
+# 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. |
+| [CreateNormalizedImageElement](#createnormalizedimageelement) | Create a Normalized Image Element object.              |
+| [CreateDetectedQuadElement](#createdetectedquadelement)       | Create a Detected Quad Element object.                 |
+
+## 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.
+
+## CreateNormalizedImageElement
+
+Create a Normalized Image Element object.
+
+```cpp
+static intermediate_results::CNormalizedImageElement* CreateNormalizedImageElement();
+```
+
+**Parameters**
+
+None.
+
+**Return Value**
+
+Returns an instance of CNormalizedImageElement.
+
+## CreateDetectedQuadElement
+
+Create a Detected Quad Element object.
+
+```cpp
+static intermediate_results::CDetectedQuadElement* CreateDetectedQuadElement();
+```
+
+**Parameters**
+
+None.
+
+**Return Value**
+
+Returns an instance of CDetectedQuadElement.