CLocalizedTextLinesUnit
The CLocalizedTextLinesUnit class represents a unit that contains localized text lines. It inherits from the CIntermediateResultUnit class.
Definition
Namespace: dynamsoft::dlr::intermediate_results
Assembly: DynamsoftLabelRecognizer
class CLocalizedTextLinesUnit : public CIntermediateResultUnit
Inheritance: CIntermediateResultUnit -> CLocalizedTextLinesUnit
Methods
| Method | Description |
|---|---|
GetCount |
Gets the number of localized text lines in the unit. |
GetLocalizedTextLine |
Gets a pointer to a specific localized text line element. |
operator[] |
Gets a pointer to a specific localized text line element. |
RemoveAllLocalizedTextLines |
Removes all localized text lines. |
RemoveLocalizedTextLine |
Removes the localized text line at the specified index. |
AddLocalizedTextLine |
Adds a localized text line. |
SetLocalizedTextLine |
Sets the localized text line at the specified index. |
GetAuxiliaryRegionElementsCount |
Gets the count of auxiliary region elements in this unit. |
GetAuxiliaryRegionElement |
Gets the auxiliary region element at the specified index. |
SetAuxiliaryRegionElement |
Sets or replaces the auxiliary region element at the specified index. |
AddAuxiliaryRegionElement |
Adds a new auxiliary region element to this unit. |
RemoveAuxiliaryRegionElement |
Removes the auxiliary region element at the specified index. |
RemoveAllAuxiliaryRegionElements |
Removes all auxiliary region elements from this unit. |
| Methods Inherited from CIntermediateResultUnit: | |
GetHashId |
Gets the hash ID of the unit. |
GetOriginalImageHashId |
Gets the hash ID of the original image. |
GetOriginalImageTag |
Gets the image tag of the original image. |
GetType |
Gets the type of the intermediate result unit. |
Clone |
Creates a copy of the intermediate result unit. |
SetHashId |
Sets the hash ID of the unit. |
SetOriginalImageHashId |
Sets the hash ID of the original image. |
SetOriginalImageTag |
Sets the image tag of the original image. |
Retain |
Increases the reference count of the unit. |
Release |
Decreases the reference count of the unit. |
GetTransformMatrix |
Gets the transformation matrix via TransformMatrixType. |
SetTransformMatrix |
Sets the transformation matrix via TransformMatrixType. |
GetCount
Gets the number of localized text lines in the unit.
virtual int GetCount() const = 0;
Return value
Returns the number of localized text lines in the unit.
GetLocalizedTextLine
Gets a pointer to a specific localized text line element.
virtual const CLocalizedTextLineElement* GetLocalizedTextLine(int index) const = 0;
Parameters
[in] index The index of the localized text line element to retrieve.
Return value
Returns a const pointer to the localized text line element at the specified index.
operator[]
Gets a pointer to a specific localized text line element.
virtual const CLocalizedTextLineElement* operator[](int index) const = 0;
Parameters
[in] index The index of the localized text line element to retrieve.
Return value
Returns a const pointer to the localized text line element at the specified index.
RemoveAllLocalizedTextLines
Removes all localized text lines.
virtual void RemoveAllLocalizedTextLines() = 0;
RemoveLocalizedTextLine
Removes the localized text line at the specified index.
virtual int RemoveLocalizedTextLine(int index) = 0;
Parameters
[in] index The index of the localized text line to remove.
Return value
Returns 0 if successful, otherwise returns a negative value.
AddLocalizedTextLine
Adds a localized text line.
virtual int AddLocalizedTextLine(const CLocalizedTextLineElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
Parameters
[in] element The localized text line element to add.
[in] matrixToOriginalImage The matrix to original image.
Return value
Returns 0 if successful, otherwise returns a negative value.
SetLocalizedTextLine
Sets the localized text line at the specified index.
virtual int SetLocalizedTextLine(int index, const CLocalizedTextLineElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
Parameters
[in] index The index of the localized text line to set.
[in] element The localized text line element to set.
[in] matrixToOriginalImage The matrix to original image.
Return value
Returns 0 if successful, otherwise returns a negative value.
GetAuxiliaryRegionElementsCount
Gets the count of auxiliary region elements in this unit.
virtual int GetAuxiliaryRegionElementsCount() const = 0;
Return value
Returns the number of auxiliary region elements.
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
GetAuxiliaryRegionElement
Gets the auxiliary region element at the specified index.
virtual const CAuxiliaryRegionElement* GetAuxiliaryRegionElement(int index) const = 0;
Parameters
[in] index The zero-based index of the auxiliary region element to retrieve.
Return value
Returns a pointer to the CAuxiliaryRegionElement object, or NULL if the index is out of range.
See Also
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
SetAuxiliaryRegionElement
Sets or replaces the auxiliary region element at the specified index.
virtual int SetAuxiliaryRegionElement(int index, const CAuxiliaryRegionElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
Parameters
[in] index The zero-based index where the element should be set.
[in] element The auxiliary region element to set.
[in] matrixToOriginalImage The transformation matrix from the current image to the original image.
Return value
Returns 0 if successful, otherwise returns an error code.
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
AddAuxiliaryRegionElement
Adds a new auxiliary region element to this unit.
virtual int AddAuxiliaryRegionElement(const CAuxiliaryRegionElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;
Parameters
[in] element The auxiliary region element to add.
[in] matrixToOriginalImage The transformation matrix from the current image to the original image.
Return value
Returns 0 if successful, otherwise returns an error code.
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
RemoveAuxiliaryRegionElement
Removes the auxiliary region element at the specified index.
virtual int RemoveAuxiliaryRegionElement(int index) = 0;
Parameters
[in] index The zero-based index of the auxiliary region element to remove.
Return value
Returns 0 if successful, otherwise returns an error code.
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
RemoveAllAuxiliaryRegionElements
Removes all auxiliary region elements from this unit.
virtual void RemoveAllAuxiliaryRegionElements() = 0;
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.