Class Lorentzian

Hierarchy

Lorentzian

Implements

Shape1DClass

Index

Constructors

constructor

Properties

fwhm

Methods

Constructors

constructor

new Lorentzian(options?: LorentzianClassOptions): Lorentzian

- Defined in shapes/1d/lorentzian/Lorentzian.ts:33
Parameters
- options: LorentzianClassOptions = {}
Returns Lorentzian

Properties

fwhm

fwhm: number

Full width at half maximum.

default: 500

Methods

calculateHeight

calculateHeight(area?: number): number

Implementation of Shape1DClass.calculateHeight
- Defined in shapes/1d/lorentzian/Lorentzian.ts:63
Calculate the height depending of fwhm and area.

Parameters
- area: number = 1
Returns number

fct

fct(x: number): number

Implementation of Shape1DClass.fct
- Defined in shapes/1d/lorentzian/Lorentzian.ts:47
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

Implementation of Shape1DClass.fwhmToWidth
- Defined in shapes/1d/lorentzian/Lorentzian.ts:39
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 = ...
Returns number
width

getArea

getArea(height?: number): number

Implementation of Shape1DClass.getArea
- Defined in shapes/1d/lorentzian/Lorentzian.ts:51
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

Implementation of Shape1DClass.getData
- Defined in shapes/1d/lorentzian/Lorentzian.ts:59
Calculate intensity array of a gaussian shape.

Parameters
- options: GetData1DOptions = {}
Returns Float64Array
Intensity values.

getFactor

getFactor(area?: number): number

Implementation of Shape1DClass.getFactor
- Defined in shapes/1d/lorentzian/Lorentzian.ts:55
Calculate the number of times FWHM allows to reach a specific area coverage.

Parameters
- Optional area: number
Returns number

getParameters

getParameters(): Parameter[]

Implementation of Shape1DClass.getParameters
- Defined in shapes/1d/lorentzian/Lorentzian.ts:67
Returns an array of the different parameters characterizing the shape

Returns Parameter[]

widthToFWHM

widthToFWHM(width: number): number

Implementation of Shape1DClass.widthToFWHM
- Defined in shapes/1d/lorentzian/Lorentzian.ts:43
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