|
| 1 | +--- |
| 2 | +layout: default-layout |
| 3 | +title: class CAuxiliaryRegionElement - Dynamsoft Core Module C++ Edition API Reference |
| 4 | +description: This page shows the C++ edition of the class CAuxiliaryRegionElement in Dynamsoft Core Module. |
| 5 | +keywords: auxiliary region element, c++ |
| 6 | +--- |
| 7 | + |
| 8 | +# CAuxiliaryRegionElement |
| 9 | + |
| 10 | +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. |
| 11 | + |
| 12 | +**Remarks** |
| 13 | + |
| 14 | +Introduced in Dynamsoft Capture Vision version 3.4.1000. |
| 15 | + |
| 16 | +## Definition |
| 17 | + |
| 18 | +*Namespace:* dynamsoft::intermediate_results |
| 19 | + |
| 20 | +*Assembly:* DynamsoftCore |
| 21 | + |
| 22 | +*Inheritance:* [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html) -> CAuxiliaryRegionElement |
| 23 | + |
| 24 | +```cpp |
| 25 | +class CAuxiliaryRegionElement : public CRegionObjectElement |
| 26 | +``` |
| 27 | +
|
| 28 | +## Methods |
| 29 | +
|
| 30 | +| Method | Description | |
| 31 | +|----------------------|-------------| |
| 32 | +| [`GetName`](#getname) | Gets the name of this auxiliary region. | |
| 33 | +| [`GetConfidence`](#getconfidence) | Gets the confidence level of this auxiliary region detection. | |
| 34 | +| [`SetName`](#setname) | Sets the name of this auxiliary region. | |
| 35 | +| [`SetLocation`](#setlocation) | Sets the location of this auxiliary region. | |
| 36 | +| [`SetConfidence`](#setconfidence) | Sets the confidence level of this auxiliary region detection. | |
| 37 | +| **Methods Inherited from [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html):** | | |
| 38 | +| [`GetLocation`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object element. | |
| 39 | +| [`GetReferencedElement`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets a pointer to a referenced region object element. | |
| 40 | +| [`GetElementType`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getelementtype) | Gets the type of the region object element. | |
| 41 | +| [`GetImageData`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the imageData of the region object element. | |
| 42 | +| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#clone) | Clone the region object element. | |
| 43 | +| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#retain) | Increases the reference count of the `CRegionObjectElement` object. | |
| 44 | +| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#release) | Decreases the reference count of the `CRegionObjectElement` object. | |
| 45 | +
|
| 46 | +### GetName |
| 47 | +
|
| 48 | +Gets the name of this auxiliary region. |
| 49 | +
|
| 50 | +```cpp |
| 51 | +virtual const char* GetName() const = 0; |
| 52 | +``` |
| 53 | + |
| 54 | +**Return value** |
| 55 | + |
| 56 | +Returns a string representing the region name (e.g., "MRZ", "PortraitZone", "SignatureArea"). |
| 57 | + |
| 58 | +### GetConfidence |
| 59 | + |
| 60 | +Gets the confidence level of this auxiliary region detection. |
| 61 | + |
| 62 | +```cpp |
| 63 | +virtual int GetConfidence() const = 0; |
| 64 | +``` |
| 65 | + |
| 66 | +**Return value** |
| 67 | + |
| 68 | +Returns the confidence value, typically in the range [0, 100]. |
| 69 | + |
| 70 | +### SetName |
| 71 | + |
| 72 | +Sets the name of this auxiliary region. |
| 73 | + |
| 74 | +```cpp |
| 75 | +virtual void SetName(const char* name) = 0; |
| 76 | +``` |
| 77 | +
|
| 78 | +**Parameters** |
| 79 | +
|
| 80 | +`[in] name` The region name to set (e.g., "MRZ", "PortraitZone", "SignatureArea"). |
| 81 | +
|
| 82 | +### SetLocation |
| 83 | +
|
| 84 | +Sets the location of this auxiliary region. |
| 85 | +
|
| 86 | +```cpp |
| 87 | +virtual int SetLocation(const CQuadrilateral& location) = 0; |
| 88 | +``` |
| 89 | + |
| 90 | +**Parameters** |
| 91 | + |
| 92 | +`[in] location` A `CQuadrilateral` object defining the region boundaries. |
| 93 | + |
| 94 | +**Return value** |
| 95 | + |
| 96 | +Returns 0 if successful, otherwise returns an error code. |
| 97 | + |
| 98 | +**See Also** |
| 99 | + |
| 100 | +[CQuadrilateral]({{ site.dcvb_cpp_api }}core/basic-structures/quadrilateral.html) |
| 101 | + |
| 102 | +### SetConfidence |
| 103 | + |
| 104 | +Sets the confidence level of this auxiliary region detection. |
| 105 | + |
| 106 | +```cpp |
| 107 | +virtual void SetConfidence(int confidence) = 0; |
| 108 | +``` |
| 109 | +
|
| 110 | +**Parameters** |
| 111 | +
|
| 112 | +`[in] confidence` The confidence value to set, typically in the range [0, 100]. |
0 commit comments