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:

Collaboration diagram for QCBase:

Classes
class	SpectraMap
	Map to find a spectrum via its NativeID. More...

Public Types
enum class	Requires : UInt64 {   NOTHING , RAWMZML , POSTFDRFEAT , PREFDRFEAT ,   CONTAMINANTS , TRAFOALIGN , ID , SIZE_OF_REQUIRES }
	Enum to encode a file type as a bit. More...
enum class	ToleranceUnit { AUTO , PPM , DA , SIZE_OF_TOLERANCEUNIT }
using	Status = FlagSet< Requires >

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...
bool	isRunnable (const Status &s) const

Static Public Member Functions
static bool	isLabeledExperiment (const ConsensusMap &cm)
	check if the IsobaricAnalyzer TOPP tool was used to create this ConsensusMap More...
template<typename MAP >
static bool	hasPepID (const MAP &fmap)
	does the container have a PeptideIdentification in its members or as unassignedPepID ? More...

Static Public Attributes
static const std::string	names_of_requires []
	strings corresponding to enum Requires More...
static const std::string	names_of_toleranceUnit []
	strings corresponding to enum ToleranceUnit 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 Typedef Documentation

Status

using Status = FlagSet<Requires>

Member Enumeration Documentation

Requires

enum Requires : UInt64

strong

Enum to encode a file type as a bit.

Enumerator
NOTHING
RAWMZML
POSTFDRFEAT
PREFDRFEAT
CONTAMINANTS
TRAFOALIGN
ID
SIZE_OF_REQUIRES

ToleranceUnit

enum ToleranceUnit

strong

Enumerator
AUTO
PPM
DA
SIZE_OF_TOLERANCEUNIT

Member Function Documentation

getName()

virtual const String& getName ( ) const

pure virtual

Returns the name of the metric.

Implemented in TIC, SpectrumCount, RTAlignment, PSMExplainedIonCurrent, PeptideMass, MzCalibration, Ms2SpectrumStats, Ms2IdentificationRate, MissedCleavages, IdentificationSummary, FWHM, FragmentMassError, FeatureSummary, and Contaminants.

hasPepID()

static bool hasPepID ( const MAP &  fmap )

inlinestatic

does the container have a PeptideIdentification in its members or as unassignedPepID ?

isLabeledExperiment()

static bool isLabeledExperiment ( const ConsensusMap &  cm )

static

check if the IsobaricAnalyzer TOPP tool was used to create this ConsensusMap

isRunnable()

bool isRunnable

(

const Status &

s

)

const

tests if a metric has the required input files gives a warning with the name of the metric that can not be performed

requires()

virtual Status requires ( ) const

pure virtual

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

Implemented in TIC, SpectrumCount, RTAlignment, PSMExplainedIonCurrent, PeptideMass, MzCalibration, Ms2SpectrumStats, Ms2IdentificationRate, MissedCleavages, IdentificationSummary, FWHM, FragmentMassError, FeatureSummary, and Contaminants.

Member Data Documentation

names_of_requires

const std::string names_of_requires[]

static

strings corresponding to enum Requires

names_of_toleranceUnit

const std::string names_of_toleranceUnit[]

static

strings corresponding to enum ToleranceUnit