Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
AveragePosition.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_MATH_STATISTICS_AVERAGEPOSITION_H
36 #define OPENMS_MATH_STATISTICS_AVERAGEPOSITION_H
37 
39 
40 namespace OpenMS
41 {
42 
43  namespace Math
44  {
56  template <UInt D>
58  {
59 public:
60 
62  enum
63  {
65  };
66 
69 
72 
73 public:
74 
77  position_(),
79  weight_sum_()
80  {
81  }
82 
85  position_(rhs.position_),
88  {
89  }
90 
92  PositionType const & getPosition() const
93  {
94  return position_;
95  }
96 
98  CoordinateType const & getWeight() const
99  {
100  return weight_sum_;
101  }
102 
104  void clear()
105  {
106  position_.clear();
108  weight_sum_ = 0;
109  return;
110  }
111 
113  void add(PositionType position, CoordinateType const weight = 1)
114  {
115 
116  weight_sum_ += weight;
117  position *= weight;
118  position_weighted_sum_ += position;
119 
120  // if the sum of weights is 0, set all coordinates to zero as well
121  if (weight_sum_ == 0)
122  {
123  position_.clear();
124  }
125  else
126  {
129  }
130  return;
131  }
132 
133 protected:
134 
135  PositionType position_;
137  CoordinateType weight_sum_;
138 
139  };
140 
141  } // namespace Math
142 
143 } // namespace OpenMS
144 
145 #endif // OPENMS_MATH_STATISTICS_AVERAGEPOSITION_H
CoordinateType weight_sum_
Definition: AveragePosition.h:137
void clear()
Reset everything. (Note that update() will cause a division by zero after that.)
Definition: AveragePosition.h:104
AveragePosition()
Default constructor.
Definition: AveragePosition.h:76
Maintain an average position by summing up positions with weights.
Definition: AveragePosition.h:57
void clear()
Set all dimensions to zero.
Definition: DPosition.h:348
DPosition< DIMENSION > PositionType
Position type (a D-dimensional position)
Definition: AveragePosition.h:68
PositionType position_weighted_sum_
Definition: AveragePosition.h:136
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
PositionType const & getPosition() const
Returns the current average position.
Definition: AveragePosition.h:92
PositionType position_
Definition: AveragePosition.h:135
Definition: AveragePosition.h:64
PositionType::CoordinateType CoordinateType
Weight type (for weighted average - a scalar type)
Definition: AveragePosition.h:71
AveragePosition(AveragePosition const &rhs)
Copy constructor.
Definition: AveragePosition.h:84
CoordinateType const & getWeight() const
Returns the total weight.
Definition: AveragePosition.h:98
void add(PositionType position, CoordinateType const weight=1)
Add a position.
Definition: AveragePosition.h:113
double CoordinateType
Coordinate type.
Definition: DPosition.h:59

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