Skip to content

Commit 39260f2

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #71 from dynamsoft-docs/preview
update to internal commit 754e0603
2 parents 1b549fb + a9c6680 commit 39260f2

File tree

6 files changed

+921
-238
lines changed

6 files changed

+921
-238
lines changed

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
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, csharp, 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_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.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn
18+
19+
*Assembly:* DynamsoftCaptureVisionBundle.aar
20+
21+
```csharp
22+
class DeskewedImageResultItem extends CapturedResultItem
23+
```
24+
25+
## Properties
26+
27+
| Property | Type | Description |
28+
| -------- | ---- | ----------- |
29+
| [`ImageData`](#imagedata) | *ImageData* | Represents an `ImageData` object as the deskewed image. |
30+
| [`SourceDeskewQuad`](#location) | *Quadrilateral* | Represents the quadrilateral from which you get the deskewed image result item. |
31+
| [`CrossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | Represents the cross verification status of the result item. |
32+
| [`OriginalToLocalMatrix`](#originaltolocalmatrix) | *Matrix* | Represents the transformation matrix from the original image coordinate system to the local coordinate system. |
33+
34+
The following properties are inherited from [`CapturedResultItem`]({{ site.dcv_maui_api }}core/captured-result-item.html).
35+
36+
| Property | Type | Description |
37+
| -------- | ---- | ----------- |
38+
| [`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. |
39+
| [`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. |
40+
| [`TaskName`]({{ site.dcv_maui_api }}core/captured-result-item.html#taskname) | *string* | The name of the task that generated the result. |
41+
42+
### ImageData
43+
44+
Represents an [`ImageData`]({{ site.dcv_maui_api }}core/basic-structures/image-data.html) object for the deskewed image.
45+
46+
```csharp
47+
ImageData ImageData { get; }
48+
```
49+
50+
### SourceDeskewQuad
51+
52+
Represents the soure [Quadrilateral]({{ site.dcv_maui_api }}core/basic-structures/quadrilateral.html) that used to deskew the image.
53+
54+
```csharp
55+
Quadrilateral Location { get; }
56+
```
57+
58+
### CrossVerificationStatus
59+
60+
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`.
61+
62+
```csharp
63+
EnumCrossVerificationStatus CrossVerificationStatus { get; }
64+
```
65+
66+
### OriginalToLocalMatrix
67+
68+
Represents the transformation matrix from the original image coordinate system to the local coordinate system.
69+
70+
```csharp
71+
Matrix OriginalToLocalMatrix { get; }
72+
```

‎programming/maui/api-reference/detected-quads-result.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ keywords: detected quads result, java, kotlin
66
needGenerateH3Content: true
77
needAutoGenerateSidebar: true
88
noTitleIndex: true
9+
ignore: true
910
---
1011

1112
# DetectedQuadsResult

‎programming/maui/api-reference/enhanced-image-result-item.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: default-layout
3+
title: EnhancedImageResultItem - Dynamsoft Document Normalizer MAUI SDK API Reference
4+
description: The class EnhancedImageResultItem of DCV MAUI represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
5+
keywords: enhanced image result item, csharp, 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_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.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn
18+
19+
*Assembly:* DynamsoftCaptureVisionBundle.aar
20+
21+
```csharp
22+
class EnhancedImageResultItem extends CapturedResultItem
23+
```
24+
25+
## Properties
26+
27+
| Property | Type | Description |
28+
| -------- | ---- | ----------- |
29+
| [`ImageData`](#imagedata) | *ImageData* | Returns an `ImageData` object as the enhanced image. |
30+
| [`OriginalToLocalMatrix`](#originaltolocalmatrix) | *Matrix* | Returns the transformation matrix from the original image coordinate system to the local coordinate system. |
31+
32+
The following properties are inherited from [`CapturedResultItem`]({{ site.dcv_maui_api }}core/captured-result-item.html).
33+
34+
| Property | Type | Description |
35+
| -------- | ---- | ----------- |
36+
| [`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. |
37+
| [`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. |
38+
| [`TaskName`]({{ site.dcv_maui_api }}core/captured-result-item.html#taskname) | *string* | The name of the task that generated the result. |
39+
40+
### ImageData
41+
42+
Returns an [`ImageData`]({{ site.dcv_maui_api }}core/basic-structures/image-data.html) object for the enhanced image.
43+
44+
```csharp
45+
ImageData ImageData { get; }
46+
```
47+
48+
### OriginalToLocalMatrix
49+
50+
Returns the transformation matrix from the original image coordinate system to the local coordinate system.
51+
52+
```csharp
53+
Matrix OriginalToLocalMatrix { get; }
54+
```

‎programming/maui/api-reference/processed-document-result.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: default-layout
3+
title: ProcessedDocumentResult - Dynamsoft Document Normalizer Android SDK API Reference
4+
description: The class ProcessedDocumentResult represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
5+
keywords: detected boundaries, deskew images, enhanced images, csharp, kotlin
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# ProcessedDocumentResult
12+
13+
The class `ProcessedDocumentResult` represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn
18+
19+
*Assembly:* DynamsoftCaptureVisionBundle.aar
20+
21+
```csharp
22+
class ProcessedDocumentResult : CapturedResultBase
23+
```
24+
25+
## Methods
26+
27+
| Methods | Description |
28+
| ---------- | ----------- |
29+
| [`DeskewedImageResultItems`](#deskewedimageresultitems) | Represents the deskew images with an array of [`DeskewedImageResultItem`](deskewed-image-result-item.md). |
30+
| [`DetectedQuadResultItems`](#detectedquadresultitems) | Represents the detected boundaries with an array of [`DetectedImageResultItem`](detected-image-result-item.md). |
31+
| [`EnhancedImageResultItems`](#enhancedimageresultitems) | Represents the enhanced images with an array of [`EnhancedImageResultItem`](enhanced-image-result-item.md). |
32+
33+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_maui_api }}core/captured-result-base.html):
34+
35+
| Property | Type | Description |
36+
| -------- | ---- | ----------- |
37+
| [`OriginalImageHashId`]({{ site.dcv_maui_api }}core/captured-result-base.html#originalimagehashid) | *string* | Represents the hash id of the original image. |
38+
| [`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. |
39+
| [`ErrorCode`]({{ site.dcv_maui_api }}core/captured-result-base.html#errorcode) | *int* | Represents the error code of this result. |
40+
| [`ErrorMessage`]({{ site.dcv_maui_api }}core/captured-result-base.html#errormessage) | *string* | Represents the error message of this result. |
41+
42+
### DeskewedImageResultItems
43+
44+
Represents an array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image.
45+
46+
```csharp
47+
DeskewedImageResultItem[]? DeskewedImageResultItems { get; }
48+
```
49+
50+
### DetectedQuadResultItems
51+
52+
Represents an array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary.
53+
54+
```csharp
55+
DetectedQuadResultItem[]? DetectedQuadResultItems { get; }
56+
```
57+
58+
### EnhancedImageResultItems
59+
60+
Represents an array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image.
61+
62+
```csharp
63+
EnhancedImageResultItem[]? EnhancedImageResultItems { get; }
64+
```

0 commit comments

Comments
 (0)