SecondDerivative Module

Functions and values

Function or value Description

characterizePeak xData yData smoothedYData labeledSndDevData peakIdx

Full Usage: characterizePeak xData yData smoothedYData labeledSndDevData peakIdx

Parameters:
    xData : float[]
    yData : float[]
    smoothedYData : float[]
    labeledSndDevData : Tag<Extrema, (float * float)>[]
    peakIdx : int

Returns: IdentifiedPeak
xData : float[]
yData : float[]
smoothedYData : float[]
labeledSndDevData : Tag<Extrema, (float * float)>[]
peakIdx : int
Returns: IdentifiedPeak

closestLeftLiftOffIdx labeledSndDevData peakIdx

Full Usage: closestLeftLiftOffIdx labeledSndDevData peakIdx

Parameters:
    labeledSndDevData : Tag<Extrema, (float * float)>[]
    peakIdx : int

Returns: int option
labeledSndDevData : Tag<Extrema, (float * float)>[]
peakIdx : int
Returns: int option

closestLiftOffIdx stepSize labeledSndDevData peakIdx

Full Usage: closestLiftOffIdx stepSize labeledSndDevData peakIdx

Parameters:
    stepSize : int
    labeledSndDevData : Tag<Extrema, (float * float)>[]
    peakIdx : int

Returns: int option
stepSize : int
labeledSndDevData : Tag<Extrema, (float * float)>[]
peakIdx : int
Returns: int option

closestRightLiftOffIdx labeledSndDevData peakIdx

Full Usage: closestRightLiftOffIdx labeledSndDevData peakIdx

Parameters:
    labeledSndDevData : Tag<Extrema, (float * float)>[]
    peakIdx : int

Returns: int option
labeledSndDevData : Tag<Extrema, (float * float)>[]
peakIdx : int
Returns: int option

filterpeaks noiseLevel yData labeledDataTmp

Full Usage: filterpeaks noiseLevel yData labeledDataTmp

Parameters:
    noiseLevel : float
    yData : float[]
    labeledDataTmp : Tag<Extrema, 'a>[]

Returns: (int * Tag<Extrema, 'a>)[]
noiseLevel : float
yData : float[]
labeledDataTmp : Tag<Extrema, 'a>[]
Returns: (int * Tag<Extrema, 'a>)[]

findLeftBorderOf xData yData smoothedYData labeledSndDevData closestPeakIdx closestLiftOffIdx

Full Usage: findLeftBorderOf xData yData smoothedYData labeledSndDevData closestPeakIdx closestLiftOffIdx

Parameters:
    xData : float[] -
    yData : float[] -
    smoothedYData : float[] -
    labeledSndDevData : Tag<Extrema, (float * float)>[] -
    closestPeakIdx : int -
    closestLiftOffIdx : int option -

Returns: bool * int

Given a noisy data set, the labled negative second derivative, the index of a putative peak and the index of the peak lift of position, the function iterates
in the positive direction returns a tuple. The first value of the tuple indicates if the peak is isolated (true indicates yes) and the second value is the
index index of the determined peak end.

xData : float[]

yData : float[]

smoothedYData : float[]

labeledSndDevData : Tag<Extrema, (float * float)>[]

closestPeakIdx : int

closestLiftOffIdx : int option

Returns: bool * int

Example

findRightBorderOf xData yData smoothedYData labeledSndDevData closestPeakIdx closestLiftOffIdx

Full Usage: findRightBorderOf xData yData smoothedYData labeledSndDevData closestPeakIdx closestLiftOffIdx

Parameters:
    xData : float[] -
    yData : float[] -
    smoothedYData : float[] -
    labeledSndDevData : Tag<Extrema, (float * float)>[] -
    closestPeakIdx : int -
    closestLiftOffIdx : int option -

Returns: bool * int

Given a noisy data set, the labled negative second derivative, the index of a putative peak and the index of the peak lift of position, the function iterates
in the positive direction returns a tuple. The first value of the tuple indicates if the peak is isolated (true indicates yes) and the second value is the
index index of the determined peak end.

xData : float[]

yData : float[]

smoothedYData : float[]

labeledSndDevData : Tag<Extrema, (float * float)>[]

closestPeakIdx : int

closestLiftOffIdx : int option

Returns: bool * int

Example

getPeaks snr polOrder ws xData yData

Full Usage: getPeaks snr polOrder ws xData yData

Parameters:
    snr : float
    polOrder : int
    ws : int
    xData : float[]
    yData : float[]

Returns: IdentifiedPeak[]
snr : float
polOrder : int
ws : int
xData : float[]
yData : float[]
Returns: IdentifiedPeak[]

tryFindPeakEnd step xData yData smoothedYData labeledSndDevData closestPeakIdx closestLiftOffIdx

Full Usage: tryFindPeakEnd step xData yData smoothedYData labeledSndDevData closestPeakIdx closestLiftOffIdx

Parameters:
    step : int -
    xData : float[] -
    yData : float[] -
    smoothedYData : float[] -
    labeledSndDevData : Tag<Extrema, (float * float)>[] -
    closestPeakIdx : int -
    closestLiftOffIdx : int option -

Returns: bool * int

Given a noisy data set, the labled negative second derivative, the index of a putative peak and the index of the peak lift of position, the function iterates
in the direction given by the step parameter and returns a tuple. The first value of the tuple indicates if the peak is isolated (true indicates yes) and the second value is the
index index of the determined peak end.

step : int

xData : float[]

yData : float[]

smoothedYData : float[]

labeledSndDevData : Tag<Extrema, (float * float)>[]

closestPeakIdx : int

closestLiftOffIdx : int option

Returns: bool * int

Example