Back to Aurora Vision Library website
You are here: Start » Function Reference » Path » Path Classification » GetMaximumPath
GetMaximumPath
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Returns the path from the input array that corresponds to the largest computed feature value.
Applications: Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.
Syntax
C++
C#
void avl::GetMaximumPath ( const atl::Array<avl::Path>& inPaths, avl::PathFeature::Type inFeature, avl::Path& outPath, atl::Optional<float&> outValue = atl::NIL, atl::Optional<int&> outIndex = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inPaths | const Array<Path>& | Input paths | ||
inFeature | PathFeature::Type | Path feature value to be computed | ||
outPath | Path& | Output path | ||
outValue | Optional<float&> | NIL | Computed feature value of the output path | |
outIndex | Optional<int&> | NIL |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outValue, outIndex.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty path array on input in GetMaximumPath. |