ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RawTowerCalibration Class Reference

#include <coresoftware/blob/master/offline/packages/CaloReco/RawTowerCalibration.h>

+ Inheritance diagram for RawTowerCalibration:
+ Collaboration diagram for RawTowerCalibration:

Public Types

enum  enu_calib_algorithm { kNo_calibration = 0, kSimple_linear_calibration = 1, kTower_by_tower_calibration = 2 }
 

Public Member Functions

 RawTowerCalibration (const std::string &name="RawTowerCalibration")
 
 ~RawTowerCalibration () override
 
int InitRun (PHCompositeNode *topNode) override
 
int process_event (PHCompositeNode *topNode) override
 
int End (PHCompositeNode *topNode) override
 Called at the end of all processing.
 
void Detector (const std::string &d)
 
void TowerType (const int type)
 
enu_calib_algorithm get_calib_algorithm () const
 
void set_calib_algorithm (enu_calib_algorithm calibAlgorithm)
 
double get_calib_const_GeV_ADC () const
 
void set_calib_const_GeV_ADC (double calibConstGeVAdc)
 
void set_variable_GeV_ADC (const bool value)
 
std::string get_calib_tower_node_prefix () const
 
void set_calib_tower_node_prefix (const std::string &calibTowerNodePrefix)
 
double get_pedstal_ADC () const
 
void set_pedstal_ADC (double pedstalAdc)
 
void set_variable_pedestal (const bool value)
 
std::string get_raw_tower_node_prefix () const
 
void set_raw_tower_node_prefix (const std::string &rawTowerNodePrefix)
 
void set_zero_suppression_GeV (double)
 
PHParametersGetCalibrationParameters ()
 Get the parameters for update. Useful fields are listed in SetDefaultParameters();.
 
- Public Member Functions inherited from SubsysReco
 ~SubsysReco () override
 
virtual int EndRun (const int)
 Called at the end of each run.
 
virtual int Init (PHCompositeNode *)
 
virtual int Reset (PHCompositeNode *)
 Reset.
 
virtual int ResetEvent (PHCompositeNode *)
 Clean up after each event.
 
void Print (const std::string &="ALL") const override
 
- Public Member Functions inherited from Fun4AllBase
virtual ~Fun4AllBase ()
 
virtual const std::string Name () const
 Returns the name of this module.
 
virtual void Name (const std::string &name)
 Sets the name of this module.
 
virtual void Verbosity (const int ival)
 Sets the verbosity of this module (0 by default=quiet).
 
virtual void Verbosity (enu_Verbosity ival)
 Sets the verbosity of this module (0 by default=quiet).
 
virtual int Verbosity () const
 Gets the verbosity of this module.
 

Protected Member Functions

void CreateNodes (PHCompositeNode *topNode)
 
- Protected Member Functions inherited from SubsysReco
 SubsysReco (const std::string &name="NONAME")
 
- Protected Member Functions inherited from Fun4AllBase
 Fun4AllBase (const std::string &name="NONAME")
 

Protected Attributes

enu_calib_algorithm _calib_algorithm
 
RawTowerContainer_calib_towers
 
RawTowerContainer_raw_towers
 
RawTowerGeomContainerrawtowergeom
 
std::string detector
 
std::string RawTowerNodeName
 
std::string CaliTowerNodeName
 
std::string TowerGeomNodeName
 
std::string _calib_tower_node_prefix
 
std::string _raw_tower_node_prefix
 
double _pedstal_ADC
 pedstal in unit of ADC
 
bool _pedestal_file
 pedestal from file
 
double _calib_const_GeV_ADC
 calibration constant in unit of GeV per ADC
 
bool _GeV_ADC_file
 GeV per ADC from file.
 
int _tower_type
 tower type to act on
 
PHParameters _tower_calib_params
 Tower by tower calibration parameters.
 

Detailed Description

calibrate ADC value to measured energy deposition in calorimeter towers default input DST node is TOWER_RAW_DETECTOR default output DST node is TOWER_CALIB_DETECTOR

Definition at line 18 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 18 of file RawTowerCalibration.h

Member Enumeration Documentation

Enumerator:
kNo_calibration 

directly pass the energy of raw tower to calibrated tower. Zero suppression is applied

kSimple_linear_calibration 

simple calibration with pedstal subtraction and a global energy scale (sampling fraction) correction

kTower_by_tower_calibration 

input calibration file for tower by tower calibration. Use GetCalibrationParameters() to set the calibration parameters

Definition at line 41 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 41 of file RawTowerCalibration.h

Constructor & Destructor Documentation

RawTowerCalibration::RawTowerCalibration ( const std::string &  name = "RawTowerCalibration")

Definition at line 35 of file RawTowerCalibration.cc.

View newest version in sPHENIX GitHub at line 35 of file RawTowerCalibration.cc

RawTowerCalibration::~RawTowerCalibration ( )
inlineoverride

Definition at line 22 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 22 of file RawTowerCalibration.h

Member Function Documentation

void RawTowerCalibration::CreateNodes ( PHCompositeNode topNode)
protected

Definition at line 217 of file RawTowerCalibration.cc.

View newest version in sPHENIX GitHub at line 217 of file RawTowerCalibration.cc

References _calib_tower_node_prefix, _calib_towers, _raw_tower_node_prefix, _raw_towers, CaliTowerNodeName, detector, PHNodeIterator::findFirst(), RawTowerContainer::getCalorimeterID(), RawTowerGeomContainer::identify(), Fun4AllBase::Name(), rawtowergeom, RawTowerNodeName, TowerGeomNodeName, and Fun4AllBase::Verbosity().

Referenced by InitRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void RawTowerCalibration::Detector ( const std::string &  d)
inline

Definition at line 30 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 30 of file RawTowerCalibration.h

References _tower_calib_params, d, detector, and PHParameters::set_name().

Referenced by B0ECAL_Towers(), BECAL_Towers(), BWD_Towers(), CEMC_Towers(), DRCALO_Towers(), EEMC_Towers(), EEMCH_Towers(), EHCAL_Towers(), FEMC_Towers(), FHCAL_Towers(), HCALInner_Towers(), HCALOuter_Towers(), and LFHCAL_Towers().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int RawTowerCalibration::End ( PHCompositeNode )
overridevirtual

Called at the end of all processing.

Reimplemented from SubsysReco.

Definition at line 212 of file RawTowerCalibration.cc.

View newest version in sPHENIX GitHub at line 212 of file RawTowerCalibration.cc

References Fun4AllReturnCodes::EVENT_OK.

enu_calib_algorithm RawTowerCalibration::get_calib_algorithm ( ) const
inline

Definition at line 54 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 54 of file RawTowerCalibration.h

References _calib_algorithm.

double RawTowerCalibration::get_calib_const_GeV_ADC ( ) const
inline

Definition at line 66 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 66 of file RawTowerCalibration.h

References _calib_const_GeV_ADC.

std::string RawTowerCalibration::get_calib_tower_node_prefix ( ) const
inline

Definition at line 84 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 84 of file RawTowerCalibration.h

References _calib_tower_node_prefix.

double RawTowerCalibration::get_pedstal_ADC ( ) const
inline

Definition at line 96 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 96 of file RawTowerCalibration.h

References _pedstal_ADC.

std::string RawTowerCalibration::get_raw_tower_node_prefix ( ) const
inline

Definition at line 114 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 114 of file RawTowerCalibration.h

References _raw_tower_node_prefix.

PHParameters& RawTowerCalibration::GetCalibrationParameters ( )
inline

Get the parameters for update. Useful fields are listed in SetDefaultParameters();.

Definition at line 135 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 135 of file RawTowerCalibration.h

References _tower_calib_params.

Referenced by CEMC_Towers().

+ Here is the caller graph for this function:

int RawTowerCalibration::InitRun ( PHCompositeNode )
overridevirtual

Called for first event when run number is known. Typically this is where you may want to fetch data from database, because you know the run number.

Reimplemented from SubsysReco.

Definition at line 65 of file RawTowerCalibration.cc.

View newest version in sPHENIX GitHub at line 65 of file RawTowerCalibration.cc

References Fun4AllReturnCodes::ABORTRUN, CreateNodes(), detector, e, Fun4AllReturnCodes::EVENT_OK, g4zmq::exit(), PHNodeIterator::findFirst(), and Fun4AllBase::Name().

+ Here is the call graph for this function:

void RawTowerCalibration::set_calib_algorithm ( enu_calib_algorithm  calibAlgorithm)
inline

Definition at line 60 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 60 of file RawTowerCalibration.h

References _calib_algorithm.

Referenced by B0ECAL_Towers(), BECAL_Towers(), BWD_Towers(), CEMC_Towers(), DRCALO_Towers(), EEMC_Towers(), EEMCH_Towers(), EHCAL_Towers(), FEMC_Towers(), FHCAL_Towers(), HCALInner_Towers(), HCALOuter_Towers(), and LFHCAL_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::set_calib_const_GeV_ADC ( double  calibConstGeVAdc)
inline

Definition at line 72 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 72 of file RawTowerCalibration.h

References _calib_const_GeV_ADC.

Referenced by B0ECAL_Towers(), BECAL_Towers(), BWD_Towers(), CEMC_Towers(), DRCALO_Towers(), EEMC_Towers(), EEMCH_Towers(), EHCAL_Towers(), FEMC_Towers(), FHCAL_Towers(), HCALInner_Towers(), HCALOuter_Towers(), and LFHCAL_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::set_calib_tower_node_prefix ( const std::string &  calibTowerNodePrefix)
inline

Definition at line 90 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 90 of file RawTowerCalibration.h

References _calib_tower_node_prefix.

void RawTowerCalibration::set_pedstal_ADC ( double  pedstalAdc)
inline

Definition at line 102 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 102 of file RawTowerCalibration.h

References _pedstal_ADC.

Referenced by B0ECAL_Towers(), BECAL_Towers(), BWD_Towers(), CEMC_Towers(), DRCALO_Towers(), EEMC_Towers(), EEMCH_Towers(), EHCAL_Towers(), FEMC_Towers(), FHCAL_Towers(), HCALInner_Towers(), HCALOuter_Towers(), and LFHCAL_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::set_raw_tower_node_prefix ( const std::string &  rawTowerNodePrefix)
inline

Definition at line 120 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 120 of file RawTowerCalibration.h

References _raw_tower_node_prefix.

Referenced by EHCAL_Towers(), and FHCAL_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::set_variable_GeV_ADC ( const bool  value)
inline

Definition at line 78 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 78 of file RawTowerCalibration.h

References _GeV_ADC_file.

Referenced by CEMC_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::set_variable_pedestal ( const bool  value)
inline

Definition at line 108 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 108 of file RawTowerCalibration.h

References _pedestal_file.

Referenced by CEMC_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::set_zero_suppression_GeV ( double  )
inline

Definition at line 126 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 126 of file RawTowerCalibration.h

Referenced by EHCAL_Towers(), and FHCAL_Towers().

+ Here is the caller graph for this function:

void RawTowerCalibration::TowerType ( const int  type)
inline

Definition at line 36 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 36 of file RawTowerCalibration.h

References _tower_type.

Referenced by FEMC_Towers().

+ Here is the caller graph for this function:

Member Data Documentation

enu_calib_algorithm RawTowerCalibration::_calib_algorithm
protected

Definition at line 144 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 144 of file RawTowerCalibration.h

Referenced by get_calib_algorithm(), process_event(), and set_calib_algorithm().

double RawTowerCalibration::_calib_const_GeV_ADC
protected

calibration constant in unit of GeV per ADC

Definition at line 165 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 165 of file RawTowerCalibration.h

Referenced by get_calib_const_GeV_ADC(), process_event(), and set_calib_const_GeV_ADC().

std::string RawTowerCalibration::_calib_tower_node_prefix
protected

Definition at line 155 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 155 of file RawTowerCalibration.h

Referenced by CreateNodes(), get_calib_tower_node_prefix(), and set_calib_tower_node_prefix().

RawTowerContainer* RawTowerCalibration::_calib_towers
protected

Definition at line 146 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 146 of file RawTowerCalibration.h

Referenced by CreateNodes(), and process_event().

bool RawTowerCalibration::_GeV_ADC_file
protected

GeV per ADC from file.

Definition at line 168 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 168 of file RawTowerCalibration.h

Referenced by process_event(), and set_variable_GeV_ADC().

bool RawTowerCalibration::_pedestal_file
protected

pedestal from file

Definition at line 162 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 162 of file RawTowerCalibration.h

Referenced by process_event(), and set_variable_pedestal().

double RawTowerCalibration::_pedstal_ADC
protected

pedstal in unit of ADC

Definition at line 159 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 159 of file RawTowerCalibration.h

Referenced by get_pedstal_ADC(), process_event(), and set_pedstal_ADC().

std::string RawTowerCalibration::_raw_tower_node_prefix
protected

Definition at line 156 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 156 of file RawTowerCalibration.h

Referenced by CreateNodes(), get_raw_tower_node_prefix(), and set_raw_tower_node_prefix().

RawTowerContainer* RawTowerCalibration::_raw_towers
protected

Definition at line 147 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 147 of file RawTowerCalibration.h

Referenced by CreateNodes(), and process_event().

PHParameters RawTowerCalibration::_tower_calib_params
protected

Tower by tower calibration parameters.

Definition at line 174 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 174 of file RawTowerCalibration.h

Referenced by Detector(), GetCalibrationParameters(), and process_event().

int RawTowerCalibration::_tower_type
protected

tower type to act on

Definition at line 171 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 171 of file RawTowerCalibration.h

Referenced by process_event(), and TowerType().

std::string RawTowerCalibration::CaliTowerNodeName
protected

Definition at line 152 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 152 of file RawTowerCalibration.h

Referenced by CreateNodes().

std::string RawTowerCalibration::detector
protected

Definition at line 150 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 150 of file RawTowerCalibration.h

Referenced by CreateNodes(), Detector(), InitRun(), and process_event().

RawTowerGeomContainer* RawTowerCalibration::rawtowergeom
protected

Definition at line 148 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 148 of file RawTowerCalibration.h

Referenced by CreateNodes(), and process_event().

std::string RawTowerCalibration::RawTowerNodeName
protected

Definition at line 151 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 151 of file RawTowerCalibration.h

Referenced by CreateNodes().

std::string RawTowerCalibration::TowerGeomNodeName
protected

Definition at line 153 of file RawTowerCalibration.h.

View newest version in sPHENIX GitHub at line 153 of file RawTowerCalibration.h

Referenced by CreateNodes().


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