You are here: Start » AVL.NET » AVL.ProfileMinimum

AVL.ProfileMinimum

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ProfileMinimum
(
	AvlNet.Profile inProfile,
	AvlNet.Range? inRange,
	AvlNet.ProfileInterpolationMethod inInterpolationMethod,
	out float outMinimumPoint,
	out int outMinimumIndex,
	out float outMinimumValue
)

Parameters

Name Type Range Default Description
inProfileAvlNet.ProfileInput profile.
inRangeAvlNet.Range?
inInterpolationMethodAvlNet.ProfileInterpolationMethodQuadratic4Profile points' interpolation method. Default value: Quadratic4.
outMinimumPointfloatPosition of lowest value with respect to profile's offset and scale.
outMinimumIndexintIndex of lowest value.
outMinimumValuefloatLowest value.

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.

Function Overrides

See also