StatisticsFinder Class Reference

#include <StatisticsFinder.h>

Inheritance diagram for StatisticsFinder:

Public Member Functions
	StatisticsFinder (bool mean=1, bool width=1, bool widthError=1, bool keepOrderedEvents=0)
double	median () const
double	numEvents () const
void	add (const double &x, const double &weight=1.0)
double	mean () const
double	meanError () const
double	varience () const
double	width () const
double	widthError () const
double	expX () const
double	expX2 () const
double	expX3 () const
double	expX4 () const
double	secondCentralMom () const
double	fourthCentralMom () const
const double &	getMin () const
const double &	getMax () const
double	range () const
virtual	~StatisticsFinder ()

Private Member Functions
bool	needOrderedEvents () const
void	warnIfWeightedEvents () const
bool	notEnoughInformation (const double &val) const

Private Attributes
double	_min
double	_max
double	_nEvents
double	_wSum
double	_wSum2
double	_wSum3
double	_wSum4
double	_sumW
int	_keepOrderedEvents
std::vector< double >	_orderedEvents

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

Used to find statistics for a dataset.

Definition at line 15 of file StatisticsFinder.h.

Constructor & Destructor Documentation

StatisticsFinder()

StatisticsFinder::StatisticsFinder	(	bool	mean = 1,
		bool	width = 1,
		bool	widthError = 1,
		bool	keepOrderedEvents = 0
	)

In the constuctor you decide what things you want to be stored once you start adding values. This will determine what statistics you are able to calcuate later

Definition at line 14 of file StatisticsFinder.cpp.

                                                                                                 :
  _min    (0.0),
  _max    (0.0),
  _nEvents(0  ),
  _wSum   (0.0),
  _wSum2  (0.0),
  _wSum3  (0.0),
  _wSum4  (0.0),
  _sumW   (0.0),
  _keepOrderedEvents(keepOrderedEvents)
{
  if( widthError == 0 ) { _wSum3 = NOT_STORED_VAL; _wSum4 = NOT_STORED_VAL;} 
  if( width      == 0 ) { _wSum2 = NOT_STORED_VAL;                         }
  if( mean       == 0 ) { _wSum  = NOT_STORED_VAL; _sumW  = NOT_STORED_VAL;}
}

~StatisticsFinder()

StatisticsFinder::~StatisticsFinder ( )

virtual

Destructor

Definition at line 195 of file StatisticsFinder.cpp.

                                   {

}

Member Function Documentation

add()

void StatisticsFinder::add	(	const double &	x,
		const double &	weight = 1.0
	)

Add a value (with optional weight) to the StatisticsFinder

Definition at line 87 of file StatisticsFinder.cpp.

                                                               {
  if (_nEvents == 0){
    _min = x;
    _max = x;
  }
  else{
    if (x < _min) _min = x;
    if (x > _max) _max = x;
  }
  if (_sumW  != NOT_STORED_VAL) _sumW  += weight;
  if (_wSum  != NOT_STORED_VAL) _wSum  += x*weight;
  if (_wSum2 != NOT_STORED_VAL) _wSum2 += x*x*weight;
  if (_wSum3 != NOT_STORED_VAL) _wSum3 += x*x*x*weight;
  if (_wSum4 != NOT_STORED_VAL) _wSum4 += x*x*x*x*weight;

  if ( _keepOrderedEvents == 1) _orderedEvents.push_back(x);
  
  _nEvents += 1.0;
}

expX()

double StatisticsFinder::expX

(

)

const

calculate and return the expectation value of X

Definition at line 145 of file StatisticsFinder.cpp.

                                   {
  if ( notEnoughInformation(_wSum) == 0 ) return 0.0;
  return _wSum/_sumW;
}

expX2()

double StatisticsFinder::expX2

(

)

const

calculate and return the expectation value of X^2

Definition at line 153 of file StatisticsFinder.cpp.

                                    {
  if ( notEnoughInformation(_wSum2) == 0 ) return 0.0;
  return _wSum2/_sumW;
}

expX3()

double StatisticsFinder::expX3

(

)

const

calculate and return the expectation value of X^3

Definition at line 161 of file StatisticsFinder.cpp.

                                    {
  if ( notEnoughInformation(_wSum3) == 0 ) return 0.0;
  return _wSum3/_sumW; 
}

expX4()

double StatisticsFinder::expX4

(

)

const

calculate and return the expectation value of X^4

Definition at line 169 of file StatisticsFinder.cpp.

                                    {
  if ( notEnoughInformation(_wSum4) == 0 ) return 0.0;
  return _wSum4/_sumW;  
}

fourthCentralMom()

double StatisticsFinder::fourthCentralMom

(

)

const

calculate and return the second central moment

E[(X - E(X))^4] = E[X^4] - 4E[X]E[X^3] + 6E[X]^2 E[X^2] - 3 E[X]^4

Definition at line 188 of file StatisticsFinder.cpp.

                                               {
  return expX4() - 4.0*expX()*expX3() + 6.0*expX()*expX()*expX2() - 3.0*expX()*expX()*expX()*expX();
}

getMax()

const double& StatisticsFinder::getMax ( ) const

inline

max value added to the StatisticsFinder

Definition at line 62 of file StatisticsFinder.h.

getMin()

const double& StatisticsFinder::getMin ( ) const

inline

min value added to the StatisticsFinder

Definition at line 61 of file StatisticsFinder.h.

mean()

double StatisticsFinder::mean

(

)

const

calculate and return the mean

Definition at line 110 of file StatisticsFinder.cpp.

                                   {
  return expX();
}

meanError()

double StatisticsFinder::meanError

(

)

const

calculate and return the error on the mean

Definition at line 117 of file StatisticsFinder.cpp.

                                        {
  return  width() /sqrt(_nEvents);
}

median()

double StatisticsFinder::median

(

)

const

The median

Definition at line 54 of file StatisticsFinder.cpp.

                                     {
  if ( needOrderedEvents() == 0) return 0.0;
  warnIfWeightedEvents();
  
  std::sort(_orderedEvents.begin(),_orderedEvents.end());
  
  int nEntries = _orderedEvents.size();

  if (nEntries % 2 == 0){
    int lowi  = (nEntries/2) - 1;
    int highi = (nEntries/2);
    return 0.5*(_orderedEvents.at(lowi) + _orderedEvents.at(highi));
  }
  
  return _orderedEvents.at( (nEntries - 1)/2 );

}

needOrderedEvents()

bool StatisticsFinder::needOrderedEvents ( ) const

private

A warning that is shown if ordered events are needed (but haven't been stored)

Definition at line 33 of file StatisticsFinder.cpp.

                                              {
  if (_keepOrderedEvents == 0){
    ERROR_LOG << "You need to keep ordered events to calculate this value";
    return 0;
  }
  return 1;
}

notEnoughInformation()

bool StatisticsFinder::notEnoughInformation ( const double &  val ) const

private

A warning that is shown if not enough information has been provided to calculate what you want

Definition at line 76 of file StatisticsFinder.cpp.

                                                                  {
  if (val == NOT_STORED_VAL) {
    ERROR_LOG << "You are not storing the correct information to calculate this value. Consider changing the constuctor";
    return 0;
  }
  return 1;
}

numEvents()

double StatisticsFinder::numEvents ( ) const

inline

numer of events added to the StatisticsFinder

Definition at line 43 of file StatisticsFinder.h.

range()

double StatisticsFinder::range ( ) const

inline

max - min value added to the StatisticsFinder

Definition at line 64 of file StatisticsFinder.h.

secondCentralMom()

double StatisticsFinder::secondCentralMom

(

)

const

calculate and return the second central moment

E[(X - E(X))^2] = E[X^2] - E[X]^2

Definition at line 179 of file StatisticsFinder.cpp.

                                               {
  return expX2() - expX()*expX();
}

varience()

double StatisticsFinder::varience

(

)

const

calculate and return the varience

Definition at line 124 of file StatisticsFinder.cpp.

                                       {
  return secondCentralMom();
}

warnIfWeightedEvents()

void StatisticsFinder::warnIfWeightedEvents ( ) const

private

A warning that is shown if the value being returned is meaningless because weights have been used

Definition at line 45 of file StatisticsFinder.cpp.

                                                 {
  if ((int)_sumW != _nEvents){
    INFO_LOG << "You have used weighted events. This may make this function meaningless";
  }
}

width()

double StatisticsFinder::width

(

)

const

calculate and return the width

Definition at line 131 of file StatisticsFinder.cpp.

                                    {
  return sqrt(secondCentralMom());  
}

widthError()

double StatisticsFinder::widthError

(

)

const

calculate and return the error on the width

Definition at line 138 of file StatisticsFinder.cpp.

                                         {
  return sqrt( sqrt( ( fourthCentralMom() - varience()*varience() )*(1.0/(8.0*_nEvents*_nEvents)) ) );
}

Member Data Documentation

_keepOrderedEvents

int StatisticsFinder::_keepOrderedEvents

private

Keep a list of the values added (so the median can be found)

Definition at line 30 of file StatisticsFinder.h.

_max

double StatisticsFinder::_max

private

The largest member added to the StatisticsFinder

Definition at line 18 of file StatisticsFinder.h.

_min

double StatisticsFinder::_min

private

The smallest member added to the StatisticsFinder

Definition at line 17 of file StatisticsFinder.h.

_nEvents

double StatisticsFinder::_nEvents

private

The number of events added to the StatisticsFinder

Definition at line 20 of file StatisticsFinder.h.

_orderedEvents

std::vector<double> StatisticsFinder::_orderedEvents

mutableprivate

list of the values added

Definition at line 31 of file StatisticsFinder.h.

_sumW

double StatisticsFinder::_sumW

private

The sum of weights

Definition at line 25 of file StatisticsFinder.h.

_wSum

double StatisticsFinder::_wSum

private

The weighted sum of values added to the StatisticsFinder

Definition at line 21 of file StatisticsFinder.h.

_wSum2

double StatisticsFinder::_wSum2

private

The weighted sum of values^2 added to the StatisticsFinder

Definition at line 22 of file StatisticsFinder.h.

_wSum3

double StatisticsFinder::_wSum3

private

The weighted sum of values^3 added to the StatisticsFinder

Definition at line 23 of file StatisticsFinder.h.

_wSum4

double StatisticsFinder::_wSum4

private

The weighted sum of values^4 added to the StatisticsFinder

Definition at line 24 of file StatisticsFinder.h.

---

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

• Mint/StatisticsFinder.h
• src/Mojito/Chi2Test/StatisticsFinder.cpp