OpenMS  2.6.0
BackgroundIntensityBin.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: Lukas Mueller, Markus Mueller $
33 // --------------------------------------------------------------------------
34 //
36 //
37 // PEAK DETECTION OF FOURIER TRANSFORME MS INSTRUMENT DATA
38 //
39 // written by Markus Mueller, markus.mueller@imsb.biol.ethz.ch
40 // ( and Lukas Mueller, Lukas.Mueller@imsb.biol.ethz.ch)
41 // October 2005
42 //
43 // Ported to OpenMS by Florian Zeller, florian.zeller@bsse.ethz.ch
44 // December 2010
45 //
46 // Group of Prof. Ruedi Aebersold, IMSB, ETH Hoenggerberg, Zurich
47 //
48 //
49 
50 #pragma once
51 
52 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/SUPERHIRN/SuperHirnConfig.h>
53 
54 #include <vector>
55 #include <map>
56 
57 namespace OpenMS
58 {
59 
60  class MSPeak;
61 
62  class SUPERHIRN_DLLAPI BackgroundIntensityBin
63  {
64 
65 private:
66 
67  // do not allow default constructor
69  {
70  }
71 
72  // mz and tr coordinates of the bin:
73  double mzCoord_;
74  double trCoord_;
75  double zCoord_;
76 
77  std::vector<double> intensityMap_;
78  std::map<double, double> intensityHist_;
79 
80  double mean_;
81  void computeIntensityHist();
82 
83 public:
84 
85  virtual ~BackgroundIntensityBin();
86 
87  // copy constructor
89 
90  // assignment operator
92 
93  BackgroundIntensityBin(double, double);
94 
95  /*
96  * @brief Check if a peak belongs to this intensity bin
97  */
98  bool checkBelonging(MSPeak *);
99 
100  /*
101  * @brief Add intensity to BackgroundIntensityBin
102  */
103  void addIntensity(double);
104 
105  /*
106  * @brief add peak to BackgroundIntensityBin
107  */
108  void addMSPeak(MSPeak *);
109  /*
110  * @brief Process collected intensities in the map
111  */
112  void processIntensities();
113 
114  std::vector<double> * getIntensityMap();
115  std::map<double, double> * getIntensityHist();
116  double getMean();
117  };
118 
119 } // ns
120 
OpenMS::BackgroundIntensityBin::mean_
double mean_
Definition: BackgroundIntensityBin.h:80
OpenMS::MSPeak
Definition: MSPeak.h:65
OpenMS::BackgroundIntensityBin::zCoord_
double zCoord_
Definition: BackgroundIntensityBin.h:75
OpenMS::BackgroundIntensityBin::trCoord_
double trCoord_
Definition: BackgroundIntensityBin.h:74
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::BackgroundIntensityBin::intensityHist_
std::map< double, double > intensityHist_
Definition: BackgroundIntensityBin.h:78
OpenMS::BackgroundIntensityBin::mzCoord_
double mzCoord_
Definition: BackgroundIntensityBin.h:73
OpenMS::BackgroundIntensityBin::intensityMap_
std::vector< double > intensityMap_
Definition: BackgroundIntensityBin.h:77
OpenMS::BackgroundIntensityBin::BackgroundIntensityBin
BackgroundIntensityBin()
Definition: BackgroundIntensityBin.h:68
OpenMS::BackgroundIntensityBin
Definition: BackgroundIntensityBin.h:62