QCBase Class Reference

This class serves as an abstract base class for all QC classes. More...

#include <OpenMS/QC/QCBase.h>

Inheritance diagram for QCBase:

Classes
class	SpectraMap
	Map to find a spectrum via its NativeID. More...
class	Status
	Storing a status of available/needed inputs (i.e. a set of Requires) as UInt64. More...

Public Types
enum	Requires : UInt64 {   FAIL, RAWMZML, POSTFDRFEAT, PREFDRFEAT,   CONTAMINANTS, TRAFOALIGN, SIZE_OF_REQUIRES }
	Enum to encode a file type as a bit. More...

Public Member Functions
virtual const String &	getName () const =0
	Returns the name of the metric. More...
virtual Status	requires () const =0
	Returns the input data requirements of the compute(...) function. More...

Static Public Member Functions
template<typename MAP , typename T >
static void	iterateFeatureMap (MAP &fmap, T lambda)
	function, which iterates through all PeptideIdentifications of a given FeatureMap and applies a given lambda function More...

Static Public Attributes
static const std::string	names_of_requires []
	strings corresponding to enum Requires More...

Detailed Description

This class serves as an abstract base class for all QC classes.

It contains the important feature of encoding the input requirements for a certain QC.

Member Enumeration Documentation

Requires

enum Requires : UInt64

strong

Enum to encode a file type as a bit.

Enumerator
FAIL
RAWMZML
POSTFDRFEAT
PREFDRFEAT
CONTAMINANTS
TRAFOALIGN
SIZE_OF_REQUIRES

Member Function Documentation

getName()

virtual const String& getName ( ) const

pure virtual

Returns the name of the metric.

Implemented in Contaminants, Ms2SpectrumStats, Ms2IdentificationRate, FragmentMassError, MzCalibration, RTAlignment, MissedCleavages, and TIC.

iterateFeatureMap()

static void iterateFeatureMap ( MAP &  fmap, T  lambda  )

inlinestatic

function, which iterates through all PeptideIdentifications of a given FeatureMap and applies a given lambda function

The Lambda may or may not change the PeptideIdentification

requires()

virtual Status requires ( ) const

pure virtual

Returns the input data requirements of the compute(...) function.

Implemented in Contaminants, FragmentMassError, Ms2IdentificationRate, Ms2SpectrumStats, MissedCleavages, RTAlignment, MzCalibration, and TIC.

Member Data Documentation

names_of_requires

const std::string names_of_requires[]

static

strings corresponding to enum Requires