Start » Filter Reference » Region » Region Relations » GetMaximumRegion

GetMaximumRegion

Advanced

Module: FoundationBasic

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

Applications

Use this filter when you have an array of regions and you want to select one of them that best matches some criterion.
Name Type Description
Input value
 inRegions RegionArray Input regions
Input value
 inFeature RegionFeature Region feature value to be computed
Output value
 outRegion Region Output region
Output value
 outValue Real Computed feature value of the output region
Output value
 outIndex Integer

Description

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

Examples

Description of usage of this filter can be found in examples and tutorial: User Filter Example - Database Access, Sorting Blobs.

GetMaximumRegion performed with Area as the selected region feature.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

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

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of GetMaximumRegion filter group.

See Also

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