TRGECLModule Class Reference

A module of ETM. More...

#include <TRGECLModule.h>

Inheritance diagram for TRGECLModule:

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
	TRGECLModule ()
	Constructor.
virtual	~TRGECLModule ()
	Destructor.
virtual void	initialize () override
	Initializes TRGECLModule.
virtual void	beginRun () override
	Called when new run started.
virtual void	event () override
	Called event by event.
virtual void	endRun () override
	Called when run ended.
virtual void	terminate () override
	Called when processing ended.
std::string	version (void) const
	returns version of TRGECLModule.
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.

Protected Attributes
std::string	m_inColName
	Input array name.
std::string	m_eclHitOutColName
	Output array name for Xtal.
std::string	m_eclTCHitOutColName
	Output array name for TC.
int	m_hitNum = 0
	The current number of created hits in an event.
int	m_hitTCNum = 0
	TC Hit number.

Private Member Functions
double	getDBparmap (const std::map< std::string, double >, std::string, double)
	get payload from conditionDB
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
int	m_debugLevel
	Parameters.
std::string	m_configFilename
	Config.
int	m_nRun = 0
	Run number.
int	m_nEvent = 0
	Event number.
int	m_Bhabha
	Bhabha option.
int	m_Clustering
	Clustering option.
int	m_ClusterLimit
	Cluster Limit.
int	m_EventTiming
	Eventtiming option.
double	m_TimeWindow
	Trigger decision time window.
double	m_OverlapWindow
	Trigger decision overlap window in order to avoid boundary effect.
int	m_NofTopTC
int	m_SelectEvent
	Event selection.
bool	m_ConditionDB
	Flag to use Condition DB.
double	m_ADCtoEnergy
	conversion factor of ADC to Energy in GeV
std::vector< double >	m_TotalEnergy
	Total Energy Threshold (low, high, lum) in Lab in GeV.
std::vector< double >	m_2DBhabhaThresholdFWD
	2D Bhabha Energy Threshold
std::vector< double >	m_2DBhabhaThresholdBWD
	2D Bhabha Energy Threshold
std::vector< double >	m_3DBhabhaVetoThreshold
	3D Veto Bhabha Energy Threshold
std::vector< int >	m_3DBhabhaVetoAngle
	3D Veto Bhabha Energy Angle
std::vector< double >	m_3DBhabhaSelectionThreshold
	3D Selection Bhabha Energy Threshold
std::vector< int >	m_3DBhabhaSelectionAngle
	3D Selection Bhabha Energy Angle
std::vector< int >	m_3DBhabhaSelectionPreScale
	3D Selection Bhabha preselection
double	m_mumuThreshold
	mumu bit Energy Threshold
std::vector< int >	m_mumuAngle
	mumu bit Angle
std::vector< double >	m_lmlCLELabCut
	Low Multiplicity cluster E cut in Lab in GeV.
std::vector< double >	m_lmlCLECMSCut
	Low Multiplicity cluster E cut in CMS in GeV.
int	m_lml00NCLforMinE
	lml0 the number of cluster for minimum energy
int	m_lml12NCLforMinE
	lml12 the number of cluster for minimum energy
int	m_lml13ThetaIdSelection
	lml13 cluster ThetaID selection
double	m_ECLBurstThreshold
	ECL Burst Bit Threshold.
std::vector< double >	m_EventTimingQualityThreshold
	Energy threshold(low, high) of event timing quality flag (GeV)
std::vector< int >	m_3DBhabhaVetoInTrackThetaRegion
	Theta region (low, high) of 3D Bhabha Veto InTrack.
std::vector< int >	m_taub2bAngleCut
	taub2b 2 cluster angle cut (degree) (dphi low, dphi high, theta_sum low, theta_sum high)
double	m_taub2bEtotCut
	taub2b total energy (TC theta ID =1-17) (GeV)
double	m_taub2bCLELabCut
	taub2b Cluster energy selection in Lab (GeV)
std::vector< int >	m_hie12BhabhaVetoAngle
	(hie1 and hie2) 2 cluster angle cut in CMS in degree for Bhabha veto in hie1 and hie2
double	m_taub2b2EtotCut
	taub2b2 total energy cut in Lab (GeV)
std::vector< int >	m_taub2b2AngleCut
	taub2b2 two Cluster angle cut (degree)
std::vector< double >	m_taub2b2CLELabCut
	taub2b2 cluster energy cut(low, high) (GeV) in lab
double	m_taub2b3EtotCut
	taub2b3 total energy cut in lab (GeV)
std::vector< int >	m_taub2b3AngleCut
	taub2b3 two Cluster angle cut in cms (degree)
double	m_taub2b3CLEb2bLabCut
	taub2b3 cluster energy cut in lab for one of b2b clusters (GeV)
std::vector< double >	m_taub2b3CLELabCut
	taub2b3 cluster energy cut(low and high) in lab for all clusters (GeV)
double	m_hie4LowCLELabCut
	(hie4) CL E cut for minimum energy cluster
TrgEclMaster *	etm
	ETM (ecl trigger master) to generate all trigger bits of ecl trigger.
StoreArray< TRGECLHit >	m_TRGECLHit
	output for TRGECLHit
StoreArray< TRGECLTrg >	m_TRGECLTrg
	output for TRGECLTrg
StoreArray< TRGECLCluster >	m_TRGECLCluster
	output for TRGECLCluster
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 of ETM.

Definition at line 31 of file TRGECLModule.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,  
    };

Member Function Documentation

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 425 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 438 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 431 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 419 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 444 of file Module.h.

{ terminate(); }

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

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 paths */
  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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  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 323 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 313 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 201 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, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 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 186 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 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 362 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 380 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 310 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 377 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://xwiki.desy.de/xwiki/rest/p/a94f2 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);
}

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 229 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 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 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;
}

Member Data Documentation

etm

TrgEclMaster* etm

private

ETM (ecl trigger master) to generate all trigger bits of ecl trigger.

Definition at line 178 of file TRGECLModule.h.

m_2DBhabhaThresholdBWD

std::vector<double> m_2DBhabhaThresholdBWD

private

2D Bhabha Energy Threshold

Definition at line 120 of file TRGECLModule.h.

m_2DBhabhaThresholdFWD

std::vector<double> m_2DBhabhaThresholdFWD

private

2D Bhabha Energy Threshold

Definition at line 118 of file TRGECLModule.h.

m_3DBhabhaSelectionAngle

std::vector<int> m_3DBhabhaSelectionAngle

private

3D Selection Bhabha Energy Angle

Definition at line 128 of file TRGECLModule.h.

m_3DBhabhaSelectionPreScale

std::vector<int> m_3DBhabhaSelectionPreScale

private

3D Selection Bhabha preselection

Definition at line 130 of file TRGECLModule.h.

m_3DBhabhaSelectionThreshold

std::vector<double> m_3DBhabhaSelectionThreshold

private

3D Selection Bhabha Energy Threshold

Definition at line 126 of file TRGECLModule.h.

m_3DBhabhaVetoAngle

std::vector<int> m_3DBhabhaVetoAngle

private

3D Veto Bhabha Energy Angle

Definition at line 124 of file TRGECLModule.h.

m_3DBhabhaVetoInTrackThetaRegion

std::vector<int> m_3DBhabhaVetoInTrackThetaRegion

private

Theta region (low, high) of 3D Bhabha Veto InTrack.

Definition at line 150 of file TRGECLModule.h.

m_3DBhabhaVetoThreshold

std::vector<double> m_3DBhabhaVetoThreshold

private

3D Veto Bhabha Energy Threshold

Definition at line 122 of file TRGECLModule.h.

m_ADCtoEnergy

double m_ADCtoEnergy

private

conversion factor of ADC to Energy in GeV

Definition at line 114 of file TRGECLModule.h.

m_Bhabha

int m_Bhabha

private

Bhabha option.

Definition at line 96 of file TRGECLModule.h.

m_Clustering

int m_Clustering

private

Clustering option.

Definition at line 98 of file TRGECLModule.h.

m_ClusterLimit

int m_ClusterLimit

private

Cluster Limit.

Definition at line 100 of file TRGECLModule.h.

m_ConditionDB

bool m_ConditionDB

private

Flag to use Condition DB.

Definition at line 112 of file TRGECLModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_configFilename

std::string m_configFilename

private

Config.

file name.

Definition at line 68 of file TRGECLModule.h.

m_debugLevel

int m_debugLevel

private

Parameters.

Debug level.

Definition at line 65 of file TRGECLModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_ECLBurstThreshold

double m_ECLBurstThreshold

private

ECL Burst Bit Threshold.

Definition at line 146 of file TRGECLModule.h.

m_eclHitOutColName

std::string m_eclHitOutColName

protected

Output array name for Xtal.

Definition at line 78 of file TRGECLModule.h.

m_eclTCHitOutColName

std::string m_eclTCHitOutColName

protected

Output array name for TC.

Definition at line 80 of file TRGECLModule.h.

m_EventTiming

int m_EventTiming

private

Eventtiming option.

Definition at line 102 of file TRGECLModule.h.

m_EventTimingQualityThreshold

std::vector<double> m_EventTimingQualityThreshold

private

Energy threshold(low, high) of event timing quality flag (GeV)

Definition at line 148 of file TRGECLModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

m_hie12BhabhaVetoAngle

std::vector<int> m_hie12BhabhaVetoAngle

private

(hie1 and hie2) 2 cluster angle cut in CMS in degree for Bhabha veto in hie1 and hie2

Definition at line 159 of file TRGECLModule.h.

m_hie4LowCLELabCut

double m_hie4LowCLELabCut

private

(hie4) CL E cut for minimum energy cluster

Definition at line 175 of file TRGECLModule.h.

m_hitNum

int m_hitNum = 0

protected

The current number of created hits in an event.

Used to fill the DataStore ECL array.

Definition at line 84 of file TRGECLModule.h.

m_hitTCNum

int m_hitTCNum = 0

protected

TC Hit number.

Definition at line 86 of file TRGECLModule.h.

m_inColName

std::string m_inColName

protected

Input array name.

Definition at line 76 of file TRGECLModule.h.

m_lml00NCLforMinE

int m_lml00NCLforMinE

private

lml0 the number of cluster for minimum energy

Definition at line 140 of file TRGECLModule.h.

m_lml12NCLforMinE

int m_lml12NCLforMinE

private

lml12 the number of cluster for minimum energy

Definition at line 142 of file TRGECLModule.h.

m_lml13ThetaIdSelection

int m_lml13ThetaIdSelection

private

lml13 cluster ThetaID selection

Definition at line 144 of file TRGECLModule.h.

m_lmlCLECMSCut

std::vector<double> m_lmlCLECMSCut

private

Low Multiplicity cluster E cut in CMS in GeV.

Definition at line 138 of file TRGECLModule.h.

m_lmlCLELabCut

std::vector<double> m_lmlCLELabCut

private

Low Multiplicity cluster E cut in Lab in GeV.

Definition at line 136 of file TRGECLModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

m_mumuAngle

std::vector<int> m_mumuAngle

private

mumu bit Angle

Definition at line 134 of file TRGECLModule.h.

m_mumuThreshold

double m_mumuThreshold

private

mumu bit Energy Threshold

Definition at line 132 of file TRGECLModule.h.

m_name

std::string m_name

privateinherited

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

Definition at line 507 of file Module.h.

m_nEvent

int m_nEvent = 0

private

Event number.

Definition at line 94 of file TRGECLModule.h.

m_NofTopTC

int m_NofTopTC

private

of considered TC in energy weighted Timing method

Definition at line 108 of file TRGECLModule.h.

m_nRun

int m_nRun = 0

private

Run number.

Definition at line 92 of file TRGECLModule.h.

m_OverlapWindow

double m_OverlapWindow

private

Trigger decision overlap window in order to avoid boundary effect.

Definition at line 106 of file TRGECLModule.h.

m_package

std::string m_package

privateinherited

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

Definition at line 509 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 511 of file Module.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

m_SelectEvent

int m_SelectEvent

private

Event selection.

Definition at line 110 of file TRGECLModule.h.

m_taub2b2AngleCut

std::vector<int> m_taub2b2AngleCut

private

taub2b2 two Cluster angle cut (degree)

Definition at line 163 of file TRGECLModule.h.

m_taub2b2CLELabCut

std::vector<double> m_taub2b2CLELabCut

private

taub2b2 cluster energy cut(low, high) (GeV) in lab

Definition at line 165 of file TRGECLModule.h.

m_taub2b2EtotCut

double m_taub2b2EtotCut

private

taub2b2 total energy cut in Lab (GeV)

Definition at line 161 of file TRGECLModule.h.

m_taub2b3AngleCut

std::vector<int> m_taub2b3AngleCut

private

taub2b3 two Cluster angle cut in cms (degree)

Definition at line 169 of file TRGECLModule.h.

m_taub2b3CLEb2bLabCut

double m_taub2b3CLEb2bLabCut

private

taub2b3 cluster energy cut in lab for one of b2b clusters (GeV)

Definition at line 171 of file TRGECLModule.h.

m_taub2b3CLELabCut

std::vector<double> m_taub2b3CLELabCut

private

taub2b3 cluster energy cut(low and high) in lab for all clusters (GeV)

Definition at line 173 of file TRGECLModule.h.

m_taub2b3EtotCut

double m_taub2b3EtotCut

private

taub2b3 total energy cut in lab (GeV)

Definition at line 167 of file TRGECLModule.h.

m_taub2bAngleCut

std::vector<int> m_taub2bAngleCut

private

taub2b 2 cluster angle cut (degree) (dphi low, dphi high, theta_sum low, theta_sum high)

Definition at line 153 of file TRGECLModule.h.

m_taub2bCLELabCut

double m_taub2bCLELabCut

private

taub2b Cluster energy selection in Lab (GeV)

Definition at line 157 of file TRGECLModule.h.

m_taub2bEtotCut

double m_taub2bEtotCut

private

taub2b total energy (TC theta ID =1-17) (GeV)

Definition at line 155 of file TRGECLModule.h.

m_TimeWindow

double m_TimeWindow

private

Trigger decision time window.

Definition at line 104 of file TRGECLModule.h.

m_TotalEnergy

std::vector<double> m_TotalEnergy

private

Total Energy Threshold (low, high, lum) in Lab in GeV.

Definition at line 116 of file TRGECLModule.h.

m_TRGECLCluster

StoreArray<TRGECLCluster> m_TRGECLCluster

private

output for TRGECLCluster

Definition at line 185 of file TRGECLModule.h.

m_TRGECLHit

StoreArray<TRGECLHit> m_TRGECLHit

private

output for TRGECLHit

Definition at line 181 of file TRGECLModule.h.

m_TRGECLTrg

StoreArray<TRGECLTrg> m_TRGECLTrg

private

output for TRGECLTrg

Definition at line 183 of file TRGECLModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

---

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

• trg/ecl/modules/trgecl/include/TRGECLModule.h
• trg/ecl/modules/trgecl/src/TRGECLModule.cc