Belle II Software development
PhysicsObjectsMiraBelleBhabhaModule Class Reference

A module template. More...

#include <PhysicsObjectsMiraBelleBhabhaModule.h>

Inheritance diagram for PhysicsObjectsMiraBelleBhabhaModule:
HistoModule Module PathElement

Public Types

enum  EModulePropFlags {
  c_Input = 1 ,
  c_Output = 2 ,
  c_ParallelProcessingCertified = 4 ,
  c_HistogramManager = 8 ,
  c_InternalSerializer = 16 ,
  c_TerminateInAllProcesses = 32 ,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

 PhysicsObjectsMiraBelleBhabhaModule ()
 Constructor.
 
void initialize () override
 Initializer.
 
void beginRun () override
 Called when entering a new run.
 
void event () override
 This method is called for each event.
 
void endRun () override
 This method is called if the current run ends.
 
void terminate () override
 This method is called at the end of the event processing.
 
void defineHisto () override
 Definition of the histograms.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level.
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module.
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module.
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module.
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished.
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module.
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter.
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module.
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

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

Private Member Functions

std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

TH1F * m_h_npxd = nullptr
 histogram for number of PXD hits associated with electron track
 
TH1F * m_h_nsvd = nullptr
 histogram for number of SVD hits associated with electron track
 
TH1F * m_h_ncdc = nullptr
 histogram for number of CDC hits associated with electron track
 
TH1F * m_h_topdig = nullptr
 histogram for TOP digits associated with electron track
 
TH1F * m_h_DetPhotonARICH = nullptr
 histogram for number of photon in ARICH associated with electron track
 
TH1F * m_h_dD0 = nullptr
 histogram for D0 difference between e+ and e-
 
TH1F * m_h_dZ0 = nullptr
 histogram for Z0 difference between e+ and e-
 
TH1F * m_h_dPtcms = nullptr
 histogram for Pt difference between e+ and e-
 
TH1F * m_h_Pval = nullptr
 histogram for Pvalue of tracks in CDC
 
TH1F * m_h_nExtraCDCHits = nullptr
 histogram for number of CDC hits not associated with any tracks
 
TH1F * m_h_nECLClusters = nullptr
 histogram for ECL clusters
 
TH1F * m_h_electronid = nullptr
 histogram for electron ID
 
TH1F * m_h_inv_p = nullptr
 histogram for invariant mass of di-electron
 
TH1F * m_h_ndf = nullptr
 histogram for n.d.f.
 
TH1F * m_h_D0 = nullptr
 histogram for D0 of electron track
 
TH1F * m_h_Z0 = nullptr
 histogram for Z0 of electron track
 
TH1F * m_h_theta = nullptr
 histogram for theta of electron track
 
TH1F * m_h_theta_lab = nullptr
 histogram for theta of electron track in lab frame
 
TH1F * m_h_Phi0 = nullptr
 histogram for phi of electron track
 
TH1F * m_h_Pt = nullptr
 histogram for Pt of electron track
 
TH1F * m_h_Mom = nullptr
 histogram for Momentum of electron track
 
TH1F * m_h_dPhicms = nullptr
 histogram for phi difference between e+ and e- in CMS
 
TH1F * m_h_dThetacms = nullptr
 histogram for theta difference between e+ and e- in CMS
 
std::string m_triggerIdentifier = ""
 Trigger identifier string used to select events for the histograms.
 
std::string m_ePListName = ""
 Name of the e+ particle list.
 
std::string m_bhabhaPListName = ""
 Name of the e+e- (Upsilon) particle list.
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

A module template.

A detailed description of your module.

Definition at line 23 of file PhysicsObjectsMiraBelleBhabhaModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

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

Constructor & Destructor Documentation

◆ PhysicsObjectsMiraBelleBhabhaModule()

Constructor.

Definition at line 35 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

35 : HistoModule()
36{
37 setDescription("Monitor Physics Objects Quality");
39
40 addParam("TriggerIdentifier", m_triggerIdentifier,
41 "Trigger identifier string used to select events for the histograms", std::string("software_trigger_cut&skim&accept_bhabha_all"));
42 addParam("ePListName", m_ePListName, "Name of the electron particle list", std::string("e+:physMiraBelle"));
43 addParam("bhabhaPListName", m_bhabhaPListName, "Name of the bhabha events particle list", std::string("Upsilon:ephysMiraBelle"));
44
45}
HistoModule()
Constructor.
Definition: HistoModule.h:32
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
std::string m_ePListName
Name of the e+ particle list.
std::string m_triggerIdentifier
Trigger identifier string used to select events for the histograms.
std::string m_bhabhaPListName
Name of the e+e- (Upsilon) particle list.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Called when entering a new run.

Reimplemented from HistoModule.

Definition at line 112 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

113{
114 m_h_npxd->Reset();
115 m_h_nsvd->Reset();
116 m_h_ncdc->Reset();
117 m_h_topdig->Reset();
118 m_h_DetPhotonARICH->Reset();
119 m_h_Pval->Reset();
120 m_h_dD0->Reset();
121 m_h_dZ0->Reset();
122 m_h_dPtcms->Reset();
123 m_h_nExtraCDCHits->Reset();
124 m_h_nECLClusters->Reset();
125 m_h_electronid->Reset();
126 m_h_inv_p->Reset();
127 m_h_ndf->Reset();
128 m_h_D0->Reset();
129 m_h_Z0->Reset();
130 m_h_theta->Reset();
131 m_h_theta_lab->Reset();
132 m_h_Phi0->Reset();
133 m_h_Pt->Reset();
134 m_h_Mom->Reset();
135 m_h_dPhicms->Reset();
136 m_h_dThetacms->Reset();
137}
TH1F * m_h_dZ0
histogram for Z0 difference between e+ and e-
TH1F * m_h_DetPhotonARICH
histogram for number of photon in ARICH associated with electron track
TH1F * m_h_dPhicms
histogram for phi difference between e+ and e- in CMS
TH1F * m_h_Mom
histogram for Momentum of electron track
TH1F * m_h_dPtcms
histogram for Pt difference between e+ and e-
TH1F * m_h_theta
histogram for theta of electron track
TH1F * m_h_ncdc
histogram for number of CDC hits associated with electron track
TH1F * m_h_npxd
histogram for number of PXD hits associated with electron track
TH1F * m_h_dThetacms
histogram for theta difference between e+ and e- in CMS
TH1F * m_h_theta_lab
histogram for theta of electron track in lab frame
TH1F * m_h_nsvd
histogram for number of SVD hits associated with electron track
TH1F * m_h_nExtraCDCHits
histogram for number of CDC hits not associated with any tracks
TH1F * m_h_dD0
histogram for D0 difference between e+ and e-
TH1F * m_h_topdig
histogram for TOP digits associated with electron track
TH1F * m_h_inv_p
histogram for invariant mass of di-electron
TH1F * m_h_Pval
histogram for Pvalue of tracks in CDC
TH1F * m_h_Phi0
histogram for phi of electron track

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

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

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

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

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

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

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

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

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

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

◆ defineHisto()

void defineHisto ( )
overridevirtual

Definition of the histograms.

Reimplemented from HistoModule.

Definition at line 47 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

48{
49 TDirectory* oldDir = gDirectory;
50 oldDir->mkdir("PhysicsObjectsMiraBelleBhabha");
51 oldDir->cd("PhysicsObjectsMiraBelleBhabha");
52
53 m_h_npxd = new TH1F("hist_npxd", "hist_npxd", 100, 0, 5);
54 m_h_npxd->SetXTitle("hist_npxd");
55 m_h_nsvd = new TH1F("hist_nsvd", "hist_nsvd", 100, 0, 16);
56 m_h_nsvd->SetXTitle("hist_nsvd");
57 m_h_ncdc = new TH1F("hist_ncdc", "hist_ncdc", 100, 0, 80);
58 m_h_ncdc->SetXTitle("hist_ncdc");
59 m_h_topdig = new TH1F("hist_topdig", "hist_topdig", 120, 0, 120);
60 m_h_topdig->SetXTitle("hist_topdig");
61 m_h_DetPhotonARICH = new TH1F("hist_DetPhotonARICH", "hist_DetPhotonARICH", 70, 0, 70);
62 m_h_DetPhotonARICH->SetXTitle("hist_DetPhotonARICH");
63 m_h_Pval = new TH1F("hist_Pval", "hist_Pval", 100, 0, 1);
64 m_h_Pval->SetXTitle("hist_Pval");
65 m_h_dD0 = new TH1F("hist_dD0", "hist_dD0", 100, -0.02, 0.02);
66 m_h_dD0->SetXTitle("hist_dD0");
67 m_h_dZ0 = new TH1F("hist_dZ0", "hist_dZ0", 100, -0.05, 0.05);
68 m_h_dZ0->SetXTitle("hist_dZ0");
69 m_h_dPtcms = new TH1F("hist_dPtcms", "hist_dPtcms", 100, -0.5, 0.5);
70 m_h_dPtcms->SetXTitle("hist_dPtcms");
71 m_h_nExtraCDCHits = new TH1F("hist_nExtraCDCHits", "hist_nExtraCDCHits", 500, 0, 5000);
72 m_h_nExtraCDCHits->SetXTitle("hist_nExtraCDCHits");
73 m_h_nECLClusters = new TH1F("hist_nECLClusters", "hist_nECLClusters", 100, 0, 60);
74 m_h_nECLClusters->SetXTitle("hist_nECLClusters");
75 m_h_electronid = new TH1F("hist_electronid", "hist_electronid", 20, 0, 1);
76 m_h_electronid->SetXTitle("hist_electronid");
77 m_h_inv_p = new TH1F("hist_inv_p", "hist_inv_p", 400, 0, 12);
78 m_h_inv_p->SetXTitle("hist_inv_p");
79 m_h_ndf = new TH1F("hist_ndf", "hist_ndf", 100, 0, 80);
80 m_h_ndf->SetXTitle("hist_ndf");
81 m_h_D0 = new TH1F("hist_D0", "hist_D0", 100, -0.1, 0.1);
82 m_h_D0->SetXTitle("hist_D0");
83 m_h_Z0 = new TH1F("hist_Z0", "hist_Z0", 100, -0.3, 0.3);
84 m_h_Z0->SetXTitle("hist_Z0");
85 m_h_theta = new TH1F("hist_theta", "hist_theta in CMS", 32, 10, 170);
86 m_h_theta->SetXTitle("hist_theta");
87 m_h_theta_lab = new TH1F("hist_theta_lab", "hist_theta in lab frame", 180, 0, 180);
88 m_h_theta_lab->SetXTitle("hist_theta_lab");
89 m_h_Phi0 = new TH1F("hist_Phi0", "hist_Phi0 in lab frame", 72, -180, 180);
90 m_h_Phi0->SetXTitle("hist_Phi0");
91 m_h_Pt = new TH1F("hist_Pt", "hist_Pt", 100, 0, 10);
92 m_h_Pt->SetXTitle("hist_Pt");
93 m_h_Mom = new TH1F("hist_Mom", "hist_Mom", 100, 0, 10);
94 m_h_Mom->SetXTitle("hist_Mom");
95 m_h_dPhicms = new TH1F("hist_dPhicms", "hist_dPhicms: 180#circ - |#phi_{1} - #phi_{2}|", 100, -10, 10);
96 m_h_dPhicms->SetXTitle("hist_dPhicms");
97 m_h_dThetacms = new TH1F("hist_dThetacms", "hist_dThetacms: |#theta_{1} + #theta_{2}| - 180#circ", 100, -10, 10);
98 m_h_dThetacms->SetXTitle("hist_dThetacms");
99
100 oldDir->cd();
101}

◆ endRun()

void endRun ( void  )
overridevirtual

This method is called if the current run ends.

Reimplemented from HistoModule.

Definition at line 247 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

248{
249}

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

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

◆ event()

void event ( void  )
overridevirtual

This method is called for each event.

Reimplemented from HistoModule.

Definition at line 139 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

140{
141
143 if (!result.isValid()) {
144 B2WARNING("SoftwareTriggerResult object not available but needed to select events for the histograms.");
145 return;
146 }
147
148 const std::map<std::string, int>& results = result->getResults();
149 if (results.find(m_triggerIdentifier) == results.end()) {
150 B2WARNING("PhysicsObjectsMiraBelleBhabha: Can't find trigger identifier: " << m_triggerIdentifier);
151 return;
152 }
153
154 // apply software trigger
155 const bool accepted = (result->getResult(m_triggerIdentifier) == SoftwareTriggerCutResult::c_accept);
156 if (accepted == false) return;
157
158 // for resolution (difference b/w 2 tracks)
159 double d0[2] = {};
160 double z0[2] = {};
161 double ptcms[2] = {};
162 double phicms[2] = {};
163 double thetacms[2] = {};
164
165 //get the bhabha events for beam energy check
167 if (UpsParticles.isValid()) {
168 for (unsigned int i = 0; i < UpsParticles->getListSize(); i++) {
169 Particle* Ups = UpsParticles->getParticle(i);
170 m_h_inv_p->Fill(Ups->getMass());
171 }
172 }
173
174 // get electrons
175 StoreObjPtr<ParticleList> electronParticles(m_ePListName);
176 for (unsigned int i = 0; i < electronParticles->getListSize(); i++) {
177 Particle* electron = electronParticles->getParticle(i);
178 const Belle2::Track* track = electron->getTrack();
179 if (!track) {
180 continue;
181 }
182
183 // Detector hits
184 m_h_npxd->Fill(Belle2::Variable::trackNPXDHits(electron));
185 m_h_nsvd->Fill(Belle2::Variable::trackNSVDHits(electron));
186 m_h_ncdc->Fill(Belle2::Variable::trackNCDCHits(electron));
187 m_h_topdig->Fill(Belle2::Variable::TOPVariable::topDigitCount(electron));
188 ARICHLikelihood* lkh = track->getRelated<ARICHLikelihood>();
189 if (lkh) {
190 m_h_DetPhotonARICH->Fill(lkh->getDetPhot());
191 }
192
193 // electron ID
194 PIDLikelihood* pid_lkh = track->getRelated<PIDLikelihood>();
195 if (pid_lkh) {
197 }
198
199 // Track variables
200 const TrackFitResult* fitresult = track->getTrackFitResult(Belle2::Const::pion);
201 if (fitresult) {
202 // Pvalue
203 double pval = fitresult->getPValue();
204 m_h_Pval->Fill(pval);
205 // separate electron+ and electron-
206 int index = fitresult->getChargeSign() > 0 ? 0 : 1;
207 d0[index] = fitresult->getD0();
208 z0[index] = fitresult->getZ0();
209 m_h_D0->Fill(d0[index]);
210 m_h_Z0->Fill(z0[index]);
211 // Momentum
212 ptcms[index] = Belle2::PCmsLabTransform::labToCms(fitresult->get4Momentum()).Pt();//CMS
213 phicms[index] = Belle2::PCmsLabTransform::labToCms(fitresult->get4Momentum()).Phi() * TMath::RadToDeg();
214 thetacms[index] = Belle2::PCmsLabTransform::labToCms(fitresult->get4Momentum()).Theta() * TMath::RadToDeg();
215 m_h_Pt->Fill(fitresult->get4Momentum().Pt());//Lab
216 m_h_theta->Fill(Belle2::PCmsLabTransform::labToCms(fitresult->get4Momentum()).Theta() * TMath::RadToDeg());//CMS
217 m_h_theta_lab->Fill(fitresult->get4Momentum().Theta() * TMath::RadToDeg());//Lab
218 m_h_Phi0->Fill(fitresult->get4Momentum().Phi() * TMath::RadToDeg());//Lab
219 m_h_Mom->Fill(fitresult->get4Momentum().P());//Lab
220 }
221 }
222 // Resolution
223 m_h_dD0->Fill((d0[0] + d0[1]) / sqrt(2));
224 m_h_dZ0->Fill((z0[0] - z0[1]) / sqrt(2));
225 m_h_dPtcms->Fill((ptcms[0] - ptcms[1]) / sqrt(2));
226 m_h_dPhicms->Fill(180 - abs(phicms[0] - phicms[1]));
227 m_h_dThetacms->Fill(abs(thetacms[0] + thetacms[1]) - 180);
228 // Event level information
230 if (elti) {
231 m_h_nExtraCDCHits->Fill(elti->getNCDCHitsNotAssigned());
232 }
233 //nECLClustersLE
234 double neclClusters = -1.;
235 StoreArray<ECLCluster> eclClusters;
236 if (eclClusters.isValid()) {
237 const unsigned int numberOfECLClusters = std::count_if(eclClusters.begin(), eclClusters.end(),
238 [](const ECLCluster & eclcluster) {
239 return (eclcluster.hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons)
240 and eclcluster.getEnergy(ECLCluster::EHypothesisBit::c_nPhotons) > 0.1);
241 });
242 neclClusters = numberOfECLClusters;
243 }
244 m_h_nECLClusters->Fill(neclClusters);
245}
This is a class to store ARICH likelihoods in the datastore.
float getDetPhot() const
Return number of detected photons for a given particle.
static const ChargedStable pion
charged pion particle
Definition: Const.h:661
static const ChargedStable electron
electron particle
Definition: Const.h:659
ECL cluster data.
Definition: ECLCluster.h:27
static ROOT::Math::PxPyPzMVector labToCms(const ROOT::Math::PxPyPzMVector &vec)
Transforms Lorentz vector into CM System.
Class to collect log likelihoods from TOP, ARICH, dEdx, ECL and KLM aimed for output to mdst includes...
Definition: PIDLikelihood.h:29
double getProbability(const Const::ChargedStable &p1, const Const::ChargedStable &p2, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
Return combined likelihood probability for a particle being p1 and not p2, assuming equal prior proba...
Class to store reconstructed particles.
Definition: Particle.h:75
const Track * getTrack() const
Returns the pointer to the Track object that was used to create this Particle (ParticleType == c_Trac...
Definition: Particle.cc:845
double getMass() const
Returns invariant mass (= nominal for FS particles)
Definition: Particle.h:507
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
bool isValid() const
Check wether the array was registered.
Definition: StoreArray.h:288
iterator end()
Return iterator to last entry +1.
Definition: StoreArray.h:320
iterator begin()
Return iterator to first entry.
Definition: StoreArray.h:318
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
Values of the result of a track fit with a given particle hypothesis.
short getChargeSign() const
Return track charge (1 or -1).
double getPValue() const
Getter for Chi2 Probability of the track fit.
ROOT::Math::PxPyPzEVector get4Momentum() const
Getter for the 4Momentum at the closest approach of the track in the r/phi projection.
double getD0() const
Getter for d0.
double getZ0() const
Getter for z0.
Class that bundles various TrackFitResults.
Definition: Track.h:25
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28
@ c_accept
Accept this event.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

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

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

Returns
A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

Initializer.

Reimplemented from HistoModule.

Definition at line 104 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

105{
106 REG_HISTOGRAM
107
109 result.isOptional();
110}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

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

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

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

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

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

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

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

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

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

void terminate ( void  )
overridevirtual

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

Reimplemented from HistoModule.

Definition at line 251 of file PhysicsObjectsMiraBelleBhabhaModule.cc.

252{
253}

Member Data Documentation

◆ m_bhabhaPListName

std::string m_bhabhaPListName = ""
private

Name of the e+e- (Upsilon) particle list.

Definition at line 100 of file PhysicsObjectsMiraBelleBhabhaModule.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_ePListName

std::string m_ePListName = ""
private

Name of the e+ particle list.

Definition at line 97 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_D0

TH1F* m_h_D0 = nullptr
private

histogram for D0 of electron track

Definition at line 83 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_dD0

TH1F* m_h_dD0 = nullptr
private

histogram for D0 difference between e+ and e-

Definition at line 70 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_DetPhotonARICH

TH1F* m_h_DetPhotonARICH = nullptr
private

histogram for number of photon in ARICH associated with electron track

Definition at line 68 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_dPhicms

TH1F* m_h_dPhicms = nullptr
private

histogram for phi difference between e+ and e- in CMS

Definition at line 90 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_dPtcms

TH1F* m_h_dPtcms = nullptr
private

histogram for Pt difference between e+ and e-

Definition at line 72 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_dThetacms

TH1F* m_h_dThetacms = nullptr
private

histogram for theta difference between e+ and e- in CMS

Definition at line 91 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_dZ0

TH1F* m_h_dZ0 = nullptr
private

histogram for Z0 difference between e+ and e-

Definition at line 71 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_electronid

TH1F* m_h_electronid = nullptr
private

histogram for electron ID

Definition at line 79 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_inv_p

TH1F* m_h_inv_p = nullptr
private

histogram for invariant mass of di-electron

Definition at line 81 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_Mom

TH1F* m_h_Mom = nullptr
private

histogram for Momentum of electron track

Definition at line 89 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_ncdc

TH1F* m_h_ncdc = nullptr
private

histogram for number of CDC hits associated with electron track

Definition at line 66 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_ndf

TH1F* m_h_ndf = nullptr
private

histogram for n.d.f.

of electron track

Definition at line 82 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_nECLClusters

TH1F* m_h_nECLClusters = nullptr
private

histogram for ECL clusters

Definition at line 77 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_nExtraCDCHits

TH1F* m_h_nExtraCDCHits = nullptr
private

histogram for number of CDC hits not associated with any tracks

Definition at line 76 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_npxd

TH1F* m_h_npxd = nullptr
private

histogram for number of PXD hits associated with electron track

Definition at line 64 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_nsvd

TH1F* m_h_nsvd = nullptr
private

histogram for number of SVD hits associated with electron track

Definition at line 65 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_Phi0

TH1F* m_h_Phi0 = nullptr
private

histogram for phi of electron track

Definition at line 87 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_Pt

TH1F* m_h_Pt = nullptr
private

histogram for Pt of electron track

Definition at line 88 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_Pval

TH1F* m_h_Pval = nullptr
private

histogram for Pvalue of tracks in CDC

Definition at line 74 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_theta

TH1F* m_h_theta = nullptr
private

histogram for theta of electron track

Definition at line 85 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_theta_lab

TH1F* m_h_theta_lab = nullptr
private

histogram for theta of electron track in lab frame

Definition at line 86 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_topdig

TH1F* m_h_topdig = nullptr
private

histogram for TOP digits associated with electron track

Definition at line 67 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_h_Z0

TH1F* m_h_Z0 = nullptr
private

histogram for Z0 of electron track

Definition at line 84 of file PhysicsObjectsMiraBelleBhabhaModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 510 of file Module.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_triggerIdentifier

std::string m_triggerIdentifier = ""
private

Trigger identifier string used to select events for the histograms.

Definition at line 94 of file PhysicsObjectsMiraBelleBhabhaModule.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.


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