TOPPPeakPickerIM::FormatDetector Class Reference

Inheritance diagram for TOPPPeakPickerIM::FormatDetector:

Collaboration diagram for TOPPPeakPickerIM::FormatDetector:

Classes
struct	FirstSpectrumRead

Public Member Functions
void	consumeSpectrum (SpectrumType &s) override
	Consume a spectrum. More...
void	consumeChromatogram (ChromatogramType &) override
	Consume a chromatogram. More...
void	setExperimentalSettings (const ExperimentalSettings &) override
	Set experimental settings (meta-data) of the data to be consumed. More...
void	setExpectedSize (size_t, size_t) override
	Set expected size of spectra and chromatograms to be consumed. More...
Public Member Functions inherited from IMSDataConsumer
virtual	~IMSDataConsumer ()

Public Attributes
IMFormat	detected_format = IMFormat::NONE

Additional Inherited Members
Public Types inherited from IMSDataConsumer
typedef MSSpectrum	SpectrumType
typedef MSChromatogram	ChromatogramType

Member Function Documentation

consumeChromatogram()

void consumeChromatogram ( ChromatogramType &  c )

inlineoverridevirtual

Consume a chromatogram.

The chromatogram will be consumed by the implementation and possibly modified.

Note

The implementation might not allow to consume spectra and chromatograms in any order

Parameters

c	The chromatogram to be consumed

Implements IMSDataConsumer.

consumeSpectrum()

void consumeSpectrum ( SpectrumType &  s )

inlineoverridevirtual

Consume a spectrum.

The spectrum will be consumed by the implementation and possibly modified.

Note

The implementation might not allow to consume spectra and chromatograms in any order

Parameters

s	The spectrum to be consumed

Implements IMSDataConsumer.

References IMTypes::determineIMFormat().

setExpectedSize()

void setExpectedSize ( size_t  expectedSpectra, size_t  expectedChromatograms  )

inlineoverridevirtual

Set expected size of spectra and chromatograms to be consumed.

Some implementations might care about the number of spectra and chromatograms to be consumed and need to be informed about this (usually before consuming starts).

Note

Calling this method is optional but good practice.

Parameters

expectedSpectra	Number of spectra expected
expectedChromatograms	Number of chromatograms expected

Implements IMSDataConsumer.

setExperimentalSettings()

void setExperimentalSettings ( const ExperimentalSettings &  exp )

inlineoverridevirtual

Set experimental settings (meta-data) of the data to be consumed.

Some implementations might need to know about the meta-data (or the context) of the spectra and chromatograms to be consumed. This method allows them learn this.

Note

Calling this method is optional but good practice.

Parameters

exp	Experimental settings meta data for the data to be consumed

Implements IMSDataConsumer.

Member Data Documentation

detected_format

IMFormat detected_format = IMFormat::NONE

Referenced by TOPPPeakPickerIM::doLowMemAlgorithm().