Belle II Software development
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SVDPositionErrorScaleFactorImporterModule Class Reference
Packages » svd | Modules » svd modules

Module that produces a localdb with position error scale factors for different position algoritms. More...

#include <SVDPositionErrorScaleFactorImporterModule.h>

Inheritance diagram for SVDPositionErrorScaleFactorImporterModule:
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

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

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

double oneSigma (TH1F *)
 computes the scale factor by requiring that 68% of the pull distribution is between ±1
 
std::list< ModulePtr > getModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

std::string m_rootFileName
 root file name
 
std::string m_posAlgorithm = "CoGOnly"
 position algorithm
 
bool m_noOutliers = false
 if True removes outliers from scale factor computation
 
float m_min = -10
 min of the pulls histograms
 
float m_max = 10
 max of the pulls histograms
 
float m_nBins = 100
 number of bins of the pulls histograms
 
std::string m_uniqueID = "PositionErrorScaleFactors_TEST"
 payload uniqueID
 
StoreArray< SVDCluster > m_clusters
 SVDClusters StoreArray.
 
StoreArray< SVDTrueHit > m_truehits
 SVDTrueHits StoreArray.
 
TFile * m_rootFilePtr = nullptr
 pointer at root file used for storing histograms
 
TTree * m_tree = nullptr
 pointer at tree containing the mean and RMS of calibration constants
 
int m_exp = -1
 exp number
 
int m_run = -1
 run number
 
int m_layer = -1
 layer number
 
int m_ladder = -1
 ladder number
 
int m_sensor = -1
 sensor number
 
int m_side = -1
 sensor side
 
int m_size = -1
 cluster size
 
float m_clsCharge = -1
 cluster charge
 
float m_clsTime = -1
 cluster time
 
float m_clsPos = -1
 cluster position error
 
float m_clsErr = -1
 cluster position error
 
float m_clsResid = -1
 cluster positionresidual
 
float m_clsPull = -1
 cluster position pull
 
SVDHistograms< TH1F > * m_hClsPullSize1 = nullptr
 cluster size 1, position error scale factor histo
 
SVDHistograms< TH1F > * m_hClsPullSize2 = nullptr
 cluster size 2, position error scale factor histo
 
SVDHistograms< TH1F > * m_hClsPullSize3 = nullptr
 cluster size 3, position error scale factor histo
 
SVDHistograms< TH1F > * m_hClsPullSize4 = nullptr
 cluster size 4, position error scale factor histo
 
SVDHistograms< TH1F > * m_hClsPullSize5 = nullptr
 cluster size 5, position error scale factor histo
 
const int maxSize = 5
 maximum cluster size
 
TH1F * m_hL3Pulls [5][2] = {}
 cumulative L3 pulls histograms [size][side]
 
TH1F * m_hFWPulls [5][2] = {}
 cumulative FW pulls histograms [size][side]
 
TH1F * m_hBWPulls [5][2] = {}
 cumulative BW pulls histograms [size][side]
 
TH1F * m_hORPulls [5][2] = {}
 cumulative ORIGAMI pulls histograms [size][side]
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleCondition > m_conditions
 Module condition, only non-null if set.
 

Detailed Description

Module that produces a localdb with position error scale factors for different position algoritms.

Definition at line 36 of file SVDPositionErrorScaleFactorImporterModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
Belle2::Module::c_DontCollectStatistics
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
Belle2::Module::c_ParallelProcessingCertified
@ 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
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ SVDPositionErrorScaleFactorImporterModule()

SVDPositionErrorScaleFactorImporterModule ( )

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

Definition at line 30 of file SVDPositionErrorScaleFactorImporterModule.cc.

30 : Module()
31{
32 // Set module properties
33 setDescription("Module to produce a list of histograms showing the uploaded calibration constants");
34
35 // Parameter definitions
36 addParam("outputFileName", m_rootFileName, "Name of output root file.", std::string("SVDPositionErrorScaleFactors.root"));
37 addParam("posAlgorithm", m_posAlgorithm, "Position Algorithm.", std::string(m_posAlgorithm));
38 addParam("uniqueID", m_uniqueID, "Payload uniqueID.", std::string(m_uniqueID));
39 addParam("minPulls", m_min, "min of the pulls histograms.", float(m_min));
40 addParam("maxPulls", m_max, "max of the pulls histograms.", float(m_max));
41 addParam("nBinsPulls", m_nBins, "number of bins of the pulls histograms.", float(m_nBins));
42 addParam("noOutliers", m_noOutliers, "If True, removes outliers from cluster position error scale factor computation.",
43 bool(false));
44}
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Belle2::Module::Module
Module()
Constructor.
Definition: Module.cc:30
Belle2::SVDPositionErrorScaleFactorImporterModule::m_noOutliers
bool m_noOutliers
if True removes outliers from scale factor computation
Definition: SVDPositionErrorScaleFactorImporterModule.h:68
Belle2::Module::addParam
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

initialize the TTrees and create histograms

Reimplemented from Module.

Definition at line 52 of file SVDPositionErrorScaleFactorImporterModule.cc.

53{
54 //to avoid publicAllocationError:
55 delete m_rootFilePtr;
56
57 m_rootFilePtr = new TFile(m_rootFileName.c_str(), "RECREATE");
58 //tree initialization
59 m_tree = new TTree("scf", "RECREATE");
60 m_tree->Branch("exp", &m_exp, "exp/i");
61 m_tree->Branch("run", &m_run, "run/i");
62 m_tree->Branch("layer", &m_layer, "layer/i");
63 m_tree->Branch("ladder", &m_ladder, "ladder/i");
64 m_tree->Branch("sensor", &m_sensor, "sensor/i");
65 m_tree->Branch("side", &m_side, "side/i");
66 m_tree->Branch("size", &m_size, "size/i");
67 m_tree->Branch("clsCharge", &m_clsCharge, "clsCharge/F");
68 m_tree->Branch("clsTime", &m_clsTime, "clsTime/F");
69 m_tree->Branch("clsPos", &m_clsPos, "clsPos/F");
70 m_tree->Branch("clsErr", &m_clsErr, "clsErr/F");
71 m_tree->Branch("clsResid", &m_clsResid, "clsResid/F");
72 m_tree->Branch("clsPull", &m_clsPull, "clsPull/F");
73
74 //CLUSTER POSITION PULLS
75 TH1F hClsPullSize1("clusterPulls1_L@layerL@ladderS@sensor@view",
76 Form("Cluster %s Pulls for Size 1 in @layer.@ladder.@sensor @view/@side", m_posAlgorithm.c_str()),
77 m_nBins, m_min, m_max);
78 hClsPullSize1.GetXaxis()->SetTitle("cluster pull");
79 m_hClsPullSize1 = new SVDHistograms<TH1F>(hClsPullSize1);
80
81 TH1F hClsPullSize2("clusterPulls2_L@layerL@ladderS@sensor@view",
82 Form("Cluster %s Pulls for Size 2 in @layer.@ladder.@sensor @view/@side", m_posAlgorithm.c_str()),
83 m_nBins, m_min, m_max);
84 hClsPullSize2.GetXaxis()->SetTitle("cluster pull");
85 m_hClsPullSize2 = new SVDHistograms<TH1F>(hClsPullSize2);
86
87 TH1F hClsPullSize3("clusterPulls3_L@layerL@ladderS@sensor@view",
88 Form("Cluster %s Pulls for Size 3 in @layer.@ladder.@sensor @view/@side", m_posAlgorithm.c_str()),
89 m_nBins, m_min, m_max);
90 hClsPullSize3.GetXaxis()->SetTitle("cluster pull");
91 m_hClsPullSize3 = new SVDHistograms<TH1F>(hClsPullSize3);
92
93 TH1F hClsPullSize4("clusterPulls4_L@layerL@ladderS@sensor@view",
94 Form("Cluster %s Pulls for Size 4 in @layer.@ladder.@sensor @view/@side", m_posAlgorithm.c_str()),
95 m_nBins, m_min, m_max);
96 hClsPullSize4.GetXaxis()->SetTitle("cluster pull");
97 m_hClsPullSize4 = new SVDHistograms<TH1F>(hClsPullSize4);
98
99 TH1F hClsPullSize5("clusterPulls5_L@layerL@ladderS@sensor@view",
100 Form("Cluster %s Pulls for Size > 4 in @layer.@ladder.@sensor @view/@side", m_posAlgorithm.c_str()),
101 m_nBins, m_min, m_max);
102 hClsPullSize5.GetXaxis()->SetTitle("cluster pull");
103 m_hClsPullSize5 = new SVDHistograms<TH1F>(hClsPullSize5);
104
105 for (int i = 0; i < 2; i++)
106 for (int s = 0; s < maxSize; s++) {
107 TString sside = "u";
108 if (i == 0) sside = "v";
109 m_hL3Pulls[s][i] = new TH1F(Form("l3_%s_size%d", sside.Data(), s + 1), Form("Size %d Cluster %s Pulls for L3 %s sensors",
110 s + 1, m_posAlgorithm.c_str(), sside.Data()), m_nBins, m_min, m_max);
111 m_hL3Pulls[s][i]->GetXaxis()->SetTitle("cluster pull");
112 m_hBWPulls[s][i] = new TH1F(Form("bw_%s_size%d", sside.Data(), s + 1), Form("Size %d Cluster %s Pulls for BW %s sensors",
113 s + 1, m_posAlgorithm.c_str(), sside.Data()), m_nBins, m_min, m_max);
114 m_hBWPulls[s][i]->GetXaxis()->SetTitle("cluster pull");
115 m_hFWPulls[s][i] = new TH1F(Form("fw_%s_size%d", sside.Data(), s + 1), Form("Size %d Cluster %s Pulls for FW %s sensors",
116 s + 1, m_posAlgorithm.c_str(), sside.Data()), m_nBins, m_min, m_max);
117 m_hFWPulls[s][i]->GetXaxis()->SetTitle("cluster pull");
118 m_hORPulls[s][i] = new TH1F(Form("or_%s_size%d", sside.Data(), s + 1), Form("Size %d Cluster %s Pulls for ORIGAMI %s sensors",
119 s + 1, m_posAlgorithm.c_str(), sside.Data()), m_nBins, m_min, m_max);
120 m_hORPulls[s][i]->GetXaxis()->SetTitle("cluster pull");
121 }
122
123
124}
Belle2::SVDHistograms
template class for SVd histograms
Definition: SVDHistograms.h:24
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hClsPullSize1
SVDHistograms< TH1F > * m_hClsPullSize1
cluster size 1, position error scale factor histo
Definition: SVDPositionErrorScaleFactorImporterModule.h:103
Belle2::SVDPositionErrorScaleFactorImporterModule::m_tree
TTree * m_tree
pointer at tree containing the mean and RMS of calibration constants
Definition: SVDPositionErrorScaleFactorImporterModule.h:80
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hFWPulls
TH1F * m_hFWPulls[5][2]
cumulative FW pulls histograms [size][side]
Definition: SVDPositionErrorScaleFactorImporterModule.h:111
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hORPulls
TH1F * m_hORPulls[5][2]
cumulative ORIGAMI pulls histograms [size][side]
Definition: SVDPositionErrorScaleFactorImporterModule.h:113
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hClsPullSize5
SVDHistograms< TH1F > * m_hClsPullSize5
cluster size 5, position error scale factor histo
Definition: SVDPositionErrorScaleFactorImporterModule.h:107
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hClsPullSize3
SVDHistograms< TH1F > * m_hClsPullSize3
cluster size 3, position error scale factor histo
Definition: SVDPositionErrorScaleFactorImporterModule.h:105
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hL3Pulls
TH1F * m_hL3Pulls[5][2]
cumulative L3 pulls histograms [size][side]
Definition: SVDPositionErrorScaleFactorImporterModule.h:110
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hClsPullSize2
SVDHistograms< TH1F > * m_hClsPullSize2
cluster size 2, position error scale factor histo
Definition: SVDPositionErrorScaleFactorImporterModule.h:104
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hClsPullSize4
SVDHistograms< TH1F > * m_hClsPullSize4
cluster size 4, position error scale factor histo
Definition: SVDPositionErrorScaleFactorImporterModule.h:106
Belle2::SVDPositionErrorScaleFactorImporterModule::m_hBWPulls
TH1F * m_hBWPulls[5][2]
cumulative BW pulls histograms [size][side]
Definition: SVDPositionErrorScaleFactorImporterModule.h:112
Belle2::SVDPositionErrorScaleFactorImporterModule::m_rootFilePtr
TFile * m_rootFilePtr
pointer at root file used for storing histograms
Definition: SVDPositionErrorScaleFactorImporterModule.h:79

◆ 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{
181 ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
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}
Belle2::ModuleManager::registerModule
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.
Definition: ModuleManager.cc:80
Belle2::ModuleManager::Instance
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
Definition: ModuleManager.cc:24
Belle2::Module::getParamList
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
Belle2::Module::getName
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
Belle2::Module::getType
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
Belle2::Module::m_propertyFlags
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
Belle2::Module::m_logConfig
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
Belle2::Module::m_conditions
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
Belle2::Module::m_package
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
Belle2::ModulePtr
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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::terminate
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

create cumulative histograms, compute scale factors, create payloads and import it to a localdb, and write tree and histograms to the rootfile

Reimplemented from Module.

Definition at line 162 of file SVDPositionErrorScaleFactorImporterModule.cc.

163{
164
165 // 1. compute scale factors for each sensor (not used in the payload!)
166 // and add them to histogram title
167
168 //call for a geometry instance
169 VXD::GeoCache& aGeometry = VXD::GeoCache::getInstance();
170 std::set<Belle2::VxdID> svdLayers = aGeometry.getLayers(VXD::SensorInfoBase::SVD);
171 std::set<Belle2::VxdID>::iterator itSvdLayers = svdLayers.begin();
172
173 while ((itSvdLayers != svdLayers.end()) && (itSvdLayers->getLayerNumber() != 7)) { //loop on Layers
174
175 std::set<Belle2::VxdID> svdLadders = aGeometry.getLadders(*itSvdLayers);
176 std::set<Belle2::VxdID>::iterator itSvdLadders = svdLadders.begin();
177
178 while (itSvdLadders != svdLadders.end()) { //loop on Ladders
179
180 std::set<Belle2::VxdID> svdSensors = aGeometry.getSensors(*itSvdLadders);
181 std::set<Belle2::VxdID>::iterator itSvdSensors = svdSensors.begin();
182 B2DEBUG(1, " svd sensor info " << * (svdSensors.begin()));
183
184 while (itSvdSensors != svdSensors.end()) { //loop on sensors
185 B2DEBUG(1, " svd sensor info " << *itSvdSensors);
186
187 m_layer = (int)itSvdSensors->getLayerNumber();
188 m_ladder = (int)itSvdSensors->getLadderNumber();
189 m_sensor = (int)itSvdSensors->getSensorNumber();
190 Belle2::VxdID theVxdID(m_layer, m_ladder, m_sensor);
191
192 for (m_side = 0; m_side < 2; m_side++) {
193
194 TH1F* h = m_hClsPullSize1->getHistogram(theVxdID, m_side);
195 h->SetTitle(Form("%s, scf = %1.2f", h->GetTitle(), oneSigma(h)));
196 h = m_hClsPullSize2->getHistogram(theVxdID, m_side);
197 h->SetTitle(Form("%s, scf = %1.2f", h->GetTitle(), oneSigma(h)));
198 h = m_hClsPullSize3->getHistogram(theVxdID, m_side);
199 h->SetTitle(Form("%s, scf = %1.2f", h->GetTitle(), oneSigma(h)));
200 h = m_hClsPullSize4->getHistogram(theVxdID, m_side);
201 h->SetTitle(Form("%s, scf = %1.2f", h->GetTitle(), oneSigma(h)));
202 h = m_hClsPullSize5->getHistogram(theVxdID, m_side);
203 h->SetTitle(Form("%s, scf = %1.2f", h->GetTitle(), oneSigma(h)));
204
205 //layer 3
206 if (theVxdID.getLayerNumber() == 3) {
207 m_hL3Pulls[0][m_side]->Add(m_hClsPullSize1->getHistogram(theVxdID, m_side));
208 m_hL3Pulls[1][m_side]->Add(m_hClsPullSize2->getHistogram(theVxdID, m_side));
209 m_hL3Pulls[2][m_side]->Add(m_hClsPullSize3->getHistogram(theVxdID, m_side));
210 m_hL3Pulls[3][m_side]->Add(m_hClsPullSize4->getHistogram(theVxdID, m_side));
211 m_hL3Pulls[4][m_side]->Add(m_hClsPullSize5->getHistogram(theVxdID, m_side));
212 }
213
214 //forward
215 else if (theVxdID.getSensorNumber() == 1) {
216 m_hFWPulls[0][m_side]->Add(m_hClsPullSize1->getHistogram(theVxdID, m_side));
217 m_hFWPulls[1][m_side]->Add(m_hClsPullSize2->getHistogram(theVxdID, m_side));
218 m_hFWPulls[2][m_side]->Add(m_hClsPullSize3->getHistogram(theVxdID, m_side));
219 m_hFWPulls[3][m_side]->Add(m_hClsPullSize4->getHistogram(theVxdID, m_side));
220 m_hFWPulls[4][m_side]->Add(m_hClsPullSize5->getHistogram(theVxdID, m_side));
221 }
222 //backward
223 else if (theVxdID.getSensorNumber() == theVxdID.getLayerNumber() - 1) {
224 m_hBWPulls[0][m_side]->Add(m_hClsPullSize1->getHistogram(theVxdID, m_side));
225 m_hBWPulls[1][m_side]->Add(m_hClsPullSize2->getHistogram(theVxdID, m_side));
226 m_hBWPulls[2][m_side]->Add(m_hClsPullSize3->getHistogram(theVxdID, m_side));
227 m_hBWPulls[3][m_side]->Add(m_hClsPullSize4->getHistogram(theVxdID, m_side));
228 m_hBWPulls[4][m_side]->Add(m_hClsPullSize5->getHistogram(theVxdID, m_side));
229 }
230 // origami
231 else {
232 m_hORPulls[0][m_side]->Add(m_hClsPullSize1->getHistogram(theVxdID, m_side));
233 m_hORPulls[1][m_side]->Add(m_hClsPullSize2->getHistogram(theVxdID, m_side));
234 m_hORPulls[2][m_side]->Add(m_hClsPullSize3->getHistogram(theVxdID, m_side));
235 m_hORPulls[3][m_side]->Add(m_hClsPullSize4->getHistogram(theVxdID, m_side));
236 m_hORPulls[4][m_side]->Add(m_hClsPullSize5->getHistogram(theVxdID, m_side));
237 }
238 }
239 ++itSvdSensors;
240 }
241 ++itSvdLadders;
242 }
243 ++itSvdLayers;
244 }
245
246
247 IntervalOfValidity iov(0, 0, -1, -1);
248
249 auto scfs = new Belle2::SVDPosErrScaleFactors;
250
251 //CoGOnly payload
252 auto payload_cogOnly = new Belle2::SVDCoGOnlyErrorScaleFactors::t_payload(*scfs, m_uniqueID);
253
254 //OldDefault payload
255 auto payload_oldDefault = new Belle2::SVDOldDefaultErrorScaleFactors::t_payload(*scfs, m_uniqueID);
256
257 // 2. compute scale factors using cumulative histograms
258 VXD::GeoCache& geoCache = VXD::GeoCache::getInstance();
259
260 for (auto layer : geoCache.getLayers(VXD::SensorInfoBase::SVD))
261 for (auto ladder : geoCache.getLadders(layer))
262 for (Belle2::VxdID theVxdID : geoCache.getSensors(ladder))
263
264 for (m_side = 0; m_side < 2; m_side++) {
265
266 //layer 3
267 if (theVxdID.getLayerNumber() == 3) {
268 scfs->scaleError_clSize1 = oneSigma(m_hL3Pulls[0][m_side]);
269 scfs->scaleError_clSize2 = oneSigma(m_hL3Pulls[1][m_side]);
270 scfs->scaleError_clSize3 = oneSigma(m_hL3Pulls[2][m_side]);
271 scfs->scaleError_clSize4 = oneSigma(m_hL3Pulls[3][m_side]);
272 scfs->scaleError_clSize5 = oneSigma(m_hL3Pulls[4][m_side]);
273 }
274 //forward
275 else if (theVxdID.getSensorNumber() == 1) {
276 scfs->scaleError_clSize1 = oneSigma(m_hFWPulls[0][m_side]);
277 scfs->scaleError_clSize2 = oneSigma(m_hFWPulls[1][m_side]);
278 scfs->scaleError_clSize3 = oneSigma(m_hFWPulls[2][m_side]);
279 scfs->scaleError_clSize4 = oneSigma(m_hFWPulls[3][m_side]);
280 scfs->scaleError_clSize5 = oneSigma(m_hFWPulls[4][m_side]);
281 }
282 //backward
283 else if (theVxdID.getSensorNumber() == theVxdID.getLayerNumber() - 1) {
284 scfs->scaleError_clSize1 = oneSigma(m_hBWPulls[0][m_side]);
285 scfs->scaleError_clSize2 = oneSigma(m_hBWPulls[1][m_side]);
286 scfs->scaleError_clSize3 = oneSigma(m_hBWPulls[2][m_side]);
287 scfs->scaleError_clSize4 = oneSigma(m_hBWPulls[3][m_side]);
288 scfs->scaleError_clSize5 = oneSigma(m_hBWPulls[4][m_side]);
289 }
290 // origami
291 else {
292 scfs->scaleError_clSize1 = oneSigma(m_hORPulls[0][m_side]);
293 scfs->scaleError_clSize2 = oneSigma(m_hORPulls[1][m_side]);
294 scfs->scaleError_clSize3 = oneSigma(m_hORPulls[2][m_side]);
295 scfs->scaleError_clSize4 = oneSigma(m_hORPulls[3][m_side]);
296 scfs->scaleError_clSize5 = oneSigma(m_hORPulls[4][m_side]);
297 }
298
299 if (TString(m_posAlgorithm).Contains("CoGOnly"))
300 payload_cogOnly->set(theVxdID.getLayerNumber(), theVxdID.getLadderNumber(), theVxdID.getSensorNumber(), m_side, 1, *scfs);
301 if (TString(m_posAlgorithm).Contains("OldDefault"))
302 payload_oldDefault->set(theVxdID.getLayerNumber(), theVxdID.getLadderNumber(), theVxdID.getSensorNumber(), m_side, 1, *scfs);
303 }
304
305 if (TString(m_posAlgorithm).Contains("CoGOnly")) {
306 Database::Instance().storeData(SVDCoGOnlyErrorScaleFactors::name, payload_cogOnly, iov);
307
308 B2RESULT("SVDCoGOnlyErrorScaleFactors imported to database.");
309 }
310 if (TString(m_posAlgorithm).Contains("OldDefault")) {
311 Database::Instance().storeData(SVDOldDefaultErrorScaleFactors::name, payload_oldDefault, iov);
312
313 B2RESULT("SVDOldDefaultErrorScaleFactors imported to database.");
314 }
315
316
317 //now write the rootfile
318 if (m_rootFilePtr != nullptr) {
319
320 m_rootFilePtr->cd();
321
322 //write the tree
323 m_tree->Write();
324
325 m_rootFilePtr->mkdir("sensor_pulls");
326 m_rootFilePtr->mkdir("pulls");
327
328 for (auto layer : geoCache.getLayers(VXD::SensorInfoBase::SVD))
329 for (auto ladder : geoCache.getLadders(layer))
330 for (Belle2::VxdID sensor : geoCache.getSensors(ladder))
331 for (int view = SVDHistograms<TH1F>::VIndex ; view < SVDHistograms<TH1F>::UIndex + 1; view++) {
332
333 //writing the histograms to root:
334
335 m_rootFilePtr->cd("sensor_pulls");
336 (m_hClsPullSize1->getHistogram(sensor, view))->Write();
337 (m_hClsPullSize2->getHistogram(sensor, view))->Write();
338 (m_hClsPullSize3->getHistogram(sensor, view))->Write();
339 (m_hClsPullSize4->getHistogram(sensor, view))->Write();
340 (m_hClsPullSize5->getHistogram(sensor, view))->Write();
341
342 }
343
344 for (int s = 0; s < maxSize; s++) {
345 m_rootFilePtr->cd("pulls");
346 m_hL3Pulls[s][1]->Write();
347 m_hFWPulls[s][1]->Write();
348 m_hBWPulls[s][1]->Write();
349 m_hORPulls[s][1]->Write();
350 m_hL3Pulls[s][0]->Write();
351 m_hFWPulls[s][0]->Write();
352 m_hBWPulls[s][0]->Write();
353 m_hORPulls[s][0]->Write();
354 }
355 m_rootFilePtr->Close();
356 B2RESULT("The rootfile containing the list of histograms has been filled and closed.");
357
358 }
359}
Belle2::IntervalOfValidity
A class that describes the interval of experiments/runs for which an object in the database is valid.
Definition: IntervalOfValidity.h:25
Belle2::SVDCoGOnlyErrorScaleFactors::name
static std::string name
name of SVDPosErrScaleFactors payload
Definition: SVDCoGOnlyErrorScaleFactors.h:31
Belle2::SVDCoGOnlyErrorScaleFactors::t_payload
SVDCalibrationsBase< SVDCalibrationsScalar< SVDPosErrScaleFactors > > t_payload
typedef for the of SVDPosErrScaleFactors payload of all SVD sensors
Definition: SVDCoGOnlyErrorScaleFactors.h:33
Belle2::SVDHistograms::getHistogram
H * getHistogram(const VxdID &vxdID, int view)
get a reference to the histogram for
Definition: SVDHistograms.h:56
Belle2::SVDOldDefaultErrorScaleFactors::name
static std::string name
name of SVDPosErrScaleFactors payload
Definition: SVDOldDefaultErrorScaleFactors.h:31
Belle2::SVDOldDefaultErrorScaleFactors::t_payload
SVDCalibrationsBase< SVDCalibrationsScalar< SVDPosErrScaleFactors > > t_payload
typedef for the of SVDPosErrScaleFactors payload of all SVD sensors
Definition: SVDOldDefaultErrorScaleFactors.h:33
Belle2::SVDPositionErrorScaleFactorImporterModule::oneSigma
double oneSigma(TH1F *)
computes the scale factor by requiring that 68% of the pull distribution is between ±1
Definition: SVDPositionErrorScaleFactorImporterModule.cc:361
Belle2::VXD::GeoCache
Class to faciliate easy access to sensor information of the VXD like coordinate transformations or pi...
Definition: GeoCache.h:39
Belle2::VXD::GeoCache::getLayers
const std::set< Belle2::VxdID > getLayers(SensorInfoBase::SensorType sensortype=SensorInfoBase::VXD)
Return a set of all known Layers.
Definition: GeoCache.cc:176
Belle2::VXD::GeoCache::getSensors
const std::set< Belle2::VxdID > & getSensors(Belle2::VxdID ladder) const
Return a set of all sensor IDs belonging to a given ladder.
Definition: GeoCache.cc:204
Belle2::VXD::GeoCache::getInstance
static GeoCache & getInstance()
Return a reference to the singleton instance.
Definition: GeoCache.cc:214
Belle2::VXD::GeoCache::getLadders
const std::set< Belle2::VxdID > & getLadders(Belle2::VxdID layer) const
Return a set of all ladder IDs belonging to a given layer.
Definition: GeoCache.cc:193
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:33
Belle2::Database::Instance
static Database & Instance()
Instance of a singleton Database.
Definition: Database.cc:42
Belle2::Database::storeData
bool storeData(const std::string &name, TObject *object, const IntervalOfValidity &iov)
Store an object in the database.
Definition: Database.cc:141
Belle2::SVDPosErrScaleFactors
contains the scaling factors for the cluster position error
Definition: SVDPosErrScaleFactors.h:18

◆ 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}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition: Module.h:519
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

fill trees and histograms

Reimplemented from Module.

Definition at line 126 of file SVDPositionErrorScaleFactorImporterModule.cc.

127{
128 StoreObjPtr<EventMetaData> meta;
129 m_run = meta->getRun();
130 m_exp = meta->getExperiment();
131
132 for (const SVDCluster& cluster : m_clusters) {
133
134 RelationVector<SVDTrueHit> trueHit = cluster.getRelationsTo<SVDTrueHit>();
135
136 if (trueHit.size() == 0) continue;
137
138 m_size = cluster.getSize();
139 m_side = cluster.isUCluster();
140 m_clsCharge = cluster.getCharge();
141 m_clsTime = cluster.getClsTime();
142 m_clsPos = m_side ? cluster.getPosition(trueHit[0]->getV()) : cluster.getPosition();
143 m_clsErr = cluster.getPositionSigma();
144 m_clsResid = m_side ? m_clsPos - trueHit[0]->getU() : m_clsPos - trueHit[0]->getV();
145 m_clsPull = m_clsResid / m_clsErr;
146
147 m_layer = cluster.getSensorID().getLayerNumber();
148 m_ladder = cluster.getSensorID().getLadderNumber();
149 m_sensor = cluster.getSensorID().getSensorNumber();
150
151 m_tree->Fill();
152
153 if (m_size == 1) m_hClsPullSize1->fill(cluster.getSensorID(), m_side, m_clsPull);
154 else if (m_size == 2) m_hClsPullSize2->fill(cluster.getSensorID(), m_side, m_clsPull);
155 else if (m_size == 3) m_hClsPullSize3->fill(cluster.getSensorID(), m_side, m_clsPull);
156 else if (m_size == 4) m_hClsPullSize4->fill(cluster.getSensorID(), m_side, m_clsPull);
157 else m_hClsPullSize5->fill(cluster.getSensorID(), m_side, m_clsPull);
158
159 }
160}
Belle2::RelationVector
Class for type safe access to objects that are referred to in relations.
Definition: RelationVector.h:67
Belle2::RelationVector::size
size_t size() const
Get number of relations.
Definition: RelationVector.h:88
Belle2::SVDCluster
The SVD Cluster class This class stores all information about reconstructed SVD clusters.
Definition: SVDCluster.h:29
Belle2::SVDHistograms::fill
void fill(const VxdID &vxdID, int view, Types ... args)
fill the histogram for
Definition: SVDHistograms.h:77
Belle2::SVDTrueHit
Class SVDTrueHit - Records of tracks that either enter or leave the sensitive volume.
Definition: SVDTrueHit.h:33
Belle2::StoreObjPtr
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96

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

◆ 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

check presence of data objects

Reimplemented from Module.

Definition at line 46 of file SVDPositionErrorScaleFactorImporterModule.cc.

47{
48 m_clusters.isRequired();
49 m_truehits.isRequired();
50}
Belle2::StoreAccessorBase::isRequired
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
Definition: StoreAccessorBase.h:78

◆ oneSigma()

double oneSigma ( TH1F *  h1)
private

computes the scale factor by requiring that 68% of the pull distribution is between ±1

Definition at line 361 of file SVDPositionErrorScaleFactorImporterModule.cc.

362{
363 TH1F* h1_res = (TH1F*)h1->Clone("h1_res");
364
365 double probs[2] = {0.16, 1 - 0.16};
366 double quant[2] = {0, 0};
367
368 int nbinsHisto = h1_res->GetNbinsX();
369
370 if (m_noOutliers) {
371 h1_res->SetBinContent(1, h1_res->GetBinContent(0) + h1_res->GetBinContent(1));
372 h1_res->SetBinContent(nbinsHisto, h1_res->GetBinContent(nbinsHisto) + h1_res->GetBinContent(nbinsHisto + 1));
373 h1_res->SetBinContent(0, 0);
374 h1_res->SetBinContent(nbinsHisto + 1, 0);
375 }
376
377 h1_res->GetQuantiles(2, quant, probs);
378
379 return (-quant[0] + quant[1]) / 2;
380
381}

◆ 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}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Belle2::LogConfig::setAbortLevel
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}
Belle2::LogConfig::setDebugLevel
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}
Belle2::LogConfig::setLogInfo
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}
Belle2::LogConfig::setLogLevel
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 {
239 m_moduleParamList.setParamPython(name, pyObj);
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}
Belle2::LogSystem
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
Belle2::LogSystem::updateModule
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
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition: ModuleParamList.templateDetails.h:104

◆ 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}
Belle2::Module::setParamPython
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()

virtual void terminate ( void  )
inlinevirtualinherited

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

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

This method can be implemented by subclasses.

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

Definition at line 176 of file Module.h.

176{};

Member Data Documentation

◆ m_clsCharge

float m_clsCharge = -1
private

cluster charge

Definition at line 90 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_clsErr

float m_clsErr = -1
private

cluster position error

Definition at line 93 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_clsPos

float m_clsPos = -1
private

cluster position error

Definition at line 92 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_clsPull

float m_clsPull = -1
private

cluster position pull

Definition at line 95 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_clsResid

float m_clsResid = -1
private

cluster positionresidual

Definition at line 94 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_clsTime

float m_clsTime = -1
private

cluster time

Definition at line 91 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_clusters

StoreArray<SVDCluster> m_clusters
private

SVDClusters StoreArray.

Definition at line 75 of file SVDPositionErrorScaleFactorImporterModule.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_exp

int m_exp = -1
private

exp number

Definition at line 83 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hBWPulls

TH1F* m_hBWPulls[5][2] = {}
private

cumulative BW pulls histograms [size][side]

Definition at line 112 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hClsPullSize1

SVDHistograms<TH1F>* m_hClsPullSize1 = nullptr
private

cluster size 1, position error scale factor histo

Definition at line 103 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hClsPullSize2

SVDHistograms<TH1F>* m_hClsPullSize2 = nullptr
private

cluster size 2, position error scale factor histo

Definition at line 104 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hClsPullSize3

SVDHistograms<TH1F>* m_hClsPullSize3 = nullptr
private

cluster size 3, position error scale factor histo

Definition at line 105 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hClsPullSize4

SVDHistograms<TH1F>* m_hClsPullSize4 = nullptr
private

cluster size 4, position error scale factor histo

Definition at line 106 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hClsPullSize5

SVDHistograms<TH1F>* m_hClsPullSize5 = nullptr
private

cluster size 5, position error scale factor histo

Definition at line 107 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hFWPulls

TH1F* m_hFWPulls[5][2] = {}
private

cumulative FW pulls histograms [size][side]

Definition at line 111 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hL3Pulls

TH1F* m_hL3Pulls[5][2] = {}
private

cumulative L3 pulls histograms [size][side]

Definition at line 110 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_hORPulls

TH1F* m_hORPulls[5][2] = {}
private

cumulative ORIGAMI pulls histograms [size][side]

Definition at line 113 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_ladder

int m_ladder = -1
private

ladder number

Definition at line 86 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_layer

int m_layer = -1
private

layer number

Definition at line 85 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_max

float m_max = 10
private

max of the pulls histograms

Definition at line 71 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_min

float m_min = -10
private

min of the pulls histograms

Definition at line 70 of file SVDPositionErrorScaleFactorImporterModule.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_nBins

float m_nBins = 100
private

number of bins of the pulls histograms

Definition at line 72 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_noOutliers

bool m_noOutliers = false
private

if True removes outliers from scale factor computation

Definition at line 68 of file SVDPositionErrorScaleFactorImporterModule.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_posAlgorithm

std::string m_posAlgorithm = "CoGOnly"
private

position algorithm

Definition at line 66 of file SVDPositionErrorScaleFactorImporterModule.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_rootFileName

std::string m_rootFileName
private

root file name

Definition at line 64 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_rootFilePtr

TFile* m_rootFilePtr = nullptr
private

pointer at root file used for storing histograms

Definition at line 79 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_run

int m_run = -1
private

run number

Definition at line 84 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_sensor

int m_sensor = -1
private

sensor number

Definition at line 87 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_side

int m_side = -1
private

sensor side

Definition at line 88 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_size

int m_size = -1
private

cluster size

Definition at line 89 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_tree

TTree* m_tree = nullptr
private

pointer at tree containing the mean and RMS of calibration constants

Definition at line 80 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ m_truehits

StoreArray<SVDTrueHit> m_truehits
private

SVDTrueHits StoreArray.

Definition at line 76 of file SVDPositionErrorScaleFactorImporterModule.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_uniqueID

std::string m_uniqueID = "PositionErrorScaleFactors_TEST"
private

payload uniqueID

Definition at line 73 of file SVDPositionErrorScaleFactorImporterModule.h.

◆ maxSize

const int maxSize = 5
private

maximum cluster size

Definition at line 109 of file SVDPositionErrorScaleFactorImporterModule.h.

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