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

ProfileMinimum

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

Syntax

void fil::ProfileMinimum
(
	const fil::Profile& inProfile,
	ftl::Optional<const fil::Range&> inRange,
	fil::ProfileInterpolationMethod::Type inInterpolationMethod,
	float& outMinimumPoint,
	ftl::Optional<int&> outMinimumIndex = ftl::NIL,
	ftl::Optional<float&> outMinimumValue = ftl::NIL
)

Parameters

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

Optional Outputs

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

Read more about Optional Outputs.

Errors