You are here: Start » AVL.NET » Function Reference » Path » Path Classification » AVL.ClassifyPaths

AVL.ClassifyPaths

Splits the paths of the input array - in accordance to the relation between computed feature values and the specified range.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ClassifyPaths
(
	IList<AvlNet.Path> inPaths,
	AvlNet.PathFilter inPathFilter,
	AvlNet.PathFeature inFeature,
	float? inMinimum,
	float? inMaximum,
	NullableRef<SafeList<AvlNet.Path>> outAccepted,
	NullableRef<SafeList<AvlNet.Path>> outRejected,
	NullableRef<SafeList<AvlNet.Path>> outBelow,
	NullableRef<SafeList<AvlNet.Path>> outAbove,
	NullableRef<List<float>> outValues
)

Parameters

Name Type Range Default Description
inPathsSystem.Collections.Generic.IList<AvlNet.Path>Input paths.
inPathFilterAvlNet.PathFilterDetermines which paths will take part in computation.
inFeatureAvlNet.PathFeaturePath feature value to be computed.
inMinimumfloat?Lowest value of the range. Default value: atl::NIL.
inMaximumfloat?Highest value of the range. Default value: atl::NIL.
outAcceptedAvlNet.NullableRef<AvlNet.SafeList<AvlNet.Path>>Paths with feature values matching the range. Can be null to skip this parameter calculation.
outRejectedAvlNet.NullableRef<AvlNet.SafeList<AvlNet.Path>>Paths with feature values outside the range. Can be null to skip this parameter calculation.
outBelowAvlNet.NullableRef<AvlNet.SafeList<AvlNet.Path>>Paths with feature values lower than inMinimum. Can be null to skip this parameter calculation.
outAboveAvlNet.NullableRef<AvlNet.SafeList<AvlNet.Path>>Paths with feature values higher than inMaximum. Can be null to skip this parameter calculation.
outValuesAvlNet.NullableRef<System.Collections.Generic.List<float>>Computed feature values. Can be null to skip this parameter calculation.

Description

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

  • Paths corresponding to feature values lower than inMinimum are passed onto outBelow and outRejected.
  • Paths corresponding to feature values that fit closed range (inMinimum, inMaximum) are passed onto outAccepted.
  • Paths 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.

Paths can be filtered before classification. One can process all paths, only open or only closed ones, depending on value of inPathFilter input.

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

See also