Belle II Software light-2406-ragdoll
MCDecayFinderModule Class Reference

Find decays in MCParticle list matching a given DecayString. More...

#include <MCDecayFinderModule.h>

Inheritance diagram for MCDecayFinderModule:
Collaboration diagram for MCDecayFinderModule:

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

 MCDecayFinderModule ()
 Constructor.
 
 ~MCDecayFinderModule ()
 Destructor.
 
virtual void initialize () override
 Initialises the module.
 
virtual void event () override
 Method called for each event.
 
DecayTree< MCParticle > * match (const MCParticle *mcp, const DecayDescriptor *d, bool isCC, int &arrayIndex)
 Search for MCParticles matching the given DecayString.
 
int write (DecayTree< MCParticle > *decay)
 Create Particle from matched MCParticle and write to Particle list.
 
void appendParticles (const MCParticle *gen, std::vector< const MCParticle * > &children)
 Recursively gather all MC daughters of gen.
 
int getNDaughtersRecursive (const DecayDescriptor *d)
 Recursively get number of daughters of given DecayDescriptor.
 
void countMaxDepthOfNest (const DecayDescriptor *d, int &depth)
 Count the max depth of nest from the given DecayDescriptor.
 
bool performMCMatching (const DecayTree< MCParticle > *decay, const DecayDescriptor *dd)
 Perform the MCMatching on the Particle built from the given DecayTree and DecayDescriptor.
 
ParticlebuildParticleFromDecayTree (const DecayTree< MCParticle > *decay, const DecayDescriptor *dd)
 Build a Particle from the given DecayTree and DecayDescriptor.
 
ParticlecreateParticleRecursively (const MCParticle *mcp, bool skipNonPrimaryDaughters)
 Create a Particle from the given MCParticle appending all daughters of the MCParticle.
 
void addUniqueParticleToList (Particle *newParticle)
 Add a new Particle into the output ParticleList if it does not exist already.
 
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.
 
virtual void terminate ()
 This method is called at the end of the event processing.
 
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

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

DecayDescriptor m_decaydescriptor
 Decay descriptor of decays to look for.
 
std::string m_strDecay
 Decay string to build the decay descriptor.
 
std::string m_listName
 Name of output particle list.
 
std::string m_antiListName
 Name of output anti-particle list.
 
bool m_isSelfConjugatedParticle
 Is the particle list for a self-conjugated particle.
 
bool m_writeOut
 toggle output particle list btw.
 
std::string m_particleStore
 name of Particle store array
 
bool m_skipNonPrimaryDaughters
 toggle skip of secondary MC daughters
 
bool m_appendAllDaughters
 if true, all daughters are appended
 
StoreObjPtr< ParticleListm_outputList
 output particle list
 
StoreObjPtr< ParticleListm_antiOutputList
 output anti-particle list
 
StoreArray< Particlem_particles
 StoreArray of Particles.
 
StoreObjPtr< ParticleExtraInfoMapm_extraInfoMap
 object pointer to ParticleExtraInfoMaps
 
StoreArray< MCParticlem_mcparticles
 StoreArray of MCParticles.
 
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

Find decays in MCParticle list matching a given DecayString.

Matched MCParticles are saved as Particle in a ParticleList. At the moment skipping of intermediate resonances is not implemented.

Definition at line 27 of file MCDecayFinderModule.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

◆ MCDecayFinderModule()

Constructor.

Definition at line 24 of file MCDecayFinderModule.cc.

25{
26 //Set module properties
27 setDescription("Find decays in MCParticle list matching a given DecayString and create Particles from them.");
28 //Parameter definition
29 addParam("decayString", m_strDecay, "DecayDescriptor string.");
30 addParam("listName", m_listName, "Name of the output particle list");
31 addParam("appendAllDaughters", m_appendAllDaughters,
32 "If true, all daughters of the matched MCParticle will be added in the order defined at the MCParticle. "
33 "If false, only the daughters described in the given decayString will be appended to the output particle.",
34 false);
35 addParam("skipNonPrimaryDaughters", m_skipNonPrimaryDaughters,
36 "If true, the secondary MC daughters will be skipped to append to the output particles. Default: true",
37 true);
38 addParam("writeOut", m_writeOut,
39 "If true, the output ParticleList will be saved by RootOutput. If false, it will be ignored when writing the file.", false);
40}
bool m_isSelfConjugatedParticle
Is the particle list for a self-conjugated particle.
std::string m_listName
Name of output particle list.
std::string m_strDecay
Decay string to build the decay descriptor.
bool m_appendAllDaughters
if true, all daughters are appended
bool m_skipNonPrimaryDaughters
toggle skip of secondary MC daughters
bool m_writeOut
toggle output particle list btw.
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Module()
Constructor.
Definition: Module.cc:30
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

◆ ~MCDecayFinderModule()

~MCDecayFinderModule ( )
inline

Destructor.

Definition at line 50 of file MCDecayFinderModule.h.

50{}

Member Function Documentation

◆ addUniqueParticleToList()

void addUniqueParticleToList ( Particle newParticle)

Add a new Particle into the output ParticleList if it does not exist already.

Definition at line 391 of file MCDecayFinderModule.cc.

392{
393 for (auto& existingParticle : *m_outputList) {
394 if (existingParticle.isCopyOf(newParticle))
395 return;
396 }
397
398 m_outputList->addParticle(newParticle);
399}
StoreObjPtr< ParticleList > m_outputList
output particle list

◆ appendParticles()

void appendParticles ( const MCParticle gen,
std::vector< const MCParticle * > &  children 
)

Recursively gather all MC daughters of gen.

Definition at line 260 of file MCDecayFinderModule.cc.

261{
262 if (MCMatching::isFSP(gen->getPDG())) {
263 if (gen->getPDG() != Const::Kshort.getPDGCode()) // exception for K_S0
264 return; //stop at the bottom of the MC decay tree (ignore secondaries)
265
266 // Currently the decay of "FSP" cannot be specified except for K_S0,
267 // e.g. photon-conversion: gamma -> e+ e-, decay-in-flight: K+ -> mu+ nu_mu
268 }
269
270 const vector<MCParticle*>& genDaughters = gen->getDaughters();
271 for (auto daug : genDaughters) {
272 children.push_back(daug);
273 appendParticles(daug, children);
274 }
275}
int getPDGCode() const
PDG code.
Definition: Const.h:473
static const ParticleType Kshort
K^0_S particle.
Definition: Const.h:677
void appendParticles(const MCParticle *gen, std::vector< const MCParticle * > &children)
Recursively gather all MC daughters of gen.
std::vector< Belle2::MCParticle * > getDaughters() const
Get vector of all daughter particles, empty vector if none.
Definition: MCParticle.cc:52
int getPDG() const
Return PDG code of particle.
Definition: MCParticle.h:112
static bool isFSP(int pdg)
Returns true if given PDG code indicates a FSP.
Definition: MCMatching.cc:448

◆ beginRun()

◆ buildParticleFromDecayTree()

Particle * buildParticleFromDecayTree ( const DecayTree< MCParticle > *  decay,
const DecayDescriptor dd 
)

Build a Particle from the given DecayTree and DecayDescriptor.

Definition at line 314 of file MCDecayFinderModule.cc.

315{
316 const int nDaughters = dd->getNDaughters();
317 const vector<DecayTree<MCParticle>*> decayDaughters = decay->getDaughters();
318
319 // sanity check
320 if ((int)decayDaughters.size() != nDaughters) {
321 B2ERROR("MCDecayFinderModule::buildParticleFromDecayTree Inconsistency on the number daughters between DecayTree and DecayDescriptor");
322 return nullptr;
323 }
324
325 // build particle from head of DecayTree
326 MCParticle* mcp = decay->getObj();
327 Particle* newParticle = m_particles.appendNew(mcp);
328 newParticle->addRelationTo(mcp);
329
330 int property = dd->getProperty();
331 property |= dd->getMother()->getProperty();
332 newParticle->setProperty(property);
333
334 // if nDaughters is 0 but mcp is not FSP, all primary daughters are appended for mcmatching
335 if (nDaughters == 0 and not MCMatching::isFSP(mcp->getPDG())) {
336 for (auto mcDaughter : mcp->getDaughters()) {
337 if (mcDaughter->hasStatus(MCParticle::c_PrimaryParticle) or
338 (abs(mcp->getPDG()) == Const::Lambda.getPDGCode())) { // Lambda's daughters are not primary but it is not FSP at mcmatching
339
340 auto partDaughter = createParticleRecursively(mcDaughter, true); // for mcmatching non-primary should be omitted
341 newParticle->appendDaughter(partDaughter, false);
342 }
343 }
344 }
345
346
347 // Daughters of DecayTree were filled in ascending order of depth of nest.
348 std::vector<std::pair<int, int>> daughtersDepthMapD; // first: -1*depth, second:iDD
349 for (int iDD = 0; iDD < nDaughters; iDD++) {
350 auto daugD = dd->getDaughter(iDD);
351
352 int depth = 1; // to be incremented
353 countMaxDepthOfNest(daugD, depth);
354 daughtersDepthMapD.push_back({-1 * depth, iDD});
355 }
356 std::sort(daughtersDepthMapD.begin(), daughtersDepthMapD.end());
357
358 for (int iDD = 0; iDD < nDaughters; iDD++) {
359
360 int index_decayDaughter = 0;
361 for (auto pair : daughtersDepthMapD) {
362 if (pair.second == iDD) break;
363 index_decayDaughter++;
364 }
365
366 Particle* partDaughter = buildParticleFromDecayTree(decayDaughters[index_decayDaughter], dd->getDaughter(iDD));
367
368 int daughterProperty = dd->getDaughter(iDD)->getMother()->getProperty();
369 newParticle->appendDaughter(partDaughter, false, daughterProperty);
370 }
371
372 return newParticle;
373}
static const ParticleType Lambda
Lambda particle.
Definition: Const.h:679
int getProperty() const
return property of the particle.
const DecayDescriptor * getDaughter(int i) const
return i-th daughter (0 based index).
int getNDaughters() const
return number of direct daughters.
int getProperty() const
return property of the particle.
const DecayDescriptorParticle * getMother() const
return mother.
Particle * createParticleRecursively(const MCParticle *mcp, bool skipNonPrimaryDaughters)
Create a Particle from the given MCParticle appending all daughters of the MCParticle.
Particle * buildParticleFromDecayTree(const DecayTree< MCParticle > *decay, const DecayDescriptor *dd)
Build a Particle from the given DecayTree and DecayDescriptor.
StoreArray< Particle > m_particles
StoreArray of Particles.
void countMaxDepthOfNest(const DecayDescriptor *d, int &depth)
Count the max depth of nest from the given DecayDescriptor.
A Class to store the Monte Carlo particle information.
Definition: MCParticle.h:32
@ c_PrimaryParticle
bit 0: Particle is primary particle.
Definition: MCParticle.h:47
Class to store reconstructed particles.
Definition: Particle.h:75
void setProperty(const int properties)
sets m_properties
Definition: Particle.h:374
void appendDaughter(const Particle *daughter, const bool updateType=true, const int daughterProperty=c_Ordinary)
Appends index of daughter to daughters index array.
Definition: Particle.cc:676
void addRelationTo(const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
Add a relation from this object to another object (with caching).
T * appendNew()
Construct a new T object at the end of the array.
Definition: StoreArray.h:246
T * getObj() const
Return the decaying object itself, e.g.
Definition: DecayTree.h:65
std::vector< DecayTree< T > * > getDaughters() const
Return list of decay daughters.
Definition: DecayTree.h:58

◆ 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

◆ countMaxDepthOfNest()

void countMaxDepthOfNest ( const DecayDescriptor d,
int &  depth 
)

Count the max depth of nest from the given DecayDescriptor.

Definition at line 292 of file MCDecayFinderModule.cc.

293{
294 int maxDepth = 0;
295 for (int i = 0; i < d->getNDaughters(); i++) {
296 int tmp_depth = 1;
297 countMaxDepthOfNest(d->getDaughter(i), tmp_depth);
298
299 if (tmp_depth > maxDepth)
300 maxDepth = tmp_depth;
301 }
302
303 depth += maxDepth;
304}

◆ createParticleRecursively()

Particle * createParticleRecursively ( const MCParticle mcp,
bool  skipNonPrimaryDaughters 
)

Create a Particle from the given MCParticle appending all daughters of the MCParticle.

Definition at line 375 of file MCDecayFinderModule.cc.

376{
377 Particle* newParticle = m_particles.appendNew(mcp);
378 newParticle->addRelationTo(mcp);
379
380 for (auto mcDaughter : mcp->getDaughters()) {
381 if (mcDaughter->hasStatus(MCParticle::c_PrimaryParticle) or not skipNonPrimaryDaughters
382 or abs(mcp->getPDG()) == Const::Lambda.getPDGCode()) { // Lambda's daughters are not primary but it is not FSP at mcmatching
383 auto partDaughter = createParticleRecursively(mcDaughter, skipNonPrimaryDaughters);
384 newParticle->appendDaughter(partDaughter, false);
385 }
386 }
387
388 return newParticle;
389}

◆ 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 69 of file MCDecayFinderModule.cc.

70{
71 if (not m_extraInfoMap)
72 m_extraInfoMap.create();
73
74 // Create output particle list
75 const int motherPDG = m_decaydescriptor.getMother()->getPDGCode();
76 m_outputList.create();
77 m_outputList->initialize(motherPDG, m_listName);
78
80 m_antiOutputList.create();
81 m_antiOutputList->initialize(-1 * motherPDG, m_antiListName);
82 m_outputList->bindAntiParticleList(*(m_antiOutputList));
83 }
84
85 // loop over all MCParticles
86 int nMCParticles = m_mcparticles.getEntries();
87 for (int i = 0; i < nMCParticles; i++) {
88
89 if (abs(m_mcparticles[i]->getPDG()) != abs(motherPDG))
90 continue;
91
92 for (int iCC = 0; iCC < 2; iCC++) {
93 int arrayIndex = -1;
94 std::unique_ptr<DecayTree<MCParticle>> decay(match(m_mcparticles[i], m_decaydescriptor, iCC, arrayIndex));
95
96 MCParticle* mcp = decay->getObj();
97 if (!mcp) continue;
98
99 B2DEBUG(19, "Match!");
100
102 // if m_appendAllDaughters is True, create a new Particle appending all daughters
103 Particle* newParticle = m_particles.appendNew(mcp);
104 newParticle->addRelationTo(mcp);
105
106 for (auto mcDaughter : mcp->getDaughters()) {
107 if (mcDaughter->hasStatus(MCParticle::c_PrimaryParticle) or not m_skipNonPrimaryDaughters
108 or abs(mcp->getPDG()) == Const::Lambda.getPDGCode()) { // Lambda's daughters are not primary but it is not FSP at mcmatching
109
110 auto partDaughter = createParticleRecursively(mcDaughter, m_skipNonPrimaryDaughters);
111 newParticle->appendDaughter(partDaughter, /* updateType = */ false); // particleSource remain c_MCParticle
112 }
113 }
114 addUniqueParticleToList(newParticle);
115
116 } else if (arrayIndex == -1) {
117 // Particle is not created when no daughter is described in decayString
118 Particle* newParticle = m_particles.appendNew(mcp);
119 newParticle->addRelationTo(mcp);
120
121 addUniqueParticleToList(newParticle);
122 } else {
123 // Particle is already created
125
126 }
127
128 }
129 }
130}
int getPDGCode() const
Return PDG code.
std::string m_antiListName
Name of output anti-particle list.
DecayTree< MCParticle > * match(const MCParticle *mcp, const DecayDescriptor *d, bool isCC, int &arrayIndex)
Search for MCParticles matching the given DecayString.
StoreArray< MCParticle > m_mcparticles
StoreArray of MCParticles.
void addUniqueParticleToList(Particle *newParticle)
Add a new Particle into the output ParticleList if it does not exist already.
StoreObjPtr< ParticleList > m_antiOutputList
output anti-particle list
DecayDescriptor m_decaydescriptor
Decay descriptor of decays to look for.
StoreObjPtr< ParticleExtraInfoMap > m_extraInfoMap
object pointer to ParticleExtraInfoMaps

◆ 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 setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
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 }

◆ 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

◆ getNDaughtersRecursive()

int getNDaughtersRecursive ( const DecayDescriptor d)

Recursively get number of daughters of given DecayDescriptor.

Definition at line 277 of file MCDecayFinderModule.cc.

278{
279 const int nDaughter = d->getNDaughters();
280 if (nDaughter == 0) return nDaughter;
281
282 int nDaughterRecursive = nDaughter;
283 for (int iDaug = 0; iDaug < nDaughter; iDaug++) {
284 const DecayDescriptor* dDaug = d->getDaughter(iDaug);
285
286 nDaughterRecursive += getNDaughtersRecursive(dDaug);
287 }
288
289 return nDaughterRecursive;
290}
The DecayDescriptor stores information about a decay tree or parts of a decay tree.
int getNDaughtersRecursive(const DecayDescriptor *d)
Recursively get number of daughters of given DecayDescriptor.

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

Reimplemented from Module.

Definition at line 42 of file MCDecayFinderModule.cc.

43{
44 bool valid = m_decaydescriptor.init(m_strDecay);
45 if (!valid)
46 B2ERROR("Invalid input DecayString: " << m_strDecay);
47
50
51 B2DEBUG(10, "particle list name: " << m_listName);
52 B2DEBUG(10, "antiparticle list name: " << m_antiListName);
53
54
55 // Register output particle list, particle store and relation to MCParticles
56 m_mcparticles.isRequired();
57
59 m_outputList.registerInDataStore(m_listName, flags);
61 m_extraInfoMap.registerInDataStore();
63
65 m_antiOutputList.registerInDataStore(m_antiListName, flags);
66 }
67}
EStoreFlags
Flags describing behaviours of objects etc.
Definition: DataStore.h:69
@ c_WriteOut
Object/array should be saved by output modules.
Definition: DataStore.h:70
@ c_DontWriteOut
Object/array should be NOT saved by output modules.
Definition: DataStore.h:71
@ c_Event
Different object in each event, all objects/arrays are invalidated after event() function has been ca...
Definition: DataStore.h:59
bool init(const std::string &str)
Initialise the DecayDescriptor from given string.
bool registerInDataStore(DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut)
Register the object/array in the DataStore.
bool registerRelationTo(const StoreArray< TO > &toArray, DataStore::EDurability durability=DataStore::c_Event, DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut, const std::string &namedRelation="") const
Register a relation to the given StoreArray.
Definition: StoreArray.h:140
std::string antiParticleListName(const std::string &listName)
Returns name of anti-particle-list corresponding to listName.

◆ match()

DecayTree< MCParticle > * match ( const MCParticle mcp,
const DecayDescriptor d,
bool  isCC,
int &  arrayIndex 
)

Search for MCParticles matching the given DecayString.

Definition at line 132 of file MCDecayFinderModule.cc.

133{
134 // Suffixes used in this method:
135 // P = Information from MCParticle
136 // D = Information from DecayDescriptor
137
138 // Create empty DecayTree as return value
139 auto* decay = new DecayTree<MCParticle>();
140
141 // Load PDG codes and compare,
142 const int iPDGD = d->getMother()->getPDGCode();
143 const int iPDGP = mcp->getPDG();
144 const bool isSelfConjugatedParticle = !(EvtPDLUtil::hasAntiParticle(iPDGD));
145
146 if (!isCC && iPDGD != iPDGP) return decay;
147 else if (isCC && (iPDGD != -iPDGP && !isSelfConjugatedParticle)) return decay;
148 else if (isCC && (iPDGD != iPDGP && isSelfConjugatedParticle)) return decay;
149 B2DEBUG(19, "PDG code matched: " << iPDGP);
150
151 // Get number of daughters in the decay descriptor.
152 // If no daughters in decay descriptor, no more checks needed.
153 const int nDaughtersD = d->getNDaughters();
154 if (nDaughtersD == 0) {
155 B2DEBUG(19, "DecayDescriptor has no Daughters, everything OK!");
156 decay->setObj(const_cast<MCParticle*>(mcp));
157 return decay; // arrayIndex is not set
158 }
159
160 // Get daughters of MCParticle
161 vector<const MCParticle*> daughtersP;
162 int nDaughtersRecursiveD = 0;
163 if (d->isIgnoreIntermediate()) {
164 appendParticles(mcp, daughtersP);
165 // Get number of daughter recursively if missing intermediate states are accepted.
166 nDaughtersRecursiveD = getNDaughtersRecursive(d);
167 } else {
168 const vector<MCParticle*>& tmpDaughtersP = mcp->getDaughters();
169 for (auto daug : tmpDaughtersP)
170 daughtersP.push_back(daug);
171 nDaughtersRecursiveD = nDaughtersD;
172 }
173
174 // The MCParticle must have at least as many daughters as the decaydescriptor
175 if (nDaughtersRecursiveD > (int)daughtersP.size()) {
176 B2DEBUG(10, "DecayDescriptor has more daughters than MCParticle!");
177 return decay;
178 }
179
180 // nested daughter has to be called at first to avoid overlap
181 std::vector<std::pair<int, int>> daughtersDepthMapD; // first: -1*depth, second:iDD
182 for (int iDD = 0; iDD < nDaughtersD; iDD++) {
183 int depth = 1; // to be incremented
184 countMaxDepthOfNest(d->getDaughter(iDD), depth);
185
186 daughtersDepthMapD.push_back({-1 * depth, iDD});
187 }
188 // sorted in ascending order = the deepest nested daughter will come first
189 std::sort(daughtersDepthMapD.begin(), daughtersDepthMapD.end());
190
191 // loop over all daughters of the decay descriptor
192 for (auto pair : daughtersDepthMapD) {
193 int iDD = pair.second;
194 // check if there is an unmatched particle daughter matching this decay descriptor daughter
195 bool isMatchDaughter = false;
196 auto itDP = daughtersP.begin();
197 while (itDP != daughtersP.end()) {
198 const MCParticle* daugP = *itDP;
199
200 int tmp; // array index of a created daughter Particle (not to be used)
201 DecayTree<MCParticle>* daughter = match(daugP, d->getDaughter(iDD), isCC, tmp);
202 if (!daughter->getObj()) {
203 ++itDP;
204 delete daughter;
205 continue;
206 }
207 // Matching daughter found, remove it from list of unmatched particle daughters
208 decay->append(daughter);
209 isMatchDaughter = true;
210 itDP = daughtersP.erase(itDP);
211
212 // if the matched daughter has daughters, they are also removed from the list
213 if (d->isIgnoreIntermediate() and d->getDaughter(iDD)->getNDaughters() != 0) {
214 vector<const MCParticle*> grandDaughtersP;
215 if (d->getDaughter(iDD)->isIgnoreIntermediate()) {
216 appendParticles(daugP, grandDaughtersP);
217 } else {
218 const vector<MCParticle*>& tmpGrandDaughtersP = daugP->getDaughters();
219 for (auto grandDaugP : tmpGrandDaughtersP)
220 grandDaughtersP.push_back(grandDaugP);
221 }
222
223 for (auto grandDaugP : grandDaughtersP) {
224 auto jtDP = itDP;
225 while (jtDP != daughtersP.end()) {
226 const MCParticle* daugP_j = *jtDP;
227 // if a grand-daughter matched a daughter, remove it.
228 if (grandDaugP == daugP_j)
229 jtDP = daughtersP.erase(jtDP);
230 else
231 ++jtDP;
232 }
233 }
234 }
235
236 break;
237 }
238 if (!isMatchDaughter) {
239 return decay;
240 }
241 }
242
243 // Ok, it seems that everything from the DecayDescriptor could be matched.
244 decay->setObj(const_cast<MCParticle*>(mcp));
245
246 Particle* newParticle = buildParticleFromDecayTree(decay, d);
247 int status = MCMatching::getMCErrors(newParticle);
248 if (status != MCMatching::c_Correct) { // isSignal != 1
249 B2DEBUG(10, "isSignal is not True. There was an additional particle left.");
250 decay->setObj(nullptr);
251 return decay;
252 }
253
254 arrayIndex = newParticle->getArrayIndex();
255
256 B2DEBUG(19, "Match found!");
257 return decay;
258}
bool isIgnoreIntermediate() const
Check if intermediate resonances/particles shall be ignored.
This is a helper class for the MCDecayFinderModule.
Definition: DecayTree.h:20
int getArrayIndex() const
Returns this object's array index (in StoreArray), or -1 if not found.
bool hasAntiParticle(int pdgCode)
Checks if the particle with given pdg code has an anti-particle or not.
Definition: EvtPDLUtil.cc:12
@ c_Correct
This Particle and all its daughters are perfectly reconstructed.
Definition: MCMatching.h:34
static int getMCErrors(const Belle2::Particle *particle, const Belle2::MCParticle *mcParticle=nullptr)
Returns quality indicator of the match as a bit pattern where the individual bits indicate the the ty...
Definition: MCMatching.cc:282

◆ performMCMatching()

bool performMCMatching ( const DecayTree< MCParticle > *  decay,
const DecayDescriptor dd 
)

Perform the MCMatching on the Particle built from the given DecayTree and DecayDescriptor.

Definition at line 306 of file MCDecayFinderModule.cc.

307{
308 auto newParticle = buildParticleFromDecayTree(decay, dd);
309 int status = MCMatching::getMCErrors(newParticle);
310 return (status == MCMatching::c_Correct);
311}

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

Member Data Documentation

◆ m_antiListName

std::string m_antiListName
private

Name of output anti-particle list.

Definition at line 33 of file MCDecayFinderModule.h.

◆ m_antiOutputList

StoreObjPtr<ParticleList> m_antiOutputList
private

output anti-particle list

Definition at line 41 of file MCDecayFinderModule.h.

◆ m_appendAllDaughters

bool m_appendAllDaughters
private

if true, all daughters are appended

Definition at line 38 of file MCDecayFinderModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_decaydescriptor

DecayDescriptor m_decaydescriptor
private

Decay descriptor of decays to look for.

Definition at line 30 of file MCDecayFinderModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_extraInfoMap

StoreObjPtr<ParticleExtraInfoMap> m_extraInfoMap
private

object pointer to ParticleExtraInfoMaps

Definition at line 43 of file MCDecayFinderModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_isSelfConjugatedParticle

bool m_isSelfConjugatedParticle
private

Is the particle list for a self-conjugated particle.

Definition at line 34 of file MCDecayFinderModule.h.

◆ m_listName

std::string m_listName
private

Name of output particle list.

Definition at line 32 of file MCDecayFinderModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mcparticles

StoreArray<MCParticle> m_mcparticles
private

StoreArray of MCParticles.

Definition at line 44 of file MCDecayFinderModule.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_outputList

StoreObjPtr<ParticleList> m_outputList
private

output particle list

Definition at line 40 of file MCDecayFinderModule.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_particles

StoreArray<Particle> m_particles
private

StoreArray of Particles.

Definition at line 42 of file MCDecayFinderModule.h.

◆ m_particleStore

std::string m_particleStore
private

name of Particle store array

Definition at line 36 of file MCDecayFinderModule.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_skipNonPrimaryDaughters

bool m_skipNonPrimaryDaughters
private

toggle skip of secondary MC daughters

Definition at line 37 of file MCDecayFinderModule.h.

◆ m_strDecay

std::string m_strDecay
private

Decay string to build the decay descriptor.

Definition at line 31 of file MCDecayFinderModule.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_writeOut

bool m_writeOut
private

toggle output particle list btw.

transient/writeOut

Definition at line 35 of file MCDecayFinderModule.h.


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