Skip to content

Commit 007e235

Browse files
Dynamsoft-JersonDynamsoft-Jerson
authored
Merge pull request #60 from dynamsoft-docs/preview
update to internal commit 4a1984b8
2 parents dcd1c87 + 4e0a8f2 commit 007e235

16 files changed

+1828
-117
lines changed

‎programming/android/api-reference/detected-quad-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: DetectedQuadResultItem - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class DetectedQuadResultItem represents a captured result item whose type is detected quads, which contains the location and confidence as a document boundary.
5+
keywords: detected quads, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# DetectedQuadResultItem
12+
13+
The `DetectedQuadResultItem` class is an extension of the [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) that represents a detected quadrilateral. This is the most basic unit of a detected quadrilateral, one of the captured result types that the Capture Vision Router can output.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class DetectedQuadResultItem extends CapturedResultItem
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ------- | ----------- |
29+
| [`getLocation`](#getlocation) | Get a Quadrilateral object as the location of current object. |
30+
| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
31+
32+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
33+
34+
| Method | Description |
35+
| ------ | ----------- |
36+
| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Get the type of the captured result item, indicating what kind of data it represents. |
37+
| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Get a property of type `CapturedResultItem` that represents a reference to another captured result item. |
38+
| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/){:target="_blank"} object which includes a task that generated the result. |
39+
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | The name of the task that generated the result. |
40+
41+
### getLocation
42+
43+
Returns a [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
44+
45+
```java
46+
Quadrilateral getLocation();
47+
```
48+
49+
**Return Value**
50+
51+
The location of current object.
52+
53+
### getConfidenceAsDocumentBoundary
54+
55+
Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
56+
57+
```java
58+
int getConfidenceAsDocumentBoundary();
59+
```
60+
61+
**Return Value**
62+
63+
The confidence as document boundary of current object.

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

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,18 @@ class DetectedQuadResultItem extends CapturedResultItem
2626

2727
| Methods | Description |
2828
| ------- | ----------- |
29-
| [`getLocation`](#getlocation) | Get a Quadrilateral object as the location of current object. |
29+
| [`getLocation`](#getlocation) | Returns a Quadrilateral object as the location of current object. |
3030
| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
31+
| [`getCrossVerificationStatus`](#getcrossverificationstatus) | Returns the cross verification status of the result item. |
3132

3233
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
3334

3435
| Method | Description |
3536
| ------ | ----------- |
36-
| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Get the type of the captured result item, indicating what kind of data it represents. |
37-
| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Get a property of type `CapturedResultItem` that represents a reference to another captured result item. |
38-
| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/){:target="_blank"} object which includes a task that generated the result. |
39-
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | The name of the task that generated the result. |
37+
| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Returns the type of the captured result item, indicating what kind of data it represents. |
38+
| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Returns a property of type `CapturedResultItem` that represents a reference to another captured result item. |
39+
| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Returns the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/){:target="_blank"} object which includes a task that generated the result. |
40+
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | Returns the name of the task that generated the result. |
4041

4142
### getLocation
4243

@@ -61,3 +62,15 @@ int getConfidenceAsDocumentBoundary();
6162
**Return Value**
6263

6364
The confidence as document boundary of current object.
65+
66+
### getCrossVerificationStatus
67+
68+
Returns the cross verification status of the result. The cross verification status determines whether the result item is approved by the multi-frame cross verification mechanism. If approved, the cross verification status is `CVS_PASSED`. Otherwise, it is `CVS_FAILED`.
69+
70+
```java
71+
EnumCrossVerificationStatus getCrossVerificationStatus();
72+
```
73+
74+
**Return Value**
75+
76+
Returns the cross verification status of type [`EnumCrossVerificationStatus`]({{ site.dcv_enumerations }}core/cross-verification-status.html).

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

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
layout: default-layout
3+
title: LogicLinesUnit - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class LogicLinesUnit of DDN Android represents an intermediate result unit containing logic lines. It inherits from the IntermediateResultUnit class.
5+
keywords: logic lines, intermediate result unit, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# LogicLinesUnit
12+
13+
The `LogicLinesUnit` class represents an intermediate result unit containing logic lines. It inherits from the `IntermediateResultUnit` class.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn.intermediate_results
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class LogicLinesUnit extends IntermediateResultUnit
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`getLogicLines`](#getlogiclines) | Get an array of [`LineSegment`]({{site.dcv_android_api}}core/basic-structures/line-segment.html) as the logic lines. |
30+
| [`getCount`](#getcount) | Get the number of logic lines. |
31+
| [`getLogicLine`](#getlogicline) | Get a logic line. |
32+
| [`removeAllLogicLines`](#removealllogiclines) | Remove all logic lines. |
33+
| [`removeLogicLine`](#removelogicline) | Remove a logic line. |
34+
| [`addLogicLine`](#addlogicline) | Add a logic line. |
35+
| [`setLogicLine`](#setlogicline) | Set a logic line. |
36+
37+
### getLogicLines
38+
39+
Get an array of `LineSegment` as the logic lines.
40+
41+
```java
42+
LineSegment[] getLogicLines();
43+
```
44+
45+
**Return Value**
46+
47+
Returns an array of `LineSegment` as the logic lines.
48+
49+
### getCount
50+
51+
Gets the number of logic lines in the unit.
52+
53+
```java
54+
int getCount();
55+
```
56+
57+
**Return Value**
58+
59+
Returns the number of logic lines in the unit.
60+
61+
### getLogicLine
62+
63+
Gets a logic line at the specified index.
64+
65+
```java
66+
LineSegment getLogicLine(int index);
67+
```
68+
69+
**Parameters**
70+
71+
`index` The index of the logic line.
72+
73+
**Return Value**
74+
75+
Returns a reference to the `LineSegment` object at the specified index.
76+
77+
### removeAllLogicLines
78+
79+
Removes all logic lines.
80+
81+
```java
82+
void removeAllLogicLines();
83+
```
84+
85+
### removeLogicLine
86+
87+
Removes the logic line at the specified index.
88+
89+
```java
90+
int removeLogicLine(int index);
91+
```
92+
93+
**Parameters**
94+
95+
`index` The index of the logic line to remove.
96+
97+
**Return Value**
98+
99+
Returns 0 if successful, otherwise returns a negative value.
100+
101+
### addLogicLine
102+
103+
Adds a logic line.
104+
105+
```java
106+
int addLogicLine(LineSegment logicLine, Matrix matrixToOriginalImage);
107+
```
108+
109+
**Parameters**
110+
111+
`logicLine` The logic line to add.
112+
113+
`matrixToOriginalImage` The matrix to the original image (3x3 matrix).
114+
115+
**Return Value**
116+
Returns 0 if successful, otherwise returns a negative value.
117+
118+
### setLogicLine
119+
120+
Sets the logic line at the specified index.
121+
122+
```java
123+
int setLogicLine(int index, LineSegment logicLine, Matrix matrixToOriginalImage);
124+
```
125+
126+
**Parameters**
127+
128+
`index` The index of the logic line to set.
129+
130+
`logicLine` The logic line to set.
131+
132+
`matrixToOriginalImage` The matrix to the original image (3x3 matrix).
133+
134+
**Return Value**
135+
136+
Returns 0 if successful, otherwise returns a negative value.

‎programming/android/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: NormalizedImageResultItem - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class NormalizedImageResultItem represents a captured result item whose type is a normalized image. It stores the normalized image information.
5+
keywords: normalized image result item, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# NormalizedImageResultItem
12+
13+
The `NormalizedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) that represents a normalized image. This is the most basic unit of the normalized image result, one of the captured result types that the Capture Vision Router can output.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class NormalizedImageResultItem extends CapturedResultItem
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`getImageData`](#getimagedata) | Gets an `ImageData` object as the normalized image. |
30+
| [`getLocation`](#getlocation) | The quadrilateral from which you get the normalized image result item. |
31+
32+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
33+
34+
| Method | Description |
35+
| ------ | ----------- |
36+
| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Get the type of the captured result item, indicating what kind of data it represents. |
37+
| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Get a property of type `CapturedResultItem` that represents a reference to another captured result item. |
38+
| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
39+
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | The name of the task that generated the result. |
40+
41+
### getImageData
42+
43+
Returns an [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object for the normalized image.
44+
45+
```java
46+
ImageData getImageData();
47+
```
48+
49+
**Return Value**
50+
51+
The `ImageData` object as the normalized image.
52+
53+
### getLocation
54+
55+
Returns the [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that represents the location of the normalized image within the original image or frame.
56+
57+
```java
58+
Quadrilateral getLocation();
59+
```
60+
61+
**Return Value**
62+
63+
The quadrilateral from which you get the normalized image result item.

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,18 @@ class NormalizedImageResultItem extends CapturedResultItem
2626

2727
| Methods | Description |
2828
| ---------- | ----------- |
29-
| [`getImageData`](#getimagedata) | Gets an `ImageData` object as the normalized image. |
30-
| [`getLocation`](#getlocation) | The quadrilateral from which you get the normalized image result item. |
29+
| [`getImageData`](#getimagedata) | Returns an `ImageData` object as the normalized image. |
30+
| [`getLocation`](#getlocation) | Returns the quadrilateral from which you get the normalized image result item. |
31+
| [`getCrossVerificationStatus`](#getcrossverificationstatus) | Returns the cross verification status of the result item. |
3132

3233
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
3334

3435
| Method | Description |
3536
| ------ | ----------- |
36-
| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Get the type of the captured result item, indicating what kind of data it represents. |
37-
| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Get a property of type `CapturedResultItem` that represents a reference to another captured result item. |
38-
| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
39-
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | The name of the task that generated the result. |
37+
| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Returns the type of the captured result item, indicating what kind of data it represents. |
38+
| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Returns a property of type `CapturedResultItem` that represents a reference to another captured result item. |
39+
| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Returns the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
40+
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | Returns the name of the task that generated the result. |
4041

4142
### getImageData
4243

@@ -61,3 +62,15 @@ Quadrilateral getLocation();
6162
**Return Value**
6263

6364
The quadrilateral from which you get the normalized image result item.
65+
66+
### getCrossVerificationStatus
67+
68+
Returns the cross verification status of the result item. The cross verification status determines whether the result item is approved by the multi-frame cross verification mechanism. If approved, the cross verification status is `CVS_PASSED`. Otherwise, it is `CVS_FAILED`.
69+
70+
```java
71+
EnumCrossVerificationStatus getCrossVerificationStatus();
72+
```
73+
74+
**Return Value**
75+
76+
Returns the cross verification status of type [`EnumCrossVerificationStatus`]({{ site.dcv_enumerations }}core/cross-verification-status.html).

‎programming/android/api-reference/simplified-document-normalizer-settings.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class SimplifiedDocumentNormalizerSettings
3434
| [`contrast`](#contrast) | *int* | The contrast. |
3535
| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. |
3636
| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. |
37-
| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | The minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages). |
37+
| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages). |
3838
| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | The number of documents expected to be detected. |
3939

4040
| Methods | Description |
@@ -112,7 +112,7 @@ int scaleDownThreshold;
112112

113113
### minQuadrilateralAreaRatio
114114

115-
The minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages).
115+
The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages).
116116

117117
```java
118118
@IntRange(from = 0, to = 100)

0 commit comments

Comments
 (0)