Interface Shape2DClass

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

Implemented by

Properties

fwhm fwhmX fwhmY

Methods

calculateHeight fct fwhmToWidth getData getFactor getVolume widthToFWHM

Properties

fwhm

fwhm: number | XYNumber

setter to parameters fwhmX and fwhmY

fwhmX

fwhmX: number

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

Default

50

fwhmY

fwhmY: number

Methods

calculateHeight

  • calculateHeight(volume?): number

  • Calculate the height depending of fwhm and volumen.

    Parameters

    • Optional volume: number

    Returns number

fct

  • fct(x, y): 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.

fwhmToWidth

getData

  • getData(options?): DoubleArray[]

  • Calculate the intensity matrix of a gaussian shape.

    Parameters

    • Optional options: GetData2DOptions

    Returns DoubleArray[]

    z values.

getFactor

getVolume

widthToFWHM

Settings

Member Visibility

Theme

On This Page