ml-peak-shape-generator

Type aliases

Shape1D

Shape1D: GaussianShape1D | LorentzianShape1D | PseudoVoigtShape1D

Shape1DInstance

Shape1DInstance: Gaussian | Lorentzian | PseudoVoigt

Shape2D

Shape2D: GaussianShape2D

Shape2DInstance

Shape2DInstance: Gaussian2D

Functions

calculateGaussian2DHeight

calculateGaussian2DHeight(options?: CalculateGaussian2DHeightOptions): number

- Defined in shapes/2d/gaussian2D/Gaussian2D.ts:182
Parameters
- options: CalculateGaussian2DHeightOptions = {}
Returns number

calculateGaussianHeight

calculateGaussianHeight(options: CalculateGaussianHeightOptions): number

- Defined in shapes/1d/gaussian/Gaussian.ts:100
Parameters
- options: CalculateGaussianHeightOptions
Returns number

calculateLorentzianHeight

calculateLorentzianHeight(__namedParameters: Object): number

- Defined in shapes/1d/lorentzian/Lorentzian.ts:72
Parameters
- __namedParameters: Object
Returns number

calculatePseudoVoigtHeight

calculatePseudoVoigtHeight(options?: CalculatePseudoVoightHeightOptions): number

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:114
Parameters
- options: CalculatePseudoVoightHeightOptions = {}
Returns number

gaussian2DFct

gaussian2DFct(x: number, y: number, xFWHM: number, yFWHM: number): number

- Defined in shapes/2d/gaussian2D/Gaussian2D.ts:128
Parameters
- x: number
- y: number
- xFWHM: number
- yFWHM: number
Returns number

gaussianFct

gaussianFct(x: number, fwhm: number): number

- Defined in shapes/1d/gaussian/Gaussian.ts:117
Calculate the height of the gaussian function of a specific width (fwhm) at a speicifc x position (the gaussian is centered on x=0)

Parameters
- x: number
- fwhm: number
Returns number
y

gaussianFwhmToWidth

gaussianFwhmToWidth(fwhm: number): number

- Defined in shapes/1d/gaussian/Gaussian.ts:125
Parameters
- fwhm: number
Returns number

gaussianWidthToFWHM

gaussianWidthToFWHM(width: number): number

- Defined in shapes/1d/gaussian/Gaussian.ts:121
Parameters
- width: number
Returns number

getGaussian2DData

getGaussian2DData(shape: Gaussian2DClassOptions, options?: GetData2DOptions): any[]

- Defined in shapes/2d/gaussian2D/Gaussian2D.ts:139
Parameters
- shape: Gaussian2DClassOptions
- options: GetData2DOptions = {}
Returns any[]

getGaussian2DVolume

getGaussian2DVolume(options?: GetGaussian2DVolumeOptions): number

- Defined in shapes/2d/gaussian2D/Gaussian2D.ts:190
Parameters
- options: GetGaussian2DVolumeOptions = {}
Returns number

getGaussianArea

getGaussianArea(options: GetGaussianAreaOptions): number

- Defined in shapes/1d/gaussian/Gaussian.ts:129
Parameters
- options: GetGaussianAreaOptions
Returns number

getGaussianData

getGaussianData(shape?: GaussianClassOptions, options?: GetData1DOptions): Float64Array

- Defined in shapes/1d/gaussian/Gaussian.ts:141
Parameters
- shape: GaussianClassOptions = {}
- options: GetData1DOptions = {}
Returns Float64Array

getGaussianFactor

getGaussianFactor(area?: number): number

- Defined in shapes/1d/gaussian/Gaussian.ts:137
Parameters
- area: number = 0.9999
Returns number

getLorentzianArea

getLorentzianArea(options: GetLorentzianAreaOptions): number

- Defined in shapes/1d/lorentzian/Lorentzian.ts:76
Parameters
- options: GetLorentzianAreaOptions
Returns number

getLorentzianData

getLorentzianData(shape?: LorentzianClassOptions, options?: GetData1DOptions): Float64Array

- Defined in shapes/1d/lorentzian/Lorentzian.ts:104
Parameters
- shape: LorentzianClassOptions = {}
- options: GetData1DOptions = {}
Returns Float64Array

getLorentzianFactor

getLorentzianFactor(area?: number): number

- Defined in shapes/1d/lorentzian/Lorentzian.ts:93
Parameters
- area: number = 0.9999
Returns number

getPseudoVoigtArea

getPseudoVoigtArea(options: GetPseudoVoigtAreaOptions): number

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:133
Parameters
- options: GetPseudoVoigtAreaOptions
Returns number

getPseudoVoigtData

getPseudoVoigtData(shape?: PseudoVoigtClassOptions, options?: GetData1DOptions): Float64Array

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:142
Parameters
- shape: PseudoVoigtClassOptions = {}
- options: GetData1DOptions = {}
Returns Float64Array

getPseudoVoigtFactor

getPseudoVoigtFactor(area?: number, mu?: number): number

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:138
Parameters
- area: number = 0.9999
- mu: number = 0.5
Returns number

getShape1D

getShape1D(shape: Shape1D): Shape1DInstance

- Defined in shapes/1d/getShape1D.ts:10
Generate a instance of a specific kind of shape.

Parameters
- shape: Shape1D
Returns Shape1DInstance

getShape2D

getShape2D(shape: GaussianShape2D): Gaussian2D

- Defined in shapes/2d/getShape2D.ts:7
Generate a instance of a specific kind of shape.

Parameters
- shape: GaussianShape2D
Returns Gaussian2D

lorentzianFct

lorentzianFct(x: number, fwhm: number): number

- Defined in shapes/1d/lorentzian/Lorentzian.ts:81
Parameters
- x: number
- fwhm: number
Returns number

lorentzianFwhmToWidth

lorentzianFwhmToWidth(fwhm: number): number

- Defined in shapes/1d/lorentzian/Lorentzian.ts:89
Parameters
- fwhm: number
Returns number

lorentzianWidthToFWHM

lorentzianWidthToFWHM(width: number): number

- Defined in shapes/1d/lorentzian/Lorentzian.ts:85
Parameters
- width: number
Returns number

pseudoVoigtFct

pseudoVoigtFct(x: number, fwhm: number, mu: number): number

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:121
Parameters
- x: number
- fwhm: number
- mu: number
Returns number

pseudoVoigtFwhmToWidth

pseudoVoigtFwhmToWidth(fwhm: number, mu?: number): number

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:129
Parameters
- fwhm: number
- mu: number = 0.5
Returns number

pseudoVoigtWidthToFWHM

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

- Defined in shapes/1d/pseudoVoigt/PseudoVoigt.ts:125
Parameters
- width: number
- mu: number = 0.5
Returns number