Skip to content

Commit 84ca94e

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #44 from dynamsoft-docs/preview
update to internal commit 185a609e
2 parents 1b08274 + d786714 commit 84ca94e

15 files changed

Lines changed: 1917 additions & 0 deletions

‎programming/java/api-reference/buffered-character-item-set.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
layout: default-layout
3+
title: BufferedCharacterItemSet Class - Dynamsoft Label Recognizer Module Java Edition API Reference
4+
description: Definition of the BufferedCharacterItemSet class in Dynamsoft Label Recognizer Module Java Edition.
5+
keywords: BufferedCharacterItemSet
6+
---
7+
8+
# BufferedCharacterItemSet
9+
10+
The `BufferedCharacterItemSet` class represents a collection of buffered character items and associated character clusters.
11+
12+
## Definition
13+
14+
*Package:* com.dynamsoft.dlr
15+
16+
```java
17+
public class BufferedCharacterItemSet
18+
```
19+
20+
## Methods
21+
22+
| Method | Description |
23+
|----------------------|-------------|
24+
| [`getItems`](#getitems) | Gets all the buffered items. |
25+
| [`getCharacterClusters`](#getcharacterclusters) | Gets all the character clusters. |
26+
27+
### getItems
28+
29+
Gets all the buffered items.
30+
31+
```java
32+
public BufferedCharacterItem[] getItems()
33+
```
34+
35+
**Return Value**
36+
37+
Returns a `BufferedCharacterItem` array.
38+
39+
**See Also**
40+
41+
[BufferedCharacterItem]({{ site.dlr_java_api }}buffered-character-item.html)
42+
43+
### getCharacterClusters
44+
45+
Gets all the character clusters.
46+
47+
```java
48+
public CharacterCluster[] getCharacterClusters()
49+
```
50+
51+
**Return Value**
52+
53+
Returns a `CharacterCluster` array.
54+
55+
**See Also**
56+
57+
[CharacterCluster]({{ site.dlr_java_api }}character-cluster.html)
58+
59+
**Return Value**
60+
61+
Returns a `CharacterCluster` list.
62+
63+
**See Also**
64+
65+
[CharacterCluster]({{ site.dlr_python_api }}character-cluster.html)
66+

‎programming/java/api-reference/buffered-character-item.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
layout: default-layout
3+
title: BufferedCharacterItem Class - Dynamsoft Label Recognizer Module Java Edition API Reference
4+
description: Definition of the BufferedCharacterItem class in Dynamsoft Label Recognizer Module Java Edition.
5+
keywords: BufferedCharacterItem
6+
---
7+
8+
# BufferedCharacterItem
9+
10+
The `BufferedCharacterItem` class represents a buffered character item recognized by the library.
11+
12+
## Definition
13+
14+
*Package:* com.dynamsoft.dlr
15+
16+
```java
17+
public class BufferedCharacterItem
18+
```
19+
20+
## Methods
21+
22+
| Method | Description |
23+
|----------------------|-------------|
24+
| [`getCharacter`](#getcharacter) | Gets the buffered character value. |
25+
| [`getImage`](#getimage) | Gets the image data of the buffered character. |
26+
| [`getFeatures`](#getfeatures) | Gets all the features formatted with id and value of the buffered character. |
27+
28+
### getCharacter
29+
30+
Gets the buffered character value.
31+
32+
```java
33+
public char getCharacter()
34+
```
35+
36+
**Return Value**
37+
38+
Returns the buffered character value.
39+
40+
### getImage
41+
42+
Gets the image data of the buffered character.
43+
44+
```java
45+
public ImageData getImage()
46+
```
47+
48+
**Return Value**
49+
50+
Returns the image data of the buffered character.
51+
52+
**See Also**
53+
54+
[ImageData]({{ site.dcvb_java_api }}core/basic-classes/image-data.html)
55+
56+
### getFeatures
57+
58+
Gets all the features formatted with id and value of the buffered character.
59+
60+
```java
61+
public HashMap<Integer, Float> getFeatures()
62+
```
63+
64+
**Return Value**
65+
66+
Returns all the features as a HashMap where keys are feature IDs and values are feature values.
67+
68+
**See Also**
69+
70+
[ImageData]({{ site.dcvb_java_api }}core/basic-classes/image-data.html)
71+
72+
### getFeatures
73+
74+
Gets all the features formatted with id and value of the buffered character.
75+
76+
```java
77+
public HashMap<Integer, Float> getFeatures()
78+
```
79+
80+
**Return Value**
81+
82+
Returns all the features as a HashMap where keys are feature IDs and values are feature values.
83+
84+

‎programming/java/api-reference/character-cluster.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
layout: default-layout
3+
title: CharacterCluster Class - Dynamsoft Label Recognizer Module Java Edition API Reference
4+
description: Definition of the CharacterCluster class in Dynamsoft Label Recognizer Module Java Edition.
5+
keywords: Character cluster
6+
---
7+
8+
# CharacterCluster
9+
10+
The `CharacterCluster` class represents a character cluster generated from the buffered character items. These buffered items will be clustered based on feature similarity to obtain cluster centers.
11+
12+
## Definition
13+
14+
*Package:* com.dynamsoft.dlr
15+
16+
```java
17+
public class CharacterCluster
18+
```
19+
20+
## Methods
21+
22+
| Method | Description |
23+
|---------- |-------------|
24+
| [`getCharacter`](#getcharacter) | Gets the character value of the cluster. |
25+
| [`getMean`](#getmean) | Gets the mean of the cluster. |
26+
27+
### getCharacter
28+
29+
Gets the character value of the cluster.
30+
31+
```java
32+
public char getCharacter()
33+
```
34+
35+
**Return Value**
36+
37+
Returns the character value of the cluster.
38+
39+
### getMean
40+
41+
Gets the mean of the cluster.
42+
43+
```java
44+
public BufferedCharacterItem getMean()
45+
```
46+
47+
**Return Value**
48+
49+
Returns the mean of the cluster which is a `BufferedCharacterItem` object.
50+
51+
**See Also**
52+
53+
[BufferedCharacterItem]({{ site.dlr_java_api }}buffered-character-item.html)
54+
55+
**See Also**
56+
57+
[BufferedCharacterItem]({{ site.dlr_python_api }}buffered-character-item.html)

‎programming/java/api-reference/character-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: CharacterResult Class - Dynamsoft Label Recognizer Module Java Edition API Reference
4+
description: Definition of the CharacterResult class in Dynamsoft Label Recognizer Module Java Edition.
5+
keywords: Character result
6+
---
7+
8+
# CharacterResult
9+
10+
The `CharacterResult` class represents the result of a character recognition process. It contains the characters recognized (high, medium, and low confidence), their respective confidences, and the location of the character in a quadrilateral shape.
11+
12+
## Definition
13+
14+
*Package:* com.dynamsoft.dlr
15+
16+
```java
17+
public class CharacterResult
18+
```
19+
20+
## Properties
21+
22+
| Property | Type |
23+
|---------- | ---- |
24+
| [`characterH`](#characterh) | *char* |
25+
| [`characterM`](#characterm) | *char* |
26+
| [`characterL`](#characterl) | *char* |
27+
| [`location`](#location) | *Quadrilateral* |
28+
| [`characterHConfidence`](#characterhconfidence) | *int* |
29+
| [`characterMConfidence`](#charactermconfidence) | *int* |
30+
| [`characterLConfidence`](#characterlconfidence) | *int* |
31+
32+
### characterH
33+
34+
The character with high confidence.
35+
36+
### characterM
37+
38+
The character with medium confidence.
39+
40+
### characterL
41+
42+
The character with low confidence.
43+
44+
### location
45+
46+
The location of the character in a quadrilateral shape.
47+
48+
**See Also**
49+
50+
[Quadrilateral]({{ site.dcvb_java_api }}core/basic-classes/quadrilateral.html)
51+
52+
### characterHConfidence
53+
54+
The confidence of the character with high confidence.
55+
56+
### characterMConfidence
57+
58+
The confidence of the character with medium confidence.
59+
60+
### characterLConfidence
61+
62+
The confidence of the character with low confidence.

‎programming/java/api-reference/enum-raw-text-line-status.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: default-layout
3+
title: RawTextLineStatus - Dynamsoft LabelRecognizer Java Enumerations
4+
description: The enumeration RawTextLineStatus of Dynamsoft LabelRecognizer describes the final status of a raw text line.
5+
keywords: Raw Text Line Status
6+
codeAutoHeight: true
7+
---
8+
9+
# Enumeration RawTextLineStatus
10+
11+
`RawTextLineStatus` enumerates the final status of a raw text line.
12+
13+
```java
14+
@Retention(RetentionPolicy.CLASS)
15+
public @interface EnumRawTextLineStatus {
16+
//Localized but recognition not performed.
17+
int RTLS_LOCALIZED = 0;
18+
//Recognition failed.
19+
int RTLS_RECOGNITION_FAILED = 1;
20+
//Successfully recognized.
21+
int RTLS_RECOGNITION_SUCCEEDED = 2;
22+
}
23+
```

‎programming/java/api-reference/label-recognizer-module.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: default-layout
3+
title: LabelRecognizerModule Class - Dynamsoft Label Recognizer Module Java Edition API Reference
4+
description: Definition of the LabelRecognizerModule class in Dynamsoft Label Recognizer Module Java Edition.
5+
keywords: label recognizer module, java
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
---
9+
10+
# LabelRecognizerModule
11+
12+
The `LabelRecognizerModule` class defines general functions in the label recognizer module.
13+
14+
## Definition
15+
16+
*Package:* com.dynamsoft.dlr
17+
18+
```java
19+
public final class LabelRecognizerModule
20+
```
21+
22+
## Methods
23+
24+
| Method | Description |
25+
| -------------------------- | -------------------------------------------------- |
26+
| [`getVersion`](#getversion) | Returns the version of the label recognizer module. |
27+
28+
### getVersion
29+
30+
Returns the version of the label recognizer module.
31+
32+
```java
33+
public static String getVersion()
34+
```
35+
36+
**Return Value**
37+
38+
Returns a string representing the version of the label recognizer module.
39+

0 commit comments

Comments
 (0)