| OpenMS 2.5.0

Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
MapAlignmentEvaluationAlgorithmPrecision Class Reference

Caap evaluation algorithm to obtain a precision value. More...

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

Inheritance diagram for MapAlignmentEvaluationAlgorithmPrecision:

## Public Member Functions

| MapAlignmentEvaluationAlgorithmPrecision ()
| Default constructor. More...
| ~MapAlignmentEvaluationAlgorithmPrecision () override
| Destructor. More...
void | evaluate (const ConsensusMap &consensus_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) override
| Applies the algorithm. More...
Public Member Functions inherited from MapAlignmentEvaluationAlgorithm
| MapAlignmentEvaluationAlgorithm ()
| Default constructor. More...
virtual | ~MapAlignmentEvaluationAlgorithm ()
| Destructor. 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 MapAlignmentEvaluationAlgorithm * | create ()
| Creates a new instance of this class (for Factory) More...
static String | getProductName ()
| Returns the product name (for the Factory) More...
Static Public Member Functions inherited from MapAlignmentEvaluationAlgorithm
static void | registerChildren ()
| Register all derived classes in this method. More...

## Private Member Functions

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

## Additional Inherited Members

Protected Types inherited from MapAlignmentEvaluationAlgorithm
typedef ConsensusFeature::HandleSetType::const_iterator | HandleIterator

## Detailed Description

Caap evaluation algorithm to obtain a precision value.

It evaluates an input consensus map with respect to a ground truth.

## Constructor & Destructor Documentation

## ◆ MapAlignmentEvaluationAlgorithmPrecision() [1/2]

MapAlignmentEvaluationAlgorithmPrecision | ( |  | ) |

Default constructor.

## ◆ ~MapAlignmentEvaluationAlgorithmPrecision()

~MapAlignmentEvaluationAlgorithmPrecision | ( |  | ) |

override

Destructor.

## ◆ MapAlignmentEvaluationAlgorithmPrecision() [2/2]

MapAlignmentEvaluationAlgorithmPrecision | ( | const MapAlignmentEvaluationAlgorithmPrecision & |  | ) |

private

Copy constructor intentionally not implemented -> private.

## Member Function Documentation

## ◆ create()

static MapAlignmentEvaluationAlgorithm* create | ( |  | ) |

inline static

Creates a new instance of this class (for Factory)

## ◆ evaluate()

void evaluate | ( | const ConsensusMap & | consensus_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
| ) |  |

override virtual

Applies the algorithm.

Implements MapAlignmentEvaluationAlgorithm.

## ◆ getProductName()

static String getProductName | ( |  | ) |

inline static

Returns the product name (for the Factory)

## ◆ operator=()

MapAlignmentEvaluationAlgorithmPrecision& operator= | ( | const MapAlignmentEvaluationAlgorithmPrecision & |  | ) |

private

Assignment operator intentionally not implemented -> private.