Belle II Software light-2406-ragdoll
VariablesToEventBasedTreeModule Class Reference

Module to calculate variables specified by the user for a given ParticleList and save them into a TTree. More...

#include <VariablesToEventBasedTreeModule.h>

Inheritance diagram for VariablesToEventBasedTreeModule:
Collaboration diagram for VariablesToEventBasedTreeModule:

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

 VariablesToEventBasedTreeModule ()
 Constructor.
 
virtual void initialize () override
 Initialises the module.
 
virtual void event () override
 Method called for each event.
 
virtual void terminate () override
 Write TTree to file, and close file if necessary.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
virtual void beginRun ()
 Called when entering a new run.
 
virtual void endRun ()
 This method is called if the current run ends.
 
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.
 
LogConfiggetLogConfig ()
 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 ModuleConditiongetCondition () 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< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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

float getInverseSamplingRateWeight ()
 Calculate inverse sampling rate weight.
 
std::list< ModulePtrgetModules () 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_particleList
 Name of particle list with reconstructed particles.
 
std::vector< std::string > m_variables
 List of variables to save.
 
std::vector< std::string > m_event_variables
 List of event variables to save.
 
unsigned int m_maxCandidates
 maximum number of candidates which is written out
 
std::string m_fileName
 Name of ROOT file for output.
 
std::string m_treeName
 Name of the TTree.
 
std::string m_fileNameSuffix
 Suffix to be appended to the output file name.
 
std::shared_ptr< TFile > m_file {nullptr}
 ROOT file for output.
 
StoreObjPtr< RootMergeable< TTree > > m_tree
 The ROOT TNtuple for output.
 
std::vector< Variable::Manager::FunctionPtrm_functions
 List of function pointers corresponding to given variables.
 
std::vector< Variable::Manager::FunctionPtrm_event_functions
 List of function pointers corresponding to given event variables.
 
int m_event { -1}
 event number
 
int m_run { -1}
 run number
 
int m_experiment { -1}
 experiment number
 
int m_production { -1}
 production ID (to distinguish MC samples)
 
unsigned int m_ncandidates { 0}
 number of candidates in this event
 
float m_weight {0.0}
 weight of this event
 
std::vector< std::vector< double > > m_valuesDouble
 Values of type double corresponding to given variables.
 
std::vector< std::vector< int > > m_valuesInt
 Values of type int corresponding to given variables.
 
std::vector< double > m_event_valuesDouble
 Values of type double corresponding to given event variables.
 
std::vector< int > m_event_valuesInt
 Values of type int corresponding to given event variables.
 
std::tuple< std::string, std::map< int, unsigned int > > m_sampling
 Tuple of variable name and a map of integer values and inverse sampling rate.
 
std::string m_sampling_name
 Variable name of sampling variable.
 
std::map< int, unsigned int > m_sampling_rates
 Inverse sampling rates.
 
const Variable::Manager::Varm_sampling_variable {nullptr}
 Variable Pointer to target variable.
 
std::map< int, unsigned long int > m_sampling_counts
 Current number of samples with this value.
 
StoreObjPtr< EventMetaDatam_eventMetaData
 event metadata (get event number etc)
 
std::string m_MCDecayString
 MC decay string to be filled.
 
StoreObjPtr< StringWrapperm_stringWrapper
 string wrapper storing the MCDecayString
 
bool m_storeEventType
 If true, the branch eventType is added.
 
StoreObjPtr< EventExtraInfom_eventExtraInfo
 pointer to EventExtraInfo

 
std::string m_eventType
 EventType to be filled.
 
bool m_ignoreCommandLineOverride
 if true, ignore override of filename
 
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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Module to calculate variables specified by the user for a given ParticleList and save them into a TTree.

The Tree is event-based, meaning that the variables of each candidate for each event are saved in an array in a branch of the Tree.

Definition at line 35 of file VariablesToEventBasedTreeModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

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.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ VariablesToEventBasedTreeModule()

Constructor.

Definition at line 34 of file VariablesToEventBasedTreeModule.cc.

34 :
36{
37 //Set module properties
38 setDescription("Calculate variables specified by the user for a given ParticleList and save them into a TTree. The Tree is event-based, meaning that the variables of each candidate for each event are saved in an array of a branch of the Tree.");
40
41 vector<string> emptylist;
42 addParam("particleList", m_particleList,
43 "Name of particle list with reconstructed particles. An empty ParticleList is not supported. Use the VariablesToNtupleModule for this use-case",
44 std::string(""));
45 addParam("variables", m_variables,
46 "List of variables (or collections) to save for each candidate. Variables are taken from Variable::Manager, and are identical to those available to e.g. ParticleSelector.",
47 emptylist);
48
49 addParam("event_variables", m_event_variables,
50 "List of variables (or collections) to save for each event. Variables are taken from Variable::Manager, and are identical to those available to e.g. ParticleSelector. Only event-based variables are allowed here.",
51 emptylist);
52
53 addParam("fileName", m_fileName, "Name of ROOT file for output. Can be overridden using the -o argument of basf2.",
54 string("VariablesToEventBasedTree.root"));
55 addParam("treeName", m_treeName, "Name of the NTuple in the saved file.", string("tree"));
56 addParam("maxCandidates", m_maxCandidates, "The maximum number of candidates in the ParticleList per entry of the Tree.", 100u);
57
58 std::tuple<std::string, std::map<int, unsigned int>> default_sampling{"", {}};
59 addParam("sampling", m_sampling,
60 "Tuple of variable name and a map of integer values and inverse sampling rate. E.g. (signal, {1: 0, 0:10}) selects all signal events and every 10th background event. Variable must be event-based.",
61 default_sampling);
62
63 addParam("fileNameSuffix", m_fileNameSuffix, "The suffix of the output ROOT file to be appended before ``.root``.",
64 string(""));
65 addParam("ignoreCommandLineOverride", m_ignoreCommandLineOverride,
66 "Ignore override of file name via command line argument -o. Useful if you have multiple output modules in one path.", false);
67
68 addParam("storeEventType", m_storeEventType,
69 "If true, the branch __eventType__ is added. The eventType information is available from MC16 on.", true);
70}
@ c_Persistent
Object is available during entire execution time.
Definition: DataStore.h:60
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Module()
Constructor.
Definition: Module.cc:30
std::vector< std::string > m_variables
List of variables to save.
unsigned int m_maxCandidates
maximum number of candidates which is written out
std::vector< std::string > m_event_variables
List of event variables to save.
std::string m_fileName
Name of ROOT file for output.
std::tuple< std::string, std::map< int, unsigned int > > m_sampling
Tuple of variable name and a map of integer values and inverse sampling rate.
bool m_storeEventType
If true, the branch eventType is added.
std::string m_particleList
Name of particle list with reconstructed particles.
bool m_ignoreCommandLineOverride
if true, ignore override of filename
StoreObjPtr< RootMergeable< TTree > > m_tree
The ROOT TNtuple for output.
std::string m_fileNameSuffix
Suffix to be appended to the output file name.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

◆ 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.

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ 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.

426{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ 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.

439{ endRun(); }
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ 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.

432{ event(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ 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.

420{ initialize(); }
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ 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.

445{ terminate(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

◆ 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.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( )
overridevirtual

Method called for each event.

Reimplemented from Module.

Definition at line 247 of file VariablesToEventBasedTreeModule.cc.

248{
249 // get counter numbers
250 m_event = m_eventMetaData->getEvent();
251 m_run = m_eventMetaData->getRun();
252 m_experiment = m_eventMetaData->getExperiment();
253 m_production = m_eventMetaData->getProduction();
254
255 if (m_stringWrapper.isValid())
256 m_MCDecayString = m_stringWrapper->getString();
257 else
258 m_MCDecayString = "";
259
260 if (m_storeEventType and m_eventExtraInfo.isValid())
261 m_eventType = m_eventExtraInfo->getEventType();
262 else
263 m_eventType = "";
264
266 m_ncandidates = particlelist->getListSize();
268 if (m_weight > 0) {
269 for (unsigned int iVar = 0; iVar < m_event_functions.size(); iVar++) {
270 if (std::holds_alternative<double>(m_event_functions[iVar](nullptr))) {
271 m_event_valuesDouble[iVar] = std::get<double>(m_event_functions[iVar](nullptr));
272 } else if (std::holds_alternative<int>(m_event_functions[iVar](nullptr))) {
273 m_event_valuesInt[iVar] = std::get<int>(m_event_functions[iVar](nullptr));
274 } else if (std::holds_alternative<bool>(m_event_functions[iVar](nullptr))) {
275 m_event_valuesInt[iVar] = std::get<bool>(m_event_functions[iVar](nullptr));
276 }
277 }
278 for (unsigned int iPart = 0; iPart < m_ncandidates; iPart++) {
279
280 if (iPart >= m_maxCandidates) {
281 B2WARNING("Maximum number of candidates exceeded in VariablesToEventBasedTree module. I will skip additional candidates");
283 break;
284 }
285
286 const Particle* particle = particlelist->getParticle(iPart);
287 for (unsigned int iVar = 0; iVar < m_functions.size(); iVar++) {
288 if (std::holds_alternative<double>(m_functions[iVar](particle))) {
289 m_valuesDouble[iVar][iPart] = std::get<double>(m_functions[iVar](particle));
290 } else if (std::holds_alternative<int>(m_functions[iVar](particle))) {
291 m_valuesInt[iVar][iPart] = std::get<int>(m_functions[iVar](particle));
292 } else if (std::holds_alternative<bool>(m_functions[iVar](particle))) {
293 m_valuesInt[iVar][iPart] = std::get<bool>(m_functions[iVar](particle));
294 }
295 }
296 }
297 m_tree->get().Fill();
298 }
299}
Class to store reconstructed particles.
Definition: Particle.h:75
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
std::vector< int > m_event_valuesInt
Values of type int corresponding to given event variables.
unsigned int m_ncandidates
number of candidates in this event
StoreObjPtr< EventMetaData > m_eventMetaData
event metadata (get event number etc)
std::vector< std::vector< double > > m_valuesDouble
Values of type double corresponding to given variables.
float getInverseSamplingRateWeight()
Calculate inverse sampling rate weight.
int m_production
production ID (to distinguish MC samples)
StoreObjPtr< StringWrapper > m_stringWrapper
string wrapper storing the MCDecayString
std::vector< Variable::Manager::FunctionPtr > m_functions
List of function pointers corresponding to given variables.
StoreObjPtr< EventExtraInfo > m_eventExtraInfo
pointer to EventExtraInfo
std::vector< std::vector< int > > m_valuesInt
Values of type int corresponding to given variables.
std::vector< double > m_event_valuesDouble
Values of type double corresponding to given event variables.
std::vector< Variable::Manager::FunctionPtr > m_event_functions
List of function pointers corresponding to given event variables.
std::string m_MCDecayString
MC decay string to be filled.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ 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.

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

◆ 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.

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ 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.

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

◆ 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.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:511

◆ 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, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getInverseSamplingRateWeight()

float getInverseSamplingRateWeight ( )
private

Calculate inverse sampling rate weight.

Event is skipped if returned weight is 0.

Definition at line 219 of file VariablesToEventBasedTreeModule.cc.

220{
221
222 if (m_sampling_variable == nullptr)
223 return 1.0;
224
225 long target = 0;
226 if (m_sampling_variable->variabletype == Variable::Manager::VariableDataType::c_double) {
227 target = std::lround(std::get<double>(m_sampling_variable->function(nullptr)));
228 } else if (m_sampling_variable->variabletype == Variable::Manager::VariableDataType::c_int) {
229 target = std::lround(std::get<int>(m_sampling_variable->function(nullptr)));
230 } else if (m_sampling_variable->variabletype == Variable::Manager::VariableDataType::c_bool) {
231 target = std::lround(std::get<bool>(m_sampling_variable->function(nullptr)));
232 }
233
234 if (m_sampling_rates.find(target) != m_sampling_rates.end() and m_sampling_rates[target] > 0) {
235 m_sampling_counts[target]++;
236 if (m_sampling_counts[target] % m_sampling_rates[target] != 0)
237 return 0;
238 else {
239 m_sampling_counts[target] = 0;
240 return m_sampling_rates[target];
241 }
242 }
243
244 return 1.0;
245}
std::map< int, unsigned int > m_sampling_rates
Inverse sampling rates.
std::map< int, unsigned long int > m_sampling_counts
Current number of samples with this value.
const Variable::Manager::Var * m_sampling_variable
Variable Pointer to target variable.
VariableDataType variabletype
data type of variable
Definition: Manager.h:133
FunctionPtr function
Pointer to function.
Definition: Manager.h:147

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{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.

506{ 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.

187{return m_name;}
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{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.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ 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.

381{ 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.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ 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.

311{ 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
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ 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.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( )
overridevirtual

Initialises the module.

Prepares variables and sets up ntuple columns.

Reimplemented from Module.

Definition at line 72 of file VariablesToEventBasedTreeModule.cc.

73{
74 m_eventMetaData.isRequired();
76
77 // override the output file name with what's been provided with the -o option
79 const std::string& outputFileArgument = Environment::Instance().getOutputFileOverride();
80 if (!outputFileArgument.empty())
81 m_fileName = outputFileArgument;
82 }
83
84 if (!m_fileNameSuffix.empty())
85 m_fileName = m_fileName.insert(m_fileName.rfind(".root"), m_fileNameSuffix);
86
87 // See if there is already a file in which case add a new tree to it ...
88 // otherwise create a new file (all handled by framework)
90 if (!m_file) {
91 B2ERROR("Could not create file \"" << m_fileName <<
92 "\". Please set a valid root output file name (\"fileName\" module parameter).");
93 return;
94 }
95
96 m_file->cd();
97
98 // check if TTree with that name already exists
99 if (m_file->Get(m_treeName.c_str())) {
100 B2FATAL("Tree with the name " << m_treeName << " already exists in the file " << m_fileName);
101 return;
102 }
103
105 // remove duplicates from list of variables but keep the previous order
106 unordered_set<string> seen;
107 auto newEnd = remove_if(m_variables.begin(), m_variables.end(), [&seen](const string & varStr) {
108 if (seen.find(varStr) != std::end(seen)) return true;
109 seen.insert(varStr);
110 return false;
111 });
112 m_variables.erase(newEnd, m_variables.end());
113
115 // remove duplicates from list of variables but keep the previous order
116 unordered_set<string> seenEventVariables;
117 auto eventVariablesEnd = remove_if(m_event_variables.begin(),
118 m_event_variables.end(), [&seenEventVariables](const string & varStr) {
119 if (seenEventVariables.find(varStr) != std::end(seenEventVariables)) return true;
120 seenEventVariables.insert(varStr);
121 return false;
122 });
123 m_event_variables.erase(eventVariablesEnd, m_event_variables.end());
124
126 m_tree.construct(m_treeName.c_str(), "");
127
128 m_valuesDouble.resize(m_variables.size());
129 m_valuesInt.resize(m_variables.size());
132
133 m_tree->get().Branch("__event__", &m_event, "__event__/i");
134 m_tree->get().Branch("__run__", &m_run, "__run__/I");
135 m_tree->get().Branch("__experiment__", &m_experiment, "__experiment__/I");
136 m_tree->get().Branch("__production__", &m_production, "__production__/I");
137 m_tree->get().Branch("__ncandidates__", &m_ncandidates, "__ncandidates__/I");
138 m_tree->get().Branch("__weight__", &m_weight, "__weight__/F");
139
140 if (m_stringWrapper.isOptional("MCDecayString"))
141 m_tree->get().Branch("__MCDecayString__", &m_MCDecayString);
142
143 if (m_storeEventType) {
144 m_tree->get().Branch("__eventType__", &m_eventType);
145 if (not m_eventExtraInfo.isOptional())
146 B2INFO("EventExtraInfo is not registered. __eventType__ will be empty. The eventType is available from MC16 on.");
147 }
148
149
150 for (unsigned int i = 0; i < m_event_variables.size(); ++i) {
151 auto varStr = m_event_variables[i];
152
153 if (Variable::isCounterVariable(varStr)) {
154 B2WARNING("The counter '" << varStr
155 << "' is handled automatically by VariablesToEventBasedTree, you don't need to add it.");
156 continue;
157 }
158
159 //also collection function pointers
161 if (!var) {
162 B2ERROR("Variable '" << varStr << "' is not available in Variable::Manager!");
163 } else {
164 if (var->variabletype == Variable::Manager::VariableDataType::c_double) {
165 m_tree->get().Branch(MakeROOTCompatible::makeROOTCompatible(varStr).c_str(), &m_event_valuesDouble[i],
166 (MakeROOTCompatible::makeROOTCompatible(varStr) + "/D").c_str());
167 } else if (var->variabletype == Variable::Manager::VariableDataType::c_int) {
168 m_tree->get().Branch(MakeROOTCompatible::makeROOTCompatible(varStr).c_str(), &m_event_valuesInt[i],
169 (MakeROOTCompatible::makeROOTCompatible(varStr) + "/I").c_str());
170 } else if (var->variabletype == Variable::Manager::VariableDataType::c_bool) {
171 m_tree->get().Branch(MakeROOTCompatible::makeROOTCompatible(varStr).c_str(), &m_event_valuesInt[i],
172 (MakeROOTCompatible::makeROOTCompatible(varStr) + "/O").c_str());
173 }
174 m_event_functions.push_back(var->function);
175 }
176 }
177
178 for (unsigned int i = 0; i < m_variables.size(); ++i) {
179 auto varStr = m_variables[i];
181 m_valuesInt[i].resize(m_maxCandidates);
182
183 //also collection function pointers
185 if (!var) {
186 B2ERROR("Variable '" << varStr << "' is not available in Variable::Manager!");
187 } else {
188 if (var->variabletype == Variable::Manager::VariableDataType::c_double) {
189 m_tree->get().Branch(MakeROOTCompatible::makeROOTCompatible(varStr).c_str(), &m_valuesDouble[i][0],
190 (MakeROOTCompatible::makeROOTCompatible(varStr) + "[__ncandidates__]/D").c_str());
191 } else if (var->variabletype == Variable::Manager::VariableDataType::c_int) {
192 m_tree->get().Branch(MakeROOTCompatible::makeROOTCompatible(varStr).c_str(), &m_valuesInt[i][0],
193 (MakeROOTCompatible::makeROOTCompatible(varStr) + "[__ncandidates__]/I").c_str());
194 } else if (var->variabletype == Variable::Manager::VariableDataType::c_bool) {
195 m_tree->get().Branch(MakeROOTCompatible::makeROOTCompatible(varStr).c_str(), &m_valuesInt[i][0],
196 (MakeROOTCompatible::makeROOTCompatible(varStr) + "[__ncandidates__]/O").c_str());
197 }
198 m_functions.push_back(var->function);
199 }
200 }
201
202 m_sampling_name = std::get<0>(m_sampling);
203 m_sampling_rates = std::get<1>(m_sampling);
204
205 if (m_sampling_name != "") {
207 if (m_sampling_variable == nullptr) {
208 B2FATAL("Couldn't find sample variable " << m_sampling_name << " via the Variable::Manager. Check the name!");
209 }
210 for (const auto& pair : m_sampling_rates)
211 m_sampling_counts[pair.first] = 0;
212 } else {
213 m_sampling_variable = nullptr;
214 }
215
216}
@ c_DontWriteOut
Object/array should be NOT saved by output modules.
Definition: DataStore.h:71
const std::string & getOutputFileOverride() const
Return overriden output file name, or "" if none was set.
Definition: Environment.h:127
static Environment & Instance()
Static method to get a reference to the Environment instance.
Definition: Environment.cc:28
static std::string makeROOTCompatible(std::string str)
Remove special characters that ROOT dislikes in branch names, e.g.
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
std::vector< std::string > resolveCollections(const std::vector< std::string > &variables)
Resolve Collection Returns variable names corresponding to the given collection or if it is not a col...
Definition: Manager.cc:179
const Var * getVariable(std::string name)
Get the variable belonging to the given key.
Definition: Manager.cc:57
static Manager & Instance()
get singleton instance.
Definition: Manager.cc:25
std::shared_ptr< TFile > m_file
ROOT file for output.
std::string m_sampling_name
Variable name of sampling variable.
std::shared_ptr< TFile > getFile(std::string, bool ignoreErrors=false)
Get a file with a specific name, if is does not exist it will be created.
static RootFileCreationManager & getInstance()
Interface for the FileManager.
A variable returning a floating-point value for a given Particle.
Definition: Manager.h:146

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ 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
nameThe name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ 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.

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

◆ terminate()

void terminate ( )
overridevirtual

Write TTree to file, and close file if necessary.

Reimplemented from Module.

Definition at line 301 of file VariablesToEventBasedTreeModule.cc.

302{
304 B2INFO("Writing TTree " << m_treeName);
305 TDirectory::TContext directoryGuard(m_file.get());
306 m_tree->write(m_file.get());
307
308 const bool writeError = m_file->TestBit(TFile::kWriteError);
309 m_file.reset();
310 if (writeError) {
311 B2FATAL("A write error occurred while saving '" << m_fileName << "', please check if enough disk space is available.");
312 }
313 }
314}
static bool isOutputProcess()
Return true if the process is an output process.
Definition: ProcHandler.cc:232
static bool parallelProcessingUsed()
Returns true if multiple processes have been spawned, false in single-core mode.
Definition: ProcHandler.cc:226

Member Data Documentation

◆ 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_event

int m_event { -1}
private

event number

Definition at line 79 of file VariablesToEventBasedTreeModule.h.

◆ m_event_functions

std::vector<Variable::Manager::FunctionPtr> m_event_functions
private

List of function pointers corresponding to given event variables.

Definition at line 78 of file VariablesToEventBasedTreeModule.h.

◆ m_event_valuesDouble

std::vector<double> m_event_valuesDouble
private

Values of type double corresponding to given event variables.

Definition at line 90 of file VariablesToEventBasedTreeModule.h.

◆ m_event_valuesInt

std::vector<int> m_event_valuesInt
private

Values of type int corresponding to given event variables.

Definition at line 92 of file VariablesToEventBasedTreeModule.h.

◆ m_event_variables

std::vector<std::string> m_event_variables
private

List of event variables to save.

Variables are taken from Variable::Manager, and are identical to those available to e.g. ParticleSelector.

Definition at line 61 of file VariablesToEventBasedTreeModule.h.

◆ m_eventExtraInfo

StoreObjPtr<EventExtraInfo> m_eventExtraInfo
private

pointer to EventExtraInfo

Definition at line 111 of file VariablesToEventBasedTreeModule.h.

◆ m_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData
private

event metadata (get event number etc)

Definition at line 105 of file VariablesToEventBasedTreeModule.h.

◆ m_eventType

std::string m_eventType
private

EventType to be filled.

Definition at line 112 of file VariablesToEventBasedTreeModule.h.

◆ m_experiment

int m_experiment { -1}
private

experiment number

Definition at line 81 of file VariablesToEventBasedTreeModule.h.

◆ m_file

std::shared_ptr<TFile> m_file {nullptr}
private

ROOT file for output.

Definition at line 72 of file VariablesToEventBasedTreeModule.h.

◆ m_fileName

std::string m_fileName
private

Name of ROOT file for output.

Definition at line 65 of file VariablesToEventBasedTreeModule.h.

◆ m_fileNameSuffix

std::string m_fileNameSuffix
private

Suffix to be appended to the output file name.

Definition at line 69 of file VariablesToEventBasedTreeModule.h.

◆ m_functions

std::vector<Variable::Manager::FunctionPtr> m_functions
private

List of function pointers corresponding to given variables.

Definition at line 76 of file VariablesToEventBasedTreeModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_ignoreCommandLineOverride

bool m_ignoreCommandLineOverride
private

if true, ignore override of filename

Definition at line 114 of file VariablesToEventBasedTreeModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_maxCandidates

unsigned int m_maxCandidates
private

maximum number of candidates which is written out

Definition at line 63 of file VariablesToEventBasedTreeModule.h.

◆ m_MCDecayString

std::string m_MCDecayString
private

MC decay string to be filled.

Definition at line 107 of file VariablesToEventBasedTreeModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 508 of file Module.h.

◆ m_ncandidates

unsigned int m_ncandidates { 0}
private

number of candidates in this event

Definition at line 83 of file VariablesToEventBasedTreeModule.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_particleList

std::string m_particleList
private

Name of particle list with reconstructed particles.

Definition at line 57 of file VariablesToEventBasedTreeModule.h.

◆ m_production

int m_production { -1}
private

production ID (to distinguish MC samples)

Definition at line 82 of file VariablesToEventBasedTreeModule.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 { -1}
private

run number

Definition at line 80 of file VariablesToEventBasedTreeModule.h.

◆ m_sampling

std::tuple<std::string, std::map<int, unsigned int> > m_sampling
private

Tuple of variable name and a map of integer values and inverse sampling rate.

E.g. (signal, {1: 0, 0:10}) selects all signal candidates and every 10th background candidate.

Definition at line 95 of file VariablesToEventBasedTreeModule.h.

◆ m_sampling_counts

std::map<int, unsigned long int> m_sampling_counts
private

Current number of samples with this value.

Definition at line 102 of file VariablesToEventBasedTreeModule.h.

◆ m_sampling_name

std::string m_sampling_name
private

Variable name of sampling variable.

Definition at line 97 of file VariablesToEventBasedTreeModule.h.

◆ m_sampling_rates

std::map<int, unsigned int> m_sampling_rates
private

Inverse sampling rates.

Definition at line 99 of file VariablesToEventBasedTreeModule.h.

◆ m_sampling_variable

const Variable::Manager::Var* m_sampling_variable {nullptr}
private

Variable Pointer to target variable.

Definition at line 101 of file VariablesToEventBasedTreeModule.h.

◆ m_storeEventType

bool m_storeEventType
private

If true, the branch eventType is added.

Definition at line 110 of file VariablesToEventBasedTreeModule.h.

◆ m_stringWrapper

StoreObjPtr<StringWrapper> m_stringWrapper
private

string wrapper storing the MCDecayString

Definition at line 108 of file VariablesToEventBasedTreeModule.h.

◆ m_tree

StoreObjPtr<RootMergeable<TTree> > m_tree
private

The ROOT TNtuple for output.

Definition at line 74 of file VariablesToEventBasedTreeModule.h.

◆ m_treeName

std::string m_treeName
private

Name of the TTree.

Definition at line 67 of file VariablesToEventBasedTreeModule.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_valuesDouble

std::vector<std::vector<double> > m_valuesDouble
private

Values of type double corresponding to given variables.

Definition at line 86 of file VariablesToEventBasedTreeModule.h.

◆ m_valuesInt

std::vector<std::vector<int> > m_valuesInt
private

Values of type int corresponding to given variables.

Definition at line 88 of file VariablesToEventBasedTreeModule.h.

◆ m_variables

std::vector<std::string> m_variables
private

List of variables to save.

Variables are taken from Variable::Manager, and are identical to those available to e.g. ParticleSelector.

Definition at line 59 of file VariablesToEventBasedTreeModule.h.

◆ m_weight

float m_weight {0.0}
private

weight of this event

Definition at line 84 of file VariablesToEventBasedTreeModule.h.


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