IMTypes Class Reference

#include <OpenMS/IONMOBILITY/IMTypes.h>

Collaboration diagram for IMTypes:

Static Public Member Functions
static IMFormat	determineIMFormat (const MSExperiment &exp)
static IMFormat	determineIMFormat (const MSSpectrum &spec)
	Checks for existence of a single driftTime (using spec.getDriftTime()) or an ion-mobility float data array (using spec.hasIMData()) More...
static DIM_UNIT	fromIMUnit (const DriftTimeUnit from)

Static Public Attributes
static constexpr double	DRIFTTIME_NOT_SET = -1.0
	If drift time for a spectrum is unavailable (i.e. not an IM spectrum), it will have this value. More...

Member Function Documentation

determineIMFormat() [1/2]

static IMFormat determineIMFormat ( const MSExperiment &  exp )

static

Checks the all spectra for their type (see overload) and returns the common type (or IMFormat::MIXED if both CONCATENATED and MULTIPLE_SPECTRA are present) If exp is empty or contains no IM spectra at all, IMFormat::NONE is returned

Exceptions

Exception::InvalidValue

if IM values are annotated as single drift time and float array for any single spectrum

Referenced by TOPPPeakPickerIM::FormatDetector::consumeSpectrum(), and TOPPPeakPickerIM::main_().

determineIMFormat() [2/2]

static IMFormat determineIMFormat ( const MSSpectrum &  spec )

static

Checks for existence of a single driftTime (using spec.getDriftTime()) or an ion-mobility float data array (using spec.hasIMData())

If neither is found, IMFormat::NONE is returned. If a single drift time (== IMFormat::MULTIPLE_SPECTRA) is found, but no unit, a warning is issued.

Exceptions

Exception::InvalidValue

if IM values are annotated as single drift time and float array in the given spectrum

fromIMUnit()

static DIM_UNIT fromIMUnit ( const DriftTimeUnit  from )

static

Parameters

from	Drift unit to convert from

Returns

A more general DIM_UNIT (or exception)

Exceptions

Exception::ConversionError

if from has invalid value (e.g. 'NONE')

Referenced by TOPPViewBase::showCurrentPeaksAsIonMobility().

Member Data Documentation

DRIFTTIME_NOT_SET

constexpr double DRIFTTIME_NOT_SET = -1.0

inlinestaticconstexpr

If drift time for a spectrum is unavailable (i.e. not an IM spectrum), it will have this value.