#include <HyperStatisticsFinder.h>

Inheritance diagram for HyperStatisticsFinder:

Public Member Functions
	HyperStatisticsFinder (int dimension, bool mean=1, bool width=1, bool widthError=1, bool keepOrderedEvents=0)

	HyperStatisticsFinder (const HyperPoint &point, bool mean=1, bool width=1, bool widthError=1, bool keepOrderedEvents=0)

void	add (const HyperPoint &x)

double	correlation (int i, int j) const

double	covarience (int i, int j) const

double	mean (int i) const

double	meanError (int i) const

double	width (int i) const

double	getMin (int i) const

double	getMax (int i) const

HyperPoint	mean () const

HyperPoint	meanError () const

HyperPoint	width () const

HyperPoint	getMin () const

HyperPoint	getMax () const

const StatisticsFinder &	getStatisticsFinder (int i) const

virtual	~HyperStatisticsFinder ()

Private Attributes
int	_dim

std::vector< std::vector< StatisticsFinder > >	_statisticsFinders

Detailed Description

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

This class is used to find statistics (e.g. mean, width...) of a multi dimensional (Hyper) dataset. To do so it uses a 2D array of the StatisticsFinder class. I suspect there is a computationally less expensive way to do this, but this does the job for now.

Definition at line 22 of file HyperStatisticsFinder.h.

Constructor & Destructor Documentation

◆ HyperStatisticsFinder() [1/2]

HyperStatisticsFinder::HyperStatisticsFinder	(	int	dimension,
		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. Also decide the dimensionality of each data point.

Definition at line 5 of file HyperStatisticsFinder.cpp.

                                                                                                                     :
   _dim(dim)
 {
   
   for (int i = 0; i < _dim; i++){
     std::vector<StatisticsFinder> statsFinders;
     for (int j = 0; j < _dim; j++){
       statsFinders.push_back( StatisticsFinder(mean, width, widthError, keepOrderedEvents) );
     }
     _statisticsFinders.push_back(statsFinders);
   }
 
 }

◆ HyperStatisticsFinder() [2/2]

HyperStatisticsFinder::HyperStatisticsFinder	(	const HyperPoint &	point,
		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. Also decide the dimensionality of each data point by passing a HyperPoint. This point is also added to the HyperStatisticsFinder

Definition at line 19 of file HyperStatisticsFinder.cpp.

                                                                                                                                 :
   _dim(x.getDimension())
 {
   
   for (int i = 0; i < _dim; i++){
     std::vector<StatisticsFinder> statsFinders;
     for (int j = 0; j < _dim; j++){
       statsFinders.push_back( StatisticsFinder(mean, width, widthError, keepOrderedEvents) );
     }
     _statisticsFinders.push_back(statsFinders);
   }
   
   add(x);
 
 }

◆ ~HyperStatisticsFinder()

HyperStatisticsFinder::~HyperStatisticsFinder ( )

virtual

Destructor

Definition at line 134 of file HyperStatisticsFinder.cpp.

                                              {
 
 }

Member Function Documentation

◆ add()

void HyperStatisticsFinder::add ( const HyperPoint & x )

add a HyperPoint to the HyperStatisticsFinder

Definition at line 35 of file HyperStatisticsFinder.cpp.

                                                     {
 
   if (x.getDimension() != _dim) ERROR_LOG << "The HyperPoint you are adding is not of the correct dimension";
   
   for (int i = 0; i < _dim; i++){ 
     for (int j = 0; j < _dim; j++){
       double val = 0.0;
       if (i == j) val = x.at(i);
       if (i != j) val = x.at(i)*x.at(j);
       _statisticsFinders.at(i).at(j).add( val, x.getWeight() );
     }
   }  
 
 }

◆ correlation()

double HyperStatisticsFinder::correlation	(	int	i,
		int	j
	)		const

get the correlation coefficient of dimesnions i and j

Definition at line 50 of file HyperStatisticsFinder.cpp.

                                                            {
   
   return covarience(i,j)/sqrt(covarience(i,i)*covarience(j,j));
 
 }

◆ covarience()

double HyperStatisticsFinder::covarience	(	int	i,
		int	j
	)		const

get the covarience of dimesnions i and j

Definition at line 61 of file HyperStatisticsFinder.cpp.

                                                           {
   
   if (i == j) {
     return _statisticsFinders.at(i).at(i).varience();
   }
 
   const StatisticsFinder& statsI  = _statisticsFinders.at(i).at(i);
   const StatisticsFinder& statsJ  = _statisticsFinders.at(j).at(j);
   const StatisticsFinder& statsIJ = _statisticsFinders.at(i).at(j);
   
   double expI  = statsI .mean();
   double expJ  = statsJ .mean();
   double expIJ = statsIJ.mean();
 
   return expIJ - expI*expJ;
 
 }

◆ getMax() [1/2]

double HyperStatisticsFinder::getMax ( int i ) const

get the maximum in a given dimension

Definition at line 96 of file HyperStatisticsFinder.cpp.

                                                {
   return _statisticsFinders.at(i).at(i).getMax();
 }

◆ getMax() [2/2]

HyperPoint HyperStatisticsFinder::getMax ( ) const

get a HyperPoint filled with the maximum of each dimension

Definition at line 127 of file HyperStatisticsFinder.cpp.

                                               {
   HyperPoint point(_dim);
   for (int i = 0; i < _dim; i++) point.at(i) = _statisticsFinders.at(i).at(i).getMax();
   return point;
 }

◆ getMin() [1/2]

double HyperStatisticsFinder::getMin ( int i ) const

get the minimum in a given dimension

Definition at line 92 of file HyperStatisticsFinder.cpp.

                                                {
   return _statisticsFinders.at(i).at(i).getMin();
 }

◆ getMin() [2/2]

HyperPoint HyperStatisticsFinder::getMin ( ) const

get a HyperPoint filled with the minimum of each dimension

Definition at line 121 of file HyperStatisticsFinder.cpp.

                                               {
   HyperPoint point(_dim);
   for (int i = 0; i < _dim; i++) point.at(i) = _statisticsFinders.at(i).at(i).getMin();
   return point;
 }

◆ getStatisticsFinder()

const StatisticsFinder& HyperStatisticsFinder::getStatisticsFinder ( int i ) const

inline

get the statistics finder for a specific dimesion

Definition at line 77 of file HyperStatisticsFinder.h.

◆ mean() [1/2]

double HyperStatisticsFinder::mean ( int i ) const

get the mean in a given dimension

Definition at line 80 of file HyperStatisticsFinder.cpp.

                                              {
   return _statisticsFinders.at(i).at(i).mean();
 }

◆ mean() [2/2]

HyperPoint HyperStatisticsFinder::mean ( ) const

get a HyperPoint filled with the mean of each dimension

Definition at line 103 of file HyperStatisticsFinder.cpp.

                                             {
   HyperPoint point(_dim);
   for (int i = 0; i < _dim; i++) point.at(i) = _statisticsFinders.at(i).at(i).mean();
   return point;
 }

◆ meanError() [1/2]

double HyperStatisticsFinder::meanError ( int i ) const

get the meanError in a given dimension

Definition at line 84 of file HyperStatisticsFinder.cpp.

                                                   {
   return _statisticsFinders.at(i).at(i).meanError();
 }

◆ meanError() [2/2]

HyperPoint HyperStatisticsFinder::meanError ( ) const

get a HyperPoint filled with the error on the mean of each dimension

Definition at line 109 of file HyperStatisticsFinder.cpp.

                                                  {
   HyperPoint point(_dim);
   for (int i = 0; i < _dim; i++) point.at(i) = _statisticsFinders.at(i).at(i).meanError();
   return point;
 }

◆ width() [1/2]

double HyperStatisticsFinder::width ( int i ) const

get the width in a given dimension

Definition at line 88 of file HyperStatisticsFinder.cpp.

                                               {
   return _statisticsFinders.at(i).at(i).width();
 }

◆ width() [2/2]

HyperPoint HyperStatisticsFinder::width ( ) const

get a HyperPoint filled with the width of each dimension

Definition at line 115 of file HyperStatisticsFinder.cpp.

                                              {
   HyperPoint point(_dim);
   for (int i = 0; i < _dim; i++) point.at(i) = _statisticsFinders.at(i).at(i).width();
   return point;
 }

Member Data Documentation

◆ _dim

int HyperStatisticsFinder::_dim

private

dimension of the HyperStatisticsFinder

Definition at line 24 of file HyperStatisticsFinder.h.

◆ _statisticsFinders

std::vector< std::vector < StatisticsFinder > > HyperStatisticsFinder::_statisticsFinders