Skip to content

Commit ca83b28

Browse files
DMGithubPublisherDMGithubPublisher
committed
update to internal commit 19642a2e
1 parent 3c221c1 commit ca83b28

18 files changed

+2151
-51
lines changed

‎programming/android/api-reference/deskewed-image-element.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: DeskewedImageElement - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class DeskewedImageElement represents an intermediate result whose type is deskewed image, It is inherited from RegionObjectElement and contains image data of deskewed result as additional parameter.
5+
keywords: deskewed image element, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# DeskewedImageElement
12+
13+
The `DeskewedImageElement` class represents an intermediate result whose type is deskewed image. It is inherited from `RegionObjectElement` and contains image data of deskewed result as an additional parameter.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn.intermediate_results
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class DeskewedImageElement extends RegionObjectElement
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`setImageData`](#getimagedata) | Sets the image data of the deskewed image with a `DSImageData` object. |
30+
| [`getSourceDeskewQuad`](#sourcedeskewquad) | Returns the quadrilateral from which you get the deskewed image result item. |
31+
32+
The following methods are inherited from class [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html).
33+
34+
{%- include api-reference/region-object-element-android.md -%}
35+
36+
### setImageData
37+
38+
Gets an [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object as the deskewed image.
39+
40+
```java
41+
void setImageData(ImageData imageData);
42+
```
43+
44+
**Parameters**
45+
46+
`imageData`: A [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object that represents the deskewed image.
47+
48+
### getSourceDeskewQuad
49+
50+
Returns the quadrilateral from which you get the deskewed image result item.
51+
52+
```java
53+
Quadrilateral getSourceDeskewQuad();
54+
```
55+
56+
**Return Value**
57+
58+
The quadrilateral from which you get the deskewed image result item.

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

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
layout: default-layout
3+
title: DeskewedImageResultItem - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class DeskewedImageResultItem represents a captured result item whose type is a deskewed image. It stores the deskewed image information.
5+
keywords: deskewed image result item, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# DeskewedImageResultItem
12+
13+
The `DeskewedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) that represents a deskewed image. This is the most basic unit of the deskewed 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 DeskewedImageResultItem extends CapturedResultItem
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`getImageData`](#getimagedata) | Returns an `ImageData` object as the deskewed image. |
30+
| [`getSourceDeskewQuad`](#getlocation) | Returns the quadrilateral from which you get the deskewed image result item. |
31+
| [`getCrossVerificationStatus`](#getcrossverificationstatus) | Returns the cross verification status of the result item. |
32+
| [`getOriginalToLocalMatrix`](#getoriginaltolocalmatrix) | Returns the transformation matrix from the original image coordinate system to the local coordinate system. |
33+
34+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
35+
36+
| Method | Description |
37+
| ------ | ----------- |
38+
| [`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. |
39+
| [`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. |
40+
| [`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. |
41+
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | Returns the name of the task that generated the result. |
42+
43+
### getImageData
44+
45+
Returns an [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object for the deskewed image.
46+
47+
```java
48+
ImageData getImageData();
49+
```
50+
51+
**Return Value**
52+
53+
The `ImageData` object as the deskewed image.
54+
55+
### getSourceDeskewQuad
56+
57+
Returns the soure [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that used to deskew the image.
58+
59+
```java
60+
Quadrilateral getLocation();
61+
```
62+
63+
**Return Value**
64+
65+
The soure [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that used to deskew the image.
66+
67+
### getCrossVerificationStatus
68+
69+
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`.
70+
71+
```java
72+
EnumCrossVerificationStatus getCrossVerificationStatus();
73+
```
74+
75+
**Return Value**
76+
77+
Returns the cross verification status of type [`EnumCrossVerificationStatus`]({{ site.dcv_enumerations }}core/cross-verification-status.html).
78+
79+
### getOriginalToLocalMatrix
80+
81+
Returns the transformation matrix from the original image coordinate system to the local coordinate system.
82+
83+
```java
84+
Matrix getOriginalToLocalMatrix();
85+
```
86+
87+
**Return Value**
88+
89+
The transformation matrix of type `android.graphics.Matrix`.

‎programming/android/api-reference/deskewed-image-unit.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
layout: default-layout
3+
title: DeskewedImagesUnit - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class DeskewedImagesUnit represents an intermediate result unit whose type is deskewed images.
5+
keywords: deskewed images, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# DeskewedImagesUnit
12+
13+
The `DeskewedImagesUnit` class represents an intermediate result unit whose type is deskewed images.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn.intermediate_results
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class DeskewedImagesUnit extends IntermediateResultUnit
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`getDeskewedImage`](#getdeskewedimage) | Gets the deskewed image of type [`DeskewedImageElement`](deskewed-image-element.md). |
30+
| [`setDeskewedImage`](#setdeskewedimage) | Sets the deskewed image with a [`DeskewedImageElement`](deskewed-image-element.md) object |
31+
32+
The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
33+
34+
{%- include api-reference/intermediate-result-unit-android.md -%}
35+
36+
### getDeskewedImage
37+
38+
Gets a deskewed image.
39+
40+
```java
41+
DeskewedImageElement getDeskewedImage();
42+
```
43+
44+
**Return Value**
45+
46+
A [`DeskewedImageElement`](deskewed-image-element.md) object that represents the deskewed image.
47+
48+
### setDeskewedImage
49+
50+
Sets a [`DeskewedImageElement`](deskewed-image-element.md) as the deskewed image.
51+
52+
```java
53+
void setDeskewedImage(DeskewedImageElement element, Matrix matrixToOriginalImage);
54+
```
55+
56+
**Parameters**
57+
58+
`[in] element`: The deskewed image to be set.
59+
60+
`[in] matrixToOriginalImage`: The matrix to the original image.

‎programming/android/api-reference/enhanced-image-element.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: default-layout
3+
title: EnhancedImageElement - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class EnhancedImageElement represents an intermediate result whose type is enhanced image, It is inherited from RegionObjectElement and contains image data of enhanced result as additional parameter.
5+
keywords: enhanced image element, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# EnhancedImageElement
12+
13+
The `EnhancedImageElement` class represents an intermediate result whose type is enhanced image. It is inherited from `RegionObjectElement` and contains image data of enhanced result as an additional parameter.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn.intermediate_results
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class EnhancedImageElement extends RegionObjectElement
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`setImageData`](#getimagedata) | Sets the image data of the deskewed image with a `DSImageData` object. |
30+
31+
The following methods are inherited from class [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html).
32+
33+
{%- include api-reference/region-object-element-android.md -%}
34+
35+
### setImageData
36+
37+
Gets an [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object as the enhanced image.
38+
39+
```java
40+
void setImageData(ImageData imageData);
41+
```
42+
43+
**Parameters**
44+
45+
`imageData`: A [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object that represents the enhanced image.

‎programming/android/api-reference/enhanced-image-result-item.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: EnhancedImageResultItem - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class EnhancedImageResultItem represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
5+
keywords: enhanced image result item, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# EnhancedImageResultItem
12+
13+
The `EnhancedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) that represents a enhanced image. This is the most basic unit of the enhanced 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 EnhancedImageResultItem extends CapturedResultItem
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`getImageData`](#getimagedata) | Returns an `ImageData` object as the enhanced image. |
30+
| [`getOriginalToLocalMatrix`](#getoriginaltolocalmatrix) | Returns the transformation matrix from the original image coordinate system to the local coordinate system. |
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) | Returns 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) | Returns 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) | Returns 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) | Returns 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 enhanced image.
44+
45+
```java
46+
ImageData getImageData();
47+
```
48+
49+
**Return Value**
50+
51+
The `ImageData` object as the enhanced image.
52+
53+
### getOriginalToLocalMatrix
54+
55+
Returns the transformation matrix from the original image coordinate system to the local coordinate system.
56+
57+
```java
58+
Matrix getOriginalToLocalMatrix();
59+
```
60+
61+
**Return Value**
62+
63+
The transformation matrix of type `android.graphics.Matrix`.

‎programming/android/api-reference/enhanced-image-unit.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: EnhancedImagesUnit - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class EnhancedImagesUnit represents an intermediate result unit whose type is enhanced images.
5+
keywords: enhanced images, java, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# EnhancedImagesUnit
12+
13+
The `EnhancedImagesUnit` class represents an intermediate result unit whose type is enhanced images.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn.intermediate_results
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class EnhancedImagesUnit extends IntermediateResultUnit
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`getEnhancedImage`](#getenhancedimage) | Gets the enhanced image of type [`EnhancedImageElement`](enhanced-image-element.md). |
30+
| [`setEnhancedImage`](#setenhancedimage) | Sets the enhanced image with a [`EnhancedImageElement`](enhanced-image-element.md) object |
31+
32+
The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
33+
34+
{%- include api-reference/intermediate-result-unit-android.md -%}
35+
36+
### getEnhancedImage
37+
38+
Gets a enhanced image.
39+
40+
```java
41+
EnhancedImageElement getEnhancedImage();
42+
```
43+
44+
**Return Value**
45+
46+
A [`EnhancedImageElement`](enhanced-image-element.md) object that represents the enhanced image.
47+
48+
### setEnhancedImage
49+
50+
Sets a [`EnhancedImageElement`](enhanced-image-element.md) as the enhanced image.
51+
52+
```java
53+
void setEnhancedImage(EnhancedImageElement element);
54+
```
55+
56+
**Parameters**
57+
58+
`[in] element`: The enhanced image to be set.

0 commit comments

Comments
 (0)