EventT0DQMModule Class Reference

This module to design collect the event t0 values base on different detectors and physics processes. More...

#include <EventT0DQM.h>

Inheritance diagram for EventT0DQMModule:

Public Types
enum	EModulePropFlags {   c_Input = 1 ,   c_Output = 2 ,   c_ParallelProcessingCertified = 4 ,   c_HistogramManager = 8 ,   c_InternalSerializer = 16 ,   c_TerminateInAllProcesses = 32 ,   c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...
typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	EventT0DQMModule ()
	Default constructor.
virtual	~EventT0DQMModule ()
	Destructor.
virtual void	defineHisto () override
	Defination of histograms.
virtual void	initialize () override
	Initialize the module.
virtual void	beginRun () override
	This method is called for each run.
virtual void	event () override
	This method is called for each event.
virtual void	endRun () override
	Function to process end_run record.
virtual void	terminate () override
	Function to terminate module.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
void	fillHistogram (TH1D *hist, const bool hasAnyT0, const bool hasECLT0, const bool hasSVDT0, const bool hasCDCHitT0, const bool hasCDCGridT0, const bool hasTOPT0)
	Fill fraction histogram with values.
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
StoreObjPtr< TRGSummary >	m_objTrgSummary
	Trigger Summary data object.
StoreObjPtr< SoftwareTriggerResult >	m_TrgResult
	Store array for Trigger selection.
StoreObjPtr< EventT0 >	m_eventT0
	Store array for event t0.
TH1F *	m_histEventT0_ECL_bhabha_L1_ECLTRG {nullptr}
	event t0 histogram for ECL, HLT bha bha events, L1 time by ECL trigger
TH1F *	m_histEventT0_CDC_bhabha_L1_ECLTRG {nullptr}
	event t0 histogram for CDC, HLT bha bha events, L1 time by ECL trigger
TH1F *	m_histEventT0_TOP_bhabha_L1_ECLTRG {nullptr}
	event t0 histogram for TOP, HLT bha bha events, L1 time by ECL trigger
TH1F *	m_histEventT0_SVD_bhabha_L1_ECLTRG {nullptr}
	event t0 histogram for SVD, HLT bha bha events, L1 time by ECL trigger
TH1F *	m_histEventT0_ECL_hadron_L1_ECLTRG {nullptr}
	event t0 histogram for ECL, HLT hadronic events, L1 time by ECL trigger
TH1F *	m_histEventT0_CDC_hadron_L1_ECLTRG {nullptr}
	event t0 histogram for CDC, HLT hadronic events, L1 time by ECL trigger
TH1F *	m_histEventT0_TOP_hadron_L1_ECLTRG {nullptr}
	event t0 histogram for TOP, HLT hadronic events, L1 time by ECL trigger
TH1F *	m_histEventT0_SVD_hadron_L1_ECLTRG {nullptr}
	event t0 histogram for SVD, HLT hadronic events, L1 time by ECL trigger
TH1F *	m_histEventT0_ECL_mumu_L1_ECLTRG {nullptr}
	event t0 histogram for ECL, HLT mu mu events, L1 time by ECL trigger
TH1F *	m_histEventT0_CDC_mumu_L1_ECLTRG {nullptr}
	event t0 histogram for CDC, HLT mu mu events, L1 time by ECL trigger
TH1F *	m_histEventT0_TOP_mumu_L1_ECLTRG {nullptr}
	event t0 histogram for TOP, HLT mu mu events, L1 time by ECL trigger
TH1F *	m_histEventT0_SVD_mumu_L1_ECLTRG {nullptr}
	event t0 histogram for SVD, HLT mu mu events, L1 time by ECL trigger
TH1F *	m_histEventT0_ECL_bhabha_L1_CDCTRG {nullptr}
	event t0 histogram for ECL, HLT bha bha events, L1 time by CDC trigger
TH1F *	m_histEventT0_CDC_bhabha_L1_CDCTRG {nullptr}
	event t0 histogram for CDC, HLT bha bha events, L1 time by CDC trigger
TH1F *	m_histEventT0_TOP_bhabha_L1_CDCTRG {nullptr}
	event t0 histogram for TOP, HLT bha bha events, L1 time by CDC trigger
TH1F *	m_histEventT0_SVD_bhabha_L1_CDCTRG {nullptr}
	event t0 histogram for SVD, HLT bha bha events, L1 time by CDC trigger
TH1F *	m_histEventT0_ECL_hadron_L1_CDCTRG {nullptr}
	event t0 histogram for ECL, HLT hadronic events, L1 time by CDC trigger
TH1F *	m_histEventT0_CDC_hadron_L1_CDCTRG {nullptr}
	event t0 histogram for CDC, HLT hadronic events, L1 time by CDC trigger
TH1F *	m_histEventT0_TOP_hadron_L1_CDCTRG {nullptr}
	event t0 histogram for TOP, HLT hadronic events, L1 time by CDC trigger
TH1F *	m_histEventT0_SVD_hadron_L1_CDCTRG {nullptr}
	event t0 histogram for SVD, HLT hadronic events, L1 time by CDC trigger
TH1F *	m_histEventT0_ECL_mumu_L1_CDCTRG {nullptr}
	event t0 histogram for ECL, HLT mu mu events, L1 time by CDC trigger
TH1F *	m_histEventT0_CDC_mumu_L1_CDCTRG {nullptr}
	event t0 histogram for CDC, HLT mu mu events, L1 time by CDC trigger
TH1F *	m_histEventT0_TOP_mumu_L1_CDCTRG {nullptr}
	event t0 histogram for TOP, HLT mu mu events, L1 time by CDC trigger
TH1F *	m_histEventT0_SVD_mumu_L1_CDCTRG {nullptr}
	event t0 histogram for SVD, HLT mu mu events, L1 time by CDC trigger
TH1F *	m_histEventT0_ECL_bhabha_L1_TOPTRG {nullptr}
	event t0 histogram for ECL, HLT bha bha events, L1 time by TOP trigger
TH1F *	m_histEventT0_CDC_bhabha_L1_TOPTRG {nullptr}
	event t0 histogram for CDC, HLT bha bha events, L1 time by TOP trigger
TH1F *	m_histEventT0_TOP_bhabha_L1_TOPTRG {nullptr}
	event t0 histogram for TOP, HLT bha bha events, L1 time by TOP trigger
TH1F *	m_histEventT0_SVD_bhabha_L1_TOPTRG {nullptr}
	event t0 histogram for SVD, HLT bha bha events, L1 time by TOP trigger
TH1F *	m_histEventT0_ECL_hadron_L1_TOPTRG {nullptr}
	event t0 histogram for ECL, HLT hadronic events, L1 time by TOP trigger
TH1F *	m_histEventT0_CDC_hadron_L1_TOPTRG {nullptr}
	event t0 histogram for CDC, HLT hadronic events, L1 time by TOP trigger
TH1F *	m_histEventT0_TOP_hadron_L1_TOPTRG {nullptr}
	event t0 histogram for TOP, HLT hadronic events, L1 time by TOP trigger
TH1F *	m_histEventT0_SVD_hadron_L1_TOPTRG {nullptr}
	event t0 histogram for SVD, HLT hadronic events, L1 time by TOP trigger
TH1F *	m_histEventT0_ECL_mumu_L1_TOPTRG {nullptr}
	event t0 histogram for ECL, HLT mu mu events, L1 time by TOP trigger
TH1F *	m_histEventT0_CDC_mumu_L1_TOPTRG {nullptr}
	event t0 histogram for CDC, HLT mu mu events, L1 time by TOP trigger
TH1F *	m_histEventT0_TOP_mumu_L1_TOPTRG {nullptr}
	event t0 histogram for TOP, HLT mu mu events, L1 time by TOP trigger
TH1F *	m_histEventT0_SVD_mumu_L1_TOPTRG {nullptr}
	event t0 histogram for SVD, HLT mu mu events, L1 time by TOP trigger
const char *	c_eventT0Algorithms [6] = {"ECL", "SVD", "CDC hit based", "CDC full grid #chi^{2}", "TOP", "Any"}
	EventT0 algorithms for which to calculate fractions of abundance.
TH1D *	m_histAlgorithmSourceFractionsHadronL1ECLTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT hadronic events, L1 time by ECL trigger.
TH1D *	m_histAlgorithmSourceFractionsHadronL1CDCTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT hadronic events, L1 time by CDC trigger.
TH1D *	m_histAlgorithmSourceFractionsHadronL1TOPTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT hadronic events, L1 time by TOP trigger.
TH1D *	m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT bhabha events, L1 time by ECL trigger.
TH1D *	m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT bhabha events, L1 time by CDC trigger.
TH1D *	m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT bhabha events, L1 time by TOP trigger.
TH1D *	m_histAlgorithmSourceFractionsMuMuL1ECLTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT mumu events, L1 time by ECL trigger.
TH1D *	m_histAlgorithmSourceFractionsMuMuL1CDCTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT mumu events, L1 time by CDC trigger.
TH1D *	m_histAlgorithmSourceFractionsMuMuL1TOPTRG {nullptr}
	Fraction of events with EventT0 from a given algorithm, HLT mumu events, L1 time by TOP trigger.
std::string	m_name
	The name of the module, saved as a string (user-modifiable)
std::string	m_type
	The type of the module, saved as a string.
std::string	m_package
	Package this module is found in (may be empty).
std::string	m_description
	The description of the module.
unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with |) of EModulePropFlags.
LogConfig	m_logConfig
	The log system configuration of the module.
ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.
bool	m_hasReturnValue
	True, if the return value is set.
int	m_returnValue
	The return value.
std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

This module to design collect the event t0 values base on different detectors and physics processes.

Definition at line 33 of file EventT0DQM.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

EventT0DQMModule()

EventT0DQMModule

(

)

Default constructor.

Definition at line 17 of file EventT0DQM.cc.

                                  : HistoModule()
{
  setPropertyFlags(c_ParallelProcessingCertified); // parallel processing
  setDescription("Make data quality monitoring plots for EventT0 for bhabha, mu mu, and hadron samples for different trigger (time) sources.");
}

~EventT0DQMModule()

~EventT0DQMModule ( )

virtual

Destructor.

Definition at line 24 of file EventT0DQM.cc.

{ }

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

This method is called for each run.

Reimplemented from HistoModule.

Definition at line 225 of file EventT0DQM.cc.

{
  if (!m_eventT0.isValid()) {
    B2WARNING("Missing EventT0, EventT0DQM is skipped.");
    return;
  }
 
  if (!m_TrgResult.isValid()) {
    B2WARNING("Missing SoftwareTriggerResult, EventT0DQM is skipped.");
    return;
  }
 
  m_histEventT0_ECL_bhabha_L1_ECLTRG->Reset();
  m_histEventT0_CDC_bhabha_L1_ECLTRG->Reset();
  m_histEventT0_TOP_bhabha_L1_ECLTRG->Reset();
  m_histEventT0_SVD_bhabha_L1_ECLTRG->Reset();
 
  m_histEventT0_ECL_hadron_L1_ECLTRG->Reset();
  m_histEventT0_CDC_hadron_L1_ECLTRG->Reset();
  m_histEventT0_TOP_hadron_L1_ECLTRG->Reset();
  m_histEventT0_SVD_hadron_L1_ECLTRG->Reset();
 
  m_histEventT0_ECL_mumu_L1_ECLTRG->Reset();
  m_histEventT0_CDC_mumu_L1_ECLTRG->Reset();
  m_histEventT0_TOP_mumu_L1_ECLTRG->Reset();
  m_histEventT0_SVD_mumu_L1_ECLTRG->Reset();
 
  m_histEventT0_ECL_bhabha_L1_CDCTRG->Reset();
  m_histEventT0_CDC_bhabha_L1_CDCTRG->Reset();
  m_histEventT0_TOP_bhabha_L1_CDCTRG->Reset();
  m_histEventT0_SVD_bhabha_L1_CDCTRG->Reset();
 
  m_histEventT0_ECL_hadron_L1_CDCTRG->Reset();
  m_histEventT0_CDC_hadron_L1_CDCTRG->Reset();
  m_histEventT0_TOP_hadron_L1_CDCTRG->Reset();
  m_histEventT0_SVD_hadron_L1_CDCTRG->Reset();
 
  m_histEventT0_ECL_mumu_L1_CDCTRG->Reset();
  m_histEventT0_CDC_mumu_L1_CDCTRG->Reset();
  m_histEventT0_TOP_mumu_L1_CDCTRG->Reset();
  m_histEventT0_SVD_mumu_L1_CDCTRG->Reset();
 
  m_histEventT0_ECL_bhabha_L1_TOPTRG->Reset();
  m_histEventT0_CDC_bhabha_L1_TOPTRG->Reset();
  m_histEventT0_TOP_bhabha_L1_TOPTRG->Reset();
  m_histEventT0_SVD_bhabha_L1_TOPTRG->Reset();
 
  m_histEventT0_ECL_hadron_L1_TOPTRG->Reset();
  m_histEventT0_CDC_hadron_L1_TOPTRG->Reset();
  m_histEventT0_TOP_hadron_L1_TOPTRG->Reset();
  m_histEventT0_SVD_hadron_L1_TOPTRG->Reset();
 
  m_histEventT0_ECL_mumu_L1_TOPTRG->Reset();
  m_histEventT0_CDC_mumu_L1_TOPTRG->Reset();
  m_histEventT0_TOP_mumu_L1_TOPTRG->Reset();
  m_histEventT0_SVD_mumu_L1_TOPTRG->Reset();
 
  m_histAlgorithmSourceFractionsHadronL1ECLTRG->Reset();
  m_histAlgorithmSourceFractionsHadronL1CDCTRG->Reset();
  m_histAlgorithmSourceFractionsHadronL1TOPTRG->Reset();
  m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG->Reset();
  m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG->Reset();
  m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG->Reset();
  m_histAlgorithmSourceFractionsMuMuL1ECLTRG->Reset();
  m_histAlgorithmSourceFractionsMuMuL1CDCTRG->Reset();
  m_histAlgorithmSourceFractionsMuMuL1TOPTRG->Reset();
 
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

defineHisto()

void defineHisto ( )

overridevirtual

Defination of histograms.

Reimplemented from HistoModule.

Definition at line 28 of file EventT0DQM.cc.

{
 
  TDirectory* oldDir = gDirectory;
  oldDir->mkdir("EventT0")->cd();
 
  int nBins = 400 ;
  double minT0 = -100 ;
  double maxT0 =  100 ;
 
  m_histEventT0_ECL_bhabha_L1_ECLTRG = new TH1F("m_histEventT0_ECL_bhabha_L1_ECLTRG",
                                                "ECL EventT0, L1TRG from ECL, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_bhabha_L1_ECLTRG = new TH1F("m_histEventT0_CDC_bhabha_L1_ECLTRG",
                                                "CDC EventT0, L1TRG from ECL, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_bhabha_L1_ECLTRG = new TH1F("m_histEventT0_TOP_bhabha_L1_ECLTRG",
                                                "TOP EventT0, L1TRG from ECL, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_bhabha_L1_ECLTRG = new TH1F("m_histEventT0_SVD_bhabha_L1_ECLTRG",
                                                "SVD EventT0, L1TRG from ECL, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histEventT0_ECL_hadron_L1_ECLTRG = new TH1F("m_histEventT0_ECL_hadron_L1_ECLTRG",
                                                "ECL EventT0, L1TRG from ECL, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_hadron_L1_ECLTRG = new TH1F("m_histEventT0_CDC_hadron_L1_ECLTRG",
                                                "CDC EventT0, L1TRG from ECL, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_hadron_L1_ECLTRG = new TH1F("m_histEventT0_TOP_hadron_L1_ECLTRG",
                                                "TOP EventT0, L1TRG from ECL, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_hadron_L1_ECLTRG = new TH1F("m_histEventT0_SVD_hadron_L1_ECLTRG",
                                                "SVD EventT0, L1TRG from ECL, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histEventT0_ECL_mumu_L1_ECLTRG   = new TH1F("m_histEventT0_ECL_mumu_L1_ECLTRG",
                                                "ECL EventT0, L1TRG from ECL, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_mumu_L1_ECLTRG   = new TH1F("m_histEventT0_CDC_mumu_L1_ECLTRG",
                                                "CDC EventT0, L1TRG from ECL, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_mumu_L1_ECLTRG   = new TH1F("m_histEventT0_TOP_mumu_L1_ECLTRG",
                                                "TOP EventT0, L1TRG from ECL, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_mumu_L1_ECLTRG   = new TH1F("m_histEventT0_SVD_mumu_L1_ECLTRG",
                                                "SVD EventT0, L1TRG from ECL, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
 
  m_histEventT0_ECL_bhabha_L1_CDCTRG = new TH1F("m_histEventT0_ECL_bhabha_L1_CDCTRG",
                                                "ECL EventT0, L1TRG from CDC, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_bhabha_L1_CDCTRG = new TH1F("m_histEventT0_CDC_bhabha_L1_CDCTRG",
                                                "CDC EventT0, L1TRG from CDC, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_bhabha_L1_CDCTRG = new TH1F("m_histEventT0_TOP_bhabha_L1_CDCTRG",
                                                "TOP EventT0, L1TRG from CDC, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_bhabha_L1_CDCTRG = new TH1F("m_histEventT0_SVD_bhabha_L1_CDCTRG",
                                                "SVD EventT0, L1TRG from CDC, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histEventT0_ECL_hadron_L1_CDCTRG = new TH1F("m_histEventT0_ECL_hadron_L1_CDCTRG",
                                                "ECL EventT0, L1TRG from CDC, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_hadron_L1_CDCTRG = new TH1F("m_histEventT0_CDC_hadron_L1_CDCTRG",
                                                "CDC EventT0, L1TRG from CDC, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_hadron_L1_CDCTRG = new TH1F("m_histEventT0_TOP_hadron_L1_CDCTRG",
                                                "TOP EventT0, L1TRG from CDC, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_hadron_L1_CDCTRG = new TH1F("m_histEventT0_SVD_hadron_L1_CDCTRG",
                                                "SVD EventT0, L1TRG from CDC, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histEventT0_ECL_mumu_L1_CDCTRG   = new TH1F("m_histEventT0_ECL_mumu_L1_CDCTRG",
                                                "ECL EventT0, L1TRG from CDC, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_mumu_L1_CDCTRG   = new TH1F("m_histEventT0_CDC_mumu_L1_CDCTRG",
                                                "CDC EventT0, L1TRG from CDC, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_mumu_L1_CDCTRG   = new TH1F("m_histEventT0_TOP_mumu_L1_CDCTRG",
                                                "TOP EventT0, L1TRG from CDC, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_mumu_L1_CDCTRG   = new TH1F("m_histEventT0_SVD_mumu_L1_CDCTRG",
                                                "SVD EventT0, L1TRG from CDC, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
 
  m_histEventT0_ECL_bhabha_L1_TOPTRG = new TH1F("m_histEventT0_ECL_bhabha_L1_TOPTRG",
                                                "ECL EventT0, L1TRG from TOP, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_bhabha_L1_TOPTRG = new TH1F("m_histEventT0_CDC_bhabha_L1_TOPTRG",
                                                "CDC EventT0, L1TRG from TOP, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_bhabha_L1_TOPTRG = new TH1F("m_histEventT0_TOP_bhabha_L1_TOPTRG",
                                                "TOP EventT0, L1TRG from TOP, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_bhabha_L1_TOPTRG = new TH1F("m_histEventT0_SVD_bhabha_L1_TOPTRG",
                                                "SVD EventT0, L1TRG from TOP, HLT Bhabha;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histEventT0_ECL_hadron_L1_TOPTRG = new TH1F("m_histEventT0_ECL_hadron_L1_TOPTRG",
                                                "ECL EventT0, L1TRG from TOP, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_hadron_L1_TOPTRG = new TH1F("m_histEventT0_CDC_hadron_L1_TOPTRG",
                                                "CDC EventT0, L1TRG from TOP, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_hadron_L1_TOPTRG = new TH1F("m_histEventT0_TOP_hadron_L1_TOPTRG",
                                                "TOP EventT0, L1TRG from TOP, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_hadron_L1_TOPTRG = new TH1F("m_histEventT0_SVD_hadron_L1_TOPTRG",
                                                "SVD EventT0, L1TRG from TOP, HLT Hadron;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histEventT0_ECL_mumu_L1_TOPTRG   = new TH1F("m_histEventT0_ECL_mumu_L1_TOPTRG",
                                                "ECL EventT0, L1TRG from TOP, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_CDC_mumu_L1_TOPTRG   = new TH1F("m_histEventT0_CDC_mumu_L1_TOPTRG",
                                                "CDC EventT0, L1TRG from TOP, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_TOP_mumu_L1_TOPTRG   = new TH1F("m_histEventT0_TOP_mumu_L1_TOPTRG",
                                                "TOP EventT0, L1TRG from TOP, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
  m_histEventT0_SVD_mumu_L1_TOPTRG   = new TH1F("m_histEventT0_SVD_mumu_L1_TOPTRG",
                                                "SVD EventT0, L1TRG from TOP, HLT mumu;EventT0 [ns];events / 0.5 ns",
                                                nBins, minT0, maxT0);
 
  m_histAlgorithmSourceFractionsHadronL1ECLTRG =
    new TH1D("AlgorithmSourceFractionsHadronL1ECLTRG",
             "Fraction of events with EventT0 from each algorithm for hadronic events triggerd by ECL;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsHadronL1CDCTRG =
    new TH1D("AlgorithmSourceFractionsHadronL1CDCTRG",
             "Fraction of events with EventT0 from each algorithm for hadronic events triggerd by CDC;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsHadronL1TOPTRG =
    new TH1D("AlgorithmSourceFractionsHadronL1TOPTRG",
             "Fraction of events with EventT0 from each algorithm for hadronic events triggerd by TOP;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG =
    new TH1D("AlgorithmSourceFractionsBhaBhaL1ECLTRG",
             "Fraction of events with EventT0 from each algorithm for Bhabha events triggerd by ECL;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG =
    new TH1D("AlgorithmSourceFractionsBhaBhaL1CDCTRG",
             "Fraction of events with EventT0 from each algorithm for Bhabha events triggerd by CDC;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG =
    new TH1D("AlgorithmSourceFractionsBhaBhaL1TOPTRG",
             "Fraction of events with EventT0 from each algorithm for Bhabha events triggerd by TOP;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsMuMuL1ECLTRG =
    new TH1D("AlgorithmSourceFractionsMuMuL1ECLTRG",
             "Fraction of events with EventT0 from each algorithm for #mu#mu events triggerd by ECL;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsMuMuL1CDCTRG =
    new TH1D("AlgorithmSourceFractionsMuMuL1CDCTRG",
             "Fraction of events with EventT0 from each algorithm for #mu#mu events triggerd by CDC;Algorithm;Fraction",
             6, 0, 6);
  m_histAlgorithmSourceFractionsMuMuL1TOPTRG =
    new TH1D("AlgorithmSourceFractionsMuMuL1TOPTRG",
             "Fraction of events with EventT0 from each algorithm for #mu#mu events triggerd by TOP;Algorithm;Fraction",
             6, 0, 6);
 
  for (uint i = 0; i < 6; i++) {
    m_histAlgorithmSourceFractionsHadronL1ECLTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsHadronL1CDCTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsHadronL1TOPTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsMuMuL1ECLTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsMuMuL1CDCTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
    m_histAlgorithmSourceFractionsMuMuL1TOPTRG->GetXaxis()->SetBinLabel(i + 1, c_eventT0Algorithms[i]);
  }
 
  oldDir->cd();
 
}

endRun()

virtual void endRun ( void  )

inlineoverridevirtualinherited

Function to process end_run record.

Reimplemented from Module.

Reimplemented in CalibrationCollectorModule, AlignDQMModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, AnalysisPhase1StudyModule, BeamabortStudyModule, BgoStudyModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, FANGSStudyModule, He3tubeStudyModule, MicrotpcStudyModule, TPCStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, MonitorDataModule, TrackAnaModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, KLMDQMModule, KLMDQM2Module, CDCDedxDQMModule, CDCDedxValidationModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPTBCComparatorModule, TOPWaveformQualityPlotterModule, SVDROIDQMModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLModule, TRGGDLDQMModule, TRGGRLDQMModule, TRGTOPDQMModule, TRGRAWDATAModule, SVDUnpackerDQMModule, and vxdDigitMaskingModule.

Definition at line 44 of file HistoModule.h.

{};

evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( void  )

overridevirtual

This method is called for each event.

All processing of the event takes place in this method.

Reimplemented from HistoModule.

Definition at line 296 of file EventT0DQM.cc.

{
  if (!m_objTrgSummary.isValid()) {
    B2WARNING("TRGSummary object not available but required to indicate which detector provided the L1 trigger time");
    return;
  }
 
  // Skip this event if there is no event t0, to avoid crashing other DQM
  if (!m_eventT0.isOptional()) {
    B2WARNING("Missing EventT0, EventT0DQM is skipped.");
    return;
  }
 
  // Determine if there is a valid event t0 to use and then extract the information about it
  if (!m_eventT0.isValid()) {
    return ;
  }
 
  if (!m_TrgResult.isValid()) {
    B2WARNING("SoftwareTriggerResult object not available but require to select bhabha/mumu/hadron events for this module");
    return;
  }
 
  const std::map<std::string, int>& fresults = m_TrgResult->getResults();
  if ((fresults.find("software_trigger_cut&skim&accept_bhabha") == fresults.end())   ||
      (fresults.find("software_trigger_cut&skim&accept_mumu_2trk") == fresults.end())   ||
      (fresults.find("software_trigger_cut&skim&accept_hadron") == fresults.end())) {
    B2WARNING("EventT0DQMModule: Can't find required bhabha or mumu or hadron trigger identifier");
    return;
  }
 
  // for L1 timing source is "ecl trigger" -> TRGSummary::ETimingType is 0
  const bool IsECLL1TriggerSource = (m_objTrgSummary->getTimType() == TRGSummary::ETimingType::TTYP_ECL);
  // for L1 timing source is "top trigger" -> TRGSummary::ETimingType is 1
  const bool IsTOPL1TriggerSource = (m_objTrgSummary->getTimType() == TRGSummary::ETimingType::TTYP_TOP);
  // for L1 timing source is "cdc trigger" -> TRGSummary::ETimingType is 3
  const bool IsCDCL1TriggerSource = (m_objTrgSummary->getTimType() == TRGSummary::ETimingType::TTYP_CDC);
 
  B2DEBUG(20, "IsECLL1TriggerSource = " << IsECLL1TriggerSource);
  B2DEBUG(20, "IsTOPL1TriggerSource = " << IsTOPL1TriggerSource);
  B2DEBUG(20, "IsCDCL1TriggerSource = " << IsCDCL1TriggerSource);
 
  // determine if the event was part of the hadron skim or bhabha skim or mumu skim
  const bool IsEvtAcceptedBhabha = (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha") ==
                                    SoftwareTriggerCutResult::c_accept);
  const bool IsEvtAcceptedHadron = (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron") ==
                                    SoftwareTriggerCutResult::c_accept);
  const bool IsEvtAcceptedMumu = (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk") ==
                                  SoftwareTriggerCutResult::c_accept);
 
 
  B2DEBUG(20, "bhabha trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
          (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha"))) ;
  B2DEBUG(20, "hadron trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
          (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron"))) ;
  B2DEBUG(20, "mu mu trigger result = "  << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
          (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk"))) ;
  B2DEBUG(20, "bhabha trigger comparison bool = " << IsEvtAcceptedBhabha) ;
  B2DEBUG(20, "hadron trigger comparison bool = " << IsEvtAcceptedHadron) ;
  B2DEBUG(20, "mumu trigger comparison bool = "   << IsEvtAcceptedMumu) ;
 
 
  // Set the different EventT0 values, default is -1000 in case there are no information based on a given detector
  const double eventT0ECL =
    m_eventT0->hasTemporaryEventT0(Const::EDetector::ECL) ? m_eventT0->getBestECLTemporaryEventT0()->eventT0 : -1000;
  const double eventT0CDC =
    m_eventT0->hasTemporaryEventT0(Const::EDetector::CDC) ? m_eventT0->getBestCDCTemporaryEventT0()->eventT0 : -1000;
  const double eventT0TOP =
    m_eventT0->hasTemporaryEventT0(Const::EDetector::TOP) ? m_eventT0->getBestTOPTemporaryEventT0()->eventT0 : -1000;
  const double eventT0SVD =
    m_eventT0->hasTemporaryEventT0(Const::EDetector::SVD) ? m_eventT0->getBestSVDTemporaryEventT0()->eventT0 : -1000;
 
  const auto checkForCDCAlgorithm = [cdcEventT0s = m_eventT0->getTemporaryEventT0s(Const::EDetector::CDC)](
  const std::string & algorithm) {
    for (const auto& evtt0 : cdcEventT0s) {
      if (evtt0.algorithm == algorithm) {
        return true;
      }
    }
    return false;
  };
 
  const bool hasCDCHitBasedEventT0 = checkForCDCAlgorithm("hit based");
  const bool hasCDCFullGridEventT0 = checkForCDCAlgorithm("chi2");
  // We are interested if an EventT0 is set, not whether temporary EventT0s exist that might not be used
  const bool hasAnyEventT0 = m_eventT0->hasEventT0();
  const bool hasECLEventT0 = m_eventT0->hasTemporaryEventT0(Const::EDetector::ECL);
  const bool hasSVDEventT0 = m_eventT0->hasTemporaryEventT0(Const::EDetector::SVD);
  const bool hasTOPEventT0 = m_eventT0->hasTemporaryEventT0(Const::EDetector::TOP);
 
  // Fill the plots that used the ECL trigger as the L1 timing source
  if (IsECLL1TriggerSource) {
    // Fill the histograms with the event t0 values
    if (IsEvtAcceptedBhabha) {   // fill the bha bha skim event t0s
      m_histEventT0_ECL_bhabha_L1_ECLTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_bhabha_L1_ECLTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_bhabha_L1_ECLTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_bhabha_L1_ECLTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
 
    if (IsEvtAcceptedHadron) {    // fill the hadron skim event t0s
      m_histEventT0_ECL_hadron_L1_ECLTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_hadron_L1_ECLTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_hadron_L1_ECLTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_hadron_L1_ECLTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsHadronL1ECLTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
 
    if (IsEvtAcceptedMumu) {    // fill the mumu skim event t0s
      m_histEventT0_ECL_mumu_L1_ECLTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_mumu_L1_ECLTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_mumu_L1_ECLTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_mumu_L1_ECLTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsMuMuL1ECLTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
  }
  // Fill the plots that used the TOP trigger as the L1 timing source
  else if (IsTOPL1TriggerSource) {
    // Fill the histograms with the event t0 values
    if (IsEvtAcceptedBhabha) {   // fill the bha bha skim event t0s
      m_histEventT0_ECL_bhabha_L1_TOPTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_bhabha_L1_TOPTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_bhabha_L1_TOPTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_bhabha_L1_TOPTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
 
    if (IsEvtAcceptedHadron) {    // fill the hadron skim event t0s
      m_histEventT0_ECL_hadron_L1_TOPTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_hadron_L1_TOPTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_hadron_L1_TOPTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_hadron_L1_TOPTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsHadronL1TOPTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
 
    if (IsEvtAcceptedMumu) {    // fill the mumu skim event t0s
      m_histEventT0_ECL_mumu_L1_TOPTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_mumu_L1_TOPTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_mumu_L1_TOPTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_mumu_L1_TOPTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsMuMuL1TOPTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
  }
  // Fill the plots that used the CDC trigger as the L1 timing source
  else if (IsCDCL1TriggerSource) {
    // Fill the histograms with the event t0 values
    if (IsEvtAcceptedBhabha) {   // fill the bha bha skim event t0s
      m_histEventT0_ECL_bhabha_L1_CDCTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_bhabha_L1_CDCTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_bhabha_L1_CDCTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_bhabha_L1_CDCTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
 
    if (IsEvtAcceptedHadron) {    // fill the hadron skim event t0s
      m_histEventT0_ECL_hadron_L1_CDCTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_hadron_L1_CDCTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_hadron_L1_CDCTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_hadron_L1_CDCTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsHadronL1CDCTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
 
    if (IsEvtAcceptedMumu) {    // fill the mumu skim event t0s
      m_histEventT0_ECL_mumu_L1_CDCTRG->Fill(eventT0ECL);
      m_histEventT0_CDC_mumu_L1_CDCTRG->Fill(eventT0CDC);
      m_histEventT0_TOP_mumu_L1_CDCTRG->Fill(eventT0TOP);
      m_histEventT0_SVD_mumu_L1_CDCTRG->Fill(eventT0SVD);
      fillHistogram(m_histAlgorithmSourceFractionsMuMuL1CDCTRG, hasAnyEventT0, hasECLEventT0, hasSVDEventT0,
                    hasCDCHitBasedEventT0, hasCDCFullGridEventT0, hasTOPEventT0);
    }
  }
 
  B2DEBUG(20, "eventT0ECL = " << eventT0ECL << " ns") ;
  B2DEBUG(20, "eventT0CDC = " << eventT0CDC << " ns") ;
  B2DEBUG(20, "eventT0TOP = " << eventT0TOP << " ns") ;
  B2DEBUG(20, "eventT0SVD = " << eventT0SVD << " ns") ;
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

fillHistogram()

void fillHistogram ( TH1D *  hist, const bool  hasAnyT0, const bool  hasECLT0, const bool  hasSVDT0, const bool  hasCDCHitT0, const bool  hasCDCGridT0, const bool  hasTOPT0  )

private

Fill fraction histogram with values.

Definition at line 483 of file EventT0DQM.cc.

{
  hist->Fill(-1); // counting events for normalisation
  hist->Fill(c_eventT0Algorithms[0], hasECLT0);
  hist->Fill(c_eventT0Algorithms[1], hasSVDT0);
  hist->Fill(c_eventT0Algorithms[2], hasCDCHitT0);
  hist->Fill(c_eventT0Algorithms[3], hasCDCGridT0);
  hist->Fill(c_eventT0Algorithms[4], hasTOPT0);
  hist->Fill(c_eventT0Algorithms[5], hasAnyT0);
}

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

virtual std::vector< std::string > getFileNames ( bool  outputFiles )

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

    {
      return std::vector<std::string>();
    }

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

{ return std::list<ModulePtr>(); }

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

if_false()

void if_false ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

if_true()

void if_true ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

if_value()

void if_value ( const std::string &  expression, const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

initialize()

void initialize ( void  )

overridevirtual

Initialize the module.

Reimplemented from HistoModule.

Definition at line 212 of file EventT0DQM.cc.

{
 
  m_TrgResult.isOptional();
  m_eventT0.isOptional();
 
  REG_HISTOGRAM
 
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

void setParamPython ( const std::string &  name, const boost::python::object &  pyObj  )

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

terminate()

virtual void terminate ( void  )

inlineoverridevirtualinherited

Function to terminate module.

Reimplemented from Module.

Reimplemented in CalibrationCollectorModule, B2BIIMCParticlesMonitorModule, AnalysisPhase1StudyModule, BeamabortStudyModule, BgoStudyModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, FANGSStudyModule, He3tubeStudyModule, MicrotpcStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, MonitorDataModule, TrackAnaModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, KLMDQMModule, KLMDQM2Module, CDCDedxDQMModule, CDCDedxValidationModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPPDFCheckerModule, TOPTBCComparatorModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLModule, TRGGDLDQMModule, TRGGRLDQMModule, TRGTOPDQMModule, TRGRAWDATAModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, and ROIDQMModule.

Definition at line 46 of file HistoModule.h.

{};

Member Data Documentation

c_eventT0Algorithms

const char* c_eventT0Algorithms[6] = {"ECL", "SVD", "CDC hit based", "CDC full grid #chi^{2}", "TOP", "Any"}

private

EventT0 algorithms for which to calculate fractions of abundance.

Definition at line 113 of file EventT0DQM.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_eventT0

StoreObjPtr<EventT0> m_eventT0

private

Store array for event t0.

Definition at line 62 of file EventT0DQM.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG

TH1D* m_histAlgorithmSourceFractionsBhaBhaL1CDCTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT bhabha events, L1 time by CDC trigger.

Definition at line 123 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG

TH1D* m_histAlgorithmSourceFractionsBhaBhaL1ECLTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT bhabha events, L1 time by ECL trigger.

Definition at line 121 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG

TH1D* m_histAlgorithmSourceFractionsBhaBhaL1TOPTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT bhabha events, L1 time by TOP trigger.

Definition at line 125 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsHadronL1CDCTRG

TH1D* m_histAlgorithmSourceFractionsHadronL1CDCTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT hadronic events, L1 time by CDC trigger.

Definition at line 117 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsHadronL1ECLTRG

TH1D* m_histAlgorithmSourceFractionsHadronL1ECLTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT hadronic events, L1 time by ECL trigger.

Definition at line 115 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsHadronL1TOPTRG

TH1D* m_histAlgorithmSourceFractionsHadronL1TOPTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT hadronic events, L1 time by TOP trigger.

Definition at line 119 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsMuMuL1CDCTRG

TH1D* m_histAlgorithmSourceFractionsMuMuL1CDCTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT mumu events, L1 time by CDC trigger.

Definition at line 129 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsMuMuL1ECLTRG

TH1D* m_histAlgorithmSourceFractionsMuMuL1ECLTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT mumu events, L1 time by ECL trigger.

Definition at line 127 of file EventT0DQM.h.

m_histAlgorithmSourceFractionsMuMuL1TOPTRG

TH1D* m_histAlgorithmSourceFractionsMuMuL1TOPTRG {nullptr}

private

Fraction of events with EventT0 from a given algorithm, HLT mumu events, L1 time by TOP trigger.

Definition at line 131 of file EventT0DQM.h.

m_histEventT0_CDC_bhabha_L1_CDCTRG

TH1F* m_histEventT0_CDC_bhabha_L1_CDCTRG {nullptr}

private

event t0 histogram for CDC, HLT bha bha events, L1 time by CDC trigger

Definition at line 82 of file EventT0DQM.h.

m_histEventT0_CDC_bhabha_L1_ECLTRG

TH1F* m_histEventT0_CDC_bhabha_L1_ECLTRG {nullptr}

private

event t0 histogram for CDC, HLT bha bha events, L1 time by ECL trigger

Definition at line 66 of file EventT0DQM.h.

m_histEventT0_CDC_bhabha_L1_TOPTRG

TH1F* m_histEventT0_CDC_bhabha_L1_TOPTRG {nullptr}

private

event t0 histogram for CDC, HLT bha bha events, L1 time by TOP trigger

Definition at line 98 of file EventT0DQM.h.

m_histEventT0_CDC_hadron_L1_CDCTRG

TH1F* m_histEventT0_CDC_hadron_L1_CDCTRG {nullptr}

private

event t0 histogram for CDC, HLT hadronic events, L1 time by CDC trigger

Definition at line 87 of file EventT0DQM.h.

m_histEventT0_CDC_hadron_L1_ECLTRG

TH1F* m_histEventT0_CDC_hadron_L1_ECLTRG {nullptr}

private

event t0 histogram for CDC, HLT hadronic events, L1 time by ECL trigger

Definition at line 71 of file EventT0DQM.h.

m_histEventT0_CDC_hadron_L1_TOPTRG

TH1F* m_histEventT0_CDC_hadron_L1_TOPTRG {nullptr}

private

event t0 histogram for CDC, HLT hadronic events, L1 time by TOP trigger

Definition at line 103 of file EventT0DQM.h.

m_histEventT0_CDC_mumu_L1_CDCTRG

TH1F* m_histEventT0_CDC_mumu_L1_CDCTRG {nullptr}

private

event t0 histogram for CDC, HLT mu mu events, L1 time by CDC trigger

Definition at line 92 of file EventT0DQM.h.

m_histEventT0_CDC_mumu_L1_ECLTRG

TH1F* m_histEventT0_CDC_mumu_L1_ECLTRG {nullptr}

private

event t0 histogram for CDC, HLT mu mu events, L1 time by ECL trigger

Definition at line 76 of file EventT0DQM.h.

m_histEventT0_CDC_mumu_L1_TOPTRG

TH1F* m_histEventT0_CDC_mumu_L1_TOPTRG {nullptr}

private

event t0 histogram for CDC, HLT mu mu events, L1 time by TOP trigger

Definition at line 108 of file EventT0DQM.h.

m_histEventT0_ECL_bhabha_L1_CDCTRG

TH1F* m_histEventT0_ECL_bhabha_L1_CDCTRG {nullptr}

private

event t0 histogram for ECL, HLT bha bha events, L1 time by CDC trigger

Definition at line 81 of file EventT0DQM.h.

m_histEventT0_ECL_bhabha_L1_ECLTRG

TH1F* m_histEventT0_ECL_bhabha_L1_ECLTRG {nullptr}

private

event t0 histogram for ECL, HLT bha bha events, L1 time by ECL trigger

Definition at line 65 of file EventT0DQM.h.

m_histEventT0_ECL_bhabha_L1_TOPTRG

TH1F* m_histEventT0_ECL_bhabha_L1_TOPTRG {nullptr}

private

event t0 histogram for ECL, HLT bha bha events, L1 time by TOP trigger

Definition at line 97 of file EventT0DQM.h.

m_histEventT0_ECL_hadron_L1_CDCTRG

TH1F* m_histEventT0_ECL_hadron_L1_CDCTRG {nullptr}

private

event t0 histogram for ECL, HLT hadronic events, L1 time by CDC trigger

Definition at line 86 of file EventT0DQM.h.

m_histEventT0_ECL_hadron_L1_ECLTRG

TH1F* m_histEventT0_ECL_hadron_L1_ECLTRG {nullptr}

private

event t0 histogram for ECL, HLT hadronic events, L1 time by ECL trigger

Definition at line 70 of file EventT0DQM.h.

m_histEventT0_ECL_hadron_L1_TOPTRG

TH1F* m_histEventT0_ECL_hadron_L1_TOPTRG {nullptr}

private

event t0 histogram for ECL, HLT hadronic events, L1 time by TOP trigger

Definition at line 102 of file EventT0DQM.h.

m_histEventT0_ECL_mumu_L1_CDCTRG

TH1F* m_histEventT0_ECL_mumu_L1_CDCTRG {nullptr}

private

event t0 histogram for ECL, HLT mu mu events, L1 time by CDC trigger

Definition at line 91 of file EventT0DQM.h.

m_histEventT0_ECL_mumu_L1_ECLTRG

TH1F* m_histEventT0_ECL_mumu_L1_ECLTRG {nullptr}

private

event t0 histogram for ECL, HLT mu mu events, L1 time by ECL trigger

Definition at line 75 of file EventT0DQM.h.

m_histEventT0_ECL_mumu_L1_TOPTRG

TH1F* m_histEventT0_ECL_mumu_L1_TOPTRG {nullptr}

private

event t0 histogram for ECL, HLT mu mu events, L1 time by TOP trigger

Definition at line 107 of file EventT0DQM.h.

m_histEventT0_SVD_bhabha_L1_CDCTRG

TH1F* m_histEventT0_SVD_bhabha_L1_CDCTRG {nullptr}

private

event t0 histogram for SVD, HLT bha bha events, L1 time by CDC trigger

Definition at line 84 of file EventT0DQM.h.

m_histEventT0_SVD_bhabha_L1_ECLTRG

TH1F* m_histEventT0_SVD_bhabha_L1_ECLTRG {nullptr}

private

event t0 histogram for SVD, HLT bha bha events, L1 time by ECL trigger

Definition at line 68 of file EventT0DQM.h.

m_histEventT0_SVD_bhabha_L1_TOPTRG

TH1F* m_histEventT0_SVD_bhabha_L1_TOPTRG {nullptr}

private

event t0 histogram for SVD, HLT bha bha events, L1 time by TOP trigger

Definition at line 100 of file EventT0DQM.h.

m_histEventT0_SVD_hadron_L1_CDCTRG

TH1F* m_histEventT0_SVD_hadron_L1_CDCTRG {nullptr}

private

event t0 histogram for SVD, HLT hadronic events, L1 time by CDC trigger

Definition at line 89 of file EventT0DQM.h.

m_histEventT0_SVD_hadron_L1_ECLTRG

TH1F* m_histEventT0_SVD_hadron_L1_ECLTRG {nullptr}

private

event t0 histogram for SVD, HLT hadronic events, L1 time by ECL trigger

Definition at line 73 of file EventT0DQM.h.

m_histEventT0_SVD_hadron_L1_TOPTRG

TH1F* m_histEventT0_SVD_hadron_L1_TOPTRG {nullptr}

private

event t0 histogram for SVD, HLT hadronic events, L1 time by TOP trigger

Definition at line 105 of file EventT0DQM.h.

m_histEventT0_SVD_mumu_L1_CDCTRG

TH1F* m_histEventT0_SVD_mumu_L1_CDCTRG {nullptr}

private

event t0 histogram for SVD, HLT mu mu events, L1 time by CDC trigger

Definition at line 94 of file EventT0DQM.h.

m_histEventT0_SVD_mumu_L1_ECLTRG

TH1F* m_histEventT0_SVD_mumu_L1_ECLTRG {nullptr}

private

event t0 histogram for SVD, HLT mu mu events, L1 time by ECL trigger

Definition at line 78 of file EventT0DQM.h.

m_histEventT0_SVD_mumu_L1_TOPTRG

TH1F* m_histEventT0_SVD_mumu_L1_TOPTRG {nullptr}

private

event t0 histogram for SVD, HLT mu mu events, L1 time by TOP trigger

Definition at line 110 of file EventT0DQM.h.

m_histEventT0_TOP_bhabha_L1_CDCTRG

TH1F* m_histEventT0_TOP_bhabha_L1_CDCTRG {nullptr}

private

event t0 histogram for TOP, HLT bha bha events, L1 time by CDC trigger

Definition at line 83 of file EventT0DQM.h.

m_histEventT0_TOP_bhabha_L1_ECLTRG

TH1F* m_histEventT0_TOP_bhabha_L1_ECLTRG {nullptr}

private

event t0 histogram for TOP, HLT bha bha events, L1 time by ECL trigger

Definition at line 67 of file EventT0DQM.h.

m_histEventT0_TOP_bhabha_L1_TOPTRG

TH1F* m_histEventT0_TOP_bhabha_L1_TOPTRG {nullptr}

private

event t0 histogram for TOP, HLT bha bha events, L1 time by TOP trigger

Definition at line 99 of file EventT0DQM.h.

m_histEventT0_TOP_hadron_L1_CDCTRG

TH1F* m_histEventT0_TOP_hadron_L1_CDCTRG {nullptr}

private

event t0 histogram for TOP, HLT hadronic events, L1 time by CDC trigger

Definition at line 88 of file EventT0DQM.h.

m_histEventT0_TOP_hadron_L1_ECLTRG

TH1F* m_histEventT0_TOP_hadron_L1_ECLTRG {nullptr}

private

event t0 histogram for TOP, HLT hadronic events, L1 time by ECL trigger

Definition at line 72 of file EventT0DQM.h.

m_histEventT0_TOP_hadron_L1_TOPTRG

TH1F* m_histEventT0_TOP_hadron_L1_TOPTRG {nullptr}

private

event t0 histogram for TOP, HLT hadronic events, L1 time by TOP trigger

Definition at line 104 of file EventT0DQM.h.

m_histEventT0_TOP_mumu_L1_CDCTRG

TH1F* m_histEventT0_TOP_mumu_L1_CDCTRG {nullptr}

private

event t0 histogram for TOP, HLT mu mu events, L1 time by CDC trigger

Definition at line 93 of file EventT0DQM.h.

m_histEventT0_TOP_mumu_L1_ECLTRG

TH1F* m_histEventT0_TOP_mumu_L1_ECLTRG {nullptr}

private

event t0 histogram for TOP, HLT mu mu events, L1 time by ECL trigger

Definition at line 77 of file EventT0DQM.h.

m_histEventT0_TOP_mumu_L1_TOPTRG

TH1F* m_histEventT0_TOP_mumu_L1_TOPTRG {nullptr}

private

event t0 histogram for TOP, HLT mu mu events, L1 time by TOP trigger

Definition at line 109 of file EventT0DQM.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

m_objTrgSummary

StoreObjPtr<TRGSummary> m_objTrgSummary

private

Trigger Summary data object.

Definition at line 59 of file EventT0DQM.h.

m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_TrgResult

StoreObjPtr<SoftwareTriggerResult> m_TrgResult

private

Store array for Trigger selection.

Definition at line 61 of file EventT0DQM.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

---

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

• reconstruction/modules/EventT0DQM/include/EventT0DQM.h
• reconstruction/modules/EventT0DQM/src/EventT0DQM.cc