CAuxiliaryRegionElement
The CAuxiliaryRegionElement class represents an auxiliary region element that contains additional region information detected during processing (e.g., MRZ, portrait zones, signature areas). It inherits from the CRegionObjectElement class.
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
Definition
Namespace: dynamsoft::intermediate_results
Assembly: DynamsoftCore
Inheritance: CRegionObjectElement -> CAuxiliaryRegionElement
class CAuxiliaryRegionElement : public CRegionObjectElement
Methods
| Method | Description |
|---|---|
GetName |
Gets the name of this auxiliary region. |
GetConfidence |
Gets the confidence level of this auxiliary region detection. |
SetName |
Sets the name of this auxiliary region. |
SetLocation |
Sets the location of this auxiliary region. |
SetConfidence |
Sets the confidence level of this auxiliary region detection. |
| Methods Inherited from CRegionObjectElement: | |
GetLocation |
Gets the location of the region object element. |
GetReferencedElement |
Gets a pointer to a referenced region object element. |
GetElementType |
Gets the type of the region object element. |
GetImageData |
Gets the imageData of the region object element. |
Clone |
Clone the region object element. |
Retain |
Increases the reference count of the CRegionObjectElement object. |
Release |
Decreases the reference count of the CRegionObjectElement object. |
GetName
Gets the name of this auxiliary region.
virtual const char* GetName() const = 0;
Return value
Returns a string representing the region name (e.g., “MRZ”, “PortraitZone”, “SignatureArea”).
GetConfidence
Gets the confidence level of this auxiliary region detection.
virtual int GetConfidence() const = 0;
Return value
Returns the confidence value, typically in the range [0, 100].
SetName
Sets the name of this auxiliary region.
virtual void SetName(const char* name) = 0;
Parameters
[in] name The region name to set (e.g., “MRZ”, “PortraitZone”, “SignatureArea”).
SetLocation
Sets the location of this auxiliary region.
virtual int SetLocation(const CQuadrilateral& location) = 0;
Parameters
[in] location A CQuadrilateral object defining the region boundaries.
Return value
Returns 0 if successful, otherwise returns an error code.
See Also
SetConfidence
Sets the confidence level of this auxiliary region detection.
virtual void SetConfidence(int confidence) = 0;
Parameters
[in] confidence The confidence value to set, typically in the range [0, 100].