MapAlignmentEvaluationAlgorithmRecall Class Reference

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

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

Inheritance diagram for MapAlignmentEvaluationAlgorithmRecall:

Collaboration diagram for MapAlignmentEvaluationAlgorithmRecall:

Public Member Functions
	MapAlignmentEvaluationAlgorithmRecall ()
	Default constructor. More...
	~MapAlignmentEvaluationAlgorithmRecall () 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
	MapAlignmentEvaluationAlgorithmRecall (const MapAlignmentEvaluationAlgorithmRecall &)
	Copy constructor intentionally not implemented -> private. More...
MapAlignmentEvaluationAlgorithmRecall &	operator= (const MapAlignmentEvaluationAlgorithmRecall &)
	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 recall value.

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

Constructor & Destructor Documentation

MapAlignmentEvaluationAlgorithmRecall() [1/2]

MapAlignmentEvaluationAlgorithmRecall

(

)

Default constructor.

~MapAlignmentEvaluationAlgorithmRecall()

~MapAlignmentEvaluationAlgorithmRecall ( )

override

Destructor.

MapAlignmentEvaluationAlgorithmRecall() [2/2]

MapAlignmentEvaluationAlgorithmRecall ( const MapAlignmentEvaluationAlgorithmRecall &  )

private

Copy constructor intentionally not implemented -> private.

Member Function Documentation

create()

static MapAlignmentEvaluationAlgorithm* create ( )

inlinestatic

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  )

overridevirtual

Applies the algorithm.

Implements MapAlignmentEvaluationAlgorithm.

getProductName()

static String getProductName ( )

inlinestatic

Returns the product name (for the Factory)

operator=()

MapAlignmentEvaluationAlgorithmRecall& operator= ( const MapAlignmentEvaluationAlgorithmRecall &  )

private

Assignment operator intentionally not implemented -> private.