Belle II Software light-2406-ragdoll
ChargedPidMVAMulticlassModule Class Reference

This module evaluates the response of a multi-class MVA trained for global charged particle identification. More...

#include <ChargedPidMVAMulticlassModule.h>

Inheritance diagram for ChargedPidMVAMulticlassModule:
Collaboration diagram for ChargedPidMVAMulticlassModule:

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

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

Static Public Member Functions

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

Protected Member Functions

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

Private Types

typedef std::vector< std::unique_ptr< MVA::Expert > > ExpertsList
 Typedef.
 
typedef std::vector< std::unique_ptr< MVA::SingleDataset > > DatasetsList
 Typedef.
 
typedef std::vector< std::unique_ptr< Variable::Cut > > CutsList
 Typedef.
 
typedef std::vector< std::vector< const Variable::Manager::Var * > > VariablesLists
 Typedef.
 

Private Member Functions

void initializeMVA ()
 
const std::string getParticleName (const ParticleList *pList) const
 Split the particle list name in "particleName", "particleLabel", and return the particle name w/o the charge +/- label.
 
void registerAliasesLegacy ()
 Set variable aliases needed by the MVA.
 
void registerAliases ()
 Set variable aliases needed by the MVA.
 
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

StoreArray< Particlem_particles
 StoreArray of Particles.
 
std::vector< std::string > m_decayStrings
 The input list of DecayStrings, where each selected (^) daughter should correspond to a standard charged ParticleList, e.g.
 
std::string m_payload_name
 The name of the database payload object with the MVA weights.
 
bool m_charge_independent
 Flag to specify if we use a charge-independent training.
 
bool m_ecl_only
 Flag to specify if we use an ECL-only based training.
 
StoreObjPtr< EventMetaDatam_event_metadata
 The event information.
 
std::unique_ptr< DBObjPtr< ChargedPidMVAWeights > > m_weightfiles_representation
 Interface to get the database payload with the MVA weight files.
 
ExpertsList m_experts
 List of MVA::Expert objects.
 
DatasetsList m_datasets
 List of MVA::SingleDataset objects.
 
CutsList m_cuts
 List of Cut objects.
 
VariablesLists m_variables
 List of lists of feature variables.
 
VariablesLists m_spectators
 List of lists of spectator variables.
 
std::vector< std::string > m_classes
 List of MVA class names.
 
std::map< int, std::string > m_stdChargedInfo
 Map with standard charged particles' info.
 
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

This module evaluates the response of a multi-class MVA trained for global charged particle identification.

It takes the Particle objects in the input charged stable particles' ParticleLists, calculates the MVA per-class score using the appropriate xml weight file, and adds it as ExtraInfo to the Particle objects.

Definition at line 42 of file ChargedPidMVAMulticlassModule.h.

Member Typedef Documentation

◆ CutsList

typedef std::vector<std::unique_ptr<Variable::Cut> > CutsList
private

Typedef.

Definition at line 46 of file ChargedPidMVAMulticlassModule.h.

◆ DatasetsList

typedef std::vector<std::unique_ptr<MVA::SingleDataset> > DatasetsList
private

Typedef.

Definition at line 45 of file ChargedPidMVAMulticlassModule.h.

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

◆ ExpertsList

typedef std::vector<std::unique_ptr<MVA::Expert> > ExpertsList
private

Typedef.

Definition at line 44 of file ChargedPidMVAMulticlassModule.h.

◆ VariablesLists

typedef std::vector< std::vector<const Variable::Manager::Var*> > VariablesLists
private

Typedef.

Definition at line 47 of file ChargedPidMVAMulticlassModule.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

◆ ChargedPidMVAMulticlassModule()

Constructor, for setting module description and parameters.

Definition at line 25 of file ChargedPidMVAMulticlassModule.cc.

25 : Module()
26{
27 setDescription("This module evaluates the response of a multi-class MVA trained for global charged particle identification.. It takes the Particle objects in the input charged stable particles' ParticleLists, calculates the MVA per-class score using the appropriate xml weight file, and adds it as ExtraInfo to the Particle objects.");
28
30
31 addParam("particleLists",
33 "The input list of DecayStrings, where each selected (^) daughter should correspond to a standard charged ParticleList, e.g. ['Lambda0:sig -> ^p+ ^pi-', 'J/psi:sig -> ^mu+ ^mu-']. One can also directly pass a list of standard charged ParticleLists, e.g. ['e+:my_electrons', 'pi+:my_pions']. Note that charge-conjugated ParticleLists will automatically be included.",
34 std::vector<std::string>());
35 addParam("payloadName",
37 "The name of the database payload object with the MVA weights.",
38 std::string("ChargedPidMVAWeights"));
39 addParam("chargeIndependent",
41 "Specify whether to use a charge-independent training of the MVA.",
42 bool(false));
43 addParam("useECLOnlyTraining",
45 "Specify whether to use an ECL-only training of the MVA.",
46 bool(false));
47}
std::vector< std::string > m_decayStrings
The input list of DecayStrings, where each selected (^) daughter should correspond to a standard char...
bool m_ecl_only
Flag to specify if we use an ECL-only based training.
bool m_charge_independent
Flag to specify if we use a charge-independent training.
std::string m_payload_name
The name of the database payload object with the MVA weights.
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
Module()
Constructor.
Definition: Module.cc:30
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

void beginRun ( )
overridevirtual

Called once before a new run begins.

This method gives you the chance to change run dependent constants like alignment parameters, etc.

Reimplemented from Module.

Definition at line 65 of file ChargedPidMVAMulticlassModule.cc.

66{
67}

◆ 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

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

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

◆ event()

void event ( )
overridevirtual

Called once for each event.

This is most likely where your module will actually do anything.

Reimplemented from Module.

Definition at line 70 of file ChargedPidMVAMulticlassModule.cc.

71{
72
73 // Debug strings per log level.
74 std::map<int, std::string> debugStr = {
75 {11, ""},
76 {12, ""}
77 };
78
79 B2DEBUG(11, "EVENT: " << m_event_metadata->getEvent());
80
81 for (auto decayString : m_decayStrings) {
82
83 DecayDescriptor decayDescriptor;
84 decayDescriptor.init(decayString);
85 auto pListName = decayDescriptor.getMother()->getFullName();
86
87 unsigned short m_nSelectedDaughters = decayDescriptor.getSelectionNames().size();
88 StoreObjPtr<ParticleList> pList(pListName);
89
90 if (!pList) {
91 B2FATAL("ParticleList: " << pListName << " could not be found. Aborting...");
92 }
93
94 auto pListSize = pList->getListSize();
95
96 B2DEBUG(11, "ParticleList: " << pList->getParticleListName() << " - N = " << pListSize << " particles.");
97
98 const auto nTargetParticles = (m_nSelectedDaughters == 0) ? pListSize : pListSize * m_nSelectedDaughters;
99
100 // Need to get an absolute value in order to check if in Const::ChargedStable.
101 std::vector<int> pdgs;
102 if (m_nSelectedDaughters == 0) {
103 pdgs.push_back(pList->getPDGCode());
104 } else {
105 pdgs = decayDescriptor.getSelectionPDGCodes();
106 }
107 for (auto pdg : pdgs) {
108 // Check if this ParticleList is made up of legit Const::ChargedStable particles.
109 if (!(*m_weightfiles_representation.get())->isValidPdg(abs(pdg))) {
110 B2FATAL("PDG: " << pdg << " of ParticleList: " << pListName <<
111 " is not that of a valid particle in Const::chargedStableSet! Aborting...");
112 }
113 }
114 std::vector<const Particle*> targetParticles;
115 if (m_nSelectedDaughters > 0) {
116 for (unsigned int iPart(0); iPart < pListSize; ++iPart) {
117 auto* iParticle = pList->getParticle(iPart);
118 auto daughters = decayDescriptor.getSelectionParticles(iParticle);
119 for (auto* iDaughter : daughters) {
120 targetParticles.push_back(iDaughter);
121 }
122 }
123 }
124
125 for (unsigned int ipart(0); ipart < nTargetParticles; ++ipart) {
126
127 const Particle* particle = (m_nSelectedDaughters > 0) ? targetParticles[ipart] : pList->getParticle(ipart);
128
129 if (!(*m_weightfiles_representation.get())->hasImplicitNaNmasking()) {
130 // LEGACY TRAININGS: always require a track-cluster match.
131 const ECLCluster* eclCluster = particle->getECLCluster();
132 if (!eclCluster) {
133 B2DEBUG(11, "\nParticle [" << ipart << "] has invalid Track-ECLCluster relation, skip MVA application...");
134 continue;
135 }
136 }
137
138 // Retrieve the index for the correct MVA expert and dataset,
139 // given the reconstructed (polar angle, p, charge)
140 auto thVarName = (*m_weightfiles_representation.get())->getThetaVarName();
141 auto theta = std::get<double>(Variable::Manager::Instance().getVariable(thVarName)->function(particle));
142 auto p = particle->getP();
143 // Set a dummy charge of zero to pick charge-independent payloads, if requested.
144 auto charge = (!m_charge_independent) ? particle->getCharge() : 0.0;
145 if (std::isnan(theta) or std::isnan(p) or std::isnan(charge)) {
146 B2DEBUG(11, "\nParticle [" << ipart << "] has invalid input variable, skip MVA application..." <<
147 " polar angle: " << theta << ", p: " << p << ", charge: " << charge);
148 continue;
149 }
150
151 int idx_theta, idx_p, idx_charge;
152 auto index = (*m_weightfiles_representation.get())->getMVAWeightIdx(theta, p, charge, idx_theta, idx_p, idx_charge);
153
154 auto* matchVar = Variable::Manager::Instance().getVariable("clusterTrackMatch");
155 auto hasMatch = std::isnormal(std::get<double>(matchVar->function(particle)));
156
157 debugStr[11] += "\n";
158 debugStr[11] += ("Particle [" + std::to_string(ipart) + "]\n");
159 debugStr[11] += ("Has ECL cluster match? " + std::to_string(hasMatch) + "\n");
160 debugStr[11] += ("polar angle: " + thVarName + " = " + std::to_string(theta) + " [rad]\n");
161 debugStr[11] += ("p = " + std::to_string(p) + " [GeV/c]\n");
163 debugStr[11] += ("charge = " + std::to_string(charge) + "\n");
164 }
165 debugStr[11] += ("Is brems corrected ? " + std::to_string(particle->hasExtraInfo("bremsCorrected")) + "\n");
166 debugStr[11] += ("Weightfile idx = " + std::to_string(index) + " - (polar angle, p, charge) = (" + std::to_string(
167 idx_theta) + ", " + std::to_string(idx_p) + ", " +
168 std::to_string(idx_charge) + ")\n");
169 if (m_cuts.at(index)) {
170 debugStr[11] += ("Category cut: " + m_cuts.at(index)->decompile() + "\n");
171 }
172
173 B2DEBUG(11, debugStr[11]);
174 debugStr[11].clear();
175
176 // Don't even bother if particle does not fulfil the category selection.
177 if (m_cuts.at(index)) {
178 if (!m_cuts.at(index)->check(particle)) {
179 B2DEBUG(11, "\nParticle [" << ipart << "] didn't pass MVA category cut, skip MVA application...");
180 continue;
181 }
182 }
183
184 // Fill the MVA::SingleDataset w/ variables and spectators.
185
186 debugStr[11] += "\n";
187 debugStr[11] += "MVA variables:\n";
188
189 auto nvars = m_variables.at(index).size();
190 for (unsigned int ivar(0); ivar < nvars; ++ivar) {
191
192 auto varobj = m_variables.at(index).at(ivar);
193
194 double var = std::numeric_limits<double>::quiet_NaN();
195 auto var_result = varobj->function(particle);
196 if (std::holds_alternative<double>(var_result)) {
197 var = std::get<double>(var_result);
198 } else if (std::holds_alternative<int>(var_result)) {
199 var = std::get<int>(var_result);
200 } else if (std::holds_alternative<bool>(var_result)) {
201 var = std::get<bool>(var_result);
202 } else {
203 B2ERROR("Variable '" << varobj->name << "' has wrong data type! It must be one of double, integer, or bool.");
204 }
205
206 if (!(*m_weightfiles_representation.get())->hasImplicitNaNmasking()) {
207 // LEGACY TRAININGS: manual imputation value of -999 for NaN (undefined) variables. Needed by TMVA.
208 var = (std::isnan(var)) ? -999.0 : var;
209 }
210
211 debugStr[11] += ("\tvar[" + std::to_string(ivar) + "] : " + varobj->name + " = " + std::to_string(var) + "\n");
212
213 m_datasets.at(index)->m_input[ivar] = var;
214
215 }
216
217 B2DEBUG(11, debugStr[11]);
218 debugStr[11].clear();
219
220 // Check spectators only when in debug mode.
221 if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 12)) {
222
223 debugStr[12] += "\n";
224 debugStr[12] += "MVA spectators:\n";
225
226 auto nspecs = m_spectators.at(index).size();
227 for (unsigned int ispec(0); ispec < nspecs; ++ispec) {
228
229 auto specobj = m_spectators.at(index).at(ispec);
230
231 double spec = std::numeric_limits<double>::quiet_NaN();
232 auto spec_result = specobj->function(particle);
233 if (std::holds_alternative<double>(spec_result)) {
234 spec = std::get<double>(spec_result);
235 } else if (std::holds_alternative<int>(spec_result)) {
236 spec = std::get<int>(spec_result);
237 } else if (std::holds_alternative<bool>(spec_result)) {
238 spec = std::get<bool>(spec_result);
239 } else {
240 B2ERROR("Variable '" << specobj->name << "' has wrong data type! It must be one of double, integer, or bool.");
241 }
242
243 debugStr[12] += ("\tspec[" + std::to_string(ispec) + "] : " + specobj->name + " = " + std::to_string(spec) + "\n");
244
245 m_datasets.at(index)->m_spectators[ispec] = spec;
246
247 }
248
249 B2DEBUG(12, debugStr[12]);
250 debugStr[12].clear();
251
252 }
253
254 // Compute MVA score for each available class.
255
256 debugStr[11] += "\n";
257 debugStr[12] += "\n";
258 debugStr[11] += "MVA response:\n";
259
260 std::string score_varname("");
261 // We deal w/ a SingleDataset, so 0 is the only existing component by construction.
262 std::vector<float> scores = m_experts.at(index)->applyMulticlass(*m_datasets.at(index))[0];
263
264 for (unsigned int classID(0); classID < m_classes.size(); ++classID) {
265
266 const std::string className(m_classes.at(classID));
267
268 score_varname = "pidChargedBDTScore_" + className;
269
270 if (m_ecl_only) {
271 score_varname += "_" + std::to_string(Const::ECL);
272 } else {
273 for (const Const::EDetector& det : Const::PIDDetectorSet::set()) {
274 score_varname += "_" + std::to_string(det);
275 }
276 }
277
278 debugStr[11] += ("\tclass[" + std::to_string(classID) + "] = " + className + " - score = " + std::to_string(
279 scores[classID]) + "\n");
280 debugStr[12] += ("\textraInfo: " + score_varname + "\n");
281
282 // Store the MVA score as a new particle object property.
283 m_particles[particle->getArrayIndex()]->writeExtraInfo(score_varname, scores[classID]);
284
285 }
286
287 B2DEBUG(11, debugStr[11]);
288 B2DEBUG(12, debugStr[12]);
289 debugStr[11].clear();
290 debugStr[12].clear();
291
292 }
293
294 }
295
296 // Clear the debug string map before next event.
297 debugStr.clear();
298
299}
StoreObjPtr< EventMetaData > m_event_metadata
The event information.
std::unique_ptr< DBObjPtr< ChargedPidMVAWeights > > m_weightfiles_representation
Interface to get the database payload with the MVA weight files.
StoreArray< Particle > m_particles
StoreArray of Particles.
DatasetsList m_datasets
List of MVA::SingleDataset objects.
std::vector< std::string > m_classes
List of MVA class names.
VariablesLists m_variables
List of lists of feature variables.
VariablesLists m_spectators
List of lists of spectator variables.
ExpertsList m_experts
List of MVA::Expert objects.
static DetectorSet set()
Accessor for the set of valid detector IDs.
Definition: Const.h:333
EDetector
Enum for identifying the detector components (detector and subdetector).
Definition: Const.h:42
The DecayDescriptor stores information about a decay tree or parts of a decay tree.
ECL cluster data.
Definition: ECLCluster.h:27
@ c_Debug
Debug: for code development.
Definition: LogConfig.h:26
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Class to store reconstructed particles.
Definition: Particle.h:75
const ECLCluster * getECLCluster() const
Returns the pointer to the ECLCluster object that was used to create this Particle (if ParticleType =...
Definition: Particle.cc:891
bool hasExtraInfo(const std::string &name) const
Return whether the extra info with the given name is set.
Definition: Particle.cc:1266
double getCharge(void) const
Returns particle charge.
Definition: Particle.cc:622
double getP() const
Returns momentum magnitude (same as getMomentumMagnitude but with shorter name)
Definition: Particle.h:578
int getArrayIndex() const
Returns this object's array index (in StoreArray), or -1 if not found.
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
const Var * getVariable(std::string name)
Get the variable belonging to the given key.
Definition: Manager.cc:57
static Manager & Instance()
get singleton instance.
Definition: Manager.cc:25
double charge(int pdgCode)
Returns electric charge of a particle with given pdg code.
Definition: EvtPDLUtil.cc:44

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

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

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

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

◆ 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; }

◆ getParticleName()

const std::string getParticleName ( const ParticleList pList) const
inlineprivate

Split the particle list name in "particleName", "particleLabel", and return the particle name w/o the charge +/- label.

This corresponds to the name as given in the evt.pdl

Definition at line 97 of file ChargedPidMVAMulticlassModule.h.

98 {
99
100 auto fullName = pList->getParticleListName();
101 auto delimiter(":");
102 auto signedName = fullName.substr(0, fullName.find(delimiter));
103 signedName.pop_back();
104
105 return signedName;
106 }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( )
overridevirtual

Use this to initialize resources or memory your module needs.

Also register any outputs of your module (StoreArrays, StoreObjPtrs, relations) here, see the respective class documentation for details.

Reimplemented from Module.

Definition at line 53 of file ChargedPidMVAMulticlassModule.cc.

54{
55 m_event_metadata.isRequired();
56
57 m_weightfiles_representation = std::make_unique<DBObjPtr<ChargedPidMVAWeights>>(m_payload_name);
58
59 /* Initialize MVA if the payload has changed and now. */
60 (*m_weightfiles_representation.get()).addCallback([this]() { initializeMVA(); });
62}

◆ initializeMVA()

void initializeMVA ( )
private
  1. Check if a payload is found in the database.
  2. Check the MVA weights for consistency every time they change in the database.
  3. Load MVA weight files, and set MVA::Expert and MVA::SingleDataset objects for each file found.

Definition at line 383 of file ChargedPidMVAMulticlassModule.cc.

384{
385
386 B2INFO("Run: " << m_event_metadata->getRun() <<
387 ". Load supported MVA interfaces for multi-class charged particle identification...");
388
389 // Set the necessary variable aliases from the payload.
390 this->registerAliases();
391
392 // The supported methods have to be initialized once (calling it more than once is safe).
394 auto supported_interfaces = MVA::AbstractInterface::getSupportedInterfaces();
395
396 B2INFO("\tLoading weightfiles from the payload class.");
397
398 auto serialized_weightfiles = (*m_weightfiles_representation.get())->getMVAWeightsMulticlass();
399 auto nfiles = serialized_weightfiles->size();
400
401 B2INFO("\tConstruct the MVA experts and datasets from N = " << nfiles << " weightfiles...");
402
403 // The size of the vectors must correspond
404 // to the number of available weightfiles for this pdgId.
405 m_experts.resize(nfiles);
406 m_datasets.resize(nfiles);
407 m_cuts.resize(nfiles);
408 m_variables.resize(nfiles);
409 m_spectators.resize(nfiles);
410
411 for (unsigned int idx(0); idx < nfiles; idx++) {
412
413 B2DEBUG(12, "\t\tweightfile[" << idx << "]");
414
415 // De-serialize the string into an MVA::Weightfile object.
416 std::stringstream ss(serialized_weightfiles->at(idx));
417 auto weightfile = MVA::Weightfile::loadFromStream(ss);
418
419 MVA::GeneralOptions general_options;
420 weightfile.getOptions(general_options);
421
422 // Store the list of pointers to the relevant variables for this xml file.
424 m_variables[idx] = manager.getVariables(general_options.m_variables);
425 m_spectators[idx] = manager.getVariables(general_options.m_spectators);
426
427 B2DEBUG(12, "\t\tRetrieved N = " << general_options.m_variables.size()
428 << " variables, N = " << general_options.m_spectators.size()
429 << " spectators");
430
431 // Store an MVA::Expert object.
432 m_experts[idx] = supported_interfaces[general_options.m_method]->getExpert();
433 m_experts.at(idx)->load(weightfile);
434
435 B2DEBUG(12, "\t\tweightfile loaded successfully into expert[" << idx << "]!");
436
437 // Store an MVA::SingleDataset object, in which we will save our features later...
438 std::vector<float> v(general_options.m_variables.size(), 0.0);
439 std::vector<float> s(general_options.m_spectators.size(), 0.0);
440 m_datasets[idx] = std::make_unique<MVA::SingleDataset>(general_options, v, 1.0, s);
441
442 B2DEBUG(12, "\t\tdataset[" << idx << "] created successfully!");
443
444 // Compile cut for this category.
445 const auto cuts = (*m_weightfiles_representation.get())->getCutsMulticlass();
446 const auto cutstr = (!cuts->empty()) ? cuts->at(idx) : "";
447 m_cuts[idx] = (!cutstr.empty()) ? Variable::Cut::compile(cutstr) : nullptr;
448
449 B2DEBUG(12, "\t\tcut[" << idx << "] created successfully!");
450
451 // Register class names only once.
452 if (idx == 0) {
453 // QUESTION: could this be made generic?
454 // Problem is I am not sure how other MVA methods deal with multi-classification,
455 // so it's difficult to make an abstract interface that surely works for everything... ideas?
456 MVA::TMVAOptionsMulticlass specific_options;
457 weightfile.getOptions(specific_options);
458
459 if (specific_options.m_classes.empty()) {
460 B2FATAL("MVA::SpecificOptions of weightfile[" << idx <<
461 "] has no registered MVA classes! This shouldn't happen in multi-class mode. Aborting...");
462 }
463
464 m_classes.clear();
465 for (const auto& cls : specific_options.m_classes) {
466 m_classes.push_back(cls);
467 }
468
469 }
470 }
471
472}
void registerAliases()
Set variable aliases needed by the MVA.
static std::unique_ptr< GeneralCut > compile(const std::string &cut)
Creates an instance of a cut and returns a unique_ptr to it, if you need a copy-able object instead y...
Definition: GeneralCut.h:84
static void initSupportedInterfaces()
Static function which initliazes all supported interfaces, has to be called once before getSupportedI...
Definition: Interface.cc:45
static std::map< std::string, AbstractInterface * > getSupportedInterfaces()
Returns interfaces supported by the MVA Interface.
Definition: Interface.h:53
General options which are shared by all MVA trainings.
Definition: Options.h:62
Options for the TMVA Multiclass MVA method.
Definition: TMVA.h:122
static Weightfile loadFromStream(std::istream &stream)
Static function which deserializes a Weightfile from a stream.
Definition: Weightfile.cc:251
Global list of available variables.
Definition: Manager.h:101

◆ registerAliases()

void registerAliases ( )
private

Set variable aliases needed by the MVA.

Read from payload.

Definition at line 353 of file ChargedPidMVAMulticlassModule.cc.

354{
355
356 auto aliases = (*m_weightfiles_representation.get())->getAliases();
357
358 if (!aliases->empty()) {
359
360 B2INFO("Setting aliases for the ChargedPidMVA algorithm read from the payload.");
361
362 std::string debugStr("\n");
363 for (const auto& [alias, variable] : *aliases) {
364 if (alias != variable) {
365 debugStr += (alias + " --> " + variable + "\n");
366 if (!Variable::Manager::Instance().addAlias(alias, variable)) {
367 B2ERROR("Something went wrong with setting alias: " << alias << " for variable: " << variable);
368 }
369 }
370 }
371 B2DEBUG(10, debugStr);
372
373 return;
374
375 }
376
377 // Manually set aliases - for bw compatibility
378 this->registerAliasesLegacy();
379
380}
void registerAliasesLegacy()
Set variable aliases needed by the MVA.
bool addAlias(const std::string &alias, const std::string &variable)
Add alias Return true if the alias was successfully added.
Definition: Manager.cc:95

◆ registerAliasesLegacy()

void registerAliasesLegacy ( )
private

Set variable aliases needed by the MVA.

Fallback to this if no aliases map found in payload.

Definition at line 301 of file ChargedPidMVAMulticlassModule.cc.

302{
303
304 std::string epsilon("1e-8");
305
306 std::map<std::string, std::string> aliasesLegacy;
307
308 aliasesLegacy.insert(std::make_pair("__event__", "evtNum"));
309
311 it != Const::PIDDetectorSet::set().end(); ++it) {
312
313 auto detName = Const::parseDetectors(*it);
314
315 aliasesLegacy.insert(std::make_pair("missingLogL_" + detName, "pidMissingProbabilityExpert(" + detName + ")"));
316
317 for (auto& [pdgId, fullName] : m_stdChargedInfo) {
318
319 std::string alias = fullName + "ID_" + detName;
320 std::string var = "pidProbabilityExpert(" + std::to_string(pdgId) + ", " + detName + ")";
321 std::string aliasLogTrf = alias + "_LogTransfo";
322 std::string varLogTrf = "formula(-1. * log10(formula(((1. - " + alias + ") + " + epsilon + ") / (" + alias + " + " + epsilon +
323 "))))";
324
325 aliasesLegacy.insert(std::make_pair(alias, var));
326 aliasesLegacy.insert(std::make_pair(aliasLogTrf, varLogTrf));
327
328 if (it.getIndex() == 0) {
329 aliasLogTrf = fullName + "ID_LogTransfo";
330 varLogTrf = "formula(-1. * log10(formula(((1. - " + fullName + "ID) + " + epsilon + ") / (" + fullName + "ID + " + epsilon +
331 "))))";
332 aliasesLegacy.insert(std::make_pair(aliasLogTrf, varLogTrf));
333 }
334
335 }
336
337 }
338
339 B2INFO("Setting hard-coded aliases for the ChargedPidMVA algorithm.");
340
341 std::string debugStr("\n");
342 for (const auto& [alias, variable] : aliasesLegacy) {
343 debugStr += (alias + " --> " + variable + "\n");
344 if (!Variable::Manager::Instance().addAlias(alias, variable)) {
345 B2ERROR("Something went wrong with setting alias: " << alias << " for variable: " << variable);
346 }
347 }
348 B2DEBUG(10, debugStr);
349
350}
std::map< int, std::string > m_stdChargedInfo
Map with standard charged particles' info.
Iterator end() const
Ending iterator.
Definition: UnitConst.cc:220
static std::string parseDetectors(EDetector det)
Converts Const::EDetector object to string.
Definition: UnitConst.cc:162

◆ 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
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

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

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

◆ setType()

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

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

Member Data Documentation

◆ m_charge_independent

bool m_charge_independent
private

Flag to specify if we use a charge-independent training.

Definition at line 130 of file ChargedPidMVAMulticlassModule.h.

◆ m_classes

std::vector<std::string> m_classes
private

List of MVA class names.

Definition at line 185 of file ChargedPidMVAMulticlassModule.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_cuts

CutsList m_cuts
private

List of Cut objects.

One Cut to be stored for each training category.

Definition at line 168 of file ChargedPidMVAMulticlassModule.h.

◆ m_datasets

DatasetsList m_datasets
private

List of MVA::SingleDataset objects.

One DS to be stored for each xml file found in the database, i.e. for each training category.

Definition at line 162 of file ChargedPidMVAMulticlassModule.h.

◆ m_decayStrings

std::vector<std::string> m_decayStrings
private

The input list of DecayStrings, where each selected (^) daughter should correspond to a standard charged ParticleList, e.g.

‘['Lambda0:sig -> ^p+ ^pi-’, 'J/psi:sig -> ^mu+ ^mu-']. One can also directly pass a list of standard charged ParticleLists, e.g.['e+:my_electrons', 'pi+:my_pions']`. Note that charge-conjugated ParticleLists will automatically be included.

Definition at line 120 of file ChargedPidMVAMulticlassModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_ecl_only

bool m_ecl_only
private

Flag to specify if we use an ECL-only based training.

Definition at line 135 of file ChargedPidMVAMulticlassModule.h.

◆ m_event_metadata

StoreObjPtr<EventMetaData> m_event_metadata
private

The event information.

Used for debugging purposes.

Definition at line 140 of file ChargedPidMVAMulticlassModule.h.

◆ m_experts

ExpertsList m_experts
private

List of MVA::Expert objects.

One Expert to be stored for each xml file found in the database, i.e. for each training category.

Definition at line 156 of file ChargedPidMVAMulticlassModule.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_particles

StoreArray<Particle> m_particles
private

StoreArray of Particles.

Definition at line 112 of file ChargedPidMVAMulticlassModule.h.

◆ m_payload_name

std::string m_payload_name
private

The name of the database payload object with the MVA weights.

Definition at line 125 of file ChargedPidMVAMulticlassModule.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_spectators

VariablesLists m_spectators
private

List of lists of spectator variables.

One list of lists to be stored for each xml file found in the database, i.e. for each training category.

Definition at line 180 of file ChargedPidMVAMulticlassModule.h.

◆ m_stdChargedInfo

std::map<int, std::string> m_stdChargedInfo
private
Initial value:
= {
{ Const::electron.getPDGCode(), "electron" },
{ Const::muon.getPDGCode(), "muon" },
{ Const::pion.getPDGCode(), "pion" },
{ Const::kaon.getPDGCode(), "kaon" },
{ Const::proton.getPDGCode(), "proton" },
{ Const::deuteron.getPDGCode(), "deuteron" }
}
int getPDGCode() const
PDG code.
Definition: Const.h:473
static const ChargedStable muon
muon particle
Definition: Const.h:660
static const ChargedStable pion
charged pion particle
Definition: Const.h:661
static const ChargedStable proton
proton particle
Definition: Const.h:663
static const ChargedStable kaon
charged kaon particle
Definition: Const.h:662
static const ChargedStable electron
electron particle
Definition: Const.h:659
static const ChargedStable deuteron
deuteron particle
Definition: Const.h:664

Map with standard charged particles' info.

For convenience.

Definition at line 190 of file ChargedPidMVAMulticlassModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_variables

VariablesLists m_variables
private

List of lists of feature variables.

One list of lists to be stored for each xml file found in the database, i.e. for each training category.

Definition at line 174 of file ChargedPidMVAMulticlassModule.h.

◆ m_weightfiles_representation

std::unique_ptr<DBObjPtr<ChargedPidMVAWeights> > m_weightfiles_representation
private

Interface to get the database payload with the MVA weight files.

The payload class has a method to retrieve the correct weightfile representation given a reconstructed particle's (polar angle, p, charge). Note that the theta of the track helix extraplolated at the ECL entry surface is used if the particle doesn't have an ECL cluster match.

Definition at line 149 of file ChargedPidMVAMulticlassModule.h.


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