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-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: Mathias Walzer $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #ifndef OPENMS_FILTERING_TRANSFORMERS_SCALER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_SCALER_H
37 
42 
43 #include <map>
44 
45 namespace OpenMS
46 {
52  class OPENMS_DLLAPI Scaler :
53  public DefaultParamHandler
54  {
55 public:
56 
57  // @name Constructors and Destructors
58  // @{
60  Scaler();
62  virtual ~Scaler();
63 
65  Scaler(const Scaler & source);
67  Scaler & operator=(const Scaler & source);
68 
69  // @}
70 
71  // @name Accessors
72  // @{
73 
74  template <typename SpectrumType>
75  void filterSpectrum(SpectrumType & spectrum)
76  {
77  if (spectrum.empty()) return;
78 
79  spectrum.sortByIntensity();
80  typename SpectrumType::size_type count = spectrum.size();
81  ++count;
82  typename SpectrumType::PeakType::IntensityType last_int = 0.0;
83  typename SpectrumType::Iterator it = spectrum.end();
84  do
85  {
86  --it;
87  if (it->getIntensity() != last_int)
88  {
89  --count;
90  }
91  last_int = it->getIntensity();
92  it->setIntensity(count);
93  }
94  while (it != spectrum.begin());
95  }
96 
97  void filterPeakSpectrum(PeakSpectrum & spectrum);
98 
99  void filterPeakMap(PeakMap & exp);
100 
101  //TODO reimplement DefaultParamHandler::updateMembers_() when introducing member variables
102 
103  // @}
104 
105  };
106 
107 }
108 #endif //OPENMS_FILTERING_TRANSFORMERS_SCALER_H
void filterSpectrum(SpectrumType &spectrum)
Definition: Scaler.h:75
Scaler scales the peak by ranking the peaks and assigning intensity according to rank.
Definition: Scaler.h:52
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
ContainerType::iterator Iterator
Mutable iterator.
Definition: MSSpectrum.h:102
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
void sortByIntensity(bool reverse=false)
Lexicographically sorts the peaks by their intensity.
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:82
float IntensityType
Intensity type.
Definition: Peak1D.h:64
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92

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