PeakFinderExecute(IReadOnlyListDouble, Object, Object, NullableDouble, Object, Object, NullableInt32, Double, Object) Method

public int[] Execute(
	IReadOnlyList<double> x,
	Object? height = null,
	Object? threshold = null,
	double? distance = null,
	Object? prominence = null,
	Object? width = null,
	int? wlen = null,
	double rel_height = 0,5,
	Object? plateau_size = null
)

Parameters

x  IReadOnlyListDouble

A signal with peaks.

height  Object  (Optional)

Required height of peaks. Either a number, , an array matching x, or a 2-element tuple of the former. The first element is interpreted as the minimal and the second (if supplied) as the maximal required height.

threshold  Object  (Optional)

Required threshold of peaks (the vertical distance to neighboring samples). Either a number, , an array matching x, or a 2-element tuple of the former. The first element is interpreted as the minimal and the second (if supplied) as the maximal required threshold.

distance  NullableDouble  (Optional)

Required minimal horizontal distance (>= 1) in samples between neighboring peaks. Smaller peaks are removed first until the condition is fulfilled for all remaining peaks.

prominence  Object  (Optional)

Required prominence of peaks. Either a number, , an array matching x, or a 2-element tuple of the former. The first element is interpreted as the minimal and the second (if supplied) as the maximal required prominence.

width  Object  (Optional)

Required width of peaks (in samples). Either a number, , an array matching x, or a 2-element tuple of the former. The first element is interpreted as the minimal and the second (if supplied) as the maximal required width.

wlen  NullableInt32  (Optional)

Window length (in samples) used while calculating peak prominences. It is only used if prominence or width is specified.

rel_height  Double  (Optional)

Relative height (as a fraction of prominence) used to calculate peak widths. It is only used if width is specified. Default value is 0.5.

plateau_size  Object  (Optional)

Required size of the flat top of peaks (in samples). Either a number, , an array matching x, or a 2-element tuple of the former. The first element is interpreted as the minimal and the second (if supplied) as the maximal required plateau size.

Return Value

Reference