Class SpectrumGenerator

Hierarchy

SpectrumGenerator

Index

Constructors

Properties

Methods

addBaseline addNoise addPeak addPeaks getSpectrum reset

Constructors

constructor

new SpectrumGenerator(options?: OptionsSG1D): SpectrumGenerator
Parameters
- options: OptionsSG1D = {}
Returns SpectrumGenerator
- Defined in src/SpectrumGenerator.ts:113

Properties

interval

interval: number

Methods

addBaseline

addBaseline(baselineFct: NumToNumFn): SpectrumGenerator
Add a baseline to the spectrum.
Parameters
- baselineFct: NumToNumFn
  
  Mathematical function producing the baseline you want.
Returns SpectrumGenerator
- Defined in src/SpectrumGenerator.ts:302

addNoise

addNoise(options?: NoiseOptions): SpectrumGenerator
Add noise to the spectrum.
Parameters
- Optional options: NoiseOptions
Returns SpectrumGenerator
- Defined in src/SpectrumGenerator.ts:312

addPeak

addPeak(peak: Peak1D, options?: PeakOptions): void
Add a single peak to the spectrum. A peak may be either defined as [x,y,fwhm,...] or as {x, y, shape}
Parameters
- peak: Peak1D
- options: PeakOptions = {}
Returns void
- Defined in src/SpectrumGenerator.ts:187

addPeaks

addPeaks(peaks: PeakSeries | Peak1D[], options?: PeakOptions): void
Add a series of peaks to the spectrum.
Parameters
- peaks: PeakSeries | Peak1D[]
  
  Peaks to add.
- Optional options: PeakOptions
Returns void
- Defined in src/SpectrumGenerator.ts:156

getSpectrum

getSpectrum(options?: boolean | GetSpectrumOptions): DataXY<Float64Array>
Get the generated spectrum.
Parameters
- options: boolean | GetSpectrumOptions = {}
Returns DataXY<Float64Array>
- Defined in src/SpectrumGenerator.ts:320

reset

reset(): SpectrumGenerator
Resets the generator with an empty spectrum.

Returns SpectrumGenerator
- Defined in src/SpectrumGenerator.ts:350