Back to Adaptive Vision Library website
You are here: Start » Function Reference » Region Relations » GetMaximumRegion
GetMaximumRegion
Returns the region from the input array that corresponds to the largest computed feature value.
Syntax
C++
C#
void avl::GetMaximumRegion ( const atl::Array<avl::Region>& inRegions, avl::RegionFeature::Type inFeature, avl::Region& outRegion, atl::Optional<float&> outValue = atl::NIL, atl::Optional<int&> outIndex = atl::NIL )
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
 |
inRegions | const Array<Region>& | Input regions | |
|
inFeature | RegionFeature::Type | Region feature value to be computed | |
 |
outRegion | Region& | Output region | |
|
outValue | Optional<float&> | NIL | Computed feature value of the output region |
|
outIndex | Optional<int&> | NIL |
Description
The filter computes the selected feature value for every input region and returns the one for which value is the largest.
Examples
 |
 |
GetMaximumRegion performed with Area as the selected region feature.
Errors
| Error type | Description |
|---|---|
| DomainError | Empty region array on input in GetMaximumRegion. |
