Click or drag to resize

IPeakSearchingExecute Method

Executes the peak searching algorithm.

Namespace: Altaxo.Science.Spectroscopy.PeakSearching
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
(double[] , double[] , int[] , IReadOnlyList<(IReadOnlyList<PeakDescription> , int , int )>? peakSearchResults) Execute(
	double[] x,
	double[] y,
	int[]? regions
)

Parameters

x  Double
The x values of the spectrum. Can be null (then, only the positions as indices are calculated).
y  Double
The y values of the spectrum.
regions  Int32
The spectral regions. Can be null (if the array is one region). Each element in this array is the start index of a new spectral region.

Return Value

ValueTupleDouble, Double, Int32, IReadOnlyListValueTupleIReadOnlyListPeakDescription, Int32, Int32
The results of the peak searching. For each spectral regions, a tuple of the peak descriptions in that range, together with the start and end index (exclusive) of that range is returned. Please note that the peak descriptions contain position indices that are relative to the corresponding range (thus not to the underlying spectral array).
See Also