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

ProfileLocalExtrema

Finds the locations at which the values of the input profile are locally highest or lowest.

Syntax

void avl::ProfileLocalExtrema
(
	const avl::Profile& inProfile,
	const bool inCyclic,
	const avl::ExtremumType::Type inExtremumType,
	avl::ProfileInterpolationMethod::Type inInterpolationMethod,
	const bool inConsiderPlateaus,
	atl::Optional<float> inMinValue,
	atl::Optional<float> inMaxValue,
	atl::Optional<atl::Array<int>& > outExtremumIndices,
	atl::Array<float>& outExtremumPoints,
	atl::Array<float>& outExtremumValues
)

void ProfileLocalExtrema
(
	Profile inProfile,
	bool inCyclic,
	ExtremumType inExtremumType,
	ProfileInterpolationMethod inInterpolationMethod,
	bool inConsiderPlateaus,
	float? inMinValue,
	float? inMaxValue,
	out int[] outExtremumIndices,
	out float[] outExtremumPoints,
	out float[] outExtremumValues
)

Parameters

Name	Type	Default	Description
inProfile	const Profile&		Input profile
inCyclic	const bool		Indicates whether the last element should be considered a neighbour of the first element
inExtremumType	const ExtremumType::Type		Type of extremum to find
inInterpolationMethod	ProfileInterpolationMethod::Type	Quadratic4	When interpolation is set to Quadratic each non-plateau minimum is located using a parabola fit
inConsiderPlateaus	const bool	True	Indicates whether the result should include centers of plateau minima
inMinValue	Optional<float>	NIL	Minimum value of an extremum
inMaxValue	Optional<float>	NIL	Maximum value of an extremum
outExtremumIndices	Optional<Array<int>& >		Indices of the profile values representing each minimum
outExtremumPoints	Array<float>&		Precise location of the profile minima
outExtremumValues	Array<float>&		Value of each minimum