Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `CandidateQuadEdgesUnit` class represents an intermediate result unit whose

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class CandidateQuadEdgesUnit extends IntermediateResultUnit
Expand Down
2 changes: 1 addition & 1 deletion programming/android/api-reference/corners-unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `CornersUnit` class represents an intermediate result unit whose type is cor

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class CornersUnit extends IntermediateResultUnit
Expand Down
58 changes: 58 additions & 0 deletions programming/android/api-reference/deskewed-image-element.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: default-layout
title: DeskewedImageElement - Dynamsoft Document Normalizer Android SDK API Reference
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.
keywords: deskewed image element, java, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# DeskewedImageElement

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.

## Definition

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DeskewedImageElement extends RegionObjectElement
```

## Methods

| Methods | Description |
| ---------- | ----------- |
| [`setImageData`](#getimagedata) | Sets the image data of the deskewed image with a `DSImageData` object. |
| [`getSourceDeskewQuad`](#sourcedeskewquad) | Returns the quadrilateral from which you get the deskewed image result item. |

The following methods are inherited from class [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html).

{%- include api-reference/region-object-element-android.md -%}

### setImageData

Gets an [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object as the deskewed image.

```java
void setImageData(ImageData imageData);
```

**Parameters**

`imageData`: A [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object that represents the deskewed image.

### getSourceDeskewQuad

Returns the quadrilateral from which you get the deskewed image result item.

```java
Quadrilateral getSourceDeskewQuad();
```

**Return Value**

The quadrilateral from which you get the deskewed image result item.
89 changes: 89 additions & 0 deletions programming/android/api-reference/deskewed-image-result-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
layout: default-layout
title: DeskewedImageResultItem - Dynamsoft Document Normalizer Android SDK API Reference
description: The class DeskewedImageResultItem represents a captured result item whose type is a deskewed image. It stores the deskewed image information.
keywords: deskewed image result item, java, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# DeskewedImageResultItem

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.

## Definition

*Namespace:* com.dynamsoft.ddn

*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DeskewedImageResultItem extends CapturedResultItem
```

## Methods

| Methods | Description |
| ---------- | ----------- |
| [`getImageData`](#getimagedata) | Returns an `ImageData` object as the deskewed image. |
| [`getSourceDeskewQuad`](#getlocation) | Returns the quadrilateral from which you get the deskewed image result item. |
| [`getCrossVerificationStatus`](#getcrossverificationstatus) | Returns the cross verification status of the result item. |
| [`getOriginalToLocalMatrix`](#getoriginaltolocalmatrix) | Returns the transformation matrix from the original image coordinate system to the local coordinate system. |

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

| Method | Description |
| ------ | ----------- |
| [`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. |
| [`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. |
| [`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. |
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | Returns the name of the task that generated the result. |

### getImageData

Returns an [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object for the deskewed image.

```java
ImageData getImageData();
```

**Return Value**

The `ImageData` object as the deskewed image.

### getSourceDeskewQuad

Returns the soure [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that used to deskew the image.

```java
Quadrilateral getLocation();
```

**Return Value**

The soure [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that used to deskew the image.

### getCrossVerificationStatus

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`.

```java
EnumCrossVerificationStatus getCrossVerificationStatus();
```

**Return Value**

Returns the cross verification status of type [`EnumCrossVerificationStatus`]({{ site.dcv_enumerations }}core/cross-verification-status.html).

### getOriginalToLocalMatrix

Returns the transformation matrix from the original image coordinate system to the local coordinate system.

```java
Matrix getOriginalToLocalMatrix();
```

**Return Value**

The transformation matrix of type `android.graphics.Matrix`.
60 changes: 60 additions & 0 deletions programming/android/api-reference/deskewed-image-unit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
layout: default-layout
title: DeskewedImagesUnit - Dynamsoft Document Normalizer Android SDK API Reference
description: The class DeskewedImagesUnit represents an intermediate result unit whose type is deskewed images.
keywords: deskewed images, java, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# DeskewedImagesUnit

The `DeskewedImagesUnit` class represents an intermediate result unit whose type is deskewed images.

## Definition

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DeskewedImagesUnit extends IntermediateResultUnit
```

## Methods

| Methods | Description |
| ---------- | ----------- |
| [`getDeskewedImage`](#getdeskewedimage) | Gets the deskewed image of type [`DeskewedImageElement`](deskewed-image-element.md). |
| [`setDeskewedImage`](#setdeskewedimage) | Sets the deskewed image with a [`DeskewedImageElement`](deskewed-image-element.md) object |

The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).

{%- include api-reference/intermediate-result-unit-android.md -%}

### getDeskewedImage

Gets a deskewed image.

```java
DeskewedImageElement getDeskewedImage();
```

**Return Value**

A [`DeskewedImageElement`](deskewed-image-element.md) object that represents the deskewed image.

### setDeskewedImage

Sets a [`DeskewedImageElement`](deskewed-image-element.md) as the deskewed image.

```java
void setDeskewedImage(DeskewedImageElement element, Matrix matrixToOriginalImage);
```

**Parameters**

`[in] element`: The deskewed image to be set.

`[in] matrixToOriginalImage`: The matrix to the original image.
2 changes: 1 addition & 1 deletion programming/android/api-reference/detected-quad-element.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `DetectedQuadElement` class represents a detected quadrilateral element, whi

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DetectedQuadElement extends RegionObjectElement
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `DetectedQuadResultItem` class is an extension of the [`CapturedResultItem`]

*Namespace:* com.dynamsoft.ddn

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DetectedQuadResultItem extends CapturedResultItem
Expand Down
2 changes: 1 addition & 1 deletion programming/android/api-reference/detected-quads-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `DetectedQuadsResult` class represents a collection of [`DetectedQuadResultI

*Namespace:* com.dynamsoft.ddn

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DetectedQuadsResult
Expand Down
2 changes: 1 addition & 1 deletion programming/android/api-reference/detected-quads-unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `DetectedQuadsUnit` class represents an intermediate result unit whose type

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DetectedQuadsUnit extends IntermediateResultUnit
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `DocumentNormalizerModule` class defines general functions of the document n

*Namespace:* com.dynamsoft.ddn

*Assembly:* DynamsoftDocumentNormalizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class DocumentNormalizerModule
Expand Down
45 changes: 45 additions & 0 deletions programming/android/api-reference/enhanced-image-element.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: default-layout
title: EnhancedImageElement - Dynamsoft Document Normalizer Android SDK API Reference
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.
keywords: enhanced image element, java, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# EnhancedImageElement

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.

## Definition

*Namespace:* com.dynamsoft.ddn.intermediate_results

*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class EnhancedImageElement extends RegionObjectElement
```

## Methods

| Methods | Description |
| ---------- | ----------- |
| [`setImageData`](#getimagedata) | Sets the image data of the deskewed image with a `DSImageData` object. |

The following methods are inherited from class [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html).

{%- include api-reference/region-object-element-android.md -%}

### setImageData

Gets an [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object as the enhanced image.

```java
void setImageData(ImageData imageData);
```

**Parameters**

`imageData`: A [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object that represents the enhanced image.
63 changes: 63 additions & 0 deletions programming/android/api-reference/enhanced-image-result-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
layout: default-layout
title: EnhancedImageResultItem - Dynamsoft Document Normalizer Android SDK API Reference
description: The class EnhancedImageResultItem represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
keywords: enhanced image result item, java, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# EnhancedImageResultItem

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.

## Definition

*Namespace:* com.dynamsoft.ddn

*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class EnhancedImageResultItem extends CapturedResultItem
```

## Methods

| Methods | Description |
| ---------- | ----------- |
| [`getImageData`](#getimagedata) | Returns an `ImageData` object as the enhanced image. |
| [`getOriginalToLocalMatrix`](#getoriginaltolocalmatrix) | Returns the transformation matrix from the original image coordinate system to the local coordinate system. |

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

| Method | Description |
| ------ | ----------- |
| [`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. |
| [`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. |
| [`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. |
| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | Returns the name of the task that generated the result. |

### getImageData

Returns an [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object for the enhanced image.

```java
ImageData getImageData();
```

**Return Value**

The `ImageData` object as the enhanced image.

### getOriginalToLocalMatrix

Returns the transformation matrix from the original image coordinate system to the local coordinate system.

```java
Matrix getOriginalToLocalMatrix();
```

**Return Value**

The transformation matrix of type `android.graphics.Matrix`.
Loading