Belle II Software development
TauDecayModeModule Class Reference

Module to classify tau decay events according to a mapping given by the user or with a default mapping based on the TauolaBelle2 decay list. More...

#include <TauDecayModeModule.h>

Inheritance diagram for TauDecayModeModule:
Module PathElement

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

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

Protected Attributes

std::string m_printmode
 Parameter passed by the user to indicate the information to be printed.
 

Private Member Functions

void AnalyzeTauPairEvent ()
 Analyze a generated tau pair event.
 
int TauolaBelle2DecayMode (const std::string &s, int chg)
 Classifies the decays of the event and assigns a decay mode.
 
int getRecursiveMotherCharge (const MCParticle *mc)
 Identifies particles coming from tau decays.
 
void IdentifyTauPair ()
 Identifies if the event is a generated tau pair.
 
int getProngOfDecay (const MCParticle &mc)
 Identifies the number of charged final state particles in the decay.
 
double getEgstar (const std::vector< int > &vec_radgam, const MCParticle &mc)
 Energy of the radiative photon in tau rest frame.
 
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

StoreObjPtr< TauPairDecaym_tauDecay
 pointer to tau pair decay objects
 
StoreObjPtr< EventMetaDatam_event_metadata
 event number
 
int m_taum_no
 number of tau- unclassified events
 
int m_taup_no
 number of tau+ unclassified events
 
StoreArray< MCParticleMCParticles
 StoreArray of MCParticles.
 
std::map< std::string, int > mode_decay_minus
 Mapping for tau- decays.
 
std::map< std::string, int > mode_decay_plus
 Mapping for tau+ decays.
 
std::string m_tauminusdecaymode
 Variable name for the decay mode of the tau-.
 
std::string m_tauplusdecaymode
 Variable name for the decay mode of the tau+.
 
Int_t m_mmode
 ID of the decay channel of tau-.
 
Int_t m_pmode
 ID of the decay channel of tau+.
 
Int_t m_mprong
 Prong of the decay channel of tau-.
 
Int_t m_pprong
 Prong of the decay channel of tau+.
 
double m_megstar
 Energy of radiative photon from tau-.
 
double m_pegstar
 Energy of radiative photon from tau+.
 
bool tauPair
 Boolean variable used to identify tau event.
 
int numOfTauMinus
 Number of tau- in the event.
 
int numOfTauPlus
 Number of tau+ in the event.
 
int idOfTauMinus
 Index of the generated tau-.
 
int idOfTauPlus
 Index of the generated tau+.
 
std::string m_file_minus
 Alternative mapping for tau-.
 
std::string m_file_plus
 Alternative mapping for tau+.
 
bool m_isEtaPizPizPizFromTauMinus
 Flag for eta->pi0pi0pi0 decays from tau-.
 
bool m_isEtaPizPizPizFromTauPlus
 Flag for eta->pi0pi0pi0 decays from tau+.
 
bool m_isOmegaPimPipFromTauMinus
 Flag for omega->pi-pi+ decays from tau-.
 
bool m_isOmegaPimPipFromTauPlus
 Flag for omega->pi-pi+ decays from tau+.
 
std::vector< int > vec_nut
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_anut
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_numu
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_anumu
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_nue
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_anue
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_em
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_ep
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_mum
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_mup
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_pim
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_pip
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_km
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_kp
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_apro
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_pro
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_pi0
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_k0s
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_k0l
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_eta
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_omega
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_etapr
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_phi
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_rhom
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_rhop
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_rho0
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_kstarm
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_kstarp
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_kstar0
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_kstar0_br
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a1m
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a1p
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a00_980
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a0m_980
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a0p_980
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a00_1450
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a0m_1450
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_a0p_1450
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_b1m
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_b1p
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_f1
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_f0
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_lambda
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_lmb_br
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_alpha
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_gam
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_radgam_taum
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_radgam_taup
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_dau_tauminus
 Variable name of the vector where particles identified in the event are stored.
 
std::vector< int > vec_dau_tauplus
 Variable name of the vector where particles identified in the event are stored.
 
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.
 

Static Private Attributes

static constexpr std::array< int, 5 > finalStatePDGs = { 11, 13, 211, 321, 2212 }
 PDG codes accepted as charged final state particles in generation: {e, mu, pi, K, p}.
 
static constexpr std::array< int, 3 > Neutrinos = { 12, 14, 16 }
 PDG codes of neutrinos in final state particles in generation: {nu_e, nu_mu, mu_tau}.
 
static constexpr std::array< int, 46 > OrderedList
 PDG codes of ORDERED particles.
 

Detailed Description

Module to classify tau decay events according to a mapping given by the user or with a default mapping based on the TauolaBelle2 decay list.

Definition at line 28 of file TauDecayModeModule.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,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
@ c_Output
Output Process.
Definition ProcHelper.h:19
@ c_Input
Input Process.
Definition ProcHelper.h:17

Constructor & Destructor Documentation

◆ TauDecayModeModule()

Constructor: Sets the description, the properties and the parameters of the module.

Definition at line 59 of file TauDecayModeModule.cc.

59 : Module(), m_taum_no(0), m_taup_no(0), m_mmode(-2), m_pmode(-2),
60 m_mprong(0), m_pprong(0), m_megstar(0), m_pegstar(0),
64{
65 // Set module properties
66 setDescription("Module to identify generated tau pair decays, using MCParticle information.\n"
67 "By default, each tau decay is numbered as TauolaBelle2DecayMode [Ref: BELLE2-NOTE-PH-2020-055]");
68 //Parameter definition
69 addParam("printmode", m_printmode, "Printout more information from each event", std::string("default"));
70 addParam("file_minus", m_file_minus, "Path for an alternative mapping for tau- decays", std::string(""));
71 addParam("file_plus", m_file_plus, "Path for an alternative mapping for tau+ decays", std::string(""));
72}
void setDescription(const std::string &description)
Sets the description of the module.
Definition Module.cc:214
Module()
Constructor.
Definition Module.cc:30
Int_t m_mprong
Prong of the decay channel of tau-.
int numOfTauPlus
Number of tau+ in the event.
Int_t m_pprong
Prong of the decay channel of tau+.
std::string m_file_plus
Alternative mapping for tau+.
bool m_isEtaPizPizPizFromTauMinus
Flag for eta->pi0pi0pi0 decays from tau-.
double m_pegstar
Energy of radiative photon from tau+.
Int_t m_mmode
ID of the decay channel of tau-.
bool m_isOmegaPimPipFromTauMinus
Flag for omega->pi-pi+ decays from tau-.
int m_taum_no
number of tau- unclassified events
bool m_isOmegaPimPipFromTauPlus
Flag for omega->pi-pi+ decays from tau+.
bool tauPair
Boolean variable used to identify tau event.
int idOfTauMinus
Index of the generated tau-.
Int_t m_pmode
ID of the decay channel of tau+.
int numOfTauMinus
Number of tau- in the event.
int idOfTauPlus
Index of the generated tau+.
std::string m_printmode
Parameter passed by the user to indicate the information to be printed.
bool m_isEtaPizPizPizFromTauPlus
Flag for eta->pi0pi0pi0 decays from tau+.
double m_megstar
Energy of radiative photon from tau-.
std::string m_file_minus
Alternative mapping for tau-.
int m_taup_no
number of tau+ unclassified events
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:559

Member Function Documentation

◆ AnalyzeTauPairEvent()

void AnalyzeTauPairEvent ( )
private

Analyze a generated tau pair event.

Definition at line 146 of file TauDecayModeModule.cc.

147{
148 // Clear local vectors
149 vec_nut.clear();
150 vec_anut.clear();
151 vec_numu.clear();
152 vec_anumu.clear();
153 vec_nue.clear();
154 vec_anue.clear();
155 vec_em.clear();
156 vec_ep.clear();
157 vec_mum.clear();
158 vec_mup.clear();
159 vec_pim.clear();
160 vec_pip.clear();
161 vec_km.clear();
162 vec_kp.clear();
163 vec_apro.clear();
164 vec_pro.clear();
165 vec_pi0.clear();
166 vec_k0s.clear();
167 vec_k0l.clear();
168 vec_eta.clear();
169 vec_omega.clear();
170 vec_etapr.clear();
171 vec_phi.clear();
172 vec_rhom.clear();
173 vec_rhop.clear();
174 vec_rho0.clear();
175 vec_kstarm.clear();
176 vec_kstarp.clear();
177 vec_kstar0.clear();
178 vec_kstar0_br.clear();
179 vec_a1m.clear();
180 vec_a1p.clear();
181 vec_a00_980.clear();
182 vec_a0m_980.clear();
183 vec_a0p_980.clear();
184 vec_a00_1450.clear();
185 vec_a0m_1450.clear();
186 vec_a0p_1450.clear();
187 vec_b1m.clear();
188 vec_b1p.clear();
189 vec_f1.clear();
190 vec_f0.clear();
191 vec_lambda.clear();
192 vec_lmb_br.clear();
193 vec_alpha.clear();
194 vec_gam.clear();
195 vec_radgam_taum.clear();
196 vec_radgam_taup.clear();
197 //
198 map<int, std::vector<int>> map_vec;
199 //
200 map_vec[11] = vec_em;
201 map_vec[-11] = vec_ep;
202 map_vec[12] = vec_nue;
203 map_vec[-12] = vec_anue;
204 map_vec[13] = vec_mum;
205 map_vec[-13] = vec_mup;
206 map_vec[14] = vec_numu;
207 map_vec[-14] = vec_anumu;
208 map_vec[16] = vec_nut;
209 map_vec[-16] = vec_anut;
210 map_vec[-211] = vec_pim;
211 map_vec[211] = vec_pip;
212 map_vec[-321] = vec_km;
213 map_vec[321] = vec_kp;
214 map_vec[-2212] = vec_apro;
215 map_vec[2212] = vec_pro;
216 map_vec[111] = vec_pi0;
217 map_vec[310] = vec_k0s;
218 map_vec[130] = vec_k0l;
219 map_vec[221] = vec_eta;
220 map_vec[223] = vec_omega;
221 map_vec[331] = vec_etapr;
222 map_vec[333] = vec_phi;
223 map_vec[-213] = vec_rhom;
224 map_vec[213] = vec_rhop;
225 map_vec[113] = vec_rho0;
226 map_vec[-323] = vec_kstarm;
227 map_vec[323] = vec_kstarp;
228 map_vec[313] = vec_kstar0;
229 map_vec[-313] = vec_kstar0_br;
230 map_vec[-20213] = vec_a1m;
231 map_vec[20213] = vec_a1p;
232 map_vec[-9000211] = vec_a0m_980;
233 map_vec[9000211] = vec_a0p_980;
234 map_vec[9000111] = vec_a00_980;
235 map_vec[-10211] = vec_a0m_1450;
236 map_vec[10211] = vec_a0p_1450;
237 map_vec[10111] = vec_a00_1450;
238 map_vec[-10213] = vec_b1m;
239 map_vec[10213] = vec_b1p;
240 map_vec[20223] = vec_f1;
241 map_vec[9010221] = vec_f0;
242 map_vec[3122] = vec_lambda;
243 map_vec[-3122] = vec_lmb_br;
244 map_vec[94144] = vec_alpha;
245 map_vec[22] = vec_gam;
246
247 bool TauMinusIsLeptonicDecay = false;
248 bool TauPlusIsLeptonicDecay = false;
249
250 bool elecFirst = true;
251 bool muonFirst = true;
252
253 bool isPiPizGamTauMinusFirst = true;
254 bool isPiPizGamTauPlusFirst = true;
255
256 bool isLFVTauMinus2BodyDecayFirst = true;
257 bool isLFVTauPlus2BodyDecayFirst = true;
258
259 bool isChargedRhoFromTauMinusFirst = true;
260 bool isChargedRhoFromTauPlusFirst = true;
261
262 bool isChargedA1FromTauMinusFirst = true;
263 bool isChargedA1FromTauPlusFirst = true;
264
265 bool isEtaPPGFromTauMinusFirst = true;
266 bool isEtaPPGFromTauPlusFirst = true;
267
268 bool isOmegaPizGamFromTauMinusFirst = true;
269 bool isOmegaPizGamFromTauPlusFirst = true;
270
271 bool isEtaPizPizPizFromTauMinusFirst = true;
272 bool isEtaPizPizPizFromTauPlusFirst = true;
273
276
277 bool isOmegaPimPipFromTauMinusFirst = true;
278 bool isOmegaPimPipFromTauPlusFirst = true;
279
282
283 // Loop of MCParticles
284 for (int i = 0; i < MCParticles.getEntries(); i++) {
285
286 MCParticle& p = *MCParticles[i];
287
288 int pdgid = p.getPDG();
289
290 if (pdgid == -Const::Klong.getPDGCode()) pdgid = -pdgid; // Strange feature in TauolaBelle2
291
292 // Special treatment for photons
293 bool accept_photon = false;
294
295 if (!p.hasStatus(MCParticle::c_PrimaryParticle))
296 continue; // only consider particles coming from generator, e.g. discard particles added by Geant4
297 if (p.isInitial()) continue; // pick e- e+, but not from the incoming beams
298
299 // Check IsLeptonicDecay first
300 if (abs(pdgid) == 12 || abs(pdgid) == 14) { // (anti-)nu_e or (anti-)nu_mu
301 int leptonicdecay = 0;
302 const MCParticle* mother = p.getMother(); // tau- or tau+
303 const vector<MCParticle*> daughters = mother->getDaughters();
304 for (MCParticle* d : daughters) {
305 int dauid = abs(d->getPDG());
306 if (dauid == 11 || dauid == 12 || dauid == 13 || dauid == 14 || dauid == 16) {
307 leptonicdecay++;
308 }
309 }
310 if (leptonicdecay == 3) {
311 if (mother->getPDG() == 15) TauMinusIsLeptonicDecay = true;
312 if (mother->getPDG() == -15) TauPlusIsLeptonicDecay = true;
313 }
314 }
315
316 else if (pdgid == Const::electron.getPDGCode() && elecFirst) {
317 elecFirst = false;
318 const MCParticle* mother = p.getMother();
319 if (not mother) continue; // In some low multiplicity generators there may be no mother
320 const vector<MCParticle*> daughters = mother->getDaughters();
321 int nElMinus = 0;
322 int nElPlus = 0;
323 stringstream elec_ss;
324 for (MCParticle* d : daughters) {
325 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
326 elec_ss << d->getPDG() << " ";
327 if (d->getPDG() == Const::electron.getPDGCode()) nElMinus++;
328 if (d->getPDG() == -Const::electron.getPDGCode()) nElPlus++;
329 }
330 if (nElMinus == 1 && nElPlus == 1) { // use this information in getRecursiveMotherCharge
331 B2DEBUG(19, "Mother of elec pair is = " << mother->getPDG() << " which has daughters : " << elec_ss.str());
332 }
333 }
334
335 else if (pdgid == Const::muon.getPDGCode() && muonFirst) {
336 muonFirst = false;
337 const MCParticle* mother = p.getMother();
338 if (not mother) continue; // In some low multiplicity generators there may be no mother
339 const vector<MCParticle*> daughters = mother->getDaughters();
340 int nMuMinus = 0;
341 int nMuPlus = 0;
342 stringstream muon_ss;
343 for (MCParticle* d : daughters) {
344 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
345 muon_ss << d->getPDG() << " ";
346 if (d->getPDG() == Const::muon.getPDGCode()) nMuMinus++;
347 if (d->getPDG() == -Const::muon.getPDGCode()) nMuPlus++;
348 }
349 if (nMuMinus == 1 && nMuPlus == 1) { // use this information in getRecursiveMotherCharge
350 B2DEBUG(19, "Mother of muon pair is = " << mother->getPDG() << " which has daughters : " << muon_ss.str());
351 }
352 }
353
354 // Photons from PHOTOS are radiative photons
355 else if (pdgid == Const::photon.getPDGCode() && p.hasStatus(MCParticle::c_IsPHOTOSPhoton)) {
357 if (chg < 0) vec_radgam_taum.push_back(i);
358 if (chg > 0) vec_radgam_taup.push_back(i);
359 }
360
361 // Photons from PHOTOS do not define tau decay mode
362 else if (pdgid == Const::photon.getPDGCode() && !p.hasStatus(MCParticle::c_IsPHOTOSPhoton)) {
363 const MCParticle* mother = p.getMother();
364 if (not mother) continue; // In some low multiplicity generators there may be no mother
365 int mothid = abs(mother->getPDG());
366
367 // check if the gamma comes from final state charged particles {e, mu, pi, K, p, b_1}
368 bool isRadiationfromFinalStateChargedParticle = false;
369 if (mothid == 11 ||
370 mothid == 13 ||
371 mothid == 211 ||
372 mothid == 321 ||
373 mothid == 2212 ||
374 mothid == 10213) {
375 isRadiationfromFinalStateChargedParticle = true;
376 }
377
378 // check if the gamma from ChargedRho
379 bool isRadiationFromChargedRho = false;
380 if (mothid == 213) {
381 int chg = getRecursiveMotherCharge(mother);
382 if (chg < 0 && isChargedRhoFromTauMinusFirst) {
383 isChargedRhoFromTauMinusFirst = false;
384 isRadiationFromChargedRho = true;
385 }
386 if (chg > 0 && isChargedRhoFromTauPlusFirst) {
387 isChargedRhoFromTauPlusFirst = false;
388 isRadiationFromChargedRho = true;
389 }
390 }
391
392 // check if the gamma from ChargedA1
393 bool isRadiationFromChargedA1 = false;
394 if (mothid == 20213) {
395 int chg = getRecursiveMotherCharge(mother);
396 if (chg < 0 && isChargedA1FromTauMinusFirst) {
397 isChargedA1FromTauMinusFirst = false;
398 isRadiationFromChargedA1 = true;
399 }
400 if (chg > 0 && isChargedA1FromTauPlusFirst) {
401 isChargedA1FromTauPlusFirst = false;
402 isRadiationFromChargedA1 = true;
403 }
404 }
405
406 // check if the gamma comes from intermediate W+- boson
407 bool isRadiationfromIntermediateWBoson = false;
408 if (mothid == 24) isRadiationfromIntermediateWBoson = true;
409
410 // check if it is a tau- -> pi- omega nu, omega -> pi0 gamma decay
411 // Note: TauolaBelle2 generator treats this a coherent production
412 // e.g. includes omega in the form factor but not as an explicit final state particle
413 bool isPiPizGam = false;
414 if (isRadiationfromIntermediateWBoson) {
415 const vector<MCParticle*> daughters = mother->getDaughters();
416 int nPiSisters = 0;
417 int nPizSisters = 0;
418 int nTotSisters = 0;
419 int nOtherSisters = 0;
420 for (MCParticle* d : daughters) {
421 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
422 nTotSisters++;
423 if (abs(d->getPDG()) == Const::pion.getPDGCode()) {
424 nPiSisters++;
425 } else if (abs(d->getPDG()) == Const::pi0.getPDGCode()) {
426 nPizSisters++;
427 } else if (abs(d->getPDG()) != Const::photon.getPDGCode()) {
428 nOtherSisters++;
429 }
430 }
431 // allow final state radiation from the tau lepton, but ignore information on number of photons for decay mode classifiction
432 if (nTotSisters >= 3 && nPiSisters == 1 && nPizSisters == 1 && nOtherSisters == 0) {
433 int chg = getRecursiveMotherCharge(mother);
434 if (chg < 0 && isPiPizGamTauMinusFirst) {
435 isPiPizGamTauMinusFirst = false;
436 isPiPizGam = true;
437 }
438 if (chg > 0 && isPiPizGamTauPlusFirst) {
439 isPiPizGamTauPlusFirst = false;
440 isPiPizGam = true;
441 }
442 }
443 }
444
445 // check if the gamma comes from tau
446 bool isRadiationfromTau = false;
447 if (mothid == 15) isRadiationfromTau = true;
448
449 // Photons from LeptonicTauDecays are radiative photons not added by PHOTOS
450 if (isRadiationfromTau) {
452 if (chg < 0 && TauMinusIsLeptonicDecay) vec_radgam_taum.push_back(i);
453 if (chg > 0 && TauPlusIsLeptonicDecay) vec_radgam_taup.push_back(i);
454 }
455
456 // check if the gamma comes from 2 body LFV decays of tau, e.g. tau- -> e-/mu- gamma with arbitrary number of extra photon radiations from PHOTOS/FSR
457 bool isLFVTau2BodyDecay = false;
458 if (isRadiationfromTau) {
459 bool hasNeutrinoAsSister = false;
460 int numChargedSister = 0;
461 int numNeutralNonNeutrinoNonPhotonSister = 0;
462 const vector<MCParticle*> daughters = mother->getDaughters();
463 for (MCParticle* d : daughters) {
464 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
465 hasNeutrinoAsSister = find(Neutrinos.begin(), Neutrinos.end(), abs(d->getPDG())) != Neutrinos.end();
466 if (hasNeutrinoAsSister) break;
467 }
468 if (!hasNeutrinoAsSister) {
469 for (MCParticle* d : daughters) {
470 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
471 bool isChargedFinalState = find(finalStatePDGs.begin(), finalStatePDGs.end(), abs(d->getPDG())) != finalStatePDGs.end();
472 if (isChargedFinalState) {
473 numChargedSister++;
474 } else if (d->getPDG() != Const::photon.getPDGCode()) {
475 numNeutralNonNeutrinoNonPhotonSister++;
476 }
477 }
478 if (numChargedSister == 1 && numNeutralNonNeutrinoNonPhotonSister == 0) {
479 if (mother->getPDG() == 15 && isLFVTauMinus2BodyDecayFirst) {
480 isLFVTauMinus2BodyDecayFirst = false;
481 isLFVTau2BodyDecay = true;
482 }
483 if (mother->getPDG() == -15 && isLFVTauPlus2BodyDecayFirst) {
484 isLFVTauPlus2BodyDecayFirst = false;
485 isLFVTau2BodyDecay = true;
486 }
487 }
488 }
489 B2DEBUG(19, "hasNeutrinoAsSister = " << hasNeutrinoAsSister
490 << " numChargedSister = " << numChargedSister
491 << " numNeutralNonNeutrinoNonPhotonSister = " << numNeutralNonNeutrinoNonPhotonSister
492 << " isLFVTau2BodyDecay = " << isLFVTau2BodyDecay);
493 }
494
495 bool isPi0GG = false;
496 bool isEtaGG = false;
497 bool isEtpGG = false;
498 bool isPi0GEE = false;
499 bool isEtaPPG = false;
500 bool isOmPizG = false;
501 if (mothid == 111 || mothid == 221 || mothid == 331 || mothid == 223) {
502 const vector<MCParticle*> daughters = mother->getDaughters();
503 int numberofTotalDaughters = 0;
504 int numberOfPhotonDaughters = 0;
505 int numberOfElectronDaughters = 0;
506 int numberOfPionDaughters = 0;
507 int numberOfPizDaughters = 0;
508 for (MCParticle* d : daughters) {
509 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
510 numberofTotalDaughters ++;
511 if (abs(d->getPDG()) == Const::photon.getPDGCode()) numberOfPhotonDaughters++;
512 if (abs(d->getPDG()) == Const::electron.getPDGCode()) numberOfElectronDaughters++;
513 if (abs(d->getPDG()) == Const::pion.getPDGCode()) numberOfPionDaughters++;
514 if (abs(d->getPDG()) == Const::pi0.getPDGCode()) numberOfPizDaughters++;
515 }
516 if (numberofTotalDaughters == 2 && numberOfPhotonDaughters == 2) {
517 if (mothid == Const::pi0.getPDGCode()) isPi0GG = true;
518 if (mothid == 221) isEtaGG = true;
519 if (mothid == 331) isEtpGG = true;
520 }
521 if (numberofTotalDaughters >= 3 && numberOfPhotonDaughters >= 1 && numberOfElectronDaughters == 2 && numberOfPionDaughters == 0
522 && numberOfPizDaughters == 0) {
523 if (mothid == Const::pi0.getPDGCode()) isPi0GEE = true;
524 }
525 if (numberofTotalDaughters >= 3 && numberOfPhotonDaughters >= 1 && numberOfPizDaughters == 0 && numberOfPionDaughters == 2) {
526 if (mothid == 221) {
527 int chg = getRecursiveMotherCharge(mother);
528 if (chg < 0 && isEtaPPGFromTauMinusFirst) {
529 isEtaPPGFromTauMinusFirst = false;
530 isEtaPPG = true;
531 }
532 if (chg > 0 && isEtaPPGFromTauPlusFirst) {
533 isEtaPPGFromTauPlusFirst = false;
534 isEtaPPG = true;
535 }
536 }
537 }
538 if (numberofTotalDaughters >= 2 && numberOfPhotonDaughters >= 1 && numberOfPizDaughters == 1 && numberOfPionDaughters == 0) {
539 if (mothid == 223) {
540 int chg = getRecursiveMotherCharge(mother);
541 if (chg < 0 && isOmegaPizGamFromTauMinusFirst) {
542 isOmegaPizGamFromTauMinusFirst = false;
543 isOmPizG = true;
544 }
545 if (chg > 0 && isOmegaPizGamFromTauPlusFirst) {
546 isOmegaPizGamFromTauPlusFirst = false;
547 isOmPizG = true;
548 }
549 }
550 }
551 }
552
553 B2DEBUG(19, "isRadiationfromFinalStateChargedParticle = " << isRadiationfromFinalStateChargedParticle);
554 B2DEBUG(19, "isRadiationFromChargedRho = " << isRadiationFromChargedRho);
555 B2DEBUG(19, "isRadiationFromChargedA1 = " << isRadiationFromChargedA1);
556 B2DEBUG(19, "isRadiationfromIntermediateWBoson = " << isRadiationfromIntermediateWBoson << " isPiPizGam = " << isPiPizGam);
557 B2DEBUG(19, "isRadiationfromTau = " << isRadiationfromTau << " isLFVTau2BodyDecay = " << isLFVTau2BodyDecay);
558 B2DEBUG(19, "isPi0GG = " << isPi0GG << " isEtaGG = " << isEtaGG << " isEtpGG = " << isEtpGG << " isPi0GEE = " << isPi0GEE);
559 B2DEBUG(19, "isEtaPPG = " << isEtaPPG << " isOmPizG = " << isOmPizG);
560
561 // accept photons if (isRadiationfromFinalStateChargedParticle is false) or
562 // if (isRadiationfromIntermediateWBoson is false) or
563 // if (isRadiationfromTau is true) {gamma is from 2 body LFV decays of tau} or
564 // if the radiation is coming from any other decay [except pi0 -> gamma gamma, eta-> gamma gamma, eta' -> gamma gamma]
565 if (isRadiationfromFinalStateChargedParticle) {
566 } else if (isRadiationFromChargedRho) {
567 accept_photon = true;
568 } else if (isRadiationFromChargedA1) {
569 accept_photon = true;
570 } else if (isRadiationfromIntermediateWBoson) {
571 if (isPiPizGam) {
572 accept_photon = true;
573 }
574 } else if (isRadiationfromTau) { // accept one photon from tau -> (charged particle) + gamma [no neutrinos]
575 if (isLFVTau2BodyDecay) {
576 accept_photon = true;
577 }
578 } else if (isPi0GG) {
579 } else if (isEtaGG) {
580 } else if (isEtpGG) {
581 } else if (isPi0GEE) {
582 } else if (isEtaPPG) {
583 accept_photon = true;
584 } else if (isOmPizG) {
585 accept_photon = true;
586 }
587 }
588
589 // Without further analysis, it is NOT possible to separate
590 // tau- -> pi- 2pi0 eta (-> pi- pi+ pi0) nu decays [Mode 39] from
591 // tau- -> 2pi- pi+ eta (-> pi0 pi0 pi0) nu decays [Mode 42]
592
593 else if (pdgid == Const::pi0.getPDGCode() && (isEtaPizPizPizFromTauMinusFirst || isEtaPizPizPizFromTauPlusFirst)) {
594 const MCParticle* mother = p.getMother();
595 // In some low multiplicity generators there may be no mother
596 if (mother and (mother->getPDG() == 221)) { // eta -> pi0 pi0 pi0
597 const vector<MCParticle*> daughters = mother->getDaughters();
598 int nPizSisters = 0;
599 for (MCParticle* d : daughters) {
600 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
601 if (d->getPDG() == Const::pi0.getPDGCode()) nPizSisters++;
602 }
603 B2DEBUG(19, "nPizSisters = " << nPizSisters);
604 if (nPizSisters == 3) {
605 int chg = getRecursiveMotherCharge(mother);
606 if (chg < 0 && isEtaPizPizPizFromTauMinusFirst) {
607 isEtaPizPizPizFromTauMinusFirst = false;
609 }
610 if (chg > 0 && isEtaPizPizPizFromTauPlusFirst) {
611 isEtaPizPizPizFromTauPlusFirst = false;
613 }
614 }
615 }
616 }
617
618 // Without further analysis, it is NOT possible to separate
619 // tau- -> pi- 2pi0 omega (-> pi- pi+) nu decays [Mode 49] from
620 // tau- -> 2pi- pi+ 2pi0 nu decays [Mode 66]
621 // Note: TauolaBelle2 treats Mode 66 is coherent production,
622 // e.g. includes omega in the form factor but not as an explicit final state particle.
623 // Note2: omega is explicitly included in following mode:
624 // tau- -> pi- pi0 omega (-> pi- pi+ pi0) nu decays [Mode 130]
625 // which is where Mode 49 is mapped to if there is no omega->pi-pi+ decay
626
627 // Same confusion can also happen for
628 // tau- -> pi- pi0 omega (-> pi- pi+) nu decays [Mode 131]
629 // tau- -> pi- omega (-> pi- pi+ pi0) nu decays [Mode 236]
630
631 else if (pdgid == -Const::pion.getPDGCode() && (isOmegaPimPipFromTauMinusFirst || isOmegaPimPipFromTauPlusFirst)) {
632 const MCParticle* mother = p.getMother();
633 // In some low multiplicity generators there may be no mother
634 if (mother and (mother->getPDG() == 223)) { // omega -> pi- pi+
635 const vector<MCParticle*> daughters = mother->getDaughters();
636 int nOmegaDaughters = 0;
637 int nPimSisters = 0;
638 int nPipSisters = 0;
639 int nPizSisters = 0;
640 for (MCParticle* d : daughters) {
641 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
642 nOmegaDaughters++;
643 if (d->getPDG() == -Const::pion.getPDGCode()) nPimSisters++;
644 if (d->getPDG() == Const::pion.getPDGCode()) nPipSisters++;
645 if (d->getPDG() == Const::pi0.getPDGCode()) nPizSisters++;
646 }
647 B2DEBUG(19,
648 "nOmegaDaughters = " << nOmegaDaughters << " "
649 "nPimSisters = " << nPimSisters << " "
650 "nPipSisters = " << nPipSisters << " "
651 "nPizSisters = " << nPizSisters);
652 if (nOmegaDaughters >= 2 && nPimSisters == 1 && nPipSisters == 1 && nPizSisters == 0) { // allow omega->pi-pi+gama
653 int chg = getRecursiveMotherCharge(mother);
654 if (chg < 0 && isOmegaPimPipFromTauMinusFirst) {
655 isOmegaPimPipFromTauMinusFirst = false;
657 }
658 if (chg > 0 && isOmegaPimPipFromTauPlusFirst) {
659 isOmegaPimPipFromTauPlusFirst = false;
661 }
662 }
663 }
664 }
665 B2DEBUG(19,
666 "isEtaPizPizPizFromTauMinusFirst = " << isEtaPizPizPizFromTauMinusFirst << " "
667 "m_isEtaPizPizPizFromTauMinus = " << m_isEtaPizPizPizFromTauMinus << " "
668 "isEtaPizPizPizFromTauPlusFirst = " << isEtaPizPizPizFromTauPlusFirst << " "
669 "m_isEtaPizPizPizFromTauPlus = " << m_isEtaPizPizPizFromTauPlus
670 );
671 B2DEBUG(19,
672 "isOmegaPimPipFromTauMinusFirst = " << isOmegaPimPipFromTauMinusFirst << " "
673 "m_isOmegaPimPipFromTauMinus = " << m_isOmegaPimPipFromTauMinus << " "
674 "isOmegaPimPipFromTauPlusFirst = " << isOmegaPimPipFromTauPlusFirst << " "
675 "m_isOmegaPimPipFromTauPlus = " << m_isEtaPizPizPizFromTauPlus
676 );
677
678 // Fill up all the vector of particles
679 map<int, std::vector<int>>::iterator ite ;
680 for (ite = map_vec.begin(); ite != map_vec.end(); ++ite) {
681 if (pdgid == ite->first) {
682 if (pdgid == Const::photon.getPDGCode()) {
683 if (accept_photon) {
684 B2DEBUG(19, "Photon accepted");
685 ite-> second.push_back(i);
686 }
687 } else {
688 ite-> second.push_back(i);
689 }
690 break;
691 }
692 }
693
694 } // End of loop over MCParticles
695
696 vec_dau_tauminus.clear();
697 vec_dau_tauplus.clear();
698
699 map<int, std::vector<int>>::iterator itr ;
700 for (itr = map_vec.begin(); itr != map_vec.end(); ++itr) {
701 for (unsigned int i = 0; i < itr-> second.size(); i++) {
702 int ii = itr-> second[i];
704 if (chg < 0) vec_dau_tauminus.push_back(ii);
705 if (chg > 0) vec_dau_tauplus.push_back(ii);
706 }
707 }
708
709 EvtGenDatabasePDG* databasePDG = EvtGenDatabasePDG::Instance();
710 std::string pdgname;
711
712 //make decay string for tau-
714 for (unsigned iorder = 0; iorder < OrderedList.size(); ++iorder) {
715 int ii = OrderedList[iorder];
716 //
717 for (unsigned int i = 0; i < vec_dau_tauminus.size(); i++) {
718 MCParticle* p = MCParticles[vec_dau_tauminus[i]];
719 int pdg = p->getPDG();
720 if (pdg == -Const::Klong.getPDGCode()) pdg = -pdg; // Strange Feature in TauolaBelle2
721 if (pdg != ii) continue;
722 m_tauminusdecaymode.append(".");
723 if (pdg == 94144) {
724 pdgname = "alpha";
725 } else {
726 pdgname = databasePDG->GetParticle(pdg)->GetName();
727 }
728 m_tauminusdecaymode.append(pdgname);
729 }
730 }
731 //
733
734 //make decay string for tau+
736 for (unsigned iorder = 0; iorder < OrderedList.size(); ++iorder) {
737 int ii = OrderedList[iorder];
738 //
739 for (unsigned int i = 0; i < vec_dau_tauplus.size(); i++) {
740 MCParticle* p = MCParticles[vec_dau_tauplus[i]];
741 int pdg = p->getPDG();
742 if (pdg == -Const::Klong.getPDGCode()) pdg = -pdg; // Strange Feature in TauolaBelle2
743 if (pdg != ii) continue;
744 m_tauplusdecaymode.append(".");
745 if (pdg == 94144) {
746 pdgname = "alpha";
747 } else {
748 pdgname = databasePDG->GetParticle(pdg)->GetName();
749 }
750 m_tauplusdecaymode.append(pdgname);
751 }
752 }
753 //
755
756}
int getPDGCode() const
PDG code.
Definition Const.h:473
static const ParticleType pi0
neutral pion particle
Definition Const.h:674
static const ChargedStable muon
muon particle
Definition Const.h:660
static const ChargedStable pion
charged pion particle
Definition Const.h:661
static const ParticleType Klong
K^0_L particle.
Definition Const.h:678
static const ParticleType photon
photon particle
Definition Const.h:673
static const ChargedStable electron
electron particle
Definition Const.h:659
static EvtGenDatabasePDG * Instance()
Instance method that loads the EvtGen table.
@ c_IsPHOTOSPhoton
bit 8: Particle is an radiative photon from PHOTOS
Definition MCParticle.h:63
@ c_PrimaryParticle
bit 0: Particle is primary particle.
Definition MCParticle.h:47
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:101
std::vector< int > vec_numu
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_em
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_omega
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_k0s
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_b1p
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_f1
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_apro
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_pi0
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_alpha
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_radgam_taum
Variable name of the vector where particles identified in the event are stored.
StoreArray< MCParticle > MCParticles
StoreArray of MCParticles.
std::vector< int > vec_anue
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_nue
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_a0p_980
Variable name of the vector where particles identified in the event are stored.
static constexpr std::array< int, 46 > OrderedList
PDG codes of ORDERED particles.
std::vector< int > vec_a0m_1450
Variable name of the vector where particles identified in the event are stored.
static constexpr std::array< int, 3 > Neutrinos
PDG codes of neutrinos in final state particles in generation: {nu_e, nu_mu, mu_tau}...
std::vector< int > vec_lmb_br
Variable name of the vector where particles identified in the event are stored.
int getRecursiveMotherCharge(const MCParticle *mc)
Identifies particles coming from tau decays.
std::vector< int > vec_phi
Variable name of the vector where particles identified in the event are stored.
std::string m_tauminusdecaymode
Variable name for the decay mode of the tau-.
std::vector< int > vec_a1p
Variable name of the vector where particles identified in the event are stored.
int TauolaBelle2DecayMode(const std::string &s, int chg)
Classifies the decays of the event and assigns a decay mode.
std::vector< int > vec_lambda
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_anut
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_f0
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_mum
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_nut
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_kstar0_br
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_radgam_taup
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_a00_1450
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_kstar0
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_a0m_980
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_a00_980
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_a1m
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_rhop
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_pro
Variable name of the vector where particles identified in the event are stored.
std::string m_tauplusdecaymode
Variable name for the decay mode of the tau+.
std::vector< int > vec_pim
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_mup
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_pip
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_kstarp
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_kstarm
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_etapr
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_ep
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_k0l
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_eta
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_km
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_anumu
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_dau_tauplus
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_rhom
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_gam
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_dau_tauminus
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_kp
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_b1m
Variable name of the vector where particles identified in the event are stored.
std::vector< int > vec_rho0
Variable name of the vector where particles identified in the event are stored.
static constexpr std::array< int, 5 > finalStatePDGs
PDG codes accepted as charged final state particles in generation: {e, mu, pi, K, p}...
std::vector< int > vec_a0p_1450
Variable name of the vector where particles identified in the event are stored.

◆ beginRun()

virtual void beginRun ( void )
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 AnalysisPhase1StudyModule, ARICHBackgroundModule, arichBtestModule, ARICHDigitizerModule, ARICHDQMModule, ARICHRateCalModule, ARICHReconstructorModule, AWESOMEBasicModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BeamSpotMonitorModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTrigger2DFinderModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerTSFModule, CDCTriggerUnpackerModule, CertifyParallelModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CreateFieldMapModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlTaggerModule, DAQMonitorModule, DAQPerfModule, DataWriterModule, DelayDQMModule, DeSerializerPXDModule, DetectorOccupanciesDQMModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputRootFileModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTrackingHLTModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistInjectionModule, DqmHistoManagerModule, DQMHistoModuleBase, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLDQMInjectionModule, ECLLOMModule, ECLBackgroundModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDModule, ECLChargedPIDMVAModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLDQMOutOfTimeDigitsModule, ECLExpertModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EnergyBiasCorrectionModule, EventInfoPrinterModule, EventLimiterModule, EventsOfDoomBusterModule, EventT0DQMModule, EventT0ValidationModule, EvReductionModule, EvtGenDecayModule, EvtGenInputModule, ExportGeometryModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastRbuf2DsModule, FlipQualityModule, FullSimModule, TRGGDLUnpackerModule, GearboxModule, GenRawSendModule, GetEventFromSocketModule, GRLNeuroModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HistoManagerModule, HistoModule, HitXPModule, HLTDQM2ZMQModule, IoVDependentConditionModule, IPDQMModule, KinkFinderModule, KKGenInputModule, KLMClusterAnaModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDigitTimeShifterModule, KLMDQM2Module, KLMDQMModule, KLMExpertModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, KlongValidationModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MaterialScanModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MCV0MatcherModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, MonitorDataModule, MuidModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, NtuplePhase1_v6Module, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, ParticleVertexFitterModule, Ph1bpipeModule, Ph1sustrModule, PhotonEfficiencySystematicsModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleEcmsBBModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, ProgressModule, PXDBackgroundModule, PXDBgTupleProducerModule, PXDClusterizerModule, PXDDAQDQMModule, PXDDigitizerModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDMCBgTupleProducerModule, PXDPackerModule, PXDRawDQMChipsModule, PXDRawDQMModule, PXDROIDQMModule, PXDUnpackerModule, PXDclusterFilterModule, PXDClustersFromTracksModule, PXDdigiFilterModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDPerformanceModule, PXDRawDQMCorrModule, PXDROIFinderAnalysisModule, PXDROIFinderModule, PXDTrackClusterDQMModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, QualityEstimatorVXDModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, ReprocessorModule, RxModule, RxSocketModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SectorMapBootstrapModule, SegmentNetworkProducerModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SoftwareTriggerHLTDQMModule, SoftwareTriggerModule, StatisticsTimingHLTDQMModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, SrsensorModule, StatisticsSummaryModule, StorageDeserializerModule, StorageSerializerModule, SubEventModule, SVD3SamplesEmulatorModule, SVDBackgroundModule, SVDClusterizerModule, SVDDigitizerModule, SVDDQMDoseModule, SVDDQMInjectionModule, SVDMissingAPVsClusterCreatorModule, SVDPackerModule, SVDRecoDigitCreatorModule, SVDUnpackerModule, SVDB4CommissioningPlotsModule, SVDClusterCalibrationsMonitorModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, SVDDQMHitTimeModule, svdDumpModule, SVDEventInfoSetterModule, SVDEventT0EstimatorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsCheckModule, SVDLocalCalibrationsMonitorModule, SVDMaxStripTTreeModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPerformanceTTreeModule, SVDPositionErrorScaleFactorImporterModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDShaperDigitsFromTracksModule, SVDSpacePointCreatorModule, SVDTimeCalibrationsMonitorModule, SVDTimeGroupingModule, SVDTriggerQualityGeneratorModule, SVDUnpackerDQMModule, SwitchDataStoreModule, TagVertexModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelMaskerModule, TOPChannelT0MCModule, TOPDigitizerModule, TOPDoublePulseGeneratorModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLaserHitSelectorModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTimeRecalibratorModule, TOPTriggerDigitizerModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, TrackAnaModule, TrackCreatorModule, TrackFinderMCTruthRecoTracksModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackFinderVXDAnalizerModule, TrackingAbortDQMModule, TrackingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TrackQualityEstimatorMVAModule, TreeFitterModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLInjectionVetoFromOverlayModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TTDDQMModule, TxModule, TxSocketModule, V0findingPerformanceEvaluationModule, V0ObjectsDQMModule, VXDMisalignmentModule, vxdDigitMaskingModule, VXDDQMExpressRecoModule, VXDQETrainingDataCollectorModule, VXDQualityEstimatorMVAModule, VXDSimpleClusterizerModule, and VXDTFTrainingDataCollectorModule.

Definition at line 146 of file Module.h.

146{};

◆ 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{
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.
void setParameters(const ModuleParamList &params)
Set values for parameters from other parameter list.
const ModuleParamList & getParamList() const
Return module param list.
Definition Module.h:362
const std::string & getName() const
Returns the name of the module.
Definition Module.h:186
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:511
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition Module.h:515
void setName(const std::string &name)
Set the name of the module.
Definition Module.h:213
LogConfig m_logConfig
The log system configuration of the module.
Definition Module.h:513
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition Module.h:520
std::string m_package
Package this module is found in (may be empty).
Definition Module.h:509
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ beginRun(); }

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

438{ endRun(); }

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

419{ initialize(); }

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

444{ terminate(); }

◆ endRun()

virtual void endRun ( void )
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 AlignDQMModule, AnalysisPhase1StudyModule, arichBtestModule, ARICHDQMModule, AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CertifyParallelModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlTaggerModule, DAQPerfModule, DataWriterModule, DeSerializerPXDModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistAnalysisTRGModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DqmHistoManagerModule, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLLOMModule, ECLBackgroundModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EventInfoPrinterModule, EventT0ValidationModule, EvReductionModule, EvtGenDecayModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastRbuf2DsModule, FullSimModule, TRGGDLUnpackerModule, GenfitVisModule, GenRawSendModule, GetEventFromSocketModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HistoManagerModule, HistoModule, HitXPModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQM2Module, KLMDQMModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, KlongValidationModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MCV0MatcherModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, TPCStudyModule, MonitorDataModule, MuidModule, NoKickCutsEvalModule, NtuplePhase1_v6Module, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, Ph1bpipeModule, Ph1sustrModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, PrintDataModule, PrintEventRateModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, PXDROIFinderModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, ReprocessorModule, Root2BinaryModule, Root2RawModule, RT2SPTCConverterModule, RxModule, RxSocketModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SectorMapBootstrapModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, SrsensorModule, StatisticsSummaryModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, SubEventModule, SVD3SamplesEmulatorModule, SVDBackgroundModule, SVDClusterizerModule, SVDPackerModule, SVDRecoDigitCreatorModule, SVDUnpackerModule, SVDB4CommissioningPlotsModule, SVDClusterCalibrationsMonitorModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, svdDumpModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsMonitorModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPositionErrorScaleFactorImporterModule, SVDROIDQMModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDShaperDigitsFromTracksModule, SVDTimeCalibrationsMonitorModule, SVDTriggerQualityGeneratorModule, SVDUnpackerDQMModule, SwitchDataStoreModule, TOPBackgroundModule, TOPChannelT0MCModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLaserHitSelectorModule, TOPMCTrackMakerModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTriggerDigitizerModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPWaveformQualityPlotterModule, TOPXTalkChargeShareSetterModule, TrackAnaModule, TrackFinderMCTruthRecoTracksModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackFinderVXDAnalizerModule, TrackingPerformanceEvaluationModule, TrackSetEvaluatorHopfieldNNDEVModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TxModule, TxSocketModule, V0findingPerformanceEvaluationModule, vxdDigitMaskingModule, VXDSimpleClusterizerModule, VXDTFTrainingDataCollectorModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 165 of file Module.h.

165{};

◆ 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:518
bool m_hasReturnValue
True, if the return value is set.
Definition Module.h:517

◆ event()

void event ( void )
overridevirtual

Method is called for each event.

Reimplemented from Module.

Definition at line 84 of file TauDecayModeModule.cc.

85{
86
88 if (tauPair) {
89
91
92 if (m_printmode == "missing") {
93 if (m_mmode == -1) {
94 B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
95 << " Decay: tau- -> " << m_tauminusdecaymode << " Mode = " << m_mmode);
96 }
97 if (m_pmode == -1) {
98 B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
99 << " Decay: tau+ -> " << m_tauplusdecaymode << " Mode = " << m_pmode);
100 }
101 }
102
103 if (m_printmode == "all") {
104 B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
105 << " Decay: tau- -> " << m_tauminusdecaymode << " Mode = " << m_mmode);
106 B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
107 << " Decay: tau+ -> " << m_tauplusdecaymode << " Mode = " << m_pmode);
108 }
109
110 //
111 if (m_mmode == -1) {
112 m_taum_no = m_taum_no - 1;
114 }
115 if (m_pmode == -1) {
116 m_taup_no = m_taup_no - 1;
118 }
119
122
125
126 } else {
127 m_pmode = -1;
128 m_mmode = -1;
129 m_pprong = -1;
130 m_mprong = -1;
131 m_megstar = -1;
132 m_pegstar = -1;
133 }
134
135 if (!m_tauDecay) m_tauDecay.create();
136 m_tauDecay->addTauMinusIdMode(m_mmode);
137 m_tauDecay->addTauPlusIdMode(m_pmode);
138
139 m_tauDecay->addTauPlusMcProng(m_pprong);
140 m_tauDecay->addTauMinusMcProng(m_mprong);
141
142 m_tauDecay->addTauMinusEgstar(m_megstar);
143 m_tauDecay->addTauPlusEgstar(m_pegstar);
144}
StoreObjPtr< EventMetaData > m_event_metadata
event number
void IdentifyTauPair()
Identifies if the event is a generated tau pair.
double getEgstar(const std::vector< int > &vec_radgam, const MCParticle &mc)
Energy of the radiative photon in tau rest frame.
void AnalyzeTauPairEvent()
Analyze a generated tau pair event.
int getProngOfDecay(const MCParticle &mc)
Identifies the number of charged final state particles in the decay.
StoreObjPtr< TauPairDecay > m_tauDecay
pointer to tau pair decay objects

◆ 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 paths */
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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
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>()),
491 &Module::setLogConfig)
@ 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: "<".
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition Module.cc:220
@ 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_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
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
ModuleCondition::EAfterConditionPath EAfterConditionPath
Forward the EAfterConditionPath definition from the ModuleCondition.
Definition Module.h:88

◆ 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 323 of file Module.h.

324 {
325 return m_conditions;
326 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 313 of file Module.h.

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

◆ 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 201 of file Module.h.

201{return m_description;}

◆ getEgstar()

double getEgstar ( const std::vector< int > & vec_radgam,
const MCParticle & mc )
private

Energy of the radiative photon in tau rest frame.

Definition at line 862 of file TauDecayModeModule.cc.

863{
864 double egstar = -1.;
865 ROOT::Math::PxPyPzEVector p4_tau = p.get4Vector();
866 B2DEBUG(19, "p4_tau: " << p4_tau << " " << p4_tau.P());
867 ROOT::Math::Boost boost_to_mother_rest_frame(p4_tau.BoostToCM());
868 for (auto i : vec_radgam) {
869 ROOT::Math::PxPyPzEVector p4_gamma = MCParticles[i]->get4Vector();
870 B2DEBUG(19, "p4_gamma: " << p4_gamma << " " << p4_gamma.P());
871 ROOT::Math::PxPyPzEVector p4_gamma_rest = boost_to_mother_rest_frame * p4_gamma;
872 B2DEBUG(19, "p4_gamma_rest: " << p4_gamma_rest << " " << p4_gamma_rest.P());
873 double energy_rest = p4_gamma_rest.E();
874 if (energy_rest > egstar) egstar = energy_rest;
875 }
876 B2DEBUG(19, "egstar: " << egstar);
877 return egstar;
878}

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( bool outputFiles)
inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

505{ return std::list<ModulePtr>(); }

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 186 of file Module.h.

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ 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}

◆ getProngOfDecay()

int getProngOfDecay ( const MCParticle & mc)
private

Identifies the number of charged final state particles in the decay.

Definition at line 844 of file TauDecayModeModule.cc.

845{
846 int ret = 0;
847 const vector<MCParticle*> daughters = p.getDaughters();
848 if (daughters.empty()) return ret;
849 for (MCParticle* d : daughters) {
850 if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
851 // TODO: Improve how to identify a final state particle.
852 bool isChargedFinalState = find(finalStatePDGs.begin(),
853 finalStatePDGs.end(),
854 abs(d->getPDG())) != finalStatePDGs.end();
855 if (isChargedFinalState) ret++;
856 else ret += getProngOfDecay(*d);
857 }
858 return ret;
859}

◆ getRecursiveMotherCharge()

int getRecursiveMotherCharge ( const MCParticle * mc)
private

Identifies particles coming from tau decays.

Definition at line 789 of file TauDecayModeModule.cc.

790{
791 const MCParticle* mother = p->getMother();
792 if (mother == nullptr) {
793 return 0;
794 } else if (abs(p->getPDG()) == Const::electron.getPDGCode() && mother->getPDG() == Const::pi0.getPDGCode()) { // pi0 -> e-e+ gamma
795 return 0;
796 } else if (abs(p->getPDG()) == Const::electron.getPDGCode() && mother->getPDG() == 221) { // eta -> e-e+ gamma
797 return 0;
798 } else if (abs(p->getPDG()) == Const::electron.getPDGCode() && mother->getPDG() == 113) { // rho0 -> e-e+
799 return 0;
800 } else if (abs(p->getPDG()) == Const::electron.getPDGCode() && mother->getPDG() == 223) { // omega -> e- e+
801 return 0;
802 } else if (abs(p->getPDG()) == Const::electron.getPDGCode() && mother->getPDG() == 333) { // phi -> e- e+
803 return 0;
804 } else if (abs(p->getPDG()) == Const::muon.getPDGCode() && mother->getPDG() == 221) { // eta -> mu-mu+ gamma
805 return 0;
806 } else if (abs(p->getPDG()) == Const::muon.getPDGCode() && mother->getPDG() == 113) { // rho0 -> mu-mu+
807 return 0;
808 } else if (abs(p->getPDG()) == Const::muon.getPDGCode() && mother->getPDG() == 333) { // phi -> mu-mu+
809 return 0;
810 } else if (mother->getPDG() == 15) {
811 return -1;
812 } else if (mother->getPDG() == -15) {
813 return 1;
814 } else {
815 return getRecursiveMotherCharge(mother);
816 }
817}

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 380 of file Module.h.

380{ 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:508

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 310 of file Module.h.

310{ 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 377 of file Module.h.

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

◆ IdentifyTauPair()

void IdentifyTauPair ( )
private

Identifies if the event is a generated tau pair.

Definition at line 820 of file TauDecayModeModule.cc.

821{
822 numOfTauPlus = 0;
823 numOfTauMinus = 0;
824 idOfTauPlus = 0;
825 idOfTauMinus = 0;
826 for (int i = 0; i < MCParticles.getEntries(); i++) {
827 MCParticle& p = *MCParticles[i];
828
829 if (p.getStatus() == 1 && p.getPDG() == 15) {
831 idOfTauMinus = p.getIndex();
832 }
833 if (p.getStatus() == 1 && p.getPDG() == -15) {
834 numOfTauPlus++;
835 idOfTauPlus = p.getIndex();
836 }
837 }
838 if (numOfTauPlus == 1 && numOfTauMinus == 1) {
839 tauPair = true;
840 } else tauPair = false;
841}

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters
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 ( void )
overridevirtual

Initializes the module.

Reimplemented from Module.

Definition at line 75 of file TauDecayModeModule.cc.

76{
77 mode_decay_minus = make_map(m_file_minus, -1);
78 mode_decay_plus = make_map(m_file_plus, 1);
79 m_tauDecay.registerInDataStore();
80 m_event_metadata.isRequired();
81}
std::map< std::string, int > mode_decay_minus
Mapping for tau- decays.
std::map< std::string, int > mode_decay_plus
Mapping for tau+ decays.

◆ 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}
std::string m_description
The description of the module.
Definition Module.h:510

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig)
inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

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

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ 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}
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:200
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition LogSystem.cc:28
LogConfig & getLogConfig()
Returns the log system configuration.
Definition Module.h:224
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition Module.h:507
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}

◆ TauolaBelle2DecayMode()

int TauolaBelle2DecayMode ( const std::string & s,
int chg )
private

Classifies the decays of the event and assigns a decay mode.

Definition at line 759 of file TauDecayModeModule.cc.

760{
761 std::map<std::string, int> mode_decay = (chg < 0) ? mode_decay_minus : mode_decay_plus;
762 map<std::string, int>::iterator itr ;
763 for (itr = mode_decay.begin(); itr != mode_decay.end(); ++itr) {
764 if (state == itr-> first) {
765 int mode = itr-> second;
766 if (mode == 39) {
767 if (chg < 0 && m_isEtaPizPizPizFromTauMinus) mode = 42;
768 if (chg > 0 && m_isEtaPizPizPizFromTauPlus) mode = 42;
769 }
770 if (mode == 49) {
771 if (chg < 0 && !m_isOmegaPimPipFromTauMinus) mode = 130;
772 if (chg > 0 && !m_isOmegaPimPipFromTauPlus) mode = 130;
773 }
774 if (mode == 131) {
775 if (chg < 0 && !m_isOmegaPimPipFromTauMinus) mode = 236;
776 if (chg > 0 && !m_isOmegaPimPipFromTauPlus) mode = 236;
777 }
778 if (mode == 247) {
779 if (chg < 0 && !m_isEtaPizPizPizFromTauMinus) mode = 15;
780 if (chg > 0 && !m_isEtaPizPizPizFromTauPlus) mode = 15;
781 }
782 return mode;
783 }
784 }
785 return -1;
786}

◆ terminate()

virtual void terminate ( void )
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 AafhInputModule, AnalysisPhase1StudyModule, ARICHBackgroundModule, arichBtestModule, ARICHNtupleModule, arichToNtupleModule, AsyncWrapper, AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BabayagaNLOInputModule, BBBremInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BeamSpotMonitorModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BHWideInputModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, CDCCrossTalkAdderModule, CDCDedxCorrectionModule, CDCDedxDQMModule, CDCDedxPIDModule, CDCDedxScanModule, CDCDedxSkimCDSTModule, CDCDedxSkimModule, CDCDedxValidationModule, CDCDigitizerModule, cdcDQM7Module, CDCDQMModule, CDCInitialT0DeterminationModule, CDCTrigger2DFinderModule, CDCTriggerHoughETFModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDataModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNeuroIDHistModule, CDCTriggerTSFFirmwareModule, CDCTriggerTSFModule, CDCTriggerUnpackerModule, CertifyParallelModule, CheckErrorEventModule, Chi2MCTrackMatcherModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, CollectorTestModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CRYInputModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlingTrackCandSplitterModule, CurlTaggerModule, DAQPerfModule, DataWriterModule, DeSerializerModule, DeSerializerPXDModule, DisplayModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistAnalysisTRGModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DqmHistoManagerModule, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLLOMModule, ECLBackgroundModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDModule, ECLClusterPSDModule, ECLCompressBGOverlayModule, ECLCovarianceMatrixModule, EclCovMatrixNtupleModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigiStudyModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLExpertModule, ECLFillCellIdMappingModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLMatchingPerformanceExpertModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLTrackClusterMatchingModule, ECLTrackClusterMatchingParametrizationExpertModule, ECLTrackClusterMatchingPerformanceModule, ECLTRGInformationModule, ECLTrimShowersAndDigitsModule, ECLUnpackerModule, eclWaveformCalibCollectorModule, ECLWaveformFitModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EventKinematicsModule, EvReductionModule, EvtGenDecayModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastBDTClassifierAnalyzerModule, FastBDTClassifierTrainingModule, FastRbuf2DsModule, FillTrackFitNtupleModule, FlavorTaggerInfoFillerModule, FragmentationModule, FullSimModule, FullSimTimingModule, TRGGDLUnpackerModule, GeneratedVertexDisplacerModule, GeneratorPreselectionModule, GenfitVisModule, GenRawSendModule, GeometryModule, GetEventFromSocketModule, GFTC2SPTCConverterModule, GRLNeuroModule, GRLNeuroTrainerModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HepevtOutputModule, HepMCInputModule, HepMCOutputModule, HistoManagerModule, HistoModule, HitLevelInfoWriterModule, HitXPModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, KinkFinderModule, KKGenInputModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQM2Module, KLMDQMModule, KLMExpertModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, KlongValidationModule, KoralWInputModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MasterClassModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MCV0MatcherModule, MergeDataStoreModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, MLSegmentNetworkProducerModule, MonitorDataModule, MuidModule, MVAExpertModule, MVAMultipleExpertsModule, NoKickCutsEvalModule, NtuplePhase1_v6Module, ParticleKinematicFitterModule, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, Ph1bpipeModule, Ph1sustrModule, PhaseSpaceAnalysisModule, PhokharaInputModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PIDNtupleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, ProfileModule, ProgressBarModule, PXDBackgroundModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDPackerErrModule, PXDPackerModule, PXDReadRawBonnDAQMatchedModule, PXDReadRawBonnDAQModule, PXDReadRawONSENModule, PXDUnpackerModule, PXDUnpackerOldModule, PXDUnpackerOTModule, PXDClustersFromTracksModule, PXDDQMEfficiencyNtupleModule, PXDDQMEfficiencyNtupleSelftrackModule, PXDDQMTrackRawNtupleModule, PXDPerformanceModule, PXDROIFinderAnalysisModule, PXDSpacePointCreatorModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, RemoveMCParticlesModule, RemoveParticlesNotInListsModule, ReprocessorModule, ROIDQMModule, ROIReadTestModule, ROISenderModule, Root2BinaryModule, Root2RawModule, RootInputModule, RootOutputModule, RT2SPTCConverterModule, RxModule, RxSocketModule, ScanCDCGeoModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SegmentNetworkAnalyzerModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SkimFilterModule, SoftwareTriggerModule, SoftwareTriggerResultPrinterModule, SpacePoint2TrueHitConnectorModule, SpacePointCreatorTestModule, SPTC2GFTCConverterModule, SPTC2RTConverterModule, SPTCRefereeModule, SrsensorModule, StandardTrackingPerformanceModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, StudyMaterialEffectsModule, SubEventModule, SVD3SamplesEmulatorModule, SVDBackgroundModule, SVDDigitizerModule, SVDPackerModule, SVDVariablesToStorageModule, SVDChannelMappingModule, SVDChargeSharingAnalysisModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDClusterQualityEstimatorCalibrationModule, SVDClusterQualityEstimatorModule, SVDCoGTimeEstimatorModule, SVDCrossTalkFinderModule, SVDDataFormatCheckModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, svdDumpModule, SVDEventT0PerformanceTTreeModule, SVDHotStripFinderModule, SVDMaxStripTTreeModule, SVDPerformanceTTreeModule, SVDROIFinderAnalysisDataModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDShaperDigitsFromTracksModule, SVDSpacePointCreatorModule, SVDSpacePointQICalibrationModule, SVDTriggerQualityGeneratorModule, SwitchDataStoreModule, TCConvertersTestModule, TeeggInputModule, TOPAlignerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelT0CalibratorModule, TOPChannelT0MCModule, TOPCommonT0CalibratorModule, TOPCosmicT0FinderModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLaserHitSelectorModule, TOPLLScannerModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPPDFCheckerModule, TOPRawDigitConverterModule, TOPRingPlotterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTriggerDigitizerModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, TrackAnaModule, TrackFilterModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackFinderVXDAnalizerModule, TrackingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TreeFitterModule, TrepsInputModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TxModule, TxSocketModule, V0FinderModule, V0findingPerformanceEvaluationModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, VXDMisalignmentModule, VXDDedxPIDModule, VXDQETrainingDataCollectorModule, VXDTFTrainingDataCollectorModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 175 of file Module.h.

175{};

Member Data Documentation

◆ finalStatePDGs

std::array<int, 5> finalStatePDGs = { 11, 13, 211, 321, 2212 }
staticconstexprprivate

PDG codes accepted as charged final state particles in generation: {e, mu, pi, K, p}.

Definition at line 99 of file TauDecayModeModule.h.

99{ 11, 13, 211, 321, 2212 };

◆ idOfTauMinus

int idOfTauMinus
private

Index of the generated tau-.

Definition at line 90 of file TauDecayModeModule.h.

◆ idOfTauPlus

int idOfTauPlus
private

Index of the generated tau+.

Definition at line 92 of file TauDecayModeModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_event_metadata

StoreObjPtr<EventMetaData> m_event_metadata
private

event number

Definition at line 52 of file TauDecayModeModule.h.

◆ m_file_minus

std::string m_file_minus
private

Alternative mapping for tau-.

Definition at line 94 of file TauDecayModeModule.h.

◆ m_file_plus

std::string m_file_plus
private

Alternative mapping for tau+.

Definition at line 96 of file TauDecayModeModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_isEtaPizPizPizFromTauMinus

bool m_isEtaPizPizPizFromTauMinus
private

Flag for eta->pi0pi0pi0 decays from tau-.

Definition at line 121 of file TauDecayModeModule.h.

◆ m_isEtaPizPizPizFromTauPlus

bool m_isEtaPizPizPizFromTauPlus
private

Flag for eta->pi0pi0pi0 decays from tau+.

Definition at line 123 of file TauDecayModeModule.h.

◆ m_isOmegaPimPipFromTauMinus

bool m_isOmegaPimPipFromTauMinus
private

Flag for omega->pi-pi+ decays from tau-.

Definition at line 126 of file TauDecayModeModule.h.

◆ m_isOmegaPimPipFromTauPlus

bool m_isOmegaPimPipFromTauPlus
private

Flag for omega->pi-pi+ decays from tau+.

Definition at line 128 of file TauDecayModeModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_megstar

double m_megstar
private

Energy of radiative photon from tau-.

Definition at line 78 of file TauDecayModeModule.h.

◆ m_mmode

Int_t m_mmode
private

ID of the decay channel of tau-.

Definition at line 68 of file TauDecayModeModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_mprong

Int_t m_mprong
private

Prong of the decay channel of tau-.

Definition at line 73 of file TauDecayModeModule.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 507 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 509 of file Module.h.

◆ m_pegstar

double m_pegstar
private

Energy of radiative photon from tau+.

Definition at line 81 of file TauDecayModeModule.h.

◆ m_pmode

Int_t m_pmode
private

ID of the decay channel of tau+.

Definition at line 70 of file TauDecayModeModule.h.

◆ m_pprong

Int_t m_pprong
private

Prong of the decay channel of tau+.

Definition at line 75 of file TauDecayModeModule.h.

◆ m_printmode

std::string m_printmode
protected

Parameter passed by the user to indicate the information to be printed.

Definition at line 45 of file TauDecayModeModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 511 of file Module.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_tauDecay

StoreObjPtr<TauPairDecay> m_tauDecay
private

pointer to tau pair decay objects

Definition at line 50 of file TauDecayModeModule.h.

◆ m_taum_no

int m_taum_no
private

number of tau- unclassified events

Definition at line 53 of file TauDecayModeModule.h.

◆ m_tauminusdecaymode

std::string m_tauminusdecaymode
private

Variable name for the decay mode of the tau-.

Definition at line 63 of file TauDecayModeModule.h.

◆ m_taup_no

int m_taup_no
private

number of tau+ unclassified events

Definition at line 54 of file TauDecayModeModule.h.

◆ m_tauplusdecaymode

std::string m_tauplusdecaymode
private

Variable name for the decay mode of the tau+.

Definition at line 65 of file TauDecayModeModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ MCParticles

StoreArray<MCParticle> MCParticles
private

StoreArray of MCParticles.

Definition at line 57 of file TauDecayModeModule.h.

◆ mode_decay_minus

std::map<std::string, int> mode_decay_minus
private

Mapping for tau- decays.

Definition at line 59 of file TauDecayModeModule.h.

◆ mode_decay_plus

std::map<std::string, int> mode_decay_plus
private

Mapping for tau+ decays.

Definition at line 61 of file TauDecayModeModule.h.

◆ Neutrinos

std::array<int, 3> Neutrinos = { 12, 14, 16 }
staticconstexprprivate

PDG codes of neutrinos in final state particles in generation: {nu_e, nu_mu, mu_tau}.

Definition at line 102 of file TauDecayModeModule.h.

102{ 12, 14, 16 };

◆ numOfTauMinus

int numOfTauMinus
private

Number of tau- in the event.

Definition at line 86 of file TauDecayModeModule.h.

◆ numOfTauPlus

int numOfTauPlus
private

Number of tau+ in the event.

Definition at line 88 of file TauDecayModeModule.h.

◆ OrderedList

std::array<int, 46> OrderedList
staticconstexprprivate
Initial value:
= {
16, -16, 14, -14, 12, -12,
11, -11, 13, -13, -211, 211, -321, 321, -2212, 2212,
111, 310, 130, 221, 223, 331, 333,
-213, 213, 113,
-323, 323, 313, -313,
-20213, 20213,
-9000211, 9000211, 9000111, -10211, 10211, 10111,
-10213, 10213,
20223, 9010221,
3122, -3122,
94144,
22
}

PDG codes of ORDERED particles.

Definition at line 105 of file TauDecayModeModule.h.

105 {
106 16, -16, 14, -14, 12, -12, // neutrinos
107 11, -11, 13, -13, -211, 211, -321, 321, -2212, 2212, // charged final state particles
108 111, 310, 130, 221, 223, 331, 333, //neutral mesons
109 -213, 213, 113, //rho
110 -323, 323, 313, -313, //Kstar
111 -20213, 20213, //a1
112 -9000211, 9000211, 9000111, -10211, 10211, 10111, //a0
113 -10213, 10213, //b1
114 20223, 9010221, //f1,f0
115 3122, -3122, //lambda
116 94144,//alpha
117 22//gamma
118 };

◆ tauPair

bool tauPair
private

Boolean variable used to identify tau event.

Definition at line 84 of file TauDecayModeModule.h.

◆ vec_a00_1450

std::vector<int> vec_a00_1450
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 166 of file TauDecayModeModule.h.

◆ vec_a00_980

std::vector<int> vec_a00_980
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 163 of file TauDecayModeModule.h.

◆ vec_a0m_1450

std::vector<int> vec_a0m_1450
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 167 of file TauDecayModeModule.h.

◆ vec_a0m_980

std::vector<int> vec_a0m_980
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 164 of file TauDecayModeModule.h.

◆ vec_a0p_1450

std::vector<int> vec_a0p_1450
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 168 of file TauDecayModeModule.h.

◆ vec_a0p_980

std::vector<int> vec_a0p_980
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 165 of file TauDecayModeModule.h.

◆ vec_a1m

std::vector<int> vec_a1m
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 161 of file TauDecayModeModule.h.

◆ vec_a1p

std::vector<int> vec_a1p
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 162 of file TauDecayModeModule.h.

◆ vec_alpha

std::vector<int> vec_alpha
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 175 of file TauDecayModeModule.h.

◆ vec_anue

std::vector<int> vec_anue
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 136 of file TauDecayModeModule.h.

◆ vec_anumu

std::vector<int> vec_anumu
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 134 of file TauDecayModeModule.h.

◆ vec_anut

std::vector<int> vec_anut
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 132 of file TauDecayModeModule.h.

◆ vec_apro

std::vector<int> vec_apro
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 145 of file TauDecayModeModule.h.

◆ vec_b1m

std::vector<int> vec_b1m
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 169 of file TauDecayModeModule.h.

◆ vec_b1p

std::vector<int> vec_b1p
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 170 of file TauDecayModeModule.h.

◆ vec_dau_tauminus

std::vector<int> vec_dau_tauminus
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 179 of file TauDecayModeModule.h.

◆ vec_dau_tauplus

std::vector<int> vec_dau_tauplus
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 180 of file TauDecayModeModule.h.

◆ vec_em

std::vector<int> vec_em
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 137 of file TauDecayModeModule.h.

◆ vec_ep

std::vector<int> vec_ep
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 138 of file TauDecayModeModule.h.

◆ vec_eta

std::vector<int> vec_eta
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 150 of file TauDecayModeModule.h.

◆ vec_etapr

std::vector<int> vec_etapr
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 152 of file TauDecayModeModule.h.

◆ vec_f0

std::vector<int> vec_f0
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 172 of file TauDecayModeModule.h.

◆ vec_f1

std::vector<int> vec_f1
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 171 of file TauDecayModeModule.h.

◆ vec_gam

std::vector<int> vec_gam
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 176 of file TauDecayModeModule.h.

◆ vec_k0l

std::vector<int> vec_k0l
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 149 of file TauDecayModeModule.h.

◆ vec_k0s

std::vector<int> vec_k0s
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 148 of file TauDecayModeModule.h.

◆ vec_km

std::vector<int> vec_km
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 143 of file TauDecayModeModule.h.

◆ vec_kp

std::vector<int> vec_kp
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 144 of file TauDecayModeModule.h.

◆ vec_kstar0

std::vector<int> vec_kstar0
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 159 of file TauDecayModeModule.h.

◆ vec_kstar0_br

std::vector<int> vec_kstar0_br
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 160 of file TauDecayModeModule.h.

◆ vec_kstarm

std::vector<int> vec_kstarm
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 157 of file TauDecayModeModule.h.

◆ vec_kstarp

std::vector<int> vec_kstarp
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 158 of file TauDecayModeModule.h.

◆ vec_lambda

std::vector<int> vec_lambda
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 173 of file TauDecayModeModule.h.

◆ vec_lmb_br

std::vector<int> vec_lmb_br
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 174 of file TauDecayModeModule.h.

◆ vec_mum

std::vector<int> vec_mum
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 139 of file TauDecayModeModule.h.

◆ vec_mup

std::vector<int> vec_mup
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 140 of file TauDecayModeModule.h.

◆ vec_nue

std::vector<int> vec_nue
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 135 of file TauDecayModeModule.h.

◆ vec_numu

std::vector<int> vec_numu
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 133 of file TauDecayModeModule.h.

◆ vec_nut

std::vector<int> vec_nut
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 131 of file TauDecayModeModule.h.

◆ vec_omega

std::vector<int> vec_omega
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 151 of file TauDecayModeModule.h.

◆ vec_phi

std::vector<int> vec_phi
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 153 of file TauDecayModeModule.h.

◆ vec_pi0

std::vector<int> vec_pi0
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 147 of file TauDecayModeModule.h.

◆ vec_pim

std::vector<int> vec_pim
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 141 of file TauDecayModeModule.h.

◆ vec_pip

std::vector<int> vec_pip
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 142 of file TauDecayModeModule.h.

◆ vec_pro

std::vector<int> vec_pro
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 146 of file TauDecayModeModule.h.

◆ vec_radgam_taum

std::vector<int> vec_radgam_taum
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 177 of file TauDecayModeModule.h.

◆ vec_radgam_taup

std::vector<int> vec_radgam_taup
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 178 of file TauDecayModeModule.h.

◆ vec_rho0

std::vector<int> vec_rho0
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 156 of file TauDecayModeModule.h.

◆ vec_rhom

std::vector<int> vec_rhom
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 154 of file TauDecayModeModule.h.

◆ vec_rhop

std::vector<int> vec_rhop
private

Variable name of the vector where particles identified in the event are stored.

Definition at line 155 of file TauDecayModeModule.h.


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