Back to Aurora Vision Library website

You are here: Start » Function Reference » Path » Path Classification » SortPaths

SortPaths


Header: AVL.h
Namespace: avl
Module: FoundationBasic

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

Syntax

C++
C#
 
void avl::SortPaths
(
	const atl::Array<avl::Path>& inPaths,
	avl::PathFilter::Type inPathFilter,
	avl::PathFeature::Type inFeature,
	avl::SortingOrder::Type inSortingOrder,
	atl::Array<avl::Path>& outSortedPaths,
	atl::Optional<atl::Array<float>&> outSortedValues = atl::NIL
)

Parameters

Name Type Default Description
Input value inPaths const Array<Path>& Input paths
Input value inPathFilter PathFilter::Type Determines which paths will take part in computation
Input value inFeature PathFeature::Type Path feature value to be computed
Input value inSortingOrder SortingOrder::Type Sorting order
Output value outSortedPaths Array<Path>& Paths sorted according to the computed feature values
Output value outSortedValues Optional<Array<float>&> NIL Computed feature values

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outSortedValues.

Read more about Optional Outputs.