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:

Collaboration diagram for TauDecayModeModule:

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.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Protected Attributes
std::string	m_printmode
	Parameter passed by the user to indicated the informationt 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.
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
StoreObjPtr< TauPairDecay >	m_tauDecay
	pointer to tau pair decay objects
StoreObjPtr< EventMetaData >	m_event_metadata
	event number
int	m_taum_no
	number of tau- unclassified events
int	m_taup_no
	number of tau+ unclassified events
StoreArray< MCParticle >	MCParticles
	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+.
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_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< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Static Private Attributes
static constexpr int	finalStatePDGs [5] = { 11, 13, 211, 321, 2212 }
	PDG codes accepted as charged final state particles in generation: {e, mu, pi, K, p}.
static constexpr int	Neutrinos [3] = { 12, 14, 16 }
	PDG codes of neutrinos in final state particles in generation: {nu_e, nu_mu, mu_tau}.
static constexpr int	OrderedList [46]
	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 31 of file TauDecayModeModule.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

TauDecayModeModule()

TauDecayModeModule

(

)

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

Definition at line 61 of file TauDecayModeModule.cc.

                                       : Module(), m_taum_no(0), m_taup_no(0), m_mmode(-2), m_pmode(-2),
  m_mprong(0), m_pprong(0), tauPair(false), numOfTauMinus(0), numOfTauPlus(0), idOfTauMinus(-1), idOfTauPlus(-1),
  m_isEtaPizPizPizFromTauMinus(false), m_isEtaPizPizPizFromTauPlus(false),
  m_isOmegaPimPipFromTauMinus(false), m_isOmegaPimPipFromTauPlus(false)
{
  // Set module properties
  setDescription("Module to identify generated tau pair decays, using MCParticle information."
                 "By default, each tau decay is numbered as TauolaBelle2DecayMode [Ref: BELLE2-NOTE-PH-2020-055]");
  //Parameter definition
  addParam("printmode",  m_printmode, "Printout more information from each event", std::string("default"));
  addParam("file_minus", m_file_minus, "Path for an alternative mapping for tau- decays", std::string(""));
  addParam("file_plus",  m_file_plus, "Path for an alternative mapping for tau+ decays", std::string(""));
}

Member Function Documentation

AnalyzeTauPairEvent()

void AnalyzeTauPairEvent ( )

private

Analyze a generated tau pair event.

Definition at line 140 of file TauDecayModeModule.cc.

{
  // Clear local vectors
  vec_nut.clear();
  vec_anut.clear();
  vec_numu.clear();
  vec_anumu.clear();
  vec_nue.clear();
  vec_anue.clear();
  vec_em.clear();
  vec_ep.clear();
  vec_mum.clear();
  vec_mup.clear();
  vec_pim.clear();
  vec_pip.clear();
  vec_km.clear();
  vec_kp.clear();
  vec_apro.clear();
  vec_pro.clear();
  vec_pi0.clear();
  vec_k0s.clear();
  vec_k0l.clear();
  vec_eta.clear();
  vec_omega.clear();
  vec_etapr.clear();
  vec_phi.clear();
  vec_rhom.clear();
  vec_rhop.clear();
  vec_rho0.clear();
  vec_kstarm.clear();
  vec_kstarp.clear();
  vec_kstar0.clear();
  vec_kstar0_br.clear();
  vec_a1m.clear();
  vec_a1p.clear();
  vec_a00_980.clear();
  vec_a0m_980.clear();
  vec_a0p_980.clear();
  vec_a00_1450.clear();
  vec_a0m_1450.clear();
  vec_a0p_1450.clear();
  vec_b1m.clear();
  vec_b1p.clear();
  vec_f1.clear();
  vec_f0.clear();
  vec_lambda.clear();
  vec_lmb_br.clear();
  vec_alpha.clear();
  vec_gam.clear();
  //
  map<int, std::vector<int>> map_vec;
  //
  map_vec[11] = vec_em;
  map_vec[-11] = vec_ep;
  map_vec[12] = vec_nue;
  map_vec[-12] = vec_anue;
  map_vec[13] = vec_mum;
  map_vec[-13] = vec_mup;
  map_vec[14] = vec_numu;
  map_vec[-14] = vec_anumu;
  map_vec[16] = vec_nut;
  map_vec[-16] = vec_anut;
  map_vec[-211] = vec_pim;
  map_vec[211] = vec_pip;
  map_vec[-321] = vec_km;
  map_vec[321] = vec_kp;
  map_vec[-2212] = vec_apro;
  map_vec[2212] = vec_pro;
  map_vec[111] = vec_pi0;
  map_vec[310] = vec_k0s;
  map_vec[130] = vec_k0l;
  map_vec[221] = vec_eta;
  map_vec[223] = vec_omega;
  map_vec[331] = vec_etapr;
  map_vec[333] = vec_phi;
  map_vec[-213] = vec_rhom;
  map_vec[213] = vec_rhop;
  map_vec[113] = vec_rho0;
  map_vec[-323] = vec_kstarm;
  map_vec[323] = vec_kstarp;
  map_vec[313] = vec_kstar0;
  map_vec[-313] = vec_kstar0_br;
  map_vec[-20213] = vec_a1m;
  map_vec[20213] = vec_a1p;
  map_vec[-9000211] = vec_a0m_980;
  map_vec[9000211]  = vec_a0p_980;
  map_vec[9000111]  = vec_a00_980;
  map_vec[-10211] = vec_a0m_1450;
  map_vec[10211]  = vec_a0p_1450;
  map_vec[10111]  = vec_a00_1450;
  map_vec[-10213] = vec_b1m;
  map_vec[10213] = vec_b1p;
  map_vec[20223] = vec_f1;
  map_vec[9010221] = vec_f0;
  map_vec[3122] = vec_lambda;
  map_vec[-3122] = vec_lmb_br;
  map_vec[94144] = vec_alpha;
  map_vec[22] = vec_gam;
 
  bool elecFirst = true;
  bool muonFirst = true;
 
  bool isPiPizGamTauMinusFirst = true;
  bool isPiPizGamTauPlusFirst = true;
 
  bool isLFVTauMinus2BodyDecayFirst = true;
  bool isLFVTauPlus2BodyDecayFirst = true;
 
  bool isChargedRhoFromTauMinusFirst = true;
  bool isChargedRhoFromTauPlusFirst = true;
 
  bool isChargedA1FromTauMinusFirst = true;
  bool isChargedA1FromTauPlusFirst = true;
 
  bool isEtaPPGFromTauMinusFirst = true;
  bool isEtaPPGFromTauPlusFirst = true;
 
  bool isOmegaPizGamFromTauMinusFirst = true;
  bool isOmegaPizGamFromTauPlusFirst = true;
 
  bool isEtaPizPizPizFromTauMinusFirst = true;
  bool isEtaPizPizPizFromTauPlusFirst = true;
 
  m_isEtaPizPizPizFromTauMinus = false;
  m_isEtaPizPizPizFromTauPlus = false;
 
  bool isOmegaPimPipFromTauMinusFirst = true;
  bool isOmegaPimPipFromTauPlusFirst = true;
 
  m_isOmegaPimPipFromTauMinus = false;
  m_isOmegaPimPipFromTauPlus = false;
 
  // Loop of MCParticles
  for (int i = 0; i < MCParticles.getEntries(); i++) {
 
    MCParticle& p = *MCParticles[i];
 
    int pdgid = p.getPDG();
 
    if (pdgid == -Const::Klong.getPDGCode()) pdgid = Const::Klong.getPDGCode(); // Strange feature in TauolaBelle2
 
    if (!p.hasStatus(MCParticle::c_PrimaryParticle))
      continue; // only consider particles coming from generator, e.g. discard particles added by Geant4
    if (p.isInitial()) continue; // pick e-  e+, but not from the incoming beams
 
    if (pdgid == Const::electron.getPDGCode() && elecFirst)  {
      elecFirst = false;
      const MCParticle* mother = p.getMother();
      if (not mother) continue; // In some low multiplicity generators there may be no mother
      const vector<MCParticle*> daughters = mother->getDaughters();
      int nElMinus = 0;
      int nElPlus = 0;
      stringstream elec_ss;
      for (MCParticle* d : daughters) {
        if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
        elec_ss <<  d->getPDG() << " ";
        if (d->getPDG() == Const::electron.getPDGCode()) nElMinus++;
        if (d->getPDG() == -Const::electron.getPDGCode()) nElPlus++;
      }
      if (nElMinus == 1 && nElPlus == 1) { // use this information in getRecursiveMotherCharge
        B2DEBUG(1, "Mother of elec pair is = " << mother->getPDG() << " which has daughters : " << elec_ss.str());
      }
    }
 
    if (pdgid == Const::muon.getPDGCode() && muonFirst)  {
      muonFirst = false;
      const MCParticle* mother = p.getMother();
      if (not mother) continue; // In some low multiplicity generators there may be no mother
      const vector<MCParticle*> daughters = mother->getDaughters();
      int nMuMinus = 0;
      int nMuPlus = 0;
      stringstream muon_ss;
      for (MCParticle* d : daughters) {
        if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
        muon_ss <<  d->getPDG() << " ";
        if (d->getPDG() == Const::muon.getPDGCode()) nMuMinus++;
        if (d->getPDG() == -Const::muon.getPDGCode()) nMuPlus++;
      }
      if (nMuMinus == 1 && nMuPlus == 1) { // use this information in getRecursiveMotherCharge
        B2DEBUG(1, "Mother of muon pair is = " << mother->getPDG() << " which has daughters : " << muon_ss.str());
      }
    }
 
    // Special treatment for photons
    bool accept_photon = false;
    if (pdgid == Const::photon.getPDGCode())  {
      const MCParticle* mother = p.getMother();
      if (not mother) continue; // In some low multiplicity generators there may be no mother
      int mothid = abs(mother->getPDG());
 
      // check if the gamma comes from final state charged particles {e, mu, pi, K, p, b_1}
      bool isRadiationfromFinalStateChargedParticle = false;
      if (mothid == 11 ||
          mothid == 13 ||
          mothid == 211 ||
          mothid == 321 ||
          mothid == 2212 ||
          mothid == 10213) {
        isRadiationfromFinalStateChargedParticle = true;
      }
 
      // check if the gamma from ChargedRho
      bool isRadiationFromChargedRho = false;
      if (mothid == 213) {
        int chg = getRecursiveMotherCharge(mother);
        if (chg < 0 && isChargedRhoFromTauMinusFirst) {
          isChargedRhoFromTauMinusFirst = false;
          isRadiationFromChargedRho = true;
        }
        if (chg > 0 && isChargedRhoFromTauPlusFirst) {
          isChargedRhoFromTauPlusFirst = false;
          isRadiationFromChargedRho = true;
        }
      }
 
      // check if the gamma from ChargedA1
      bool isRadiationFromChargedA1 = false;
      if (mothid == 20213) {
        int chg = getRecursiveMotherCharge(mother);
        if (chg < 0 && isChargedA1FromTauMinusFirst) {
          isChargedA1FromTauMinusFirst = false;
          isRadiationFromChargedA1 = true;
        }
        if (chg > 0 && isChargedA1FromTauPlusFirst) {
          isChargedA1FromTauPlusFirst = false;
          isRadiationFromChargedA1 = true;
        }
      }
 
      // check if the gamma comes from intermediate W+- boson
      bool isRadiationfromIntermediateWBoson = false;
      if (mothid == 24) isRadiationfromIntermediateWBoson = true;
 
      // check if it is a tau- -> pi- omega nu, omega -> pi0 gamma decay
      // Note: TauolaBelle2 generator treats this a coherent production
      // e.g. includes omega in the form factor but not as an explicit final state particle
      bool isPiPizGam = false;
      if (isRadiationfromIntermediateWBoson) {
        if (p.get4Vector().E() > 0.050) { // 50 MeV threshold
          const vector<MCParticle*> daughters = mother->getDaughters();
          int nPiSisters = 0;
          int nPizSisters = 0;
          int nTotSisters = 0;
          int nOtherSisters = 0;
          for (MCParticle* d : daughters) {
            if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
            nTotSisters++;
            if (abs(d->getPDG()) == 211) {
              nPiSisters++;
            } else if (abs(d->getPDG()) == 111) {
              nPizSisters++;
            } else if (abs(d->getPDG()) != 22) {
              nOtherSisters++;
            }
          }
          // allow final state radiation from the tau lepton, but ignore information on number of photons for decay mode classifiction
          if (nTotSisters >= 3 && nPiSisters == 1 && nPizSisters == 1 && nOtherSisters == 0) {
            int chg = getRecursiveMotherCharge(mother);
            if (chg < 0 && isPiPizGamTauMinusFirst) {
              isPiPizGamTauMinusFirst = false;
              isPiPizGam = true;
            }
            if (chg > 0 && isPiPizGamTauPlusFirst) {
              isPiPizGamTauPlusFirst = false;
              isPiPizGam = true;
            }
          }
        }
      }
 
      // check if the gamma comes from tau
      bool isRadiationfromTau = false;
      if (mothid == 15) isRadiationfromTau = true;
 
      // 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
      bool isLFVTau2BodyDecay = false;
      if (isRadiationfromTau) {
        bool hasNeutrinoAsSister = false;
        int numChargedSister = 0;
        int numNeutralNonNeutrinoNonPhotonSister = 0;
        const vector<MCParticle*> daughters = mother->getDaughters();
        for (MCParticle* d : daughters) {
          if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
          hasNeutrinoAsSister = find(begin(Neutrinos), end(Neutrinos), abs(d->getPDG())) != end(Neutrinos);
          if (hasNeutrinoAsSister) break;
        }
        if (!hasNeutrinoAsSister) {
          for (MCParticle* d : daughters) {
            if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
            bool isChargedFinalState = find(begin(finalStatePDGs), end(finalStatePDGs), abs(d->getPDG())) != end(finalStatePDGs);
            if (isChargedFinalState) {
              numChargedSister++;
            } else if (d->getPDG() != 22) {
              numNeutralNonNeutrinoNonPhotonSister++;
            }
          }
          if (numChargedSister == 1 && numNeutralNonNeutrinoNonPhotonSister == 0) {
            if (mother->getPDG() == 15 && isLFVTauMinus2BodyDecayFirst) {
              isLFVTauMinus2BodyDecayFirst = false;
              isLFVTau2BodyDecay = true;
            }
            if (mother->getPDG() == -15 && isLFVTauPlus2BodyDecayFirst) {
              isLFVTauPlus2BodyDecayFirst = false;
              isLFVTau2BodyDecay = true;
            }
          }
        }
        B2DEBUG(1, "hasNeutrinoAsSister = " << hasNeutrinoAsSister
                << " numChargedSister = " << numChargedSister
                << " numNeutralNonNeutrinoNonPhotonSister = " << numNeutralNonNeutrinoNonPhotonSister
                << " isLFVTau2BodyDecay = " << isLFVTau2BodyDecay);
      }
 
      bool isPi0GG = false;
      bool isEtaGG = false;
      bool isEtpGG = false;
      bool isPi0GEE = false;
      bool isEtaPPG = false;
      bool isOmPizG = false;
      if (mothid == 111 || mothid == 221 || mothid == 331 || mothid == 223) {
        const vector<MCParticle*> daughters = mother->getDaughters();
        int numberofTotalDaughters = 0;
        int numberOfPhotonDaughters = 0;
        int numberOfElectronDaughters = 0;
        int numberOfPionDaughters = 0;
        int numberOfPizDaughters = 0;
        for (MCParticle* d : daughters) {
          if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
          numberofTotalDaughters ++;
          if (abs(d->getPDG()) == 22) numberOfPhotonDaughters++;
          if (abs(d->getPDG()) == 11) numberOfElectronDaughters++;
          if (abs(d->getPDG()) == 211) numberOfPionDaughters++;
          if (abs(d->getPDG()) == 111) numberOfPizDaughters++;
        }
        if (numberofTotalDaughters == 2 && numberOfPhotonDaughters == 2) {
          if (mothid == 111) isPi0GG = true;
          if (mothid == 221) isEtaGG = true;
          if (mothid == 331) isEtpGG = true;
        }
        if (numberofTotalDaughters >= 3 && numberOfPhotonDaughters >= 1 && numberOfElectronDaughters == 2 && numberOfPionDaughters == 0
            && numberOfPizDaughters == 0) {
          if (mothid == 111) isPi0GEE = true;
        }
        if (numberofTotalDaughters >= 3 && numberOfPhotonDaughters >= 1 && numberOfPizDaughters == 0 && numberOfPionDaughters == 2) {
          if (mothid == 221) {
            int chg = getRecursiveMotherCharge(mother);
            if (chg < 0 && isEtaPPGFromTauMinusFirst)  {
              isEtaPPGFromTauMinusFirst = false;
              isEtaPPG = true;
            }
            if (chg > 0 && isEtaPPGFromTauPlusFirst)  {
              isEtaPPGFromTauPlusFirst = false;
              isEtaPPG = true;
            }
          }
        }
        if (numberofTotalDaughters >= 2 && numberOfPhotonDaughters >= 1 && numberOfPizDaughters == 1 && numberOfPionDaughters == 0) {
          if (mothid == 223) {
            int chg = getRecursiveMotherCharge(mother);
            if (chg < 0 && isOmegaPizGamFromTauMinusFirst) {
              isOmegaPizGamFromTauMinusFirst = false;
              isOmPizG = true;
            }
            if (chg > 0 && isOmegaPizGamFromTauPlusFirst) {
              isOmegaPizGamFromTauPlusFirst = false;
              isOmPizG = true;
            }
          }
        }
      }
 
      B2DEBUG(1, "isRadiationfromFinalStateChargedParticle = " << isRadiationfromFinalStateChargedParticle);
      B2DEBUG(1, "isRadiationFromChargedRho = " << isRadiationFromChargedRho);
      B2DEBUG(1, "isRadiationFromChargedA1 = " << isRadiationFromChargedA1);
      B2DEBUG(1, "isRadiationfromIntermediateWBoson = " << isRadiationfromIntermediateWBoson << " isPiPizGam = " << isPiPizGam);
      B2DEBUG(1, "isRadiationfromTau = " << isRadiationfromTau << " isLFVTau2BodyDecay = " << isLFVTau2BodyDecay);
      B2DEBUG(1, "isPi0GG = " << isPi0GG << " isEtaGG = " << isEtaGG << " isEtpGG = " << isEtpGG << " isPi0GEE = " << isPi0GEE);
      B2DEBUG(1, "isEtaPPG = " << isEtaPPG << " isOmPizG = " << isOmPizG);
 
      // accept photons if (isRadiationfromFinalStateChargedParticle is false) or
      // if (isRadiationfromIntermediateWBoson is false) or
      // if (isRadiationfromTau is true) {gamma is from 2 body LFV decays of tau} or
      // if the radiation is coming from any other decay [except pi0 -> gamma gamma, eta-> gamma gamma, eta' -> gamma gamma]
      if (isRadiationfromFinalStateChargedParticle) {
      } else if (isRadiationFromChargedRho) {
        accept_photon = true;
      } else if (isRadiationFromChargedA1) {
        accept_photon = true;
      } else if (isRadiationfromIntermediateWBoson) {
        if (isPiPizGam) {
          accept_photon = true;
        }
      } else if (isRadiationfromTau) { // accept one photon from tau -> (charged particle) + gamma [no neutrinos]
        if (isLFVTau2BodyDecay) {
          accept_photon = true;
        }
      } else if (isPi0GG) {
      } else if (isEtaGG) {
      } else if (isEtpGG) {
      } else if (isPi0GEE) {
      } else if (isEtaPPG) {
        accept_photon = true;
      } else if (isOmPizG) {
        accept_photon = true;
      }
    }
 
    // Without further analysis, it is NOT possible to separate
    // tau- -> pi- 2pi0 eta (-> pi- pi+ pi0) nu decays [Mode 39] from
    // tau- -> 2pi- pi+ eta (-> pi0 pi0 pi0) nu decays [Mode 42]
 
    if (pdgid == 111 && (isEtaPizPizPizFromTauMinusFirst || isEtaPizPizPizFromTauPlusFirst)) {
      const MCParticle* mother = p.getMother();
      // In some low multiplicity generators there may be no mother
      if (mother and (mother->getPDG() == 221)) { // eta -> pi0 pi0 pi0
        const vector<MCParticle*> daughters = mother->getDaughters();
        int nPizSisters = 0;
        for (MCParticle* d : daughters) {
          if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
          if (d->getPDG() == 111) nPizSisters++;
        }
        B2DEBUG(1, "nPizSisters = " << nPizSisters);
        if (nPizSisters == 3) {
          int chg = getRecursiveMotherCharge(mother);
          if (chg < 0 && isEtaPizPizPizFromTauMinusFirst) {
            isEtaPizPizPizFromTauMinusFirst = false;
            m_isEtaPizPizPizFromTauMinus = true;
          }
          if (chg > 0 && isEtaPizPizPizFromTauPlusFirst) {
            isEtaPizPizPizFromTauPlusFirst = false;
            m_isEtaPizPizPizFromTauPlus = true;
          }
        }
      }
    }
    B2DEBUG(1,
            "isEtaPizPizPizFromTauMinusFirst = " << isEtaPizPizPizFromTauMinusFirst << " "
            "m_isEtaPizPizPizFromTauMinus = "    << m_isEtaPizPizPizFromTauMinus    << " "
            "isEtaPizPizPizFromTauPlusFirst = "  << isEtaPizPizPizFromTauPlusFirst  << " "
            "m_isEtaPizPizPizFromTauPlus = "     << m_isEtaPizPizPizFromTauPlus
           );
 
    // Without further analysis, it is NOT possible to separate
    // tau- ->  pi-     2pi0 omega (-> pi- pi+)     nu decays [Mode 49] from
    // tau- -> 2pi- pi+ 2pi0                        nu decays [Mode 66]
    // Note: TauolaBelle2 treats Mode 66 is coherent production,
    // e.g. includes omega in the form factor but not as an explicit final state particle.
    // Note2: omega is explicitly included in following mode:
    // tau- ->  pi-      pi0 omega (-> pi- pi+ pi0) nu decays [Mode 130]
    // which is where Mode 49 is mapped to if there is no omega->pi-pi+ decay
 
    // Same confusion can also happen for
    // tau- -> pi- pi0 omega (-> pi- pi+)     nu decays [Mode 131]
    // tau- -> pi-     omega (-> pi- pi+ pi0) nu decays [Mode 236]
 
    if (pdgid == -211 && (isOmegaPimPipFromTauMinusFirst || isOmegaPimPipFromTauPlusFirst)) {
      const MCParticle* mother = p.getMother();
      // In some low multiplicity generators there may be no mother
      if (mother and (mother->getPDG() == 223)) { // omega -> pi- pi+
        const vector<MCParticle*> daughters = mother->getDaughters();
        int nOmegaDaughters = 0;
        int nPimSisters = 0;
        int nPipSisters = 0;
        int nPizSisters = 0;
        for (MCParticle* d : daughters) {
          if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
          nOmegaDaughters++;
          if (d->getPDG() == -211) nPimSisters++;
          if (d->getPDG() ==  211) nPipSisters++;
          if (d->getPDG() ==  111) nPizSisters++;
        }
        B2DEBUG(1,
                "nOmegaDaughters = " << nOmegaDaughters << " "
                "nPimSisters = " << nPimSisters << " "
                "nPipSisters = " << nPipSisters << " "
                "nPizSisters = " << nPizSisters);
        if (nOmegaDaughters >= 2 && nPimSisters == 1 && nPipSisters == 1 && nPizSisters == 0) { // allow omega->pi-pi+gama
          int chg = getRecursiveMotherCharge(mother);
          if (chg < 0 && isOmegaPimPipFromTauMinusFirst) {
            isOmegaPimPipFromTauMinusFirst = false;
            m_isOmegaPimPipFromTauMinus = true;
          }
          if (chg > 0 && isOmegaPimPipFromTauPlusFirst) {
            isOmegaPimPipFromTauPlusFirst = false;
            m_isOmegaPimPipFromTauPlus = true;
          }
        }
      }
    }
    B2DEBUG(1,
            "isOmegaPimPipFromTauMinusFirst = " << isOmegaPimPipFromTauMinusFirst << " "
            "m_isOmegaPimPipFromTauMinus = "    << m_isOmegaPimPipFromTauMinus    << " "
            "isOmegaPimPipFromTauPlusFirst = "  << isOmegaPimPipFromTauPlusFirst  << " "
            "m_isOmegaPimPipFromTauPlus = "     << m_isEtaPizPizPizFromTauPlus
           );
 
    // Fill up all the vector of particles
    map<int, std::vector<int>>::iterator ite ;
    for (ite =  map_vec.begin(); ite !=  map_vec.end(); ++ite) {
      if (pdgid == ite->first) {
        if (pdgid == 22) {
          if (accept_photon) {
            B2DEBUG(1, "Photon accepted");
            ite-> second.push_back(i);
          }
        } else {
          ite-> second.push_back(i);
        }
        break;
      }
    }
 
  } // End of loop over MCParticles
 
  vec_dau_tauminus.clear();
  vec_dau_tauplus.clear();
 
  map<int, std::vector<int>>::iterator itr ;
  for (itr =  map_vec.begin(); itr !=  map_vec.end(); ++itr) {
    for (unsigned int i = 0; i < itr-> second.size(); i++) {
      int ii = itr-> second[i];
      int chg = getRecursiveMotherCharge(MCParticles[ii]);
      if (chg < 0) vec_dau_tauminus.push_back(ii);
      if (chg > 0) vec_dau_tauplus.push_back(ii);
    }
  }
 
  EvtGenDatabasePDG* databasePDG = EvtGenDatabasePDG::Instance();
  std::string pdgname;
 
  //make decay string for tau-
  m_tauminusdecaymode = "";
  for (unsigned iorder = 0; iorder < 46; ++iorder) {
    int ii = OrderedList[iorder];
    //
    for (unsigned int i = 0; i < vec_dau_tauminus.size(); i++) {
      MCParticle* p = MCParticles[vec_dau_tauminus[i]];
      int pdg = p->getPDG();
      if (pdg == -130) pdg = 130; // Strange Feature in TauolaBelle2
      if (pdg != ii) continue;
      m_tauminusdecaymode.append(".");
      if (pdg == 94144) {
        pdgname = "alpha";
      } else {
        pdgname = databasePDG->GetParticle(pdg)->GetName();
      }
      m_tauminusdecaymode.append(pdgname);
    }
  }
  //
  m_mmode = TauolaBelle2DecayMode(m_tauminusdecaymode, -1);
 
  //make decay string for tau+
  m_tauplusdecaymode = "";
  for (unsigned iorder = 0; iorder < 46; ++iorder) {
    int ii = OrderedList[iorder];
    //
    for (unsigned int i = 0; i < vec_dau_tauplus.size(); i++) {
      MCParticle* p = MCParticles[vec_dau_tauplus[i]];
      int pdg = p->getPDG();
      if (pdg == -130) pdg = 130; // Strange Feature in TauolaBelle2
      if (pdg != ii) continue;
      m_tauplusdecaymode.append(".");
      if (pdg == 94144) {
        pdgname = "alpha";
      } else {
        pdgname = databasePDG->GetParticle(pdg)->GetName();
      }
      m_tauplusdecaymode.append(pdgname);
    }
  }
  //
  m_pmode = TauolaBelle2DecayMode(m_tauplusdecaymode, 1);
 
}

beginRun()

virtual void beginRun ( )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented in EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, CreateFieldMapModule, ExportGeometryModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, and PyModule.

Definition at line 147 of file Module.h.

{};

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

endRun()

virtual void endRun ( )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Reimplemented in CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, AWESOMEBasicModule, and PyModule.

Definition at line 166 of file Module.h.

{};

evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( )

overridevirtual

Method is called for each event.

Reimplemented from Module.

Definition at line 85 of file TauDecayModeModule.cc.

{
 
  IdentifyTauPair();
  if (tauPair) {
 
    AnalyzeTauPairEvent();
 
    if (m_printmode == "missing") {
      if (m_mmode == -1) {
        B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
               << " Decay: tau- -> " << m_tauminusdecaymode << " Mode = " << m_mmode);
      }
      if (m_pmode == -1) {
        B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
               << " Decay: tau+ -> " << m_tauplusdecaymode  << " Mode = " << m_pmode);
      }
    }
 
    if (m_printmode == "all") {
      B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
             << " Decay: tau- -> " << m_tauminusdecaymode << " Mode = " << m_mmode);
      B2INFO("TauDecayMode:: EventNumber = " << m_event_metadata->getEvent()
             << " Decay: tau+ -> " << m_tauplusdecaymode  << " Mode = " << m_pmode);
    }
 
    //
    if (m_mmode == -1) {
      m_taum_no = m_taum_no - 1;
      m_mmode = m_taum_no;
    }
    if (m_pmode == -1) {
      m_taup_no = m_taup_no - 1;
      m_pmode = m_taup_no;
    }
 
    m_pprong = getProngOfDecay(*MCParticles[idOfTauPlus - 1]);
    m_mprong = getProngOfDecay(*MCParticles[idOfTauMinus - 1]);
 
  } else {
    m_pmode = -1;
    m_mmode = -1;
    m_pprong = -1;
    m_mprong = -1;
  }
 
  if (!m_tauDecay) m_tauDecay.create();
  m_tauDecay->addTauMinusIdMode(m_mmode);
  m_tauDecay->addTauPlusIdMode(m_pmode);
 
  m_tauDecay->addTauPlusMcProng(m_pprong);
  m_tauDecay->addTauMinusMcProng(m_mprong);
 
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

getProngOfDecay()

int getProngOfDecay ( const MCParticle &  mc )

private

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

Definition at line 802 of file TauDecayModeModule.cc.

{
  int ret = 0;
  const vector<MCParticle*> daughters = p.getDaughters();
  if (daughters.empty()) return ret;
  for (MCParticle* d : daughters) {
    if (!d->hasStatus(MCParticle::c_PrimaryParticle)) continue;
    // TODO: Improve how to identify a final state particle.
    bool isChargedFinalState = find(begin(finalStatePDGs),
                                    end(finalStatePDGs),
                                    abs(d->getPDG())) != end(finalStatePDGs);
    if (isChargedFinalState) ret++;
    else ret += getProngOfDecay(*d);
  }
  return ret;
}

getRecursiveMotherCharge()

int getRecursiveMotherCharge ( const MCParticle *  mc )

private

Identifies particles coming from tau decays.

Definition at line 747 of file TauDecayModeModule.cc.

{
  const MCParticle* mother = p->getMother();
  if (mother == nullptr) {
    return 0;
  } else if (abs(p->getPDG()) == 11 && mother->getPDG() == 111) { // pi0 -> e-e+ gamma
    return 0;
  } else if (abs(p->getPDG()) == 11 && mother->getPDG() == 221) { // eta -> e-e+ gamma
    return 0;
  } else if (abs(p->getPDG()) == 11 && mother->getPDG() == 113) { // rho0 -> e-e+
    return 0;
  } else if (abs(p->getPDG()) == 11 && mother->getPDG() == 223) { // omega -> e- e+
    return 0;
  } else if (abs(p->getPDG()) == 11 && mother->getPDG() == 333) { // phi -> e- e+
    return 0;
  } else if (abs(p->getPDG()) == 13 && mother->getPDG() == 221) { // eta -> mu-mu+ gamma
    return 0;
  } else if (abs(p->getPDG()) == 13 && mother->getPDG() == 113) { // rho0 -> mu-mu+
    return 0;
  } else if (abs(p->getPDG()) == 13 && mother->getPDG() == 333) { // phi -> mu-mu+
    return 0;
  } else if (mother->getPDG() == 15) {
    return -1;
  } else if (mother->getPDG() == -15) {
    return 1;
  } else {
    return getRecursiveMotherCharge(mother);
  }
}

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

IdentifyTauPair()

void IdentifyTauPair ( )

private

Identifies if the event is a generated tau pair.

Definition at line 778 of file TauDecayModeModule.cc.

{
  numOfTauPlus = 0;
  numOfTauMinus = 0;
  idOfTauPlus = 0;
  idOfTauMinus = 0;
  for (int i = 0; i < MCParticles.getEntries(); i++) {
    MCParticle& p = *MCParticles[i];
 
    if (p.getStatus() == 1 && p.getPDG() == 15) {
      numOfTauMinus++;
      idOfTauMinus = p.getIndex();
    }
    if (p.getStatus() == 1 && p.getPDG() == -15) {
      numOfTauPlus++;
      idOfTauPlus = p.getIndex();
    }
  }
  if (numOfTauPlus == 1 && numOfTauMinus == 1) {
    tauPair = true;
  } else tauPair = false;
}

if_false()

void if_false ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

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

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

if_true()

void if_true ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

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

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

if_value()

void if_value ( const std::string &  expression, const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( )

overridevirtual

Initializes the module.

Reimplemented from Module.

Definition at line 76 of file TauDecayModeModule.cc.

{
  mode_decay_minus = make_map(m_file_minus, -1);
  mode_decay_plus  = make_map(m_file_plus, 1);
  m_tauDecay.registerInDataStore();
  m_event_metadata.isRequired();
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

void setParamPython ( const std::string &  name, const boost::python::object &  pyObj  )

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

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

TauolaBelle2DecayMode()

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

private

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

Definition at line 717 of file TauDecayModeModule.cc.

{
  std::map<std::string, int> mode_decay = (chg < 0) ? mode_decay_minus : mode_decay_plus;
  map<std::string, int>::iterator itr ;
  for (itr =  mode_decay.begin(); itr !=  mode_decay.end(); ++itr) {
    if (state == itr-> first) {
      int mode = itr-> second;
      if (mode == 39) {
        if (chg < 0 && m_isEtaPizPizPizFromTauMinus) mode = 42;
        if (chg > 0 && m_isEtaPizPizPizFromTauPlus)  mode = 42;
      }
      if (mode == 49) {
        if (chg < 0 && !m_isOmegaPimPipFromTauMinus) mode = 130;
        if (chg > 0 && !m_isOmegaPimPipFromTauPlus)  mode = 130;
      }
      if (mode == 131) {
        if (chg < 0 && !m_isOmegaPimPipFromTauMinus) mode = 236;
        if (chg > 0 && !m_isOmegaPimPipFromTauPlus)  mode = 236;
      }
      if (mode == 247) {
        if (chg < 0 && !m_isEtaPizPizPizFromTauMinus) mode = 15;
        if (chg > 0 && !m_isEtaPizPizPizFromTauPlus)  mode = 15;
      }
      return mode;
    }
  }
  return -1;
}

terminate()

virtual void terminate ( )

inlinevirtualinherited

This method is called at the end of the event processing.

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented in CurlTaggerModule, EventKinematicsModule, FlavorTaggerInfoFillerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleKinematicFitterModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, RemoveParticlesNotInListsModule, SkimFilterModule, TreeFitterModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, MergeDataStoreModule, SubEventModule, SwitchDataStoreModule, ProgressBarModule, RandomBarrierModule, HistoManagerModule, ProfileModule, RootInputModule, RootOutputModule, SeqRootInputModule, SeqRootOutputModule, AsyncWrapper, RxModule, TxModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, ZMQTxWorkerModule, GeometryModule, MVAExpertModule, MVAMultipleExpertsModule, AWESOMEBasicModule, and PyModule.

Definition at line 176 of file Module.h.

{};

Member Data Documentation

finalStatePDGs

constexpr int finalStatePDGs[5] = { 11, 13, 211, 321, 2212 }

staticconstexprprivate

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

Definition at line 96 of file TauDecayModeModule.h.

idOfTauMinus

int idOfTauMinus

private

Index of the generated tau-.

Definition at line 87 of file TauDecayModeModule.h.

idOfTauPlus

int idOfTauPlus

private

Index of the generated tau+.

Definition at line 89 of file TauDecayModeModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_event_metadata

StoreObjPtr<EventMetaData> m_event_metadata

private

event number

Definition at line 55 of file TauDecayModeModule.h.

m_file_minus

std::string m_file_minus

private

Alternative mapping for tau-.

Definition at line 91 of file TauDecayModeModule.h.

m_file_plus

std::string m_file_plus

private

Alternative mapping for tau+.

Definition at line 93 of file TauDecayModeModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_isEtaPizPizPizFromTauMinus

bool m_isEtaPizPizPizFromTauMinus

private

Flag for eta->pi0pi0pi0 decays from tau-.

Definition at line 118 of file TauDecayModeModule.h.

m_isEtaPizPizPizFromTauPlus

bool m_isEtaPizPizPizFromTauPlus

private

Flag for eta->pi0pi0pi0 decays from tau+.

Definition at line 120 of file TauDecayModeModule.h.

m_isOmegaPimPipFromTauMinus

bool m_isOmegaPimPipFromTauMinus

private

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

Definition at line 123 of file TauDecayModeModule.h.

m_isOmegaPimPipFromTauPlus

bool m_isOmegaPimPipFromTauPlus

private

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

Definition at line 125 of file TauDecayModeModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_mmode

Int_t m_mmode

private

ID of the decay channel of tau-.

Definition at line 71 of file TauDecayModeModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_mprong

Int_t m_mprong

private

Prong of the decay channel of tau-.

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

m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

m_pmode

Int_t m_pmode

private

ID of the decay channel of tau+.

Definition at line 73 of file TauDecayModeModule.h.

m_pprong

Int_t m_pprong

private

Prong of the decay channel of tau+.

Definition at line 78 of file TauDecayModeModule.h.

m_printmode

std::string m_printmode

protected

Parameter passed by the user to indicated the informationt to be printed.

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

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_tauDecay

StoreObjPtr<TauPairDecay> m_tauDecay

private

pointer to tau pair decay objects

Definition at line 53 of file TauDecayModeModule.h.

m_taum_no

int m_taum_no

private

number of tau- unclassified events

Definition at line 56 of file TauDecayModeModule.h.

m_tauminusdecaymode

std::string m_tauminusdecaymode

private

Variable name for the decay mode of the tau-.

Definition at line 66 of file TauDecayModeModule.h.

m_taup_no

int m_taup_no

private

number of tau+ unclassified events

Definition at line 57 of file TauDecayModeModule.h.

m_tauplusdecaymode

std::string m_tauplusdecaymode

private

Variable name for the decay mode of the tau+.

Definition at line 68 of file TauDecayModeModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

MCParticles

StoreArray<MCParticle> MCParticles

private

StoreArray of MCParticles.

Definition at line 60 of file TauDecayModeModule.h.

mode_decay_minus

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

private

Mapping for tau- decays.

Definition at line 62 of file TauDecayModeModule.h.

mode_decay_plus

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

private

Mapping for tau+ decays.

Definition at line 64 of file TauDecayModeModule.h.

Neutrinos

constexpr int Neutrinos[3] = { 12, 14, 16 }

staticconstexprprivate

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

Definition at line 99 of file TauDecayModeModule.h.

numOfTauMinus

int numOfTauMinus

private

Number of tau- in the event.

Definition at line 83 of file TauDecayModeModule.h.

numOfTauPlus

int numOfTauPlus

private

Number of tau+ in the event.

Definition at line 85 of file TauDecayModeModule.h.

OrderedList

constexpr int OrderedList[46]

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 102 of file TauDecayModeModule.h.

tauPair

bool tauPair

private

Boolean variable used to identify tau event.

Definition at line 81 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 163 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 160 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 164 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 161 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 165 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 162 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 158 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 159 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 172 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 133 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 131 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 129 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 142 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 166 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 167 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 174 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 175 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 134 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 135 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 147 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 149 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 169 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 168 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 173 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 146 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 145 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 140 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 141 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 156 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 157 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 154 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 155 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 170 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 171 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 136 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 137 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 132 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 130 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 128 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 148 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 150 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 144 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 138 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 139 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 143 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 153 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 151 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 152 of file TauDecayModeModule.h.

---

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

• analysis/modules/TauDecayMode/include/TauDecayModeModule.h
• analysis/modules/TauDecayMode/src/TauDecayModeModule.cc