OpenMS
SimplePairFinder.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: $
7 // --------------------------------------------------------------------------
8 
9 
10 #ifndef OPENMS_ANALYSIS_MAPMATCHING_SIMPLEPAIRFINDER_H
11 #define OPENMS_ANALYSIS_MAPMATCHING_SIMPLEPAIRFINDER_H
12 
14 
15 #define V_SimplePairFinder(bla) // std::cout << bla << std::endl;
16 
17 namespace OpenMS
18 {
19 
55  class OPENMS_DLLAPI SimplePairFinder :
56  public BaseGroupFinder
57  {
58 public:
61 
65  ~SimplePairFinder() override
66  {
67  }
68 
71  {
72  return new SimplePairFinder();
73  }
74 
76  static const String getProductName()
77  {
78  return "simple";
79  }
80 
89  void run(const std::vector<ConsensusMap> & input_maps, ConsensusMap & result_map) override;
90 
91 protected:
92 
93  //docu in base class
94  void updateMembers_() override;
95 
97  double diff_exponent_[2];
98 
100  double diff_intercept_[2];
101 
104 
107  double similarity_(ConsensusFeature const & left, ConsensusFeature const & right) const;
108 
109  }; // SimplePairFinder
110 
111 } // namespace OpenMS
112 
113 #endif // OPENMS_ANALYSIS_MAPMATCHING_SimplePairFinder_H
114 
115 /*
116 
117 gnuplot history - how the plot was created - please do not delete this receipt
118 
119 f(x,intercept,exponent)=1/(1+(abs(x)*intercept)**exponent)
120 set terminal postscript enhanced color
121 set output "choosingsimplepairfinderparams.ps"
122 set size ratio .3
123 plot [-3:3] [0:1] f(x,1,1), f(x,2,1), f(x,1,2), f(x,2,2)
124 
125 */
The base class of all element group finding algorithms.
Definition: BaseGroupFinder.h:38
A consensus feature spanning multiple LC-MS/MS experiments.
Definition: ConsensusFeature.h:45
A container for consensus elements.
Definition: ConsensusMap.h:66
This class implements a simple point pair finding algorithm.
Definition: SimplePairFinder.h:57
SimplePairFinder()
Constructor.
~SimplePairFinder() override
Destructor.
Definition: SimplePairFinder.h:65
void run(const std::vector< ConsensusMap > &input_maps, ConsensusMap &result_map) override
Run the algorithm.
void updateMembers_() override
This method is used to update extra member variables at the end of the setParameters() method.
BaseGroupFinder Base
Base class.
Definition: SimplePairFinder.h:60
double similarity_(ConsensusFeature const &left, ConsensusFeature const &right) const
Compute the similarity for a pair of elements.
double pair_min_quality_
Minimal pair quality.
Definition: SimplePairFinder.h:103
static BaseGroupFinder * create()
returns an instance of this class
Definition: SimplePairFinder.h:70
static const String getProductName()
returns the name of this module
Definition: SimplePairFinder.h:76
A more convenient string class.
Definition: String.h:34
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22