OpenMS  2.8.0
Classes | Public Member Functions | Private Attributes | List of all members
FeatureSummary Class Reference

#include <OpenMS/QC/FeatureSummary.h>

Inheritance diagram for FeatureSummary:
[legend]
Collaboration diagram for FeatureSummary:
[legend]

Classes

struct  Result
 

Public Member Functions

 FeatureSummary ()=default
 Constructor. More...
 
virtual ~FeatureSummary ()=default
 Destructor. More...
 
Result compute (const FeatureMap &feature_map)
 computes a summary of a featureXML file More...
 
const StringgetName () const override
 Returns the name of the metric. More...
 
QCBase::Status requires () const override
 Returns the input data requirements of the compute(...) function. More...
 
- Public Member Functions inherited from QCBase
bool isRunnable (const Status &s) const
 

Private Attributes

const String name_ = "Summary of features from featureXML file"
 

Additional Inherited Members

- Public Types inherited from QCBase
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 >
 
- Static Public Member Functions inherited from QCBase
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 inherited from QCBase
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...
 

Constructor & Destructor Documentation

◆ FeatureSummary()

FeatureSummary ( )
default

Constructor.

◆ ~FeatureSummary()

virtual ~FeatureSummary ( )
virtualdefault

Destructor.

Member Function Documentation

◆ compute()

Result compute ( const FeatureMap feature_map)

computes a summary of a featureXML file

Parameters
feature_mapFeatureMap
Returns
result object with summary values: number of detected compounds (detected_compounds), retention time shift mean (rt_shift_mean)

◆ getName()

const String& getName ( ) const
overridevirtual

Returns the name of the metric.

Implements QCBase.

◆ requires()

QCBase::Status requires ( ) const
overridevirtual

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

Implements QCBase.

Member Data Documentation

◆ name_

const String name_ = "Summary of features from featureXML file"
private