OpenMS  3.0.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-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: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 #include <cmath>
40 
41 namespace OpenMS
42 {
55  class OPENMS_DLLAPI LabeledPairFinder :
56  public BaseGroupFinder
57  {
58 
59 public:
60 
63 
65  inline ~LabeledPairFinder() override
66  {
67  }
68 
71  {
72  return new LabeledPairFinder();
73  }
74 
76  static const String getProductName()
77  {
78  return "labeled_pair_finder";
79  }
80 
91  void run(const std::vector<ConsensusMap> & input_maps, ConsensusMap & result_map) override;
92 
93 protected:
94 
96  inline double PValue_(double x, double m, double sig1, double sig2)
97  {
98  if (m < x)
99  {
100  return 1 - std::erf((x - m) / sig2 / 0.707106781);
101  }
102  else
103  {
104  return 1 - std::erf((m - x) / sig1 / 0.707106781);
105  }
106  }
107 
108 private:
109 
111  LabeledPairFinder(const LabeledPairFinder & source);
112 
114  LabeledPairFinder & operator=(const LabeledPairFinder & source);
115 
116  }; // end of class LabeledPairFinder
117 
118 } // end of namespace OpenMS
119 
ConsensusXMLFile.h
OpenMS::TOPPBase
Base class for TOPP applications.
Definition: TOPPBase.h:147
BaseGroupFinder.h
Size
OpenMS::LabeledPairFinder::~LabeledPairFinder
~LabeledPairFinder() override
Destructor.
Definition: LabeledPairFinder.h:65
OpenMS::String
A more convenient string class.
Definition: String.h:58
Feature.h
OpenMS::LabeledPairFinder::getProductName
static const String getProductName()
Returns the name of this module.
Definition: LabeledPairFinder.h:76
FeatureXMLFile.h
StatisticFunctions.h
OpenMS::Peak2D::getIntensity
IntensityType getIntensity() const
Definition: Peak2D.h:166
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::String::number
static String number(double d, UInt n)
returns a string for d with exactly n decimal places
OpenMS::FeatureXMLFile::load
void load(const String &filename, FeatureMap &feature_map)
loads the file with name filename into map and calls updateRanges().
FeatureMap.h
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:96
OpenMS::Math
Math namespace.
Definition: BilinearInterpolation.h:42
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:82
OpenMS::Peak2D::getRT
CoordinateType getRT() const
Returns the RT coordinate (index 0)
Definition: Peak2D.h:208
OpenMS::LabeledPairFinder
The LabeledPairFinder allows the matching of labeled features (features with a fixed distance).
Definition: LabeledPairFinder.h:55
OpenMS::ConsensusXMLFile::load
void load(const String &filename, ConsensusMap &map)
Loads a consensus map from file and calls updateRanges.
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
main
int main(int argc, const char **argv)
Definition: INIFileEditor.cpp:71
OpenMS::FeatureMap
A container for features.
Definition: FeatureMap.h:98
OpenMS::Feature
An LC-MS feature.
Definition: Feature.h:70
OpenMS::LabeledPairFinder::create
static BaseGroupFinder * create()
Returns an instance of this class.
Definition: LabeledPairFinder.h:70
OpenMS::FeatureXMLFile
This class provides Input/Output functionality for feature maps.
Definition: FeatureXMLFile.h:62
OpenMS::BaseGroupFinder
The base class of all element group finding algorithms.
Definition: BaseGroupFinder.h:61
OpenMS::Peak2D::getMZ
CoordinateType getMZ() const
Returns the m/z coordinate (index 1)
Definition: Peak2D.h:196
TOPPBase.h
OpenMS::ConsensusXMLFile
This class provides Input functionality for ConsensusMaps and Output functionality for alignments and...
Definition: ConsensusXMLFile.h:58