Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
ComplementFilter.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-2017.
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 #ifndef OPENMS_FILTERING_TRANSFORMERS_COMPLEMENTFILTER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_COMPLEMENTFILTER_H
37 
39 
40 #include <map>
41 #include <cmath>
42 
43 namespace OpenMS
44 {
52  class OPENMS_DLLAPI ComplementFilter :
53  public FilterFunctor
54  {
55 public:
56 
57  // @name Constructors and Destructors
61 
63  ComplementFilter(const ComplementFilter & source);
64 
66  virtual ~ComplementFilter();
68 
69  // @name Operators
71  ComplementFilter & operator=(const ComplementFilter & source);
74 
75  // @name Accessors
77  static FilterFunctor * create() { return new ComplementFilter(); }
78 
80  template <typename SpectrumType>
81  double apply(SpectrumType & spectrum)
82  {
83  if (spectrum.size() < 2)
84  {
85  return 0;
86  }
87  double tolerance = (double)param_.getValue("tolerance");
88  double parentmass = 0.0;
89  if (!spectrum.getPrecursors().empty()) parentmass = spectrum.getPrecursors()[0].getMZ();
90  double result(0);
91 
92  spectrum.sortByPosition();
93 
95  Size j = spectrum.size() - 1;
96  for (Size i = 0; i < spectrum.size() && i <= j; /*++i*/)
97  {
98  double sum = spectrum[i].getPosition()[0] + spectrum[j].getPosition()[0];
99 
100  if (std::fabs(sum - parentmass) < tolerance)
101  {
102  result += spectrum[i].getIntensity() + spectrum[j].getIntensity();
103  }
104 
105  if (sum < parentmass)
106  {
107  ++i;
108  }
109  else
110  {
111  if (sum > parentmass)
112  {
113  --j;
114  }
115  }
116  }
117 
118  return result;
119  }
120 
122  static const String getProductName()
123  {
124  return "ComplementFilter";
125  }
126 
128 
129  };
130 }
131 #endif // OPENMS_FILTERING_TRANSFORMERS_COMPLEMENTFILTER_H
A more convenient string class.
Definition: String.h:57
static double sum(IteratorType begin, IteratorType end)
Calculates the sum of a range of values.
Definition: StatisticFunctions.h:122
void sortByPosition()
Lexicographically sorts the peaks by their position.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
double apply(SpectrumType &spectrum)
returns the total intensity of peak pairs which could result from complementing fragments ...
Definition: ComplementFilter.h:81
A FilterFunctor extracts some spectrum characteristics for quality assessment.
Definition: FilterFunctor.h:45
const std::vector< Precursor > & getPrecursors() const
returns a const reference to the precursors
total intensity of peak pairs that could result from complementing fragments of charge state 1 ...
Definition: ComplementFilter.h:52
static FilterFunctor * create()
Definition: ComplementFilter.h:77
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
static const String getProductName()
returns the name for registration at the factory
Definition: ComplementFilter.h:122

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13