common-spectrum
    Preparing search index...

    Interface AutoPeakPickingOptions

    interface AutoPeakPickingOptions {
        from?: number;
        maxAbsoluteRatio?: number;
        maxCriteria?: boolean;
        minMaxRatio?: number;
        minPeakWidth?: number;
        noiseLevel?: number;
        normalizationOptions?: NormalizedSpectrumOptions;
        peakDetectionAlgorithm?: "first" | "second" | "auto";
        realTopDetection?: boolean;
        sgOptions?: SGGOptions;
        shape?: Shape1D;
        smoothY?: boolean;
        to?: number;
        xVariable?: OneLowerCase;
        yVariable?: OneLowerCase;
    }

    Hierarchy

    • GSDOptions
      • AutoPeakPickingOptions
    Index

    Properties

    from? maxAbsoluteRatio? maxCriteria? minMaxRatio? minPeakWidth? noiseLevel? normalizationOptions? peakDetectionAlgorithm? realTopDetection? sgOptions? shape? smoothY? to? xVariable? yVariable?

    Properties

    from?: number

    First X value for the peak picking (default: first X value)

    maxAbsoluteRatio?: number

    Threshold to use an absolute ratio of the maximum absolute Y value as an additional minimum peak height. Value must be between 0 and 1. When 0 (default) this option is ignored and noiseLevel is used.

    0
    maxCriteria?: boolean

    Peaks are local maxima (true) or minima (false)

    true
    minMaxRatio?: number

    Minimal height of small peaks based on the ratio between min and max

    0.00025
    minPeakWidth?: number

    Minimal peak width

    noiseLevel?: number

    Peaks under the noiseLevel (or above it in case of maxCriteria=false) are ignored. When omitted, the noise level is estimated from the spectrum for equally-spaced x, and set to 0 otherwise.

    undefined
    normalizationOptions?: NormalizedSpectrumOptions

    Normalization can be applied before peak picking. This is useful for example to correct baseline while still have a minMaxRatio filter

    peakDetectionAlgorithm?: "first" | "second" | "auto"

    Algorithm used for peak detection:

    • 'first': Uses the first derivative to detect peaks, detecting only the peaks which first derivative cross the zero.
    • 'second': Uses the second derivative to detect peaks (inflection points).
    • 'auto': Automatically selects the peaks by checking the zero crossing of the first derivative or the local minima in the second derivative.
    'second'
    realTopDetection?: boolean

    Use a quadratic optimizations with the peak and its 3 closest neighbors

    false
    sgOptions?: SGGOptions

    Options for the Savitzky-Golay generalised algorithm. This algorithm is used to calculate the first ans second derivative. It is also used when smoothY:true to smooth the spectrum for peak picking. The Y values in case of smoothY is true will therefore be lower.

    {windowSize:9,polynomial:3}
    shape?: Shape1D
    smoothY?: boolean

    Select the peak intensities from a smoothed version of the independent variables

    false
    to?: number

    Last X value for the peak picking (default: last X value)

    xVariable?: OneLowerCase

    x variable label, by default 'x'

    yVariable?: OneLowerCase

    y variable label, by default 'y'

    Settings

    Member Visibility

    On This Page

    Properties