Click or drag to resize

PeakFittingTogetherExecute(Double, Double, Int32, IReadOnlyListValueTupleIReadOnlyListPeakDescription, Int32, Int32, CancellationToken) Method

Executes the peak fitting algorithm.

Namespace: Altaxo.Science.Spectroscopy.PeakFitting
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
Copy
public (double[] , double[] , int[] , IReadOnlyList<(IReadOnlyList<PeakDescription> , int , int )>? peakFittingResults) Execute(
	double[] xArray,
	double[] yArray,
	int[]? regions,
	IReadOnlyList<(IReadOnlyList<PeakDescription> PeakDescriptions, int StartOfRegion, int EndOfRegion)> peakDescriptions,
	CancellationToken cancellationToken
)

Parameters

xArray  Double

[Missing <param name="xArray"/> documentation for "M:Altaxo.Science.Spectroscopy.PeakFitting.PeakFittingTogether.Execute(System.Double[],System.Double[],System.Int32[],System.Collections.Generic.IReadOnlyList{System.ValueTuple{System.Collections.Generic.IReadOnlyList{Altaxo.Science.Spectroscopy.PeakSearching.PeakDescription},System.Int32,System.Int32}},System.Threading.CancellationToken)"]

yArray  Double

[Missing <param name="yArray"/> documentation for "M:Altaxo.Science.Spectroscopy.PeakFitting.PeakFittingTogether.Execute(System.Double[],System.Double[],System.Int32[],System.Collections.Generic.IReadOnlyList{System.ValueTuple{System.Collections.Generic.IReadOnlyList{Altaxo.Science.Spectroscopy.PeakSearching.PeakDescription},System.Int32,System.Int32}},System.Threading.CancellationToken)"]

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.
peakDescriptions  IReadOnlyListValueTupleIReadOnlyListPeakDescription, Int32, Int32
Description of the peaks (output of peak searching algorithms, see IPeakSearching).
cancellationToken  CancellationToken
Token used to cancel this task.

Return Value

ValueTupleDouble, Double, Int32, IReadOnlyListValueTupleIReadOnlyListPeakDescription, Int32, Int32
The results of the peak fitting. For each spectral region, a tuple containing the fitted peak data in that region and the start and end index (exclusive) of that region 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).

Implements

IPeakFittingExecute(Double, Double, Int32, IReadOnlyListValueTupleIReadOnlyListPeakDescription, Int32, Int32, CancellationToken)
See Also