Skip to content

Commit 913a368

Browse files
Merge pull request #46 from dynamsoft-docs/preview
update to internal commit b3118d6c
2 parents 2a7f6d3 + c787702 commit 913a368

File tree

8 files changed

+614
-18
lines changed

8 files changed

+614
-18
lines changed

assets/js/ddnMobileVersionSearch.json

Lines changed: 66 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,107 @@
22
{
33
"version": "2.2.11",
44
"matchList": {
5+
"android":{
6+
"dcvRepoMobile": [
7+
{
8+
"path": "/programming/android/api-reference/utility",
9+
"version": "1.2.20"
10+
}, {
11+
"path": "/programming/android/api-reference/license",
12+
"version": "3.2.20"
13+
}, {
14+
"path": "/programming/android/api-reference/capture-vision-router",
15+
"version": "2.2.30"
16+
}, {
17+
"path": "/programming/android/api-reference/core",
18+
"version": "3.2.30"
19+
}, {
20+
"path": "/programming/android/api-reference/image-processing",
21+
"version": "2.2.30"
22+
}
23+
],
24+
"dcvRepoCore": [
25+
{
26+
"path": "/introduction/",
27+
"version": "2.2.10"
28+
}, {
29+
"path": "/enums/capture-vision-router",
30+
"version": "2.2.30"
31+
}, {
32+
"path": "/enums/core",
33+
"version": "3.2.30"
34+
},{
35+
"path": "/parameters/reference/capture-vision-template",
36+
"version": "2.2.30"
37+
},{
38+
"path": "/parameters/reference/target-roi-def",
39+
"version": "2.2.30"
40+
},{
41+
"path": "/parameters/reference/document-normalizer-task-settings",
42+
"version": "2.2.10"
43+
},{
44+
"path": "/parameters/reference/image-parameter",
45+
"version": "2.2.30"
46+
},{
47+
"path": "/parameters/reference/image-source-options",
48+
"version": "3.2.30"
49+
},{
50+
"path": "/parameters/reference/global-parameter",
51+
"version": "2.2.30"
52+
}
53+
],
54+
"dce": "4.2.10"
55+
},
556
"ios":{
657
"dcvRepoMobile": [
758
{
859
"path": "/programming/objectivec-swift/api-reference/utility",
9-
"version": "1.2.11"
60+
"version": "1.2.20"
1061
}, {
1162
"path": "/programming/objectivec-swift/api-reference/license",
12-
"version": "3.2.11"
63+
"version": "3.2.20"
1364
}, {
1465
"path": "/programming/objectivec-swift/api-reference/capture-vision-router",
15-
"version": "2.2.11"
66+
"version": "2.2.30"
1667
}, {
1768
"path": "/programming/objectivec-swift/api-reference/core",
18-
"version": "3.2.11"
69+
"version": "3.2.30"
1970
}, {
2071
"path": "/programming/objectivec-swift/api-reference/image-processing",
21-
"version": "2.2.11"
72+
"version": "2.2.30"
2273
}
2374
],
2475
"dcvRepoCore": [
2576
{
2677
"path": "/introduction/",
27-
"version": "2.2.11"
78+
"version": "2.2.10"
2879
}, {
2980
"path": "/enums/capture-vision-router",
30-
"version": "2.2.11"
81+
"version": "2.2.30"
3182
}, {
3283
"path": "/enums/core",
33-
"version": "3.2.11"
84+
"version": "3.2.30"
3485
},{
3586
"path": "/parameters/reference/capture-vision-template",
36-
"version": "2.2.11"
87+
"version": "2.2.30"
3788
},{
3889
"path": "/parameters/reference/target-roi-def",
39-
"version": "2.2.11"
90+
"version": "2.2.30"
4091
},{
4192
"path": "/parameters/reference/document-normalizer-task-settings",
42-
"version": "2.2.11"
93+
"version": "2.2.10"
4394
},{
4495
"path": "/parameters/reference/image-parameter",
45-
"version": "2.2.11"
96+
"version": "2.2.30"
4697
},{
4798
"path": "/parameters/reference/image-source-options",
48-
"version": "3.2.11"
99+
"version": "3.2.30"
49100
},{
50101
"path": "/parameters/reference/global-parameter",
51-
"version": "2.2.11"
102+
"version": "2.2.30"
52103
}
53104
],
54-
"dce": "4.2.1"
105+
"dce": "4.2.10"
55106
}
56107
}
57108
},{
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
layout: default-layout
3+
title: SimplifiedDocumentNormalizerSettings - Dynamsoft Document Normalizer module Android Edition API Reference
4+
description: The class SimplifiedDocumentNormalizerSettings of Dynamsoft Document Normalizer module Android edition represents the simplified document normalizer settings.
5+
keywords: document normalizer settings, Android, java
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 Normalizer. Please note that this is not the full list of settings that can be utilized by the Document Normalizer, which you can find on the [Dynamsoft Document Normalizer Parameters]({{ site.parameters }}reference/index.html){:target="_blank"} page.
14+
15+
## Definition
16+
17+
*Namespace:* com.dynamsoft.ddn
18+
19+
*Assembly:* DynamsoftDocumentNormalizer.aar
20+
21+
```java
22+
class SimplifiedDocumentNormalizerSettings
23+
```
24+
25+
## Attributes
26+
27+
| Attributes | Type | Description |
28+
| ---------- | ---- | ----------- |
29+
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *EnumGrayscaleTransformationMode[]* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
30+
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *EnumGrayscaleEnhancementModes[]* | An array of GrayscaleEnhancementModes. |
31+
| [`colourMode`](#colourmode) | *EnumImageColourMode* | The grayscale transformation mode. It controls whether to decode the inverted text. |
32+
| [`pageSize`](#pagesize) | *int[]* | The page size. |
33+
| [`brightness`](#brightness) | *int* | The brightness. |
34+
| [`contrast`](#contrast) | *int* | The contrast. |
35+
| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. |
36+
| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. |
37+
38+
### grayscaleTransformationModes
39+
40+
Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary.
41+
42+
```java
43+
EnumGrayscaleTransformationMode[] grayscaleTransformationModes;
44+
```
45+
46+
### grayscaleEnhancementModes
47+
48+
Defines the grayscale enhancement modes with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_enumerations }}core/grayscale-enhancement-modes.html?lang=android) 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+
```java
51+
EnumGrayscaleEnhancementMode[] grayscaleEnhancementModes;
52+
```
53+
54+
### colourMode
55+
56+
Defines the colour mode of the normalized image with an [`EnumImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=android) 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+
```java
59+
EnumImageColourMode colourMode;
60+
```
61+
62+
### pageSize
63+
64+
Defines the page size of the normalized image through an integer array.
65+
66+
```java
67+
int[] pageSize;
68+
```
69+
70+
### brightness
71+
72+
Defines the brightness of the normalized image result with an integer.
73+
74+
```java
75+
int brightness;
76+
```
77+
78+
### contrast
79+
80+
Defines the contrast of the normalized image result with an integer.
81+
82+
```java
83+
int contrast;
84+
```
85+
86+
### maxThreadsInOneTask
87+
88+
Defines the maximum number of threads dedicated to a single task.
89+
90+
```java
91+
int maxThreadsInOneTask;
92+
```
93+
94+
### scaleDownThreshold
95+
96+
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.
97+
98+
```java
99+
int scaleDownThreshold;
100+
```

programming/android/api-reference/simplified-document-normalizer-settings.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The `SimplifiedDocumentNormalizerSettings` class represents a series of simple s
2222
class SimplifiedDocumentNormalizerSettings
2323
```
2424

25-
## Attributes
25+
## Methods & Attributes
2626

2727
| Attributes | Type | Description |
2828
| ---------- | ---- | ----------- |
@@ -35,6 +35,10 @@ class SimplifiedDocumentNormalizerSettings
3535
| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. |
3636
| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. |
3737

38+
| Methods | Description |
39+
| [`toJson`](#tojson) | Generate a JSON string from this `SimplifiedDocumentNormalizerSettings` object. |
40+
| [`fromJson`](#fromjson) | Create a `SimplifiedDocumentNormalizerSettings` object from a JSON string. |
41+
3842
### grayscaleTransformationModes
3943

4044
Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary.
@@ -98,3 +102,31 @@ If the original image size is quite large, then the `scaledownThreshold` can be
98102
```java
99103
int scaleDownThreshold;
100104
```
105+
106+
### toJson
107+
108+
Generate a JSON string from this `SimplifiedDocumentNormalizerSettings` object.
109+
110+
```java
111+
String toJson()
112+
```
113+
114+
**Return Value**
115+
116+
A JSON string that contains all the information of this object.
117+
118+
### fromJson
119+
120+
Create a `SimplifiedDocumentNormalizerSettings` object from a JSON string.
121+
122+
```java
123+
static SimplifiedDocumentNormalizerSettings fromJson(String json);
124+
```
125+
126+
**Parameters**
127+
128+
* `json`: A JSON string that contains all `SimplifiedDocumentNormalizerSettings` required information.
129+
130+
**Return Value**
131+
132+
A `SimplifiedDocumentNormalizerSettings` object.

programming/android/release-notes/android-2.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ permalink: /programming/android/release-notes/android-2.html
1111

1212
# Release Notes for Android SDK - v2.x
1313

14+
## 2.2.11 (05/15/2024)
15+
16+
- Added new methods `toJson` & `fromJson` to the [`SimplifiedDocumentNormalizerSettings`]({{ site.dbr_android_api }}simplified-document-normalizer-settings.html) class.
17+
1418
## 2.2.10 (03/07/2024)
1519

1620
### New

programming/android/release-notes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ permalink: /programming/android/release-notes/index.html
1010

1111
# Release Notes - Android Edition
1212

13+
- [2.2.11 (05/15/2024)]({{ site.android_release_notes }}android-2.html#2211-05152024)
1314
- [2.2.10 (03/07/2024)]({{ site.android_release_notes }}android-2.html#2210-03072024)
1415
- [2.0.20 (12/12/2023)]({{ site.android_release_notes }}android-2.html#2020-12122023)
1516
- [2.0.10 (08/10/2023)]({{ site.android_release_notes }}android-2.html#2010-08102023)

0 commit comments

Comments
 (0)