Class GeneralizedLorentzian

constructor

• new GeneralizedLorentzian(
      options?: GeneralizedLorentzianClassOptions,
  ): GeneralizedLorentzian

  Parameters

  • options: GeneralizedLorentzianClassOptions = {}

  Returns GeneralizedLorentzian

fwhm

500
Copy

gamma

1
Copy

calculateHeight

• calculateHeight(area?: number): number

  Calculate the height depending of fwhm and area.

  Parameters

  • area: number = 1

  Returns number

fct

• fct(x: number): number

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

  Parameters

  • x: number

  Returns number

  • the y value of gaussian with the current parameters.

fwhmToWidth

• fwhmToWidth(fwhm?: number): number

  Compute the value of width between the inflection points from Full Width at Half Maximum (FWHM). for more information check the mathworld page

  Parameters

  • fwhm: number = ...

    Full Width at Half Maximum.

  Returns number

  width

getArea

• getArea(height?: number): number

  Calculate the area of a specific shape.

  Parameters

  • height: number = 1

  Returns number

  returns the area of the specific shape and parameters.

getData

• getData(options?: GetData1DOptions): Float64Array

  Calculate intensity array of a gaussian shape.

  Parameters

  • options: GetData1DOptions = {}

  Returns Float64Array

  Intensity values.

getFactor

• getFactor(area?: number): number

  Calculate the number of times FWHM allows to reach a specific area coverage.

  Parameters

  • Optionalarea: number

    Expected area to be covered.

  Returns number

getParameters

• getParameters(): Parameter[]

  Returns an array of the different parameters characterizing the shape

  Returns Parameter[]

widthToFWHM

• widthToFWHM(width: number): number

  Compute the value of Full Width at Half Maximum (FWHM) from the width between the inflection points. for more information check the mathworld page

  Parameters

  • width: number

  Returns number

  fwhm