Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Static Public Member Functions | Protected Types | Private Member Functions

MapAlignmentEvaluationAlgorithm Class Reference

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

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

Inheritance diagram for MapAlignmentEvaluationAlgorithm:
MapAlignmentEvaluationAlgorithmPrecision MapAlignmentEvaluationAlgorithmRecall

List of all members.

Public Member Functions

 MapAlignmentEvaluationAlgorithm ()
 Default constructor.
virtual ~MapAlignmentEvaluationAlgorithm ()
 Destructor.
virtual void evaluate (const ConsensusMap &conensus_map_in, const ConsensusMap &consensus_map_gt, const DoubleReal &rt_dev, const DoubleReal &mz_dev, const Peak2D::IntensityType &int_dev, const bool use_charge, DoubleReal &out)=0
 Applies the algorithm. The input consensus map is compared to the ground truth.
bool isSameHandle (const FeatureHandle &lhs, const FeatureHandle &rhs, const DoubleReal &rt_dev, const DoubleReal &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.

Static Public Member Functions

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

Protected Types

typedef
ConsensusFeature::HandleSetType::const_iterator 
HandleIterator

Private Member Functions

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

Detailed Description

Base class for all Caap evaluation algorithms.

These algorithms evaluates alignment results against a ground truth.


Member Typedef Documentation

typedef ConsensusFeature::HandleSetType::const_iterator HandleIterator [protected]

Constructor & Destructor Documentation

Default constructor.

virtual ~MapAlignmentEvaluationAlgorithm (  )  [virtual]

Destructor.

Copy constructor is not implemented -> private.


Member Function Documentation

virtual void evaluate ( const ConsensusMap conensus_map_in,
const ConsensusMap consensus_map_gt,
const DoubleReal rt_dev,
const DoubleReal mz_dev,
const Peak2D::IntensityType int_dev,
const bool  use_charge,
DoubleReal out 
) [pure virtual]

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

Implemented in MapAlignmentEvaluationAlgorithmPrecision, and MapAlignmentEvaluationAlgorithmRecall.

bool isSameHandle ( const FeatureHandle lhs,
const FeatureHandle rhs,
const DoubleReal rt_dev,
const DoubleReal 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.

MapAlignmentEvaluationAlgorithm& operator= ( const MapAlignmentEvaluationAlgorithm  )  [private]

Assignment operator is not implemented -> private.

static void registerChildren (  )  [static]

Register all derived classes in this method.


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:49 using doxygen 1.7.1