You are here: Start » AVL.NET » Function Reference » Region » Region Relations » AVL.GetMaximumRegion

AVL.GetMaximumRegion

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void GetMaximumRegion
(
	IList<AvlNet.Region> inRegions,
	AvlNet.RegionFeature inFeature,
	AvlNet.Region outRegion,
	out float outValue,
	out int outIndex
)

Parameters

Name Type Range Default Description
inRegionsSystem.Collections.Generic.IList<AvlNet.Region>Input regions.
inFeatureAvlNet.RegionFeatureRegion feature value to be computed.
outRegionAvlNet.RegionOutput region.
outValuefloatComputed feature value of the output region.
outIndexint

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

List of possible exceptions:

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

Function Overrides

See also