Skip to content

Commit cf3cf8e

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #38 from dynamsoft-docs/preview
update to internal commit d894538a
2 parents 3f458c1 + 7343182 commit cf3cf8e

7 files changed

+487
-6
lines changed

‎programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: default-layout
3+
title: CDetectedQuadResultItem Class
4+
description: This page shows CDetectedQuadResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition.
5+
keywords: GetLocation, GetConfidenceAsDocumentBoundary, GetRotationTransformMatrix, CDetectedQuadResultItem, api reference
6+
permalink: /programming/cplusplus/api-reference/detected-quad-result-item-v2.4.2200.html
7+
---
8+
9+
# CDetectedQuadResultItem Class
10+
11+
The CDetectedQuadResultItem class stores a captured result whose type is detected quad.
12+
13+
## Definition
14+
15+
*Namespace:* dynamsoft::ddn
16+
17+
*Assembly:* DynamsoftDocumentNormalizer
18+
19+
```cpp
20+
class CDetectedQuadResultItem: CCapturedResultItem
21+
```
22+
23+
*Inheritance:* [CCapturedResultItem]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -> CDetectedQuadResultItem
24+
25+
## Methods
26+
27+
| Method | Description |
28+
|--------|-------------|
29+
| [`GetLocation`](#getlocation) | Gets the location of current object. |
30+
| [`GetConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence of current object as a document boundary. |
31+
32+
### GetLocation
33+
34+
Gets the location of current object.
35+
36+
```cpp
37+
const CQuadrilateral GetLocation()
38+
```
39+
40+
**Return Value**
41+
42+
The location of current object.
43+
44+
**See Also**
45+
46+
* [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html)
47+
48+
### GetConfidenceAsDocumentBoundary
49+
50+
Gets the confidence of current object as a document boundary.
51+
52+
```cpp
53+
int GetConfidenceAsDocumentBoundary()
54+
```
55+
56+
**Return Value**
57+
58+
The confidence as document boundary of the detected quad result.

‎programming/cplusplus/api-reference/detected-quad-result-item.md‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@ layout: default-layout
33
title: CDetectedQuadResultItem Class
44
description: This page shows CDetectedQuadResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition.
55
keywords: GetLocation, GetConfidenceAsDocumentBoundary, GetRotationTransformMatrix, CDetectedQuadResultItem, api reference
6-
permalink: /programming/cplusplus/api-reference/detected-quad-result-item.html
76
---
87

98
# CDetectedQuadResultItem Class
109

11-
The CDetectedQuadResultItem class stores a captured result whose type is detected quad.
10+
The `CDetectedQuadResultItem` class stores a captured result whose type is detected quad.
1211

1312
## Definition
1413

@@ -28,6 +27,7 @@ class CDetectedQuadResultItem: CCapturedResultItem
2827
|--------|-------------|
2928
| [`GetLocation`](#getlocation) | Gets the location of current object. |
3029
| [`GetConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence of current object as a document boundary. |
30+
| [`GetCrossVerificationStatus`](#getcrossverificationstatus) | Gets the status of current object as a verified document boundary. |
3131
3232
### GetLocation
3333
@@ -56,3 +56,19 @@ int GetConfidenceAsDocumentBoundary()
5656
**Return Value**
5757

5858
The confidence as document boundary of the detected quad result.
59+
60+
### GetCrossVerificationStatus
61+
62+
Gets the status of current object as a verified document boundary.
63+
64+
```cpp
65+
virtual CrossVerificationStatus GetCrossVerificationStatus() const = 0;
66+
```
67+
68+
**Return Value**
69+
70+
The `CrossVerificationStatus` of the detected quad result.
71+
72+
**See Also**
73+
74+
* [CrossVerificationStatus]({{ site.dcv_enumerations }}core/cross-verification-status.html?lang=cpp)

‎programming/cplusplus/api-reference/logic-lines-unit.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
layout: default-layout
3+
title: CLogicLinesUnit Class
4+
description: This page shows CLogicLinesUnit class definition of Dynamsoft Document Normalizer SDK C++ Edition.
5+
keywords: GetCount, GetLogicLine, CLogicLinesUnit, api reference
6+
permalink: /programming/cplusplus/api-reference/logic-lines-unit.html
7+
---
8+
9+
# CLogicLinesUnit Class
10+
11+
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.
12+
13+
## Definition
14+
15+
*Namespace:* dynamsoft::ddn::intermediate_results
16+
17+
*Assembly:* DynamsoftDocumentNormalizer
18+
19+
```cpp
20+
class CLogicLinesUnit: CIntermediateResultUnit
21+
```
22+
23+
*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLogicLinesUnit
24+
25+
## Methods
26+
27+
| Method | Description |
28+
|--------|-------------|
29+
| [`GetCount`](#getcount) | Gets the count of LogicLine objects in current object.|
30+
| [`GetLogicLine`](#getlogicline) | Gets a LogicLine object from current object by specifying a index. |
31+
| [`RemoveAllLogicLines`](#removealllogiclines) | Removes all the LogicLines in current object. |
32+
| [`RemoveLogicLine`](#removelogicline) | Removes a LogicLine from current object by specifying an index. |
33+
| [`AddLogicLine`](#addlogicline) | Adds a LogicLine to current object. |
34+
| [`SetLogicLine`](#setlogicline) | Sets the LogicLine at the specified index. |
35+
36+
### GetCount
37+
38+
Gets the count of LogicLine objects in current object.
39+
40+
```cpp
41+
int GetCount()
42+
```
43+
44+
**Return Value**
45+
46+
The count of LogicLine objects in current object.
47+
48+
### GetLogicLine
49+
50+
Gets a LogicLine object from current object by specifying a index.
51+
52+
```cpp
53+
const CLineSegment* GetLogicLine(int index) const = 0;
54+
```
55+
56+
**Parameters**
57+
58+
`[in] index` The index of the LogicLine object.
59+
60+
**Return Value**
61+
62+
Returns the LogicLine object.
63+
64+
**See Also**
65+
66+
* [CLineSegment]({{ site.dcv_cpp_api }}core/basic-structures/line-segment.html)
67+
* [ErrorCode]({{ site.dcv_enumerations }}core/error-code.html?src=cpp&&lang=cpp)
68+
69+
### RemoveAllLogicLines
70+
71+
Removes all the LogicLines in current object.
72+
73+
```cpp
74+
virtual void RemoveAllLogicLines() = 0
75+
```
76+
77+
### RemoveLogicLine
78+
79+
Removes a LogicLine from current object by specifying an index.
80+
81+
```cpp
82+
virtual int RemoveLogicLine(int index) = 0
83+
```
84+
85+
**Parameters**
86+
87+
`[in] index` The index of the LogicLine to be removed.
88+
89+
**Return Value**
90+
91+
Returns 0 if successful, otherwise returns a negative value.
92+
93+
### AddLogicLine
94+
95+
Adds a LogicLine to current object.
96+
97+
```cpp
98+
virtual int AddLogicLine(const CLineSegment& logicline, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0
99+
```
100+
101+
**Parameters**
102+
103+
`[in] line` The LogicLine to be added.
104+
105+
`[in] matrixToOriginalImage` The matrix to the original image.
106+
107+
**Return Value**
108+
109+
Returns 0 if successful, otherwise returns a negative value.
110+
111+
### SetLogicLine
112+
113+
Sets the LogicLine at the specified index.
114+
115+
```cpp
116+
virtual int SetLogicLine(int index, const CLineSegment& logicline, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
117+
```
118+
119+
**Parameters**
120+
121+
`[in] index` The index of the LogicLine to be set.
122+
123+
`[in] line` The LogicLine to be added.
124+
125+
`[in] matrixToOriginalImage` The matrix to the original image.
126+
127+
**Return Value**
128+
129+
Returns 0 if successful, otherwise returns a negative value.

‎programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
layout: default-layout
3+
title: CNormalizedImageResultItem Class
4+
description: This page shows CNormalizedImageResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition.
5+
keywords: GetImageData, SaveToFile, CNormalizedImageResultItem, api reference
6+
permalink: /programming/cplusplus/api-reference/normalized-image-result-item-v2.4.2000.html
7+
---
8+
9+
# CNormalizedImageResultItem Class
10+
11+
The CNormalizedImageResultItem class stores a captured result item whose type is normalized image.
12+
13+
## Definition
14+
15+
*Namespace:* dynamsoft::ddn
16+
17+
*Assembly:* DynamsoftDocumentNormalizer
18+
19+
```cpp
20+
class CNormalizedImageResultItem: CCapturedResultItem
21+
```
22+
23+
*Inheritance:* [CCapturedResultItem]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -> CNormalizedImageResultItem
24+
25+
## Methods
26+
27+
| Method | Description |
28+
|--------|-------------|
29+
| [`GetImageData`](#getimagedata) | Gets the ImageData of current object. |
30+
| [`GetLocation`](#getlocation) | Get the quadrilateral from which you get the normalized image result item. |
31+
32+
### GetImageData
33+
34+
Gets the ImageData of current object.
35+
36+
```cpp
37+
const CImageData* GetImageData()
38+
```
39+
40+
**Return Value**
41+
42+
The image data.
43+
44+
**See Also**
45+
46+
* [CImageData]({{ site.dcv_cpp_api }}core/basic-structures/image-data.html)
47+
48+
### GetLocation
49+
50+
Gets the location of current object.
51+
52+
```cpp
53+
const CQuadrilateral GetLocation()
54+
```
55+
56+
**Return Value**
57+
58+
The location of current object.
59+
60+
**See Also**
61+
62+
* [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html)
63+

‎programming/cplusplus/api-reference/normalized-image-result-item.md‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@ layout: default-layout
33
title: CNormalizedImageResultItem Class
44
description: This page shows CNormalizedImageResultItem class definition of Dynamsoft Document Normalizer SDK C++ Edition.
55
keywords: GetImageData, SaveToFile, CNormalizedImageResultItem, api reference
6-
permalink: /programming/cplusplus/api-reference/normalized-image-result-item.html
76
---
87

98
# CNormalizedImageResultItem Class
109

11-
The CNormalizedImageResultItem class stores a captured result item whose type is normalized image.
10+
The `CNormalizedImageResultItem` class stores a captured result item whose type is normalized image.
1211

1312
## Definition
1413

@@ -28,6 +27,7 @@ class CNormalizedImageResultItem: CCapturedResultItem
2827
|--------|-------------|
2928
| [`GetImageData`](#getimagedata) | Gets the ImageData of current object. |
3029
| [`GetLocation`](#getlocation) | Get the quadrilateral from which you get the normalized image result item. |
30+
| [`GetCrossVerificationStatus`](#getcrossverificationstatus) | Gets the status of current object as a verified normalized image. |
3131
3232
### GetImageData
3333
@@ -61,3 +61,18 @@ The location of current object.
6161

6262
* [CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html)
6363

64+
### GetCrossVerificationStatus
65+
66+
Gets the status of current object as a verified normalized image.
67+
68+
```cpp
69+
virtual CrossVerificationStatus GetCrossVerificationStatus() const = 0
70+
```
71+
72+
**Return Value**
73+
74+
The `CrossVerificationStatus` of the normalized image result.
75+
76+
**See Also**
77+
78+
* [CrossVerificationStatus]({{ site.dcv_enumerations }}core/cross-verification-status.html?lang=cpp)

0 commit comments

Comments
 (0)