Class Analysis

Class allowing to store and manipulate an analysis. An analysis may contain one or more spectra that can be selected based on their units

Hierarchy

Analysis

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Analysis(options?: AnalysisOptions): Analysis

- Defined in src/Analysis.ts:36
Parameters
- options: AnalysisOptions = {}
Returns Analysis

Properties

cache

cache: Record<string, undefined | Spectrum<DoubleArray>>

id

id: string

label

label: string

spectra

spectra: Spectrum<DoubleArray>[]

spectrumCallback

spectrumCallback: undefined | SpectrumCallback

Methods

getNormalizedSpectrum

getNormalizedSpectrum(options?: NormalizedOptions): undefined | Spectrum<DoubleArray>

- Defined in src/Analysis.ts:91
Return the data object for specific x/y units with possibly some normalization options

Parameters
- options: NormalizedOptions = {}
Returns undefined | Spectrum<DoubleArray>

getSpectrum

getSpectrum(): Spectrum<DoubleArray>

- Defined in src/Analysis.ts:102
Returns the first spectrum. This method could be improved in the future

Returns Spectrum<DoubleArray>

getXLabel

getXLabel(selector: SpectrumSelector): undefined | string

- Defined in src/Analysis.ts:111
Returns the xLabel

Parameters
- selector: SpectrumSelector
Returns undefined | string

getXY

getXY(selector?: SpectrumSelector): undefined | { x: DoubleArray; y: DoubleArray }

- Defined in src/Analysis.ts:76
Retrieve a xy object

Parameters
- selector: SpectrumSelector = {}
Returns undefined | { x: DoubleArray; y: DoubleArray }

getXYSpectrum

getXYSpectrum(selector?: SpectrumSelector): undefined | Spectrum<DoubleArray>

- Defined in src/Analysis.ts:62
Retrieve a Spectrum based on x/y units

Parameters
- selector: SpectrumSelector = {}
Returns undefined | Spectrum<DoubleArray>

getYLabel

getYLabel(selector: SpectrumSelector): undefined | string

- Defined in src/Analysis.ts:120
Returns the yLabel

Parameters
- selector: SpectrumSelector
Returns undefined | string

pushSpectrum

pushSpectrum(variables: SpectrumVariables<DoubleArray>, options?: Omit<Spectrum<DoubleArray>, "variables">): void

- Defined in src/Analysis.ts:47
Add a spectrum in the internal spectra variable

Parameters
- variables: SpectrumVariables<DoubleArray>
- options: Omit<Spectrum<DoubleArray>, "variables"> = {}
Returns void