OpenMS  2.5.0
Public Member Functions | Private Attributes | List of all members
MissedCleavages Class Reference

This class is a metric for the QualityControl TOPP Tool. More...

#include <OpenMS/QC/MissedCleavages.h>

Inheritance diagram for MissedCleavages:
QCBase

Public Member Functions

 MissedCleavages ()=default
 constructor More...
 
virtual ~MissedCleavages ()=default
 destructor More...
 
void compute (FeatureMap &fmap)
 Counts the number of MissedCleavages per PeptideIdentification. More...
 
const StringgetName () const override
 returns the name of the metric More...
 
const std::vector< std::map< UInt32, UInt32 > > & getResults () const
 returns the result as maps of #missed_cleavages –> counts; one map for each call to compute(...) More...
 
QCBase::Status requires () const override
 Returns the input data requirements of the compute(...) function. More...
 

Private Attributes

const String name_ = "MissedCleavages"
 name of the metric More...
 
std::vector< std::map< UInt32, UInt32 > > mc_result_
 container that stores results More...
 

Additional Inherited Members

- Public Types inherited from QCBase
enum  Requires : UInt64 {
  FAIL, RAWMZML, POSTFDRFEAT, PREFDRFEAT,
  CONTAMINANTS, TRAFOALIGN, SIZE_OF_REQUIRES
}
 Enum to encode a file type as a bit. More...
 
- Static Public Member Functions inherited from QCBase
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 inherited from QCBase
static const std::string names_of_requires []
 strings corresponding to enum Requires More...
 

Detailed Description

This class is a metric for the QualityControl TOPP Tool.

This class counts the number of MissedCleavages per PeptideIdentification given a FeatureMap and returns an agglomeration statistic (observed counts). Additionally the PeptideHits in the FeatureMap are augmented with MetaInformation:

Constructor & Destructor Documentation

◆ MissedCleavages()

MissedCleavages ( )
default

constructor

◆ ~MissedCleavages()

virtual ~MissedCleavages ( )
virtualdefault

destructor

Member Function Documentation

◆ compute()

void compute ( FeatureMap fmap)

Counts the number of MissedCleavages per PeptideIdentification.

The result is a key/value map: #missed_cleavages –> counts Additionally the first PeptideHit in each PeptideIdentification of the FeatureMap is annotated with metavalue 'missed_cleavages'. The protease and digestion parameters are taken from the first ProteinIdentication (and SearchParamter therein) within the FeatureMap itself.

Parameters
fmapFeatureMap with Peptide and ProteinIdentifications

◆ getName()

const String& getName ( ) const
overridevirtual

returns the name of the metric

Implements QCBase.

◆ getResults()

const std::vector<std::map<UInt32, UInt32> >& getResults ( ) const

returns the result as maps of #missed_cleavages –> counts; one map for each call to compute(...)

◆ requires()

QCBase::Status requires ( ) const
overridevirtual

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

Returns
Status for POSTFDRFEAT;

Implements QCBase.

Member Data Documentation

◆ mc_result_

std::vector<std::map<UInt32, UInt32> > mc_result_
private

container that stores results

◆ name_

const String name_ = "MissedCleavages"
private

name of the metric