Skip to content

Commit 438c2de

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #43 from dynamsoft-docs/preview
update to internal commit 4b7a5ab7
2 parents 9276b0c + 92f28da commit 438c2de

18 files changed

+1794
-0
lines changed

‎programming/java/api-reference/candidate-quad-edges-unit.md‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
layout: default-layout
3+
title: CandidateQuadEdgesUnit Class
4+
description: This page shows CandidateQuadEdgesUnit class definition of Dynamsoft Document Normalizer SDK Java Edition.
5+
keywords: getCount, getCandidateQuadEdge, CandidateQuadEdgesUnit, api reference
6+
---
7+
8+
# CandidateQuadEdgesUnit Class
9+
10+
The `CandidateQuadEdgesUnit` class represents an intermediate result unit whose type is candidate quad edges.
11+
12+
## Definition
13+
14+
*Package:* com.dynamsoft.ddn.intermediate_results
15+
16+
```java
17+
public class CandidateQuadEdgesUnit extends IntermediateResultUnit
18+
```
19+
20+
*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> CandidateQuadEdgesUnit
21+
22+
## Methods
23+
24+
| Method | Description |
25+
|--------|-------------|
26+
| [`getCount`](#getcount) | Gets the count of `Edge` objects in current object.|
27+
| [`getCandidateQuadEdge`](#getcandidatequadedge) | Gets an `Edge` object from current object by specifying a index. |
28+
| [`getCandidateQuadEdges`](#getcandidatequadedges) | Gets all `Edge` objects in current object. |
29+
| [`removeAllCandidateQuadEdges`](#removeallcandidatequadedges) | Removes all the candidate quad edges in current object. |
30+
| [`removeCandidateQuadEdge`](#removecandidatequadedge) | Removes a candidate quad edge from current object by specifying an index. |
31+
| [`addCandidateQuadEdge`](#addcandidatequadedge) | Adds a candidate quad edge to current object. |
32+
| [`setCandidateQuadEdge`](#setcandidatequadedge) | Sets the candidate quad edge at the specified index. |
33+
34+
### getCount
35+
36+
Gets the count of `Edge` objects in current object.
37+
38+
```java
39+
public int getCount()
40+
```
41+
42+
**Return Value**
43+
44+
The count of `Edge` objects in current object.
45+
46+
### getCandidateQuadEdge
47+
48+
Gets an `Edge` object from current object by specifying a index.
49+
50+
```java
51+
public Edge getCandidateQuadEdge(int index) throws DocumentNormalizerException
52+
```
53+
54+
**Parameters**
55+
56+
`index` The index of the `Edge` object.
57+
58+
**Return Value**
59+
60+
Returns the `Edge` object got by the specific index.
61+
62+
**Exceptions**
63+
64+
[`DocumentNormalizerException`](document-normalizer-exception.html)
65+
66+
**See Also**
67+
68+
[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html)
69+
70+
### getCandidateQuadEdges
71+
72+
Gets all `Edge` objects in current object.
73+
74+
```java
75+
public Edge[] getCandidateQuadEdges()
76+
```
77+
78+
**Return Value**
79+
80+
Returns an array of `Edge` objects.
81+
82+
**See Also**
83+
84+
[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html)
85+
86+
### removeAllCandidateQuadEdges
87+
88+
Removes all the candidate quad edges in current object.
89+
90+
```java
91+
public void removeAllCandidateQuadEdges()
92+
```
93+
94+
### removeCandidateQuadEdge
95+
96+
Removes a candidate quad edge from current object by specifying an index.
97+
98+
```java
99+
public void removeCandidateQuadEdge(int index) throws DocumentNormalizerException
100+
```
101+
102+
**Parameters**
103+
104+
`index` The index of the candidate quad edge to be removed.
105+
106+
**Exceptions**
107+
108+
[`DocumentNormalizerException`](document-normalizer-exception.html)
109+
110+
### addCandidateQuadEdge
111+
112+
Adds a candidate quad edge to current object.
113+
114+
```java
115+
public void addCandidateQuadEdge(Edge edge) throws DocumentNormalizerException
116+
public void addCandidateQuadEdge(Edge edge, double[] matrixToOriginalImage) throws DocumentNormalizerException
117+
```
118+
119+
**Parameters**
120+
121+
`edge` The candidate quad edge to be added.
122+
123+
`matrixToOriginalImage` The matrix to the original image.
124+
125+
**Exceptions**
126+
127+
[`DocumentNormalizerException`](document-normalizer-exception.html)
128+
129+
**See Also**
130+
131+
[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html)
132+
133+
### setCandidateQuadEdge
134+
135+
Sets the candidate quad edge at the specified index.
136+
137+
```java
138+
public void setCandidateQuadEdge(int index, Edge edge) throws DocumentNormalizerException
139+
public void setCandidateQuadEdge(int index, Edge edge, double[] matrixToOriginalImage) throws DocumentNormalizerException
140+
```
141+
142+
**Parameters**
143+
144+
`index` The index of the candidate quad edge to be set.
145+
146+
`edge` The candidate quad edge to be added.
147+
148+
`matrixToOriginalImage` The matrix to the original image.
149+
150+
**Exceptions**
151+
152+
[`DocumentNormalizerException`](document-normalizer-exception.html)
153+
154+
**See Also**
155+
156+
[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html)

‎programming/java/api-reference/corners-unit.md‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
---
2+
layout: default-layout
3+
title: CornersUnit Class
4+
description: This page shows CornersUnit class definition of Dynamsoft Document Normalizer SDK Java Edition.
5+
keywords: getCount, getCorner, CornersUnit, api reference
6+
---
7+
8+
# CornersUnit Class
9+
10+
The `CornersUnit` class represents an intermediate result unit whose type is corners.
11+
12+
## Definition
13+
14+
*Package:* com.dynamsoft.ddn.intermediate_results
15+
16+
```java
17+
public class CornersUnit extends IntermediateResultUnit
18+
```
19+
20+
*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> CornersUnit
21+
22+
## Methods
23+
24+
| Method | Description |
25+
|--------|-------------|
26+
| [`getCount`](#getcount) | Gets the count of `Corner` objects in current object.|
27+
| [`getCorner`](#getcorner) | Gets a `Corner` object from current object by specifying a index. |
28+
| [`getCorners`](#getcorners) | Gets all `Corner` objects in current object. |
29+
| [`removeAllCorners`](#removeallcorners) | Removes all the corners in current object. |
30+
| [`removeCorner`](#removecorner) | Removes a corner from current object by specifying an index. |
31+
| [`addCorner`](#addcorner) | Adds a corner to current object. |
32+
| [`setCorner`](#setcorner) | Sets the corner at the specified index. |
33+
34+
### getCount
35+
36+
Gets the count of `Corner` objects in current object.
37+
38+
```java
39+
public int getCount()
40+
```
41+
42+
**Return Value**
43+
44+
The count of `Corner` objects in current object.
45+
46+
### getCorner
47+
48+
Gets a `Corner` object from current object by specifying a index.
49+
50+
```java
51+
public Corner getCorner(int index) throws DocumentNormalizerException
52+
```
53+
```
54+
55+
**Parameters**
56+
57+
`index` The index of the `Corner` object.
58+
59+
**Return Value**
60+
61+
Returns the `Corner` object got by the specific index.
62+
63+
**Exceptions**
64+
65+
[`DocumentNormalizerException`](document-normalizer-exception.html)
66+
67+
**See Also**
68+
69+
[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html)
70+
71+
### getCorners
72+
73+
Gets all `Corner` objects in current object.
74+
75+
```java
76+
public Corner[] getCorners()
77+
```
78+
79+
**Return Value**
80+
81+
Returns an array of `Corner` objects.
82+
83+
**See Also**
84+
85+
[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html)
86+
87+
### removeAllCorners
88+
89+
Removes all the corners in current object.
90+
91+
```java
92+
public void removeAllCorners() throws DocumentNormalizerException
93+
```
94+
95+
**Exceptions**
96+
97+
[`DocumentNormalizerException`](document-normalizer-exception.html)
98+
99+
### removeCorner
100+
101+
Removes a corner from current object by specifying an index.
102+
103+
```java
104+
public void removeCorner(int index) throws DocumentNormalizerException
105+
```
106+
107+
**Parameters**
108+
109+
`index` The index of the corner to be removed.
110+
111+
**Exceptions**
112+
113+
[`DocumentNormalizerException`](document-normalizer-exception.html)
114+
115+
### addCorner
116+
117+
Adds a corner to current object.
118+
119+
```java
120+
public void addCorner(Corner corner) throws DocumentNormalizerException
121+
public void addCorner(Corner corner, double[] matrixToOriginalImage) throws DocumentNormalizerException
122+
```
123+
124+
**Parameters**
125+
126+
`corner` The corner to be added.
127+
128+
`matrixToOriginalImage` The matrix to the original image.
129+
130+
**Exceptions**
131+
132+
[`DocumentNormalizerException`](document-normalizer-exception.html)
133+
134+
**See Also**
135+
136+
[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html)
137+
138+
### setCorner
139+
140+
Sets the corner at the specified index.
141+
142+
```java
143+
public void setCorner(int index, Corner corner) throws DocumentNormalizerException
144+
public void setCorner(int index, Corner corner, double[] matrixToOriginalImage) throws DocumentNormalizerException
145+
```
146+
147+
**Parameters**
148+
149+
`index` The index of the corner to be set.
150+
151+
`corner` The corner to be added.
152+
153+
`matrixToOriginalImage` The matrix to the original image.
154+
155+
**Exceptions**
156+
157+
[`DocumentNormalizerException`](document-normalizer-exception.html)
158+
159+
**See Also**
160+
161+
[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html)
162+

0 commit comments

Comments
 (0)