AuxiliaryRegionElement
The AuxiliaryRegionElement 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 RegionObjectElement class.
Remarks
Introduced in Dynamsoft Capture Vision version 3.4.1000.
Definition
Module: core
Inheritance: RegionObjectElement -> AuxiliaryRegionElement
class AuxiliaryRegionElement(RegionObjectElement)
Methods
| Method | Description |
|---|---|
__init__ |
Initializes a new instance of the AuxiliaryRegionElement class. |
get_name |
Gets the name of this auxiliary region. |
get_confidence |
Gets the confidence level of this auxiliary region detection. |
set_name |
Sets the name of this auxiliary region. |
set_location |
Sets the location of this auxiliary region. |
set_confidence |
Sets the confidence level of this auxiliary region detection. |
| Methods Inherited from RegionObjectElement: | |
get_location |
Gets the location of the region object element. |
get_referenced_element |
Gets a referenced region object element. |
get_element_type |
Gets the type of the region object element. |
get_image_data |
Gets the imageData of the region object element. |
clone |
Clones the region object element. |
__init__
Initializes a new instance of the AuxiliaryRegionElement class.
def __init__(self):
get_name
Gets the name of this auxiliary region.
def get_name(self) -> str:
Return value
Returns a string representing the region name (e.g., “PortraitZone”, “SignatureArea”).
get_confidence
Gets the confidence level of this auxiliary region detection.
def get_confidence(self) -> int:
Return value
Returns the confidence value, typically in the range [0, 100].
set_name
Sets the name of this auxiliary region.
def set_name(self, name: str) -> None:
Parameters
name The region name to set (e.g., “PortraitZone”, “SignatureArea”).
set_location
Sets the location of this auxiliary region.
def set_location(self, location: Quadrilateral) -> int:
Parameters
location A Quadrilateral object defining the region boundaries.
Return value
Returns 0 if successful, otherwise returns an error code.
See Also
set_confidence
Sets the confidence level of this auxiliary region detection.
def set_confidence(self, confidence: int) -> None:
Parameters
confidence The confidence value to set, typically in the range [0, 100].
Yes
No