Skip to content

Commit b7b0df1

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #81 from dynamsoft-docs/preview
Preview
2 parents f1bed33 + dbe9aa7 commit b7b0df1

File tree

7 files changed

+380
-1
lines changed

7 files changed

+380
-1
lines changed

‎.github/workflows/main.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
push:
99
branches:
1010
- main
11-
#- preview
11+
- preview
1212

1313
# Allows you to run this workflow manually from the Actions tab
1414
workflow_dispatch:

‎_config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
1919

2020
dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
2121

22+
dcv_flutter: /capture-vision/docs/mobile/programming/flutter/
23+
dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
24+
2225
dcv_introduction: /capture-vision/docs/core/introduction/
2326

2427
dce_android_api: /camera-enhancer/docs/mobile/programming/android/

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
layout: default-layout
3+
title: DeskewedImageResultItem - Dynamsoft Capture Vision Flutter 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, dart
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_flutter_api }}core/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+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class DeskewedImageResultItem extends CapturedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the deskewed image. |
28+
| [`sourceDeskewQuad`](#location) | *Quadrilateral* | The quadrilateral from which you get the deskewed image result item. |
29+
| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
30+
| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Matrix4* | 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_flutter_api }}core/captured-result-item.html).
33+
34+
| Property | Type | Description |
35+
| -------- | ---- | ----------- |
36+
| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
37+
| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
38+
| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
39+
40+
### imageData
41+
42+
An [`ImageData`]({{ site.dcv_flutter_api }}core/image-data.html) object for the deskewed image.
43+
44+
```dart
45+
ImageData? imageData;
46+
```
47+
48+
### sourceDeskewQuad
49+
50+
The soure [Quadrilateral]({{ site.dcv_flutter_api }}core/quadrilateral.html) that used to deskew the image.
51+
52+
```dart
53+
Quadrilateral sourceDeskewQuad;
54+
```
55+
56+
### crossVerificationStatus
57+
58+
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`.
59+
60+
```dart
61+
EnumCrossVerificationStatus crossVerificationStatus;
62+
```
63+
64+
### originalToLocalMatrix
65+
66+
The transformation matrix from the original image coordinate system to the local coordinate system.
67+
68+
```dart
69+
Matrix4 originalToLocalMatrix;
70+
```

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
layout: default-layout
3+
title: DetectedQuadResultItem - Dynamsoft Capture Vision Flutter 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, dart
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_flutter_api }}core/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+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class DetectedQuadResultItem extends CapturedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`location`](#location) | *Quadrilateral* | A Quadrilateral object as the location of current object. |
28+
| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *int* | The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
29+
| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
30+
31+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html).
32+
33+
| Property | Type | Description |
34+
| -------- | ---- | ----------- |
35+
| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
36+
| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
37+
| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
38+
39+
### location
40+
41+
Returns a [Quadrilateral]({{ site.dcv_flutter_api }}core/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
42+
43+
```dart
44+
Quadrilateral location;
45+
```
46+
47+
### confidenceAsDocumentBoundary
48+
49+
Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
50+
51+
```dart
52+
int confidenceAsDocumentBoundary;
53+
```
54+
55+
### crossVerificationStatus
56+
57+
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`.
58+
59+
```dart
60+
EnumCrossVerificationStatus crossVerificationStatus;
61+
```

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: default-layout
3+
title: EnhancedImageResultItem - Dynamsoft Capture Vision Flutter 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, dart
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_flutter_api }}core/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+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class EnhancedImageResultItem extends CapturedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the enhanced image. |
28+
| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Matrix4* | The transformation matrix from the original image coordinate system to the local coordinate system. |
29+
30+
The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html).
31+
32+
| Property | Type | Description |
33+
| -------- | ---- | ----------- |
34+
| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
35+
| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
36+
| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
37+
38+
### imageData
39+
40+
An [`ImageData`]({{ site.dcv_flutter_api }}core/image-data.html) object for the enhanced image.
41+
42+
```dart
43+
ImageData? imageData;
44+
```
45+
46+
### originalToLocalMatrix
47+
48+
The transformation matrix from the original image coordinate system to the local coordinate system.
49+
50+
```dart
51+
Matrix4 originalToLocalMatrix;
52+
```

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
layout: default-layout
3+
title: ProcessedDocumentResult - Dynamsoft Capture Vision Flutter 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, dart
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+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ProcessedDocumentResult extends CapturedResultBase
21+
```
22+
23+
## Properties
24+
25+
| Property | Types | Description |
26+
| -------- | ----- | ----------- |
27+
| [`DeskewedImageResultItems`](#deskewedimageresultitems) | *List<DeskewedImageResultItem>* | An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image. |
28+
| [`DetectedQuadResultItems`](#detectedquadresultitems) | *List<DetectedQuadResultItem>* | An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary. |
29+
| [`EnhancedImageResultItems`](#enhancedimageresultitems) | *List<EnhancedImageResultItem>* | A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image. |
30+
31+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html):
32+
33+
| Property | Types | Description |
34+
| -------- | ----- | ----------- |
35+
| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. |
36+
| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
37+
| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. |
38+
| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. |
39+
40+
### deskewedImageResultItems
41+
42+
An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image.
43+
44+
```dart
45+
List<DeskewedImageResultItem>? deskewedImageResultItems;
46+
```
47+
48+
### detectedQuadResultItems
49+
50+
An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary.
51+
52+
```dart
53+
List<DetectedQuadResultItem>? detectedQuadResultItems;
54+
```
55+
56+
### enhancedImageResultItems
57+
58+
A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image.
59+
60+
```dart
61+
List<EnhancedImageResultItem>? enhancedImageResultItems;
62+
```

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

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
layout: default-layout
3+
title: SimplifiedDocumentNormalizerSettings - Dynamsoft Capture Vision Flutter Edition API Reference
4+
description: The class SimplifiedDocumentNormalizerSettings of Dynamsoft Capture Vision Flutter edition represents the simplified document normalizer settings.
5+
keywords: document normalizer settings, Flutter, dart
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# SimplifiedDocumentNormalizerSettings
12+
13+
The `SimplifiedDocumentNormalizerSettings` class represents a series of simple settings related to the document scanning.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class SimplifiedDocumentNormalizerSettings
21+
```
22+
23+
## Properties
24+
25+
| Property | Types | Description |
26+
| -------- | ----- | ----------- |
27+
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List<EnumGrayscaleTransformationMode>* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
28+
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List<EnumGrayscaleEnhancementMode>* | An array of GrayscaleEnhancementModes. |
29+
| [`colourMode`](#colourmode) | *EnumImageColourMode* | The grayscale transformation mode. It controls whether to decode the inverted text. |
30+
| [`pageSize`](#pagesize) | *Size* | The page size. |
31+
| [`brightness`](#brightness) | *int* | The brightness. |
32+
| [`contrast`](#contrast) | *int* | The contrast. |
33+
| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. |
34+
| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. |
35+
| [`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). |
36+
| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | The number of documents expected to be detected. |
37+
38+
### grayscaleTransformationModes
39+
40+
Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-transformation-mode.html) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary.
41+
42+
```dart
43+
List<EnumGrayscaleTransformationMode> grayscaleTransformationModes;
44+
```
45+
46+
### grayscaleEnhancementModes
47+
48+
Defines the grayscale enhancement modes with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_flutter_api }}core/enum/grayscale-enhancement-modes.html) items. This parameter can be quite powerful in increasing the border detection rate of your application should you experience any trouble in that area. To learn more about the `grayscaleEnhancementModes` and how they can be used, please visit the main [GrayscaleEnhancementModes]({{ site.dcv_parameters }}reference/image-parameter/grayscale-enhancement-modes.html) parameter page.
49+
50+
```dart
51+
List<EnumGrayscaleEnhancementMode> grayscaleEnhancementModes;
52+
```
53+
54+
### colourMode
55+
56+
Defines the colour mode of the normalized image with an [`EnumImageColourMode`]({{ site.dcv_flutter_api }}core/enum/image-colour-mode.html) member. By default, the normalized image will output in colour. In order to make the result image grayscale or binary, setting the `colourMode` to the corresponding pixel type will do the trick.
57+
58+
```dart
59+
EnumImageColourMode colourMode;
60+
```
61+
62+
### pageSize
63+
64+
The page size of the normalized image.
65+
66+
```dart
67+
Size pageSize;
68+
```
69+
70+
### brightness
71+
72+
The brightness of the normalized image result.
73+
74+
```dart
75+
@IntRange
76+
int brightness;
77+
```
78+
79+
**Range**
80+
81+
[-100, 100]
82+
83+
### contrast
84+
85+
The contrast of the normalized image result.
86+
87+
```dart
88+
int contrast;
89+
```
90+
91+
**Range**
92+
93+
[-100,100]
94+
95+
### maxThreadsInOneTask
96+
97+
The maximum number of threads dedicated to a single task.
98+
99+
```dart
100+
int maxThreadsInOneTask;
101+
```
102+
103+
### scaleDownThreshold
104+
105+
If the original image size is quite large, then the `scaledownThreshold` can be used to shrink the image and speed up the processing. If the shorter edge size is larger than the defined scale down threshold, the library will calculate the required width and height of the image and shrink it to that size before moving forward in the process.
106+
107+
```dart
108+
int scaleDownThreshold;
109+
```
110+
111+
### minQuadrilateralAreaRatio
112+
113+
The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages).
114+
115+
```dart
116+
int minQuadrilateralAreaRatio;
117+
```
118+
119+
**Range**
120+
121+
[0, 100]
122+
123+
If expectedDocumentsCount is 1 && documentType is Document, the range is from 20 to 100.
124+
125+
### expectedDocumentsCount
126+
127+
The number of documents expected to be detected.
128+
129+
```dart
130+
int expectedDocumentsCount;
131+
```

0 commit comments

Comments
 (0)