GetMaximumRegion_OrNil


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#
Python
 
def GetMaximumRegion_OrNil(
	inRegions: list[Region],
	/,
	*,
	inFeature: RegionFeature = RegionFeature.Area
)
-> (
	outRegion: Region | None,
	outValue: float | None,
	outIndex: int | None
)

Parameters

Name Type Default Description
Input value inRegions list[Region] Input regions
Input value inFeature RegionFeature RegionFeature.Area Region feature value to be computed
Output value outRegion Region | None Output region
Output value outValue float | None Computed feature value of the output region
Output value outIndex int | None