ml-peak-shape-generator
    Preparing search index...

    Interface Shape2DClass

    interface Shape2DClass {
        fwhm: number | XYNumber;
        fwhmX: number;
        fwhmY: number;
        calculateHeight(volume?: number): number;
        fct(x: number, y: number): number;
        fwhmToWidth(fwhm?: number): number;
        getData(options?: GetData2DOptions): DoubleArray[];
        getFactor(volume?: number): number;
        getVolume(height?: number): number;
        widthToFWHM(width: number): number;
    }

    Implemented by

    Index

    Properties

    fwhm fwhmX fwhmY

    Methods

    calculateHeight fct fwhmToWidth getData getFactor getVolume widthToFWHM

    Properties

    fwhm: number | XYNumber

    setter to parameters fwhmX and fwhmY

    fwhmX: number

    Full width at half maximum. Could specify the value for each axis by a xy object or both by a number.

    50
    fwhmY: number

    Methods

    • Calculate the height depending of fwhm and volumen.

      Parameters

      • Optionalvolume: number

      Returns number

    • Return a parameterized function of a Gaussian2D shape (see README for equation).

      Parameters

      • x: number

        x value to calculate.

      • y: number

        y value to calculate.

      Returns number

      • the z value of bi-dimensional gaussian with the current parameters.

    • Parameters

      • Optionalfwhm: number

      Returns number

    • Calculate the intensity matrix of a gaussian shape.

      Parameters

      • Optionaloptions: GetData2DOptions

      Returns DoubleArray[]

      z values.

    • Parameters

      • Optionalvolume: number

      Returns number

    • Parameters

      • Optionalheight: number

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Methods