RidgeLine Type

Namespace: Altaxo.Science.Spectroscopy.PeakSearching
Assembly: AltaxoCore.Redist.dll
Base Type: List<int * int * float>
All Interfaces: IList<int * int * float> , ICollection<int * int * float> , IReadOnlyList<int * int * float> , IReadOnlyCollection<int * int * float> , IEnumerable<int * int * float> , IList , ICollection , IEnumerable

Represents a ridge line that is the output of the ridge line search in a Continuous Wavelet Transformation (Cwt) matrix.

Constructors

Constructor Description

RidgeLine()

Full Usage: RidgeLine()

Instance members

Instance member Description

this.GetPointAtMaximalCwtCoefficient

Full Usage: this.GetPointAtMaximalCwtCoefficient

Parameters:
    order : int - The order (must be at least 1). Number of points to the left and right of the designated maximum taken into consideration.

Returns: int * int * float The first local maximum that is found. If no local maximum is found, the point at which the Cwt coefficient has its global maximum is returned.

Beginning from stage 0 (lowest width), a point is searched at which the Cwt coefficient has a local maximum. The parameter order determines, how many points to the left and the right of the designates local maximum are taken into consideration.

order : int

The order (must be at least 1). Number of points to the left and right of the designated maximum taken into consideration.

Returns: int * int * float

The first local maximum that is found. If no local maximum is found, the point at which the Cwt coefficient has its global maximum is returned.

ArgumentOutOfRangeException Order has to be >=1 - order

this.GetSignalToNoiseRatioAtLowestWidth

Full Usage: this.GetSignalToNoiseRatioAtLowestWidth

Parameters:
    noiseLevels : float[] - The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).

Returns: float The signal-to-noise ratio at the point with the lowest stage (and therefore, the lowest width).

Gets the signal-to-noise ratio at the point with the lowest stage (and therefore, the lowest width, see RidgeLine.PointAtLowestWidth).

noiseLevels : float[]

The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).

Returns: float

The signal-to-noise ratio at the point with the lowest stage (and therefore, the lowest width).

this.GetSignalToNoiseRatioAtMaximalCwtCoefficient

Full Usage: this.GetSignalToNoiseRatioAtMaximalCwtCoefficient

Parameters:
    noiseLevels : float[] - The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).
    order : int - The order (must be at least 1). Number of points to the left and right of the designated maximum taken into consideration. See RidgeLine.GetPointAtMaximalCwtCoefficient.

Returns: float The signal-to-noise ratio at the point with the first maximum of the Cwt coefficient

Gets the signal-to-noise ratio at the point with the first maximum of the Cwt coefficient (see RidgeLine.PointAtMaximalCwtCoefficient).

noiseLevels : float[]

The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).

order : int

The order (must be at least 1). Number of points to the left and right of the designated maximum taken into consideration. See RidgeLine.GetPointAtMaximalCwtCoefficient.

Returns: float

The signal-to-noise ratio at the point with the first maximum of the Cwt coefficient

this.LengthIsAtLeast

Full Usage: this.LengthIsAtLeast

Parameters:
    minimalLength : int - Minimal required length of the ridge line.

Returns: bool True if the length of the ridge line is >= minimalLength; otherwise, false.

Gets a value indicating whether the ridge line has at least the provided length.

minimalLength : int

Minimal required length of the ridge line.

Returns: bool

True if the length of the ridge line is >= minimalLength; otherwise, false.

this.PointAtLowestWidth

Full Usage: this.PointAtLowestWidth

Returns: int * int * float

Gets the point at the lowest stage, i.e. at the lowest width. This is not neccessarily the stage 0, since the ridge line can end before reaching stage 0.

Returns: int * int * float

this.PointAtMaximalCwtCoefficient

Full Usage: this.PointAtMaximalCwtCoefficient

Returns: int * int * float

Gets the point where the CWT coefficient has the first time a local maximum (searching starts from stage0 (lowest width))

Returns: int * int * float

this.SignalToNoiseRatioAtLowestWidthIsAtLeast

Full Usage: this.SignalToNoiseRatioAtLowestWidthIsAtLeast

Parameters:
    noiseLevels : float[] - The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).
    minimalSNR : float - The minimal required signal-to-noise ratio.

Returns: bool True if the signal-to-noise ratio is greater than or equal to minimalSNR; otherwise, false.

Gets a value indicating whether the ridge line has at least a signal the provided signal-to-noise ratio. The signal-to-noise ratio is calculated at the point of the lowest stage (lowest width, see RidgeLine.PointAtLowestWidth).

noiseLevels : float[]

The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).

minimalSNR : float

The minimal required signal-to-noise ratio.

Returns: bool

True if the signal-to-noise ratio is greater than or equal to minimalSNR; otherwise, false.

this.SignalToNoiseRatioAtMaximalCwtCoefficientIsAtLeast

Full Usage: this.SignalToNoiseRatioAtMaximalCwtCoefficientIsAtLeast

Parameters:
    noiseLevels : float[] - The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).
    minimalSNR : float - The minimal required signal-to-noise ratio.
    order : int - The order (must be at least 1). Number of points to the left and right of the designated maximum taken into consideration. See RidgeLine.GetPointAtMaximalCwtCoefficient.

Returns: bool True if the signal-to-noise ratio is greater than or equal to minimalSNR; otherwise, false.

Gets a value indicating whether the ridge line has at least a signal-to-noise ratio greater than or equal to the provided value. The signal-to-noise ratio is calculated at the point with the first maximum of the Cwt coefficient (see RidgeLine.PointAtMaximalCwtCoefficient).

noiseLevels : float[]

The noise levels along the x-axis. The array must have the same length than the length of the spectrum that was used to create the ridge line(s).

minimalSNR : float

The minimal required signal-to-noise ratio.

order : int

The order (must be at least 1). Number of points to the left and right of the designated maximum taken into consideration. See RidgeLine.GetPointAtMaximalCwtCoefficient.

Returns: bool

True if the signal-to-noise ratio is greater than or equal to minimalSNR; otherwise, false.

this.StartsAtStageZero

Full Usage: this.StartsAtStageZero

Returns: bool

Gets a value indicating whether the ridge line starts at stage 0 (the stage with the lowest width).

Returns: bool