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

FIL.ClassifyRegions

Splits an array of regions according to the selected feature and range.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void ClassifyRegions
(
	IList<FilNet.Region> inRegions,
	FilNet.RegionFeature inFeature,
	float? inMinimum,
	float? inMaximum,
	NullableRef<SafeList<FilNet.Region>> outAccepted,
	NullableRef<SafeList<FilNet.Region>> outRejected,
	NullableRef<SafeList<FilNet.Region>> outBelow,
	NullableRef<SafeList<FilNet.Region>> outAbove,
	NullableRef<List<float>> outValues
)

Parameters

Name Type Range Default Description
inRegionsSystem.Collections.Generic.IList<FilNet.Region>Input regions.
inFeatureFilNet.RegionFeatureRegion feature value to be computed.
inMinimumfloat?Lowest value of the range. Default value: ftl::NIL.
inMaximumfloat?Highest value of the range. Default value: ftl::NIL.
outAcceptedFilNet.NullableRef<FilNet.SafeList<FilNet.Region>>Regions with feature values matching the range. Can be null to skip this parameter calculation.
outRejectedFilNet.NullableRef<FilNet.SafeList<FilNet.Region>>Regions with feature values outside the range. Can be null to skip this parameter calculation.
outBelowFilNet.NullableRef<FilNet.SafeList<FilNet.Region>>Regions with feature values lower than inMinimum. Can be null to skip this parameter calculation.
outAboveFilNet.NullableRef<FilNet.SafeList<FilNet.Region>>Regions with feature values higher than inMaximum. Can be null to skip this parameter calculation.
outValuesFilNet.NullableRef<System.Collections.Generic.List<float>>Computed feature values. Can be null to skip this parameter calculation.

Description

The filter accepts an array of regions and splits it into output arrays, depending on how each of the computed feature values fits the (inMinimum, inMaximum) range.

  • Regions corresponding to feature values lower than inMinimum are passed onto outBelow and outRejected.
  • Regions corresponding to feature values that fit closed range (inMinimum, inMaximum) are passed onto outAccepted.
  • Regions corresponding to feature values higher than inMaximum are passed onto outAbove and outRejected.

In the special case of inMinimum being greater than inMaximum, first matching condition is applied, which means that objects corresponding to values higher than inMaximum and lower than inMinimum are passed onto outBelow.

To learn about possible features to classify regions, one should see RegionFeature documentation. To know details about particular feature, corresponding filter article should be read.

Examples

ClassifyRegions performed with Elongation selected as the region feature and inMaximum = 10. The blue regions are from outAccepted output, the orange ones from outRejected.

See also