Belle II Software  light-2212-foldex
MVAExpertModule.h
1 /**************************************************************************
2  * basf2 (Belle II Analysis Software Framework) *
3  * Author: The Belle II Collaboration *
4  * *
5  * See git log for contributors and copyright holders. *
6  * This file is licensed under LGPL-3.0, see LICENSE.md. *
7  **************************************************************************/
8 
9 #pragma once
10 
11 #include <framework/core/Module.h>
12 
13 #include <mva/dataobjects/DatabaseRepresentationOfWeightfile.h>
14 #include <mva/interface/Weightfile.h>
15 #include <mva/interface/Expert.h>
16 
17 #include <framework/database/DBObjPtr.h>
18 
19 #include <analysis/VariableManager/Manager.h>
20 #include <framework/dataobjects/EventExtraInfo.h>
21 
22 #include <vector>
23 #include <string>
24 
25 namespace Belle2 {
31  class Particle;
32 
40  class MVAExpertModule : public Module {
41  public:
42 
47 
51  virtual void initialize() override;
52 
56  virtual void beginRun() override;
57 
61  virtual void event() override;
62 
66  virtual void terminate() override;
67 
68  private:
72  float analyse(Particle*);
73 
77  std::vector<float> analyseMulticlass(Particle*);
78 
83  void init_mva(MVA::Weightfile& weightfile);
84 
88  void fillDataset(Particle*);
89 
93  void setExtraInfoField(Particle*, std::string, float);
94 
98  void setEventExtraInfoField(StoreObjPtr<EventExtraInfo>, std::string, float);
99 
100 
101  private:
102 
103  std::vector<std::string> m_listNames;
104  std::string m_identifier;
105  std::string m_extraInfoName;
108  std::vector<const Variable::Manager::Var*> m_feature_variables;
110  std::unique_ptr<DBObjPtr<DatabaseRepresentationOfWeightfile>>
112  std::unique_ptr<MVA::Expert> m_expert;
113  std::unique_ptr<MVA::SingleDataset> m_dataset;
118  unsigned int
120  };
121 
123 } // Belle2 namespace
124 
This module adds an ExtraInfo to the Particle objects in a given ParticleList.
std::unique_ptr< MVA::SingleDataset > m_dataset
Pointer to the current dataset.
std::vector< const Variable::Manager::Var * > m_feature_variables
Pointers to the feature variables.
virtual void initialize() override
Initialize the module.
void fillDataset(Particle *)
Evaluate the variables and fill the Dataset to be used by the expert.
virtual void event() override
Called for each event.
void setEventExtraInfoField(StoreObjPtr< EventExtraInfo >, std::string, float)
Set the event extra info field.
virtual void terminate() override
Called at the end of the event processing.
std::unique_ptr< MVA::Expert > m_expert
Pointer to the current MVA Expert.
double m_signal_fraction_override
Signal Fraction which should be used.
std::unique_ptr< DBObjPtr< DatabaseRepresentationOfWeightfile > > m_weightfile_representation
Database pointer to the Database representation of the weightfile.
std::vector< std::string > m_listNames
input particle list names
virtual void beginRun() override
Called at the beginning of a new run.
MVAExpertModule()
Constructor.
bool m_existGivenExtraInfo
check if the given extraInfo is already defined.
int m_overwriteExistingExtraInfo
-1/0/1/2: overwrite if lower/ don't overwrite / overwrite if higher/ always overwrite,...
float analyse(Particle *)
Calculates expert output for given Particle pointer.
std::vector< float > analyseMulticlass(Particle *)
Calculates expert output for given Particle pointer.
void init_mva(MVA::Weightfile &weightfile)
Initialize mva expert, dataset and features Called every time the weightfile in the database changes ...
std::string m_extraInfoName
Name under which the SignalProbability is stored in the extraInfo of the Particle object.
unsigned int m_nClasses
number of classes (~outputs) of the current MVA Expert.
void setExtraInfoField(Particle *, std::string, float)
Set the extra info field.
std::string m_identifier
weight-file
The Weightfile class serializes all information about a training into an xml tree.
Definition: Weightfile.h:38
Base class for Modules.
Definition: Module.h:72
Class to store reconstructed particles.
Definition: Particle.h:74
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:95
Abstract base class for different kinds of events.
Definition: ClusterUtils.h:23