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

#include <OpenMS/QC/TIC.h>

Inheritance diagram for TIC:
QCBase

Public Member Functions

 TIC ()=default
 Constructor. More...
 
virtual ~TIC ()=default
 Destructor. More...
 
void clear ()
 
void compute (const MSExperiment &exp, float bin_size=0)
 Compute Total Ion Count and applies the resampling algorithm, if a bin size in RT seconds greater than 0 is given. More...
 
const StringgetName () const override
 Returns the name of the metric. More...
 
const std::vector< MSChromatogram > & getResults () const
 
QCBase::Status requires () const override
 Returns the input data requirements of the compute(...) function. More...
 

Private Attributes

const String name_ = "TIC"
 
std::vector< MSChromatogramresults_
 

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...
 

Constructor & Destructor Documentation

◆ TIC()

TIC ( )
default

Constructor.

◆ ~TIC()

virtual ~TIC ( )
virtualdefault

Destructor.

Member Function Documentation

◆ clear()

void clear ( )

◆ compute()

void compute ( const MSExperiment exp,
float  bin_size = 0 
)

Compute Total Ion Count and applies the resampling algorithm, if a bin size in RT seconds greater than 0 is given.

All MS1 TICs within a bin are summed up.

Parameters
expPeak map to compute the MS1 tick from
bin_sizeRT bin size in seconds
Returns
TIC Chromatogram

◆ getName()

const String& getName ( ) const
overridevirtual

Returns the name of the metric.

Implements QCBase.

◆ getResults()

const std::vector<MSChromatogram>& getResults ( ) const

◆ requires()

QCBase::Status requires ( ) const
overridevirtual

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

Implements QCBase.

Member Data Documentation

◆ name_

const String name_ = "TIC"
private

◆ results_

std::vector<MSChromatogram> results_
private