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

PXD DQM Module. More...

#include <PXDDQMExpressRecoModule.h>

Inheritance diagram for PXDDQMExpressRecoModule:
Collaboration diagram for PXDDQMExpressRecoModule:

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

 PXDDQMExpressRecoModule ()
 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_CutMinCharge
 cut for accepting filtered pixel
 
int m_CutMinClusterCharge
 cut for accepting filtered cluster, using cluster charge
 
int m_CutMinSeedCharge
 cut for accepting to filtered hitmap histogram, using cluster seed
 
int m_CutMaxClusterSize
 cut for accepting to filtered hitmap histogram, maximum cluster size
 
std::string m_histogramDirectoryName
 Name of the histogram directory in ROOT file.
 
std::string m_storePXDDigitsName
 PXDDigits StoreArray name.
 
std::string m_storePXDClustersName
 PXDClusters StoreArray name.
 
StoreArray< PXDDigitm_storePXDDigits
 Storearray for Digits

 
StoreArray< PXDClusterm_storePXDClusters
 Storearray for Cluster

 
TH1D * m_hitMapCounts = {}
 Hitmaps of Digits.
 
TH1D * m_hitMapFilterCounts = {}
 Hitmaps of filtered Digits.
 
TH1D * m_hitMapClCounts = {}
 Hitmaps of Clusters.
 
TH1D * m_hitMapClFilterCounts = {}
 Hitmaps of filtered Clusters.
 
TH1D * m_hitMapCountsChip = {}
 Hitmaps of digits on chips.
 
TH1D * m_hitMapClCountsChip = {}
 Hitmaps of clusters on chips.
 
std::vector< TH1D * > m_fired = {}
 Fired pixels per event.
 
std::vector< TH1D * > m_goodfired = {}
 Filtered fired pixels per event.
 
std::vector< TH1D * > m_clusters = {}
 Clusters per event.
 
std::vector< TH1D * > m_goodclusters = {}
 filtered Clusters per event
 
std::vector< TH1D * > m_clusterCharge = {}
 Start row distribution. More...
 
std::vector< TH1D * > m_pixelSignal = {}
 Charge of pixels.
 
std::vector< TH1D * > m_clusterSizeU = {}
 u cluster size
 
std::vector< TH1D * > m_clusterSizeV = {}
 v cluster size
 
std::vector< TH1D * > m_clusterSizeUV = {}
 Cluster size.
 
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 PXDDQMExpressRecoModule.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.

Reimplemented from HistoModule.

Definition at line 65 of file PXDDQMExpressRecoModule.cc.

66 {
67  auto gTools = VXD::GeoCache::getInstance().getGeoTools();
68  if (gTools->getNumberOfLayers() == 0) {
69  B2FATAL("Missing geometry for VXD, check steering file.");
70  }
71  if (gTools->getNumberOfPXDLayers() == 0) {
72  B2WARNING("Missing geometry for PXD, PXD-DQM is skipped.");
73  return;
74  }
75 
76  // Create a separate histogram directories and cd into it.
77  TDirectory* oldDir = gDirectory;
78  if (m_histogramDirectoryName != "") {
79  oldDir->mkdir(m_histogramDirectoryName.c_str());// do not use return value with ->cd(), its ZERO if dir already exists
80  oldDir->cd(m_histogramDirectoryName.c_str());
81  }
82 
83  // basic constants presets:
84  int nPXDSensors = gTools->getNumberOfPXDSensors();
85  int nPXDChips = gTools->getTotalPXDChips();
86 
87  // Create basic histograms:
88  m_hitMapCounts = new TH1D("DQMER_PXD_PixelHitmapCounts", "PXD Integrated number of fired pixels per sensor",
89  nPXDSensors, 0, nPXDSensors);
90  m_hitMapCounts->GetXaxis()->SetTitle("Sensor ID");
91  m_hitMapCounts->GetYaxis()->SetTitle("counts");
92 
93  m_hitMapFilterCounts = new TH1D("DQMER_PXD_PixelHitmapFilterCounts", "PXD Integrated number of filtered pixels per sensor",
94  nPXDSensors, 0, nPXDSensors);
95  m_hitMapFilterCounts->GetXaxis()->SetTitle("Sensor ID");
96  m_hitMapFilterCounts->GetYaxis()->SetTitle("counts");
97 
98  m_hitMapClCounts = new TH1D("DQMER_PXD_ClusterHitmapCounts", "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 
103  m_hitMapClFilterCounts = new TH1D("DQMER_PXD_ClusterHitmapFilterCounts", "PXD Integrated number of filtered clusters per sensor",
104  nPXDSensors, 0, nPXDSensors);
105  m_hitMapClFilterCounts->GetXaxis()->SetTitle("Sensor ID");
106  m_hitMapClFilterCounts->GetYaxis()->SetTitle("counts");
107 
108  // basic counters per chip:
109  m_hitMapCountsChip = new TH1D("DQMER_PXD_PixelHitmapCountsChip", "PXD Integrated number of fired pixels per chip",
110  nPXDChips, 0, nPXDChips);
111  m_hitMapCountsChip->GetXaxis()->SetTitle("Chip ID");
112  m_hitMapCountsChip->GetYaxis()->SetTitle("counts");
113  m_hitMapClCountsChip = new TH1D("DQMER_PXD_ClusterHitmapCountsChip", "PXD Integrated number of clusters per chip",
114  nPXDChips, 0, nPXDChips);
115  m_hitMapClCountsChip->GetXaxis()->SetTitle("Chip ID");
116  m_hitMapClCountsChip->GetYaxis()->SetTitle("counts");
117  for (int i = 0; i < nPXDChips; i++) {
118  VxdID id = gTools->getChipIDFromPXDIndex(i);
119  int iLayer = id.getLayerNumber();
120  int iLadder = id.getLadderNumber();
121  int iSensor = id.getSensorNumber();
122  int iChip = gTools->getPXDChipNumber(id);
123  int IsU = gTools->isPXDSideU(id);
124  TString AxisTicks = Form("%i_%i_%i_u%iDCD", iLayer, iLadder, iSensor, iChip);
125  if (!IsU)
126  AxisTicks = Form("%i_%i_%i_v%iSWB", iLayer, iLadder, iSensor, iChip);
127  m_hitMapCountsChip->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
128  m_hitMapClCountsChip->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
129  }
130 
131  for (int i = 0; i < nPXDSensors; i++) {
132  VxdID id = gTools->getSensorIDFromPXDIndex(i);
133  int iLayer = id.getLayerNumber();
134  int iLadder = id.getLadderNumber();
135  int iSensor = id.getSensorNumber();
136  TString AxisTicks = Form("%i_%i_%i", iLayer, iLadder, iSensor);
137  m_hitMapCounts->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
138  m_hitMapClCounts->GetXaxis()->SetBinLabel(i + 1, AxisTicks.Data());
139  }
140 
141  m_fired.resize(nPXDSensors);
142  m_goodfired.resize(nPXDSensors);
143  m_clusters.resize(nPXDSensors);
144  m_goodclusters.resize(nPXDSensors);
145  // FIXME: startrow histos are for experts not shifters
146  //m_startRow.resize(nPXDSensors);
147  //m_chargStartRow.resize(nPXDSensors);
148  //m_startRowCount.resize(nPXDSensors);
149  m_clusterCharge.resize(nPXDSensors);
150  m_pixelSignal.resize(nPXDSensors);
151  m_clusterSizeU.resize(nPXDSensors);
152  m_clusterSizeV.resize(nPXDSensors);
153  m_clusterSizeUV.resize(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("DQMER_PXD_%1%_Fired") % sensorDescr);
166  string title = str(format("PXD Sensor %1% Fired pixels") % sensorDescr);
167  m_fired[i] = new TH1D(name.c_str(), title.c_str(), 200, 0, 200);
168  m_fired[i]->SetCanExtend(TH1::kAllAxes);
169  m_fired[i]->GetXaxis()->SetTitle("# of fired pixels");
170  m_fired[i]->GetYaxis()->SetTitle("counts");
171  //----------------------------------------------------------------
172  // Number of good fired pixels per frame
173  //----------------------------------------------------------------
174  name = str(format("DQMER_PXD_%1%_GoodFired") % sensorDescr);
175  title = str(format("PXD Sensor %1% Good pixels") % sensorDescr);
176  m_goodfired[i] = new TH1D(name.c_str(), title.c_str(), 200, 0, 200);
177  m_goodfired[i]->SetCanExtend(TH1::kAllAxes);
178  m_goodfired[i]->GetXaxis()->SetTitle("# of fired pixels");
179  m_goodfired[i]->GetYaxis()->SetTitle("counts");
180  //----------------------------------------------------------------
181  // Number of clusters per frame
182  //----------------------------------------------------------------
183  name = str(format("DQMER_PXD_%1%_Clusters") % sensorDescr);
184  title = str(format("PXD Sensor %1% Clusters") % sensorDescr);
185  m_clusters[i] = new TH1D(name.c_str(), title.c_str(), 200, 0, 200);
186  m_clusters[i]->SetCanExtend(TH1::kAllAxes);
187  m_clusters[i]->GetXaxis()->SetTitle("# of clusters");
188  m_clusters[i]->GetYaxis()->SetTitle("counts");
189  //----------------------------------------------------------------
190  // Number of good clusters per frame
191  //----------------------------------------------------------------
192  name = str(format("DQMER_PXD_%1%_GoodClusters") % sensorDescr);
193  title = str(format("PXD Sensor %1% Good clusters") % sensorDescr);
194  m_goodclusters[i] = new TH1D(name.c_str(), title.c_str(), 200, 0, 200);
195  m_goodclusters[i]->SetCanExtend(TH1::kAllAxes);
196  m_goodclusters[i]->GetXaxis()->SetTitle("# of clusters");
197  m_goodclusters[i]->GetYaxis()->SetTitle("counts");
198  //----------------------------------------------------------------
199  // Start row distribution
200  // FIXME: expert level, remove here at some point
201  //----------------------------------------------------------------
202  //name = str(format("DQMER_PXD_%1%_StartRow") % sensorDescr);
203  //title = str(format("PXD Sensor %1% Start row distribution") % sensorDescr);
204 
205  //int nPixels;/** Number of pixels on PXD v direction */
206  //nPixels = SensorInfo.getVCells();
207  //m_startRow[i] = new TH1D(name.c_str(), title.c_str(), nPixels / 4, 0.0, nPixels);
208  //m_startRow[i]->GetXaxis()->SetTitle("start row [pitch units]");
209  //m_startRow[i]->GetYaxis()->SetTitle("count");
210  //----------------------------------------------------------------
211  // Cluster seed charge by distance from the start row
212  //----------------------------------------------------------------
213  //name = str(format("DQMER_PXD_%1%_AverageSeedByStartRow") % sensorDescr);
214  //title = str(format("PXD Sensor %1% Average seed charge by distance from the start row") % sensorDescr);
215  //m_chargStartRow[i] = new TH1D(name.c_str(), title.c_str(), nPixels / 4, 0.0, nPixels);
216  //m_chargStartRow[i]->GetXaxis()->SetTitle("distance from the start row [pitch units]");
217  //m_chargStartRow[i]->GetYaxis()->SetTitle("average seed [ADU]");
218  //name = str(format("DQMER_PXD_%1%_SeedCountsByStartRow") % sensorDescr);
219  //title = str(format("PXD Sensor %1% Seed charge count by distance from the start row") % sensorDescr);
220  //m_startRowCount[i] = new TH1D(name.c_str(), title.c_str(), nPixels / 4, 0.0, nPixels);
221  //m_startRowCount[i]->GetXaxis()->SetTitle("distance from the start row [pitch units]");
222  //m_startRowCount[i]->GetYaxis()->SetTitle("count");
223  //----------------------------------------------------------------
224  // Cluster Charge
225  //----------------------------------------------------------------
226  name = str(format("DQMER_PXD_%1%_ClusterCharge") % sensorDescr);
227  title = str(format("PXD Sensor %1% Cluster Charge") % sensorDescr);
228  m_clusterCharge[i] = new TH1D(name.c_str(), title.c_str(), 256, 0, 256);
229  m_clusterCharge[i]->GetXaxis()->SetTitle("charge of clusters [ADU]");
230  m_clusterCharge[i]->GetYaxis()->SetTitle("counts");
231  //----------------------------------------------------------------
232  // Pixel Signal
233  //----------------------------------------------------------------
234  name = str(format("DQMER_PXD_%1%_PixelSignal") % sensorDescr);
235  title = str(format("PXD Sensor %1% Pixel Signal") % sensorDescr);
236  m_pixelSignal[i] = new TH1D(name.c_str(), title.c_str(), 256, 0, 256);
237  m_pixelSignal[i]->GetXaxis()->SetTitle("signal of pixels [ADU]");
238  m_pixelSignal[i]->GetYaxis()->SetTitle("counts");
239  //----------------------------------------------------------------
240  // Cluster Size in U
241  //----------------------------------------------------------------
242  name = str(format("DQMER_PXD_%1%_ClusterSizeU") % sensorDescr);
243  title = str(format("PXD Sensor %1% Cluster Size U") % sensorDescr);
244  m_clusterSizeU[i] = new TH1D(name.c_str(), title.c_str(), 10, 0, 10);
245  m_clusterSizeU[i]->GetXaxis()->SetTitle("size of u clusters");
246  m_clusterSizeU[i]->GetYaxis()->SetTitle("counts");
247  //----------------------------------------------------------------
248  // Cluster Size in V
249  //----------------------------------------------------------------
250  name = str(format("DQMER_PXD_%1%_ClusterSizeV") % sensorDescr);
251  title = str(format("PXD Sensor %1% Cluster Size V") % sensorDescr);
252  m_clusterSizeV[i] = new TH1D(name.c_str(), title.c_str(), 10, 0, 10);
253  m_clusterSizeV[i]->GetXaxis()->SetTitle("size of v clusters");
254  m_clusterSizeV[i]->GetYaxis()->SetTitle("counts");
255  //----------------------------------------------------------------
256  // Cluster Size in U+V
257  //----------------------------------------------------------------
258  name = str(format("DQMER_PXD_%1%_ClusterSizeUV") % sensorDescr);
259  title = str(format("PXD Sensor %1% Cluster Size U+V") % sensorDescr);
260  m_clusterSizeUV[i] = new TH1D(name.c_str(), title.c_str(), 10, 0, 10);
261  m_clusterSizeUV[i]->GetXaxis()->SetTitle("size of u+v clusters");
262  m_clusterSizeUV[i]->GetYaxis()->SetTitle("counts");
263  }
264 
265  oldDir->cd();
266 }

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

Member Data Documentation

◆ m_clusterCharge

std::vector<TH1D*> m_clusterCharge = {}
private

Start row distribution.

Cluster seed charge by distance from the start row counter for Cluster seed charge by distance from the start row Charge of clusters

Definition at line 113 of file PXDDQMExpressRecoModule.h.


The documentation for this class was generated from the following files:
Belle2::PXDDQMExpressRecoModule::m_pixelSignal
std::vector< TH1D * > m_pixelSignal
Charge of pixels.
Definition: PXDDQMExpressRecoModule.h:115
Belle2::PXDDQMExpressRecoModule::m_hitMapClCounts
TH1D * m_hitMapClCounts
Hitmaps of Clusters.
Definition: PXDDQMExpressRecoModule.h:89
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:43
Belle2::PXDDQMExpressRecoModule::m_hitMapClFilterCounts
TH1D * m_hitMapClFilterCounts
Hitmaps of filtered Clusters.
Definition: PXDDQMExpressRecoModule.h:91
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::PXDDQMExpressRecoModule::m_clusterSizeU
std::vector< TH1D * > m_clusterSizeU
u cluster size
Definition: PXDDQMExpressRecoModule.h:117
Belle2::PXDDQMExpressRecoModule::m_clusterCharge
std::vector< TH1D * > m_clusterCharge
Start row distribution.
Definition: PXDDQMExpressRecoModule.h:113
Belle2::PXDDQMExpressRecoModule::m_goodfired
std::vector< TH1D * > m_goodfired
Filtered fired pixels per event.
Definition: PXDDQMExpressRecoModule.h:100
Belle2::PXD::SensorInfo
Specific implementation of SensorInfo for PXD Sensors which provides additional pixel specific inform...
Definition: SensorInfo.h:34
Belle2::VXD::GeoCache::getInstance
static GeoCache & getInstance()
Return a reference to the singleton instance.
Definition: GeoCache.cc:215
Belle2::PXDDQMExpressRecoModule::m_histogramDirectoryName
std::string m_histogramDirectoryName
Name of the histogram directory in ROOT file.
Definition: PXDDQMExpressRecoModule.h:72
Belle2::PXDDQMExpressRecoModule::m_clusterSizeUV
std::vector< TH1D * > m_clusterSizeUV
Cluster size.
Definition: PXDDQMExpressRecoModule.h:121
Belle2::VXD::GeoCache::getGeoTools
const GeoTools * getGeoTools()
Return a raw pointer to a GeoTools object.
Definition: GeoCache.h:149
Belle2::PXDDQMExpressRecoModule::m_hitMapCounts
TH1D * m_hitMapCounts
Hitmaps of Digits.
Definition: PXDDQMExpressRecoModule.h:85
Belle2::PXDDQMExpressRecoModule::m_clusterSizeV
std::vector< TH1D * > m_clusterSizeV
v cluster size
Definition: PXDDQMExpressRecoModule.h:119
Belle2::PXDDQMExpressRecoModule::m_hitMapFilterCounts
TH1D * m_hitMapFilterCounts
Hitmaps of filtered Digits.
Definition: PXDDQMExpressRecoModule.h:87
Belle2::PXDDQMExpressRecoModule::m_clusters
std::vector< TH1D * > m_clusters
Clusters per event.
Definition: PXDDQMExpressRecoModule.h:102
Belle2::PXDDQMExpressRecoModule::m_goodclusters
std::vector< TH1D * > m_goodclusters
filtered Clusters per event
Definition: PXDDQMExpressRecoModule.h:104
Belle2::VxdID::getLayerNumber
baseType getLayerNumber() const
Get the layer id.
Definition: VxdID.h:106
Belle2::PXDDQMExpressRecoModule::m_fired
std::vector< TH1D * > m_fired
Fired pixels per event.
Definition: PXDDQMExpressRecoModule.h:98
Belle2::PXDDQMExpressRecoModule::m_hitMapCountsChip
TH1D * m_hitMapCountsChip
Hitmaps of digits on chips.
Definition: PXDDQMExpressRecoModule.h:94
Belle2::PXDDQMExpressRecoModule::m_hitMapClCountsChip
TH1D * m_hitMapClCountsChip
Hitmaps of clusters on chips.
Definition: PXDDQMExpressRecoModule.h:96