Back to Aurora Vision Library website

You are here: Start » Function Reference » Profile » Profile Features » ProfileMinimum

ProfileMinimum


Header: AVL.h
Namespace: avl
Module: FoundationPro

Finds the lowest value of the input profile, its precise location and the corresponding index.

Syntax

C++
C#
 
void avl::ProfileMinimum
(
	const avl::Profile& inProfile,
	atl::Optional<const avl::Range&> inRange,
	avl::ProfileInterpolationMethod::Type inInterpolationMethod,
	float& outMinimumPoint,
	atl::Optional<int&> outMinimumIndex = atl::NIL,
	atl::Optional<float&> outMinimumValue = atl::NIL
)

Parameters

Name Type Default Description
Input value inProfile const Profile& Input profile
Input value inRange Optional<const Range&> NIL
Input value inInterpolationMethod ProfileInterpolationMethod::Type Quadratic4 Profile points' interpolation method
Output value outMinimumPoint float& Position of lowest value with respect to profile's offset and scale
Output value outMinimumIndex Optional<int&> NIL Index of lowest value
Output value outMinimumValue Optional<float&> NIL Lowest value

Optional Outputs

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

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Empty profile in ProfileMinimum.
DomainError Empty profile range in ProfileMinimum.
DomainError Range exceeds the input profile in ProfileMinimum.
DomainError Unsupported interpolation method in ProfileMinimum.