Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MarkerMower.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_MARKERMOWER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_MARKERMOWER_H
37 
41 
44 
45 #include <vector>
46 #include <map>
47 
48 namespace OpenMS
49 {
55  class OPENMS_DLLAPI MarkerMower :
56  public DefaultParamHandler
57  {
58 public:
59 
60  // @name Constructors and Destructors
61  // @{
63  MarkerMower();
65  virtual ~MarkerMower();
66 
68  MarkerMower(const MarkerMower & source);
70  MarkerMower & operator=(const MarkerMower & source);
71  // @}
72 
73  // @name Accessors
74  // @{
76  template <typename SpectrumType>
77  void filterSpectrum(SpectrumType & spectrum)
78  {
79  typedef typename SpectrumType::Iterator Iterator;
80 
81  std::map<double, int> marks;
82  for (std::vector<PeakMarker *>::const_iterator cvit = markers_.begin(); cvit != markers_.end(); ++cvit)
83  {
84  std::map<double, bool> marked;
85  (*cvit)->apply(marked, spectrum);
86  for (std::map<double, bool>::const_iterator cmit = marked.begin(); cmit != marked.end(); ++cmit)
87  {
88  if (cmit->second)
89  {
90  marks[cmit->first]++;
91  }
92  }
93  }
94 
95  for (Iterator it = spectrum.begin(); it != spectrum.end(); )
96  {
97  if (marks[it->getMZ()] > 0)
98  {
99  ++it;
100  }
101  else
102  {
103  it = spectrum.erase(it);
104  }
105  }
106  }
107 
108  void filterPeakSpectrum(PeakSpectrum & spectrum);
109 
110  void filterPeakMap(PeakMap & exp);
111 
112  static const String getProductName()
113  {
114  return "MarkerMower";
115  }
116 
118  void insertmarker(PeakMarker * peak_marker);
119 
120  //TODO reimplement DefaultParamHandler::updateMembers_()
121 
122  // @}
123 
124 private:
126  std::vector<PeakMarker *> markers_;
127 
128  };
129 }
130 #endif // OPENMS_COMPARISON_CLUSTERING_MARKERMOWER_H
A more convenient string class.
Definition: String.h:57
MarkerMower uses PeakMarker to find peaks, those that are not marked get removed. ...
Definition: MarkerMower.h:55
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
ContainerType::iterator Iterator
Mutable iterator.
Definition: MSSpectrum.h:102
PeakMarker marks peaks that seem to fulfill some criterion.
Definition: PeakMarker.h:48
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
void filterSpectrum(SpectrumType &spectrum)
Definition: MarkerMower.h:77
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:82
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
std::vector< PeakMarker * > markers_
used peak markers
Definition: MarkerMower.h:126
static const String getProductName()
Definition: MarkerMower.h:112

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