You are here: Start » FIL.NET » Function Reference » Region » Region Relations » FIL.GetMinimumRegion

FIL.GetMinimumRegion

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

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void GetMinimumRegion
(
	IList<FilNet.Region> inRegions,
	FilNet.RegionFeature inFeature,
	FilNet.Region outRegion,
	NullableValue<float> outValue,
	NullableValue<int> outIndex
)

Parameters

Name Type Range Default Description
inRegionsSystem.Collections.Generic.IList<FilNet.Region>Input regions.
inFeatureFilNet.RegionFeatureRegion feature value to be computed.
outRegionFilNet.RegionOutput region.
outValueFilNet.NullableValue<float>Computed feature value of the output region. Can be null to skip this parameter calculation.
outIndexFilNet.NullableValue<int> Can be null to skip this parameter calculation.

Description

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

Examples

GetMinimumRegion performed with Area as the selected region feature.

Errors

List of possible exceptions:

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

Function Overrides

See also