Skip to content

Commit 2a088ac

Browse files
fix module name and updates for v3.4.1000
1 parent fc10377 commit 2a088ac

16 files changed

+490
-16
lines changed

programming/cplusplus/api-reference/localized-text-lines-unit.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ class CLocalizedTextLinesUnit : public CIntermediateResultUnit
3636
| [`RemoveLocalizedTextLine`](#removelocalizedtextline) | Removes the localized text line at the specified index.|
3737
| [`AddLocalizedTextLine`](#addlocalizedtextline) | Adds a localized text line.|
3838
| [`SetLocalizedTextLine`](#setlocalizedtextline) | Sets the localized text line at the specified index.|
39+
| [`GetAuxiliaryRegionElementsCount`](#getauxiliaryregionelementscount) | Gets the count of auxiliary region elements in this unit.|
40+
| [`GetAuxiliaryRegionElement`](#getauxiliaryregionelement) | Gets the auxiliary region element at the specified index.|
41+
| [`SetAuxiliaryRegionElement`](#setauxiliaryregionelement) | Sets or replaces the auxiliary region element at the specified index.|
42+
| [`AddAuxiliaryRegionElement`](#addauxiliaryregionelement) | Adds a new auxiliary region element to this unit.|
43+
| [`RemoveAuxiliaryRegionElement`](#removeauxiliaryregionelement) | Removes the auxiliary region element at the specified index.|
44+
| [`RemoveAllAuxiliaryRegionElements`](#removeallauxiliaryregionelements) | Removes all auxiliary region elements from this unit.|
3945
| **Methods Inherited from [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html):** | |
4046
| [`GetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Gets the hash ID of the unit.|
4147
| [`GetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Gets the hash ID of the original image. |
@@ -155,3 +161,122 @@ virtual int SetLocalizedTextLine(int index, const CLocalizedTextLineElement* ele
155161
**Return value**
156162
157163
Returns 0 if successful, otherwise returns a negative value.
164+
165+
### GetAuxiliaryRegionElementsCount
166+
167+
Gets the count of auxiliary region elements in this unit.
168+
169+
```cpp
170+
virtual int GetAuxiliaryRegionElementsCount() const = 0;
171+
```
172+
173+
**Return value**
174+
175+
Returns the number of auxiliary region elements.
176+
177+
**Remarks**
178+
179+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
180+
181+
### GetAuxiliaryRegionElement
182+
183+
Gets the auxiliary region element at the specified index.
184+
185+
```cpp
186+
virtual const CAuxiliaryRegionElement* GetAuxiliaryRegionElement(int index) const = 0;
187+
```
188+
189+
**Parameters**
190+
191+
`[in] index` The zero-based index of the auxiliary region element to retrieve.
192+
193+
**Return value**
194+
195+
Returns a pointer to the `CAuxiliaryRegionElement` object, or NULL if the index is out of range.
196+
197+
**See Also**
198+
199+
[CAuxiliaryRegionElement]({{ site.dcvb_cpp_api }}core/intermediate-results/auxiliary-region-element.html)
200+
201+
**Remarks**
202+
203+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
204+
205+
### SetAuxiliaryRegionElement
206+
207+
Sets or replaces the auxiliary region element at the specified index.
208+
209+
```cpp
210+
virtual int SetAuxiliaryRegionElement(int index, const CAuxiliaryRegionElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
211+
```
212+
213+
**Parameters**
214+
215+
`[in] index` The zero-based index where the element should be set.
216+
217+
`[in] element` The auxiliary region element to set.
218+
219+
`[in] matrixToOriginalImage` The transformation matrix from the current image to the original image.
220+
221+
**Return value**
222+
223+
Returns 0 if successful, otherwise returns an error code.
224+
225+
**Remarks**
226+
227+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
228+
229+
### AddAuxiliaryRegionElement
230+
231+
Adds a new auxiliary region element to this unit.
232+
233+
```cpp
234+
virtual int AddAuxiliaryRegionElement(const CAuxiliaryRegionElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
235+
```
236+
237+
**Parameters**
238+
239+
`[in] element` The auxiliary region element to add.
240+
241+
`[in] matrixToOriginalImage` The transformation matrix from the current image to the original image.
242+
243+
**Return value**
244+
245+
Returns 0 if successful, otherwise returns an error code.
246+
247+
**Remarks**
248+
249+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
250+
251+
### RemoveAuxiliaryRegionElement
252+
253+
Removes the auxiliary region element at the specified index.
254+
255+
```cpp
256+
virtual int RemoveAuxiliaryRegionElement(int index) = 0;
257+
```
258+
259+
**Parameters**
260+
261+
`[in] index` The zero-based index of the auxiliary region element to remove.
262+
263+
**Return value**
264+
265+
Returns 0 if successful, otherwise returns an error code.
266+
267+
**Remarks**
268+
269+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
270+
271+
### RemoveAllAuxiliaryRegionElements
272+
273+
Removes all auxiliary region elements from this unit.
274+
275+
```cpp
276+
virtual void RemoveAllAuxiliaryRegionElements() = 0;
277+
```
278+
279+
**Remarks**
280+
281+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
282+

programming/dotnet/api-reference/localized-text-lines-unit.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ class LocalizedTextLinesUnit : IntermediateResultUnit, IEnumerable<LocalizedText
3434
| [`RemoveLocalizedTextLine`](#removelocalizedtextline) | Removes the localized text line at the specified index.|
3535
| [`AddLocalizedTextLine`](#addlocalizedtextline) | Adds a localized text line.|
3636
| [`SetLocalizedTextLine`](#setlocalizedtextline) | Sets the localized text line at the specified index.|
37+
| [`GetAuxiliaryRegionElements`](#getauxiliaryregionelements) | Gets all auxiliary region elements. |
38+
| [`SetAuxiliaryRegionElement`](#setauxiliaryregionelement) | Sets the auxiliary region element at the specified index. |
39+
| [`AddAuxiliaryRegionElement`](#addauxiliaryregionelement) | Adds a new auxiliary region element to this unit. |
40+
| [`RemoveAuxiliaryRegionElement`](#removeauxiliaryregionelement) | Removes the auxiliary region element at the specified index. |
41+
| [`RemoveAllAuxiliaryRegionElements`](#removeallauxiliaryregionelements) | Removes all auxiliary region elements from this unit. |
3742

3843
### GetCount
3944

@@ -152,3 +157,110 @@ Returns 0 if successful, otherwise returns a negative value.
152157
**See Also**
153158

154159
[LocalizedTextLineElement]({{ site.dlr_dotnet_api }}localized-text-line-element.html)
160+
161+
### GetAuxiliaryRegionElements
162+
163+
Gets all auxiliary region elements.
164+
165+
```csharp
166+
AuxiliaryRegionElement[] GetAuxiliaryRegionElements()
167+
```
168+
169+
**Return value**
170+
171+
Returns an array of `AuxiliaryRegionElement` objects.
172+
173+
**See Also**
174+
175+
[AuxiliaryRegionElement]({{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html)
176+
177+
**Remarks**
178+
179+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
180+
181+
### SetAuxiliaryRegionElement
182+
183+
Sets or replaces the auxiliary region element at the specified index.
184+
185+
```csharp
186+
int SetAuxiliaryRegionElement(int index, AuxiliaryRegionElement element, double[] matrixToOriginalImage)
187+
```
188+
189+
**Parameters**
190+
191+
`[in] index` The zero-based index where the element should be set.
192+
193+
`[in] element` The auxiliary region element to set.
194+
195+
`[in] matrixToOriginalImage` The transformation matrix from the current image to the original image.
196+
197+
**Return value**
198+
199+
Returns 0 if successful, otherwise returns a negative value.
200+
201+
**See Also**
202+
203+
[AuxiliaryRegionElement]({{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html)
204+
205+
**Remarks**
206+
207+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
208+
209+
### AddAuxiliaryRegionElement
210+
211+
Adds a new auxiliary region element to this unit.
212+
213+
```csharp
214+
int AddAuxiliaryRegionElement(AuxiliaryRegionElement element, double[] matrixToOriginalImage)
215+
```
216+
217+
**Parameters**
218+
219+
`[in] element` The auxiliary region element to add.
220+
221+
`[in] matrixToOriginalImage` The transformation matrix from the current image to the original image.
222+
223+
**Return value**
224+
225+
Returns 0 if successful, otherwise returns a negative value.
226+
227+
**See Also**
228+
229+
[AuxiliaryRegionElement]({{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html)
230+
231+
**Remarks**
232+
233+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
234+
235+
### RemoveAuxiliaryRegionElement
236+
237+
Removes the auxiliary region element at the specified index.
238+
239+
```csharp
240+
int RemoveAuxiliaryRegionElement(int index)
241+
```
242+
243+
**Parameters**
244+
245+
`[in] index` The zero-based index of the auxiliary region element to remove.
246+
247+
**Return value**
248+
249+
Returns 0 if successful, otherwise returns a negative value.
250+
251+
**Remarks**
252+
253+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
254+
255+
### RemoveAllAuxiliaryRegionElements
256+
257+
Removes all auxiliary region elements from this unit.
258+
259+
```csharp
260+
void RemoveAllAuxiliaryRegionElements()
261+
```
262+
263+
**Remarks**
264+
265+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
266+

programming/java/api-reference/localized-text-lines-unit.md

Lines changed: 107 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ public class LocalizedTextLinesUnit extends IntermediateResultUnit
3030
| [`removeLocalizedTextLine`](#removelocalizedtextline) | Removes the localized text line at the specified index.|
3131
| [`addLocalizedTextLine`](#addlocalizedtextline) | Adds a localized text line.|
3232
| [`setLocalizedTextLine`](#setlocalizedtextline) | Sets the localized text line at the specified index.|
33+
| [`getAuxiliaryRegionElements`](#getauxiliaryregionelements) | Gets all auxiliary region elements. |
34+
| [`setAuxiliaryRegionElement`](#setauxiliaryregionelement) | Sets the auxiliary region element at the specified index. |
35+
| [`addAuxiliaryRegionElement`](#addauxiliaryregionelement) | Adds a new auxiliary region element to this unit. |
36+
| [`removeAuxiliaryRegionElement`](#removeauxiliaryregionelement) | Removes the auxiliary region element at the specified index. |
37+
| [`removeAllAuxiliaryRegionElements`](#removeallauxiliaryregionelements) | Removes all auxiliary region elements from this unit. |
3338

3439
### getCount
3540

@@ -148,12 +153,111 @@ public void setLocalizedTextLine(int index, LocalizedTextLineElement element, do
148153

149154
[LocalizedTextLineElement]({{ site.dlr_java_api }}localized-text-line-element.html)
150155

151-
`matrix_to_original_image` The matrix to original image.
156+
### getAuxiliaryRegionElements
157+
158+
Gets all auxiliary region elements.
159+
160+
```java
161+
public AuxiliaryRegionElement[] getAuxiliaryRegionElements()
162+
```
152163

153164
**Return value**
154165

155-
Returns 0 if successful, otherwise returns a negative value.
166+
Returns an array of `AuxiliaryRegionElement` objects.
156167

157168
**See Also**
158169

159-
[LocalizedTextLineElement]({{ site.dlr_java_api }}localized-text-line-element.html)
170+
[AuxiliaryRegionElement]({{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html)
171+
172+
**Remarks**
173+
174+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
175+
176+
### setAuxiliaryRegionElement
177+
178+
Sets or replaces the auxiliary region element at the specified index.
179+
180+
```java
181+
public void setAuxiliaryRegionElement(int index, AuxiliaryRegionElement element) throws LabelRecognizerException
182+
public void setAuxiliaryRegionElement(int index, AuxiliaryRegionElement element, double[] matrixToOriginalImage) throws LabelRecognizerException
183+
```
184+
185+
**Parameters**
186+
187+
`index` The zero-based index where the element should be set.
188+
189+
`element` The auxiliary region element to set.
190+
191+
`matrixToOriginalImage` The transformation matrix from the current image to the original image (optional).
192+
193+
**Exceptions**
194+
195+
[`LabelRecognizerException`]({{ site.dlr_java_api }}label-recognizer-exception.html)
196+
197+
**See Also**
198+
199+
[AuxiliaryRegionElement]({{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html)
200+
201+
**Remarks**
202+
203+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
204+
205+
### addAuxiliaryRegionElement
206+
207+
Adds a new auxiliary region element to this unit.
208+
209+
```java
210+
public void addAuxiliaryRegionElement(AuxiliaryRegionElement element) throws LabelRecognizerException
211+
public void addAuxiliaryRegionElement(AuxiliaryRegionElement element, double[] matrixToOriginalImage) throws LabelRecognizerException
212+
```
213+
214+
**Parameters**
215+
216+
`element` The auxiliary region element to add.
217+
218+
`matrixToOriginalImage` The transformation matrix from the current image to the original image (optional).
219+
220+
**Exceptions**
221+
222+
[`LabelRecognizerException`]({{ site.dlr_java_api }}label-recognizer-exception.html)
223+
224+
**See Also**
225+
226+
[AuxiliaryRegionElement]({{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html)
227+
228+
**Remarks**
229+
230+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
231+
232+
### removeAuxiliaryRegionElement
233+
234+
Removes the auxiliary region element at the specified index.
235+
236+
```java
237+
public void removeAuxiliaryRegionElement(int index) throws LabelRecognizerException
238+
```
239+
240+
**Parameters**
241+
242+
`index` The zero-based index of the auxiliary region element to remove.
243+
244+
**Exceptions**
245+
246+
[`LabelRecognizerException`]({{ site.dlr_java_api }}label-recognizer-exception.html)
247+
248+
**Remarks**
249+
250+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
251+
252+
### removeAllAuxiliaryRegionElements
253+
254+
Removes all auxiliary region elements from this unit.
255+
256+
```java
257+
public void removeAllAuxiliaryRegionElements()
258+
```
259+
260+
**Remarks**
261+
262+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
263+

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The `BufferedCharacterItemSet` class represents a collection of buffered charact
1111

1212
## Definition
1313

14-
*Module:* dynamsoft_label_recognizer
14+
*Module:* dlr
1515

1616
```python
1717
class BufferedCharacterItemSet

0 commit comments

Comments
 (0)