Class Analysis

constructor

• new Analysis(options?): Analysis

• Parameters

  • options: AnalysisOptions = {}

  Returns Analysis

id

label

spectra

spectrumCallback

clone

• clone(__namedParameters): Analysis

• Parameters

  • __namedParameters: {
        filter: {
            ids?: string[];
        };
    }

    • filter: {
          ids?: string[];
      }

      • Optional ids?: string[]

  Returns Analysis

getNormalizedSpectra

• getNormalizedSpectra(options?): Spectrum<DoubleArray>[]

• Parameters

  • options: NormalizedOptions = {}

  Returns Spectrum<DoubleArray>[]

getNormalizedSpectrum

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

• 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>

• Returns the first spectrum. This method could be improved in the future

  Returns Spectrum<DoubleArray>

getXLabel

• getXLabel(selector): undefined | string

• Returns the xLabel

  Parameters

  • selector: SpectrumSelector

  Returns undefined | string

getXY

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

• Retrieve a xy object

  Parameters

  • selector: SpectrumSelector = {}

  Returns undefined | {
      x: DoubleArray;
      y: DoubleArray;
  }

getXYSpectra

• getXYSpectra(selector?): Spectrum<DoubleArray>[]

• Retrieve spectra matching selector

  Parameters

  • selector: SpectrumSelector = {}

  Returns Spectrum<DoubleArray>[]

getXYSpectrum

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

• Retrieve a Spectrum based on x/y units

  Parameters

  • selector: SpectrumSelector = {}

  Returns undefined | Spectrum<DoubleArray>

getYLabel

• getYLabel(selector): undefined | string

• Returns the yLabel

  Parameters

  • selector: SpectrumSelector

  Returns undefined | string

pushSpectrum

• pushSpectrum(variables, options?): void

• Add a spectrum in the internal spectra variable

  Parameters

  • variables: SpectrumVariables<DoubleArray>

  • options: Omit<Spectrum<DoubleArray>, "variables"> = {}

  Returns void

toJSON

• toJSON(): {
      id: string;
      label: string;
      spectra: any;
  }

• Returns {
      id: string;
      label: string;
      spectra: any;
  }

  • id: string

  • label: string

  • spectra: any

Static fromJSON

• fromJSON(json): Analysis

• Parameters

  • json: any

  Returns Analysis