OnDiscMSExperiment

class pyopenms.OnDiscMSExperiment

Bases: object

Cython implementation of _OnDiscMSExperiment

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1OnDiscMSExperiment.html

Representation of a mass spectrometry experiment on disk.

__init__()

  • Cython signature: void OnDiscMSExperiment()

  • Cython signature: void OnDiscMSExperiment(OnDiscMSExperiment &)

Methods

__init__

  • Cython signature: void OnDiscMSExperiment()

getChromatogram

Cython signature: MSChromatogram getChromatogram(size_t id)

getChromatogramById

Cython signature: shared_ptr[_Interfaces_Chromatogram] getChromatogramById(int id_) Returns a single chromatogram

getChromatogramByNativeId

Cython signature: MSChromatogram getChromatogramByNativeId(String id)

getExperimentalSettings

Cython signature: shared_ptr[const ExperimentalSettings] getExperimentalSettings() Returns the meta information of this experiment (const access)

getMetaData

Cython signature: shared_ptr[MSExperiment] getMetaData() Returns the meta information of this experiment

getNrChromatograms

Cython signature: size_t getNrChromatograms() Returns the total number of chromatograms available

getNrSpectra

Cython signature: size_t getNrSpectra() Returns the total number of spectra available

getSpectrum

Cython signature: MSSpectrum getSpectrum(size_t id)

getSpectrumById

Cython signature: shared_ptr[_Interfaces_Spectrum] getSpectrumById(int id_) Returns a single spectrum

getSpectrumByNativeId

Cython signature: MSSpectrum getSpectrumByNativeId(String id)

openFile

  • Cython signature: bool openFile(String filename)

setSkipXMLChecks

Cython signature: void setSkipXMLChecks(bool skip) Sets whether to skip some XML checks and be fast instead
getChromatogram()

Cython signature: MSChromatogram getChromatogram(size_t id)

Parameters

id – The index of the chromatogram

getChromatogramById()

Cython signature: shared_ptr[_Interfaces_Chromatogram] getChromatogramById(int id_) Returns a single chromatogram

getChromatogramByNativeId()

Cython signature: MSChromatogram getChromatogramByNativeId(String id)

Parameters

id – The native identifier of the chromatogram

getExperimentalSettings()

Cython signature: shared_ptr[const ExperimentalSettings] getExperimentalSettings() Returns the meta information of this experiment (const access)

getMetaData()

Cython signature: shared_ptr[MSExperiment] getMetaData() Returns the meta information of this experiment

getNrChromatograms()

Cython signature: size_t getNrChromatograms() Returns the total number of chromatograms available

getNrSpectra()

Cython signature: size_t getNrSpectra() Returns the total number of spectra available

getSpectrum()

Cython signature: MSSpectrum getSpectrum(size_t id)

Parameters

id – The index of the spectrum

getSpectrumById()

Cython signature: shared_ptr[_Interfaces_Spectrum] getSpectrumById(int id_) Returns a single spectrum

getSpectrumByNativeId()

Cython signature: MSSpectrum getSpectrumByNativeId(String id)

Parameters

id – The native identifier of the spectrum

openFile()

  • Cython signature: bool openFile(String filename)

  • Cython signature: bool openFile(String filename, bool skipLoadingMetaData)

returns: Whether the parsing of the file was successful (if false, the file most likely was not an indexed mzML file)

setSkipXMLChecks()

Cython signature: void setSkipXMLChecks(bool skip) Sets whether to skip some XML checks and be fast instead