Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ repository: Dynamsoft-Docs/label-recognition-docs-mobile
docFullPath: https://www.dynamsoft.com/label-recognition/docs/mobile/
firstLevelUrl: /label-recognition/docs/mobile/
docHomePage: /label-recognition/docs/mobile/introduction/
needSearchIndex: true
searchNeedFilter: true

enumerations: /label-recognition/docs/core/parameters/enum/
parameters-reference: /label-recognition/docs/core/parameters/reference/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `BufferedCharacterItemSet` class represents the buffered characters and the

*Namespace:* com.dynamsoft.dlr

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class BufferedCharacterItemSet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `BufferedCharacterItem` class represents a buffered character.

*Namespace:* com.dynamsoft.dlr

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class BufferedCharacterItem
Expand Down
2 changes: 1 addition & 1 deletion programming/android/api-reference/character-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `CharacterCluster` class represents the character clustering result. Each `C

*Namespace:* com.dynamsoft.dlr

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class CharacterCluster
Expand Down
93 changes: 93 additions & 0 deletions programming/android/api-reference/character-result-v2.6.1003.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
layout: default-layout
title: CharacterResult - Dynamsoft Label Recognizer Android Edition
description: The class CharacterResult of Dynamsoft Label Recognizer Android edition represents the result of a character recognition process.
keywords: Character result
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
breadcrumbText: CharacterResult
permalink: /programming/android/api-reference/character-result.html
---

# CharacterResult

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.

## Definition

*Namespace:* com.dynamsoft.dlr

*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class CharacterResult
```

## Methods

| Method | Description |
| ------ | ----------- |
| [`getCharacterH`](#getcharacterh) | Returns the highest confidence character recognized. |
| [`getCharacterM`](#getcharacterm) | Returns the medium confidence character recognized. |
| [`getCharacterL`](#getcharacterl) | Returns the lowest confidence character recognized. |
| [`getLocation`](#getlocation) | Returns the location of the recognized character within the image. |
| [`getCharacterHConfidence`](#getcharacterhconfidence) | Returns the confidence score for the highest confidence character. |
| [`getCharacterMConfidence`](#getcharactermconfidence) | Returns the confidence score for the medium confidence character. |
| [`getCharacterLConfidence`](#getcharacterlconfidence) | Returns the confidence score for the lowest confidence character. |

### getCharacterH

Returns the highest confidence character recognized.

```java
char getCharacterH();
```

### getCharacterM

Returns the medium confidence character recognized.

```java
char getCharacterM();
```

### getCharacterL

Returns the lowest confidence character recognized.

```java
char getCharacterL();
```

### getLocation

Returns the location of the recognized character within the image.

```java
Quadrilateral getLocation();
```

### getCharacterHConfidence

Returns the confidence score for the highest confidence character.

```java
int getCharacterHConfidence();
```

### getCharacterMConfidence

Returns the confidence score for the medium confidence character.

```java
int characterMConfidence();
```

### getCharacterLConfidence

Returns the confidence score for the lowest confidence character.

```java
int characterLConfidence();
```
77 changes: 75 additions & 2 deletions programming/android/api-reference/character-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `CharacterResult` class represents the result of a character recognition pro

*Namespace:* com.dynamsoft.dlr

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class CharacterResult
Expand All @@ -28,13 +28,30 @@ class CharacterResult

| Method | Description |
| ------ | ----------- |
| [`CharacterResult`](#characterresult) | The constructor. |
| [`getCharacterH`](#getcharacterh) | Returns the highest confidence character recognized. |
| [`setCharacterH`](#setcharacterh) | Sets the highest confidence character recognized. |
| [`getCharacterM`](#getcharacterm) | Returns the medium confidence character recognized. |
| [`setCharacterM`](#setcharacterm) | Sets the medium confidence character recognized. |
| [`getCharacterL`](#getcharacterl) | Returns the lowest confidence character recognized. |
| [`getLocation`](#getlocation) | Returns the location of the recognized character within the image. |
| [`setCharacterL`](#setcharacterl) | Sets the lowest confidence character recognized. |
| [`getLocation`](#getlocation) | Returns the location of the recognized character within the image. |
| [`setLocation`](#setlocation) | Sets the location of the recognized character within the image. |
| [`getCharacterHConfidence`](#getcharacterhconfidence) | Returns the confidence score for the highest confidence character. |
| [`setCharacterHConfidence`](#setcharacterhconfidence) | Sets the confidence score for the highest confidence character. |
| [`getCharacterMConfidence`](#getcharactermconfidence) | Returns the confidence score for the medium confidence character. |
| [`setCharacterMConfidence`](#setcharactermconfidence) | Sets the confidence score for the medium confidence character. |
| [`getCharacterLConfidence`](#getcharacterlconfidence) | Returns the confidence score for the lowest confidence character. |
| [`setCharacterLConfidence`](#setcharacterlconfidence) | Sets the confidence score for the lowest confidence character. |

### CharacterResult

The constructor.


```java
CharacterResult(char characterH, char characterM, char characterL, int characterHConfidence, int characterMConfidence, int characterLConfidence, Quadrilateral location);
```

### getCharacterH

Expand All @@ -44,6 +61,14 @@ Returns the highest confidence character recognized.
char getCharacterH();
```

### setCharacterH

Sets the highest confidence character recognized.

```java
setCharacterH(char characterH);
```

### getCharacterM

Returns the medium confidence character recognized.
Expand All @@ -52,6 +77,14 @@ Returns the medium confidence character recognized.
char getCharacterM();
```

### setCharacterM

Sets the medium confidence character recognized.

```java
setCharacterM(char characterM);
```

### getCharacterL

Returns the lowest confidence character recognized.
Expand All @@ -60,6 +93,14 @@ Returns the lowest confidence character recognized.
char getCharacterL();
```

### setCharacterL

Sets the lowest confidence character recognized.

```java
setCharacterL(char characterL);
```

### getLocation

Returns the location of the recognized character within the image.
Expand All @@ -68,6 +109,14 @@ Returns the location of the recognized character within the image.
Quadrilateral getLocation();
```

### setLocation

Sets the location of the recognized character within the image.

```java
setLocation(Quadrilateral location);
```

### getCharacterHConfidence

Returns the confidence score for the highest confidence character.
Expand All @@ -76,6 +125,14 @@ Returns the confidence score for the highest confidence character.
int getCharacterHConfidence();
```

### setCharacterHConfidence

Sets the confidence score for the highest confidence character.

```java
setCharacterHConfidence(int characterHConfidence);
```

### getCharacterMConfidence

Returns the confidence score for the medium confidence character.
Expand All @@ -84,10 +141,26 @@ Returns the confidence score for the medium confidence character.
int characterMConfidence();
```

### setCharacterMConfidence

Sets the confidence score for the medium confidence character.

```java
setCharacterMConfidence(int characterMConfidence);
```

### getCharacterLConfidence

Returns the confidence score for the lowest confidence character.

```java
int characterLConfidence();
```

### setCharacterLConfidence

Sets the confidence score for the lowest confidence character.

```java
setCharacterLConfidence(int characterLConfidence);
```
28 changes: 28 additions & 0 deletions programming/android/api-reference/enum/raw-text-line-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: default-layout
title: RawTextLineStatus - Dynamsoft LabelRecognizer Enumerations
description: The enumeration RawTextLineStatus of Dynamsoft LabelRecognizer describes the final status of a raw text line.
keywords: Raw Text Line Status
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
breadcrumbText: RawTextLineStatus
codeAutoHeight: true
---

# Enumeration RawTextLineStatus

`RawTextLineStatus` enumerates the final status of a raw text line.

```java
@IntDef({})
@Retention(RetentionPolicy.CLASS)
public @interface EnumRawTextLineStatus {
/** Localized but recognition not performed. */
public static final int RTLS_LOCALIZED = 0;
/** Recognition failed. */
public static final int RTLS_RECOGNITION_FAILED = 1;
/** Successfully recognized. */
public static final int RTLS_RECOGNITION_SUCCEEDED = 2;
} EnumRawTextLineStatus;
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `LabelRecognizerModule` class defines general functions of the `DynamsoftLab

*Namespace:* com.dynamsoft.dlr

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class LabelRecognizerModule
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `LocalizedTextLineElement` class represents a localized text line element. I

*Namespace:* com.dynamsoft.dlr.intermediate_results

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class LocalizedTextLineElement extends RegionObjectElement
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `LocalizedTextLinesUnit` class represents a unit that contains localized tex

*Namespace:* com.dynamsoft.dlr.intermediate_results

*Assembly:* DynamsoftLabelRecognizer.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class LocalizedTextLinesUnit extends IntermediateResultUnit
Expand Down
Loading