Skip to content

Commit 2204a47

Browse files
Merge pull request #39 from dynamsoft-docs/preview
update to internal commit 0c64d00c
2 parents 47f3c1b + 8f308c9 commit 2204a47

14 files changed

+892
-9
lines changed

programming/python/api-reference/buffered-character-item-set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `BufferedCharacterItemSet` class represents a collection of buffered charact
1717
*Module:* dynamsoft_label_recognizer
1818

1919
```python
20-
class BufferedCharacterItemSet(object)
20+
class BufferedCharacterItemSet
2121
```
2222

2323
## Methods

programming/python/api-reference/buffered-character-item.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `BufferedCharacterItem` class represents a text line result item recognized
1717
*Module:* dynamsoft_label_recognizer
1818

1919
```python
20-
class BufferedCharacterItem(object)
20+
class BufferedCharacterItem
2121
```
2222

2323
## Methods

programming/python/api-reference/character-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `CharacterCluster` class represents a character cluster generated from the b
1717
*Module:* dynamsoft_label_recognizer
1818

1919
```python
20-
class CharacterCluster(object)
20+
class CharacterCluster
2121
```
2222

2323
## Properties

programming/python/api-reference/character-result.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `CharacterResult` class represents the result of a character recognition pro
1717
*Module:* dynamsoft_label_recognizer
1818

1919
```python
20-
class CharacterResult(object)
20+
class CharacterResult
2121
```
2222

2323
## Properties

programming/python/api-reference/label-recognizer-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `LabelRecognizerModule` class defines general functions in the label recogni
1616
*Module:* dynamsoft_label_recognizer
1717

1818
```python
19-
class LabelRecognizerModule(object)
19+
class LabelRecognizerModule
2020
```
2121

2222
## Methods
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
layout: default-layout
3+
title: LocalizedTextLineElement - Dynamsoft Label Recognizer Classes
4+
description: The class LocalizedTextLineElement of Dynamsoft Label Recognizer represents a localized text line element.
5+
keywords: Localized text line element
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# LocalizedTextLineElement
12+
13+
The `LocalizedTextLineElement` class represents a localized text line element. It inherits from the `RegionObjectElement` class.
14+
15+
## Definition
16+
17+
*Module:* dynamsoft_label_recognizer
18+
19+
```cpp
20+
class LocalizedTextLineElement(RegionObjectElement)
21+
```
22+
23+
*Inheritance:* [RegionObjectElement]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -> LocalizedTextLineElement
24+
25+
## Methods
26+
27+
| Method | Description |
28+
|----------------------|-------------|
29+
| [`__init__`](#__init__) | Initializes a new instance of the `LocalizedTextLineElement` class. |
30+
| [`get_character_quads_count`](#get_character_quads_count) | Gets the number of character quads in the text line.|
31+
| [`get_character_quad`](#get_character_quad) | Gets the quadrilateral of a specific character in the text line. |
32+
| [`get_row_number`](#get_row_number) | Gets the row number of the text line. |
33+
34+
### \_\_init\_\_
35+
36+
Initializes a new instance of the `LocalizedTextLineElement` class.
37+
38+
```python
39+
def __init__(self, *args, **kwargs):
40+
```
41+
42+
### get_character_quads_count
43+
44+
Gets the number of character quads in the text line.
45+
46+
```cpp
47+
def get_character_quads_count(self) -> int:
48+
```
49+
50+
**Return value**
51+
52+
Returns the number of character quads in the text line.
53+
54+
### get_character_quad
55+
56+
Gets the quadrilateral of a specific character in the text line.
57+
58+
```cpp
59+
def get_character_quad(self, index: int) -> Tuple[int, Quadrilateral]:
60+
```
61+
62+
**Parameters**
63+
64+
`index` The index of the character.
65+
66+
**Return value**
67+
68+
Returns a tuple containing following elements:
69+
- `error_code` <*int*>: The error code indicating the status of the operation.
70+
- `quad` <*Quadrilateral*>: The quadrilateral of the character.
71+
72+
### get_row_number
73+
74+
Gets the row number of the text line.
75+
76+
```cpp
77+
def get_row_number(self) -> int:
78+
```
79+
80+
**Return value**
81+
82+
Returns the row number of the text line.
Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
layout: default-layout
3+
title: LocalizedTextLinesUnit - Dynamsoft Label Recognizer Classes
4+
description: The class LocalizedTextLinesUnit of Dynamsoft Label Recognizer represents a unit that contains localized text lines.
5+
keywords: Localized text lines unit
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# LocalizedTextLinesUnit
12+
13+
The `LocalizedTextLinesUnit` class represents a unit that contains localized text lines. It inherits from the `IntermediateResultUnit` class.
14+
15+
## Definition
16+
17+
*Module:* dynamsoft_label_recognizer
18+
19+
```python
20+
class LocalizedTextLinesUnit(IntermediateResultUnit)
21+
```
22+
23+
*Inheritance:* [IntermediateResultUnit]({{ site.dcv_python_api }}core/intermediate-results/intermediate-result-unit.html) -> LocalizedTextLinesUnit
24+
25+
## Methods
26+
27+
| Method | Description |
28+
|-----------------------------------|-------------|
29+
| [`get_count`](#get_count) | Gets the number of localized text lines in the unit.|
30+
| [`get_localized_text_line`](#get_localized_text_line) | Gets a localized text line element.|
31+
| [`remove_all_localized_text_lines`](#remove_all_localized_text_lines) | Removes all localized text lines.|
32+
| [`remove_localized_text_line`](#remove_localized_text_line) | Removes the localized text line at the specified index.|
33+
| [`add_localized_text_line`](#add_localized_text_line) | Adds a localized text line.|
34+
| [`set_localized_text_line`](#set_localized_text_line) | Sets the localized text line at the specified index.|
35+
36+
### get_count
37+
38+
Gets the number of localized text lines in the unit.
39+
40+
```python
41+
def get_count(self) -> int:
42+
```
43+
44+
**Return value**
45+
46+
Returns the number of localized text lines in the unit.
47+
48+
### get_localized_text_line
49+
50+
Gets a localized text line element.
51+
52+
```python
53+
def get_localized_text_line(self, index: int) -> LocalizedTextLineElement:
54+
```
55+
56+
**Parameters**
57+
58+
`index` The index of the localized text line element to retrieve.
59+
60+
**Return value**
61+
62+
Returns the localized text line element at the specified index.
63+
64+
**See Also**
65+
66+
[LocalizedTextLineElement]({{ site.dlr_python_api }}localized-text-line-element.html)
67+
68+
### remove_all_localized_text_lines
69+
70+
Removes all localized text lines.
71+
72+
```python
73+
def remove_all_localized_text_lines(self) -> None:
74+
```
75+
76+
### remove_localized_text_line
77+
78+
Removes the localized text line at the specified index.
79+
80+
```python
81+
def remove_localized_text_line(self, index: int) -> int:
82+
```
83+
84+
**Parameters**
85+
86+
`index` The index of the localized text line to remove.
87+
88+
**Return value**
89+
90+
Returns 0 if successful, otherwise returns a negative value.
91+
92+
### add_localized_text_line
93+
94+
Adds a localized text line.
95+
96+
```python
97+
def add_localized_text_line(self, element: LocalizedTextLineElement, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int:
98+
```
99+
100+
**Parameters**
101+
102+
`element` The localized text line element to add.
103+
104+
`matrix_to_original_image` The matrix to original image.
105+
106+
**Return value**
107+
108+
Returns 0 if successful, otherwise returns a negative value.
109+
110+
**See Also**
111+
112+
[LocalizedTextLineElement]({{ site.dlr_python_api }}localized-text-line-element.html)
113+
114+
### set_localized_text_line
115+
116+
Sets the localized text line at the specified index.
117+
118+
```python
119+
def set_localized_text_line(self, index: int, element: LocalizedTextLineElement, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int:
120+
```
121+
122+
**Parameters**
123+
124+
`index` The index of the localized text line to set.
125+
126+
`element` The localized text line element to set.
127+
128+
`matrix_to_original_image` The matrix to original image.
129+
130+
**Return value**
131+
132+
Returns 0 if successful, otherwise returns a negative value.
133+
134+
**See Also**
135+
136+
[LocalizedTextLineElement]({{ site.dlr_python_api }}localized-text-line-element.html)

0 commit comments

Comments
 (0)