Belle II Software development
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
TOPCalTimeWalk Class Reference
Packages » top

Calibration constants for time-walk correction and for tuning of electronic time resolution in digitization. More...

#include <TOPCalTimeWalk.h>

Inheritance diagram for TOPCalTimeWalk:

Public Types

enum  EStatus {
  c_Default = 0 ,
  c_Calibrated = 1 ,
  c_Unusable = 2
}
 Calibration status of a constant. More...
 

Public Member Functions

 TOPCalTimeWalk ()
 Default constructor.
 
void set (const std::vector< double > &timeWalkParams, double noise, double quadratic)
 Sets all the parameters and switches status to calibrated.
 
void setUnusable ()
 Switches calibration status to unusable to flag badly calibrated constants.
 
const std::vector< double > & getTimeWalkParams () const
 Returns polynomial coefficients of time walk calibration curve.
 
double getNoiseCoefficient () const
 Returns noise term excess coefficient of electronic time resolution.
 
double getQuadraticCoefficient () const
 Returns quadratic term coefficient of electronic time resolution.
 
double getTimeWalk (int pulseHeight) const
 Returns time-walk at given pulse height.
 
double getSigmaSq (int pulseHeight) const
 Returns an excess of electronic time resolution at given pulse height.
 
double getSigma (int pulseHeight) const
 Returns an excess of electronic time resolution at given pulse height.
 
bool isCalibrated () const
 Returns calibration status.
 
bool isDefault () const
 Returns calibration status.
 
bool isUnusable () const
 Returns calibration status.
 

Private Member Functions

 ClassDef (TOPCalTimeWalk, 1)
 ClassDef.
 

Private Attributes

std::vector< double > m_timeWalkParams
 parameters of calibration curve [ns]
 
double m_noise = 0
 noise term excess coefficient [ns]
 
double m_quadratic = 0
 quadratic term coefficient [ns]
 
EStatus m_status = c_Default
 calibration status
 

Detailed Description

Calibration constants for time-walk correction and for tuning of electronic time resolution in digitization.

Definition at line 24 of file TOPCalTimeWalk.h.

Member Enumeration Documentation

◆ EStatus

enum EStatus

Calibration status of a constant.

Enumerator
c_Default 

uncalibrated default value

c_Calibrated 

good calibrated value

c_Unusable 

bad calibrated value

Definition at line 31 of file TOPCalTimeWalk.h.

31 {
32 c_Default = 0,
33 c_Calibrated = 1,
34 c_Unusable = 2
35 };
Belle2::TOPCalTimeWalk::c_Calibrated
@ c_Calibrated
good calibrated value
Definition: TOPCalTimeWalk.h:33
Belle2::TOPCalTimeWalk::c_Unusable
@ c_Unusable
bad calibrated value
Definition: TOPCalTimeWalk.h:34
Belle2::TOPCalTimeWalk::c_Default
@ c_Default
uncalibrated default value
Definition: TOPCalTimeWalk.h:32

Constructor & Destructor Documentation

◆ TOPCalTimeWalk()

TOPCalTimeWalk ( )
inline

Default constructor.

Definition at line 40 of file TOPCalTimeWalk.h.

41 {}

Member Function Documentation

◆ getNoiseCoefficient()

double getNoiseCoefficient ( ) const
inline

Returns noise term excess coefficient of electronic time resolution.

Returns
noise term excess coefficient [ns]

Definition at line 66 of file TOPCalTimeWalk.h.

66{return m_noise;}
Belle2::TOPCalTimeWalk::m_noise
double m_noise
noise term excess coefficient [ns]
Definition: TOPCalTimeWalk.h:116

◆ getQuadraticCoefficient()

double getQuadraticCoefficient ( ) const
inline

Returns quadratic term coefficient of electronic time resolution.

Returns
quadratic term coefficient [ns]

Definition at line 72 of file TOPCalTimeWalk.h.

72{return m_quadratic;}
Belle2::TOPCalTimeWalk::m_quadratic
double m_quadratic
quadratic term coefficient [ns]
Definition: TOPCalTimeWalk.h:117

◆ getTimeWalkParams()

const std::vector< double > & getTimeWalkParams ( ) const
inline

Returns polynomial coefficients of time walk calibration curve.

Returns
coefficents of polynomial [ns]

Definition at line 60 of file TOPCalTimeWalk.h.

60{return m_timeWalkParams;}
Belle2::TOPCalTimeWalk::m_timeWalkParams
std::vector< double > m_timeWalkParams
parameters of calibration curve [ns]
Definition: TOPCalTimeWalk.h:115

◆ isCalibrated()

bool isCalibrated ( ) const
inline

Returns calibration status.

Returns
true, if good calibrated

Definition at line 99 of file TOPCalTimeWalk.h.

99{return m_status == c_Calibrated;}
Belle2::TOPCalTimeWalk::m_status
EStatus m_status
calibration status
Definition: TOPCalTimeWalk.h:118

◆ isDefault()

bool isDefault ( ) const
inline

Returns calibration status.

Returns
true, if default (not calibrated)

Definition at line 105 of file TOPCalTimeWalk.h.

105{return m_status == c_Default;};

◆ isUnusable()

bool isUnusable ( ) const
inline

Returns calibration status.

Returns
true, if bad calibrated

Definition at line 111 of file TOPCalTimeWalk.h.

111{return m_status == c_Unusable;};

◆ setUnusable()

void setUnusable ( )
inline

Switches calibration status to unusable to flag badly calibrated constants.

Definition at line 54 of file TOPCalTimeWalk.h.

54{m_status = c_Unusable;}

Member Data Documentation

◆ m_noise

double m_noise = 0
private

noise term excess coefficient [ns]

Definition at line 116 of file TOPCalTimeWalk.h.

◆ m_quadratic

double m_quadratic = 0
private

quadratic term coefficient [ns]

Definition at line 117 of file TOPCalTimeWalk.h.

◆ m_status

EStatus m_status = c_Default
private

calibration status

Definition at line 118 of file TOPCalTimeWalk.h.

◆ m_timeWalkParams

std::vector<double> m_timeWalkParams
private

parameters of calibration curve [ns]

Definition at line 115 of file TOPCalTimeWalk.h.

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