Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
IsotopeDiffFilter.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_ISOTOPEDIFFFILTER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_ISOTOPEDIFFFILTER_H
37 
39 #include <cmath>
40 
41 namespace OpenMS
42 {
50  class OPENMS_DLLAPI IsotopeDiffFilter :
51  public FilterFunctor
52  {
53 
54 public:
55 
56  // @name Constructors and Destructors
57  // @{
60 
62  IsotopeDiffFilter(const IsotopeDiffFilter & source);
63 
65  virtual ~IsotopeDiffFilter();
66  // @}
67 
68  // @name Operators
69  // @{
71  IsotopeDiffFilter & operator=(const IsotopeDiffFilter & source);
72  // @}
73 
74  // @name Accessors
75  // @{
77  static FilterFunctor * create() { return new IsotopeDiffFilter(); }
78 
80  template <typename SpectrumType>
81  double apply(SpectrumType & spectrum)
82  {
83  double tolerance = (double)param_.getValue("tolerance");
84  double isodiff = 0;
85 
86  //iterate over all peaks
87  for (Size i = 0; i < spectrum.size(); ++i)
88  {
89  for (Size j = 1; i + j < spectrum.size(); ++j)
90  {
91  double pos_ij = spectrum[i + j].getPosition()[0];
92  double pos_i = spectrum[i].getPosition()[0];
93  if (std::fabs(pos_ij - pos_i + 1) < tolerance)
94  {
95  isodiff += spectrum[i].getIntensity() + spectrum[i + j].getIntensity();
96  }
97  else
98  {
99  if (std::fabs(spectrum[i + j].getPosition()[0] - spectrum[i].getPosition()[0]) > 1 + tolerance)
100  {
101  break;
102  }
103  }
104  }
105  }
106  return isodiff;
107  }
108 
110  static const String getProductName()
111  {
112  return "IsotopeDiffFilter";
113  }
114 
115  // @}
116 
117 private:
118  };
119 }
120 #endif // OPENMS_FILTERING_TRANSFORMERS_ISOTOPEDIFFFILTER_H
A more convenient string class.
Definition: String.h:57
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
static const String getProductName()
Definition: IsotopeDiffFilter.h:110
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
IsotopeDiffFilter returns total intensity of peak pairs that could result from isotope peaks...
Definition: IsotopeDiffFilter.h:50
A FilterFunctor extracts some spectrum characteristics for quality assessment.
Definition: FilterFunctor.h:45
double apply(SpectrumType &spectrum)
Definition: IsotopeDiffFilter.h:81
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
static FilterFunctor * create()
Definition: IsotopeDiffFilter.h:77

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