Belle II Software development
VXDDQMExpressRecoModule Class Reference

VXD DQM Module. More...

#include <VXDDQMExpressRecoModule.h>

Inheritance diagram for VXDDQMExpressRecoModule:
HistoModule Module PathElement

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

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

Private Attributes

std::string m_histogramDirectoryName
 Name of the histogram directory in ROOT file.
 
int m_UseDigits = 0
 flag <0,1> for using digits only, no clusters will be required, default = 0
 
int m_SwapPXD = 0
 flag <0,1> very special case for swap of u-v coordinates
 
float m_CorrelationGranulation = 1.0
 set granulation of histogram plots, default is 1 deg (1 mm), min = 0.02, max = 5.0
 
std::string m_storePXDDigitsName
 PXDDigits StoreArray name.
 
std::string m_storeSVDShaperDigitsName
 SVDShaperDigits StoreArray name.
 
std::string m_storePXDClustersName
 PXDClusters StoreArray name.
 
std::string m_storeSVDClustersName
 SVDClusters StoreArray name.
 
std::string m_relPXDClusterDigitName
 PXDClustersToPXDDigits RelationArray name.
 
std::string m_relSVDClusterDigitName
 SVDClustersToSVDDigits RelationArray name.
 
float m_CutCorrelationSigPXD = 0
 Cut threshold of PXD signal for accepting to correlations, default = 0 ADU.
 
float m_CutCorrelationSigUSVD = 0
 Cut threshold of SVD signal for accepting to correlations in u, default = 0 ADU.
 
float m_CutCorrelationSigVSVD = 0
 Cut threshold of SVD signal for accepting to correlations in v, default = 0 ADU.
 
float m_CutCorrelationTimeSVD = 70
 Cut threshold of SVD time window for accepting to correlations, default = 70 ns.
 
TH2F ** m_correlationsSP {nullptr}
 Correlations and hit maps from space points.
 
TH1F ** m_correlationsSP1DPhi {nullptr}
 Correlations and hit maps from space points - differencies in Phi.
 
TH1F ** m_correlationsSP1DTheta {nullptr}
 Correlations and hit maps from space points - differencies in Theta.
 
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

VXD DQM Module.

Definition at line 22 of file VXDDQMExpressRecoModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

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

Constructor & Destructor Documentation

◆ VXDDQMExpressRecoModule()

Constructor.

Definition at line 46 of file VXDDQMExpressRecoModule.cc.

46 : HistoModule()
47{
48 //Set module properties
49 setDescription("VXD DQM module for Express Reco "
50 "Recommended Number of events for monitor is 40 kEvents or more to fill all histograms "
51 );
52
53 setPropertyFlags(c_ParallelProcessingCertified); // specify this flag if you need parallel processing
54 addParam("UseDigits", m_UseDigits,
55 "flag <0,1> for using digits only, no cluster information will be required, default = 0 ", m_UseDigits);
56 addParam("CorrelationGranulation", m_CorrelationGranulation,
57 "Set granulation of histogram plots, default is 1 degree, min = 0.02 degree, max = 1 degree ", m_CorrelationGranulation);
58 addParam("SwapPXD", m_SwapPXD, "flag <0,1> very special case for swap of phi-theta coordinates, default = 0 ", m_SwapPXD);
59 addParam("CutCorrelationSigPXD", m_CutCorrelationSigPXD,
60 "Cut threshold of PXD signal for accepting to correlations, default = 0 ADU ", m_CutCorrelationSigPXD);
61 addParam("CutCorrelationSigUSVD", m_CutCorrelationSigUSVD,
62 "Cut threshold of SVD signal for accepting to correlations in u, default = 0 ADU ", m_CutCorrelationSigUSVD);
63 addParam("CutCorrelationSigVSVD", m_CutCorrelationSigVSVD,
64 "Cut threshold of SVD signal for accepting to correlations in v, default = 0 ADU ", m_CutCorrelationSigVSVD);
65 addParam("CutCorrelationTimeSVD", m_CutCorrelationTimeSVD,
66 "Cut threshold of SVD time window for accepting to correlations, default = 70 ns ", m_CutCorrelationTimeSVD);
67
68 addParam("histogramDirectoryName", m_histogramDirectoryName, "Name of the directory where histograms will be placed",
69 std::string("VXDExpReco"));
70}
HistoModule()
Constructor.
Definition: HistoModule.h:32
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
int m_SwapPXD
flag <0,1> very special case for swap of u-v coordinates
float m_CorrelationGranulation
set granulation of histogram plots, default is 1 deg (1 mm), min = 0.02, max = 5.0
float m_CutCorrelationTimeSVD
Cut threshold of SVD time window for accepting to correlations, default = 70 ns.
float m_CutCorrelationSigVSVD
Cut threshold of SVD signal for accepting to correlations in v, default = 0 ADU.
std::string m_histogramDirectoryName
Name of the histogram directory in ROOT file.
float m_CutCorrelationSigPXD
Cut threshold of PXD signal for accepting to correlations, default = 0 ADU.
int m_UseDigits
flag <0,1> for using digits only, no clusters will be required, default = 0
float m_CutCorrelationSigUSVD
Cut threshold of SVD signal for accepting to correlations in u, default = 0 ADU.
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

◆ ~VXDDQMExpressRecoModule()

Definition at line 73 of file VXDDQMExpressRecoModule.cc.

74{
75}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
finaloverridevirtual

Begin run.

Reimplemented from HistoModule.

Definition at line 264 of file VXDDQMExpressRecoModule.cc.

265{
266 auto gTools = VXD::GeoCache::getInstance().getGeoTools();
267 if (gTools->getNumberOfLayers() == 0) return;
268
269 // Just to make sure, reset all the histograms.
270 int nVXDLayers = gTools->getNumberOfLayers();
271 for (int i = 0; i < nVXDLayers; i++) {
272 for (int j = 0; j < nVXDLayers; j++) {
273 if (m_correlationsSP[nVXDLayers * j + i] != NULL) m_correlationsSP[nVXDLayers * j + i]->Reset();
274 if (m_correlationsSP1DPhi[nVXDLayers * j + i] != NULL) m_correlationsSP1DPhi[nVXDLayers * j + i]->Reset();
275 if (m_correlationsSP1DTheta[nVXDLayers * j + i] != NULL) m_correlationsSP1DTheta[nVXDLayers * j + i]->Reset();
276 }
277 }
278}
TH2F ** m_correlationsSP
Correlations and hit maps from space points.
TH1F ** m_correlationsSP1DPhi
Correlations and hit maps from space points - differencies in Phi.
TH1F ** m_correlationsSP1DTheta
Correlations and hit maps from space points - differencies in Theta.
static GeoCache & getInstance()
Return a reference to the singleton instance.
Definition: GeoCache.cc:214
const GeoTools * getGeoTools()
Return a raw pointer to a GeoTools object.
Definition: GeoCache.h:142
unsigned short getNumberOfLayers() const
Get number of VXD layers.
Definition: GeoTools.h:41

◆ clone()

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

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

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

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

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

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

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

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

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

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

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

◆ defineHisto()

void defineHisto ( )
finaloverridevirtual

Histogram definitions such as TH1(), TH2(), TNtuple(), TTree()....

are supposed to be placed in this function.

Reimplemented from HistoModule.

Definition at line 81 of file VXDDQMExpressRecoModule.cc.

82{
84 if (gTools->getNumberOfLayers() == 0) {
85 B2WARNING("Missing geometry for VXD, check steering file.");
86 return;
87 }
88 if (gTools->getNumberOfPXDLayers() == 0) {
89 B2WARNING("Missing geometry for PXD.");
90 }
91 if (gTools->getNumberOfSVDLayers() == 0) {
92 B2WARNING("Missing geometry for SVD.");
93 }
94
95 // Create a separate histogram directories and cd into it.
96 TDirectory* oldDir = gDirectory;
97 if (m_histogramDirectoryName != "") {
98 oldDir->mkdir(m_histogramDirectoryName.c_str());// do not use return value with ->cd(), its ZERO if dir already exists
99 oldDir->cd(m_histogramDirectoryName.c_str());
100 }
101
102 if (m_CorrelationGranulation > 5.0) m_CorrelationGranulation = 5.0; // set maximum of gramularity to 1 degree
103 if (m_CorrelationGranulation < 0.02) m_CorrelationGranulation = 0.02; // set minimum of gramularity to 0.02 degree
104
105 // if binning go over h_MaxBins it decrease preset of range
106 int h_MaxBins = 2000; //maximal size of histogram binning:
107
109
110 // basic constants presets:
111 int nVXDLayers = gTools->getNumberOfLayers();
112
113 // Create basic histograms:
114 m_correlationsSP = (TH2F**) new TH2F*[nVXDLayers * nVXDLayers];
115 m_correlationsSP1DPhi = (TH1F**) new TH1F*[nVXDLayers * nVXDLayers];
116 m_correlationsSP1DTheta = (TH1F**) new TH1F*[nVXDLayers * nVXDLayers];
117
118
119 for (int i = 0; i < nVXDLayers; i++) {
120 for (int j = 0; j < nVXDLayers; j++) {
121 m_correlationsSP[nVXDLayers * j + i] = NULL;
122 m_correlationsSP1DPhi[nVXDLayers * j + i] = NULL;
123 m_correlationsSP1DTheta[nVXDLayers * j + i] = NULL;
124 }
125 }
126
127 string Diru = str(format("Phi"));
128 string Dirv = str(format("Theta"));
129 string Unit = str(format("degree"));
130 string AxisTitPhi = str(format("%1% position [%2%]") % Diru.c_str() % Unit.c_str()); // 0..360 degree, from x+ to y+...
131 string AxisTitTheta = str(format("%1% position [%2%]") % Dirv.c_str() % Unit.c_str()); // 0..180 degree, z+ to z-
132 if (m_UseDigits) {
133 AxisTitPhi = str(format("From digits: %1%") % AxisTitPhi);
134 AxisTitTheta = str(format("From digits: %1%") % AxisTitTheta);
135 }
136 for (VxdID layer1 : geo.getLayers()) {
137 int i = layer1.getLayerNumber() - gTools->getFirstLayer();
138 float uSize1s, uSize1e;
139 float vSize1s, vSize1e;
140 int nStripsU1, nStripsV1;
141 uSize1s = -180.0; // degree
142 uSize1e = 180.0; // degree
143 vSize1s = 0.0; // degree
144 vSize1e = 180.0; // degree
145 nStripsU1 = (uSize1e - uSize1s) / m_CorrelationGranulation;
146 if (nStripsU1 > h_MaxBins) nStripsU1 = h_MaxBins;
147 nStripsV1 = nStripsU1;
148 for (VxdID layer2 : geo.getLayers()) {
149 int j = layer2.getLayerNumber() - gTools->getFirstLayer();
150 float uSize2s, uSize2e;
151 float vSize2s, vSize2e;
152 int nStripsU2, nStripsV2;
153 uSize2s = -180.0; // degree
154 uSize2e = 180.0; // degree
155 vSize2s = 0.0; // degree
156 vSize2e = 180.0; // degree
157 nStripsU2 = nStripsU1;
158 nStripsV2 = nStripsV1;
159
160 if (i == j) { // hit maps
161 string nameSP = str(format("DQMER_VXD_Hitmap_L%1%") % layer2.getLayerNumber());
162 string titleSP = str(format("DQM ER VXD Hitmap, layer %1%") % layer2.getLayerNumber());
163 m_correlationsSP[nVXDLayers * j + i] = new TH2F(nameSP.c_str(), titleSP.c_str(),
164 nStripsU2, uSize2s, uSize2e,
165 nStripsV2, vSize2s, vSize2e);
166 m_correlationsSP[nVXDLayers * j + i]->GetXaxis()->SetTitle(AxisTitPhi.c_str());
167 m_correlationsSP[nVXDLayers * j + i]->GetYaxis()->SetTitle(AxisTitTheta.c_str());
168 m_correlationsSP[nVXDLayers * j + i]->GetZaxis()->SetTitle("hits");
169
170 nameSP = str(format("DQMER_VXD_Hitmap_%1%_L%2%") % Diru.c_str() % layer2.getLayerNumber());
171 titleSP = str(format("DQM ER VXD Hitmap in %1%, layer %2%") % Diru.c_str() % layer2.getLayerNumber());
172 m_correlationsSP1DPhi[nVXDLayers * j + i] = new TH1F(nameSP.c_str(), titleSP.c_str(),
173 nStripsU2, uSize2s, uSize2e);
174 m_correlationsSP1DPhi[nVXDLayers * j + i]->GetXaxis()->SetTitle(AxisTitPhi.c_str());
175 m_correlationsSP1DPhi[nVXDLayers * j + i]->GetYaxis()->SetTitle("hits");
176
177 nameSP = str(format("DQMER_VXD_Hitmap_%1%_L%2%") % Dirv.c_str() % layer2.getLayerNumber());
178 titleSP = str(format("DQM ER VXD Hitmap in %1%, layer %2%") % Dirv.c_str() % layer2.getLayerNumber());
179 m_correlationsSP1DTheta[nVXDLayers * j + i] = new TH1F(nameSP.c_str(), titleSP.c_str(),
180 nStripsV2, vSize2s, vSize2e);
181 m_correlationsSP1DTheta[nVXDLayers * j + i]->GetXaxis()->SetTitle(AxisTitTheta.c_str());
182 m_correlationsSP1DTheta[nVXDLayers * j + i]->GetYaxis()->SetTitle("hits");
183
184 } else if (i < j) { // correlations for Phi
185 string nameSP = str(format("DQMER_VXD_Correlations_%1%_L%2%_L%3%") % Diru.c_str() % layer1.getLayerNumber() %
186 layer2.getLayerNumber());
187 string titleSP = str(format("DQM ER VXD Correlations in %1%, layers %2% %3%") % Diru.c_str() % layer1.getLayerNumber() %
188 layer2.getLayerNumber());
189 m_correlationsSP[nVXDLayers * j + i] = new TH2F(nameSP.c_str(), titleSP.c_str(),
190 nStripsU1, uSize1s, uSize1e,
191 nStripsU2, uSize2s, uSize2e);
192 string axisxtitle = str(format("%1%, layer %2%") % AxisTitPhi.c_str() % layer1.getLayerNumber());
193 string axisytitle = str(format("%1%, layer %2%") % AxisTitPhi.c_str() % layer2.getLayerNumber());
194 m_correlationsSP[nVXDLayers * j + i]->GetXaxis()->SetTitle(axisxtitle.c_str());
195 m_correlationsSP[nVXDLayers * j + i]->GetYaxis()->SetTitle(axisytitle.c_str());
196 m_correlationsSP[nVXDLayers * j + i]->GetZaxis()->SetTitle("hits");
197
198 nameSP = str(format("DQMER_VXD_1D_Correlations_%1%_L%2%_L%3%") % Diru.c_str() % layer1.getLayerNumber() % layer2.getLayerNumber());
199 titleSP = str(format("DQM ER VXD 1D Correlations in %1%, layers %2% %3%") % Diru.c_str() % layer1.getLayerNumber() %
200 layer2.getLayerNumber());
201 m_correlationsSP1DPhi[nVXDLayers * j + i] = new TH1F(nameSP.c_str(), titleSP.c_str(),
202 nStripsU1, uSize1s, uSize1e);
203 axisxtitle = str(format("%1%, layer %2% - %3%") % AxisTitPhi.c_str() % layer1.getLayerNumber() % layer2.getLayerNumber());
204 m_correlationsSP1DPhi[nVXDLayers * j + i]->GetXaxis()->SetTitle(axisxtitle.c_str());
205 m_correlationsSP1DPhi[nVXDLayers * j + i]->GetYaxis()->SetTitle("hits");
206 } else { // correlations for Theta
207 string nameSP = str(format("DQMER_VXD_Correlations_%1%_L%2%_L%3%") % Dirv.c_str() % layer1.getLayerNumber() %
208 layer2.getLayerNumber());
209 string titleSP = str(format("DQM ER VXD Correlations in %1%, layers %2% %3%") % Dirv.c_str() % layer1.getLayerNumber() %
210 layer2.getLayerNumber());
211 m_correlationsSP[nVXDLayers * j + i] = new TH2F(nameSP.c_str(), titleSP.c_str(),
212 nStripsV1, vSize1s, vSize1e,
213 nStripsV2, vSize2s, vSize2e);
214 string axisxtitle = str(format("%1%, layer %2%") % AxisTitTheta.c_str() % layer1.getLayerNumber());
215 string axisytitle = str(format("%1%, layer %2%") % AxisTitTheta.c_str() % layer2.getLayerNumber());
216 m_correlationsSP[nVXDLayers * j + i]->GetXaxis()->SetTitle(axisxtitle.c_str());
217 m_correlationsSP[nVXDLayers * j + i]->GetYaxis()->SetTitle(axisytitle.c_str());
218 m_correlationsSP[nVXDLayers * j + i]->GetZaxis()->SetTitle("hits");
219
220 nameSP = str(format("DQMER_VXD_1D_Correlations_%1%_L%2%_L%3%") % Dirv.c_str() % layer1.getLayerNumber() % layer2.getLayerNumber());
221 titleSP = str(format("DQM ER VXD 1D Correlations in %1%, layers %2% %3%") % Dirv.c_str() % layer1.getLayerNumber() %
222 layer2.getLayerNumber());
223 m_correlationsSP1DTheta[nVXDLayers * j + i] = new TH1F(nameSP.c_str(), titleSP.c_str(),
224 nStripsV1, -vSize1e, vSize1e);
225 axisxtitle = str(format("%1%, layer %2% - %3%") % AxisTitTheta.c_str() % layer1.getLayerNumber() % layer2.getLayerNumber());
226 m_correlationsSP1DTheta[nVXDLayers * j + i]->GetXaxis()->SetTitle(axisxtitle.c_str());
227 m_correlationsSP1DTheta[nVXDLayers * j + i]->GetYaxis()->SetTitle("hits");
228 }
229 }
230 }
231
232 oldDir->cd();
233}
The Unit class.
Definition: Unit.h:40
Class to faciliate easy access to sensor information of the VXD like coordinate transformations or pi...
Definition: GeoCache.h:39
const std::set< Belle2::VxdID > getLayers(SensorInfoBase::SensorType sensortype=SensorInfoBase::VXD)
Return a set of all known Layers.
Definition: GeoCache.cc:176
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:33

◆ endRun()

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

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

◆ event()

void event ( void  )
finaloverridevirtual

Event.

Reimplemented from HistoModule.

Definition at line 281 of file VXDDQMExpressRecoModule.cc.

282{
283 auto gTools = VXD::GeoCache::getInstance().getGeoTools();
284 if (gTools->getNumberOfLayers() == 0) return;
285
286 const StoreArray<PXDDigit> storePXDDigits(m_storePXDDigitsName);
287 const StoreArray<SVDShaperDigit> storeSVDShaperDigits(m_storeSVDShaperDigitsName);
288
289 const StoreArray<SVDCluster> storeSVDClusters(m_storeSVDClustersName);
290 const StoreArray<PXDCluster> storePXDClusters(m_storePXDClustersName);
291
292 const RelationArray relPXDClusterDigits(storePXDClusters, storePXDDigits, m_relPXDClusterDigitName);
293 const RelationArray relSVDClusterDigits(storeSVDClusters, storeSVDShaperDigits, m_relSVDClusterDigitName);
294
295 // If there are no digits, leave
296 if (!storePXDDigits && !storeSVDShaperDigits) return;
297
298 // basic constants presets:
299 int nVXDLayers = gTools->getNumberOfLayers();
300 int firstVXDLayer = gTools->getFirstLayer();
301 int firstPXDLayer = gTools->getFirstPXDLayer();
302 int lastPXDLayer = gTools->getLastPXDLayer();
303 int firstSVDLayer = gTools->getFirstSVDLayer();
304 int lastSVDLayer = gTools->getLastSVDLayer();
305
306 int MaxHits = 0;
307 if (m_UseDigits) {
308 MaxHits = storeSVDShaperDigits.getEntries() + storePXDDigits.getEntries();
309 } else {
310 MaxHits = storeSVDClusters.getEntries() + storePXDClusters.getEntries();
311 }
312
313 // If there are no hits, leave
314 if (MaxHits == 0) return;
315
316 for (int i1 = 0; i1 < MaxHits; i1++) {
317 // preparing of first value for correlation plots with postfix "1":
318 float fTime1 = 0.0;
319 float fPosSPU1 = 0.0;
320 float fPosSPV1 = 0.0;
321 int iIsPXD1 = 0;
322 int index1 = 0;
323 int iIsU1 = 0;
324 int iIsV1 = 0;
325 int iLayer1 = 0;
326 if (m_UseDigits) { // DIGITS:
327 if (i1 < storePXDDigits.getEntries()) { // PXD digits/clusters:
328 const PXDDigit& digitPXD1 = *storePXDDigits[i1];
329 iLayer1 = digitPXD1.getSensorID().getLayerNumber();
330 if ((iLayer1 < firstPXDLayer) || (iLayer1 > lastPXDLayer)) continue;
331 index1 = iLayer1 - firstVXDLayer;
332 float fCharge1 = digitPXD1.getCharge();
333 if (fCharge1 < m_CutCorrelationSigPXD) continue;
334 VxdID sensorID1 = digitPXD1.getSensorID();
335 auto info = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID1));
336 ROOT::Math::XYZVector rLocal1(info.getUCellPosition(digitPXD1.getUCellID()), info.getVCellPosition(digitPXD1.getVCellID()), 0);
337 ROOT::Math::XYZVector ral1 = info.pointToGlobal(rLocal1);
338 iIsPXD1 = 1;
339 iIsU1 = 1;
340 iIsV1 = 1;
341 fPosSPU1 = ral1.Phi() / TMath::Pi() * 180;
342 fPosSPV1 = ral1.Theta() / TMath::Pi() * 180;
343 if (m_SwapPXD) {
344 fPosSPV1 = ral1.Phi() / TMath::Pi() * 180;
345 fPosSPU1 = ral1.Theta() / TMath::Pi() * 180;
346 }
347 } else { // SVD digits/clusters:
348 const SVDShaperDigit& digitSVD1 = *storeSVDShaperDigits[i1 - storePXDDigits.getEntries()];
349 iLayer1 = digitSVD1.getSensorID().getLayerNumber();
350 if ((iLayer1 < firstSVDLayer) || (iLayer1 > lastSVDLayer)) continue;
351 index1 = iLayer1 - firstVXDLayer;
352 fTime1 = digitSVD1.getFADCTime();
353 VxdID sensorID1 = digitSVD1.getSensorID();
354 auto info = dynamic_cast<const SVD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID1));
355 SVDShaperDigit::APVFloatSamples samples = digitSVD1.getSamples();
356 if (digitSVD1.isUStrip()) {
357 int iCont = 0;
358 for (size_t i = 0; i < SVDShaperDigit::c_nAPVSamples; ++i) {
359 float fCharge1 = samples[i];
360 if (fCharge1 > m_CutCorrelationSigUSVD) iCont = 1;
361 }
362 if (iCont == 0) continue;
363 float possi = info.getUCellPosition(digitSVD1.getCellID());
364 ROOT::Math::XYZVector rLocal1(possi, 0, 0);
365 ROOT::Math::XYZVector ral1 = info.pointToGlobal(rLocal1);
366 iIsU1 = 1;
367 fPosSPU1 = ral1.Phi() / TMath::Pi() * 180;
368 } else {
369 int iCont = 0;
370 for (size_t i = 0; i < SVDShaperDigit::c_nAPVSamples; ++i) {
371 float fCharge1 = samples[i];
372 if (fCharge1 > m_CutCorrelationSigVSVD) iCont = 1;
373 }
374 if (iCont == 0) continue;
375
376 //float possi = digitSVD1.getCellPosition(); // is not work anymore
377 float possi = info.getVCellPosition(digitSVD1.getCellID());
378
379 ROOT::Math::XYZVector rLocal1(0, possi, 0);
380 ROOT::Math::XYZVector ral1 = info.pointToGlobal(rLocal1);
381 iIsV1 = 1;
382 fPosSPV1 = ral1.Theta() / TMath::Pi() * 180;
383 }
384 }
385 } else { // CLUSTERS:
386 if (i1 < storePXDClusters.getEntries()) { // PXD digits/clusters:
387 const PXDCluster& clusterPXD1 = *storePXDClusters[i1];
388 iLayer1 = clusterPXD1.getSensorID().getLayerNumber();
389 if ((iLayer1 < firstPXDLayer) || (iLayer1 > lastPXDLayer)) continue;
390 index1 = iLayer1 - firstVXDLayer;
391 float fCharge1 = clusterPXD1.getCharge();
392 if (fCharge1 < m_CutCorrelationSigPXD) continue;
393 VxdID sensorID1 = clusterPXD1.getSensorID();
394 auto info = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID1));
395 ROOT::Math::XYZVector rLocal1(clusterPXD1.getU(), clusterPXD1.getV(), 0);
396 ROOT::Math::XYZVector ral1 = info.pointToGlobal(rLocal1);
397 iIsPXD1 = 1;
398 iIsU1 = 1;
399 iIsV1 = 1;
400 fPosSPU1 = ral1.Phi() / TMath::Pi() * 180;
401 fPosSPV1 = ral1.Theta() / TMath::Pi() * 180;
402 if (m_SwapPXD) {
403 fPosSPV1 = ral1.Phi() / TMath::Pi() * 180;
404 fPosSPU1 = ral1.Theta() / TMath::Pi() * 180;
405 }
406 } else { // SVD digits/clusters:
407 const SVDCluster& clusterSVD1 = *storeSVDClusters[i1 - storePXDClusters.getEntries()];
408 iLayer1 = clusterSVD1.getSensorID().getLayerNumber();
409 if ((iLayer1 < firstSVDLayer) || (iLayer1 > lastSVDLayer)) continue;
410 index1 = iLayer1 - firstVXDLayer;
411 float fCharge1 = clusterSVD1.getCharge();
412 fTime1 = clusterSVD1.getClsTime();
413 VxdID sensorID1 = clusterSVD1.getSensorID();
414 auto info = dynamic_cast<const SVD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID1));
415 if (clusterSVD1.isUCluster()) {
416 if (fCharge1 < m_CutCorrelationSigUSVD * 200) continue; // in electrons
417 ROOT::Math::XYZVector rLocal1(clusterSVD1.getPosition(), 0, 0);
418 ROOT::Math::XYZVector ral1 = info.pointToGlobal(rLocal1);
419 iIsU1 = 1;
420 fPosSPU1 = ral1.Phi() / TMath::Pi() * 180;
421 } else {
422 if (fCharge1 < m_CutCorrelationSigVSVD * 200) continue; // in electrons
423 ROOT::Math::XYZVector rLocal1(0, clusterSVD1.getPosition(), 0);
424 ROOT::Math::XYZVector ral1 = info.pointToGlobal(rLocal1);
425 iIsV1 = 1;
426 fPosSPV1 = ral1.Theta() / TMath::Pi() * 180;
427 }
428 }
429 }
430 // hit maps for PXD:
431 if ((iIsU1 == 1) && (iIsV1 == 1)) {
432 if (m_correlationsSP[nVXDLayers * index1 + index1] != NULL)
433 m_correlationsSP[nVXDLayers * index1 + index1]->Fill(fPosSPU1, fPosSPV1);
434 if (m_correlationsSP1DPhi[nVXDLayers * index1 + index1] != NULL)
435 m_correlationsSP1DPhi[nVXDLayers * index1 + index1]->Fill(fPosSPU1);
436 if (m_correlationsSP1DTheta[nVXDLayers * index1 + index1] != NULL)
437 m_correlationsSP1DTheta[nVXDLayers * index1 + index1]->Fill(fPosSPV1);
438 }
439 for (int i2 = 0; i2 < MaxHits; i2++) {
440 // preparing of second value for correlation plots with postfix "2":
441 float fTime2 = 0.0;
442 float fPosSPU2 = 0.0;
443 float fPosSPV2 = 0.0;
444 int iIsPXD2 = 0;
445 int index2 = 0;
446 int iIsU2 = 0;
447 int iIsV2 = 0;
448 int iLayer2 = 0;
449 if (m_UseDigits) { // DIGITS:
450 if (i2 < storePXDDigits.getEntries()) { // PXD digits/clusters:
451 const PXDDigit& digitPXD2 = *storePXDDigits[i2];
452 iLayer2 = digitPXD2.getSensorID().getLayerNumber();
453 if ((iLayer2 < firstPXDLayer) || (iLayer2 > lastPXDLayer)) continue;
454 index2 = iLayer2 - firstVXDLayer;
455 float fCharge2 = digitPXD2.getCharge();
456 if (fCharge2 < m_CutCorrelationSigPXD) continue;
457 VxdID sensorID2 = digitPXD2.getSensorID();
458 auto info = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID2));
459 ROOT::Math::XYZVector rLocal2(info.getUCellPosition(digitPXD2.getUCellID()), info.getVCellPosition(digitPXD2.getVCellID()), 0);
460 ROOT::Math::XYZVector ral2 = info.pointToGlobal(rLocal2);
461 iIsPXD2 = 1;
462 iIsU2 = 1;
463 iIsV2 = 1;
464 fPosSPU2 = ral2.Phi() / TMath::Pi() * 180;
465 fPosSPV2 = ral2.Theta() / TMath::Pi() * 180;
466 if (m_SwapPXD) {
467 fPosSPV2 = ral2.Phi() / TMath::Pi() * 180;
468 fPosSPU2 = ral2.Theta() / TMath::Pi() * 180;
469 }
470 } else { // SVD digits/clusters:
471 const SVDShaperDigit& digitSVD2 = *storeSVDShaperDigits[i2 - storePXDDigits.getEntries()];
472 iLayer2 = digitSVD2.getSensorID().getLayerNumber();
473 if ((iLayer2 < firstSVDLayer) || (iLayer2 > lastSVDLayer)) continue;
474 index2 = iLayer2 - firstVXDLayer;
475 fTime2 = digitSVD2.getFADCTime();
476 VxdID sensorID2 = digitSVD2.getSensorID();
477 auto info = dynamic_cast<const SVD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID2));
478
479 SVDShaperDigit::APVFloatSamples samples = digitSVD2.getSamples();
480 if (digitSVD2.isUStrip()) {
481 int iCont = 0;
482 for (size_t i = 0; i < SVDShaperDigit::c_nAPVSamples; ++i) {
483 float fCharge2 = samples[i];
484 if (fCharge2 > m_CutCorrelationSigUSVD) iCont = 1;
485 }
486 if (iCont == 0) continue;
487 float possi = info.getUCellPosition(digitSVD2.getCellID());
488 ROOT::Math::XYZVector rLocal2(possi, 0, 0);
489 ROOT::Math::XYZVector ral2 = info.pointToGlobal(rLocal2);
490 iIsU2 = 1;
491 fPosSPU2 = ral2.Phi() / TMath::Pi() * 180;
492 } else {
493 int iCont = 0;
494 for (size_t i = 0; i < SVDShaperDigit::c_nAPVSamples; ++i) {
495 float fCharge2 = samples[i];
496 if (fCharge2 > m_CutCorrelationSigVSVD) iCont = 1;
497 }
498 if (iCont == 0) continue;
499 float possi = info.getVCellPosition(digitSVD2.getCellID());
500 ROOT::Math::XYZVector rLocal2(0, possi, 0);
501 ROOT::Math::XYZVector ral2 = info.pointToGlobal(rLocal2);
502 iIsV2 = 1;
503 fPosSPV2 = ral2.Theta() / TMath::Pi() * 180;
504 }
505 }
506 } else { // CLUSTERS:
507 if (i2 < storePXDClusters.getEntries()) { // PXD digits/clusters:
508 const PXDCluster& clusterPXD2 = *storePXDClusters[i2];
509 iLayer2 = clusterPXD2.getSensorID().getLayerNumber();
510 if ((iLayer2 < firstPXDLayer) || (iLayer2 > lastPXDLayer)) continue;
511 index2 = iLayer2 - firstVXDLayer;
512 float fCharge2 = clusterPXD2.getCharge();
513 if (fCharge2 < m_CutCorrelationSigPXD) continue;
514 VxdID sensorID2 = clusterPXD2.getSensorID();
515 auto info = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID2));
516 ROOT::Math::XYZVector rLocal2(clusterPXD2.getU(), clusterPXD2.getV(), 0);
517 ROOT::Math::XYZVector ral2 = info.pointToGlobal(rLocal2);
518 iIsPXD2 = 1;
519 iIsU2 = 1;
520 iIsV2 = 1;
521 fPosSPU2 = ral2.Phi() / TMath::Pi() * 180;
522 fPosSPV2 = ral2.Theta() / TMath::Pi() * 180;
523 if (m_SwapPXD) {
524 fPosSPV2 = ral2.Phi() / TMath::Pi() * 180;
525 fPosSPU2 = ral2.Theta() / TMath::Pi() * 180;
526 }
527 } else { // SVD digits/clusters:
528 const SVDCluster& clusterSVD2 = *storeSVDClusters[i2 - storePXDClusters.getEntries()];
529 iLayer2 = clusterSVD2.getSensorID().getLayerNumber();
530 if ((iLayer2 < firstSVDLayer) || (iLayer2 > lastSVDLayer)) continue;
531 index2 = iLayer2 - firstVXDLayer;
532 float fCharge2 = clusterSVD2.getCharge();
533 fTime2 = clusterSVD2.getClsTime();
534 VxdID sensorID2 = clusterSVD2.getSensorID();
535 auto info = dynamic_cast<const SVD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID2));
536 if (clusterSVD2.isUCluster()) {
537 if (fCharge2 < m_CutCorrelationSigUSVD * 200) continue; // in electrons
538 ROOT::Math::XYZVector rLocal2(clusterSVD2.getPosition(), 0, 0);
539 ROOT::Math::XYZVector ral2 = info.pointToGlobal(rLocal2);
540 iIsU2 = 1;
541 fPosSPU2 = ral2.Phi() / TMath::Pi() * 180;
542 } else {
543 if (fCharge2 < m_CutCorrelationSigVSVD * 200) continue; // in electrons
544 ROOT::Math::XYZVector rLocal2(0, clusterSVD2.getPosition(), 0);
545 ROOT::Math::XYZVector ral2 = info.pointToGlobal(rLocal2);
546 iIsV2 = 1;
547 fPosSPV2 = ral2.Theta() / TMath::Pi() * 180;
548 }
549 }
550 }
551 if ((iIsPXD1 == 0) && (iIsPXD2 == 0))
552 if ((fabs(fTime1 - fTime2)) > m_CutCorrelationTimeSVD) continue;
553 // ready to fill correlation histograms and hit maps:
554 if ((index1 == index2) && (iIsU1 == 1) && (iIsV2 == 1) && (iIsPXD1 == 0) && (iIsPXD2 == 0)) {
555 // hit maps for SVD:
556 if (m_correlationsSP[nVXDLayers * index2 + index1] != NULL)
557 m_correlationsSP[nVXDLayers * index2 + index1]->Fill(fPosSPU1, fPosSPV2);
558 if (m_correlationsSP1DPhi[nVXDLayers * index2 + index1] != NULL)
559 m_correlationsSP1DPhi[nVXDLayers * index2 + index1]->Fill(fPosSPU1);
560 if (m_correlationsSP1DTheta[nVXDLayers * index2 + index1] != NULL)
561 m_correlationsSP1DTheta[nVXDLayers * index2 + index1]->Fill(fPosSPV2);
562 } else if ((index1 < index2) && (iIsU1 == iIsU2) && (iIsU1 == 1)) {
563 // correlations for u
564 if (m_correlationsSP[nVXDLayers * index2 + index1] != NULL)
565 m_correlationsSP[nVXDLayers * index2 + index1]->Fill(fPosSPU1, fPosSPU2);
566 if (m_correlationsSP1DPhi[nVXDLayers * index2 + index1] != NULL)
567 m_correlationsSP1DPhi[nVXDLayers * index2 + index1]->Fill(fPosSPU2 - fPosSPU1);
568 } else if ((index1 > index2) && (iIsV1 == iIsV2) && (iIsV1 == 1)) {
569 // correlations for v
570 if (m_correlationsSP[nVXDLayers * index2 + index1] != NULL)
571 m_correlationsSP[nVXDLayers * index2 + index1]->Fill(fPosSPV2, fPosSPV1);
572 if (m_correlationsSP1DTheta[nVXDLayers * index2 + index1] != NULL)
573 m_correlationsSP1DTheta[nVXDLayers * index2 + index1]->Fill(fPosSPV2 - fPosSPV1);
574 }
575 }
576 }
577
578}
The PXD Cluster class This class stores all information about reconstructed PXD clusters The position...
Definition: PXDCluster.h:30
float getV() const
Get v coordinate of hit position.
Definition: PXDCluster.h:136
unsigned short getCharge() const
Get collected charge.
Definition: PXDCluster.h:156
VxdID getSensorID() const
Get the sensor ID.
Definition: PXDCluster.h:126
float getU() const
Get u coordinate of hit position.
Definition: PXDCluster.h:131
The PXD digit class.
Definition: PXDDigit.h:27
unsigned short getVCellID() const
Get cell ID in v.
Definition: PXDDigit.h:74
unsigned short getUCellID() const
Get cell ID in u.
Definition: PXDDigit.h:69
unsigned short getCharge() const
Get collected charge.
Definition: PXDDigit.h:79
VxdID getSensorID() const
Get the sensor ID.
Definition: PXDDigit.h:64
Specific implementation of SensorInfo for PXD Sensors which provides additional pixel specific inform...
Definition: SensorInfo.h:23
Low-level class to create/modify relations between StoreArrays.
Definition: RelationArray.h:62
The SVD Cluster class This class stores all information about reconstructed SVD clusters.
Definition: SVDCluster.h:29
float getClsTime() const
Get average of waveform maximum times of cluster strip signals.
Definition: SVDCluster.h:134
float getCharge() const
Get collected charge.
Definition: SVDCluster.h:144
VxdID getSensorID() const
Get the sensor ID.
Definition: SVDCluster.h:102
bool isUCluster() const
Get the direction of strips.
Definition: SVDCluster.h:110
float getPosition(double v=0) const
Get the coordinate of reconstructed hit.
Definition: SVDCluster.h:117
The SVD ShaperDigit class.
static const std::size_t c_nAPVSamples
Number of APV samples stored.
std::array< APVFloatSampleType, c_nAPVSamples > APVFloatSamples
array of APVFloatSampleType objects
VxdID getSensorID() const
Get the sensor ID.
APVFloatSamples getSamples() const
Get array of samples.
short int getCellID() const
Get strip ID.
bool isUStrip() const
Get strip direction.
float getFADCTime() const
Get digit FADCTime estimate.
Specific implementation of SensorInfo for SVD Sensors which provides additional sensor specific infor...
Definition: SensorInfo.h:25
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
std::string m_relPXDClusterDigitName
PXDClustersToPXDDigits RelationArray name.
std::string m_storePXDClustersName
PXDClusters StoreArray name.
std::string m_relSVDClusterDigitName
SVDClustersToSVDDigits RelationArray name.
std::string m_storeSVDShaperDigitsName
SVDShaperDigits StoreArray name.
std::string m_storeSVDClustersName
SVDClusters StoreArray name.
std::string m_storePXDDigitsName
PXDDigits StoreArray name.
const SensorInfoBase & getSensorInfo(Belle2::VxdID id) const
Return a referecne to the SensorInfo of a given SensorID.
Definition: GeoCache.cc:67
baseType getLayerNumber() const
Get the layer id.
Definition: VxdID.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")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

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

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

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

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
finaloverridevirtual

Initialize.

Reimplemented from HistoModule.

Definition at line 236 of file VXDDQMExpressRecoModule.cc.

237{
238 // Register histograms (calls back defineHisto)
239 REG_HISTOGRAM
240
241 auto gTools = VXD::GeoCache::getInstance().getGeoTools();
242 if (gTools->getNumberOfLayers() != 0) {
243 //Register collections
248 RelationArray relPXDClusterDigits(storePXDClusters, storePXDDigits);
249 RelationArray relSVDClusterDigits(storeSVDClusters, storeSVDShaperDigits);
250 m_storePXDClustersName = storePXDClusters.getName();
251 m_relPXDClusterDigitName = relPXDClusterDigits.getName();
252 m_storeSVDClustersName = storeSVDClusters.getName();
253 m_relSVDClusterDigitName = relSVDClusterDigits.getName();
254
255 storePXDDigits.isRequired();
256 storeSVDShaperDigits.isRequired();
257
258 //Store names to speed up creation later
259 m_storePXDDigitsName = storePXDDigits.getName();
260 m_storeSVDShaperDigitsName = storeSVDShaperDigits.getName();
261 }
262}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

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

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

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

Set the name of the module.

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

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

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

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

◆ setType()

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

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

Member Data Documentation

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_CorrelationGranulation

float m_CorrelationGranulation = 1.0
private

set granulation of histogram plots, default is 1 deg (1 mm), min = 0.02, max = 5.0

Definition at line 53 of file VXDDQMExpressRecoModule.h.

◆ m_correlationsSP

TH2F** m_correlationsSP {nullptr}
private

Correlations and hit maps from space points.

Definition at line 78 of file VXDDQMExpressRecoModule.h.

◆ m_correlationsSP1DPhi

TH1F** m_correlationsSP1DPhi {nullptr}
private

Correlations and hit maps from space points - differencies in Phi.

Definition at line 80 of file VXDDQMExpressRecoModule.h.

◆ m_correlationsSP1DTheta

TH1F** m_correlationsSP1DTheta {nullptr}
private

Correlations and hit maps from space points - differencies in Theta.

Definition at line 82 of file VXDDQMExpressRecoModule.h.

◆ m_CutCorrelationSigPXD

float m_CutCorrelationSigPXD = 0
private

Cut threshold of PXD signal for accepting to correlations, default = 0 ADU.

Definition at line 69 of file VXDDQMExpressRecoModule.h.

◆ m_CutCorrelationSigUSVD

float m_CutCorrelationSigUSVD = 0
private

Cut threshold of SVD signal for accepting to correlations in u, default = 0 ADU.

Definition at line 71 of file VXDDQMExpressRecoModule.h.

◆ m_CutCorrelationSigVSVD

float m_CutCorrelationSigVSVD = 0
private

Cut threshold of SVD signal for accepting to correlations in v, default = 0 ADU.

Definition at line 73 of file VXDDQMExpressRecoModule.h.

◆ m_CutCorrelationTimeSVD

float m_CutCorrelationTimeSVD = 70
private

Cut threshold of SVD time window for accepting to correlations, default = 70 ns.

Definition at line 75 of file VXDDQMExpressRecoModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_histogramDirectoryName

std::string m_histogramDirectoryName
private

Name of the histogram directory in ROOT file.

Definition at line 46 of file VXDDQMExpressRecoModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 510 of file Module.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

◆ m_relPXDClusterDigitName

std::string m_relPXDClusterDigitName
private

PXDClustersToPXDDigits RelationArray name.

Definition at line 64 of file VXDDQMExpressRecoModule.h.

◆ m_relSVDClusterDigitName

std::string m_relSVDClusterDigitName
private

SVDClustersToSVDDigits RelationArray name.

Definition at line 66 of file VXDDQMExpressRecoModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_storePXDClustersName

std::string m_storePXDClustersName
private

PXDClusters StoreArray name.

Definition at line 60 of file VXDDQMExpressRecoModule.h.

◆ m_storePXDDigitsName

std::string m_storePXDDigitsName
private

PXDDigits StoreArray name.

Definition at line 56 of file VXDDQMExpressRecoModule.h.

◆ m_storeSVDClustersName

std::string m_storeSVDClustersName
private

SVDClusters StoreArray name.

Definition at line 62 of file VXDDQMExpressRecoModule.h.

◆ m_storeSVDShaperDigitsName

std::string m_storeSVDShaperDigitsName
private

SVDShaperDigits StoreArray name.

Definition at line 58 of file VXDDQMExpressRecoModule.h.

◆ m_SwapPXD

int m_SwapPXD = 0
private

flag <0,1> very special case for swap of u-v coordinates

Definition at line 51 of file VXDDQMExpressRecoModule.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_UseDigits

int m_UseDigits = 0
private

flag <0,1> for using digits only, no clusters will be required, default = 0

Definition at line 49 of file VXDDQMExpressRecoModule.h.


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