OpenMS
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-2023.
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 #pragma once
36 
40 
43 
44 #include <vector>
45 #include <map>
46 
47 namespace OpenMS
48 {
54  class OPENMS_DLLAPI MarkerMower :
55  public DefaultParamHandler
56  {
57 public:
58 
59  // @name Constructors and Destructors
60  // @{
64  ~MarkerMower() override;
65 
67  MarkerMower(const MarkerMower & source);
69  MarkerMower & operator=(const MarkerMower & source);
70  // @}
71 
72  // @name Accessors
73  // @{
75  template <typename SpectrumType>
76  void filterSpectrum(SpectrumType & spectrum)
77  {
78  typedef typename SpectrumType::Iterator Iterator;
79 
80  std::map<double, int> marks;
81  for (std::vector<PeakMarker *>::const_iterator cvit = markers_.begin(); cvit != markers_.end(); ++cvit)
82  {
83  std::map<double, bool> marked;
84  (*cvit)->apply(marked, spectrum);
85  for (std::map<double, bool>::const_iterator cmit = marked.begin(); cmit != marked.end(); ++cmit)
86  {
87  if (cmit->second)
88  {
89  marks[cmit->first]++;
90  }
91  }
92  }
93 
94  for (Iterator it = spectrum.begin(); it != spectrum.end(); )
95  {
96  if (marks[it->getMZ()] > 0)
97  {
98  ++it;
99  }
100  else
101  {
102  it = spectrum.erase(it);
103  }
104  }
105  }
106 
108 
109  void filterPeakMap(PeakMap & exp);
110 
111  static const String getProductName()
112  {
113  return "MarkerMower";
114  }
115 
117  void insertmarker(PeakMarker * peak_marker);
118 
119  //TODO reimplement DefaultParamHandler::updateMembers_()
120 
121  // @}
122 
123 private:
125  std::vector<PeakMarker *> markers_;
126 
127  };
128 }
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:72
The representation of a 1D spectrum.
Definition: MSSpectrum.h:70
ContainerType::iterator Iterator
Mutable iterator.
Definition: MSSpectrum.h:134
MarkerMower uses PeakMarker to find peaks, those that are not marked get removed.
Definition: MarkerMower.h:56
void insertmarker(PeakMarker *peak_marker)
insert new Marker (violates the DefaultParamHandler interface)
MarkerMower & operator=(const MarkerMower &source)
assignment operator
void filterPeakSpectrum(PeakSpectrum &spectrum)
MarkerMower()
default constructor
void filterPeakMap(PeakMap &exp)
void filterSpectrum(SpectrumType &spectrum)
Definition: MarkerMower.h:76
~MarkerMower() override
destructor
std::vector< PeakMarker * > markers_
used peak markers
Definition: MarkerMower.h:125
MarkerMower(const MarkerMower &source)
copy constructor
static const String getProductName()
Definition: MarkerMower.h:111
PeakMarker marks peaks that seem to fulfill some criterion.
Definition: PeakMarker.h:49
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48