OpenStructure
Public Member Functions | Static Public Member Functions | Protected Attributes
StatBase Class Reference

#include <stat.hh>

Public Member Functions

 StatBase ()
 
template<typename T , class D >
void VisitState (const ImageStateImpl< T, D > &isi)
 
Real GetMean () const
 
void SetMean (Real m)
 
Real GetMinimum () const
 
Point GetMinimumPosition () const
 
void SetMinimum (Real m)
 
Real GetMaximum () const
 
Point GetMaximumPosition () const
 
void SetMaximum (Real m)
 
Real GetSum () const
 
void SetSum (Real s)
 
Real GetVariance () const
 
void SetVariance (Real v)
 
Real GetStandardDeviation () const
 
void SetStandardDeviation (Real s)
 
Real GetRootMeanSquare () const
 
Real GetSkewness () const
 
Real GetKurtosis () const
 
Vec3 GetCenterOfMass () const
 

Static Public Member Functions

static String GetAlgorithmName ()
 

Protected Attributes

Real mean_
 
Real var_
 
Real std_dev_
 
Real sum_
 
Real min_
 
Real max_
 
Point maxpos_
 
Point minpos_
 
Real rms_
 
Real skewness_
 
Real kurtosis_
 
Vec3 center_of_mass_
 

Detailed Description

collect statistical information about data

Since this algorithm is implemented as a combined image stage visitor and algorithm, the main workhorse is this class StatBase, which will act as the parent class of the actual algorithm class, Stat

Mean value, variance and standard deviation are calculated based on the one pass algorithm by Welford et al.: B. P. Welford (1962)."Note on a method for calculating corrected sums of squares and products". Technometrics 4(3):419–420 The calculation of the higher order central moments is implemented according to Terriberry: Terriberry, Timothy B. (2007), Computing Higher-Order Moments Online (http://people.xiph.org/~tterribe/notes/homs.html)

Definition at line 49 of file stat.hh.

Constructor & Destructor Documentation

◆ StatBase()

StatBase ( )
inline

Definition at line 52 of file stat.hh.

Member Function Documentation

◆ GetAlgorithmName()

static String GetAlgorithmName ( )
inlinestatic

Definition at line 71 of file stat.hh.

◆ GetCenterOfMass()

Vec3 GetCenterOfMass ( ) const
inline

Definition at line 92 of file stat.hh.

◆ GetKurtosis()

Real GetKurtosis ( ) const
inline

Definition at line 91 of file stat.hh.

◆ GetMaximum()

Real GetMaximum ( ) const
inline

Definition at line 80 of file stat.hh.

◆ GetMaximumPosition()

Point GetMaximumPosition ( ) const
inline

Definition at line 81 of file stat.hh.

◆ GetMean()

Real GetMean ( ) const
inline

Definition at line 75 of file stat.hh.

◆ GetMinimum()

Real GetMinimum ( ) const
inline

Definition at line 77 of file stat.hh.

◆ GetMinimumPosition()

Point GetMinimumPosition ( ) const
inline

Definition at line 78 of file stat.hh.

◆ GetRootMeanSquare()

Real GetRootMeanSquare ( ) const
inline

Definition at line 89 of file stat.hh.

◆ GetSkewness()

Real GetSkewness ( ) const
inline

Definition at line 90 of file stat.hh.

◆ GetStandardDeviation()

Real GetStandardDeviation ( ) const
inline

Definition at line 87 of file stat.hh.

◆ GetSum()

Real GetSum ( ) const
inline

Definition at line 83 of file stat.hh.

◆ GetVariance()

Real GetVariance ( ) const
inline

Definition at line 85 of file stat.hh.

◆ SetMaximum()

void SetMaximum ( Real  m)
inline

Definition at line 82 of file stat.hh.

◆ SetMean()

void SetMean ( Real  m)
inline

Definition at line 76 of file stat.hh.

◆ SetMinimum()

void SetMinimum ( Real  m)
inline

Definition at line 79 of file stat.hh.

◆ SetStandardDeviation()

void SetStandardDeviation ( Real  s)
inline

Definition at line 88 of file stat.hh.

◆ SetSum()

void SetSum ( Real  s)
inline

Definition at line 84 of file stat.hh.

◆ SetVariance()

void SetVariance ( Real  v)
inline

Definition at line 86 of file stat.hh.

◆ VisitState()

void VisitState ( const ImageStateImpl< T, D > &  isi)

Field Documentation

◆ center_of_mass_

Vec3 center_of_mass_
protected

Definition at line 98 of file stat.hh.

◆ kurtosis_

Real kurtosis_
protected

Definition at line 97 of file stat.hh.

◆ max_

Real max_
protected

Definition at line 95 of file stat.hh.

◆ maxpos_

Point maxpos_
protected

Definition at line 96 of file stat.hh.

◆ mean_

Real mean_
protected

Definition at line 94 of file stat.hh.

◆ min_

Real min_
protected

Definition at line 95 of file stat.hh.

◆ minpos_

Point minpos_
protected

Definition at line 96 of file stat.hh.

◆ rms_

Real rms_
protected

Definition at line 97 of file stat.hh.

◆ skewness_

Real skewness_
protected

Definition at line 97 of file stat.hh.

◆ std_dev_

Real std_dev_
protected

Definition at line 94 of file stat.hh.

◆ sum_

Real sum_
protected

Definition at line 95 of file stat.hh.

◆ var_

Real var_
protected

Definition at line 94 of file stat.hh.


The documentation for this class was generated from the following file: