| OpenMS 2.5.0

Public Member Functions | Static Public Member Functions | Protected Types | Private Member Functions | List of all members
MapAlignmentEvaluationAlgorithm Class Referenceabstract

Base class for all Caap evaluation algorithms. More...

`#include <OpenMS/ANALYSIS/MAPMATCHING/MapAlignmentEvaluationAlgorithm.h>`

Inheritance diagram for MapAlignmentEvaluationAlgorithm:

## Public Member Functions

| MapAlignmentEvaluationAlgorithm ()
| Default constructor. More...
virtual | ~MapAlignmentEvaluationAlgorithm ()
| Destructor. More...
virtual void | evaluate (const ConsensusMap &conensus_map_in, const ConsensusMap &consensus_map_gt, const double &rt_dev, const double &mz_dev, const Peak2D::IntensityType &int_dev, const bool use_charge, double &out)=0
| Applies the algorithm. The input consensus map is compared to the ground truth. More...
bool | isSameHandle (const FeatureHandle &lhs, const FeatureHandle &rhs, const double &rt_dev, const double &mz_dev, const Peak2D::IntensityType &int_dev, const bool use_charge)
| Decides if two features are the same, based on maximum allowed deviations for retention time, m/z and intensity. More...

## Static Public Member Functions

static void | registerChildren ()
| Register all derived classes in this method. More...

## Protected Types

typedef ConsensusFeature::HandleSetType::const_iterator | HandleIterator

## Private Member Functions

| MapAlignmentEvaluationAlgorithm (const MapAlignmentEvaluationAlgorithm &)
| Copy constructor is not implemented -> private. More...
MapAlignmentEvaluationAlgorithm & | operator= (const MapAlignmentEvaluationAlgorithm &)
| Assignment operator is not implemented -> private. More...

## Detailed Description

Base class for all Caap evaluation algorithms.

These algorithms evaluates alignment results against a ground truth.

## Member Typedef Documentation

## ◆ HandleIterator

typedef ConsensusFeature::HandleSetType::const_iterator HandleIterator

protected

## Constructor & Destructor Documentation

## ◆ MapAlignmentEvaluationAlgorithm() [1/2]

MapAlignmentEvaluationAlgorithm | ( |  | ) |

Default constructor.

## ◆ ~MapAlignmentEvaluationAlgorithm()

virtual ~MapAlignmentEvaluationAlgorithm | ( |  | ) |

virtual

Destructor.

## ◆ MapAlignmentEvaluationAlgorithm() [2/2]

MapAlignmentEvaluationAlgorithm | ( | const MapAlignmentEvaluationAlgorithm & |  | ) |

private

Copy constructor is not implemented -> private.

## Member Function Documentation

## ◆ evaluate()

virtual void evaluate | ( | const ConsensusMap & | conensus_map_in,
|  | const ConsensusMap & | consensus_map_gt,
|  | const double & | rt_dev,
|  | const double & | mz_dev,
|  | const Peak2D::IntensityType & | int_dev,
|  | const bool | use_charge,
|  | double & | out
| ) |  |

pure virtual

Applies the algorithm. The input consensus map is compared to the ground truth.

Implemented in MapAlignmentEvaluationAlgorithmPrecision, and MapAlignmentEvaluationAlgorithmRecall.

## ◆ isSameHandle()

bool isSameHandle | ( | const FeatureHandle & | lhs,
|  | const FeatureHandle & | rhs,
|  | const double & | rt_dev,
|  | const double & | mz_dev,
|  | const Peak2D::IntensityType & | int_dev,
|  | const bool | use_charge
| ) |  |

Decides if two features are the same, based on maximum allowed deviations for retention time, m/z and intensity.

## ◆ operator=()

MapAlignmentEvaluationAlgorithm& operator= | ( | const MapAlignmentEvaluationAlgorithm & |  | ) |

private

Assignment operator is not implemented -> private.

## ◆ registerChildren()

static void registerChildren | ( |  | ) |

static

Register all derived classes in this method.