Belle II Software development
TOPCalCommonT0 Class Reference

Common T0 calibration constant. More...

#include <TOPCalCommonT0.h>

Inheritance diagram for TOPCalCommonT0:

Public Types

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

Public Member Functions

 TOPCalCommonT0 ()
 Default constructor.
 
 TOPCalCommonT0 (double T0, double errT0)
 Full constructor, sets status to calibrated.
 
void setUnusable ()
 Switches calibration status to unusable to flag badly calibrated constant.
 
void setRoughlyCalibrated ()
 Switches calibration status to roughly calibrated (usefull at HLT/express reco)
 
double getT0 () const
 Returns T0.
 
double getT0Error () const
 Returns error on T0.
 
bool isCalibrated () const
 Returns calibration status.
 
bool isDefault () const
 Returns calibration status.
 
bool isUnusable () const
 Returns calibration status.
 
bool isRoughlyCalibrated () const
 Returns calibration status.
 

Private Member Functions

 ClassDef (TOPCalCommonT0, 3)
 ClassDef.
 

Private Attributes

float m_T0 = 0
 calibration constant
 
float m_errT0 = 0
 error on constant
 
EStatus m_status = c_Default
 calibration status
 

Detailed Description

Common T0 calibration constant.

Calibration can be intra run dependent. Done usually with di-muon events.

Definition at line 23 of file TOPCalCommonT0.h.

Member Enumeration Documentation

◆ EStatus

enum EStatus

Calibration status of a constant.

Notes:

  • TOPDigits are alowed to be calibrated only if status = c_Calibrated
  • value for status = c_roughlyCalibrated is used only to set initial value of bunch offset running average in bunch finder
Enumerator
c_Default 

uncalibrated default value

c_Calibrated 

good calibrated value

c_Unusable 

bad calibrated value

c_roughlyCalibrated 

only roughly calibrated value (for HLT/expressreco)

Definition at line 34 of file TOPCalCommonT0.h.

34 {
35 c_Default = 0,
36 c_Calibrated = 1,
37 c_Unusable = 2,
39 };
@ c_Calibrated
good calibrated value
@ c_Unusable
bad calibrated value
@ c_roughlyCalibrated
only roughly calibrated value (for HLT/expressreco)
@ c_Default
uncalibrated default value

Constructor & Destructor Documentation

◆ TOPCalCommonT0() [1/2]

TOPCalCommonT0 ( )
inline

Default constructor.

Definition at line 44 of file TOPCalCommonT0.h.

45 {}

◆ TOPCalCommonT0() [2/2]

TOPCalCommonT0 ( double  T0,
double  errT0 
)
inline

Full constructor, sets status to calibrated.

Parameters
T0common T0
errT0error on T0

Definition at line 52 of file TOPCalCommonT0.h.

52 : m_T0(T0), m_errT0(errT0), m_status(c_Calibrated)
53 {}
EStatus m_status
calibration status
float m_errT0
error on constant
float m_T0
calibration constant

Member Function Documentation

◆ getT0()

double getT0 ( ) const
inline

Returns T0.

Returns
T0

Definition at line 69 of file TOPCalCommonT0.h.

69{return m_T0;}

◆ getT0Error()

double getT0Error ( ) const
inline

Returns error on T0.

Returns
error on T0

Definition at line 75 of file TOPCalCommonT0.h.

75{return m_errT0;}

◆ isCalibrated()

bool isCalibrated ( ) const
inline

Returns calibration status.

Returns
true, if good calibrated

Definition at line 81 of file TOPCalCommonT0.h.

81{return m_status == c_Calibrated;}

◆ isDefault()

bool isDefault ( ) const
inline

Returns calibration status.

Returns
true, if default (not calibrated)

Definition at line 87 of file TOPCalCommonT0.h.

87{return m_status == c_Default;}

◆ isRoughlyCalibrated()

bool isRoughlyCalibrated ( ) const
inline

Returns calibration status.

Returns
true, if roughly calibrated

Definition at line 99 of file TOPCalCommonT0.h.

◆ isUnusable()

bool isUnusable ( ) const
inline

Returns calibration status.

Returns
true, if bad calibrated

Definition at line 93 of file TOPCalCommonT0.h.

93{return m_status == c_Unusable;}

◆ setRoughlyCalibrated()

void setRoughlyCalibrated ( )
inline

Switches calibration status to roughly calibrated (usefull at HLT/express reco)

Definition at line 63 of file TOPCalCommonT0.h.

◆ setUnusable()

void setUnusable ( )
inline

Switches calibration status to unusable to flag badly calibrated constant.

Definition at line 58 of file TOPCalCommonT0.h.

Member Data Documentation

◆ m_errT0

float m_errT0 = 0
private

error on constant

Definition at line 104 of file TOPCalCommonT0.h.

◆ m_status

EStatus m_status = c_Default
private

calibration status

Definition at line 105 of file TOPCalCommonT0.h.

◆ m_T0

float m_T0 = 0
private

calibration constant

Definition at line 103 of file TOPCalCommonT0.h.


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