Belle II Software development
SVDROIDQMModule Class Reference

Creates basic DQM for ROI creation on ExpressReco
More...

#include <SVDROIDQMModule.h>

Inheritance diagram for SVDROIDQMModule:
HistoModule Module PathElement

Classes

struct  ROIHistoAccumulateAndFill
 struct: histograms to be filled once per event + filling function + accumulate function More...
 

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

 SVDROIDQMModule ()
 Constructor defining the parameters.
 
void initialize () override
 register histograms
 
void event () override
 fill per-event histograms
 
void endRun () override
 fill per-run histograms
 
virtual void beginRun () override
 Function to process begin_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 Types

typedef std::pair< TH1 *, std::function< void(TH1 *, const SVDIntercept *) > > InterHistoAndFill
 typedef: histograms to be filled once per intercept + filling function
 
typedef std::pair< TH1 *, std::function< void(TH1 *, const ROIid *) > > ROIHistoAndFill
 typedef: histograms to be filled once per roi + filling function
 

Private Member Functions

void createHistosDictionaries ()
 create the dictionary
 
void fillSensorROIHistos (const ROIid *roi)
 fill histograms per sensor, filled once per ROI
 
void fillSensorInterHistos (const SVDIntercept *inter)
 fill histograms per sensor, filled once per intercept
 
void defineHisto () override
 define histograms
 
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_SVDShaperDigitsName
 shaper digit list name
 
std::string m_SVDRecoDigitsName
 reco digit list name
 
std::string m_SVDClustersName
 cluster list name
 
StoreArray< ROIidm_ROIs
 ROis store array.
 
StoreArray< SVDInterceptm_Intercepts
 SVDIntercept Store Arrays.
 
StoreArray< SVDShaperDigitm_SVDShaperDigits
 shaper digit store array
 
StoreArray< SVDRecoDigitm_SVDRecoDigits
 reco digit store array
 
StoreArray< SVDClusterm_SVDClusters
 svd cluster store array
 
VXD::GeoCachem_geoCache = VXD::GeoCache::getInstance()
 the geo cache instance
 
std::string m_ROIsName
 Name of the ROIid StoreArray.
 
std::string m_InterceptsName
 Name of the SVDIntercept StoreArray.
 
TDirectory * m_InterDir
 intercepts directory in the root file
 
TDirectory * m_ROIDir
 ROI directory in the root file.
 
std::unordered_multimap< Belle2::VxdID, InterHistoAndFill, std::function< size_t(const Belle2::VxdID &)> > hInterDictionary
 map of histograms to be filled once per intercept
 
std::unordered_multimap< Belle2::VxdID, ROIHistoAndFill, std::function< size_t(const Belle2::VxdID &)> > hROIDictionary
 map of histograms to be filled once per roi
 
std::unordered_multimap< Belle2::VxdID, ROIHistoAccumulateAndFill &, std::function< size_t(const Belle2::VxdID &) > > hROIDictionaryEvt
 map of histograms to be filled once per event
 
int m_numModules
 number of hardware modules
 
int m_specificLayer
 specific layer selected for which to produce the plots.
 
bool m_plotRecoDigits = false
 Produce plots for SVDRecoDigits when True.
 
TH1F * hnROIs
 number of ROIs
 
TH1F * hnInter
 number of intercpets
 
TH1F * harea
 ROis area.
 
TH1F * hredFactor
 reduction factor
 
TH1F * hCellU
 U cells.
 
TH1F * hCellV
 V cells.
 
int n_events
 number of events
 
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

Creates basic DQM for ROI creation on ExpressReco

Definition at line 36 of file SVDROIDQMModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

◆ InterHistoAndFill

typedef std::pair< TH1*, std::function< void(TH1*, const SVDIntercept*) > > InterHistoAndFill
private

typedef: histograms to be filled once per intercept + filling function

Definition at line 70 of file SVDROIDQMModule.h.

◆ ROIHistoAndFill

typedef std::pair< TH1*, std::function< void(TH1*, const ROIid*) > > ROIHistoAndFill
private

typedef: histograms to be filled once per roi + filling function

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

◆ SVDROIDQMModule()

Constructor defining the parameters.

Definition at line 30 of file SVDROIDQMModule.cc.

31 : HistoModule()
32 , m_InterDir(nullptr)
33 , m_ROIDir(nullptr)
34 , hInterDictionary(172, [](const Belle2::VxdID & vxdid) {return (size_t)vxdid.getID(); })
35, hROIDictionary(172, [](const Belle2::VxdID& vxdid) {return (size_t)vxdid.getID(); })
36, hROIDictionaryEvt(172, [](const Belle2::VxdID& vxdid) {return (size_t)vxdid.getID(); })
37, m_numModules(0)
38, hnROIs(nullptr)
39, hnInter(nullptr)
40, harea(nullptr)
41, hredFactor(nullptr)
42, hCellU(nullptr)
43, hCellV(nullptr)
44, n_events(0)
45{
46 //Set module properties
47 setDescription("Monitor of the ROIs creation on HLT");
49
50 addParam("SVDShaperDigitsName", m_SVDShaperDigitsName,
51 "name of the list of SVDShaperDigits", std::string(""));
52 addParam("SVDRecoDigitsName", m_SVDRecoDigitsName,
53 "name of the list of SVDRecoDigits", std::string(""));
54 addParam("SVDClustersName", m_SVDClustersName,
55 "name of the list of SVDClusters", std::string(""));
56
57 addParam("InterceptsName", m_InterceptsName,
58 "name of the list of interceptions", std::string(""));
59
60 addParam("ROIsName", m_ROIsName,
61 "name of the list of ROIs", std::string(""));
62
63 addParam("specificLayer", m_specificLayer,
64 "Layer number, if you want the plots only for a specific SVD layer. If it is not a SVD layer (3, 4, 5, 6) than the plots for all SVD layers are produced. Default is (-1), i.e. plots for all SVD layers are produced.",
66
67 addParam("plotRecoDigits", m_plotRecoDigits,
68 "Set true to produce the plots for RecoDigits (false by default)", m_plotRecoDigits);
69
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
std::unordered_multimap< Belle2::VxdID, ROIHistoAccumulateAndFill &, std::function< size_t(const Belle2::VxdID &) > > hROIDictionaryEvt
map of histograms to be filled once per event
int m_numModules
number of hardware modules
std::unordered_multimap< Belle2::VxdID, InterHistoAndFill, std::function< size_t(const Belle2::VxdID &)> > hInterDictionary
map of histograms to be filled once per intercept
std::string m_InterceptsName
Name of the SVDIntercept StoreArray.
bool m_plotRecoDigits
Produce plots for SVDRecoDigits when True.
TH1F * hnROIs
number of ROIs
int n_events
number of events
TDirectory * m_ROIDir
ROI directory in the root file.
std::string m_SVDRecoDigitsName
reco digit list name
std::string m_SVDClustersName
cluster list name
int m_specificLayer
specific layer selected for which to produce the plots.
TH1F * hredFactor
reduction factor
std::string m_ROIsName
Name of the ROIid StoreArray.
TH1F * hnInter
number of intercpets
TDirectory * m_InterDir
intercepts directory in the root file
std::unordered_multimap< Belle2::VxdID, ROIHistoAndFill, std::function< size_t(const Belle2::VxdID &)> > hROIDictionary
map of histograms to be filled once per roi
TH1F * harea
ROis area.
std::string m_SVDShaperDigitsName
shaper digit list name
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:33
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void  )
inlineoverridevirtualinherited

Function to process begin_run record.

Reimplemented from Module.

Reimplemented in CalibrationCollectorModule, ARICHDQMModule, ARICHRateCalModule, B2BIIMCParticlesMonitorModule, AnalysisPhase1StudyModule, BeamabortStudyModule, BgoStudyModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, FANGSStudyModule, He3tubeStudyModule, MicrotpcStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, MonitorDataModule, TrackAnaModule, IPDQMModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLDQMModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, SoftwareTriggerHLTDQMModule, StatisticsTimingHLTDQMModule, KLMDQMModule, KLMDQM2Module, PXDRawDQMChipsModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0DQMModule, SVDDQMHitTimeModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPTBCComparatorModule, DQMHistoModuleBase, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGGDLModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGRLDQMModule, TRGTOPDQMModule, TRGRAWDATAModule, DAQMonitorModule, DelayDQMModule, V0ObjectsDQMModule, ECLDQMInjectionModule, PXDDAQDQMModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDRawDQMCorrModule, PXDRawDQMModule, PXDROIDQMModule, PXDTrackClusterDQMModule, TTDDQMModule, DetectorOccupanciesDQMModule, SVDDQMClustersOnTrackModule, SVDDQMDoseModule, SVDDQMExpressRecoModule, SVDDQMInjectionModule, SVDUnpackerDQMModule, TrackingAbortDQMModule, VXDDQMExpressRecoModule, and vxdDigitMaskingModule.

Definition at line 40 of file HistoModule.h.

40{};

◆ 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

◆ createHistosDictionaries()

void createHistosDictionaries ( )
private

create the dictionary

Definition at line 172 of file SVDROIDQMModule.cc.

173{
174
175 // VXD::GeoCache& aGeometry = VXD::GeoCache::getInstance();
176
177 std::string name; //name of the histogram
178 std::string title; //title of the histogram
179 TH2F* tmp2D; //temporary 2D histo used to set axis title
180 TH1F* tmp1D; //temporary 1D histo used to set axis title
181
182 m_numModules = 0;
183
184 std::set<Belle2::VxdID> svdLayers = m_geoCache.getLayers(VXD::SensorInfoBase::SVD);
185 std::set<Belle2::VxdID>::iterator itSvdLayers = svdLayers.begin();
186
187 if (m_specificLayer >= 3 && m_specificLayer <= 6) {
188 B2INFO("Producing plots for layer: " << m_specificLayer);
189 svdLayers.clear();
190 svdLayers.insert(Belle2::VxdID(m_specificLayer, 0, 0));
191 itSvdLayers = svdLayers.begin();
192 } else {
193 B2INFO("No specific SVD layer (3,4,5,6) selected (m_specificLayer = " << m_specificLayer <<
194 "). Producing plots for all SVD layers.");
195 }
196
197 while (itSvdLayers != svdLayers.end()) {
198
199 std::set<Belle2::VxdID> svdLadders = m_geoCache.getLadders(*itSvdLayers);
200 std::set<Belle2::VxdID>::iterator itSvdLadders = svdLadders.begin();
201
202 while (itSvdLadders != svdLadders.end()) {
203
204 std::set<Belle2::VxdID> svdSensors = m_geoCache.getSensors(*itSvdLadders);
205 std::set<Belle2::VxdID>::iterator itSvdSensors = svdSensors.begin();
206
207 while (itSvdSensors != svdSensors.end()) {
208
209 m_numModules++; //counting the total number of modules
210
211 const VXD::SensorInfoBase& wSensorInfo = m_geoCache.getSensorInfo(*itSvdSensors);
212
213 const int nPixelsU = wSensorInfo.getUCells();
214 const int nPixelsV = wSensorInfo.getVCells();
215 std::string sensorid = std::to_string(itSvdSensors->getLayerNumber()) + "_" + std::to_string(
216 itSvdSensors->getLadderNumber()) + "_" +
217 std::to_string(itSvdSensors->getSensorNumber());
218
219
220 // ------ HISTOGRAMS WITH AN ACCUMULATE PER ROI AND A FILL PER EVENT -------
221 m_ROIDir->cd();
222
223 name = "hNROIs_" + sensorid;
224 title = "number of ROIs for sensor " + sensorid;
225 double value = 0;
226 ROIHistoAccumulateAndFill* aHAAF = new ROIHistoAccumulateAndFill {
227 new TH1F(name.c_str(), title.c_str(), 25, 0, 25),
228 [](const ROIid*, double & val) {val++;},
229 [](TH1 * hPtr, double & val) { hPtr->Fill(val); },
230 value
231 };
232 hROIDictionaryEvt.insert(std::pair< Belle2::VxdID, ROIHistoAccumulateAndFill& > ((Belle2::VxdID)*itSvdSensors, *aHAAF));
233
234
235
236
237 // ------ HISTOGRAMS WITH A FILL PER INTERCEPT -------
238 m_InterDir->cd();
239
240 // coor U and V
241 name = "hCoorU_" + sensorid;
242 title = "U coordinate of the extrapolation in U for sensor " + sensorid;
243 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
244 (
245 (Belle2::VxdID)*itSvdSensors,
247 new TH1F(name.c_str(), title.c_str(), 100, -5, 5),
248 [](TH1 * hPtr, const SVDIntercept * inter) { hPtr->Fill(inter->getCoorU()); }
249 )
250 )
251 );
252
253 name = "hCoorV_" + sensorid;
254 title = "V coordinate of the extrapolation in V for sensor " + sensorid;
255 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
256 (
257 (Belle2::VxdID)*itSvdSensors,
259 new TH1F(name.c_str(), title.c_str(), 100, -5, 5),
260 [](TH1 * hPtr, const SVDIntercept * inter) { hPtr->Fill(inter->getCoorV()); }
261 )
262 )
263 );
264
265 // Intercept U vs V coordinate
266 name = "hCoorU_vs_CoorV_" + sensorid;
267 title = "U vs V intercept (cm) " + sensorid;
268 tmp2D = new TH2F(name.c_str(), title.c_str(), 100, -5, 5, 100, -5, 5);
269 tmp2D->GetXaxis()->SetTitle("intercept U coor (cm)");
270 tmp2D->GetYaxis()->SetTitle("intercept V coor (cm)");
271 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
272 (
273 (Belle2::VxdID)*itSvdSensors,
275 tmp2D,
276 [](TH1 * hPtr, const SVDIntercept * inter) { hPtr->Fill(inter->getCoorU(), inter->getCoorV()); }
277 )
278 )
279 );
280
281
282 // sigma U and V
283 name = "hStatErrU_" + sensorid;
284 title = "stat error of the extrapolation in U for sensor " + sensorid;
285 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
286 (
287 (Belle2::VxdID)*itSvdSensors,
289 new TH1F(name.c_str(), title.c_str(), 100, 0, 0.35),
290 [](TH1 * hPtr, const SVDIntercept * inter) { hPtr->Fill(inter->getSigmaU()); }
291 )
292 )
293 );
294 name = "hStatErrV_" + sensorid;
295 title = "stat error of the extrapolation in V for sensor " + sensorid;
296 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
297 (
298 (Belle2::VxdID)*itSvdSensors,
300 new TH1F(name.c_str(), title.c_str(), 100, 0, 0.35),
301 [](TH1 * hPtr, const SVDIntercept * inter) { hPtr->Fill(inter->getSigmaV()); }
302 )
303 )
304 );
305
306 //1D residuals
307 name = "hResidU_" + sensorid;
308 title = "U residuals = intercept - digit, for sensor " + sensorid;
309 tmp1D = new TH1F(name.c_str(), title.c_str(), 1000, -5, 5);
310 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
311 (
312 (Belle2::VxdID)*itSvdSensors,
314 tmp1D,
315 [this](TH1 * hPtr, const SVDIntercept * inter) {
316
317 for (auto& it : this->m_SVDShaperDigits)
318 if ((int)it.getSensorID() == (int)inter->getSensorID()) {
319 if (it.isUStrip()) {
320 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
321 hPtr->Fill(inter->getCoorU() - aSensorInfo.getUCellPosition(it.getCellID()));
322 }
323 }
324 }
325 )
326 )
327 );
328
329 name = "hResidV_" + sensorid;
330 title = "V residuals = intercept - digit, for sensor " + sensorid;
331 tmp1D = new TH1F(name.c_str(), title.c_str(), 1000, -5, 5);
332 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
333 (
334 (Belle2::VxdID)*itSvdSensors,
336 tmp1D,
337 [this](TH1 * hPtr, const SVDIntercept * inter) {
338
339 for (auto& it : this->m_SVDShaperDigits)
340 if ((int)it.getSensorID() == (int)inter->getSensorID()) {
341 if (!it.isUStrip()) {
342 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
343 hPtr->Fill(inter->getCoorV() - aSensorInfo.getVCellPosition(it.getCellID()));
344 }
345 }
346 }
347 )
348 )
349 );
350
351
352 //residual U,V vs coordinate U,V
353 name = "hResidU_vs_CoorU_" + sensorid;
354 title = "U residual (cm) vs coor U (cm) " + sensorid;
355 tmp2D = new TH2F(name.c_str(), title.c_str(), 1000, -5, 5, 1000, -5, 5);
356 tmp2D->GetYaxis()->SetTitle("U resid (cm)");
357 tmp2D->GetXaxis()->SetTitle("U coor (cm)");
358 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
359 (
360 (Belle2::VxdID)*itSvdSensors,
362 tmp2D,
363 [this](TH1 * hPtr, const SVDIntercept * inter) {
364
365 for (auto& it : this->m_SVDShaperDigits)
366 if (((int)it.getSensorID() == (int)inter->getSensorID()) && it.isUStrip()) {
367 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
368 double resid = inter->getCoorU() - aSensorInfo.getUCellPosition(it.getCellID());
369 hPtr->Fill(inter->getCoorU(), resid);
370 }
371 }
372 )
373 )
374 );
375
376 name = "hResidV_vs_CoorV_" + sensorid;
377 title = "V residual (cm) vs coor V (cm) " + sensorid;
378 tmp2D = new TH2F(name.c_str(), title.c_str(), 1000, -5, 5, 1000, -5, 5);
379 tmp2D->GetYaxis()->SetTitle("V resid (cm)");
380 tmp2D->GetXaxis()->SetTitle("V coor (cm)");
381 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
382 (
383 (Belle2::VxdID)*itSvdSensors,
385 tmp2D,
386 [this](TH1 * hPtr, const SVDIntercept * inter) {
387
388 for (auto& it : this->m_SVDShaperDigits)
389 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (!it.isUStrip())) {
390 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
391 double resid = inter->getCoorV() - aSensorInfo.getVCellPosition(it.getCellID());
392 hPtr->Fill(inter->getCoorV(), resid);
393 }
394 }
395 )
396 )
397 );
398
399
400 // RecoDigits
401 //residual vs charge
402 if (m_plotRecoDigits) {
403 name = "hResidU_vs_charge_" + sensorid;
404 title = "U residual (cm) vs charge " + sensorid;
405 tmp2D = new TH2F(name.c_str(), title.c_str(), 250, 0, 250, 100, -5, 5);
406 tmp2D->GetYaxis()->SetTitle("U resid (cm)");
407 tmp2D->GetXaxis()->SetTitle("charge");
408 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
409 (
410 (Belle2::VxdID)*itSvdSensors,
412 tmp2D,
413 [this](TH1 * hPtr, const SVDIntercept * inter) {
414
415 for (auto& it : this->m_SVDRecoDigits)
416 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (it.isUStrip())) {
417 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
418 double resid = inter->getCoorU() - aSensorInfo.getUCellPosition(it.getCellID());
419 hPtr->Fill(it.getCharge(), resid);
420 }
421 }
422 )
423 )
424 );
425
426 name = "hResidV_vs_charge_" + sensorid;
427 title = "V residual (cm) vs charge " + sensorid;
428 tmp2D = new TH2F(name.c_str(), title.c_str(), 250, 0, 250, 100, -5, 5);
429 tmp2D->GetYaxis()->SetTitle("V resid (cm)");
430 tmp2D->GetXaxis()->SetTitle("charge");
431 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
432 (
433 (Belle2::VxdID)*itSvdSensors,
435 tmp2D,
436 [this](TH1 * hPtr, const SVDIntercept * inter) {
437
438 for (auto& it : this->m_SVDRecoDigits)
439 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (!it.isUStrip())) {
440 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
441 double resid = inter->getCoorV() - aSensorInfo.getVCellPosition(it.getCellID());
442 hPtr->Fill(it.getCharge(), resid);
443 }
444 }
445 )
446 )
447 );
448 }
449
450 // 1D residual for clusters
451 name = "hClusterResidU_" + sensorid;
452 title = "Cluster U residuals = intercept - cluster, for sensor " + sensorid;
453 tmp1D = new TH1F(name.c_str(), title.c_str(), 1000, -5, 5);
454 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
455 (
456 (Belle2::VxdID)*itSvdSensors,
458 tmp1D,
459 [this](TH1 * hPtr, const SVDIntercept * inter) {
460
461 for (auto& it : this->m_SVDClusters)
462 if ((int)it.getSensorID() == (int)inter->getSensorID()) {
463 if (it.isUCluster()) {
464 hPtr->Fill(inter->getCoorU() - it.getPosition(inter->getCoorV()));
465 }
466 }
467 }
468 )
469 )
470 );
471
472 name = "hClusterResidV_" + sensorid;
473 title = "Cluster V residuals = intercept - cluster, for sensor " + sensorid;
474 tmp1D = new TH1F(name.c_str(), title.c_str(), 1000, -5, 5);
475 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
476 (
477 (Belle2::VxdID)*itSvdSensors,
479 tmp1D,
480 [this](TH1 * hPtr, const SVDIntercept * inter) {
481
482 for (auto& it : this->m_SVDClusters)
483 if ((int)it.getSensorID() == (int)inter->getSensorID()) {
484 if (!it.isUCluster()) {
485 hPtr->Fill(inter->getCoorV() - it.getPosition());
486 }
487 }
488 }
489 )
490 )
491 );
492
493 //residual U,V vs coordinate U,V for clusters
494 name = "hClusterResidU_vs_CoorU_" + sensorid;
495 title = "Cluster U residual (cm) vs coor U (cm) " + sensorid;
496 tmp2D = new TH2F(name.c_str(), title.c_str(), 1000, -5, 5, 1000, -5, 5);
497 tmp2D->GetYaxis()->SetTitle("Cluster U resid (cm)");
498 tmp2D->GetXaxis()->SetTitle("U coor (cm)");
499 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
500 (
501 (Belle2::VxdID)*itSvdSensors,
503 tmp2D,
504 [this](TH1 * hPtr, const SVDIntercept * inter) {
505
506 for (auto& it : this->m_SVDClusters)
507 if (((int)it.getSensorID() == (int)inter->getSensorID()) && it.isUCluster()) {
508 double resid = inter->getCoorU() - it.getPosition(inter->getCoorV());
509 hPtr->Fill(inter->getCoorU(), resid);
510 }
511 }
512 )
513 )
514 );
515
516 name = "hClusterResidV_vs_CoorV_" + sensorid;
517 title = "Cluster V residual (cm) vs coor V (cm) " + sensorid;
518 tmp2D = new TH2F(name.c_str(), title.c_str(), 1000, -5, 5, 1000, -5, 5);
519 tmp2D->GetYaxis()->SetTitle("Cluster V resid (cm)");
520 tmp2D->GetXaxis()->SetTitle("V coor (cm)");
521 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
522 (
523 (Belle2::VxdID)*itSvdSensors,
525 tmp2D,
526 [this](TH1 * hPtr, const SVDIntercept * inter) {
527
528 for (auto& it : this->m_SVDClusters)
529 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (!it.isUCluster())) {
530 double resid = inter->getCoorV() - it.getPosition();
531 hPtr->Fill(inter->getCoorV(), resid);
532 }
533 }
534 )
535 )
536 );
537
538
539 //residual vs charge for clusters
540 name = "hClusterResidU_vs_charge_" + sensorid;
541 title = "Cluster U residual (cm) vs charge " + sensorid;
542 tmp2D = new TH2F(name.c_str(), title.c_str(), 250, 0, 250, 100, -5, 5);
543 tmp2D->GetYaxis()->SetTitle("U resid (cm)");
544 tmp2D->GetXaxis()->SetTitle("charge (ke-)");
545 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
546 (
547 (Belle2::VxdID)*itSvdSensors,
549 tmp2D,
550 [this](TH1 * hPtr, const SVDIntercept * inter) {
551
552 for (auto& it : this->m_SVDClusters)
553 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (it.isUCluster())) {
554 double resid = inter->getCoorU() - it.getPosition(inter->getCoorV());
555 hPtr->Fill(it.getCharge() / 1000., resid);
556 }
557 }
558 )
559 )
560 );
561
562 name = "hClusterResidV_vs_charge_" + sensorid;
563 title = "Cluster V residual (cm) vs charge " + sensorid;
564 tmp2D = new TH2F(name.c_str(), title.c_str(), 250, 0, 250, 100, -5, 5);
565 tmp2D->GetYaxis()->SetTitle("Cluster V resid (cm)");
566 tmp2D->GetXaxis()->SetTitle("charge (ke-)");
567 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
568 (
569 (Belle2::VxdID)*itSvdSensors,
571 tmp2D,
572 [this](TH1 * hPtr, const SVDIntercept * inter) {
573
574 for (auto& it : this->m_SVDClusters)
575 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (!it.isUCluster())) {
576 double resid = inter->getCoorV() - it.getPosition();
577 hPtr->Fill(it.getCharge() / 1000., resid);
578 }
579 }
580 )
581 )
582 );
583
584 // residual vs time for clusters
585 name = "hClusterResidU_vs_time_" + sensorid;
586 title = "Cluster U residual (cm) vs time " + sensorid;
587 tmp2D = new TH2F(name.c_str(), title.c_str(), 400, -200, 200, 100, -5, 5);
588 tmp2D->GetYaxis()->SetTitle("U resid (cm)");
589 tmp2D->GetXaxis()->SetTitle("time (ns)");
590 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
591 (
592 (Belle2::VxdID)*itSvdSensors,
594 tmp2D,
595 [this](TH1 * hPtr, const SVDIntercept * inter) {
596
597 for (auto& it : this->m_SVDClusters)
598 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (it.isUCluster())) {
599 double resid = inter->getCoorU() - it.getPosition(inter->getCoorV());
600 hPtr->Fill(it.getClsTime(), resid);
601 }
602 }
603 )
604 )
605 );
606
607 name = "hClusterResidV_vs_time_" + sensorid;
608 title = "Cluster V residual (cm) vs time " + sensorid;
609 tmp2D = new TH2F(name.c_str(), title.c_str(), 400, -200, 200, 100, -5, 5);
610 tmp2D->GetYaxis()->SetTitle("Cluster V resid (cm)");
611 tmp2D->GetXaxis()->SetTitle("time (ns)");
612 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
613 (
614 (Belle2::VxdID)*itSvdSensors,
616 tmp2D,
617 [this](TH1 * hPtr, const SVDIntercept * inter) {
618
619 for (auto& it : this->m_SVDClusters)
620 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (!it.isUCluster())) {
621 double resid = inter->getCoorV() - it.getPosition();
622 hPtr->Fill(it.getClsTime(), resid);
623 }
624 }
625 )
626 )
627 );
628
629 // scatter plot: U,V intercept in cm VS U,V cell position
630 name = "hCoorU_vs_UDigit_" + sensorid;
631 title = "U intercept (cm) vs U Digit (ID) " + sensorid;
632 tmp2D = new TH2F(name.c_str(), title.c_str(), 1000, -5, 5, 1000, -5, 5);
633 tmp2D->GetXaxis()->SetTitle("intercept U coor (cm)");
634 tmp2D->GetYaxis()->SetTitle("digit U coor (cm)");
635 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
636 (
637 (Belle2::VxdID)*itSvdSensors,
639 tmp2D,
640 [this](TH1 * hPtr, const SVDIntercept * inter) {
641
642 for (auto& it : this->m_SVDShaperDigits)
643 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (it.isUStrip())) {
644 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
645 hPtr->Fill(inter->getCoorU(), aSensorInfo.getUCellPosition(it.getCellID()));
646 // hPtr->Fill( inter->getCoorU(), it.getVCellID()*75e-4 );
647 }
648 }
649 )
650 )
651 );
652
653 name = "hCoorV_vs_VDigit_" + sensorid;
654 title = "V intercept (cm) vs V Digit (ID) " + sensorid;
655 tmp2D = new TH2F(name.c_str(), title.c_str(), 1000, -5, 5, 1000, -5, 5);
656 tmp2D->GetXaxis()->SetTitle("intercept V coor (cm)");
657 tmp2D->GetYaxis()->SetTitle("digi V coor (cm)");
658 hInterDictionary.insert(std::pair< Belle2::VxdID, InterHistoAndFill >
659 (
660 (Belle2::VxdID)*itSvdSensors,
662 tmp2D,
663 [this](TH1 * hPtr, const SVDIntercept * inter) {
664
665 for (auto& it : this->m_SVDShaperDigits) {
666 if (((int)it.getSensorID() == (int)inter->getSensorID()) && (!it.isUStrip())) {
667 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
668 hPtr->Fill(inter->getCoorV(), aSensorInfo.getVCellPosition(it.getCellID()));
669 // hPtr->Fill( inter->getCoorV(), it.getUCellID()*50e-4 );
670 }
671 }
672 }
673 )
674 )
675 );
676
677
678
679
680
681
682 // ------ HISTOGRAMS WITH A FILL PER ROI -------
683 m_ROIDir->cd();
684
685 // MIN in U and V
686 name = "hminU_" + sensorid;
687 title = "ROI min in U for sensor " + sensorid;
688 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
689 (
690 (Belle2::VxdID)*itSvdSensors,
692 new TH1F(name.c_str(), title.c_str(), nPixelsU, 0, nPixelsU),
693 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill(roi->getMinUid()); }
694 )
695 )
696 );
697 name = "hminV_" + sensorid;
698 title = "ROI min in V for sensor " + sensorid;
699 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
700 (
701 (Belle2::VxdID)*itSvdSensors,
703 new TH1F(name.c_str(), title.c_str(), nPixelsV, 0, nPixelsV),
704 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill(roi->getMinVid()); }
705 )
706 )
707 );
708 //--------------------------
709 // MAX in U and V
710 name = "hmaxU_" + sensorid;
711 title = "ROI max in U for sensor " + sensorid;
712 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
713 (
714 (Belle2::VxdID)*itSvdSensors,
716 new TH1F(name.c_str(), title.c_str(), nPixelsU, 0, nPixelsU),
717 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill(roi->getMaxUid()); }
718 )
719 )
720 );
721 name = "hmaxV_" + sensorid;
722 title = "ROI max in V for sensor " + sensorid;
723 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
724 (
725 (Belle2::VxdID)*itSvdSensors,
727 new TH1F(name.c_str(), title.c_str(), nPixelsV, 0, nPixelsV),
728 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill(roi->getMaxVid()); }
729 )
730 )
731 );
732 //--------------------------
733
734 // WIDTH in U and V
735 name = "hwidthU_" + sensorid;
736 title = "ROI width in U for sensor " + sensorid;
737 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
738 (
739 (Belle2::VxdID)*itSvdSensors,
741 new TH1F(name.c_str(), title.c_str(), nPixelsU, 0, nPixelsU),
742 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill(roi->getMaxUid() - roi->getMinUid()); }
743 )
744 )
745 );
746 name = "hwidthV_" + sensorid;
747 title = "ROI width in V for sensor " + sensorid;
748 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
749 (
750 (Belle2::VxdID)*itSvdSensors,
752 new TH1F(name.c_str(), title.c_str(), nPixelsV, 0, nPixelsV),
753 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill(roi->getMaxVid() - roi->getMinVid()); }
754 )
755 )
756 );
757
758 // ROI center
759 name = "hROIcenter_" + sensorid;
760 title = "ROI center " + sensorid;
761 tmp2D = new TH2F(name.c_str(), title.c_str(), nPixelsU, 0, nPixelsU, nPixelsV, 0, nPixelsV);
762 tmp2D->GetXaxis()->SetTitle(" U (ID)");
763 tmp2D->GetYaxis()->SetTitle(" V (ID)");
764 hROIDictionary.insert(std::pair< Belle2::VxdID, ROIHistoAndFill >
765 (
766 (Belle2::VxdID)*itSvdSensors,
768 tmp2D,
769 [](TH1 * hPtr, const ROIid * roi) { hPtr->Fill((roi->getMaxUid() + roi->getMinUid()) / 2, (roi->getMaxVid() + roi->getMinVid()) / 2); }
770 )
771 )
772 );
773
774 //--------------------------
775
776 ++itSvdSensors;
777 }
778 ++itSvdLadders;
779 }
780 ++itSvdLayers;
781 }
782
783}
ROIid stores the U and V ids and the sensor id of the Region Of Interest.
Definition: ROIid.h:25
SVDIntercept stores the U,V coordinates and uncertainties of the intersection of a track with an SVD ...
Definition: SVDIntercept.h:22
std::pair< TH1 *, std::function< void(TH1 *, const SVDIntercept *) > > InterHistoAndFill
typedef: histograms to be filled once per intercept + filling function
StoreArray< SVDCluster > m_SVDClusters
svd cluster store array
VXD::GeoCache & m_geoCache
the geo cache instance
std::pair< TH1 *, std::function< void(TH1 *, const ROIid *) > > ROIHistoAndFill
typedef: histograms to be filled once per roi + filling function
StoreArray< SVDShaperDigit > m_SVDShaperDigits
shaper digit store array
StoreArray< SVDRecoDigit > m_SVDRecoDigits
reco digit store array
double getCoorV() const
return the V coordinate of the intercept
Definition: VXDIntercept.h:60
VxdID::baseType getSensorID() const
return the sensor ID
Definition: VXDIntercept.h:68
double getCoorU() const
return the U coordinate of the intercept
Definition: VXDIntercept.h:59
const std::set< Belle2::VxdID > getLayers(SensorInfoBase::SensorType sensortype=SensorInfoBase::VXD)
Return a set of all known Layers.
Definition: GeoCache.cc:176
const SensorInfoBase & getSensorInfo(Belle2::VxdID id) const
Return a referecne to the SensorInfo of a given SensorID.
Definition: GeoCache.cc:67
const std::set< Belle2::VxdID > & getSensors(Belle2::VxdID ladder) const
Return a set of all sensor IDs belonging to a given ladder.
Definition: GeoCache.cc:204
const std::set< Belle2::VxdID > & getLadders(Belle2::VxdID layer) const
Return a set of all ladder IDs belonging to a given layer.
Definition: GeoCache.cc:193
Base class to provide Sensor Information for PXD and SVD.
int getVCells() const
Return number of pixel/strips in v direction.
int getUCells() const
Return number of pixel/strips in u direction.

◆ 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 ( )
overrideprivatevirtual

define histograms

Reimplemented from HistoModule.

Definition at line 72 of file SVDROIDQMModule.cc.

73{
74
75 // Create a separate histogram directory and cd into it.
76 TDirectory* oldDir = gDirectory;
77 TDirectory* roiDir = oldDir->mkdir("SVDROIs");
78 m_InterDir = roiDir->mkdir("intercept");
79 m_ROIDir = roiDir->mkdir("roi");
80
81 hCellU = new TH1F("hCellU", "CellID U", 769, -0.5, 768.5);
82 hCellU->GetXaxis()->SetTitle("U cell ID");
83 hCellV = new TH1F("hCellV", "CellID V", 769, -0.5, 768.5);
84 hCellV->GetXaxis()->SetTitle("V cell ID");
85
86 m_InterDir->cd();
87 hnInter = new TH1F("hnInter", "number of intercepts", 100, 0, 100);
88
89 m_ROIDir->cd();
90 hnROIs = new TH1F("hnROIs", "number of ROIs", 100, 0, 100);
91 harea = new TH1F("harea", "ROIs area", 100, 0, 100000);
92 hredFactor = new TH1F("hredFactor", "ROI reduction factor", 1000, 0, 1);
93
94
96
97 oldDir->cd();
98
99}
void createHistosDictionaries()
create the dictionary

◆ endRun()

void endRun ( void  )
overridevirtual

fill per-run histograms

Reimplemented from HistoModule.

Definition at line 812 of file SVDROIDQMModule.cc.

813{
814
815 hCellU->Scale((double)1 / n_events);
816 hCellV->Scale((double)1 / n_events);
817
818 for (auto it = hROIDictionaryEvt.begin(); it != hROIDictionaryEvt.end(); ++it)
819 delete &(it->second);
820}

◆ 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  )
overridevirtual

fill per-event histograms

Reimplemented from HistoModule.

Definition at line 116 of file SVDROIDQMModule.cc.

117{
118
119 n_events++;
120
121 for (auto& it : m_SVDShaperDigits)
122 if (it.isUStrip())
123 hCellU->Fill(it.getCellID());
124 else
125 hCellV->Fill(it.getCellID());
126
127 hnInter->Fill(m_Intercepts.getEntries());
128
129 for (auto& it : m_Intercepts)
131
132
133 for (auto it = hROIDictionaryEvt.begin(); it != hROIDictionaryEvt.end(); ++it)
134 (it->second).value = 0;
135
136 int ROIarea = 0;
137 double redFactor = 0;
138
139 for (auto& it : m_ROIs) {
140
142
143 const VXD::SensorInfoBase& aSensorInfo = m_geoCache.getSensorInfo(it.getSensorID());
144 const int nPixelsU = aSensorInfo.getUCells();
145 const int nPixelsV = aSensorInfo.getVCells();
146
147 int minU = it.getMinUid();
148 int minV = it.getMinVid();
149 int maxU = it.getMaxUid();
150 int maxV = it.getMaxVid();
151
152 int tmpROIarea = (maxU - minU) * (maxV - minV);
153 ROIarea += tmpROIarea;
154 redFactor += (double)tmpROIarea / (nPixelsU * nPixelsV * m_numModules);
155
156 }
157
158 hnROIs->Fill(m_ROIs.getEntries());
159
160 harea->Fill((double)ROIarea);
161
162 hredFactor->Fill((double)redFactor);
163
164
165 for (auto it = hROIDictionaryEvt.begin(); it != hROIDictionaryEvt.end(); ++it) {
166 ROIHistoAccumulateAndFill aROIHistoAccumulateAndFill = it->second;
167 aROIHistoAccumulateAndFill.fill(aROIHistoAccumulateAndFill.hPtr, aROIHistoAccumulateAndFill.value);
168 }
169
170}
void fillSensorInterHistos(const SVDIntercept *inter)
fill histograms per sensor, filled once per intercept
void fillSensorROIHistos(const ROIid *roi)
fill histograms per sensor, filled once per ROI
StoreArray< SVDIntercept > m_Intercepts
SVDIntercept Store Arrays.
StoreArray< ROIid > m_ROIs
ROis store array.

◆ 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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ 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

◆ fillSensorInterHistos()

void fillSensorInterHistos ( const SVDIntercept inter)
private

fill histograms per sensor, filled once per intercept

Definition at line 785 of file SVDROIDQMModule.cc.

786{
787
788 auto its = hInterDictionary.equal_range(inter->getSensorID());
789
790 for (auto it = its.first; it != its.second; ++it) {
791 InterHistoAndFill aInterHistoAndFill = it->second;
792 aInterHistoAndFill.second(aInterHistoAndFill.first, inter);
793 }
794
795}

◆ fillSensorROIHistos()

void fillSensorROIHistos ( const ROIid roi)
private

fill histograms per sensor, filled once per ROI

Definition at line 797 of file SVDROIDQMModule.cc.

798{
799
800 auto its = hROIDictionary.equal_range(roi->getSensorID());
801
802 for (auto it = its.first; it != its.second; ++it) {
803 ROIHistoAndFill aROIHistoAndFill = it->second;
804 aROIHistoAndFill.second(aROIHistoAndFill.first, roi);
805 }
806
807 auto itsEvt = hROIDictionaryEvt.equal_range(roi->getSensorID());
808 for (auto it = itsEvt.first; it != itsEvt.second; ++it)
809 (it->second).accumulate(roi, (it->second).value);
810}

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

register histograms

Reimplemented from HistoModule.

Definition at line 101 of file SVDROIDQMModule.cc.

102{
103 REG_HISTOGRAM
104
108 m_ROIs.isRequired(m_ROIsName);
109 m_Intercepts.isRequired(m_InterceptsName);
110
111 n_events = 0;
112
113
114}
bool isOptional(const std::string &name="")
Tell the DataStore about an optional input.

◆ 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

◆ harea

TH1F* harea
private

ROis area.

Definition at line 101 of file SVDROIDQMModule.h.

◆ hCellU

TH1F* hCellU
private

U cells.

Definition at line 103 of file SVDROIDQMModule.h.

◆ hCellV

TH1F* hCellV
private

V cells.

Definition at line 104 of file SVDROIDQMModule.h.

◆ hInterDictionary

std::unordered_multimap<Belle2::VxdID, InterHistoAndFill, std::function<size_t (const Belle2::VxdID&)> > hInterDictionary
private

map of histograms to be filled once per intercept

Definition at line 72 of file SVDROIDQMModule.h.

◆ hnInter

TH1F* hnInter
private

number of intercpets

Definition at line 100 of file SVDROIDQMModule.h.

◆ hnROIs

TH1F* hnROIs
private

number of ROIs

Definition at line 99 of file SVDROIDQMModule.h.

◆ hredFactor

TH1F* hredFactor
private

reduction factor

Definition at line 102 of file SVDROIDQMModule.h.

◆ hROIDictionary

std::unordered_multimap<Belle2::VxdID, ROIHistoAndFill, std::function<size_t (const Belle2::VxdID&)> > hROIDictionary
private

map of histograms to be filled once per roi

Definition at line 77 of file SVDROIDQMModule.h.

◆ hROIDictionaryEvt

std::unordered_multimap<Belle2::VxdID, ROIHistoAccumulateAndFill&, std::function<size_t (const Belle2::VxdID&) > > hROIDictionaryEvt
private

map of histograms to be filled once per event

Definition at line 88 of file SVDROIDQMModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_geoCache

VXD::GeoCache& m_geoCache = VXD::GeoCache::getInstance()
private

the geo cache instance

Definition at line 61 of file SVDROIDQMModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_Intercepts

StoreArray<SVDIntercept> m_Intercepts
private

SVDIntercept Store Arrays.

Definition at line 56 of file SVDROIDQMModule.h.

◆ m_InterceptsName

std::string m_InterceptsName
private

Name of the SVDIntercept StoreArray.

Definition at line 64 of file SVDROIDQMModule.h.

◆ m_InterDir

TDirectory* m_InterDir
private

intercepts directory in the root file

Definition at line 66 of file SVDROIDQMModule.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_numModules

int m_numModules
private

number of hardware modules

Definition at line 94 of file SVDROIDQMModule.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_plotRecoDigits

bool m_plotRecoDigits = false
private

Produce plots for SVDRecoDigits when True.

Definition at line 97 of file SVDROIDQMModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

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

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_ROIDir

TDirectory* m_ROIDir
private

ROI directory in the root file.

Definition at line 67 of file SVDROIDQMModule.h.

◆ m_ROIs

StoreArray<ROIid> m_ROIs
private

ROis store array.

Definition at line 55 of file SVDROIDQMModule.h.

◆ m_ROIsName

std::string m_ROIsName
private

Name of the ROIid StoreArray.

Definition at line 63 of file SVDROIDQMModule.h.

◆ m_specificLayer

int m_specificLayer
private
Initial value:
=
-1

specific layer selected for which to produce the plots.

If it is not a SVD layer (3, 4, 5, 6) than the plots for all layers are produced. Default is (-1), i.e. plots for all SVD layers are produced.

Definition at line 95 of file SVDROIDQMModule.h.

◆ m_SVDClusters

StoreArray<SVDCluster> m_SVDClusters
private

svd cluster store array

Definition at line 59 of file SVDROIDQMModule.h.

◆ m_SVDClustersName

std::string m_SVDClustersName
private

cluster list name

Definition at line 53 of file SVDROIDQMModule.h.

◆ m_SVDRecoDigits

StoreArray<SVDRecoDigit> m_SVDRecoDigits
private

reco digit store array

Definition at line 58 of file SVDROIDQMModule.h.

◆ m_SVDRecoDigitsName

std::string m_SVDRecoDigitsName
private

reco digit list name

Definition at line 52 of file SVDROIDQMModule.h.

◆ m_SVDShaperDigits

StoreArray<SVDShaperDigit> m_SVDShaperDigits
private

shaper digit store array

Definition at line 57 of file SVDROIDQMModule.h.

◆ m_SVDShaperDigitsName

std::string m_SVDShaperDigitsName
private

shaper digit list name

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

◆ n_events

int n_events
private

number of events

Definition at line 105 of file SVDROIDQMModule.h.


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