IPeakSearchingExecute Method |
Executes the peak searching algorithm.
Namespace: Altaxo.Science.Spectroscopy.PeakSearchingAssembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax(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 (then only the positions as indices are calculated).
- y Double
- The y values of the spectrum.
- regions Int32
-
The spectral regions. Can be (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 region, a tuple containing the peak descriptions in that range and 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 region (and thus
not to the underlying spectral array).
See Also