Class Gaussian2D

constructor

• new Gaussian2D(options?: Gaussian2DClassOptions): Gaussian2D

  Parameters

  • options: Gaussian2DClassOptions = {}

  Returns Gaussian2D

fwhmX

50
Copy

fwhmY

Readonlykind

fwhm

• get fwhm(): XYNumber

  Full width at half maximum on each axis.

  Returns XYNumber

  the fwhm of both axes.

• set fwhm(fwhm: number | XYNumber): void

  setter to parameters fwhmX and fwhmY

  Parameters

  • fwhm: number | XYNumber

  Returns void

calculateHeight

• calculateHeight(volume?: number): number

  Calculate the height depending of fwhm and volumen.

  Parameters

  • volume: number = 1

  Returns number

fct

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

• fwhmToWidth(fwhm: number): number

  Parameters

  • fwhm: number

  Returns number

getData

• getData(options?: GetData2DOptions): any[]

  Calculate the intensity matrix of a gaussian shape.

  Parameters

  • options: GetData2DOptions = {}

  Returns any[]

  z values.

getFactor

• getFactor(volume?: number): number

  Parameters

  • Optionalvolume: number

  Returns number

getVolume

• getVolume(height?: number): number

  Parameters

  • height: number = ...

  Returns number

toJSON

• toJSON(): GaussianShape2D

  Descriptor of this shape, so JSON.stringify round-trips through getShape2D.

  Returns GaussianShape2D

  the shape descriptor.

widthToFWHM

• widthToFWHM(width: number): number

  Parameters

  • width: number

  Returns number