Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
SqrtMower.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-2015.
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: Mathias Walzer $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #ifndef OPENMS_FILTERING_TRANSFORMERS_SQRTMOWER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_SQRTMOWER_H
37 
40 
41 #include <cmath>
42 
43 namespace OpenMS
44 {
50  class OPENMS_DLLAPI SqrtMower :
51  public DefaultParamHandler
52  {
53 public:
54 
55  // @name Constructors and Destructors
56  // @{
58  SqrtMower();
60  virtual ~SqrtMower();
61 
63  SqrtMower(const SqrtMower & source);
65  SqrtMower & operator=(const SqrtMower & source);
66  // @}
67 
69  template <typename SpectrumType>
70  void filterSpectrum(SpectrumType & spectrum)
71  {
72  bool warning = false;
73  for (typename SpectrumType::Iterator it = spectrum.begin(); it != spectrum.end(); ++it)
74  {
75  double intens = it->getIntensity();
76  if (intens < 0)
77  {
78  intens = 0;
79  warning = true;
80  }
81  it->setIntensity(std::sqrt(intens));
82  }
83  if (warning)
84  {
85  std::cerr << "Warning negative intensities were set to zero" << std::endl;
86  }
87  return;
88  }
89 
90  void filterPeakSpectrum(PeakSpectrum & spectrum);
91 
92  void filterPeakMap(PeakMap & exp);
93 
94  //TODO reimplement DefaultParamHandler::updateMembers_()
95 
96  // @}
97 
98  };
99 
100 }
101 
102 #endif // OPENMS_FILTERING_TRANSFORMERS_SQRTMOWER_H
void filterSpectrum(SpectrumType &spectrum)
Definition: SqrtMower.h:70
Scales the intensity of peaks to the sqrt.
Definition: SqrtMower.h:50
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 16:18:42 using doxygen 1.8.5