ECLTimeWalkCorrection Class Reference

This object contain parameters of the Time-Walk correction function of the ECL. More...

#include <ECLTimeWalkCorrection.h>

Inheritance diagram for ECLTimeWalkCorrection:

Public Member Functions
	ECLTimeWalkCorrection ()
	Default constructor.
	~ECLTimeWalkCorrection ()
	Destructor.
double	getParam (int n) const
	return nth parameter of the time-walk correction.
void	setParam (int n, double newval)
	set nth parameter of the time-walk correction.
std::vector< double >	getParams () const
	Return std::vector containing all parameters of the time walk correction function.
void	setParams (const std::vector< double > &new_params)
	Set std::vector containing all parameters of the time walk correction function.
int	getParamFormat ()
	Get parameter format ID.
void	setParamFormat (int newval)
	Set parameter format ID.

Private Member Functions
	ClassDef (ECLTimeWalkCorrection, 1)
	tells ROOT not to write it to file

Private Attributes
int	m_parFormat = 0
	Format of the correction parameters 0 - same set of (c_expectedParametersCount) parameters for all Cell IDs (for now, only 0 is supported)
std::vector< double >	m_par
	List of time walk correction parameters.

Static Private Attributes
static const int	c_expectedParametersCount = 6
	Number of values expected to be in the m_par vector.

Detailed Description

This object contain parameters of the Time-Walk correction function of the ECL.

General correction contain 7 parameters

Definition at line 26 of file ECLTimeWalkCorrection.h.

Constructor & Destructor Documentation

ECLTimeWalkCorrection()

ECLTimeWalkCorrection ( )

inline

Default constructor.

Definition at line 32 of file ECLTimeWalkCorrection.h.

                            :
      m_par(c_expectedParametersCount)
    {
    }

~ECLTimeWalkCorrection()

~ECLTimeWalkCorrection ( )

inline

Destructor.

Definition at line 40 of file ECLTimeWalkCorrection.h.

{}

Member Function Documentation

ClassDef()

ClassDef ( ECLTimeWalkCorrection , 1  )

private

tells ROOT not to write it to file

ClassDef

getParam()

double getParam ( int n ) const

inline

return nth parameter of the time-walk correction.

Definition at line 43 of file ECLTimeWalkCorrection.h.

    {
      return m_par.at(n);
    }

getParamFormat()

int getParamFormat ( )

inline

Get parameter format ID.

Definition at line 85 of file ECLTimeWalkCorrection.h.

    {
      return m_parFormat;
    }

getParams()

std::vector< double > getParams ( ) const

inline

Return std::vector containing all parameters of the time walk correction function.

See also

m_par

m_parFormat

Definition at line 63 of file ECLTimeWalkCorrection.h.

    {
      return m_par;
    }

setParam()

void setParam ( int n, double newval )

inline

set nth parameter of the time-walk correction.

Definition at line 48 of file ECLTimeWalkCorrection.h.

    {
      if (n < 0 || n >= c_expectedParametersCount) {
        B2FATAL("Parameter index should be within [0, " <<
                c_expectedParametersCount - 1 << "]." <<
                LogVar("parameter index", n));
      }
      m_par[n] = newval;
    }

setParamFormat()

void setParamFormat ( int newval )

inline

Set parameter format ID.

Definition at line 93 of file ECLTimeWalkCorrection.h.

    {
      m_parFormat = newval;
    }

setParams()

void setParams ( const std::vector< double > & new_params )

inline

Set std::vector containing all parameters of the time walk correction function.

See also

m_par

m_parFormat

Definition at line 72 of file ECLTimeWalkCorrection.h.

    {
      if (new_params.size() != c_expectedParametersCount) {
        B2FATAL("Count of parameters must always be equal to " <<
                c_expectedParametersCount <<
                LogVar("count of parameters", new_params.size()));
      }
      m_par = new_params;
    }

Member Data Documentation

c_expectedParametersCount

const int c_expectedParametersCount = 6

staticprivate

Number of values expected to be in the m_par vector.

Definition at line 111 of file ECLTimeWalkCorrection.h.

m_par

std::vector<double> m_par

private

List of time walk correction parameters.

Definition at line 106 of file ECLTimeWalkCorrection.h.

m_parFormat

int m_parFormat = 0

private

Format of the correction parameters 0 - same set of (c_expectedParametersCount) parameters for all Cell IDs (for now, only 0 is supported)

Definition at line 104 of file ECLTimeWalkCorrection.h.

---

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

• ecl/dbobjects/include/ECLTimeWalkCorrection.h