List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | Private Attributes
MdADCCalibrationAG::MdADCCalibration Class Reference

Obtain the estimated number of muons with the ADC channel. More...

#include <MdADCCalibrationAG/MdADCCalibration.h>

Inheritance diagram for MdADCCalibrationAG::MdADCCalibration:
Inheritance graph
[legend]

Public Types

enum  ResultFlag { eSuccess, eFailure, eBreakLoop, eContinueLoop }
 Flag returned by module methods to the RunController. More...
 
enum  VersionInfoType {
  eFilename = 1, eRevisionNumber = 2, eDate = 3, eTime = 4,
  eLastEditor = 5
}
 Different types of version info that can be retrieved from GetVersionInfo. More...
 

Public Member Functions

VModule::ResultFlag Finish ()
 Finish: invoked at end of the run (NOT end of the event) More...
 
utl::StopwatchGetStopwatch ()
 
const utl::StopwatchGetStopwatch () const
 
std::string GetVersionInfo (const VersionInfoType v) const
 Retrieve different sorts of module version info. More...
 
VModule::ResultFlag Init ()
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
 MdADCCalibration ()
 
VModule::ResultFlag Run (evt::Event &e)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
 ~MdADCCalibration ()
 

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Protected Types

enum  InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }
 

Protected Attributes

int fInfoLevel = 0
 

Private Member Functions

void GetOfflineCalibration (double &calibrationA, double &resolutionA, double &calibrationB, double &resolutionB, mevt::Counter &counter, mevt::Module &module)
 Get calibration from XML. More...
 
void GetOnlineCalibration (double &calibrationA, double &resolutionA, double &calibrationB, double &resolutionB, mevt::Module &module)
 Get calibration histogram. More...
 
void LoadModuleCalibration (mevt::Counter &counter, mevt::Module &module)
 Obtain module calibration. More...
 
 REGISTER_MODULE ("MdADCCalibrationAG", MdADCCalibration)
 

Private Attributes

std::map< int, double > fModuleOfflineCalibrationHG
 Offline HG calibration needed for simulated data, and data with no online calibration. More...
 
std::map< int, double > fModuleOfflineCalibrationLG
 Offline LG calibration needed for simulated data, and data with no online calibration. More...
 
std::map< int, double > fModuleOfflineResolutionHG
 Offline HG single-muon resolution needed for simulated data, and data with no online calibration. More...
 
std::map< int, double > fModuleOfflineResolutionLG
 Offline LG single-muon resolution needed for simulated data, and data with no online calibration. More...
 
bool fUseOfflineCalibration
 Flag to indicate if the we should use the offline calibration, if available. More...
 
bool fUseOnlineCalibration
 Flag to indicate if the we should use the online calibration, if available. More...
 

Detailed Description

Obtain the estimated number of muons with the ADC channel.

Date
18 Jan 2020

Definition at line 22 of file MdADCCalibration.h.

Member Enumeration Documentation

enum fwk::VModule::InfoLevel
protectedinherited
Enumerator
eInfoNone 
eInfoFinal 
eInfoIntermediate 
eInfoDebug 

Definition at line 125 of file VModule.h.

enum fwk::VModule::ResultFlag
inherited

Flag returned by module methods to the RunController.

Enumerator
eSuccess 

Report success to RunController.

eFailure 

Report failure to RunController, causing RunController to terminate execution.

eBreakLoop 

Break current loop. It works for nested loops too!

eContinueLoop 

Skip remaining modules in the current loop and continue with next iteration of the loop.

Definition at line 60 of file VModule.h.

Different types of version info that can be retrieved from GetVersionInfo.

Enumerator
eFilename 
eRevisionNumber 
eDate 
eTime 
eLastEditor 

Definition at line 110 of file VModule.h.

Constructor & Destructor Documentation

MdADCCalibrationAG::MdADCCalibration::MdADCCalibration ( )
inline

Definition at line 25 of file MdADCCalibration.h.

MdADCCalibrationAG::MdADCCalibration::~MdADCCalibration ( )
inline

Definition at line 26 of file MdADCCalibration.h.

Member Function Documentation

VModule::ResultFlag MdADCCalibrationAG::MdADCCalibration::Finish ( )
virtual

Finish: invoked at end of the run (NOT end of the event)

This method is for things that should be done at the end of the run (for example, closing files or writing out histograms) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 135 of file MdADCCalibration.cc.

References io::eSuccess.

void MdADCCalibrationAG::MdADCCalibration::GetOfflineCalibration ( double &  calibrationA,
double &  resolutionA,
double &  calibrationB,
double &  resolutionB,
mevt::Counter counter,
mevt::Module module 
)
private

Get calibration from XML.

Definition at line 179 of file MdADCCalibration.cc.

References mevt::Counter::GetId(), mevt::Module::GetId(), and WARNING.

void MdADCCalibrationAG::MdADCCalibration::GetOnlineCalibration ( double &  calibrationA,
double &  resolutionA,
double &  calibrationB,
double &  resolutionB,
mevt::Module module 
)
private

Get calibration histogram.

Definition at line 220 of file MdADCCalibration.cc.

References mevt::Module::GetId().

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited
utl::Stopwatch& fwk::VModule::GetStopwatch ( )
inlineinherited

Definition at line 106 of file VModule.h.

References fwk::VModule::fStopwatch.

const utl::Stopwatch& fwk::VModule::GetStopwatch ( ) const
inlineinherited

Definition at line 107 of file VModule.h.

References fwk::VModule::fStopwatch.

std::string fwk::VModule::GetVersionInfo ( const VersionInfoType  v) const
inherited
VModule::ResultFlag MdADCCalibrationAG::MdADCCalibration::Init ( )
virtual

Initialize: invoked at beginning of run (NOT beginning of event)

This method is for things that should be done once at the beginning of a run (for example, booking histograms, performing calculations that need to be done only once, initializing parameters) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 21 of file MdADCCalibration.cc.

References RdGeoCeLDFFitter::b, io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetFirstChild(), fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), and utl::LoadConfig().

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

References fwk::VModule::fStopwatch, and utl::Stopwatch::Reset().

void MdADCCalibrationAG::MdADCCalibration::LoadModuleCalibration ( mevt::Counter counter,
mevt::Module module 
)
private
MdADCCalibrationAG::MdADCCalibration::REGISTER_MODULE ( "MdADCCalibrationAG"  ,
MdADCCalibration   
)
private
VModule::ResultFlag MdADCCalibrationAG::MdADCCalibration::Run ( evt::Event event)
virtual

Run: invoked once per event.

This method is for things that should be done once per event {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 76 of file MdADCCalibration.cc.

References mevt::MEvent::CountersBegin(), mevt::MEvent::CountersEnd(), DEBUGLOG, io::eSuccess, mevt::Counter::GetId(), mevt::Module::GetId(), mevt::Module::GetRejectionReason(), evt::Event::HasMEvent(), INFO, mevt::Counter::IsRejected(), mevt::Module::IsRejected(), mevt::Counter::ModulesBegin(), mevt::Counter::ModulesEnd(), and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

int fwk::VModule::fInfoLevel = 0
protectedinherited
std::map<int, double> MdADCCalibrationAG::MdADCCalibration::fModuleOfflineCalibrationHG
private

Offline HG calibration needed for simulated data, and data with no online calibration.

Definition at line 68 of file MdADCCalibration.h.

std::map<int, double> MdADCCalibrationAG::MdADCCalibration::fModuleOfflineCalibrationLG
private

Offline LG calibration needed for simulated data, and data with no online calibration.

Definition at line 63 of file MdADCCalibration.h.

std::map<int, double> MdADCCalibrationAG::MdADCCalibration::fModuleOfflineResolutionHG
private

Offline HG single-muon resolution needed for simulated data, and data with no online calibration.

Definition at line 78 of file MdADCCalibration.h.

std::map<int, double> MdADCCalibrationAG::MdADCCalibration::fModuleOfflineResolutionLG
private

Offline LG single-muon resolution needed for simulated data, and data with no online calibration.

Definition at line 73 of file MdADCCalibration.h.

bool MdADCCalibrationAG::MdADCCalibration::fUseOfflineCalibration
private

Flag to indicate if the we should use the offline calibration, if available.

Definition at line 53 of file MdADCCalibration.h.

bool MdADCCalibrationAG::MdADCCalibration::fUseOnlineCalibration
private

Flag to indicate if the we should use the online calibration, if available.

Definition at line 58 of file MdADCCalibration.h.


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

, generated on Tue Sep 26 2023.