Belle II Software  release-05-01-25
PXDDQMClustersModule Class Reference

PXD DQM Module. More...

#include <PXDDQMClustersModule.h>

Inheritance diagram for PXDDQMClustersModule:
Collaboration diagram for PXDDQMClustersModule:

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

 PXDDQMClustersModule ()
 Constructor.
 
virtual void endRun () override
 Function to process end_run record.
 
virtual void terminate () override
 Function to terminate module.
 
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.
 

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

void initialize () override final
 Module functions.
 
void beginRun () override final
 Function to process begin_run record.
 
void event () override final
 Function to process event record.
 
void defineHisto () override final
 Histogram definitions such as TH1(), TH2(), TNtuple(), TTree().... More...
 
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_CutPXDCharge = 0
 cut for accepting to hitmap histogram, using pixels only, default = 0
 
std::string m_histogramDirectoryName
 Name of the histogram directory in ROOT file.
 
StoreObjPtr< PXDDAQStatusm_storeDAQEvtStats
 Input array for DAQ Status.
 
std::string m_storePXDDigitsName
 PXDDigits StoreArray name.
 
std::string m_storePXDClustersName
 PXDClusters StoreArray name.
 
std::string m_relPXDClusterDigitName
 PXDClustersToPXDDigits RelationArray name.
 
TH1D * m_hitMapCounts = {}
 Hitmaps of Digits.
 
TH1D * m_hitMapClCounts = {}
 Hitmaps of Clusters.
 
TH1D * m_hitMapCountsChip = {}
 Hitmaps of digits on chips.
 
TH1D * m_hitMapClCountsChip = {}
 Hitmaps of clusters on chips.
 
TH1F ** m_fired = {}
 Fired pixels per event.
 
TH1F ** m_clusters = {}
 Clusters per event.
 
TH1F ** m_startRow = {}
 Start row distribution.
 
TH1F ** m_chargStartRow = {}
 Cluster seed charge by distance from the start row.
 
TH1F ** m_startRowCount = {}
 counter for Cluster seed charge by distance from the start row
 
TH1F ** m_clusterCharge = {}
 Charge of clusters.
 
TH1F ** m_clusterEnergy = {}
 Deposited energy of clusters.
 
TH1F ** m_pixelSignal = {}
 Charge of pixels.
 
TH1F ** m_clusterSizeU = {}
 u cluster size
 
TH1F ** m_clusterSizeV = {}
 v cluster size
 
TH1F ** m_clusterSizeUV = {}
 Cluster size.
 
TH1F ** m_hitMapU = {}
 Hitmaps pixels for u.
 
TH1F ** m_hitMapV = {}
 Hitmaps pixels for v.
 
TH2F ** m_hitMap = {}
 Hitmaps pixels.
 
TH1F ** m_hitMapUCl = {}
 Hitmaps clusters for u.
 
TH1F ** m_hitMapVCl = {}
 Hitmaps clusters for v.
 
TH2F ** m_hitMapCl = {}
 Hitmaps clusters.
 
TH1F ** m_seed = {}
 Seed.
 
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

PXD DQM Module.

Definition at line 42 of file PXDDQMClustersModule.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

◆ 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.

◆ defineHisto()

void defineHisto ( )
finaloverrideprivatevirtual

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

are supposed to be placed in this function.

Number of pixels on PXD v direction

Reimplemented from HistoModule.

Definition at line 71 of file PXDDQMClustersModule.cc.

72 {
73  auto gTools = VXD::GeoCache::getInstance().getGeoTools();
74  if (gTools->getNumberOfLayers() == 0) {
75  B2FATAL("Missing geometry for VXD, check steering file.");
76  }
77  if (gTools->getNumberOfPXDLayers() == 0) {
78  B2WARNING("Missing geometry for PXD, PXD-DQM is skiped.");
79  return;
80  }
81 
82  // Create a separate histogram directories and cd into it.
83  TDirectory* oldDir = gDirectory;
84  if (m_histogramDirectoryName != "") {
85  oldDir->mkdir(m_histogramDirectoryName.c_str());// do not use return value with ->cd(), its ZERO if dir already exists
86  oldDir->cd(m_histogramDirectoryName.c_str());
87  }
88 
89  // basic constants presets:
90  int nPXDSensors = gTools->getNumberOfPXDSensors();
91  int nPXDChips = gTools->getTotalPXDChips();
92 
93  // Create basic histograms:
94  m_hitMapCounts = new TH1D("DQM_PXD_PixelHitmapCounts", "DQM PXD Integrated number of fired pixels per sensor",
95  nPXDSensors, 0, nPXDSensors);
96  m_hitMapCounts->GetXaxis()->SetTitle("Sensor ID");
97  m_hitMapCounts->GetYaxis()->SetTitle("counts");
98  m_hitMapClCounts = new TH1D("DQM_PXD_ClusterHitmapCounts", "DQM PXD Integrated number of clusters per sensor",
99  nPXDSensors, 0, nPXDSensors);
100  m_hitMapClCounts->GetXaxis()->SetTitle("Sensor ID");
101  m_hitMapClCounts->GetYaxis()->SetTitle("counts");
102  // basic counters per chip:
103  m_hitMapCountsChip = new TH1D("DQM_PXD_PixelHitmapCountsChip", "DQM PXD Integrated number of fired pixels per chip",
104  nPXDChips, 0, nPXDChips);
105  m_hitMapCountsChip->GetXaxis()->SetTitle("Sensor ID");
106  m_hitMapCountsChip->GetYaxis()->SetTitle("counts");
107  m_hitMapClCountsChip = new TH1D("DQM_PXD_ClusterHitmapCountsChip", "DQM PXD Integrated number of clusters per chip",
108  nPXDChips, 0, nPXDChips);
109  m_hitMapClCountsChip->GetXaxis()->SetTitle("Sensor ID");
110  m_hitMapClCountsChip->GetYaxis()->SetTitle("counts");
111  for (int i = 0; i < nPXDChips; i++) {
112  VxdID id = gTools->getChipIDFromPXDIndex(i);
113  int iLayer = id.getLayerNumber();
114  int iLadder = id.getLadderNumber();
115  int iSensor = id.getSensorNumber();
116  int iChip = gTools->getPXDChipNumber(id);
117  int IsU = gTools->isPXDSideU(id);
118  TString AxisTicks = Form("%i_%i_%i_u%iDCD", iLayer, iLadder, iSensor, iChip);
119  if (!IsU)
120  AxisTicks = Form("%i_%i_%i_v%iSWB", iLayer, iLadder, iSensor, iChip);
121  m_hitMapCountsChip->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
122  m_hitMapClCountsChip->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
123  }
124 
125  for (int i = 0; i < nPXDSensors; i++) {
126  VxdID id = gTools->getSensorIDFromPXDIndex(i);
127  int iLayer = id.getLayerNumber();
128  int iLadder = id.getLadderNumber();
129  int iSensor = id.getSensorNumber();
130  TString AxisTicks = Form("%i_%i_%i", iLayer, iLadder, iSensor);
131  m_hitMapCounts->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
132  m_hitMapClCounts->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
133  }
134 
135  m_fired = new TH1F*[nPXDSensors];
136  m_clusters = new TH1F*[nPXDSensors];
137  m_startRow = new TH1F*[nPXDSensors];
138  m_chargStartRow = new TH1F*[nPXDSensors];
139  m_startRowCount = new TH1F*[nPXDSensors];
140  m_clusterCharge = new TH1F*[nPXDSensors];
141  m_clusterEnergy = new TH1F*[nPXDSensors];
142  m_pixelSignal = new TH1F*[nPXDSensors];
143  m_clusterSizeU = new TH1F*[nPXDSensors];
144  m_clusterSizeV = new TH1F*[nPXDSensors];
145  m_clusterSizeUV = new TH1F*[nPXDSensors];
146 
147  m_hitMapU = new TH1F*[nPXDSensors];
148  m_hitMapV = new TH1F*[nPXDSensors];
149  m_hitMap = new TH2F*[nPXDSensors];
150  m_hitMapUCl = new TH1F*[nPXDSensors];
151  m_hitMapVCl = new TH1F*[nPXDSensors];
152  m_hitMapCl = new TH2F*[nPXDSensors];
153  m_seed = new TH1F*[nPXDSensors];
154  for (int i = 0; i < nPXDSensors; i++) {
155  VxdID id = gTools->getSensorIDFromPXDIndex(i);
156  int iLayer = id.getLayerNumber();
157  int iLadder = id.getLadderNumber();
158  int iSensor = id.getSensorNumber();
159  VxdID sensorID(iLayer, iLadder, iSensor);
160  PXD::SensorInfo SensorInfo = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::get(sensorID));
161  string sensorDescr = str(format("%1%_%2%_%3%") % iLayer % iLadder % iSensor);
162  //----------------------------------------------------------------
163  // Number of fired pixels per frame
164  //----------------------------------------------------------------
165  string name = str(format("DQM_PXD_%1%_Fired") % sensorDescr);
166  string title = str(format("DQM PXD Sensor %1% Fired pixels") % sensorDescr);
167  m_fired[i] = nullptr;
168  m_fired[i] = new TH1F(name.c_str(), title.c_str(), 50, 0, 50);
169  m_fired[i]->GetXaxis()->SetTitle("# of fired pixels");
170  m_fired[i]->GetYaxis()->SetTitle("counts");
171  //----------------------------------------------------------------
172  // Number of clusters per frame
173  //----------------------------------------------------------------
174  name = str(format("DQM_PXD_%1%_Clusters") % sensorDescr);
175  title = str(format("DQM PXD Sensor %1% Number of clusters") % sensorDescr);
176  m_clusters[i] = nullptr;
177  m_clusters[i] = new TH1F(name.c_str(), title.c_str(), 20, 0, 20);
178  m_clusters[i]->GetXaxis()->SetTitle("# of clusters");
179  m_clusters[i]->GetYaxis()->SetTitle("counts");
180  //----------------------------------------------------------------
181  // Start row distribution
182  //----------------------------------------------------------------
183  name = str(format("DQM_PXD_%1%_StartRow") % sensorDescr);
184  title = str(format("DQM PXD Sensor %1% Start row distribution") % sensorDescr);
185 
186  int nPixels;
187  nPixels = SensorInfo.getVCells();
188  m_startRow[i] = new TH1F(name.c_str(), title.c_str(), nPixels / 4, 0.0, nPixels);
189  m_startRow[i]->GetXaxis()->SetTitle("start row [pitch units]");
190  m_startRow[i]->GetYaxis()->SetTitle("count");
191  //----------------------------------------------------------------
192  // Cluster seed charge by distance from the start row
193  //----------------------------------------------------------------
194  name = str(format("DQM_PXD_%1%_AverageSeedByStartRow") % sensorDescr);
195  title = str(format("DQM PXD Sensor %1% Average seed charge by distance from the start row") % sensorDescr);
196  m_chargStartRow[i] = new TH1F(name.c_str(), title.c_str(), nPixels / 4, 0.0, nPixels);
197  m_chargStartRow[i]->GetXaxis()->SetTitle("distance from the start row [pitch units]");
198  m_chargStartRow[i]->GetYaxis()->SetTitle("average seed [ADU]");
199  name = str(format("DQM_PXD_%1%_SeedCountsByStartRow") % sensorDescr);
200  title = str(format("DQM PXD Sensor %1% Seed charge count by distance from the start row") % sensorDescr);
201  m_startRowCount[i] = new TH1F(name.c_str(), title.c_str(), nPixels / 4, 0.0, nPixels);
202  m_startRowCount[i]->GetXaxis()->SetTitle("distance from the start row [pitch units]");
203  m_startRowCount[i]->GetYaxis()->SetTitle("count");
204  //----------------------------------------------------------------
205  // Cluster Charge
206  //----------------------------------------------------------------
207  name = str(format("DQM_PXD_%1%_ClusterCharge") % sensorDescr);
208  title = str(format("DQM PXD Sensor %1% Cluster Charge") % sensorDescr);
209  m_clusterCharge[i] = new TH1F(name.c_str(), title.c_str(), 256, 0, 256);
210  m_clusterCharge[i]->GetXaxis()->SetTitle("charge of clusters [ADU]");
211  m_clusterCharge[i]->GetYaxis()->SetTitle("counts");
212  //----------------------------------------------------------------
213  // Cluster Energy
214  //----------------------------------------------------------------
215  name = str(format("DQM_PXD_%1%_ClusterEnergy") % sensorDescr);
216  title = str(format("DQM PXD Sensor %1% Cluster Energy") % sensorDescr);
217  m_clusterEnergy[i] = new TH1F(name.c_str(), title.c_str(), 100, 0, 50);
218  m_clusterEnergy[i]->GetXaxis()->SetTitle("energy of clusters [keV]");
219  m_clusterEnergy[i]->GetYaxis()->SetTitle("counts");
220  //----------------------------------------------------------------
221  // Pixel Signal
222  //----------------------------------------------------------------
223  name = str(format("DQM_PXD_%1%_PixelSignal") % sensorDescr);
224  title = str(format("DQM PXD Sensor %1% Pixel Signal") % sensorDescr);
225  m_pixelSignal[i] = new TH1F(name.c_str(), title.c_str(), 256, 0, 256);
226  m_pixelSignal[i]->GetXaxis()->SetTitle("signal of pixels [ADU]");
227  m_pixelSignal[i]->GetYaxis()->SetTitle("counts");
228  //----------------------------------------------------------------
229  // Cluster Size in U
230  //----------------------------------------------------------------
231  name = str(format("DQM_PXD_%1%_ClusterSizeU") % sensorDescr);
232  title = str(format("DQM PXD Sensor %1% Cluster Size U") % sensorDescr);
233  m_clusterSizeU[i] = new TH1F(name.c_str(), title.c_str(), 10, 0, 10);
234  m_clusterSizeU[i]->GetXaxis()->SetTitle("size of u clusters");
235  m_clusterSizeU[i]->GetYaxis()->SetTitle("counts");
236  //----------------------------------------------------------------
237  // Cluster Size in V
238  //----------------------------------------------------------------
239  name = str(format("DQM_PXD_%1%_ClusterSizeV") % sensorDescr);
240  title = str(format("DQM PXD Sensor %1% Cluster Size V") % sensorDescr);
241  m_clusterSizeV[i] = new TH1F(name.c_str(), title.c_str(), 10, 0, 10);
242  m_clusterSizeV[i]->GetXaxis()->SetTitle("size of v clusters");
243  m_clusterSizeV[i]->GetYaxis()->SetTitle("counts");
244  //----------------------------------------------------------------
245  // Cluster Size in U+V
246  //----------------------------------------------------------------
247  name = str(format("DQM_PXD_%1%_ClusterSizeUV") % sensorDescr);
248  title = str(format("DQM PXD Sensor %1% Cluster Size U+V") % sensorDescr);
249  m_clusterSizeUV[i] = new TH1F(name.c_str(), title.c_str(), 10, 0, 10);
250  m_clusterSizeUV[i]->GetXaxis()->SetTitle("size of u+v clusters");
251  m_clusterSizeUV[i]->GetYaxis()->SetTitle("counts");
252 
253  //----------------------------------------------------------------
254  // Hitmaps: Number of pixels by coordinate
255  //----------------------------------------------------------------
256  // Hitmaps in U
257  name = str(format("PXD_%1%_PixelHitmapU") % sensorDescr);
258  title = str(format("PXD Sensor %1% Pixel Hitmap in U") % sensorDescr);
259  nPixels = SensorInfo.getUCells();
260  m_hitMapU[i] = new TH1F(name.c_str(), title.c_str(), nPixels, 0, nPixels);
261  m_hitMapU[i]->GetXaxis()->SetTitle("u position [pitch units]");
262  m_hitMapU[i]->GetYaxis()->SetTitle("hits");
263  // Hitmaps in V
264  name = str(format("PXD_%1%_PixelHitmapV") % sensorDescr);
265  title = str(format("PXD Sensor %1% Pixel Hitmap in V") % sensorDescr);
266  nPixels = SensorInfo.getVCells();
267  m_hitMapV[i] = new TH1F(name.c_str(), title.c_str(), nPixels, 0, nPixels);
268  m_hitMapV[i]->GetXaxis()->SetTitle("v position [pitch units]");
269  m_hitMapV[i]->GetYaxis()->SetTitle("hits");
270  // Hitmaps in UV
271  name = str(format("PXD_%1%_PixelHitmap") % sensorDescr);
272  title = str(format("PXD Sensor %1% Pixel Hitmap") % sensorDescr);
273  nPixels = SensorInfo.getUCells();
274  int nPixelsV = SensorInfo.getVCells();
275  m_hitMap[i] = new TH2F(name.c_str(), title.c_str(), nPixels, 0, nPixels, nPixelsV, 0, nPixelsV);
276  m_hitMap[i]->GetXaxis()->SetTitle("u position [pitch units]");
277  m_hitMap[i]->GetYaxis()->SetTitle("v position [pitch units]");
278  m_hitMap[i]->GetZaxis()->SetTitle("hits");
279 
280  //----------------------------------------------------------------
281  // Hitmaps: Number of clusters by coordinate
282  //----------------------------------------------------------------
283  // Hitmaps in U
284  name = str(format("PXD_%1%_HitmapClstU") % sensorDescr);
285  title = str(format("PXD Sensor %1% Hitmap Clusters in U") % sensorDescr);
286  nPixels = SensorInfo.getUCells();
287  m_hitMapUCl[i] = new TH1F(name.c_str(), title.c_str(), nPixels, 0, nPixels);
288  m_hitMapUCl[i]->GetXaxis()->SetTitle("u position [pitch units]");
289  m_hitMapUCl[i]->GetYaxis()->SetTitle("hits");
290  // Hitmaps in V
291  name = str(format("PXD_%1%_HitmapClstV") % sensorDescr);
292  title = str(format("PXD Sensor %1% Hitmap Clusters in V") % sensorDescr);
293  nPixels = SensorInfo.getVCells();
294  m_hitMapVCl[i] = new TH1F(name.c_str(), title.c_str(), nPixels, 0, nPixels);
295  m_hitMapVCl[i]->GetXaxis()->SetTitle("v position [pitch units]");
296  m_hitMapVCl[i]->GetYaxis()->SetTitle("hits");
297  // Hitmaps in UV
298  name = str(format("PXD_%1%_HitmapClst") % sensorDescr);
299  title = str(format("PXD Sensor %1% Hitmap Clusters") % sensorDescr);
300  nPixels = SensorInfo.getUCells();
301  nPixelsV = SensorInfo.getVCells();
302  m_hitMapCl[i] = new TH2F(name.c_str(), title.c_str(), nPixels, 0, nPixels, nPixelsV, 0, nPixelsV);
303  m_hitMapCl[i]->GetXaxis()->SetTitle("u position [pitch units]");
304  m_hitMapCl[i]->GetYaxis()->SetTitle("v position [pitch units]");
305  m_hitMapCl[i]->GetZaxis()->SetTitle("hits");
306 
307  //----------------------------------------------------------------
308  // Cluster seed charge distribution
309  //----------------------------------------------------------------
310  name = str(format("PXD_%1%_Seed") % sensorDescr);
311  title = str(format("PXD Sensor %1% Seed charge") % sensorDescr);
312  m_seed[i] = new TH1F(name.c_str(), title.c_str(), 256, 0, 256);
313  m_seed[i]->GetXaxis()->SetTitle("seed charge of clusters [ADU]");
314  m_seed[i]->GetYaxis()->SetTitle("count");
315 
316  }
317  oldDir->cd();
318 }

◆ 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.

◆ 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.

◆ 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.


The documentation for this class was generated from the following files:
Belle2::VXD::SensorInfoBase::getUCells
int getUCells() const
Return number of pixel/strips in u direction.
Definition: SensorInfoBase.h:223
Belle2::PXDDQMClustersModule::m_startRow
TH1F ** m_startRow
Start row distribution.
Definition: PXDDQMClustersModule.h:92
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:43
Belle2::PXDDQMClustersModule::m_pixelSignal
TH1F ** m_pixelSignal
Charge of pixels.
Definition: PXDDQMClustersModule.h:102
Belle2::PXDDQMClustersModule::m_chargStartRow
TH1F ** m_chargStartRow
Cluster seed charge by distance from the start row.
Definition: PXDDQMClustersModule.h:94
Belle2::PXDDQMClustersModule::m_seed
TH1F ** m_seed
Seed.
Definition: PXDDQMClustersModule.h:123
Belle2::PXDDQMClustersModule::m_histogramDirectoryName
std::string m_histogramDirectoryName
Name of the histogram directory in ROOT file.
Definition: PXDDQMClustersModule.h:66
Belle2::VXD::GeoCache::get
static const SensorInfoBase & get(Belle2::VxdID id)
Return a reference to the SensorInfo of a given SensorID.
Definition: GeoCache.h:141
Belle2::PXDDQMClustersModule::m_hitMapUCl
TH1F ** m_hitMapUCl
Hitmaps clusters for u.
Definition: PXDDQMClustersModule.h:117
Belle2::PXDDQMClustersModule::m_clusterSizeU
TH1F ** m_clusterSizeU
u cluster size
Definition: PXDDQMClustersModule.h:104
Belle2::PXDDQMClustersModule::m_clusterCharge
TH1F ** m_clusterCharge
Charge of clusters.
Definition: PXDDQMClustersModule.h:98
Belle2::PXDDQMClustersModule::m_clusters
TH1F ** m_clusters
Clusters per event.
Definition: PXDDQMClustersModule.h:90
Belle2::PXDDQMClustersModule::m_hitMapCl
TH2F ** m_hitMapCl
Hitmaps clusters.
Definition: PXDDQMClustersModule.h:121
Belle2::PXDDQMClustersModule::m_clusterSizeUV
TH1F ** m_clusterSizeUV
Cluster size.
Definition: PXDDQMClustersModule.h:108
Belle2::PXDDQMClustersModule::m_hitMapClCounts
TH1D * m_hitMapClCounts
Hitmaps of Clusters.
Definition: PXDDQMClustersModule.h:82
Belle2::PXDDQMClustersModule::m_hitMapClCountsChip
TH1D * m_hitMapClCountsChip
Hitmaps of clusters on chips.
Definition: PXDDQMClustersModule.h:86
Belle2::PXD::SensorInfo
Specific implementation of SensorInfo for PXD Sensors which provides additional pixel specific inform...
Definition: SensorInfo.h:34
Belle2::PXDDQMClustersModule::m_clusterSizeV
TH1F ** m_clusterSizeV
v cluster size
Definition: PXDDQMClustersModule.h:106
Belle2::PXDDQMClustersModule::m_fired
TH1F ** m_fired
Fired pixels per event.
Definition: PXDDQMClustersModule.h:88
Belle2::VXD::GeoCache::getInstance
static GeoCache & getInstance()
Return a reference to the singleton instance.
Definition: GeoCache.cc:215
Belle2::VXD::SensorInfoBase::getVCells
int getVCells() const
Return number of pixel/strips in v direction.
Definition: SensorInfoBase.h:225
Belle2::VXD::GeoCache::getGeoTools
const GeoTools * getGeoTools()
Return a raw pointer to a GeoTools object.
Definition: GeoCache.h:149
Belle2::PXDDQMClustersModule::m_hitMapU
TH1F ** m_hitMapU
Hitmaps pixels for u.
Definition: PXDDQMClustersModule.h:111
Belle2::PXDDQMClustersModule::m_hitMap
TH2F ** m_hitMap
Hitmaps pixels.
Definition: PXDDQMClustersModule.h:115
Belle2::PXDDQMClustersModule::m_hitMapCounts
TH1D * m_hitMapCounts
Hitmaps of Digits.
Definition: PXDDQMClustersModule.h:80
Belle2::PXDDQMClustersModule::m_hitMapVCl
TH1F ** m_hitMapVCl
Hitmaps clusters for v.
Definition: PXDDQMClustersModule.h:119
Belle2::PXDDQMClustersModule::m_hitMapCountsChip
TH1D * m_hitMapCountsChip
Hitmaps of digits on chips.
Definition: PXDDQMClustersModule.h:84
Belle2::PXDDQMClustersModule::m_clusterEnergy
TH1F ** m_clusterEnergy
Deposited energy of clusters.
Definition: PXDDQMClustersModule.h:100
Belle2::VxdID::getLayerNumber
baseType getLayerNumber() const
Get the layer id.
Definition: VxdID.h:106
Belle2::PXDDQMClustersModule::m_hitMapV
TH1F ** m_hitMapV
Hitmaps pixels for v.
Definition: PXDDQMClustersModule.h:113
Belle2::PXDDQMClustersModule::m_startRowCount
TH1F ** m_startRowCount
counter for Cluster seed charge by distance from the start row
Definition: PXDDQMClustersModule.h:96