OpenMS  3.0.0
ThresholdMower.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-2022.
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: Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34 //
35 #pragma once
36 
41 
42 namespace OpenMS
43 {
51  class OPENMS_DLLAPI ThresholdMower :
52  public DefaultParamHandler
53  {
54 public:
55 
56  // @name Constructors and Destructors
57  // @{
61  ~ThresholdMower() override;
62 
64  ThresholdMower(const ThresholdMower & source);
66  ThresholdMower & operator=(const ThresholdMower & source);
67  // @}
68 
69  // @name Accessors
70  // @{
72 
74  template <typename SpectrumType>
75  void filterSpectrum(SpectrumType & spectrum)
76  {
77  threshold_ = ((double)param_.getValue("threshold"));
78  std::vector<Size> indices;
79  for (Size i = 0; i != spectrum.size(); ++i)
80  {
81  if (spectrum[i].getIntensity() >= threshold_)
82  {
83  indices.push_back(i);
84  }
85  }
86  spectrum.select(indices);
87  }
88 
89  void filterPeakSpectrum(PeakSpectrum & spectrum);
90 
91  void filterPeakMap(PeakMap & exp);
92 
93  //TODO reimplement DefaultParamHandler::updateMembers_()
94 
95 private:
96  double threshold_;
97 
98  // @}
99  };
100 
101 }
102 
DefaultParamHandler.h
double
OpenMS::MSSpectrum::select
MSSpectrum & select(const std::vector< Size > &indices)
OpenMS::ThresholdMower::threshold_
double threshold_
Definition: ThresholdMower.h:96
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:70
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ThresholdMower::filterSpectrum
void filterSpectrum(SpectrumType &spectrum)
Definition: ThresholdMower.h:75
MSExperiment.h
OpenMS::ThresholdMower
ThresholdMower removes all peaks below a threshold.
Definition: ThresholdMower.h:51
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:66
StandardTypes.h
MSSpectrum.h