ECLLocalRunCalibAcc Class Reference

ECLLocalRunCalibAcc is the class designed to accumulate mean values, standard deviation and number of accepted events. More...

#include <ECLLocalRunCalibAcc.h>

Collaboration diagram for ECLLocalRunCalibAcc:

Public Member Functions
	ECLLocalRunCalibAcc (const float &min_value, const float &max_value, const int *const ndevs)
	Constructor.
	~ECLLocalRunCalibAcc ()
	Destructor.
int	getNOfEvents () const
	Get total number of events.
int	getCount () const
	Get number of accepted events.
float	getMean () const
	Get mean value.
float	getStdDev () const
	Get standard deviation.
void	add (const float &value)
	Add value.
void	calc ()
	Calculate mean value, standard deviation and number of accepted events.

Private Member Functions
bool	isValueInRange (const float &value) const
	Check value.
float	calcStdDev (const float &variance, const int &count) const
	Calculate standard deviation using variance and number of accepted events.
void	updateLimits (const float &mean, const float &stddev)
	Update value limits.

Private Attributes
float	m_leftLimit
	Lower value limit.
float	m_rightLimit
	Upper value limit.
const int *const	c_ndevs
	Number of standard deviations used to update value limits.
int	m_nevents
	Total number of events.
int	m_count
	Number of accepted events.
float	m_mean
	Mean value.
float	m_stddev
	Standard deviation.
std::vector< int >	m_data
	Vector of accepted values.

Detailed Description

ECLLocalRunCalibAcc is the class designed to accumulate mean values, standard deviation and number of accepted events.

Definition at line 27 of file ECLLocalRunCalibAcc.h.

Constructor & Destructor Documentation

ECLLocalRunCalibAcc()

ECLLocalRunCalibAcc	(	const float &	min_value,
		const float &	max_value,
		const int *const	ndevs
	)

Constructor.

Parameters

min_value	is the lower value limit.
max_value	is the upper value limit
ndevs	is the number of standard deviations. used to update value limits.

Definition at line 18 of file ECLLocalRunCalibAcc.cc.

                         :
  m_leftLimit(min_value),
  m_rightLimit(max_value),
  c_ndevs(ndevs),
  m_nevents(0),
  m_count(0),
  m_mean(0.),
  m_stddev(0.)
{
  m_data.reserve(1000);
}

~ECLLocalRunCalibAcc()

~ECLLocalRunCalibAcc

(

)

Destructor.

Definition at line 33 of file ECLLocalRunCalibAcc.cc.

{
}

Member Function Documentation

add()

void add

(

const float &

value

)

Add value.

Definition at line 43 of file ECLLocalRunCalibAcc.cc.

{
  m_data.push_back(value);
}

calc()

void calc

(

)

Calculate mean value, standard deviation and number of accepted events.

Definition at line 65 of file ECLLocalRunCalibAcc.cc.

{
  if (m_data.size() == 0) {
    m_nevents = 0;
    m_count = 0;
    m_mean = 0;
    m_stddev = 0;
  } else {
    namespace bacc = boost::accumulators;
    bacc::accumulator_set <
    float,
    bacc::features <
    bacc::tag::count,
    bacc::tag::median,
    bacc::tag::variance >> acc;
    for (const auto& value : m_data) {
      if (isValueInRange(value)) {
        acc(value);
      }
    }
    float tcount = bacc::count(acc);
    float tmedian = bacc::median(acc);
    float tvariance = bacc::variance(acc);
    float tstddev = calcStdDev(tvariance,
                               tcount);
    updateLimits(tmedian, tstddev);
    bacc::accumulator_set <
    float,
    bacc::features <
    bacc::tag::count,
    bacc::tag::mean,
    bacc::tag::variance >> acc_final;
    for (const auto& value : m_data) {
      if (isValueInRange(value)) {
        acc_final(value);
      }
    }
    m_nevents = static_cast<int>(m_data.size());
    m_data.clear();
    m_count = bacc::count(acc_final);
    m_mean = bacc::mean(acc_final);
    tvariance = bacc::variance(acc_final);
    m_stddev = calcStdDev(tvariance, m_count);
  }
}

calcStdDev()

float calcStdDev ( const float &  variance, const int &  count  ) const

private

Calculate standard deviation using variance and number of accepted events.

Parameters

variance	is the variance.
count	is the number of accepted events.

Definition at line 50 of file ECLLocalRunCalibAcc.cc.

{
  return sqrt((variance * count) / (count - 1));
}

getCount()

int getCount

(

)

const

Get number of accepted events.

Definition at line 116 of file ECLLocalRunCalibAcc.cc.

{
  return m_count;
}

getMean()

float getMean

(

)

const

Get mean value.

Definition at line 121 of file ECLLocalRunCalibAcc.cc.

{
  return m_mean;
}

getNOfEvents()

int getNOfEvents

(

)

const

Get total number of events.

Definition at line 111 of file ECLLocalRunCalibAcc.cc.

{
  return m_nevents;
}

getStdDev()

float getStdDev

(

)

const

Get standard deviation.

Definition at line 126 of file ECLLocalRunCalibAcc.cc.

{
  return m_stddev;
}

isValueInRange()

bool isValueInRange ( const float &  value ) const

private

Check value.

Parameters

value

is the amplitude or time value

Definition at line 37 of file ECLLocalRunCalibAcc.cc.

{
  return (value > m_leftLimit) &&
         (value < m_rightLimit);
}

updateLimits()

void updateLimits ( const float &  mean, const float &  stddev  )

private

Update value limits.

Parameters

mean	is the mean value.
stddev	is the standard deviation.

Definition at line 56 of file ECLLocalRunCalibAcc.cc.

{
  m_leftLimit = std::max(m_leftLimit,
                         mean - (*c_ndevs) * stddev);
  m_rightLimit = std::min(m_rightLimit,
                          mean + (*c_ndevs) * stddev);
}

Member Data Documentation

c_ndevs

const int* const c_ndevs

private

Number of standard deviations used to update value limits.

Definition at line 109 of file ECLLocalRunCalibAcc.h.

m_count

int m_count

private

Number of accepted events.

Definition at line 118 of file ECLLocalRunCalibAcc.h.

m_data

std::vector<int> m_data

private

Vector of accepted values.

Definition at line 130 of file ECLLocalRunCalibAcc.h.

m_leftLimit

float m_leftLimit

private

Lower value limit.

Definition at line 99 of file ECLLocalRunCalibAcc.h.

m_mean

float m_mean

private

Mean value.

Definition at line 122 of file ECLLocalRunCalibAcc.h.

m_nevents

int m_nevents

private

Total number of events.

Definition at line 113 of file ECLLocalRunCalibAcc.h.

m_rightLimit

float m_rightLimit

private

Upper value limit.

Definition at line 103 of file ECLLocalRunCalibAcc.h.

m_stddev

float m_stddev

private

Standard deviation.

Definition at line 126 of file ECLLocalRunCalibAcc.h.

---

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

• ecl/modules/eclLocalRunCalibration/include/ECLLocalRunCalibAcc.h
• ecl/modules/eclLocalRunCalibration/src/ECLLocalRunCalibAcc.cc