You are here: Start » AVL.NET » AVL.GetMaximumRegion Method

AVL.GetMaximumRegion Method

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

public static void GetMaximumRegion(
	AvlNet.Region[] inRegions,
	AvlNet.RegionFeature inFeature,
	out AvlNet.Region outRegion,
	out float outValue,
	out int outIndex
)

Parameters

Name Type Range Default Description
inRegionsAvlNet.RegionInput 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

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

See also