Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Scaler.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-2013.
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_SCALER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_SCALER_H
37 
40 
41 #include <map>
42 
43 namespace OpenMS
44 {
50  class OPENMS_DLLAPI Scaler :
51  public DefaultParamHandler
52  {
53 public:
54 
55  // @name Constructors and Destructors
56  // @{
58  Scaler();
60  virtual ~Scaler();
61 
63  Scaler(const Scaler & source);
65  Scaler & operator=(const Scaler & source);
66 
67  // @}
68 
69  // @name Accessors
70  // @{
71 
72  template <typename SpectrumType>
73  void filterSpectrum(SpectrumType & spectrum)
74  {
75  if (spectrum.empty()) return;
76 
77  spectrum.sortByIntensity();
78  typename SpectrumType::size_type count = spectrum.size();
79  ++count;
80  typename SpectrumType::PeakType::IntensityType last_int = 0.0;
81  typename SpectrumType::Iterator it = spectrum.end();
82  do
83  {
84  --it;
85  if (it->getIntensity() != last_int)
86  {
87  --count;
88  }
89  last_int = it->getIntensity();
90  it->setIntensity(count);
91  }
92  while (it != spectrum.begin());
93  }
94 
95  void filterPeakSpectrum(PeakSpectrum & spectrum);
96 
97  void filterPeakMap(PeakMap & exp);
98 
99  //TODO reimplement DefaultParamHandler::updateMembers_() when introducing member variables
100 
101  // @}
102 
103  };
104 
105 }
106 #endif //OPENMS_FILTERING_TRANSFORMERS_SCALER_H
void filterSpectrum(SpectrumType &spectrum)
Definition: Scaler.h:73
Scaler scales the peak by ranking the peaks and assigning intensity according to rank.
Definition: Scaler.h:50
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:90

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:20 using doxygen 1.8.5