PlainMSDataWritingConsumer

class pyopenms.PlainMSDataWritingConsumer

Bases: object

Cython implementation of _PlainMSDataWritingConsumer

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

__init__()

Cython signature: void PlainMSDataWritingConsumer(String filename)

Methods

__init__	Cython signature: void PlainMSDataWritingConsumer(String filename)
addDataProcessing	Cython signature: void addDataProcessing(DataProcessing d)
consumeChromatogram	Cython signature: void consumeChromatogram(MSChromatogram & c)
consumeSpectrum	Cython signature: void consumeSpectrum(MSSpectrum & s)
getNrChromatogramsWritten	Cython signature: size_t getNrChromatogramsWritten() Returns the number of chromatograms written
getNrSpectraWritten	Cython signature: size_t getNrSpectraWritten() Returns the number of spectra written
getOptions	Cython signature: PeakFileOptions getOptions()
setExpectedSize	Cython signature: void setExpectedSize(size_t expectedSpectra, size_t expectedChromatograms)
setExperimentalSettings	Cython signature: void setExperimentalSettings(ExperimentalSettings & exp)
setOptions	Cython signature: void setOptions(PeakFileOptions opt)

addDataProcessing()

Cython signature: void addDataProcessing(DataProcessing d)

The provided DataProcessing object will be added to each chromatogram and spectrum written to to the mzML file —– :param d: The DataProcessing object to be added

consumeChromatogram()

Cython signature: void consumeChromatogram(MSChromatogram & c)

consumeSpectrum()

Cython signature: void consumeSpectrum(MSSpectrum & s)

getNrChromatogramsWritten()

Cython signature: size_t getNrChromatogramsWritten() Returns the number of chromatograms written

getNrSpectraWritten()

Cython signature: size_t getNrSpectraWritten() Returns the number of spectra written

getOptions()

Cython signature: PeakFileOptions getOptions()

setExpectedSize()

Cython signature: void setExpectedSize(size_t expectedSpectra, size_t expectedChromatograms)

These numbers will be written in the spectrumList and chromatogramList tag in the mzML file. Therefore, these will contain wrong numbers if the expected size is not set correctly —– :param expectedSpectra: Number of spectra expected :param expectedChromatograms: Number of chromatograms expected

setExperimentalSettings()

Cython signature: void setExperimentalSettings(ExperimentalSettings & exp)

Parameters

exp – Experimental settings to be used for this file (from this

and the first spectrum/chromatogram, the class will deduce most of the header of the mzML file)

setOptions()

Cython signature: void setOptions(PeakFileOptions opt)