OpenMS
MapAlignmentEvaluationAlgorithm.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Katharina Albers $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
12 
13 namespace OpenMS
14 {
15 
21  class OPENMS_DLLAPI MapAlignmentEvaluationAlgorithm
22  {
23 
24 protected:
25  typedef ConsensusFeature::HandleSetType::const_iterator HandleIterator;
26 
27 public:
28 
31 
34 
35 
37  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;
38 
40  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);
41 
43  static void registerChildren();
44 
45 private:
50 
51  };
52 
53 } // namespace OpenMS
54 
A container for consensus elements.
Definition: ConsensusMap.h:66
Representation of a Peak2D, RichPeak2D or Feature .
Definition: FeatureHandle.h:34
Base class for all Caap evaluation algorithms.
Definition: MapAlignmentEvaluationAlgorithm.h:22
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.
ConsensusFeature::HandleSetType::const_iterator HandleIterator
Definition: MapAlignmentEvaluationAlgorithm.h:25
MapAlignmentEvaluationAlgorithm(const MapAlignmentEvaluationAlgorithm &)
Copy constructor is not implemented -> private.
MapAlignmentEvaluationAlgorithm()
Default constructor.
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,...
static void registerChildren()
Register all derived classes in this method.
MapAlignmentEvaluationAlgorithm & operator=(const MapAlignmentEvaluationAlgorithm &)
Assignment operator is not implemented -> private.
virtual ~MapAlignmentEvaluationAlgorithm()
Destructor.
float IntensityType
Intensity type.
Definition: Peak2D.h:36
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22