OpenMS  3.0.0
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-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: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
41 
42  namespace Math
43  {
55  template <UInt D>
57  {
58 public:
59 
61  enum
62  {
64  };
65 
68 
71 
72 public:
73 
76  position_(),
78  weight_sum_()
79  {
80  }
81 
84  position_(rhs.position_),
87  {
88  }
89 
91  PositionType const & getPosition() const
92  {
93  return position_;
94  }
95 
97  CoordinateType const & getWeight() const
98  {
99  return weight_sum_;
100  }
101 
103  void clear()
104  {
105  position_.clear();
107  weight_sum_ = 0;
108  return;
109  }
110 
112  void add(PositionType position, CoordinateType const weight = 1)
113  {
114 
115  weight_sum_ += weight;
116  position *= weight;
117  position_weighted_sum_ += position;
118 
119  // if the sum of weights is 0, set all coordinates to zero as well
120  if (weight_sum_ == 0)
121  {
122  position_.clear();
123  }
124  else
125  {
128  }
129  return;
130  }
131 
132 protected:
133 
137 
138  };
139 
140  } // namespace Math
141 
142 } // namespace OpenMS
143 
OpenMS::DPosition::clear
void clear()
Set all dimensions to zero.
Definition: DPosition.h:354
OpenMS::Math::AveragePosition::PositionType
DPosition< DIMENSION > PositionType
Position type (a D-dimensional position)
Definition: AveragePosition.h:67
OpenMS::Math::AveragePosition::position_
PositionType position_
Definition: AveragePosition.h:134
double
DPosition.h
OpenMS::Math::AveragePosition::clear
void clear()
Reset everything. (Note that update() will cause a division by zero after that.)
Definition: AveragePosition.h:103
OpenMS::Math::AveragePosition::AveragePosition
AveragePosition()
Default constructor.
Definition: AveragePosition.h:75
OpenMS::Math::AveragePosition::getPosition
const PositionType & getPosition() const
Returns the current average position.
Definition: AveragePosition.h:91
OpenMS::Math::AveragePosition::getWeight
const CoordinateType & getWeight() const
Returns the total weight.
Definition: AveragePosition.h:97
OpenMS::Math::AveragePosition
Maintain an average position by summing up positions with weights.
Definition: AveragePosition.h:56
OpenMS::Math::AveragePosition::AveragePosition
AveragePosition(AveragePosition const &rhs)
Copy constructor.
Definition: AveragePosition.h:83
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Math::AveragePosition::DIMENSION
Definition: AveragePosition.h:63
OpenMS::Math::AveragePosition::CoordinateType
PositionType::CoordinateType CoordinateType
Weight type (for weighted average - a scalar type)
Definition: AveragePosition.h:70
OpenMS::DPosition< DIMENSION >
OpenMS::Math::AveragePosition::weight_sum_
CoordinateType weight_sum_
Definition: AveragePosition.h:136
OpenMS::Math::AveragePosition::position_weighted_sum_
PositionType position_weighted_sum_
Definition: AveragePosition.h:135
OpenMS::Math::AveragePosition::add
void add(PositionType position, CoordinateType const weight=1)
Add a position.
Definition: AveragePosition.h:112