Back to FabImage Library website

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

GetMaximumRegion_OrNil


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Returns the region from the input array that corresponds to the largest computed feature value; returns NIL if the array or any region inside it is empty.

Applications: Use this filter when you have an array of regions and you want to select one of them that best matches some criterion.

Syntax

C++
C#
 
void fil::GetMaximumRegion_OrNil
(
	const ftl::Array<fil::Region>& inRegions,
	fil::RegionFeature::Type inFeature,
	ftl::Conditional<fil::Region>& outRegion,
	ftl::Conditional<float>& outValue,
	ftl::Conditional<int>& outIndex
)

Parameters

Name Type Default Description
Input value
 inRegions const Array<Region>& Input regions
Input value
 inFeature RegionFeature::Type Region feature value to be computed
Output value
 outRegion Conditional<Region>& Output region
Output value
 outValue Conditional<float>& Computed feature value of the output region
Output value
 outIndex Conditional<int>&