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

AVL.SortRegions

Changes the order of regions from the input array according to an ascending/descending sequence of their computed feature values.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void SortRegions
(
	IList<AvlNet.Region> inRegions,
	AvlNet.RegionFeature inFeature,
	AvlNet.SortingOrder inSortingOrder,
	IList<AvlNet.Region> outSortedRegions,
	NullableRef<List<float>> outSortedValues
)

Parameters

Name Type Range Default Description
inRegionsSystem.Collections.Generic.IList<AvlNet.Region>Input regions.
inFeatureAvlNet.RegionFeatureRegion feature value to be computed.
inSortingOrderAvlNet.SortingOrderSorting order.
outSortedRegionsSystem.Collections.Generic.IList<AvlNet.Region>Regions sorted according to the computed feature values.
outSortedValuesAvlNet.NullableRef<System.Collections.Generic.List<float>>Computed feature values. Can be null to skip this parameter calculation.

Description

The filter sorts the array of input regions according to the selected feature values computed for each of them.

Examples

SortRegions performed with inFeature = Area. Input regions are on the left. On the right is the result.

Function Overrides

See also