OpenStructure
stat.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of the OpenStructure project <www.openstructure.org>
3 //
4 // Copyright (C) 2008-2020 by the OpenStructure authors
5 // Copyright (C) 2003-2010 by the IPLT authors
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License as published by the Free
9 // Software Foundation; either version 3.0 of the License, or (at your option)
10 // any later version.
11 // This library is distributed in the hope that it will be useful, but WITHOUT
12 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
14 // details.
15 //
16 // You should have received a copy of the GNU Lesser General Public License
17 // along with this library; if not, write to the Free Software Foundation, Inc.,
18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 //------------------------------------------------------------------------------
20 
21 /*
22  Authors: Andreas Schenk, Ansgar Philippsen
23 */
24 
25 #ifndef IMG_ALG_STAT_H
26 #define IMG_ALG_STAT_H
27 
28 #include <iosfwd>
29 
30 #include <ost/img/algorithm.hh>
31 #include <ost/img/image_state.hh>
33 
34 namespace ost { namespace img { namespace alg {
35 
50 {
51  public:
53  mean_(0.0),
54  var_(0.0),
55  std_dev_(0.0),
56  sum_(0.0),
57  min_(0.0),
58  max_(0.0),
59  maxpos_(),
60  minpos_(),
61  rms_(0.0),
62  skewness_(0.0),
63  kurtosis_(0.0),
64  center_of_mass_(0.0,0.0,0.0)
65  {}
66 
67  // image state algorithm interface
68  template <typename T, class D>
69  void VisitState(const ImageStateImpl<T,D>& isi);
70 
71  static String GetAlgorithmName() {return "Stat";}
72 
73  // other interface
74 
75  Real GetMean() const {return mean_;}
76  void SetMean(Real m) {mean_=m;}
77  Real GetMinimum() const {return min_;}
78  Point GetMinimumPosition() const {return minpos_;}
79  void SetMinimum(Real m) {min_=m;}
80  Real GetMaximum() const {return max_;}
81  Point GetMaximumPosition() const {return maxpos_;}
82  void SetMaximum(Real m) {max_=m;}
83  Real GetSum() const {return sum_;}
84  void SetSum(Real s) {sum_=s;}
85  Real GetVariance() const {return var_;}
86  void SetVariance(Real v) {var_=v;}
87  Real GetStandardDeviation() const {return std_dev_;}
88  void SetStandardDeviation(Real s) {std_dev_=s;}
89  Real GetRootMeanSquare() const {return rms_;}
90  Real GetSkewness() const {return skewness_;}
91  Real GetKurtosis() const {return kurtosis_;}
92  Vec3 GetCenterOfMass() const {return center_of_mass_;}
93 protected:
94  Real mean_, var_, std_dev_;
95  Real sum_, min_, max_;
96  Point maxpos_,minpos_;
97  Real rms_,skewness_,kurtosis_;
99 };
100 
102 
103 DLLEXPORT_IMG_ALG std::ostream& operator<<(std::ostream& o, const Stat& s);
104 }
105 
107 
108 }} // ns
109 
110 #endif
111 
class encapsulating 1D to 3D point
Definition: point.hh:47
Real GetMaximum() const
Definition: stat.hh:80
void SetMaximum(Real m)
Definition: stat.hh:82
void SetSum(Real s)
Definition: stat.hh:84
void SetVariance(Real v)
Definition: stat.hh:86
Real GetVariance() const
Definition: stat.hh:85
Vec3 GetCenterOfMass() const
Definition: stat.hh:92
Real GetMean() const
Definition: stat.hh:75
Real GetSkewness() const
Definition: stat.hh:90
void SetMean(Real m)
Definition: stat.hh:76
void SetStandardDeviation(Real s)
Definition: stat.hh:88
void VisitState(const ImageStateImpl< T, D > &isi)
Real GetSum() const
Definition: stat.hh:83
Real GetKurtosis() const
Definition: stat.hh:91
static String GetAlgorithmName()
Definition: stat.hh:71
Real GetMinimum() const
Definition: stat.hh:77
Real GetStandardDeviation() const
Definition: stat.hh:87
void SetMinimum(Real m)
Definition: stat.hh:79
Point GetMinimumPosition() const
Definition: stat.hh:78
Real GetRootMeanSquare() const
Definition: stat.hh:89
Point GetMaximumPosition() const
Definition: stat.hh:81
non-modifying image state visitor plus non-mod algorithm
#define DLLEXPORT_IMG_ALG
#define OST_IMG_ALG_EXPLICIT_INST_DECL(c, t)
float Real
Definition: base.hh:44
std::string String
Definition: base.hh:54
DLLEXPORT_IMG_ALG std::ostream & operator<<(std::ostream &o, const Stat &s)
ImageStateNonModAlgorithm< StatBase > Stat
Definition: stat.hh:101
Definition: base.dox:1