Belle II Software  release-05-02-19
SVDB4CommissioningPlotsModule Class Reference

The SVD B4CommissioningPlots Module. More...

#include <SVDB4CommissioningPlotsModule.h>

Inheritance diagram for SVDB4CommissioningPlotsModule:
Collaboration diagram for SVDB4CommissioningPlotsModule:

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

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

Static Public Member Functions

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

Public Attributes

std::string m_ShaperDigitName
 SVDSHaperDigit StoreArray name.
 
std::string m_RecoDigitName
 SVDRecoDigit StoreArray name.
 
std::string m_ClusterName
 SVDCluster StoreArray name.
 
std::string m_TrackFitResultName
 TrackFitResult name.
 
std::string m_TrackName
 Track StoreArray name.
 
std::string m_rootFileName
 root file name
 
TFile * m_rootFilePtr = NULL
 pointer at root file used for storing histograms
 

Protected Member Functions

virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python. More...
 
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. More...
 
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. More...
 
void setType (const std::string &type)
 Set the module type. More...
 
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. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module. More...
 
void setReturnValue (int value)
 Sets the return value for this module as integer. More...
 
void setReturnValue (bool value)
 Sets the return value for this module as bool. More...
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

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

Private Attributes

int m_nEvents = 0
 number of events
 
SVDNoiseCalibrations m_NoiseCal
 SVDNoise Calibrations db object.
 
SVDPulseShapeCalibrations m_PulseShapeCal
 SVDPulseShaper calibrations db object.
 
StoreArray< SVDRecoDigitm_svdRecos
 SVDRecoDigit StoreArray.
 
StoreArray< SVDClusterm_svdClusters
 SVDCluster StoreArray.
 
StoreArray< RecoTrackm_recoTracks
 RecoTrack StoreArray.
 
StoreArray< Trackm_Tracks
 Track StoreArray.
 
StoreArray< TrackFitResultm_tfr
 TrackFitResult StoreArray.
 
int m_ntracks = 0
 number of tracks
 
TH1F * m_nTracks = NULL
 number of tracks
 
TH1F * m_Pvalue = NULL
 track p value
 
TH1F * m_mom = NULL
 track momentum
 
TH1F * m_nSVDhits = NULL
 track momentum
 
SVDHistograms< TH1F > * h_recoCharge = NULL
 SVDRecoDigits Charge.
 
SVDHistograms< TH1F > * h_recoEnergy = NULL
 SVDRecoDigits Energy.
 
SVDHistograms< TH1F > * h_recoTime = NULL
 SVDRecoDigits Time.
 
SVDHistograms< TH1F > * h_recoNoise = NULL
 SVDRecoDigits Noise.
 
SVDHistograms< TH1F > * h_clusterCharge = NULL
 SVDClusters Charge.
 
SVDHistograms< TH1F > * h_clusterSize = NULL
 SVDClusters Size.
 
SVDHistograms< TH1F > * h_clusterSNR = NULL
 SVDClusters SNR.
 
SVDHistograms< TH1F > * h_clusterEnergy = NULL
 SVDClusters Energy.
 
SVDHistograms< TH1F > * h_clusterTime = NULL
 SVDClusters Time.
 
SVDHistograms< TH1F > * h_clusterTrkCharge = NULL
 SVDClusters Charge.
 
SVDHistograms< TH1F > * h_clusterTrkSize = NULL
 SVDClusters Size.
 
SVDHistograms< TH1F > * h_clusterTrkSNR = NULL
 SVDClusters SNR.
 
SVDHistograms< TH1F > * h_clusterTrkEnergy = NULL
 SVDClusters Energy.
 
SVDHistograms< TH1F > * h_clusterTrkTime = NULL
 SVDClusters Time.
 
SVDHistograms< TH1F > * h_clusterTrkInterstripPos = NULL
 SVDClusters InterstripPosition.
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

The SVD B4CommissioningPlots Module.

Definition at line 49 of file SVDB4CommissioningPlotsModule.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 79 of file Module.h.

Member Function Documentation

◆ beginRun()

void beginRun ( )
overridevirtual

Called when entering a new run.

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

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 55 of file SVDB4CommissioningPlotsModule.cc.

56 {
57  m_nEvents = 0;
58 
59  //RECO DIGITS
60  TH1F hRecoCharge("reco_charge_L@layerL@ladderS@sensor@view",
61  "Charge of RecoDigits in @layer.@ladder.@sensor @view/@side side",
62  100, 0 , 1000);
63  hRecoCharge.GetXaxis()->SetTitle("charge (ke-)");
64  h_recoCharge = new SVDHistograms<TH1F>(hRecoCharge);
65 
66  TH1F hRecoEnergy("reco_energy_L@layerL@ladderS@sensor@view",
67  "Energy of RecoDigits in @layer.@ladder.@sensor @view/@side side",
68  100, 0 , 360);
69  hRecoEnergy.GetXaxis()->SetTitle("energy (keV)");
70  h_recoEnergy = new SVDHistograms<TH1F>(hRecoEnergy);
71 
72  TH1F hRecoTime("reco_time_L@layerL@ladderS@sensor@view",
73  "Time of RecoDigits in @layer.@ladder.@sensor @view/@side side",
74  200, -100 , 100);
75  hRecoTime.GetXaxis()->SetTitle("time (ns)");
76  h_recoTime = new SVDHistograms<TH1F>(hRecoTime);
77 
78  TH1F hRecoNoise("reco_noise_L@layerL@ladderS@sensor@view",
79  "Noise of RecoDigits in @layer.@ladder.@sensor @view/@side side",
80  200, 300 , 1800);
81  hRecoNoise.GetXaxis()->SetTitle("strip noise (e-)");
82  h_recoNoise = new SVDHistograms<TH1F>(hRecoNoise);
83 
84  //CLUSTER NOT RELATED TO TRACKS
85  TH1F hClusterCharge("cluster_charge_L@layerL@ladderS@sensor@view",
86  "Charge of Clusters in @layer.@ladder.@sensor @view/@side side",
87  100, 0 , 100);
88  hClusterCharge.GetXaxis()->SetTitle("charge (ke-)");
89  h_clusterCharge = new SVDHistograms<TH1F>(hClusterCharge);
90 
91  TH1F hClusterSize("cluster_size_L@layerL@ladderS@sensor@view",
92  "Clusters Size for @layer.@ladder.@sensor @view/@side side",
93  20, 0 , 20);
94  hClusterSize.GetXaxis()->SetTitle("cluster size");
95  h_clusterSize = new SVDHistograms<TH1F>(hClusterSize);
96 
97  TH1F hClusterSNR("cluster_SNR_L@layerL@ladderS@sensor@view",
98  "SNR of Clusters in @layer.@ladder.@sensor @view/@side side",
99  100, 0 , 140);
100  hClusterSNR.GetXaxis()->SetTitle("SNR");
101  h_clusterSNR = new SVDHistograms<TH1F>(hClusterSNR);
102 
103  TH1F hClusterEnergy("cluster_energy_L@layerL@ladderS@sensor@view",
104  "Energy of Clusters in @layer.@ladder.@sensor @view/@side side",
105  100, 0 , 360);
106  hClusterEnergy.GetXaxis()->SetTitle("energy (keV)");
107  h_clusterEnergy = new SVDHistograms<TH1F>(hClusterEnergy);
108 
109  TH1F hClusterTime("cluster_time_L@layerL@ladderS@sensor@view",
110  "Time of Clusters in @layer.@ladder.@sensor @view/@side side",
111  200, -100 , 100);
112  hClusterTime.GetXaxis()->SetTitle("time (ns)");
113  h_clusterTime = new SVDHistograms<TH1F>(hClusterTime);
114 
115  //CLUSTER RELATED TO TRACKS
116  TH1F hClusterTrkCharge("clusterTrk_charge_L@layerL@ladderS@sensor@view",
117  "Charge of Clusters Related to Tracks in @layer.@ladder.@sensor @view/@side side",
118  100, 0 , 100);
119  hClusterTrkCharge.GetXaxis()->SetTitle("charge (ke-)");
120  h_clusterTrkCharge = new SVDHistograms<TH1F>(hClusterTrkCharge);
121 
122  TH1F hClusterTrkSize("clusterTrk_size_L@layerL@ladderS@sensor@view",
123  "Cluster Size for @layer.@ladder.@sensor @view/@side side",
124  20, 0 , 20);
125  hClusterTrkSize.GetXaxis()->SetTitle("cluster size");
126  h_clusterTrkSize = new SVDHistograms<TH1F>(hClusterTrkSize);
127 
128  TH1F hClusterTrkSNR("clusterTrk_SNR_L@layerL@ladderS@sensor@view",
129  "SNR of Clusters Related to Tracks in @layer.@ladder.@sensor @view/@side side",
130  100, 0 , 140);
131  hClusterTrkSNR.GetXaxis()->SetTitle("SNR");
132  h_clusterTrkSNR = new SVDHistograms<TH1F>(hClusterTrkSNR);
133 
134  TH1F hClusterTrkEnergy("clusterTrk_energy_L@layerL@ladderS@sensor@view",
135  "Energy of Clusters Related to Tracks in @layer.@ladder.@sensor @view/@side side",
136  100, 0 , 360);
137  hClusterTrkEnergy.GetXaxis()->SetTitle("energy (keV)");
138  h_clusterTrkEnergy = new SVDHistograms<TH1F>(hClusterTrkEnergy);
139 
140  TH1F hClusterTrkTime("clusterTrk_time_L@layerL@ladderS@sensor@view",
141  "Time of Clusters Related to Tracks in @layer.@ladder.@sensor @view/@side side",
142  200, -100 , 100);
143  hClusterTrkTime.GetXaxis()->SetTitle("time (ns)");
144  h_clusterTrkTime = new SVDHistograms<TH1F>(hClusterTrkTime);
145 
146  TH1F hClusterTrkInterstripPos("clusterTrk_interstripPos_L@layerL@ladderS@sensor@view",
147  "Interstrip Position of Clusters Related to Tracks in @layer.@ladder.@sensor @view/@side side",
148  400, 0 , 1);
149  hClusterTrkInterstripPos.GetXaxis()->SetTitle("interstrip position");
150  h_clusterTrkInterstripPos = new SVDHistograms<TH1F>(hClusterTrkInterstripPos);
151 
152  //tracks
153  m_nTracks = new TH1F("h1nTracks", "number of Tracks per event", 50, 0, 50);
154  m_nTracks->GetXaxis()->SetTitle("n Tracks");
155  m_Pvalue = new TH1F("h1pValue", "Tracks p value", 100, 0, 1);
156  m_Pvalue->GetXaxis()->SetTitle("p value");
157  m_mom = new TH1F("h1momentum", " Tracks Momentum", 200, 0, 10);
158  m_mom->GetXaxis()->SetTitle("p (GeV/c)");
159  m_nSVDhits = new TH1F("h1nSVDhits", "# SVD hits per track", 20, 0, 20);
160  m_nSVDhits->GetXaxis()->SetTitle("# SVD hits");
161 
162 
163 }

◆ 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 181 of file Module.cc.

◆ 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 441 of file Module.h.

◆ 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 422 of file Module.h.

◆ endRun()

void endRun ( )
overridevirtual

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 276 of file SVDB4CommissioningPlotsModule.cc.

◆ 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 98 of file Module.cc.

◆ event()

void event ( )
overridevirtual

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 165 of file SVDB4CommissioningPlotsModule.cc.

◆ 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 135 of file Module.cc.

◆ 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 115 of file Module.cc.

◆ getFileNames()

virtual std::vector<std::string> getFileNames ( __attribute__((unused)) 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.

Definition at line 136 of file Module.h.

◆ 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 189 of file Module.h.

◆ 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 281 of file Module.cc.

◆ 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 383 of file Module.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ 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 162 of file Module.cc.

◆ 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 87 of file Module.cc.

◆ 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 92 of file Module.cc.

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 81 of file Module.cc.

◆ initialize()

void initialize ( )
overridevirtual

Initialize the Module.

This method is called once before the actual event processing starts. Use this method to initialize variables, open files etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 33 of file SVDB4CommissioningPlotsModule.cc.

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 216 of file Module.cc.

◆ 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 75 of file Module.cc.

◆ 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 216 of file Module.h.

◆ 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 236 of file Module.cc.

◆ 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 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ 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 229 of file Module.cc.

◆ 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 222 of file Module.cc.

◆ 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 50 of file Module.cc.

◆ terminate()

void terminate ( )
overridevirtual

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 from Module.

Definition at line 336 of file SVDB4CommissioningPlotsModule.cc.


The documentation for this class was generated from the following files:
Belle2::SVDB4CommissioningPlotsModule::h_clusterTrkSNR
SVDHistograms< TH1F > * h_clusterTrkSNR
SVDClusters SNR.
Definition: SVDB4CommissioningPlotsModule.h:111
Belle2::SVDB4CommissioningPlotsModule::h_clusterTrkSize
SVDHistograms< TH1F > * h_clusterTrkSize
SVDClusters Size.
Definition: SVDB4CommissioningPlotsModule.h:110
Belle2::SVDHistograms< TH1F >
Belle2::SVDB4CommissioningPlotsModule::m_nTracks
TH1F * m_nTracks
number of tracks
Definition: SVDB4CommissioningPlotsModule.h:90
Belle2::SVDB4CommissioningPlotsModule::m_Pvalue
TH1F * m_Pvalue
track p value
Definition: SVDB4CommissioningPlotsModule.h:91
Belle2::SVDB4CommissioningPlotsModule::h_clusterTrkCharge
SVDHistograms< TH1F > * h_clusterTrkCharge
SVDClusters Charge.
Definition: SVDB4CommissioningPlotsModule.h:109
Belle2::SVDB4CommissioningPlotsModule::m_nEvents
int m_nEvents
number of events
Definition: SVDB4CommissioningPlotsModule.h:76
Belle2::SVDB4CommissioningPlotsModule::h_recoEnergy
SVDHistograms< TH1F > * h_recoEnergy
SVDRecoDigits Energy.
Definition: SVDB4CommissioningPlotsModule.h:97
Belle2::SVDB4CommissioningPlotsModule::h_recoNoise
SVDHistograms< TH1F > * h_recoNoise
SVDRecoDigits Noise.
Definition: SVDB4CommissioningPlotsModule.h:99
Belle2::SVDB4CommissioningPlotsModule::h_clusterSNR
SVDHistograms< TH1F > * h_clusterSNR
SVDClusters SNR.
Definition: SVDB4CommissioningPlotsModule.h:104
Belle2::SVDB4CommissioningPlotsModule::h_clusterEnergy
SVDHistograms< TH1F > * h_clusterEnergy
SVDClusters Energy.
Definition: SVDB4CommissioningPlotsModule.h:105
Belle2::SVDB4CommissioningPlotsModule::h_clusterTrkTime
SVDHistograms< TH1F > * h_clusterTrkTime
SVDClusters Time.
Definition: SVDB4CommissioningPlotsModule.h:113
Belle2::SVDB4CommissioningPlotsModule::h_clusterTrkEnergy
SVDHistograms< TH1F > * h_clusterTrkEnergy
SVDClusters Energy.
Definition: SVDB4CommissioningPlotsModule.h:112
Belle2::SVDB4CommissioningPlotsModule::h_recoCharge
SVDHistograms< TH1F > * h_recoCharge
SVDRecoDigits Charge.
Definition: SVDB4CommissioningPlotsModule.h:96
Belle2::SVDB4CommissioningPlotsModule::m_nSVDhits
TH1F * m_nSVDhits
track momentum
Definition: SVDB4CommissioningPlotsModule.h:93
Belle2::SVDB4CommissioningPlotsModule::h_clusterCharge
SVDHistograms< TH1F > * h_clusterCharge
SVDClusters Charge.
Definition: SVDB4CommissioningPlotsModule.h:102
Belle2::SVDB4CommissioningPlotsModule::h_clusterTrkInterstripPos
SVDHistograms< TH1F > * h_clusterTrkInterstripPos
SVDClusters InterstripPosition.
Definition: SVDB4CommissioningPlotsModule.h:114
Belle2::SVDB4CommissioningPlotsModule::h_recoTime
SVDHistograms< TH1F > * h_recoTime
SVDRecoDigits Time.
Definition: SVDB4CommissioningPlotsModule.h:98
Belle2::SVDB4CommissioningPlotsModule::h_clusterSize
SVDHistograms< TH1F > * h_clusterSize
SVDClusters Size.
Definition: SVDB4CommissioningPlotsModule.h:103
Belle2::SVDB4CommissioningPlotsModule::h_clusterTime
SVDHistograms< TH1F > * h_clusterTime
SVDClusters Time.
Definition: SVDB4CommissioningPlotsModule.h:106
Belle2::SVDB4CommissioningPlotsModule::m_mom
TH1F * m_mom
track momentum
Definition: SVDB4CommissioningPlotsModule.h:92