ECLLocalRunCalibUnit Class Reference

ECLLocalRunCalibUnit is the class designed for the control of mean value and the standard deviation accumulators. More...

#include <ECLLocalRunCalibUnit.h>

Public Member Functions
	ECLLocalRunCalibUnit (const int &ncellids, const float &min_value, const float &max_value, const int *const ndevs)
	Constructor.
	~ECLLocalRunCalibUnit ()
	Destructor.
void	add (const int &cellid, const float &value)
	Add value to accumulate mean value, standard deviation and number of accepted events.
void	calc ()
	Calculate accumulated values.
void	writeToDB (bool isLocal, const std::string &dbName, const std::string &payloadName, const IntervalOfValidity &iov, const int &run, const bool &changePrev, const bool &addref)
	Write calibration results into a database.
void	enableNegAmpl ()
	This function will be called only in the case, if negative amplitudes are observed in the current run.
bool	isNegAmpl () const
	Check presence of negative amplitudes in the current run.

Private Member Functions
void	markAsRefference (const bool &isLocal, const std::string &dbName, const int &run, const IntervalOfValidity &iov)
	Mark current run as reference.
void	changePreviousIoV (const ECLDBTool &payload, const IntervalOfValidity &iov)
	Change previous validity interval.
template<typename T >
void	callAccGetter (std::vector< T > *vec, T(ECLLocalRunCalibAcc::*getter)() const)
	Getter of accumulated values.

Private Attributes
bool	m_isNegAmpl
	m_isNegAmpl is true if there are negative amplitudes in the current run and false otherwise.
std::vector< ECLLocalRunCalibAcc >	m_unitData
	Mean value and standard deviation accumulators for each cell id.

Detailed Description

ECLLocalRunCalibUnit is the class designed for the control of mean value and the standard deviation accumulators.

Definition at line 27 of file ECLLocalRunCalibUnit.h.

Constructor & Destructor Documentation

ECLLocalRunCalibUnit()

ECLLocalRunCalibUnit	(	const int &	ncellids,
		const float &	min_value,
		const float &	max_value,
		const int *const	ndevs
	)

Constructor.

Parameters

ncellids	is the number of cell ids.
min_value	is the minimum allowed value.
max_value	is the maximum allowed value.
ndevs	is the number of standard deviations.

Definition at line 16 of file ECLLocalRunCalibUnit.cc.

                         :
  m_isNegAmpl(false), m_unitData(ncellids,
                                 ECLLocalRunCalibAcc(
                                   min_value,
                                   max_value,
                                   ndevs))
{
}

~ECLLocalRunCalibUnit()

~ECLLocalRunCalibUnit

(

)

Destructor.

Definition at line 29 of file ECLLocalRunCalibUnit.cc.

{
}

Member Function Documentation

add()

void add	(	const int &	cellid,
		const float &	value
	)

Add value to accumulate mean value, standard deviation and number of accepted events.

Parameters

cellid	is the cell id number.
value	is the accumulated value.

Definition at line 49 of file ECLLocalRunCalibUnit.cc.

{
  m_unitData[index].add(value);
}

calc()

void calc

(

)

Calculate accumulated values.

Definition at line 54 of file ECLLocalRunCalibUnit.cc.

{
  for (auto& cellAcc : m_unitData) {
    cellAcc.calc();
  }
}

callAccGetter()

void callAccGetter ( std::vector< T > *  vec, T(ECLLocalRunCalibAcc::*)() const  getter  )

private

Getter of accumulated values.

Parameters

vec	is the vector used to get vector of accumulated values.
getter	is the name of the getter method.

Definition at line 62 of file ECLLocalRunCalibUnit.cc.

{
  for (const auto& obj : m_unitData) {
    vec->push_back((obj.*getter)());
  }
}

changePreviousIoV()

void changePreviousIoV ( const ECLDBTool &  payload, const IntervalOfValidity &  iov  )

private

Change previous validity interval.

Parameters

payload	is the connection to a certain payload.
iov	is the current validity interval.

Definition at line 84 of file ECLLocalRunCalibUnit.cc.

{
  int exp = iov.getExperimentLow();
  int run_high = iov.getRunLow() - 1;
  EventMetaData ev(1, run_high, exp);
  IntervalOfValidity* prevIoV;
  payload.read(&prevIoV, ev);
  int run_low = prevIoV->getRunLow();
  IntervalOfValidity ciov(exp, run_low,
                          exp, run_high);
  payload.changeIoV(ev, ciov);
  delete prevIoV;
}

enableNegAmpl()

void enableNegAmpl

(

)

This function will be called only in the case, if negative amplitudes are observed in the current run.

Definition at line 35 of file ECLLocalRunCalibUnit.cc.

{
  m_isNegAmpl = true;
}

isNegAmpl()

bool isNegAmpl

(

)

const

Check presence of negative amplitudes in the current run.

Definition at line 41 of file ECLLocalRunCalibUnit.cc.

{
  return m_isNegAmpl;
}

markAsRefference()

void markAsRefference ( const bool &  isLocal, const std::string &  dbName, const int &  run, const IntervalOfValidity &  iov  )

private

Mark current run as reference.

Parameters

isLocal	is true for local database
dbName	is central DB tag or path to a local DB.
run	is the current run number.
iov	is the current validity interval.

Definition at line 71 of file ECLLocalRunCalibUnit.cc.

{
  int exp = iov.getExperimentLow();
  ECLDBTool refPayload(isLocal, dbName.c_str(),
                       "ECLCalibRef");
  refPayload.connect();
  ECLLocalRunCalibRef refobj(exp, run);
  refPayload.write(&refobj, iov);
}

writeToDB()

void writeToDB	(	bool	isLocal,
		const std::string &	dbName,
		const std::string &	payloadName,
		const IntervalOfValidity &	iov,
		const int &	run,
		const bool &	changePrev,
		const bool &	addref
	)

Write calibration results into a database.

Parameters

isLocal	enables usage of a local database.
dbName	is the central database tag or path to a local database.
payloadName	is the payload name.
iov	is the validity interval.
run	is the current run number.
changePrev	enables previous validity interval changing.
addref	is used to mark current run as reference.

Definition at line 99 of file ECLLocalRunCalibUnit.cc.

{
  int exp = iov.getExperimentLow();
  ECLCrystalLocalRunCalib data(isNegAmpl());
  if (m_unitData.size() > 0) {
    int nevents = 0;
    for (const auto& cellAcc : m_unitData) {
      nevents = cellAcc.getNOfEvents();
      if (nevents != 0) {
        break;
      }
    }
    std::vector<int> counts;
    counts.reserve(m_unitData.size());
    callAccGetter<int>(&counts,
                       &ECLLocalRunCalibAcc::getCount);
    std::vector<float> means;
    means.reserve(m_unitData.size());
    callAccGetter<float>(&means,
                         &ECLLocalRunCalibAcc::getMean);
    std::vector<float> stddevs;
    stddevs.reserve(m_unitData.size());
    callAccGetter<float>(&stddevs,
                         &ECLLocalRunCalibAcc::getStdDev);
    data.setNumberOfEvents(nevents);
    data.setNumbersOfAcceptedEvents(counts);
    data.setCalibVector(means, stddevs);
    data.setExpRun(exp, run);
    ECLDBTool payload(isLocal, dbName.c_str(),
                      payloadName.c_str());
    payload.connect();
    if (changePrev) {
      changePreviousIoV(payload, iov);
    }
    payload.write(&data, iov);
    if (addref) {
      markAsRefference(isLocal, dbName,
                       run, iov);
    }
  }
}

Member Data Documentation

m_isNegAmpl

bool m_isNegAmpl

private

m_isNegAmpl is true if there are negative amplitudes in the current run and false otherwise.

Definition at line 95 of file ECLLocalRunCalibUnit.h.

m_unitData

std::vector<ECLLocalRunCalibAcc> m_unitData

private

Mean value and standard deviation accumulators for each cell id.

Definition at line 118 of file ECLLocalRunCalibUnit.h.

---

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

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