| OpenMS 2.5.0

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-2020.
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 #pragma once
36
37 #include <OpenMS/FILTERING/TRANSFORMERS/FilterFunctor.h>
38
39 namespace OpenMS
40 {
48 class OPENMS_DLLAPI TICFilter :
49 public FilterFunctor
50 {
51 public:
52
53 // @name Constructors and Destructors
54 // @{
56 TICFilter();
57
59 TICFilter(const TICFilter & source);
60
62 ~TICFilter() override;
63 // @}
64
65 // @name Operators
66 // @{
68 TICFilter & operator=(const TICFilter & source);
69 // @}
70
71 // @name Accessors
72 // @{
74 static FilterFunctor * create() { return new TICFilter(); }
75
77 template <typename SpectrumType>
78 double apply(SpectrumType & spectrum)
79 {
80 typedef typename SpectrumType::ConstIterator ConstIterator;
81 double TIC = 0;
82 //double window = (double)param_.getValue("window");
83
84 for (ConstIterator it = spectrum.begin(); it != spectrum.end(); ++it)
85 {
86 TIC += it->getIntensity();
87 }
88 return TIC;
89 }
90
92 static const String getProductName()
93 {
94 return "TICFilter";
95 }
96
97 // @}
98
99 };
100 }
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::TIC
Definition: TIC.h:52
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::FilterFunctor
A FilterFunctor extracts some spectrum characteristics for quality assessment.
Definition: FilterFunctor.h:44
OpenMS::MSSpectrum::ConstIterator
ContainerType::const_iterator ConstIterator
Non-mutable iterator.
Definition: MSSpectrum.h:104
OpenMS::TICFilter
TICFilter calculates TIC.
Definition: TICFilter.h:48
OpenMS::TICFilter::getProductName
static const String getProductName()
Definition: TICFilter.h:92
OpenMS::TICFilter::create
static FilterFunctor * create()
Definition: TICFilter.h:74
OpenMS::TICFilter::apply
double apply(SpectrumType &spectrum)
Definition: TICFilter.h:78
FilterFunctor.h