Belle II Software development
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
SVDHotStripFinderModule Class Reference
Packages » svd | Modules » svd modules

A module template. More...

#include <SVDHotStripFinderModule.h>

Inheritance diagram for SVDHotStripFinderModule:
Module PathElement

Public Types

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

Public Member Functions

 SVDHotStripFinderModule ()
 Constructor, for setting module description and parameters.
 
virtual ~SVDHotStripFinderModule ()
 Use to clean up anything you created in the constructor.
 
virtual void initialize () override
 Use this to initialize resources or memory your module needs.
 
virtual void beginRun () override
 Called once before a new run begins.
 
virtual void event () override
 Called once for each event.
 
virtual void endRun () override
 Called once when a run ends.
 
virtual void terminate () override
 Clean up anything you created in initialize().
 
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.
 
LogConfig & getLogConfig ()
 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 ModuleCondition * getCondition () 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< Path > getConditionPath () 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 ModuleParamList & getParamList () 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< PathElement > clone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

TH1F * createHistogram1D (const char *name, const char *title, Int_t nbins, Double_t min, Double_t max, const char *xtitle, TList *histoList=nullptr)
 create 1D histograms
 
TH2F * createHistogram2D (const char *name, const char *title, Int_t nbinsX, Double_t minX, Double_t maxX, const char *titleX, Int_t nbinsY, Double_t minY, Double_t maxY, const char *titleY, TList *histoList=nullptr)
 create 2D histograms
 
bool theHSFinder (double *stripOccAfterAbsCut, int *hsflag, int nstrips)
 return true if the strip is hot
 
std::list< ModulePtr > getModules () 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

StoreArray< SVDShaperDigit > m_storeDigits
 shaper digits store array
 
StoreObjPtr< EventMetaData > m_eventMetaData
 event meta data store array
 
std::string m_rootFileName
 root file name
 
std::string m_ShaperDigitName
 shaper digits name
 
float m_thr
 threshold
 
int m_base
 base
 
bool m_useHSFinderV1 = true
 use V1 finder
 
float m_absThr
 Absolute Occupancy Threshold cut for Hot strip finder.
 
float m_relOccPrec
 Relative precision on occupancy which is defined to be negligible for the hit background rate estimate.
 
bool m_verbose
 False by default, it allows to switch on the printing of all found HS.
 
TFile * m_rootFilePtr = nullptr
 pointer at root file used for storing histograms
 
float m_zs
 zero suppression cut for the input shaper digits
 
int m_firstExp
 first valid experiment
 
int m_firstRun
 first valid run
 
int m_lastExp
 last valid experiment
 
int m_lastRun
 last valid run
 
TList * m_histoList_occu = nullptr
 occupancy for low charge clusters
 
SVDHistograms< TH1F > * hm_occupancy = nullptr
 strip occupancy per sensor
 
SVDHistograms< TH1F > * hm_hot_strips = nullptr
 hot strips per sensor
 
SVDHistograms< TH1F > * hm_occupancy_after = nullptr
 strip occupancy after removal of hot strips, per sensor
 
SVDHistograms< TH1F > * hm_occAll = nullptr
 occupancy distribution - all strips
 
SVDHistograms< TH1F > * hm_occHot = nullptr
 occupancy distribution - hot strips
 
SVDHistograms< TH1F > * hm_occAfter = nullptr
 occupancy distribution - not hot strips
 
SVDHistograms< TH1F > * hm_dist = nullptr
 occupancy histograms
 
SVDHistograms< TH1F > * hm_dist1 = nullptr
 true occupancy histograms
 
SVDHistograms< TH2F > * hm_dist12 = nullptr
 true occupancy VS sensor histograms
 
SVDSummaryPlots * m_hHotStripsSummary = nullptr
 hot strip summary histo
 
TH1F * h_tot_dqm = nullptr
 number of hot strips per sensor
 
TH1F * h_tot_dqm1 = nullptr
 number of hot strips per sensor for layer 3
 
TH1F * h_tot_dist = nullptr
 relative occupancy histogram
 
TH1F * h_tot_dist1 = nullptr
 absolute occupany histogram
 
TH2F * h_tot_dist12 = nullptr
 2d distributiuons of occupancies
 
TH1F * h_nevents = nullptr
 number of events counting
 
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< ModuleCondition > m_conditions
 Module condition, only non-null if set.
 

Static Private Attributes

static const int m_nLayers = 4
 number of layers
 
static const int m_nLadders = 16
 max number of ladders
 
static const int m_nSensors = 5
 max number of sensors
 
static const int m_nSides = 2
 number of sides
 

Detailed Description

A module template.

A detailed description of your module.

Definition at line 37 of file SVDHotStripFinderModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
Belle2::Module::c_DontCollectStatistics
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
Belle2::Module::c_ParallelProcessingCertified
@ 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
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ SVDHotStripFinderModule()

SVDHotStripFinderModule ( )

Constructor, for setting module description and parameters.

Definition at line 26 of file SVDHotStripFinderModule.cc.

26 : Module()
27{
28 setDescription("The svdHotStripFinder module finds hot strips in SVD data SVDShaperDigit");
29
30 addParam("outputFileName", m_rootFileName, "Name of output root file.", std::string("SVDHotStripFinder.root"));
31 addParam("threshold", m_thr, "Threshold cut for Hot strip finder in percent", float(4.0));
32 addParam("searchBase", m_base,
33 "number of strips used to compute the average occupancy, possible choices = 32, 64, 128. Default = -1, use all sensor strips.",
34 int(-1));
35 //additional paramters to import on the DB:
36 addParam("zeroSuppression", m_zs, "ZeroSuppression cut of the input SVDShaperDigits", float(5));
37 addParam("firstExp", m_firstExp, "experiment number", int(-1));
38 addParam("firstRun", m_firstRun, "run number", int(-1));
39 addParam("lastExp", m_lastExp, "open iov", int(-1));
40 addParam("lastRun", m_lastRun, "open iov", int(-1));
41 addParam("ShaperDigits", m_ShaperDigitName, "shaper digit name", std::string(""));
42 //new parameters for HSFinderV2:
43 addParam("useHSFinderV1", m_useHSFinderV1, "Set to false only if you want to test the second version of the algorithm",
44 bool(false));
45 addParam("absOccThreshold", m_absThr,
46 "Absolute occupancy threshold: at a first loop, flag as Hot Strip (HS) all those whose occupancy > absOccThreshold", float(0.2));
47 addParam("relOccPrec", m_relOccPrec,
48 "Number of times the average sensor occupancy considered to fix the sensor dependent threshold, as for example occ_threshold = relOccPrec x occ_average",
49 float(5));
50 addParam("verbose", m_verbose, " True by default, it allows to switch off the printing of all found HS.", bool(true));
51
52}
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Belle2::Module::Module
Module()
Constructor.
Definition: Module.cc:30
Belle2::SVDHotStripFinderModule::m_rootFileName
std::string m_rootFileName
root file name
Definition: SVDHotStripFinderModule.h:78
Belle2::SVDHotStripFinderModule::m_absThr
float m_absThr
Absolute Occupancy Threshold cut for Hot strip finder.
Definition: SVDHotStripFinderModule.h:83
Belle2::SVDHotStripFinderModule::m_ShaperDigitName
std::string m_ShaperDigitName
shaper digits name
Definition: SVDHotStripFinderModule.h:79
Belle2::SVDHotStripFinderModule::m_relOccPrec
float m_relOccPrec
Relative precision on occupancy which is defined to be negligible for the hit background rate estimat...
Definition: SVDHotStripFinderModule.h:84
Belle2::SVDHotStripFinderModule::m_zs
float m_zs
zero suppression cut for the input shaper digits
Definition: SVDHotStripFinderModule.h:91
Belle2::SVDHotStripFinderModule::m_firstExp
int m_firstExp
first valid experiment
Definition: SVDHotStripFinderModule.h:92
Belle2::SVDHotStripFinderModule::m_verbose
bool m_verbose
False by default, it allows to switch on the printing of all found HS.
Definition: SVDHotStripFinderModule.h:85
Belle2::Module::addParam
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

◆ ~SVDHotStripFinderModule()

~SVDHotStripFinderModule ( )
virtual

Use to clean up anything you created in the constructor.

Definition at line 55 of file SVDHotStripFinderModule.cc.

56{
57}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Called once before a new run begins.

This method gives you the chance to change run dependent constants like alignment parameters, etc.

Reimplemented from Module.

Definition at line 76 of file SVDHotStripFinderModule.cc.

77{
78
79 //create histograms
80
81 TH1F hOccupancy768("Occupancy768_L@layerL@ladderS@sensor@view", "Strip Occupancy of @layer.@ladder.@sensor @view/@side side", 768,
82 0,
83 768);
84 hOccupancy768.GetXaxis()->SetTitle("cellID");
85 TH1F hOccupancy512("Occupancy512_L@layerL@ladderS@sensor@view", "Strip Occupancy of @layer.@ladder.@sensor @view/@side side", 512,
86 0,
87 512);
88 hOccupancy512.GetXaxis()->SetTitle("cellID");
89 hm_occupancy = new SVDHistograms<TH1F>(hOccupancy768, hOccupancy768, hOccupancy768, hOccupancy512);
90
91 TH1F hHotStrips768("HotStrips768_L@layerL@ladderS@sensor@view", "Hot Strips of @layer.@ladder.@sensor @view/@side side", 768, 0,
92 768);
93 hHotStrips768.GetXaxis()->SetTitle("cellID");
94 TH1F hHotStrips512("HotStrips512_L@layerL@ladderS@sensor@view", "Hot Strips of @layer.@ladder.@sensor @view/@side side", 512, 0,
95 512);
96 hHotStrips512.GetXaxis()->SetTitle("cellID");
97 hm_hot_strips = new SVDHistograms<TH1F>(hHotStrips768, hHotStrips768, hHotStrips768, hHotStrips512);
98
99 TH1F hOccupancy_after768("OccupancyAfter768_L@layerL@ladderS@sensor@view",
100 "Non-Hot Strip Occupancy after HSF of @layer.@ladder.@sensor @view/@side side", 768, 0, 768);
101 hOccupancy_after768.GetXaxis()->SetTitle("cellID");
102 TH1F hOccupancy_after512("OccupancyAfter512_L@layerL@ladderS@sensor@view",
103 "Non-Hot Strip Occupancy after HSF of @layer.@ladder.@sensor @view/@side side", 512, 0, 512);
104 hOccupancy_after512.GetXaxis()->SetTitle("cellID");
105 hm_occupancy_after = new SVDHistograms<TH1F>(hOccupancy_after768, hOccupancy_after768, hOccupancy_after768, hOccupancy_after512);
106
107 TH1F hOccAll("occAll_L@layerL@ladderS@sensor@view", "Strip Occupancy Distribution of @layer.@ladder.@sensor @view/@side side", 1000,
108 0, 1);
109 hOccAll.GetXaxis()->SetTitle("occupancy");
110 hm_occAll = new SVDHistograms<TH1F>(hOccAll);
111
112 TH1F hOccHot("occHot_L@layerL@ladderS@sensor@view", "Hot Strip Occupancy Distribution of @layer.@ladder.@sensor @view/@side side",
113 10000, 0, 1);
114 hOccHot.GetXaxis()->SetTitle("occupancy");
115 hm_occHot = new SVDHistograms<TH1F>(hOccHot);
116
117 TH1F hOccAfter("occAfter_L@layerL@ladderS@sensor@view",
118 "Non-Hot Strip Occupancy Distribution of @layer.@ladder.@sensor @view/@side side", 1000, 0, 0.05);
119 hOccAfter.GetXaxis()->SetTitle("occupancy");
120 hm_occAfter = new SVDHistograms<TH1F>(hOccAfter);
121
122 //
123 TH1F hDist("dist_L@layerL@ladderS@sensor@view", "DSSD occupancy distribution of @layer.@ladder.@sensor @view/@side side", 100, 0,
124 0.05);
125 hDist.GetXaxis()->SetTitle("occupancy");
126 hm_dist = new SVDHistograms<TH1F>(hDist);
127
128 TH1F hDist1("dist1_L@layerL@ladderS@sensor@view", "DSSD true occupancy distribution of @layer.@ladder.@sensor @view/@side side",
129 100, 0, 0.05);
130 hm_dist1 = new SVDHistograms<TH1F>(hDist1);
131 hDist.GetXaxis()->SetTitle("occupancy");
132
133 TH2F hDist12("dist2d_L@layerL@ladderS@sensor@view",
134 "DSSD true vs sensor occupancy distribution of @layer.@ladder.@sensor @view/@side side", 1000, 0, 0.05, 1000, 0, 0.05);
135 hDist12.GetXaxis()->SetTitle("sensor occupancy");
136 hDist12.GetYaxis()->SetTitle("occupancy");
137 hm_dist12 = new SVDHistograms<TH2F>(hDist12);
138
139 //summary plot of the hot strips per sensor
140 m_hHotStripsSummary = new SVDSummaryPlots("hotStripsSummary@view", "Number of HotStrips on @view/@side Side");
141
142
143 // DQM style historgram number of hs vs sensor plane
144 h_tot_dqm = createHistogram1D("htodqm", "HS per sensor", 28, 0, 28.0, "HS per sensor", m_histoList_occu);
145 h_tot_dqm1 = createHistogram1D("htodqm1", "HS per sensor1", 350, 0, 350.0, "HS per sensor ", m_histoList_occu);
146
147 h_tot_dist = createHistogram1D("htotdist", "Occupancy distribution", 1000, 0, 0.05, "Relative occupancy", m_histoList_occu);
148 h_tot_dist1 = createHistogram1D("htotdist1", "True occupancy distribution", 1000, 0, 0.05, "occupancy", m_histoList_occu);
149 h_tot_dist12 = createHistogram2D("htotdist2d", "True vs sensor occupancy distribution", 1000, 0, 0.05, "sensor occupancy", 1000, 0,
150 0.05, "occupancy", m_histoList_occu);
151 h_nevents = createHistogram1D("hnevents", "Number of events", 1, 0, 1, "", m_histoList_occu);
152
153}
Belle2::SVDHistograms
template class for SVd histograms
Definition: SVDHistograms.h:24
Belle2::SVDHotStripFinderModule::createHistogram1D
TH1F * createHistogram1D(const char *name, const char *title, Int_t nbins, Double_t min, Double_t max, const char *xtitle, TList *histoList=nullptr)
create 1D histograms
Definition: SVDHotStripFinderModule.cc:591
Belle2::SVDHotStripFinderModule::hm_occupancy
SVDHistograms< TH1F > * hm_occupancy
strip occupancy per sensor
Definition: SVDHotStripFinderModule.h:105
Belle2::SVDHotStripFinderModule::hm_hot_strips
SVDHistograms< TH1F > * hm_hot_strips
hot strips per sensor
Definition: SVDHotStripFinderModule.h:106
Belle2::SVDHotStripFinderModule::hm_dist12
SVDHistograms< TH2F > * hm_dist12
true occupancy VS sensor histograms
Definition: SVDHotStripFinderModule.h:114
Belle2::SVDHotStripFinderModule::m_histoList_occu
TList * m_histoList_occu
occupancy for low charge clusters
Definition: SVDHotStripFinderModule.h:103
Belle2::SVDHotStripFinderModule::h_tot_dist1
TH1F * h_tot_dist1
absolute occupany histogram
Definition: SVDHotStripFinderModule.h:121
Belle2::SVDHotStripFinderModule::hm_dist1
SVDHistograms< TH1F > * hm_dist1
true occupancy histograms
Definition: SVDHotStripFinderModule.h:113
Belle2::SVDHotStripFinderModule::m_hHotStripsSummary
SVDSummaryPlots * m_hHotStripsSummary
hot strip summary histo
Definition: SVDHotStripFinderModule.h:116
Belle2::SVDHotStripFinderModule::hm_dist
SVDHistograms< TH1F > * hm_dist
occupancy histograms
Definition: SVDHotStripFinderModule.h:112
Belle2::SVDHotStripFinderModule::hm_occAll
SVDHistograms< TH1F > * hm_occAll
occupancy distribution - all strips
Definition: SVDHotStripFinderModule.h:108
Belle2::SVDHotStripFinderModule::h_nevents
TH1F * h_nevents
number of events counting
Definition: SVDHotStripFinderModule.h:123
Belle2::SVDHotStripFinderModule::h_tot_dist
TH1F * h_tot_dist
relative occupancy histogram
Definition: SVDHotStripFinderModule.h:120
Belle2::SVDHotStripFinderModule::hm_occAfter
SVDHistograms< TH1F > * hm_occAfter
occupancy distribution - not hot strips
Definition: SVDHotStripFinderModule.h:110
Belle2::SVDHotStripFinderModule::h_tot_dist12
TH2F * h_tot_dist12
2d distributiuons of occupancies
Definition: SVDHotStripFinderModule.h:122
Belle2::SVDHotStripFinderModule::hm_occHot
SVDHistograms< TH1F > * hm_occHot
occupancy distribution - hot strips
Definition: SVDHotStripFinderModule.h:109
Belle2::SVDHotStripFinderModule::h_tot_dqm
TH1F * h_tot_dqm
number of hot strips per sensor
Definition: SVDHotStripFinderModule.h:118
Belle2::SVDHotStripFinderModule::createHistogram2D
TH2F * createHistogram2D(const char *name, const char *title, Int_t nbinsX, Double_t minX, Double_t maxX, const char *titleX, Int_t nbinsY, Double_t minY, Double_t maxY, const char *titleY, TList *histoList=nullptr)
create 2D histograms
Definition: SVDHotStripFinderModule.cc:608
Belle2::SVDHotStripFinderModule::hm_occupancy_after
SVDHistograms< TH1F > * hm_occupancy_after
strip occupancy after removal of hot strips, per sensor
Definition: SVDHotStripFinderModule.h:107
Belle2::SVDHotStripFinderModule::h_tot_dqm1
TH1F * h_tot_dqm1
number of hot strips per sensor for layer 3
Definition: SVDHotStripFinderModule.h:119
Belle2::SVDSummaryPlots
class to summarize SVD quantities per sensor and side
Definition: SVDSummaryPlots.h:23

◆ 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{
181 ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
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}
Belle2::ModuleManager::registerModule
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.
Definition: ModuleManager.cc:80
Belle2::ModuleManager::Instance
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
Definition: ModuleManager.cc:24
Belle2::Module::getParamList
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
Belle2::Module::getName
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
Belle2::Module::getType
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
Belle2::Module::m_propertyFlags
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
Belle2::Module::m_logConfig
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
Belle2::Module::m_conditions
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
Belle2::Module::m_package
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
Belle2::ModulePtr
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ createHistogram1D()

TH1F * createHistogram1D ( const char *  name,
const char *  title,
Int_t  nbins,
Double_t  min,
Double_t  max,
const char *  xtitle,
TList *  histoList = nullptr 
)
private

create 1D histograms

Definition at line 591 of file SVDHotStripFinderModule.cc.

594{
595
596 TH1F* h = new TH1F(name, title, nbins, min, max);
597
598 h->GetXaxis()->SetTitle(xtitle);
599
600 if (histoList)
601 histoList->Add(h);
602
603
604 return h;
605}

◆ createHistogram2D()

TH2F * createHistogram2D ( const char *  name,
const char *  title,
Int_t  nbinsX,
Double_t  minX,
Double_t  maxX,
const char *  titleX,
Int_t  nbinsY,
Double_t  minY,
Double_t  maxY,
const char *  titleY,
TList *  histoList = nullptr 
)
private

create 2D histograms

thf

Definition at line 608 of file SVDHotStripFinderModule.cc.

613{
614
615 TH2F* h = new TH2F(name, title, nbinsX, minX, maxX, nbinsY, minY, maxY);
616 h->GetXaxis()->SetTitle(titleX);
617 h->GetYaxis()->SetTitle(titleY);
618
619 if (histoList)
620 histoList->Add(h);
621
622 return h;
623}

◆ 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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::terminate
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

Called once when a run ends.

Use this method to save run information, which you aggregated over the last run.

Reimplemented from Module.

Definition at line 180 of file SVDHotStripFinderModule.cc.

181{
182
183 int exp = m_eventMetaData->getExperiment();
184 int run = m_eventMetaData->getRun();
185
186 if (!m_useHSFinderV1) {
187
188 TDirectory* oldDir = nullptr;
189 TDirectory* dir_occuL[4] = {nullptr, nullptr, nullptr, nullptr};
190
191 //prepare ROOT FILE
192 if (m_rootFilePtr != nullptr) {
193 m_rootFilePtr->cd();
194 oldDir = gDirectory;
195 dir_occuL[0] = oldDir->mkdir("layer3");
196 dir_occuL[1] = oldDir->mkdir("layer4");
197 dir_occuL[2] = oldDir->mkdir("layer5");
198 dir_occuL[3] = oldDir->mkdir("layer6");
199 }
200
201 //Scale strip occupancy plots (per each sensor side) by the number of events. Fill SVDOccupancyCalibrations payload with the measured strip occupancy.
202
203 int hsflag[768]; //found hot strips list; hsflag[i]==1 for indetified Hot Strip
204 int nevents = h_nevents->GetEntries(); //number of events processed in events
205
206 //Define the DBObj pointers to create the needed payloads
207
208 DBImportObjPtr< SVDOccupancyCalibrations::t_payload> occDBObjPtr(SVDOccupancyCalibrations::name);
209 occDBObjPtr.construct(-99., Form("SVDOccupancy_exp%d_run%d_zs%1.1f", exp, run, m_zs));
210
211 DBImportObjPtr< SVDHotStripsCalibrations::t_payload> hotStripsDBObjPtr(SVDHotStripsCalibrations::name);
212 hotStripsDBObjPtr.construct(0, Form("SVDHotStrips_exp%d_run%d_zs%1.1f_absThr%f_relOccPrec%f", exp, run, m_zs, m_absThr,
213 m_relOccPrec));
214
215 B2RESULT("number of events " << nevents);
216
217 VXD::GeoCache& aGeometry = VXD::GeoCache::getInstance();
218 std::set<Belle2::VxdID> svdLayers = aGeometry.getLayers(VXD::SensorInfoBase::SVD);
219 std::set<Belle2::VxdID>::iterator itSvdLayers = svdLayers.begin();
220 while ((itSvdLayers != svdLayers.end())
221 && (itSvdLayers->getLayerNumber() != 7)) { //loop on Layers
222
223 std::set<Belle2::VxdID> svdLadders = aGeometry.getLadders(*itSvdLayers);
224 std::set<Belle2::VxdID>::iterator itSvdLadders = svdLadders.begin();
225
226 while (itSvdLadders != svdLadders.end()) { //loop on Ladders
227
228 std::set<Belle2::VxdID> svdSensors = aGeometry.getSensors(*itSvdLadders);
229 std::set<Belle2::VxdID>::iterator itSvdSensors = svdSensors.begin();
230
231 while (itSvdSensors != svdSensors.end()) { //loop on sensors
232
233 for (int k = 0; k < m_nSides; k ++) { //loop on Sides , k = isU(), k=0 is v-side, k=1 is u-side
234
235 /* we start indexing from 0 to avoid empty histograms */
236 int layer = itSvdSensors->getLayerNumber();
237 int ladder = itSvdSensors->getLadderNumber();
238 int sensor = itSvdSensors->getSensorNumber();
239
240 // int nafter =0; //number of good strips after first preselection cut
241 int nstrips = 768;
242 if (!k && layer != 3) nstrips = 512;
243
244 double stripOcc[768];
245 for (int i = 0; i < nstrips; i++) {stripOcc[i] = 0; hsflag[i] = 0;} //initialize vector to zero
246 double stripOccAfterAbsCut[768]; // vector of strip occupancy after first preselection based on absOccupThres cut
247 (hm_occupancy->getHistogram(*itSvdSensors, k))->Scale(1. / nevents);
248 for (int l = 0; l < nstrips; l++) {
249
250 //normalized to the total number of events to have the correct occupancy per strip and fill the corresponding dbobject
251
252 stripOcc[l] = (double)(hm_occupancy->getHistogram(*itSvdSensors, k)->GetBinContent(l + 1));
253
254 //0. Fill SVDOccupancyCalibrations Payload with the measured strip occupancy
255 occDBObjPtr->set(layer, ladder, sensor, k, l, stripOcc[l]);
256 hm_occAll->fill(*itSvdSensors, k, stripOcc[l]);
257
258 //1. Cut based on absOccupancyThreshold
259 if (stripOcc[l] > m_absThr) {
260 stripOccAfterAbsCut[l] = 0;
261 hsflag[l] = 1;
262 } else {
263 stripOccAfterAbsCut[l] = stripOcc[l];
264 hsflag[l] = 0;
265 }
266 B2DEBUG(1, "Measured strip occupancy for strip " << l << ":" << stripOccAfterAbsCut[l]);
267 }
268
269 // 2. flag hot strips that has occ_Strip > sensor average Occupancy * relOccPrec
270 bool moreHS = true;
271
272 while (moreHS && theHSFinder(stripOccAfterAbsCut, hsflag, nstrips)) {
273 moreHS = theHSFinder(stripOccAfterAbsCut, hsflag, nstrips);
274 }
275
276 //3. after second step: fill HS histograms and occupancy histograms of survived strips; fill HS payload, SVDHotStripsCalibrations
277 for (int l = 0; l < nstrips; l++) {
278 hotStripsDBObjPtr->set(layer, ladder, sensor, k, l, (int)hsflag[l]);
279 if (hsflag[l] == 0) {
280 hm_occupancy_after->getHistogram(*itSvdSensors, k)->SetBinContent(l + 1, stripOccAfterAbsCut[l]);
281 hm_occAfter->fill(*itSvdSensors, k, stripOccAfterAbsCut[l]);
282 } else {
283 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetBinContent(l + 1, 1);
284 hm_occHot->fill(*itSvdSensors, k, stripOcc[l]);
285
286 TString aux_side = "V/N";
287 if (k) aux_side = "U/P";
288 if (m_verbose) B2RESULT("HS found, occupancy = " << stripOcc[l] << ", Layer: " << layer << " Ladder: " << ladder << " Sensor: "
289 << sensor <<
290 " Side: " << k << " channel: " << l);
291
292 }
293
294 }
295
296 for (int s = 0; s < hm_hot_strips->getHistogram(*itSvdSensors, k)->GetEntries(); s++)
297 m_hHotStripsSummary->fill(*itSvdSensors, k, 1);
298
299 if (m_rootFilePtr != nullptr) {
300 dir_occuL[layer - 3]->cd();
301 hm_occupancy->getHistogram(*itSvdSensors, k)->Write();
302 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetLineColor(kBlack);
303 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetMarkerColor(kBlack);
304 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetFillStyle(3001);
305 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetFillColor(kBlack);
306 hm_hot_strips->getHistogram(*itSvdSensors, k)->Write();
307 hm_occupancy_after->getHistogram(*itSvdSensors, k)->SetLineColor(kRed);
308 hm_occupancy_after->getHistogram(*itSvdSensors, k)->SetMarkerColor(kRed);
309 hm_occupancy_after->getHistogram(*itSvdSensors, k)->Write();
310 hm_occAll->getHistogram(*itSvdSensors, k)->Write();
311 hm_occHot->getHistogram(*itSvdSensors, k)->SetLineColor(kBlack);
312 hm_occHot->getHistogram(*itSvdSensors, k)->SetFillStyle(3001);
313 hm_occHot->getHistogram(*itSvdSensors, k)->SetFillColor(kBlack);
314 hm_occHot->getHistogram(*itSvdSensors, k)->SetMarkerColor(kBlack);
315 hm_occHot->getHistogram(*itSvdSensors, k)->Write();
316 hm_occAfter->getHistogram(*itSvdSensors, k)->SetLineColor(kRed);
317 hm_occAfter->getHistogram(*itSvdSensors, k)->SetMarkerColor(kRed);
318 hm_occAfter->getHistogram(*itSvdSensors, k)->Write();
319 }
320
321 B2DEBUG(1, " L" << layer << "." << ladder << "." << sensor << ".isU=" << k);
322
323 }
324 ++itSvdSensors;
325 }
326 ++itSvdLadders;
327 }
328 ++itSvdLayers;
329 }
330
331 if (m_rootFilePtr != nullptr) {
332 oldDir->cd();
333 m_hHotStripsSummary->getHistogram(0)->Write();
334 m_hHotStripsSummary->getHistogram(1)->Write();
335 m_rootFilePtr->Close();
336 }
337
338 //import the filled dbobjects to the ConditionDB
339 if (m_firstExp == -1)
340 m_firstExp = exp;
341 if (m_lastExp == -1)
342 m_lastExp = exp;
343 if (m_firstRun == -1)
344 m_firstRun = run;
345 if (m_lastRun == -1)
346 m_lastRun = run;
347
348 IntervalOfValidity iov(m_firstExp, m_firstRun, m_lastExp, m_lastRun);
349 occDBObjPtr.import(iov);
350 hotStripsDBObjPtr.import(iov);
351 B2RESULT("Imported to database.");
352 }
353}
Belle2::DBImportObjPtr
Class for importing a single object to the database.
Definition: DBImportObjPtr.h:23
Belle2::IntervalOfValidity
A class that describes the interval of experiments/runs for which an object in the database is valid.
Definition: IntervalOfValidity.h:25
Belle2::SVDHistograms::fill
void fill(const VxdID &vxdID, int view, Types ... args)
fill the histogram for
Definition: SVDHistograms.h:77
Belle2::SVDHistograms::getHistogram
H * getHistogram(const VxdID &vxdID, int view)
get a reference to the histogram for
Definition: SVDHistograms.h:56
Belle2::SVDHotStripFinderModule::theHSFinder
bool theHSFinder(double *stripOccAfterAbsCut, int *hsflag, int nstrips)
return true if the strip is hot
Definition: SVDHotStripFinderModule.cc:626
Belle2::SVDHotStripFinderModule::m_nSides
static const int m_nSides
number of sides
Definition: SVDHotStripFinderModule.h:101
Belle2::SVDHotStripFinderModule::m_eventMetaData
StoreObjPtr< EventMetaData > m_eventMetaData
event meta data store array
Definition: SVDHotStripFinderModule.h:77
Belle2::SVDHotStripFinderModule::m_rootFilePtr
TFile * m_rootFilePtr
pointer at root file used for storing histograms
Definition: SVDHotStripFinderModule.h:88
Belle2::SVDHotStripsCalibrations::name
static std::string name
name of the SVDHotStripsCalibrations payload
Definition: SVDHotStripsCalibrations.h:34
Belle2::SVDOccupancyCalibrations::name
static std::string name
name of the ccupancy payload
Definition: SVDOccupancyCalibrations.h:32
Belle2::SVDSummaryPlots::fill
void fill(int layer, int ladder, int sensor, int view, float value)
fill the histogram for
Definition: SVDSummaryPlots.h:107
Belle2::SVDSummaryPlots::getHistogram
TH2F * getHistogram(int view)
get a reference to the histogram for
Definition: SVDSummaryPlots.h:63
Belle2::VXD::GeoCache
Class to faciliate easy access to sensor information of the VXD like coordinate transformations or pi...
Definition: GeoCache.h:39
Belle2::VXD::GeoCache::getLayers
const std::set< Belle2::VxdID > getLayers(SensorInfoBase::SensorType sensortype=SensorInfoBase::VXD)
Return a set of all known Layers.
Definition: GeoCache.cc:176
Belle2::VXD::GeoCache::getSensors
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
Belle2::VXD::GeoCache::getInstance
static GeoCache & getInstance()
Return a reference to the singleton instance.
Definition: GeoCache.cc:214
Belle2::VXD::GeoCache::getLadders
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

◆ 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}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition: Module.h:519
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

Called once for each event.

This is most likely where your module will actually do anything.

Reimplemented from Module.

Definition at line 155 of file SVDHotStripFinderModule.cc.

156{
157
158 int nDigits = m_storeDigits.getEntries();
159 h_nevents->Fill(0.0); // number of events count
160
161 if (nDigits == 0)
162 return;
163
164 //loop over the SVDShaperDigits
165 int i = 0;
166 while (i < nDigits) {
167 VxdID theVxdID = m_storeDigits[i]->getSensorID();
168 int side = m_storeDigits[i]->isUStrip();
169 int CellID = m_storeDigits[i]->getCellID();
170
171 hm_occupancy->fill(theVxdID, side, CellID);
172
173 i++;
174 }
175
176
177
178}
Belle2::SVDHotStripFinderModule::m_storeDigits
StoreArray< SVDShaperDigit > m_storeDigits
shaper digits store array
Definition: SVDHotStripFinderModule.h:76
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:33

◆ 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")
350 .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
351 .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
352 .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
353 .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
354 .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
355 .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
491 &Module::setLogConfig)
Belle2::ModuleCondition::c_GE
@ c_GE
Greater or equal than: ">=".
Definition: ModuleCondition.h:35
Belle2::ModuleCondition::c_SE
@ c_SE
Smaller or equal than: "<=".
Definition: ModuleCondition.h:36
Belle2::ModuleCondition::c_GT
@ c_GT
Greater than: ">"
Definition: ModuleCondition.h:33
Belle2::ModuleCondition::c_NE
@ c_NE
Not equal: "!=".
Definition: ModuleCondition.h:38
Belle2::ModuleCondition::c_EQ
@ c_EQ
Equal: "=" or "=="
Definition: ModuleCondition.h:37
Belle2::ModuleCondition::c_ST
@ c_ST
Smaller than: "<"
Definition: ModuleCondition.h:34
Belle2::Module
Base class for Modules.
Definition: Module.h:72
Belle2::Module::getLogConfig
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
Belle2::Module::if_value
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
Belle2::Module::setPropertyFlags
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Belle2::Module::if_true
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
Belle2::Module::setReturnValue
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
Belle2::Module::setLogConfig
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
Belle2::Module::getDescription
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
Belle2::Module::if_false
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
Belle2::Module::hasCondition
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
Belle2::Module::getPackage
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
Belle2::Module::setName
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
Belle2::Module::hasProperties
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
Belle2::Module::getPathString
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

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

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


Definition at line 113 of file Module.cc.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
Belle2::PathPtr
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;}
Belle2::Module::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;}
Belle2::Module::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{
281 return m_moduleParamList.getParamInfoListPython();
282}
Belle2::ModuleParamList::getParamInfoListPython
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
Definition: ModuleParamList.cc:64
Belle2::Module::m_moduleParamList
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}
Belle2::Module::m_type
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{
168 auto missing = m_moduleParamList.getUnsetForcedParams();
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}
Belle2::ModuleParamList::getUnsetForcedParams
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.
Definition: ModuleParamList.cc:54

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

Use this to initialize resources or memory your module needs.

Also register any outputs of your module (StoreArrays, StoreObjPtrs, relations) here, see the respective class documentation for details.

Reimplemented from Module.

Definition at line 60 of file SVDHotStripFinderModule.cc.

61{
62
63 m_eventMetaData.isRequired();
64 m_storeDigits.isRequired(m_ShaperDigitName);
65
66 B2DEBUG(25, " ShaperDigits: " << m_ShaperDigitName);
67
68 m_histoList_occu = new TList;
69
70 m_rootFilePtr = new TFile(m_rootFileName.c_str(), "RECREATE");
71 if (m_useHSFinderV1)
72 B2RESULT("You are using the first version of the HSFinder algorithm (see SVDHotStripFinder::terminate in the module)");
73 else B2RESULT("You are using the modified version of the HSFinder algorithm (see SVDHotStripFinder::endRun in the module)");
74
75}

◆ 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}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Belle2::LogConfig::setAbortLevel
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}
Belle2::LogConfig::setDebugLevel
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}
Belle2::LogConfig::setLogInfo
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}
Belle2::LogConfig::setLogLevel
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 {
239 m_moduleParamList.setParamPython(name, pyObj);
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}
Belle2::LogSystem
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
Belle2::LogSystem::updateModule
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
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition: ModuleParamList.templateDetails.h:104

◆ 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}
Belle2::Module::setParamPython
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()

void terminate ( void  )
overridevirtual

Clean up anything you created in initialize().

Reimplemented from Module.

Definition at line 355 of file SVDHotStripFinderModule.cc.

356{
357 if (m_useHSFinderV1) {
358 TDirectory* oldDir = nullptr;
359
360 TDirectory* dir_occuL[4] = {nullptr, nullptr, nullptr, nullptr};
361
362 //prepare ROOT FILE
363 if (m_rootFilePtr != nullptr) {
364 m_rootFilePtr->cd();
365 oldDir = gDirectory;
366 dir_occuL[0] = oldDir->mkdir("layer3");
367 dir_occuL[1] = oldDir->mkdir("layer4");
368 dir_occuL[2] = oldDir->mkdir("layer5");
369 dir_occuL[3] = oldDir->mkdir("layer6");
370 }
371
372 /**************************************************************************
373 * Hotstrips finding algorithm *
374 ***************************************************************************/
375
376
377 //Find low charged clusters with high occupancy.
378 int flag[768]; // list of working (non zero) strips
379 int hsflag[768]; //found hot strips list; hsflag[i]==1 for indetified Hot Strip
380 int nevents = h_nevents->GetEntries(); //number of events processed in events
381 int ibase = 768; // interval used for the hot strip finding
382 if (m_base != -1)
383 ibase = m_base;
384
385 B2DEBUG(1, "number of events " << nevents);
386
387 VXD::GeoCache& aGeometry = VXD::GeoCache::getInstance();
388 std::set<Belle2::VxdID> svdLayers = aGeometry.getLayers(VXD::SensorInfoBase::SVD);
389 std::set<Belle2::VxdID>::iterator itSvdLayers = svdLayers.begin();
390 int itsensor = 0; //sensor numbering
391 while ((itSvdLayers != svdLayers.end())
392 && (itSvdLayers->getLayerNumber() != 7)) { //loop on Layers
393
394 std::set<Belle2::VxdID> svdLadders = aGeometry.getLadders(*itSvdLayers);
395 std::set<Belle2::VxdID>::iterator itSvdLadders = svdLadders.begin();
396
397 while (itSvdLadders != svdLadders.end()) { //loop on Ladders
398
399 std::set<Belle2::VxdID> svdSensors = aGeometry.getSensors(*itSvdLadders);
400 std::set<Belle2::VxdID>::iterator itSvdSensors = svdSensors.begin();
401
402 while (itSvdSensors != svdSensors.end()) { //loop on sensors
403
404 for (int k = 0; k < m_nSides; k ++) { //loop on Sides
405
406 // we start indexing from 0 to avoid empty histograms
407 int i = itSvdSensors->getLayerNumber() - 3;
408 int m = itSvdSensors->getLadderNumber() - 1;
409 int j = itSvdSensors->getSensorNumber() - 1;
410 float position1[768]; // vector of hits in the sensor
411 float nCltrk[24]; // index to interval if we search in smaller intervals then full sensor
412 int it = 0;
413 int iths = 0;
414 // it is safer to initialize the nCltrk vector
415 for (int l = 0; l < 24; l++) {
416 nCltrk[l] = 0.0;
417 }
418
419 for (int l = 0; l < 768; l++) {
420
421 position1[l] = hm_occupancy->getHistogram(*itSvdSensors, k)->GetBinContent(l + 1);
422 //if no hits in strip, mark the strip as bad
423
424 if (position1[l] == 0) { flag[l] = 0;}
425 else {
426 flag[l] = 1;
427 it++; //number of good (non zero ) strips
428 // find in which interval the strip lays
429 div_t test = div(l, ibase);
430 nCltrk[test.quot] = nCltrk[test.quot] + position1[l]; // number of entries in given interval
431 }
432
433 }
434
435 for (int l = 0; l < 768; l++) {
436 div_t test = div(l, ibase);
437
438 // tmp_occ - relative occupancy for Hot Strip search interval, for channel l
439 // tmp_occ1 - occupancy
440
441 float tmp_occ = position1[l] / (float)nCltrk[test.quot]; //for hot strip search
442 float tmp_occ1 = position1[l] / (float)nevents; //for SVDOccupancyCalibration
443 position1[l] = tmp_occ; //vector used for Hot strip search<
444 if (tmp_occ > 0.0) {
445 hm_dist->fill(*itSvdSensors, k, tmp_occ); // ..
446 h_tot_dist->Fill(tmp_occ);
447 hm_dist1->fill(*itSvdSensors, k, tmp_occ1); //occupancy as probablity to fire the strip
448 h_tot_dist1->Fill(tmp_occ1);
449 hm_dist12->fill(*itSvdSensors, k, tmp_occ, tmp_occ1); // 2D distribution
450 h_tot_dist12->Fill(tmp_occ, tmp_occ1);
451 }
452 }
453 float occupancy[24]; //occupancy for second pass
454 for (int l = 0; l < 24; l++) {
455 occupancy[l] = 0.0;
456 }
457 int it1st = it; //first pass:number of good strips
458 it = 0;
459 // first pass
460 for (int l = 0; l < 768; l++) {
461 div_t test = div(l, ibase);
462 float threshold_corrections = 1.0;
463 /*
464 threshold is corrected by the real number of alive strips
465 */
466 threshold_corrections = threshold_corrections * sqrt(768.0 / (float)it1st);
467 if (ibase == 32) threshold_corrections = 24.0;
468 if (ibase == 64) threshold_corrections = 12.0;
469 if (ibase == 128) threshold_corrections = 6.0;
470
471 if (position1[l] > 0.01 * m_thr * threshold_corrections) { // if probablity is larger then threshold mark as Hot strip
472 hsflag[l] = 1; // HS vector
473 flag[l] = 0; // mark strip as bad for second pass
474 iths++;
475 B2RESULT("1st pass HS found! Layer: " << i + 3 << " Ladder: " << m << " Sensor: " << j << " Side: " << k << " channel: " << l);
476 } else {
477 hsflag[l] = 0; // not a HS
478 //recalculate the occupancy in DSSD only for good strip after first pass
479 occupancy[test.quot] = occupancy[test.quot] + hm_occupancy->getHistogram(*itSvdSensors, k)->GetBinContent(l + 1);
480 it++; //number of good strips after first pass
481 }
482
483 }
484 /*
485 Second pass of Hot strip finder, After the first pass we remove already found Host strips we do the second pass with the same threshold
486 */
487 // second pass
488 for (int l = 0; l < 768; l++) {
489 div_t test = div(l, ibase);
490 position1[l] = position1[l] * nCltrk[test.quot] / (float)occupancy[test.quot];
491 float threshold_corrections = 1.0;
492 threshold_corrections = threshold_corrections * sqrt(768.0 / (float)it);
493 if (ibase == 32) threshold_corrections = 24.0;
494 if (ibase == 64) threshold_corrections = 12.0;
495 if (ibase == 128) threshold_corrections = 6.0;
496
497 if ((flag[l]) && (position1[l] > 0.01 * m_thr * threshold_corrections)) { //HS
498 hsflag[l] = 1;// HS vector
499 flag[l] = 0; // mark strip as bad after second pass
500 iths++;
501 B2RESULT("2nd pass HS FOUND! Layer: " << i + 3 << " Ladder: " << m << " Sensor: " << j << " Side: " << k << " channel: " << l);
502 }
503 }
504 // for Laura .. HS flags, place interface for DB
505 // outputs : hsflag[l] 1- HS 0- non HS, flag[l] 0- bad strip, 1 working strip, h_tot_dist1 occupancy as probablity of firing the strip
506
507
508 for (int l = 0; l < 768; l++) {
509
510 B2DEBUG(1, hsflag[l]);
511
512 float tmpOcc = hm_occupancy->getHistogram(*itSvdSensors, k)->GetBinContent(l + 1) / (double)nevents;
513 hm_occAll->fill(*itSvdSensors, k, tmpOcc);
514
515 if (hsflag[l] == 0) {
516 hm_occupancy_after->getHistogram(*itSvdSensors, k)->SetBinContent(l + 1, tmpOcc); //alive strips without identified HS
517 hm_occAfter->fill(*itSvdSensors, k, tmpOcc);
518 } else {
519 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetBinContent(l + 1, 1);
520 hm_occHot->fill(*itSvdSensors, k, tmpOcc);
521 }
522 }
523
524 if (m_rootFilePtr != nullptr) {
525 hm_occupancy->getHistogram(*itSvdSensors, k)->Scale(1.0 / (double)nevents);
526
527 dir_occuL[i]->cd();
528 hm_occupancy->getHistogram(*itSvdSensors, k)->Write();
529 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetLineColor(kBlack);
530 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetFillStyle(3001);
531 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetFillColor(kBlack);
532 hm_hot_strips->getHistogram(*itSvdSensors, k)->SetMarkerColor(kBlack);
533 hm_hot_strips->getHistogram(*itSvdSensors, k)->Write();
534 hm_occupancy_after->getHistogram(*itSvdSensors, k)->SetLineColor(kRed);
535 hm_occupancy_after->getHistogram(*itSvdSensors, k)->SetMarkerColor(kRed);
536 hm_occupancy_after->getHistogram(*itSvdSensors, k)->Write();
537 hm_occAll->getHistogram(*itSvdSensors, k)->Write();
538 hm_occHot->getHistogram(*itSvdSensors, k)->SetLineColor(kBlack);
539 hm_occHot->getHistogram(*itSvdSensors, k)->SetFillStyle(3001);
540 hm_occHot->getHistogram(*itSvdSensors, k)->SetFillColor(kBlack);
541 hm_occHot->getHistogram(*itSvdSensors, k)->SetMarkerColor(kBlack);
542 hm_occHot->getHistogram(*itSvdSensors, k)->Write();
543 hm_occAfter->getHistogram(*itSvdSensors, k)->SetLineColor(kRed);
544 hm_occAfter->getHistogram(*itSvdSensors, k)->SetMarkerColor(kRed);
545 hm_occAfter->getHistogram(*itSvdSensors, k)->Write();
546 // hm_dist12->getHistogram(*itSvdSensors, k)->Write();
547 }
548
549 B2DEBUG(1, " side " << i << " " << j << " " << m << " " << k);
550 /* end */
551
552
553 // store number hot strips per sensor
554
555
556 for (int iy = 0; iy < iths; iy++) {
557 h_tot_dqm->Fill(float(itsensor));
558 h_tot_dqm1->Fill(float(itsensor));
559 }
560
561 for (int s = 0; s < hm_hot_strips->getHistogram(*itSvdSensors, k)->GetEntries(); s++)
562 m_hHotStripsSummary->fill(*itSvdSensors, k, 1);
563
564 itsensor++;
565 }
566 ++itSvdSensors;
567 }
568 ++itSvdLadders;
569 }
570 ++itSvdLayers;
571
572 }
573
574 if (m_rootFilePtr != nullptr) {
575 oldDir->cd();
576
577 m_hHotStripsSummary->getHistogram(0)->Write();
578 m_hHotStripsSummary->getHistogram(1)->Write();
579
580 TObject* obj;
581 TIter nextH_occu(m_histoList_occu);
582 while ((obj = nextH_occu()))
583 obj->Write();
584
585 m_rootFilePtr->Close();
586 }
587
588 }
589}
Belle2::sqrt
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28

◆ theHSFinder()

bool theHSFinder ( double *  stripOccAfterAbsCut,
int *  hsflag,
int  nstrips 
)
private

return true if the strip is hot

Definition at line 626 of file SVDHotStripFinderModule.cc.

627{
628 bool found = false;
629
630 if (m_base == -1)
631 m_base = nstrips;
632
633 int N = nstrips / m_base;
634
635 for (int sector = 0; sector < N; sector++) {
636
637 int nafter = 0;
638 double sensorOccAverage = 0;
639
640 for (int l = sector * m_base; l < sector * m_base + m_base; l++) {
641 sensorOccAverage = sensorOccAverage + stripOccAfterAbsCut[l];
642 if (stripOccAfterAbsCut[l] > 0) nafter++;
643 }
644 sensorOccAverage = sensorOccAverage / nafter;
645
646 B2DEBUG(1, "Average occupancy: " << sensorOccAverage);
647
648 for (int l = sector * m_base; l < sector * m_base + m_base; l++) {
649
650 // flag additional HS by comparing each strip occupancy with the sensor-based average occupancy
651
652 if (stripOccAfterAbsCut[l] > sensorOccAverage * m_relOccPrec) {
653 hsflag[l] = 1;
654 found = true;
655 stripOccAfterAbsCut[l] = 0;
656 }
657 // else hsflag[l]=0;
658 }
659 }
660
661 return found;
662}

Member Data Documentation

◆ h_nevents

TH1F* h_nevents = nullptr
private

number of events counting

Definition at line 123 of file SVDHotStripFinderModule.h.

◆ h_tot_dist

TH1F* h_tot_dist = nullptr
private

relative occupancy histogram

Definition at line 120 of file SVDHotStripFinderModule.h.

◆ h_tot_dist1

TH1F* h_tot_dist1 = nullptr
private

absolute occupany histogram

Definition at line 121 of file SVDHotStripFinderModule.h.

◆ h_tot_dist12

TH2F* h_tot_dist12 = nullptr
private

2d distributiuons of occupancies

Definition at line 122 of file SVDHotStripFinderModule.h.

◆ h_tot_dqm

TH1F* h_tot_dqm = nullptr
private

number of hot strips per sensor

Definition at line 118 of file SVDHotStripFinderModule.h.

◆ h_tot_dqm1

TH1F* h_tot_dqm1 = nullptr
private

number of hot strips per sensor for layer 3

Definition at line 119 of file SVDHotStripFinderModule.h.

◆ hm_dist

SVDHistograms<TH1F>* hm_dist = nullptr
private

occupancy histograms

Definition at line 112 of file SVDHotStripFinderModule.h.

◆ hm_dist1

SVDHistograms<TH1F>* hm_dist1 = nullptr
private

true occupancy histograms

Definition at line 113 of file SVDHotStripFinderModule.h.

◆ hm_dist12

SVDHistograms<TH2F>* hm_dist12 = nullptr
private

true occupancy VS sensor histograms

Definition at line 114 of file SVDHotStripFinderModule.h.

◆ hm_hot_strips

SVDHistograms<TH1F>* hm_hot_strips = nullptr
private

hot strips per sensor

Definition at line 106 of file SVDHotStripFinderModule.h.

◆ hm_occAfter

SVDHistograms<TH1F>* hm_occAfter = nullptr
private

occupancy distribution - not hot strips

Definition at line 110 of file SVDHotStripFinderModule.h.

◆ hm_occAll

SVDHistograms<TH1F>* hm_occAll = nullptr
private

occupancy distribution - all strips

Definition at line 108 of file SVDHotStripFinderModule.h.

◆ hm_occHot

SVDHistograms<TH1F>* hm_occHot = nullptr
private

occupancy distribution - hot strips

Definition at line 109 of file SVDHotStripFinderModule.h.

◆ hm_occupancy

SVDHistograms<TH1F>* hm_occupancy = nullptr
private

strip occupancy per sensor

Definition at line 105 of file SVDHotStripFinderModule.h.

◆ hm_occupancy_after

SVDHistograms<TH1F>* hm_occupancy_after = nullptr
private

strip occupancy after removal of hot strips, per sensor

Definition at line 107 of file SVDHotStripFinderModule.h.

◆ m_absThr

float m_absThr
private

Absolute Occupancy Threshold cut for Hot strip finder.

Definition at line 83 of file SVDHotStripFinderModule.h.

◆ m_base

int m_base
private

base

Definition at line 81 of file SVDHotStripFinderModule.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_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData
private

event meta data store array

Definition at line 77 of file SVDHotStripFinderModule.h.

◆ m_firstExp

int m_firstExp
private

first valid experiment

Definition at line 92 of file SVDHotStripFinderModule.h.

◆ m_firstRun

int m_firstRun
private

first valid run

Definition at line 93 of file SVDHotStripFinderModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hHotStripsSummary

SVDSummaryPlots* m_hHotStripsSummary = nullptr
private

hot strip summary histo

Definition at line 116 of file SVDHotStripFinderModule.h.

◆ m_histoList_occu

TList* m_histoList_occu = nullptr
private

occupancy for low charge clusters

Definition at line 103 of file SVDHotStripFinderModule.h.

◆ m_lastExp

int m_lastExp
private

last valid experiment

Definition at line 94 of file SVDHotStripFinderModule.h.

◆ m_lastRun

int m_lastRun
private

last valid run

Definition at line 95 of file SVDHotStripFinderModule.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_nLadders

const int m_nLadders = 16
staticprivate

max number of ladders

Definition at line 99 of file SVDHotStripFinderModule.h.

◆ m_nLayers

const int m_nLayers = 4
staticprivate

number of layers

Definition at line 98 of file SVDHotStripFinderModule.h.

◆ m_nSensors

const int m_nSensors = 5
staticprivate

max number of sensors

Definition at line 100 of file SVDHotStripFinderModule.h.

◆ m_nSides

const int m_nSides = 2
staticprivate

number of sides

Definition at line 101 of file SVDHotStripFinderModule.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 510 of file Module.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

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

Definition at line 512 of file Module.h.

◆ m_relOccPrec

float m_relOccPrec
private

Relative precision on occupancy which is defined to be negligible for the hit background rate estimate.

Definition at line 84 of file SVDHotStripFinderModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_rootFileName

std::string m_rootFileName
private

root file name

Definition at line 78 of file SVDHotStripFinderModule.h.

◆ m_rootFilePtr

TFile* m_rootFilePtr = nullptr
private

pointer at root file used for storing histograms

Definition at line 88 of file SVDHotStripFinderModule.h.

◆ m_ShaperDigitName

std::string m_ShaperDigitName
private

shaper digits name

Definition at line 79 of file SVDHotStripFinderModule.h.

◆ m_storeDigits

StoreArray<SVDShaperDigit> m_storeDigits
private

shaper digits store array

Definition at line 76 of file SVDHotStripFinderModule.h.

◆ m_thr

float m_thr
private

threshold

Definition at line 80 of file SVDHotStripFinderModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_useHSFinderV1

bool m_useHSFinderV1 = true
private

use V1 finder

Definition at line 82 of file SVDHotStripFinderModule.h.

◆ m_verbose

bool m_verbose
private

False by default, it allows to switch on the printing of all found HS.

Definition at line 85 of file SVDHotStripFinderModule.h.

◆ m_zs

float m_zs
private

zero suppression cut for the input shaper digits

Definition at line 91 of file SVDHotStripFinderModule.h.

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