Belle II Software light-2406-ragdoll
|
Module to identify generated tau pair decays, using MCParticle information. More...
#include <TauDecayMarkerModule.h>
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 | |
TauDecayMarkerModule () | |
Constructor: Sets the description, the properties and the parameters of the module. | |
virtual void | initialize () override |
Initializes the module. | |
virtual void | event () override |
Method is called for each event. | |
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. | |
LogConfig & | getLogConfig () |
Returns the log system configuration. | |
void | setLogConfig (const LogConfig &logConfig) |
Set the log system configuration. | |
void | setLogLevel (int logLevel) |
Configure the log level. | |
void | setDebugLevel (int debugLevel) |
Configure the debug messaging level. | |
void | setAbortLevel (int abortLevel) |
Configure the abort log level. | |
void | setLogInfo (int logLevel, unsigned int logInfo) |
Configure the printed log information for the given level. | |
void | if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End) |
Add a condition to the module. | |
void | if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End) |
A simplified version to add a condition to the module. | |
void | if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End) |
A simplified version to set the condition of the module. | |
bool | hasCondition () const |
Returns true if at least one condition was set for the module. | |
const ModuleCondition * | getCondition () const |
Return a pointer to the first condition (or nullptr, if none was set) | |
const std::vector< ModuleCondition > & | getAllConditions () const |
Return all set conditions for this module. | |
bool | evalCondition () const |
If at least one condition was set, it is evaluated and true returned if at least one condition returns true. | |
std::shared_ptr< Path > | getConditionPath () const |
Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). | |
Module::EAfterConditionPath | getAfterConditionPath () const |
What to do after the conditional path is finished. | |
std::vector< std::shared_ptr< Path > > | getAllConditionPaths () const |
Return all condition paths currently set (no matter if the condition is true or not). | |
bool | hasProperties (unsigned int propertyFlags) const |
Returns true if all specified property flags are available in this module. | |
bool | hasUnsetForcedParams () const |
Returns true and prints error message if the module has unset parameters which the user has to set in the steering file. | |
const ModuleParamList & | getParamList () const |
Return module param list. | |
template<typename T > | |
ModuleParam< T > & | getParam (const std::string &name) const |
Returns a reference to a parameter. | |
bool | hasReturnValue () const |
Return true if this module has a valid return value set. | |
int | getReturnValue () const |
Return the return value set by this module. | |
std::shared_ptr< PathElement > | clone () const override |
Create an independent copy of this module. | |
std::shared_ptr< boost::python::list > | getParamInfoListPython () const |
Returns a python list of all parameters. | |
Static Public Member Functions | |
static void | exposePythonAPI () |
Exposes methods of the Module class to Python. | |
Protected Member Functions | |
virtual void | def_initialize () |
Wrappers to make the methods without "def_" prefix callable from Python. | |
virtual void | def_beginRun () |
Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python. | |
virtual void | def_event () |
Wrapper method for the virtual function event() that has the implementation to be used in a call from Python. | |
virtual void | def_endRun () |
This method can receive that the current run ends as a call from the Python side. | |
virtual void | def_terminate () |
Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python. | |
void | setDescription (const std::string &description) |
Sets the description of the module. | |
void | setType (const std::string &type) |
Set the module type. | |
template<typename T > | |
void | addParam (const std::string &name, T ¶mVariable, const std::string &description, const T &defaultValue) |
Adds a new parameter to the module. | |
template<typename T > | |
void | addParam (const std::string &name, T ¶mVariable, 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 ¶ms) |
Replace existing parameter list. | |
Protected Attributes | |
bool | m_printDecayInfo |
If true, prints ID and prong of each tau lepton in the event. | |
Private Member Functions | |
void | IdentifyTauPair () |
Identifies if the event is a generated tau pair. | |
int | getDecayChannelOfTau (int s=0) |
Gets the id of the decay channel. | |
int | getNumDaughterOfTauExceptGamma (int s=0, int id=0, int sign=0) |
Count the number of daughers of the generated tau except gammas. | |
int | getNumDaughterOfTau (int s=0, int id=0, int sign=0) |
Count the number of daughers of the generated tau. | |
int | getProngOfDecay (const MCParticle &mc) |
Get the prong of the generated tau decay. | |
std::list< ModulePtr > | getModules () const override |
no submodules, return empty list | |
std::string | getPathString () const override |
return the module name. | |
void | setParamPython (const std::string &name, const boost::python::object &pyObj) |
Implements a method for setting boost::python objects. | |
void | setParamPythonDict (const boost::python::dict &dictionary) |
Implements a method for reading the parameter values from a boost::python dictionary. | |
Private Attributes | |
StoreObjPtr< TauPairDecay > | m_tauDecay |
pointer to tau pair decay objects | |
StoreArray< MCParticle > | m_MCParticles |
StoreArray of MCParticles. | |
bool | tauPair |
True if the generated event is a tau pair event. | |
int | numOfTauPlus |
Number of positive tau leptons in the event. | |
int | numOfTauMinus |
Number of negative tau leptons in the event. | |
int | idOfTauPlus |
Index of the generated positive tau. | |
int | idOfTauMinus |
Index of the generated negative tau. | |
const int | finalStatePDGs [5] = { 11, 13, 211, 321, 2212 } |
PDG codes accepted as charged final state particles in generation: {e, mu, pi, K, p}. | |
Int_t | m_pmode |
ID of the decay channel of positive tau. | |
Int_t | m_mmode |
ID of the decay channel of negative tau. | |
Int_t | m_pprong |
Prong of the decay channel of positive tau. | |
Int_t | m_mprong |
Prong of the decay channel of negative tau. | |
std::string | m_name |
The name of the module, saved as a string (user-modifiable) | |
std::string | m_type |
The type of the module, saved as a string. | |
std::string | m_package |
Package this module is found in (may be empty). | |
std::string | m_description |
The description of the module. | |
unsigned int | m_propertyFlags |
The properties of the module as bitwise or (with |) of EModulePropFlags. | |
LogConfig | m_logConfig |
The log system configuration of the module. | |
ModuleParamList | m_moduleParamList |
List storing and managing all parameter of the module. | |
bool | m_hasReturnValue |
True, if the return value is set. | |
int | m_returnValue |
The return value. | |
std::vector< ModuleCondition > | m_conditions |
Module condition, only non-null if set. | |
Module to identify generated tau pair decays, using MCParticle information.
Each tau lepton decay channel is numbered following the order in the default KKMC decay table. Using this module, the channel number will be stored in the variables tauPlusMCMode
, and tauMinusMCMode
. Further details and usage can be found at TauDecayMCModes
.
Definition at line 32 of file TauDecayMarkerModule.h.
|
inherited |
Forward the EAfterConditionPath definition from the ModuleCondition.
|
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.
Constructor: Sets the description, the properties and the parameters of the module.
Definition at line 28 of file TauDecayMarkerModule.cc.
|
inlinevirtualinherited |
Called when entering a new run.
Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.
This method can be implemented by subclasses.
Reimplemented in EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, CreateFieldMapModule, ExportGeometryModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, and PyModule.
Definition at line 147 of file Module.h.
|
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.
|
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.
|
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.
|
inlineprotectedvirtualinherited |
|
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.
|
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.
|
inlinevirtualinherited |
This method is called if the current run ends.
Use this method to store information, which should be aggregated over one run.
This method can be implemented by subclasses.
Reimplemented in CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, AWESOMEBasicModule, and PyModule.
Definition at line 166 of file Module.h.
|
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().
Definition at line 96 of file Module.cc.
|
overridevirtual |
Method is called for each event.
Reimplemented from Module.
Definition at line 46 of file TauDecayMarkerModule.cc.
|
staticinherited |
Exposes methods of the Module class to Python.
Definition at line 325 of file Module.cc.
|
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.
|
inherited |
|
inlineinherited |
Return all set conditions for this module.
|
inlineinherited |
|
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.
|
private |
Gets the id of the decay channel.
Definition at line 167 of file TauDecayMarkerModule.cc.
|
inlineinherited |
Returns the description of the module.
Definition at line 202 of file Module.h.
|
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.
|
inlineinherited |
|
inlineoverrideprivatevirtualinherited |
no submodules, return empty list
Implements PathElement.
Definition at line 506 of file Module.h.
|
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.
|
private |
Count the number of daughers of the generated tau.
Definition at line 99 of file TauDecayMarkerModule.cc.
|
private |
Count the number of daughers of the generated tau except gammas.
Definition at line 132 of file TauDecayMarkerModule.cc.
|
inlineinherited |
|
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.
Definition at line 279 of file Module.cc.
|
inlineinherited |
|
overrideprivatevirtualinherited |
return the module name.
Implements PathElement.
Definition at line 192 of file Module.cc.
|
private |
Get the prong of the generated tau decay.
Definition at line 562 of file TauDecayMarkerModule.cc.
|
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.
|
inherited |
Returns the type of the module (i.e.
class name minus 'Module')
|
inlineinherited |
|
inherited |
Returns true if all specified property flags are available in this module.
propertyFlags | Ored EModulePropFlags which should be compared with the module flags. |
|
inlineinherited |
|
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.
|
private |
Identifies if the event is a generated tau pair.
Definition at line 76 of file TauDecayMarkerModule.cc.
|
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.
path | Shared pointer to the Path which will be executed if the return value is false. |
afterConditionPath | What to do after executing 'path'. |
|
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.
path | Shared pointer to the Path which will be executed if the return value is true. |
afterConditionPath | What to do after executing 'path'. |
|
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.
expression | The expression of the condition. |
path | Shared pointer to the Path which will be executed if the condition is evaluated to true. |
afterConditionPath | What to do after executing 'path'. |
|
overridevirtual |
Initializes the module.
Reimplemented from Module.
Definition at line 40 of file TauDecayMarkerModule.cc.
|
inherited |
Configure the abort log level.
Definition at line 67 of file Module.cc.
|
inherited |
Configure the debug messaging level.
Definition at line 61 of file Module.cc.
|
protectedinherited |
Sets the description of the module.
description | A description of the module. |
|
inlineinherited |
Set the log system configuration.
Definition at line 230 of file Module.h.
|
inherited |
Configure the printed log information for the given level.
logLevel | The log level (one of LogConfig::ELogLevel) |
logInfo | What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags. |
Definition at line 73 of file Module.cc.
|
inherited |
Configure the log level.
|
inlineinherited |
|
inlineprotectedinherited |
Replace existing parameter list.
Definition at line 501 of file Module.h.
|
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.
name | The unique name of the parameter. |
pyObj | The object which should be converted and stored as the parameter value. |
Definition at line 234 of file Module.cc.
|
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.
dictionary | The python dictionary from which the parameter values are read. |
Definition at line 249 of file Module.cc.
|
inherited |
Sets the flags for the module properties.
propertyFlags | bitwise OR of EModulePropFlags |
|
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.
value | The value of the return 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.
value | The value of the return value. |
|
protectedinherited |
Set the module type.
Only for use by internal modules (which don't use the normal REG_MODULE mechanism).
|
inlinevirtualinherited |
This method is called at the end of the event processing.
This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.
This method can be implemented by subclasses.
Reimplemented in CurlTaggerModule, EventKinematicsModule, FlavorTaggerInfoFillerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleKinematicFitterModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, RemoveParticlesNotInListsModule, SkimFilterModule, TreeFitterModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, MergeDataStoreModule, SubEventModule, SwitchDataStoreModule, ProgressBarModule, RandomBarrierModule, HistoManagerModule, ProfileModule, RootInputModule, RootOutputModule, SeqRootInputModule, SeqRootOutputModule, AsyncWrapper, RxModule, TxModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, ZMQTxWorkerModule, GeometryModule, MVAExpertModule, MVAMultipleExpertsModule, AWESOMEBasicModule, and PyModule.
Definition at line 176 of file Module.h.
|
private |
PDG codes accepted as charged final state particles in generation: {e, mu, pi, K, p}.
Definition at line 64 of file TauDecayMarkerModule.h.
|
private |
Index of the generated negative tau.
Definition at line 62 of file TauDecayMarkerModule.h.
|
private |
Index of the generated positive tau.
Definition at line 60 of file TauDecayMarkerModule.h.
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
private |
StoreArray of MCParticles.
Definition at line 52 of file TauDecayMarkerModule.h.
|
private |
ID of the decay channel of negative tau.
Definition at line 68 of file TauDecayMarkerModule.h.
|
privateinherited |
|
private |
Prong of the decay channel of negative tau.
Definition at line 72 of file TauDecayMarkerModule.h.
|
privateinherited |
|
privateinherited |
|
private |
ID of the decay channel of positive tau.
Definition at line 66 of file TauDecayMarkerModule.h.
|
private |
Prong of the decay channel of positive tau.
Definition at line 70 of file TauDecayMarkerModule.h.
|
protected |
If true, prints ID and prong of each tau lepton in the event.
Definition at line 87 of file TauDecayMarkerModule.h.
|
privateinherited |
|
private |
pointer to tau pair decay objects
Definition at line 50 of file TauDecayMarkerModule.h.
|
privateinherited |
|
private |
Number of negative tau leptons in the event.
Definition at line 58 of file TauDecayMarkerModule.h.
|
private |
Number of positive tau leptons in the event.
Definition at line 56 of file TauDecayMarkerModule.h.
|
private |
True if the generated event is a tau pair event.
Definition at line 54 of file TauDecayMarkerModule.h.