BeamBkgHitRateMonitorModule Class Reference

A module to monitor detector hit rates of beam background Output is to a flat ntuple. More...

#include <BeamBkgHitRateMonitorModule.h>

Inheritance diagram for BeamBkgHitRateMonitorModule:

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
	BeamBkgHitRateMonitorModule ()
	Constructor.
virtual	~BeamBkgHitRateMonitorModule ()
	Destructor.
virtual void	initialize () override
	Initialize the Module.
virtual void	beginRun () override
	Called when entering a new run.
virtual void	event () override
	Event processor.
virtual void	endRun () override
	End-of-run action.
virtual void	terminate () override
	Termination action.
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
bool	isEventSelected ()
	event selection
void	collectFileMetaData ()
	Collect file meta data: LFN's, low and high experiment, run and event numbers.
void	setFileMetaData ()
	Set output FileMetaData object.
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
std::string	m_outputFileName
	output file name
std::string	m_treeName
	output tree name
std::vector< int >	m_trgTypes
	trigger types to be selected
bool	m_writeEmptyTimeStamps
	if true write to ntuple also empty time stamps
double	m_topTimeOffset
	TOP: time offset of hits [ns].
double	m_topTimeWindow
	TOP: time window in which to count hits [ns].
std::string	m_svdShaperDigitsName
	SVD: name of the SVDShaperDigits collection.
double	m_svdThrCharge
	SVD: energy cut on cluster charge.
bool	m_svdIgnoreHotStripsPayload
	SVD: count hot strips as active.
bool	m_svdIgnoreMaskedStripsPayload
	SVD: count FADC-masked strips as active.
std::map< std::string, std::string >	m_additionalDataDescription
	additional metadata description
int	m_cdcTimeWindowLowerEdgeSmallCell
	CDC: lower edge of the time window for small cells [tdc count = ns].
int	m_cdcTimeWindowUpperEdgeSmallCell
	CDC: upper edge of the time window for small cells [tdc count = ns].
int	m_cdcTimeWindowLowerEdgeNormalCell
	CDC: lower edge of the time window for normal cells [tdc count = ns].
int	m_cdcTimeWindowUpperEdgeNormalCell
	CDC: upper edge of the time window for normal cells [tdc count = ns].
bool	m_cdcEnableBadWireTreatment
	CDC: flag to enable the bad wire treatment.
bool	m_cdcEnableBackgroundHitFilter
	CDC: flag to enable the CDC background hit (crosstakl, noise) filter.
bool	m_cdcEnableMarkBackgroundHit
	CDC: flag to enable to mark background flag on CDCHit (set 0x100 bit for CDCHit::m_status).
std::vector< std::string >	m_detectors
	detectors to be included in the output tree
StoreObjPtr< EventMetaData >	m_eventMetaData
	event meta data object
StoreObjPtr< TRGSummary >	m_trgSummary
	trigger summary
StoreObjPtr< FileMetaData >	m_fileMetaData {"", DataStore::c_Persistent}
	file metadata
TFile *	m_file = 0
	root file pointer
TTree *	m_tree = 0
	root tree pointer
int	m_run = 0
	run number
int	m_numEvents = 0
	number of events in the time stamp
unsigned	m_timeStamp = 0
	time stamp (unix time)
int	m_time = 0
	time in seconds w.r.t the first event of the run
TH1F *	m_trgAll = 0
	trigger types of all events
TH1F *	m_trgSel = 0
	trigger types of selected events
std::map< unsigned, int >	m_eventCounts
	number of events in time stamps
std::vector< Background::HitRateBase * >	m_monitors
	rate monitors
unsigned	m_numEventsSelected = 0
	number of selected events in a run
std::map< TRGSummary::ETimingType, unsigned >	m_trgTypesCount
	trigger type counters
unsigned	m_utimeFirst = 0
	unix time of the first event in the run input stream
unsigned	m_utimeMin = 0
	minimal unix time of events in the run
unsigned	m_utimeMax = 0
	maximal unix time of events in the run
TTree *	m_persistent = 0
	root tree pointer (for FileMetaData)
FileMetaData	m_outputFileMetaData
	output file meta data branch
std::vector< std::string >	m_parentLfns
	Vector of parent file LFNs.
unsigned long	m_experimentLow = 1
	Lowest experiment number.
unsigned long	m_runLow = 0
	Lowest run number.
unsigned long	m_eventLow = 0
	Lowest event number in lowest run.
unsigned long	m_experimentHigh = 0
	Highest experiment number.
unsigned long	m_runHigh = 0
	Highest run number.
unsigned long	m_eventHigh = 0
	Highest event number in highest run.
unsigned	m_allEventsSelected = 0
	number of selected events in all runs
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

A module to monitor detector hit rates of beam background Output is to a flat ntuple.

Definition at line 35 of file BeamBkgHitRateMonitorModule.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

BeamBkgHitRateMonitorModule()

BeamBkgHitRateMonitorModule

(

)

Constructor.

Definition at line 47 of file BeamBkgHitRateMonitorModule.cc.

                                                         : Module()
 
{
  // set module description
  setDescription("A module for off-line monitoring of beam background hit rates.");
 
  /* No multiprocessing allowed!
   * setPropertyFlags(c_ParallelProcessingCertified);
   */
 
  // Add parameters
  addParam("outputFileName", m_outputFileName, "output file name",
           string("beamBkgHitRates.root"));
  addParam("treeName", m_treeName, "output tree name",
           string("tree"));
  m_trgTypes.push_back(TRGSummary::TTYP_DPHY);
  m_trgTypes.push_back(TRGSummary::TTYP_RAND);
  m_trgTypes.push_back(TRGSummary::TTYP_POIS);
  addParam("trgTypes", m_trgTypes,
           "trigger types for event selection (see TRGSummary.h for definitions). "
           "Empty list means all trigger types.",
           m_trgTypes);
  addParam("writeEmptyTimeStamps", m_writeEmptyTimeStamps,
           "if true, write to ntuple also empty time stamps", false);
  addParam("topTimeOffset", m_topTimeOffset,
           "TOP: time offset of hits (to be subtracted) [ns]", 25.0);
  addParam("topTimeWindow", m_topTimeWindow,
           "TOP: time window in which to count hits [ns]", 100.0);
  addParam("svdShaperDigitsName", m_svdShaperDigitsName,
           "SVDShaperDigits collection name", string(""));
  addParam("svdThrCharge", m_svdThrCharge,
           "Energy cur on SVD Cluster charge in electrons", 15000.);
  addParam("svdIgnoreHotStripsPayload", m_svdIgnoreHotStripsPayload,
           "If true, also SVD hot strips are counted as active", false);
  addParam("svdIgnoreMaskedStripsPayload", m_svdIgnoreMaskedStripsPayload,
           "If true, also SVD FADC-masked strips are counted as active", false);
  addParam("additionalDataDescription", m_additionalDataDescription,
           "Additional dictionary of "
           "name->value pairs to be added to the file metadata to describe the data",
           m_additionalDataDescription);
  addParam("cdcTimeWindowLowerEdgeSmallCell",  m_cdcTimeWindowLowerEdgeSmallCell,
           "CDC: lower edge of the time window for small cells [tdc count = ns]",
           4550);
  addParam("cdcTimeWindowUpperEdgeSmallCell",  m_cdcTimeWindowUpperEdgeSmallCell,
           "CDC: upper edge of the time window for small cells [tdc count = ns]",
           5050);
  addParam("cdcTimeWindowLowerEdgeNormalCell", m_cdcTimeWindowLowerEdgeNormalCell,
           "CDC: lower edge of the time window for normal cells [tdc count = ns]",
           4200);
  addParam("cdcTimeWindowUpperEdgeNormalCell", m_cdcTimeWindowUpperEdgeNormalCell,
           "CDC: upper edge of the time window for normal cells [tdc count = ns]",
           5050);
  addParam("cdcEnableBadWireTreatment", m_cdcEnableBadWireTreatment,
           "CDC: flag to enable the bad wire treatment", true);
  addParam("cdcEnableBackgroundHitFilter", m_cdcEnableBackgroundHitFilter,
           "CDC: flag to enable the CDC background hit (crosstakl, noise) filter", true);
  addParam("cdcEnableMarkBackgroundHit", m_cdcEnableMarkBackgroundHit,
           "CDC: flag to enable to mark background flag on CDCHit (set 0x100 bit for CDCHit::m_status).", false);
  addParam("detectors", m_detectors,
           "Detectors to be included in the output tree, if empty, all detectors are included", m_detectors);
}

~BeamBkgHitRateMonitorModule()

~BeamBkgHitRateMonitorModule ( )

virtual

Destructor.

Definition at line 109 of file BeamBkgHitRateMonitorModule.cc.

{
  for (auto& monitor : m_monitors) {
    if (monitor) delete monitor;
  }
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 200 of file BeamBkgHitRateMonitorModule.cc.

{
  // clear buffers
  for (auto& monitor : m_monitors) {
    monitor->clear();
  }
  m_eventCounts.clear();
 
  // clear counters
  m_numEventsSelected = 0;
  m_trgTypesCount.clear();
 
  // set run number
  m_run = m_eventMetaData->getRun();
 
  // set unix time of the first event in the run
  unsigned utime = m_eventMetaData->getTime() / 1000000000;
  m_utimeFirst = utime;
  m_utimeMin = utime;
  m_utimeMax = utime + 1;
 
}

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;
}

collectFileMetaData()

void collectFileMetaData ( )

private

Collect file meta data: LFN's, low and high experiment, run and event numbers.

This code is based on RootOutputModule::event().

Definition at line 315 of file BeamBkgHitRateMonitorModule.cc.

{
  // add file name to the list
  if (m_fileMetaData.isValid()) {
    std::string lfn = m_fileMetaData->getLfn();
    if (not lfn.empty() and (m_parentLfns.empty() or (m_parentLfns.back() != lfn))) {
      m_parentLfns.push_back(lfn);
    }
  }
 
  // low and high experiment, run and event numbers
  unsigned long experiment =  m_eventMetaData->getExperiment();
  unsigned long run =  m_eventMetaData->getRun();
  unsigned long event = m_eventMetaData->getEvent();
  if (m_experimentLow > m_experimentHigh) { //starting condition
    m_experimentLow = m_experimentHigh = experiment;
    m_runLow = m_runHigh = run;
    m_eventLow = m_eventHigh = event;
  } else {
    if ((experiment < m_experimentLow) or ((experiment == m_experimentLow) and ((run < m_runLow) or ((run == m_runLow)
                                           and (event < m_eventLow))))) {
      m_experimentLow = experiment;
      m_runLow = run;
      m_eventLow = event;
    }
    if ((experiment > m_experimentHigh) or ((experiment == m_experimentHigh) and ((run > m_runHigh) or ((run == m_runHigh)
                                            and (event > m_eventHigh))))) {
      m_experimentHigh = experiment;
      m_runHigh = run;
      m_eventHigh = event;
    }
  }
 
}

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(); }

endRun()

void endRun ( void  )

overridevirtual

End-of-run action.

Reimplemented from Module.

Definition at line 245 of file BeamBkgHitRateMonitorModule.cc.

{
  // fill ntuple
  for (unsigned utime = m_utimeMin; utime < m_utimeMax; utime++) {
    if (not m_writeEmptyTimeStamps) {
      if (m_eventCounts.find(utime) == m_eventCounts.end()) continue;
    }
    m_numEvents = m_eventCounts[utime];
    m_timeStamp = utime;
    m_time = utime - m_utimeMin;
    for (auto& monitor : m_monitors) {
      monitor->normalize(utime);
    }
    m_tree->Fill();
  }
 
  // count selected events in all runs
  m_allEventsSelected += m_numEventsSelected;
 
  // print a summary for this run
  std::string trigs;
  for (const auto& trgType : m_trgTypesCount) {
    trigs += "        trigger type " + std::to_string(trgType.first) + ": " +
             std::to_string(trgType.second) + " events\n";
  }
  B2INFO("Run " << m_run << ": " << m_numEventsSelected
         << " events selected for beam background hit rate monitoring.\n"
         << trigs
         << LogVar("first event utime ", m_utimeMin)
         << LogVar("start utime       ", m_utimeMin)
         << LogVar("stop utime        ", m_utimeMax)
         << LogVar("duration [seconds]", m_utimeMax - m_utimeMin)
        );
}

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

Event processor.

Reimplemented from Module.

Definition at line 223 of file BeamBkgHitRateMonitorModule.cc.

{
  // get unix time of the event
  unsigned utime = m_eventMetaData->getTime() / 1000000000;
  m_utimeMin = std::min(m_utimeMin, utime);
  m_utimeMax = std::max(m_utimeMax, utime + 1);
 
  // collect file meta data
  collectFileMetaData();
 
  // event selection
  if (not isEventSelected()) return;
  m_numEventsSelected++;
 
  // accumulate
  for (auto& monitor : m_monitors) {
    monitor->accumulate(utime);
  }
  m_eventCounts[utime] += 1;
 
}

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)

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.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 116 of file BeamBkgHitRateMonitorModule.cc.

{
  // collections registration
  m_eventMetaData.isRequired();
  if (m_trgTypes.empty()) {
    m_trgSummary.isOptional(); // enables to run the module when TRGSummary is absent
  } else {
    m_trgSummary.isRequired();
  }
  m_fileMetaData.isOptional(); // enables to run the module with simulation
 
  // create, set and append hit rate monitoring classes
  std::string detectors;
  for (const auto& detector : m_detectors) detectors += detector + " ";
  if (detectors.find("PXD") != string::npos or detectors.empty()) {
    auto* pxd = new Background::PXDHitRateCounter();
    m_monitors.push_back(pxd);
  }
 
  if (detectors.find("SVD") != string::npos or detectors.empty()) {
    auto* svd = new Background::SVDHitRateCounter(m_svdShaperDigitsName, m_svdThrCharge,
                                                  m_svdIgnoreHotStripsPayload,
                                                  m_svdIgnoreMaskedStripsPayload);
    m_monitors.push_back(svd);
  }
 
  if (detectors.find("CDC") != string::npos or detectors.empty()) {
    auto* cdc = new Background::CDCHitRateCounter(m_cdcTimeWindowLowerEdgeSmallCell,  m_cdcTimeWindowUpperEdgeSmallCell,
                                                  m_cdcTimeWindowLowerEdgeNormalCell, m_cdcTimeWindowUpperEdgeNormalCell,
                                                  m_cdcEnableBadWireTreatment, m_cdcEnableBackgroundHitFilter,
                                                  m_cdcEnableMarkBackgroundHit);
    m_monitors.push_back(cdc);
  }
 
  if (detectors.find("TOP") != string::npos or detectors.empty()) {
    auto* top = new Background::TOPHitRateCounter(m_topTimeOffset, m_topTimeWindow);
    m_monitors.push_back(top);
  }
 
  if (detectors.find("ARICH") != string::npos or detectors.empty()) {
    auto* arich = new Background::ARICHHitRateCounter();
    m_monitors.push_back(arich);
  }
 
  if (detectors.find("ECL") != string::npos or detectors.empty()) {
    auto* ecl = new Background::ECLHitRateCounter();
    m_monitors.push_back(ecl);
  }
 
  if (detectors.find("KLM") != string::npos or detectors.empty()) {
    auto* klm = new Background::KLMHitRateCounter();
    m_monitors.push_back(klm);
  }
 
  // open output root file
  m_file = TFile::Open(m_outputFileName.c_str(), "RECREATE");
  if (not m_file) {
    B2FATAL("Cannot open output file '" << m_outputFileName << "' for writing");
  }
 
  // create tree
  m_tree = new TTree(m_treeName.c_str(), "hit rates of selected events");
 
  // create persistent tree to store fileMetaData
  m_persistent = new TTree("persistent", "persistent data");
  m_persistent->Branch("FileMetaData", &m_outputFileMetaData);
 
  // set tree branches
  m_tree->Branch("run", &m_run, "run/I");
  m_tree->Branch("numEvents", &m_numEvents, "numEvents/I");
  m_tree->Branch("timeStamp", &m_timeStamp, "timeStamp/i");
  m_tree->Branch("time", &m_time, "time/I");
  for (auto& monitor : m_monitors) {
    monitor->initialize(m_tree);
  }
 
  // control histograms
  m_trgAll = new TH1F("trgAll", "trigger types of all events", 16, -0.5, 15.5);
  m_trgAll->SetXTitle("type of trigger timing source");
  m_trgSel = new TH1F("trgSel", "trigger types of selected events", 16, -0.5, 15.5);
  m_trgSel->SetXTitle("type of trigger timing source");
 
}

isEventSelected()

bool isEventSelected ( )

private

event selection

Returns

true if event is selected

Definition at line 293 of file BeamBkgHitRateMonitorModule.cc.

{
  auto trgType = TRGSummary::TTYP_NONE;
  if (m_trgSummary.isValid()) trgType = m_trgSummary->getTimType();
  m_trgAll->Fill(trgType);
 
  if (m_trgTypes.empty()) {
    m_trgTypesCount[trgType] += 1;
    m_trgSel->Fill(trgType);
    return true;
  }
  for (auto type : m_trgTypes) {
    if (trgType == type) {
      m_trgTypesCount[trgType] += 1;
      m_trgSel->Fill(trgType);
      return true;
    }
  }
  return false;
}

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;
}

setFileMetaData()

void setFileMetaData ( )

private

Set output FileMetaData object.

This code is based on RootOutputModule::fillFileMetaData().

Definition at line 351 of file BeamBkgHitRateMonitorModule.cc.

{
 
  if (m_fileMetaData.isValid() and not m_fileMetaData->isMC()) {
    m_outputFileMetaData.declareRealData();
  }
 
  m_outputFileMetaData.setNEvents(m_allEventsSelected);
 
  if (m_experimentLow > m_experimentHigh) {
    // starting condition so apparently no events at all
    m_outputFileMetaData.setLow(-1, -1, 0);
    m_outputFileMetaData.setHigh(-1, -1, 0);
  } else {
    m_outputFileMetaData.setLow(m_experimentLow, m_runLow, m_eventLow);
    m_outputFileMetaData.setHigh(m_experimentHigh, m_runHigh, m_eventHigh);
  }
 
  m_outputFileMetaData.setParents(m_parentLfns);
  RootIOUtilities::setCreationData(m_outputFileMetaData);
  m_outputFileMetaData.setRandomSeed(RandomNumbers::getSeed());
  m_outputFileMetaData.setSteering(Environment::Instance().getSteering());
  auto mcEvents = Environment::Instance().getNumberOfMCEvents();
  m_outputFileMetaData.setMcEvents(mcEvents);
  m_outputFileMetaData.setDatabaseGlobalTag(Database::Instance().getGlobalTags());
 
  for (const auto& item : m_additionalDataDescription) {
    m_outputFileMetaData.setDataDescription(item.first, item.second);
  }
 
  std::string lfn = m_file->GetName();
  lfn = std::filesystem::absolute(lfn).string();
  std::string format = EnvironmentVariables::get("BELLE2_LFN_FORMATSTRING", "");
  if (!format.empty()) {
    auto format_filename = boost::python::import("B2Tools.format").attr("format_filename");
    lfn = boost::python::extract<std::string>(format_filename(format, m_outputFileName, m_outputFileMetaData.getJsonStr()));
  }
  m_outputFileMetaData.setLfn(lfn);
 
}

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()

void terminate ( void  )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 280 of file BeamBkgHitRateMonitorModule.cc.

{
  setFileMetaData();
  m_persistent->Fill();
 
  // write to file and close
  m_file->cd();
  m_file->Write();
  m_file->Close();
 
  B2INFO("Output file: " << m_outputFileName);
}

Member Data Documentation

m_additionalDataDescription

std::map<std::string, std::string> m_additionalDataDescription

private

additional metadata description

Definition at line 107 of file BeamBkgHitRateMonitorModule.h.

m_allEventsSelected

unsigned m_allEventsSelected = 0

private

number of selected events in all runs

Definition at line 159 of file BeamBkgHitRateMonitorModule.h.

m_cdcEnableBackgroundHitFilter

bool m_cdcEnableBackgroundHitFilter

private

CDC: flag to enable the CDC background hit (crosstakl, noise) filter.

Definition at line 113 of file BeamBkgHitRateMonitorModule.h.

m_cdcEnableBadWireTreatment

bool m_cdcEnableBadWireTreatment

private

CDC: flag to enable the bad wire treatment.

Definition at line 112 of file BeamBkgHitRateMonitorModule.h.

m_cdcEnableMarkBackgroundHit

bool m_cdcEnableMarkBackgroundHit

private

CDC: flag to enable to mark background flag on CDCHit (set 0x100 bit for CDCHit::m_status).

default: false

Definition at line 114 of file BeamBkgHitRateMonitorModule.h.

m_cdcTimeWindowLowerEdgeNormalCell

int m_cdcTimeWindowLowerEdgeNormalCell

private

CDC: lower edge of the time window for normal cells [tdc count = ns].

Definition at line 110 of file BeamBkgHitRateMonitorModule.h.

m_cdcTimeWindowLowerEdgeSmallCell

int m_cdcTimeWindowLowerEdgeSmallCell

private

CDC: lower edge of the time window for small cells [tdc count = ns].

Definition at line 108 of file BeamBkgHitRateMonitorModule.h.

m_cdcTimeWindowUpperEdgeNormalCell

int m_cdcTimeWindowUpperEdgeNormalCell

private

CDC: upper edge of the time window for normal cells [tdc count = ns].

Definition at line 111 of file BeamBkgHitRateMonitorModule.h.

m_cdcTimeWindowUpperEdgeSmallCell

int m_cdcTimeWindowUpperEdgeSmallCell

private

CDC: upper edge of the time window for small cells [tdc count = ns].

Definition at line 109 of file BeamBkgHitRateMonitorModule.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_detectors

std::vector<std::string> m_detectors

private

detectors to be included in the output tree

Definition at line 115 of file BeamBkgHitRateMonitorModule.h.

m_eventCounts

std::map<unsigned, int> m_eventCounts

private

number of events in time stamps

Definition at line 137 of file BeamBkgHitRateMonitorModule.h.

m_eventHigh

unsigned long m_eventHigh = 0

private

Highest event number in highest run.

Definition at line 158 of file BeamBkgHitRateMonitorModule.h.

m_eventLow

unsigned long m_eventLow = 0

private

Lowest event number in lowest run.

Definition at line 155 of file BeamBkgHitRateMonitorModule.h.

m_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData

private

event meta data object

Definition at line 118 of file BeamBkgHitRateMonitorModule.h.

m_experimentHigh

unsigned long m_experimentHigh = 0

private

Highest experiment number.

Definition at line 156 of file BeamBkgHitRateMonitorModule.h.

m_experimentLow

unsigned long m_experimentLow = 1

private

Lowest experiment number.

Definition at line 153 of file BeamBkgHitRateMonitorModule.h.

m_file

TFile* m_file = 0

private

root file pointer

Definition at line 123 of file BeamBkgHitRateMonitorModule.h.

m_fileMetaData

StoreObjPtr<FileMetaData> m_fileMetaData {"", DataStore::c_Persistent}

private

file metadata

Definition at line 120 of file BeamBkgHitRateMonitorModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.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_monitors

std::vector<Background::HitRateBase*> m_monitors

private

rate monitors

Definition at line 140 of file BeamBkgHitRateMonitorModule.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_numEvents

int m_numEvents = 0

private

number of events in the time stamp

Definition at line 128 of file BeamBkgHitRateMonitorModule.h.

m_numEventsSelected

unsigned m_numEventsSelected = 0

private

number of selected events in a run

Definition at line 143 of file BeamBkgHitRateMonitorModule.h.

m_outputFileMetaData

FileMetaData m_outputFileMetaData

private

output file meta data branch

Definition at line 151 of file BeamBkgHitRateMonitorModule.h.

m_outputFileName

std::string m_outputFileName

private

output file name

Definition at line 97 of file BeamBkgHitRateMonitorModule.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_parentLfns

std::vector<std::string> m_parentLfns

private

Vector of parent file LFNs.

Definition at line 152 of file BeamBkgHitRateMonitorModule.h.

m_persistent

TTree* m_persistent = 0

private

root tree pointer (for FileMetaData)

Definition at line 150 of file BeamBkgHitRateMonitorModule.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_run

int m_run = 0

private

run number

Definition at line 127 of file BeamBkgHitRateMonitorModule.h.

m_runHigh

unsigned long m_runHigh = 0

private

Highest run number.

Definition at line 157 of file BeamBkgHitRateMonitorModule.h.

m_runLow

unsigned long m_runLow = 0

private

Lowest run number.

Definition at line 154 of file BeamBkgHitRateMonitorModule.h.

m_svdIgnoreHotStripsPayload

bool m_svdIgnoreHotStripsPayload

private

SVD: count hot strips as active.

Definition at line 105 of file BeamBkgHitRateMonitorModule.h.

m_svdIgnoreMaskedStripsPayload

bool m_svdIgnoreMaskedStripsPayload

private

SVD: count FADC-masked strips as active.

Definition at line 106 of file BeamBkgHitRateMonitorModule.h.

m_svdShaperDigitsName

std::string m_svdShaperDigitsName

private

SVD: name of the SVDShaperDigits collection.

Definition at line 103 of file BeamBkgHitRateMonitorModule.h.

m_svdThrCharge

double m_svdThrCharge

private

SVD: energy cut on cluster charge.

Definition at line 104 of file BeamBkgHitRateMonitorModule.h.

m_time

int m_time = 0

private

time in seconds w.r.t the first event of the run

Definition at line 130 of file BeamBkgHitRateMonitorModule.h.

m_timeStamp

unsigned m_timeStamp = 0

private

time stamp (unix time)

Definition at line 129 of file BeamBkgHitRateMonitorModule.h.

m_topTimeOffset

double m_topTimeOffset

private

TOP: time offset of hits [ns].

Definition at line 101 of file BeamBkgHitRateMonitorModule.h.

m_topTimeWindow

double m_topTimeWindow

private

TOP: time window in which to count hits [ns].

Definition at line 102 of file BeamBkgHitRateMonitorModule.h.

m_tree

TTree* m_tree = 0

private

root tree pointer

Definition at line 124 of file BeamBkgHitRateMonitorModule.h.

m_treeName

std::string m_treeName

private

output tree name

Definition at line 98 of file BeamBkgHitRateMonitorModule.h.

m_trgAll

TH1F* m_trgAll = 0

private

trigger types of all events

Definition at line 133 of file BeamBkgHitRateMonitorModule.h.

m_trgSel

TH1F* m_trgSel = 0

private

trigger types of selected events

Definition at line 134 of file BeamBkgHitRateMonitorModule.h.

m_trgSummary

StoreObjPtr<TRGSummary> m_trgSummary

private

trigger summary

Definition at line 119 of file BeamBkgHitRateMonitorModule.h.

m_trgTypes

std::vector<int> m_trgTypes

private

trigger types to be selected

Definition at line 99 of file BeamBkgHitRateMonitorModule.h.

m_trgTypesCount

std::map<TRGSummary::ETimingType, unsigned> m_trgTypesCount

private

trigger type counters

Definition at line 144 of file BeamBkgHitRateMonitorModule.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.

m_utimeFirst

unsigned m_utimeFirst = 0

private

unix time of the first event in the run input stream

Definition at line 145 of file BeamBkgHitRateMonitorModule.h.

m_utimeMax

unsigned m_utimeMax = 0

private

maximal unix time of events in the run

Definition at line 147 of file BeamBkgHitRateMonitorModule.h.

m_utimeMin

unsigned m_utimeMin = 0

private

minimal unix time of events in the run

Definition at line 146 of file BeamBkgHitRateMonitorModule.h.

m_writeEmptyTimeStamps

bool m_writeEmptyTimeStamps

private

if true write to ntuple also empty time stamps

Definition at line 100 of file BeamBkgHitRateMonitorModule.h.

---

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

• background/modules/BeamBkgHitRateMonitor/include/BeamBkgHitRateMonitorModule.h
• background/modules/BeamBkgHitRateMonitor/src/BeamBkgHitRateMonitorModule.cc