OpenMS  2.7.0
Public Member Functions | Private Attributes | List of all members
SpectrumCount Class Reference

#include <OpenMS/QC/SpectrumCount.h>

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

Public Member Functions

 SpectrumCount ()=default
 Constructor. More...
 
virtual ~SpectrumCount ()=default
 Destructor. More...
 
std::map< Size, UIntcompute (const MSExperiment &exp)
 Compute number of spectra per MS level and returns them in a map. 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_ = "SpectrumCount"
 

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

◆ SpectrumCount()

SpectrumCount ( )
default

Constructor.

◆ ~SpectrumCount()

virtual ~SpectrumCount ( )
virtualdefault

Destructor.

Member Function Documentation

◆ compute()

std::map<Size, UInt> compute ( const MSExperiment exp)

Compute number of spectra per MS level and returns them in a map.

Parameters
expMSExperiment containing the spectra to be counted
Returns
SpectrumCount

◆ 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_ = "SpectrumCount"
private