Class PseudoVoigt

Hierarchy

PseudoVoigt

Implements

Shape1DClass

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PseudoVoigt(options?: PseudoVoigtClassOptions): PseudoVoigt

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:65
Parameters
- options: PseudoVoigtClassOptions = {}
Returns PseudoVoigt

Properties

fwhm

fwhm: number

mu

mu: number

Ratio of gaussian contribution in the shape

default: 0.5

Methods

calculateHeight

calculateHeight(area?: number): number

Implementation of Shape1DClass.calculateHeight
- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:105
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/pseudoVoigt/PseudoVoigt.ts:80
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, mu?: number): number

Implementation of Shape1DClass.fwhmToWidth
- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:72
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 = ...
- mu: number = ...
Returns number
width

getArea

getArea(height?: number): number

Implementation of Shape1DClass.getArea
- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:84
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/pseudoVoigt/PseudoVoigt.ts:92
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/pseudoVoigt/PseudoVoigt.ts:88
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/pseudoVoigt/PseudoVoigt.ts:109
Returns an array of the different parameters characterizing the shape

Returns Parameter[]

widthToFWHM

widthToFWHM(width: number, mu?: number): number

Implementation of Shape1DClass.widthToFWHM
- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:76
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