Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
TICFilter.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: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #ifndef OPENMS_FILTERING_TRANSFORMERS_TICFILTER_H
36 #define OPENMS_FILTERING_TRANSFORMERS_TICFILTER_H
37 
39 
40 namespace OpenMS
41 {
49  class OPENMS_DLLAPI TICFilter :
50  public FilterFunctor
51  {
52 public:
53 
54  // @name Constructors and Destructors
55  // @{
57  TICFilter();
58 
60  TICFilter(const TICFilter & source);
61 
63  virtual ~TICFilter();
64  // @}
65 
66  // @name Operators
67  // @{
69  TICFilter & operator=(const TICFilter & source);
70  // @}
71 
72  // @name Accessors
73  // @{
75  static FilterFunctor * create() { return new TICFilter(); }
76 
78  template <typename SpectrumType>
79  double apply(SpectrumType & spectrum)
80  {
81  typedef typename SpectrumType::ConstIterator ConstIterator;
82  double TIC = 0;
83  //double window = (double)param_.getValue("window");
84 
85  for (ConstIterator it = spectrum.begin(); it != spectrum.end(); ++it)
86  {
87  TIC += it->getIntensity();
88  }
89  return TIC;
90  }
91 
93  static const String getProductName()
94  {
95  return "TICFilter";
96  }
97 
98  // @}
99 
100  };
101 }
102 #endif //OPENMS_FILTERING_TRANSFORMERS_TICFILTER_H
A more convenient string class.
Definition: String.h:57
ContainerType::const_iterator ConstIterator
Non-mutable iterator.
Definition: MSSpectrum.h:104
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
static const String getProductName()
Definition: TICFilter.h:93
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
TICFilter calculates TIC.
Definition: TICFilter.h:49
double apply(SpectrumType &spectrum)
Definition: TICFilter.h:79
A FilterFunctor extracts some spectrum characteristics for quality assessment.
Definition: FilterFunctor.h:45
static FilterFunctor * create()
Definition: TICFilter.h:75

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