Back to Aurora Vision Library website
You are here: Start » Function Reference » Profile » Profile Features » ProfileMaximum
ProfileMaximum
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationPro |
Finds the highest value of the input profile, its precise location and the corresponding index.
Syntax
C++
C#
void avl::ProfileMaximum ( const avl::Profile& inProfile, atl::Optional<const avl::Range&> inRange, avl::ProfileInterpolationMethod::Type inInterpolationMethod, float& outMaximumPoint, atl::Optional<int&> outMaximumIndex = atl::NIL, atl::Optional<float&> outMaximumValue = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inProfile | const Profile& | Input profile | ||
inRange | Optional<const Range&> | NIL | ||
inInterpolationMethod | ProfileInterpolationMethod::Type | Quadratic4 | Profile points' interpolation method | |
outMaximumPoint | float& | Position of highest value with respect to profile's offset and scale | ||
outMaximumIndex | Optional<int&> | NIL | Index of highest value | |
outMaximumValue | Optional<float&> | NIL | Highest value |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outMaximumIndex, outMaximumValue.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty profile in ProfileMaximum. |
DomainError | Empty profile range in ProfileMaximum. |
DomainError | Range exceeds the input profile in ProfileMaximum. |
DomainError | Unsupported interpolation method in ProfileMaximum. |