ProfileLocalExtrema


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

Syntax

C++
C#
Python
 
def ProfileLocalExtrema(
	inProfile: Profile,
	/,
	*,
	inRange: Range | None = None,
	inCyclic: bool = False,
	inExtremumType: ExtremumType = ExtremumType.Maximum,
	inInterpolationMethod: ProfileInterpolationMethod = ProfileInterpolationMethod.Quadratic4,
	inConsiderPlateaus: bool = True,
	inMinValue: float | None = None,
	inMaxValue: float | None = None,
	inLocalBlindness: LocalBlindness | None = None
)
-> outLocalExtrema: list[Extremum1D]

Parameters

Name Type Default Description
Input value inProfile Profile Input profile
Input value inRange Range | None None
Input value inCyclic bool False Indicates whether the last element should be considered a neighbour of the first element
Input value inExtremumType ExtremumType ExtremumType.Maximum Type of extremum to find
Input value inInterpolationMethod ProfileInterpolationMethod ProfileInterpolationMethod.Quadratic4 When interpolation is set to Quadratic each non-plateau extremum is located using a parabola fit
Input value inConsiderPlateaus bool True Indicates whether the result should include centers of plateau extrema
Input value inMinValue float | None None Minimum value of an extremum
Input value inMaxValue float | None None Maximum value of an extremum
Input value inLocalBlindness LocalBlindness | None None Defines conditions in which weaker extrema can be detected in the vicinity of stronger ones
Output value outLocalExtrema list[Extremum1D] Extrema of the profile values