You are here: Start » AVL.NET » Function Reference » Profile » Profile Features » AVL.ProfileMaximum

AVL.ProfileMaximum

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ProfileMaximum
(
	AvlNet.Profile inProfile,
	AvlNet.Range? inRange,
	AvlNet.ProfileInterpolationMethod inInterpolationMethod,
	out float outMaximumPoint,
	out int outMaximumIndex,
	out float outMaximumValue
)

Parameters

Name Type Range Default Description
inProfileAvlNet.ProfileInput profile.
inRangeAvlNet.Range?
inInterpolationMethodAvlNet.ProfileInterpolationMethodQuadratic4Profile points' interpolation method. Default value: Quadratic4.
outMaximumPointfloatPosition of highest value with respect to profile's offset and scale.
outMaximumIndexintIndex of highest value.
outMaximumValuefloatHighest value.

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.

Function Overrides

See also