Back to Adaptive Vision Library website

You are here: Start » Function Reference » Region Relations » GetMinimumRegion

GetMinimumRegion


Header:AVL.h
Namespace:avl

Returns the region from the input array that corresponds to the smallest computed feature value.

Syntax

C++
C#
 
void avl::GetMinimumRegion
(
	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

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outValue, outIndex.

Read more about Optional Outputs.

Description

The filter computes the selected feature value for every input region and returns the one for which value is the smallest.

Examples

GetMinimumRegion performed with Area as the selected region feature.

Errors

List of possible exceptions:

Error type Description
DomainError Empty region array on input in GetMinimumRegion.

See Also

  • ClassifyRegions – Splits an array of regions according to the selected feature and range.
  • GetMaximumRegion – Returns the region from the input array that corresponds to the largest computed feature value.
  • SortRegions – Changes the order of regions from the input array accordingly to an ascending/descending sequence of their computed feature values.