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

AVL.ClassifyPaths Method

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

public static void ClassifyPaths(
	AvlNet.Path[] inPaths,
	AvlNet.PathFilter inPathFilter,
	AvlNet.PathFeature inFeature,
	float? inMinimum,
	float? inMaximum,
	out AvlNet.Path[] outAccepted,
	out AvlNet.Path[] outRejected,
	out AvlNet.Path[] outBelow,
	out AvlNet.Path[] outAbove,
	out float[] outValues
)

Parameters

Name Type Range Default Description
inPathsAvlNet.PathInput 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, or null.
inMaximumfloat?Highest value of the range. Default value: atl::NIL, or null.
outAcceptedAvlNet.PathPaths with feature values matching the range
outRejectedAvlNet.PathPaths with feature values outside the range
outBelowAvlNet.PathPaths with feature values lower than inMinimum
outAboveAvlNet.PathPaths with feature values higher than inMaximum
outValuesfloatComputed feature values

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