| OpenMS 2.5.0

LabeledPairFinder.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-2020.
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: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/ANALYSIS/MAPMATCHING/BaseGroupFinder.h>
38
39 #include <boost/math/tr1.hpp>
40 #include <cmath>
41
42 namespace OpenMS
43 {
56 class OPENMS_DLLAPI LabeledPairFinder :
57 public BaseGroupFinder
58 {
59
60 public:
61
63 LabeledPairFinder();
64
66 inline ~LabeledPairFinder() override
67 {
68 }
69
71 static BaseGroupFinder * create()
72 {
73 return new LabeledPairFinder();
74 }
75
77 static const String getProductName()
78 {
79 return "labeled_pair_finder";
80 }
81
92 void run(const std::vector<ConsensusMap> & input_maps, ConsensusMap & result_map) override;
93
94 protected:
95
97 inline double PValue_(double x, double m, double sig1, double sig2)
98 {
99 if (m < x)
100 {
101 return 1 - boost::math::tr1::erf((x - m) / sig2 / 0.707106781);
102 }
103 else
104 {
105 return 1 - boost::math::tr1::erf((m - x) / sig1 / 0.707106781);
106 }
107 }
108
109 private:
110
112 LabeledPairFinder(const LabeledPairFinder & source);
113
115 LabeledPairFinder & operator=(const LabeledPairFinder & source);
116
117 }; // end of class LabeledPairFinder
118
119 } // end of namespace OpenMS
120
OpenMS::BaseGroupFinder
The base class of all element group finding algorithms.
Definition: BaseGroupFinder.h:61
BaseGroupFinder.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::LabeledPairFinder::PValue_
double PValue_(double x, double m, double sig1, double sig2)
return the p-value at position x for the bi-Gaussian distribution with mean m and standard deviation ...
Definition: LabeledPairFinder.h:97
OpenMS::LabeledPairFinder
The LabeledPairFinder allows the matching of labeled features (features with a fixed distance)...
Definition: LabeledPairFinder.h:56
OpenMS::LabeledPairFinder::create
static BaseGroupFinder * create()
Returns an instance of this class.
Definition: LabeledPairFinder.h:71
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::LabeledPairFinder::~LabeledPairFinder
~LabeledPairFinder() override
Destructor.
Definition: LabeledPairFinder.h:66
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:79
OpenMS::LabeledPairFinder::getProductName
static const String getProductName()
Returns the name of this module.
Definition: LabeledPairFinder.h:77