LArSamples::Averager Class Reference

storage of the time histories of all the cells More...

#include <Averager.h>

Inheritance diagram for LArSamples::Averager:

Collaboration diagram for LArSamples::Averager:

Public Member Functions
	Averager (unsigned int n=0)
	Constructor More...
	Averager (unsigned int lwb, unsigned int upb)
	Averager (const Averager &)=default
virtual	~Averager ()
bool	add (double xMin=-DBL_MAX, double xMax=DBL_MAX)
bool	fill (const TVectorD &values, double w=1)
bool	append (const Averager &other)
double	mean (unsigned int i) const
double	meanError (unsigned int i) const
double	rms (unsigned int i) const
double	covariance (unsigned int i, unsigned j) const
double	covarianceError (unsigned int i, unsigned j) const
TVectorD	means () const
TVectorD	meanErrors () const
CovMatrix	meanErrorMatrix () const
CovMatrix	covarianceMatrix () const
CovMatrix	covarianceMatrixErrors () const
unsigned int	nVariables () const
int	lwb () const
int	upb () const
unsigned int	nEntries () const
double	totalWeight () const
const TVectorD &	sum1 () const
const TVectorD &	sum2 () const
const TMatrixD &	sum11Matrix () const
const TMatrixD &	sum21Matrix () const
const TMatrixD &	sum22Matrix () const
Averager &	operator= (const Averager &other)
bool	isInRange (int i) const
bool	hasSameRange (int lw, int up) const
bool	hasSameRange (const IndexRange &other) const
bool	hasSameRange (const TVectorD &v) const
bool	providesRange (int lw, int up) const
bool	providesRange (const IndexRange &other) const
bool	providesRange (const TVectorD &v) const
TString	rangeStr () const
int	commonLwb (const IndexRange &other) const
int	commonUpb (const IndexRange &other) const
bool	checkRange (int &l, int &h) const

Static Public Member Functions
static double	safeSqrt (double x)

Private Member Functions
bool	prepare ()

Private Attributes
unsigned int	m_n
double	m_wTot
int	m_lwb
std::vector< double >	m_xMin
std::vector< double >	m_xMax
TVectorD	m_sum1
TVectorD	m_sum2
TMatrixD	m_sum11Matrix
TMatrixD	m_sum21Matrix
TMatrixD	m_sum22Matrix

Detailed Description

storage of the time histories of all the cells

Definition at line 22 of file Averager.h.

Constructor & Destructor Documentation

Averager() [1/3]

Averager::Averager

(

unsigned int

n = 0

)

Constructor

Definition at line 15 of file Averager.cxx.

 : m_n(0), m_wTot(0), m_lwb(0)
{
  for (unsigned int i = 0; i < n; i++) add();
}

Averager() [2/3]

Averager::Averager	(	unsigned int	lwb,
		unsigned int	upb
	)

Definition at line 22 of file Averager.cxx.

 : m_n(0), m_wTot(0), m_lwb(lwb)
{
  for (unsigned int i = lwb; i <= upb; i++) add();
}

Averager() [3/3]

LArSamples::Averager::Averager ( const Averager &  )

default

~Averager()

virtual LArSamples::Averager::~Averager ( )

inlinevirtual

Definition at line 32 of file Averager.h.

{ }

Member Function Documentation

add()

bool Averager::add	(	double	xMin = -DBL_MAX,
		double	xMax = DBL_MAX
	)

Definition at line 46 of file Averager.cxx.

{
  if (m_n > 0) {
    cout << "Cannot add more variables to the Averager, data filling has started already." << endl;
    return false;
  }
  m_xMin.push_back(xMin);
  m_xMax.push_back(xMax);
  return true;
}

append()

bool Averager::append

(

const Averager &

other

)

Definition at line 94 of file Averager.cxx.

{
  if (nEntries() == 0) {
    *this = other;
    return true;
  }
  if (!hasSameRange(other)) return false;
  m_sum1 += other.sum1();
  m_sum2 += other.sum2();
  m_sum11Matrix += other.sum11Matrix();
  m_sum21Matrix += other.sum21Matrix();
  m_sum22Matrix += other.sum22Matrix();
  m_n += other.nEntries();
  m_wTot += other.totalWeight();
  return true;
}

checkRange()

bool IndexRange::checkRange ( int &  l, int &  h  ) const

inherited

Definition at line 14 of file IndexRange.cxx.

{  
  if (l < 0) 
    l = lwb();
  else if (!isInRange(l)) {
    cout << "IndexRange::checkRange : lower bound " << l << " is out of bounds" << endl;
    return false;
  }
 
  if (h < 0) 
    h = upb();
  else if (!isInRange(h)) {
    cout << "IndexRange::checkRange : upper bound " << h << " is out of bounds" << endl;
    return false;
  }
 
  return true;
}

commonLwb()

int LArSamples::IndexRange::commonLwb ( const IndexRange &  other ) const

inlineinherited

Definition at line 39 of file IndexRange.h.

{ return (other.lwb() > lwb() ? other.lwb() : lwb()); }

commonUpb()

int LArSamples::IndexRange::commonUpb ( const IndexRange &  other ) const

inlineinherited

Definition at line 40 of file IndexRange.h.

{ return (other.upb() < upb() ? other.upb() : upb()); }

covariance()

double Averager::covariance	(	unsigned int	i,
		unsigned	j
	)		const

Definition at line 221 of file Averager.cxx.

{
  if (!isInRange(i) || !isInRange(j)) {
    cout << "Indices (" << i << ", " << j << ") out of range" << endl;
    return 0;
  }
  return covarianceMatrix()(i, j);
}

covarianceError()

double Averager::covarianceError	(	unsigned int	i,
		unsigned	j
	)		const

Definition at line 231 of file Averager.cxx.

{
  if (!isInRange(i) || !isInRange(j)) {
    cout << "Indices (" << i << ", " << j << ") out of range" << endl;
    return 0;
  }
  return covarianceMatrixErrors()(i, j);
}

covarianceMatrix()

CovMatrix Averager::covarianceMatrix

(

)

const

Definition at line 153 of file Averager.cxx.

{
  CovMatrix cm(lwb(), upb());
  if (m_n == 0) {
    cout << "No entries filled yet!" << endl;
    return cm;
  }
  for (int i1 = lwb(); i1 <= upb(); i1++)
    for (int i2 = lwb(); i2 <= upb(); i2++)
      cm(i1, i2) = (m_sum11Matrix(i1, i2)/m_wTot) - (m_sum1(i1)/m_wTot)*(m_sum1(i2)/m_wTot);
  return cm;
}

covarianceMatrixErrors()

CovMatrix Averager::covarianceMatrixErrors

(

)

const

Definition at line 167 of file Averager.cxx.

{
  CovMatrix dcm(lwb(), upb());
  if (m_n == 0) {
    cout << "No entries filled yet!" << endl;
    return dcm;
  }
  
  for (int i1 = lwb(); i1 <= upb(); i1++)
    for (int i2 = lwb(); i2 <= upb(); i2++) {
      dcm(i1, i2) = safeSqrt((
      (m_sum22Matrix(i1, i2)/m_wTot) 
      - 2*(m_sum21Matrix(i1, i2)/m_wTot)*(m_sum1(i2)/m_wTot) - 2*(m_sum21Matrix(i2, i1)/m_wTot)*(m_sum1(i1)/m_wTot)
      + (m_sum11Matrix(i1, i1)/m_wTot)*(m_sum1(i2)/m_wTot)*(m_sum1(i2)/m_wTot) + (m_sum11Matrix(i2, i2)/m_wTot)*(m_sum1(i1)/m_wTot)*(m_sum1(i1)/m_wTot)
      - (m_sum11Matrix(i1, i2)/m_wTot)*(m_sum11Matrix(i1, i2)/m_wTot)
      + 6*(m_sum11Matrix(i1, i2)/m_wTot)*(m_sum1(i1)/m_wTot)*(m_sum1(i2)/m_wTot)
      - 4*(m_sum1(i1)/m_wTot)*(m_sum1(i1)/m_wTot)*(m_sum1(i2)/m_wTot)*(m_sum1(i2)/m_wTot)
      )/m_wTot);
    }
    
  return dcm;
}

fill()

bool Averager::fill	(	const TVectorD &	values,
		double	w = 1
	)

Definition at line 69 of file Averager.cxx.

{
  if (!hasSameRange(values)) {
    cout << "Filling with wrong indices!" << endl;
    return false;
  }
  if (m_n == 0 && !prepare()) return false;
  
  for (int i1 = lwb(); i1 <= upb(); i1++) {
    double val1 = values(i1);
    m_sum1(i1) += val1*w;
    m_sum2(i1) += val1*val1*w;
    for (int i2 = lwb(); i2 <= upb(); i2++) {
      double val2 = values(i2);      
      m_sum11Matrix(i1, i2) += val1*val2*w;
      m_sum21Matrix(i1, i2) += val1*val1*val2*w;
      m_sum22Matrix(i1, i2) += val1*val1*val2*val2*w;
    }
  }
  m_n++;
  m_wTot += w;
  return true;
}

hasSameRange() [1/3]

bool LArSamples::IndexRange::hasSameRange ( const IndexRange &  other ) const

inlineinherited

Definition at line 30 of file IndexRange.h.

{ return hasSameRange(other.lwb(), other.upb()); }

hasSameRange() [2/3]

bool LArSamples::IndexRange::hasSameRange ( const TVectorD &  v ) const

inlineinherited

Definition at line 31 of file IndexRange.h.

{ return hasSameRange(v.GetLwb(), v.GetUpb()); }

hasSameRange() [3/3]

bool LArSamples::IndexRange::hasSameRange ( int  lw, int  up  ) const

inlineinherited

Definition at line 29 of file IndexRange.h.

{ return (lwb() == lw && upb() == up); }

isInRange()

bool LArSamples::IndexRange::isInRange ( int  i ) const

inlineinherited

Definition at line 27 of file IndexRange.h.

{ return (i >= lwb() && i <= upb()); }

lwb()

int LArSamples::Averager::lwb ( ) const

inlinevirtual

Implements LArSamples::IndexRange.

Definition at line 54 of file Averager.h.

{ return m_lwb; }

mean()

double Averager::mean

(

unsigned int

i

)

const

Definition at line 191 of file Averager.cxx.

{
  if (!isInRange(i)) {
    cout << "Index " << i << " out of range" << endl;
    return 0;
  }
  return means()(i);
}

meanError()

double Averager::meanError

(

unsigned int

i

)

const

Definition at line 201 of file Averager.cxx.

{
  if (!isInRange(i)) {
    cout << "Index " << i << " out of range" << endl;
    return 0;
  }
  return meanErrors()(i);
}

meanErrorMatrix()

CovMatrix Averager::meanErrorMatrix

(

)

const

Definition at line 138 of file Averager.cxx.

{
  CovMatrix errs(lwb(), upb());
  if (m_n == 0) {
    cout << "No entries filled yet!" << endl;
    return errs;
  }
  CovMatrix cm = covarianceMatrix();
  for (int i1 = lwb(); i1 <= upb(); i1++)
    for (int i2 = lwb(); i2 <= upb(); i2++)
      errs(i1, i2) = cm(i1, i2)/m_wTot;
  return errs;
}

meanErrors()

TVectorD Averager::meanErrors

(

)

const

Definition at line 124 of file Averager.cxx.

{
  TVectorD dm(lwb(), upb());
  if (m_n == 0) {
    cout << "No entries filled yet!" << endl;
    return dm;
  }
  CovMatrix cm = covarianceMatrix();
  for (int i1 = lwb(); i1 <= upb(); i1++)
      dm(i1) = safeSqrt(cm(i1, i1)/m_wTot);
  return dm;
}

means()

TVectorD Averager::means

(

)

const

Definition at line 112 of file Averager.cxx.

{
  TVectorD m(lwb(), upb());
  if (m_n == 0) {
    cout << "No entries filled yet!" << endl;
    return m;
  }
  for (int i = lwb(); i <= upb(); i++) m(i) = m_sum1(i)/m_wTot;
  return m;
}

nEntries()

unsigned int LArSamples::Averager::nEntries ( ) const

inline

Definition at line 57 of file Averager.h.

{ return m_n; }

nVariables()

unsigned int LArSamples::Averager::nVariables ( ) const

inline

Definition at line 53 of file Averager.h.

{ return m_xMin.size(); }

operator=()

Averager & Averager::operator=

(

const Averager &

other

)

Definition at line 29 of file Averager.cxx.

{
  m_n = other.m_n;
  m_wTot = other.m_wTot;
  m_lwb = other.lwb();
  m_xMin = other.m_xMin;
  m_xMax = other.m_xMax;
  prepare();
  m_sum1 = other.sum1();
  m_sum2 = other.sum2();
  m_sum11Matrix = other.sum11Matrix();
  m_sum21Matrix = other.sum21Matrix();
  m_sum22Matrix = other.sum22Matrix();
  return *this;
}

prepare()

bool Averager::prepare ( )

private

Definition at line 58 of file Averager.cxx.

{
  m_sum1.ResizeTo(lwb(), upb());
  m_sum2.ResizeTo(lwb(), upb());
  m_sum11Matrix.ResizeTo(lwb(), upb(), lwb(), upb());                         
  m_sum21Matrix.ResizeTo(lwb(), upb(), lwb(), upb());
  m_sum22Matrix.ResizeTo(lwb(), upb(), lwb(), upb());
  return true;
}

providesRange() [1/3]

bool LArSamples::IndexRange::providesRange ( const IndexRange &  other ) const

inlineinherited

Definition at line 34 of file IndexRange.h.

{ return providesRange(other.lwb(), other.upb()); }

providesRange() [2/3]

bool LArSamples::IndexRange::providesRange ( const TVectorD &  v ) const

inlineinherited

Definition at line 35 of file IndexRange.h.

{ return providesRange(v.GetLwb(), v.GetUpb()); }

providesRange() [3/3]

bool LArSamples::IndexRange::providesRange ( int  lw, int  up  ) const

inlineinherited

Definition at line 33 of file IndexRange.h.

{ return (lwb() <= lw && upb() >= up); }

rangeStr()

TString LArSamples::IndexRange::rangeStr ( ) const

inlineinherited

Definition at line 37 of file IndexRange.h.

{ return Form("[%d, %d]", lwb(), upb()); }

rms()

double Averager::rms

(

unsigned int

i

)

const

Definition at line 211 of file Averager.cxx.

{
  if (!isInRange(i)) {
    cout << "Index " << i << " out of range" << endl;
    return 0;
  }
  return safeSqrt(covarianceMatrix()(i, i));
}

safeSqrt()

double Averager::safeSqrt ( double  x )

static

Definition at line 241 of file Averager.cxx.

{
  if (x < 0 && x > -1E-10) return 0;
  return TMath::Sqrt(x);
}

sum1()

const TVectorD& LArSamples::Averager::sum1 ( ) const

inline

Definition at line 60 of file Averager.h.

{ return m_sum1; }

sum11Matrix()

const TMatrixD& LArSamples::Averager::sum11Matrix ( ) const

inline

Definition at line 62 of file Averager.h.

{ return m_sum11Matrix; }

sum2()

const TVectorD& LArSamples::Averager::sum2 ( ) const

inline

Definition at line 61 of file Averager.h.

{ return m_sum2; }

sum21Matrix()

const TMatrixD& LArSamples::Averager::sum21Matrix ( ) const

inline

Definition at line 63 of file Averager.h.

{ return m_sum21Matrix; }

sum22Matrix()

const TMatrixD& LArSamples::Averager::sum22Matrix ( ) const

inline

Definition at line 64 of file Averager.h.

{ return m_sum22Matrix; }

totalWeight()

double LArSamples::Averager::totalWeight ( ) const

inline

Definition at line 58 of file Averager.h.

{ return m_wTot; }

upb()

int LArSamples::Averager::upb ( ) const

inlinevirtual

Implements LArSamples::IndexRange.

Definition at line 55 of file Averager.h.

{ return m_lwb + nVariables() - 1; }

Member Data Documentation

m_lwb

int LArSamples::Averager::m_lwb

private

Definition at line 75 of file Averager.h.

m_n

unsigned int LArSamples::Averager::m_n

private

Definition at line 73 of file Averager.h.

m_sum1

TVectorD LArSamples::Averager::m_sum1

private

Definition at line 78 of file Averager.h.

m_sum11Matrix

TMatrixD LArSamples::Averager::m_sum11Matrix

private

Definition at line 79 of file Averager.h.

m_sum2

TVectorD LArSamples::Averager::m_sum2

private

Definition at line 78 of file Averager.h.

m_sum21Matrix

TMatrixD LArSamples::Averager::m_sum21Matrix

private

Definition at line 79 of file Averager.h.

m_sum22Matrix

TMatrixD LArSamples::Averager::m_sum22Matrix

private

Definition at line 79 of file Averager.h.

m_wTot

double LArSamples::Averager::m_wTot

private

Definition at line 74 of file Averager.h.

m_xMax

std::vector<double> LArSamples::Averager::m_xMax

private

Definition at line 77 of file Averager.h.

m_xMin

std::vector<double> LArSamples::Averager::m_xMin

private

Definition at line 77 of file Averager.h.

---

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

• Averager.h
• Averager.cxx