OpenMS  3.0.0
SimplePairFinder.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 
36 #ifndef OPENMS_ANALYSIS_MAPMATCHING_SIMPLEPAIRFINDER_H
37 #define OPENMS_ANALYSIS_MAPMATCHING_SIMPLEPAIRFINDER_H
38 
40 
41 #define V_SimplePairFinder(bla) // std::cout << bla << std::endl;
42 
43 namespace OpenMS
44 {
45 
81  class OPENMS_DLLAPI SimplePairFinder :
82  public BaseGroupFinder
83  {
84 public:
87 
91  ~SimplePairFinder() override
92  {
93  }
94 
97  {
98  return new SimplePairFinder();
99  }
100 
102  static const String getProductName()
103  {
104  return "simple";
105  }
106 
115  void run(const std::vector<ConsensusMap> & input_maps, ConsensusMap & result_map) override;
116 
117 protected:
118 
119  //docu in base class
120  void updateMembers_() override;
121 
123  double diff_exponent_[2];
124 
126  double diff_intercept_[2];
127 
130 
133  double similarity_(ConsensusFeature const & left, ConsensusFeature const & right) const;
134 
135  }; // SimplePairFinder
136 
137 } // namespace OpenMS
138 
139 #endif // OPENMS_ANALYSIS_MAPMATCHING_SimplePairFinder_H
140 
141 /*
142 
143 gnuplot history - how the plot was created - please do not delete this receipt
144 
145 f(x,intercept,exponent)=1/(1+(abs(x)*intercept)**exponent)
146 set terminal postscript enhanced color
147 set output "choosingsimplepairfinderparams.ps"
148 set size ratio .3
149 plot [-3:3] [0:1] f(x,1,1), f(x,2,1), f(x,1,2), f(x,2,2)
150 
151 */
BaseGroupFinder.h
OpenMS::SimplePairFinder::pair_min_quality_
double pair_min_quality_
Minimal pair quality.
Definition: SimplePairFinder.h:129
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SimplePairFinder::~SimplePairFinder
~SimplePairFinder() override
Destructor.
Definition: SimplePairFinder.h:91
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::SimplePairFinder::Base
BaseGroupFinder Base
Base class.
Definition: SimplePairFinder.h:86
OpenMS::ConsensusFeature
A consensus feature spanning multiple LC-MS/MS experiments.
Definition: ConsensusFeature.h:69
OpenMS::SimplePairFinder::getProductName
static const String getProductName()
returns the name of this module
Definition: SimplePairFinder.h:102
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:82
OpenMS::SimplePairFinder::create
static BaseGroupFinder * create()
returns an instance of this class
Definition: SimplePairFinder.h:96
OpenMS::BaseGroupFinder
The base class of all element group finding algorithms.
Definition: BaseGroupFinder.h:61
OpenMS::SimplePairFinder
This class implements a simple point pair finding algorithm.
Definition: SimplePairFinder.h:81