OnDiscMSExperiment

class pyopenms.OnDiscMSExperiment

Bases: object

Cython implementation of _OnDiscMSExperiment

Original C++ documentation is available here

Representation of a mass spectrometry experiment on disk.

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: OnDiscMSExperiment) → None

Methods

__init__	Overload:
getChromatogram(self, id)	Returns a single chromatogram
getChromatogramById(self, id_)	Returns a single chromatogram
getChromatogramByNativeId(self, id)	Returns a single chromatogram
getExperimentalSettings(self)	Returns the meta information of this experiment (const access)
getMetaData(self)	Returns the meta information of this experiment
getNrChromatograms(self)	Returns the total number of chromatograms available
getNrSpectra(self)	Returns the total number of spectra available
getSpectrum(self, id)	Returns a single spectrum
getSpectrumById(self, id_)	Returns a single spectrum
getSpectrumByNativeId(self, id)	Returns a single spectrum
openFile	Overload:
setSkipXMLChecks(self, skip)	Sets whether to skip some XML checks and be fast instead

getChromatogram(self, id: int) → MSChromatogram

Returns a single chromatogram

Parameters:

id – The index of the chromatogram

getChromatogramById(self, id_: int) → _Interfaces_Chromatogram

Returns a single chromatogram

getChromatogramByNativeId(self, id: bytes | str | String) → MSChromatogram

Returns a single chromatogram

Parameters:

id – The native identifier of the chromatogram

getExperimentalSettings(self) → ExperimentalSettings

Returns the meta information of this experiment (const access)

getMetaData(self) → MSExperiment

Returns the meta information of this experiment

getNrChromatograms(self) → int

Returns the total number of chromatograms available

getNrSpectra(self) → int

Returns the total number of spectra available

getSpectrum(self, id: int) → MSSpectrum

Returns a single spectrum

Parameters:

id – The index of the spectrum

getSpectrumById(self, id_: int) → _Interfaces_Spectrum

Returns a single spectrum

getSpectrumByNativeId(self, id: bytes | str | String) → MSSpectrum

Returns a single spectrum

Parameters:

id – The native identifier of the spectrum

openFile()

Overload:

openFile(self, filename: bytes | str | String) → bool

Overload:

openFile(self, filename: bytes | str | String, skipLoadingMetaData: bool) → bool

Open a specific file on disk

This tries to read the indexed mzML by parsing the index and then reading the meta information into memory

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

setSkipXMLChecks(self, skip: bool) → None

Sets whether to skip some XML checks and be fast instead