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
72 changes: 72 additions & 0 deletions programming/maui/api-reference/deskewed-image-result-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
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, csharp, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# DeskewedImageResultItem

The `DeskewedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_maui_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

```csharp
class DeskewedImageResultItem extends CapturedResultItem
```

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`ImageData`](#imagedata) | *ImageData* | Represents an `ImageData` object as the deskewed image. |
| [`SourceDeskewQuad`](#location) | *Quadrilateral* | Represents the quadrilateral from which you get the deskewed image result item. |
| [`CrossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | Represents the cross verification status of the result item. |
| [`OriginalToLocalMatrix`](#originaltolocalmatrix) | *Matrix* | Represents the transformation matrix from the original image coordinate system to the local coordinate system. |

The following properties are inherited from [`CapturedResultItem`]({{ site.dcv_maui_api }}core/captured-result-item.html).

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`Type`]({{ site.dcv_maui_api }}core/captured-result-item.html#type) | *[EnumCapturedResultItemType]({{ site.dcv_maui_api }}core/enum/captured-result-item-type.html)* | Get the type of the captured result item, indicating what kind of data it represents. |
| [`TargetROIDefName`]({{ site.dcv_maui_api }}core/captured-result-item.html#targetroidefname) | *string* | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
| [`TaskName`]({{ site.dcv_maui_api }}core/captured-result-item.html#taskname) | *string* | The name of the task that generated the result. |

### ImageData

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

```csharp
ImageData ImageData { get; }
```

### SourceDeskewQuad

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

```csharp
Quadrilateral Location { get; }
```

### CrossVerificationStatus

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

```csharp
EnumCrossVerificationStatus CrossVerificationStatus { get; }
```

### OriginalToLocalMatrix

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

```csharp
Matrix OriginalToLocalMatrix { get; }
```
1 change: 1 addition & 0 deletions programming/maui/api-reference/detected-quads-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ keywords: detected quads result, java, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
ignore: true
---

# DetectedQuadsResult
Expand Down
54 changes: 54 additions & 0 deletions programming/maui/api-reference/enhanced-image-result-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
layout: default-layout
title: EnhancedImageResultItem - Dynamsoft Document Normalizer MAUI SDK API Reference
description: The class EnhancedImageResultItem of DCV MAUI represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
keywords: enhanced image result item, csharp, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# EnhancedImageResultItem

The `EnhancedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_maui_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

```csharp
class EnhancedImageResultItem extends CapturedResultItem
```

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`ImageData`](#imagedata) | *ImageData* | Returns an `ImageData` object as the enhanced image. |
| [`OriginalToLocalMatrix`](#originaltolocalmatrix) | *Matrix* | Returns the transformation matrix from the original image coordinate system to the local coordinate system. |

The following properties are inherited from [`CapturedResultItem`]({{ site.dcv_maui_api }}core/captured-result-item.html).

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`Type`]({{ site.dcv_maui_api }}core/captured-result-item.html#type) | *[EnumCapturedResultItemType]({{ site.dcv_maui_api }}core/enum/captured-result-item-type.html)* | Get the type of the captured result item, indicating what kind of data it represents. |
| [`TargetROIDefName`]({{ site.dcv_maui_api }}core/captured-result-item.html#targetroidefname) | *string* | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
| [`TaskName`]({{ site.dcv_maui_api }}core/captured-result-item.html#taskname) | *string* | The name of the task that generated the result. |

### ImageData

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

```csharp
ImageData ImageData { get; }
```

### OriginalToLocalMatrix

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

```csharp
Matrix OriginalToLocalMatrix { get; }
```
64 changes: 64 additions & 0 deletions programming/maui/api-reference/processed-document-result.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
layout: default-layout
title: ProcessedDocumentResult - Dynamsoft Document Normalizer Android SDK API Reference
description: The class ProcessedDocumentResult represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
keywords: detected boundaries, deskew images, enhanced images, csharp, kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# ProcessedDocumentResult

The class `ProcessedDocumentResult` represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.

## Definition

*Namespace:* com.dynamsoft.ddn

*Assembly:* DynamsoftCaptureVisionBundle.aar

```csharp
class ProcessedDocumentResult : CapturedResultBase
```

## Methods

| Methods | Description |
| ---------- | ----------- |
| [`DeskewedImageResultItems`](#deskewedimageresultitems) | Represents the deskew images with an array of [`DeskewedImageResultItem`](deskewed-image-result-item.md). |
| [`DetectedQuadResultItems`](#detectedquadresultitems) | Represents the detected boundaries with an array of [`DetectedImageResultItem`](detected-image-result-item.md). |
| [`EnhancedImageResultItems`](#enhancedimageresultitems) | Represents the enhanced images with an array of [`EnhancedImageResultItem`](enhanced-image-result-item.md). |

The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_maui_api }}core/captured-result-base.html):

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`OriginalImageHashId`]({{ site.dcv_maui_api }}core/captured-result-base.html#originalimagehashid) | *string* | Represents the hash id of the original image. |
| [`RotationTransformMatrix`]({{ site.dcv_maui_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix* | Represents the rotation transformation matrix of the original image relative to the rotated image. |
| [`ErrorCode`]({{ site.dcv_maui_api }}core/captured-result-base.html#errorcode) | *int* | Represents the error code of this result. |
| [`ErrorMessage`]({{ site.dcv_maui_api }}core/captured-result-base.html#errormessage) | *string* | Represents the error message of this result. |

### DeskewedImageResultItems

Represents an array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image.

```csharp
DeskewedImageResultItem[]? DeskewedImageResultItems { get; }
```

### DetectedQuadResultItems

Represents an array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary.

```csharp
DetectedQuadResultItem[]? DetectedQuadResultItems { get; }
```

### EnhancedImageResultItems

Represents an array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image.

```csharp
EnhancedImageResultItem[]? EnhancedImageResultItems { get; }
```
Loading