Class PseudoVoigtTCH

TCH-style pseudo-Voigt where gaussian and lorentzian widths are independent. The effective fwhm and mixing parameter mu are derived from fwhmG and fwhmL via the Thompson–Cox–Hastings approximation.

Implements

Shape1DClass

Index

Constructors

Accessors

fwhm fwhmG fwhmL mu

Methods

calculateHeight fct fwhmToWidth getArea getData getFactor getParameters widthToFWHM

Constructors

constructor

new PseudoVoigtTCH(options?: PseudoVoigtTCHClassOptions): PseudoVoigtTCH
Parameters
- options: PseudoVoigtTCHClassOptions = {}
Returns PseudoVoigtTCH
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:48

Accessors

fwhm

get fwhm(): number
Returns number
Implementation of Shape1DClass.fwhm
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:119
set fwhm(value: number): void
Parameters
- value: number
Returns void
Implementation of Shape1DClass.fwhm
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:111

fwhmG

get fwhmG(): number
Returns number
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:78
set fwhmG(value: number): void
Parameters
- value: number
Returns void
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:65

fwhmL

get fwhmL(): number
Returns number
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:95
set fwhmL(value: number): void
Parameters
- value: number
Returns void
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:82

mu

get mu(): number
Returns number
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:107
set mu(value: number): void
Parameters
- value: number
Returns void
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:99

Methods

calculateHeight

calculateHeight(area?: number): number
Calculate the height depending of fwhm and area.
Parameters
- area: number = 1
Returns number
Implementation of Shape1DClass.calculateHeight
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:156

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.
Implementation of Shape1DClass.fct
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:131

fwhmToWidth

fwhmToWidth(fwhm?: number, mu?: 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.
- mu: number = ...
Returns number
width
Implementation of Shape1DClass.fwhmToWidth
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:123

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.
Implementation of Shape1DClass.getArea
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:135

getData

getData(options?: GetData1DOptions): Float64Array<ArrayBuffer>
Calculate intensity array of a gaussian shape.
Parameters
- options: GetData1DOptions = {}
Returns Float64Array<ArrayBuffer>
Intensity values.
Implementation of Shape1DClass.getData
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:143

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
Implementation of Shape1DClass.getFactor
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:139

getParameters

getParameters(): Parameter[]
Returns an array of the different parameters characterizing the shape

Returns Parameter[]
Implementation of Shape1DClass.getParameters
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:164

widthToFWHM

widthToFWHM(width: number, mu?: 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
- mu: number = ...
Returns number
fwhm
Implementation of Shape1DClass.widthToFWHM
- Defined in 1d/pseudoVoigtTCH/PseudoVoigtTCH.ts:127