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

A module template. More...

#include <SVDHotStripFinderModule.h>

Inheritance diagram for SVDHotStripFinderModule:
Collaboration diagram for SVDHotStripFinderModule:

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

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

TH1F * createHistogram1D (const char *name, const char *title, Int_t nbins, Double_t min, Double_t max, const char *xtitle, TList *histoList=nullptr)
 thf
 
bool theHSFinder (double *stripOccAfterAbsCut, int *hsflag, int nstrips)
 
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)
 thf
 
std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Private Attributes

StoreArray< SVDShaperDigitm_storeDigits
 shaper digits store array
 
StoreObjPtr< EventMetaDatam_eventMetaData
 event meta data store array
 
std::string m_rootFileName
 root file name
 
std::string m_ShaperDigitName
 shaper digits name
 
float m_thr
 
int m_base
 
bool m_useHSFinderV1 = true
 
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
 
SVDHistograms< TH1F > * hm_dist1 = nullptr
 
SVDHistograms< TH2F > * hm_dist12 = nullptr
 
SVDSummaryPlotsm_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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Static Private Attributes

static const int m_nLayers = 4
 
static const int m_nLadders = 16
 
static const int m_nSensors = 5
 
static const int m_nSides = 2
 

Detailed Description

A module template.

A detailed description of your module.

Definition at line 33 of file SVDHotStripFinderModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 79 of file Module.h.

Member Function Documentation

◆ beginRun()

void beginRun ( )
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 69 of file SVDHotStripFinderModule.cc.

70 {
71 
72  //create histograms
73 
74  TH1F hOccupancy768("Occupancy768_L@layerL@ladderS@sensor@view", "Strip Occupancy of @layer.@ladder.@sensor @view/@side side", 768,
75  0,
76  768);
77  hOccupancy768.GetXaxis()->SetTitle("cellID");
78  TH1F hOccupancy512("Occupancy512_L@layerL@ladderS@sensor@view", "Strip Occupancy of @layer.@ladder.@sensor @view/@side side", 512,
79  0,
80  512);
81  hOccupancy512.GetXaxis()->SetTitle("cellID");
82  hm_occupancy = new SVDHistograms<TH1F>(hOccupancy768, hOccupancy768, hOccupancy768, hOccupancy512);
83 
84  TH1F hHotStrips768("HotStrips768_L@layerL@ladderS@sensor@view", "Hot Strips of @layer.@ladder.@sensor @view/@side side", 768, 0,
85  768);
86  hHotStrips768.GetXaxis()->SetTitle("cellID");
87  TH1F hHotStrips512("HotStrips512_L@layerL@ladderS@sensor@view", "Hot Strips of @layer.@ladder.@sensor @view/@side side", 512, 0,
88  512);
89  hHotStrips512.GetXaxis()->SetTitle("cellID");
90  hm_hot_strips = new SVDHistograms<TH1F>(hHotStrips768, hHotStrips768, hHotStrips768, hHotStrips512);
91 
92  TH1F hOccupancy_after768("OccupancyAfter768_L@layerL@ladderS@sensor@view",
93  "Non-Hot Strip Occupancy after HSF of @layer.@ladder.@sensor @view/@side side", 768, 0, 768);
94  hOccupancy_after768.GetXaxis()->SetTitle("cellID");
95  TH1F hOccupancy_after512("OccupancyAfter512_L@layerL@ladderS@sensor@view",
96  "Non-Hot Strip Occupancy after HSF of @layer.@ladder.@sensor @view/@side side", 512, 0, 512);
97  hOccupancy_after512.GetXaxis()->SetTitle("cellID");
98  hm_occupancy_after = new SVDHistograms<TH1F>(hOccupancy_after768, hOccupancy_after768, hOccupancy_after768, hOccupancy_after512);
99 
100  TH1F hOccAll("occAll_L@layerL@ladderS@sensor@view", "Strip Occupancy Distribution of @layer.@ladder.@sensor @view/@side side", 1000,
101  0, 1);
102  hOccAll.GetXaxis()->SetTitle("occupancy");
103  hm_occAll = new SVDHistograms<TH1F>(hOccAll);
104 
105  TH1F hOccHot("occHot_L@layerL@ladderS@sensor@view", "Hot Strip Occupancy Distribution of @layer.@ladder.@sensor @view/@side side",
106  10000, 0, 1);
107  hOccHot.GetXaxis()->SetTitle("occupancy");
108  hm_occHot = new SVDHistograms<TH1F>(hOccHot);
109 
110  TH1F hOccAfter("occAfter_L@layerL@ladderS@sensor@view",
111  "Non-Hot Strip Occupancy Distribution of @layer.@ladder.@sensor @view/@side side", 1000, 0, 0.05);
112  hOccAfter.GetXaxis()->SetTitle("occupancy");
113  hm_occAfter = new SVDHistograms<TH1F>(hOccAfter);
114 
115  //
116  TH1F hDist("dist_L@layerL@ladderS@sensor@view", "DSSD occupancy distribution of @layer.@ladder.@sensor @view/@side side", 100, 0,
117  0.05);
118  hDist.GetXaxis()->SetTitle("occupancy");
119  hm_dist = new SVDHistograms<TH1F>(hDist);
120 
121  TH1F hDist1("dist1_L@layerL@ladderS@sensor@view", "DSSD true occupancy distribution of @layer.@ladder.@sensor @view/@side side",
122  100, 0, 0.05);
123  hm_dist1 = new SVDHistograms<TH1F>(hDist1);
124  hDist.GetXaxis()->SetTitle("occupancy");
125 
126  TH2F hDist12("dist2d_L@layerL@ladderS@sensor@view",
127  "DSSD true vs sensor occupancy distribution of @layer.@ladder.@sensor @view/@side side", 1000, 0, 0.05, 1000, 0, 0.05);
128  hDist12.GetXaxis()->SetTitle("sensor occupancy");
129  hDist12.GetYaxis()->SetTitle("occupancy");
130  hm_dist12 = new SVDHistograms<TH2F>(hDist12);
131 
132  //summary plot of the hot strips per sensor
133  m_hHotStripsSummary = new SVDSummaryPlots("hotStripsSummary@view", "Number of HotStrips on @view/@side Side");
134 
135 
136  // DQM style historgram number of hs vs sensor plane
137  h_tot_dqm = createHistogram1D("htodqm", "HS per sensor", 28, 0, 28.0, "HS per sensor", m_histoList_occu);
138  h_tot_dqm1 = createHistogram1D("htodqm1", "HS per sensor1", 350, 0, 350.0, "HS per sensor ", m_histoList_occu);
139 
140  h_tot_dist = createHistogram1D("htotdist", "Occupancy distribution", 1000, 0, 0.05, "Relative occupancy", m_histoList_occu);
141  h_tot_dist1 = createHistogram1D("htotdist1", "True occupancy distribution", 1000, 0, 0.05, "occupancy", m_histoList_occu);
142  h_tot_dist12 = createHistogram2D("htotdist2d", "True vs sensor occupancy distribution", 1000, 0, 0.05, "sensor occupancy", 1000, 0,
143  0.05, "occupancy", m_histoList_occu);
144  h_nevents = createHistogram1D("hnevents", "Number of events", 1, 0, 1, "", m_histoList_occu);
145 
146 }

◆ clone()

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

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 181 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 441 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 422 of file Module.h.

◆ endRun()

void endRun ( )
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 173 of file SVDHotStripFinderModule.cc.

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 98 of file Module.cc.

◆ event()

void event ( )
overridevirtual

Called once for each event.

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

Reimplemented from Module.

Definition at line 148 of file SVDHotStripFinderModule.cc.

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 135 of file Module.cc.

◆ getConditionPath()

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

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


Definition at line 115 of file Module.cc.

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Definition at line 136 of file Module.h.

◆ getName()

const std::string& getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 189 of file Module.h.

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 281 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 383 of file Module.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 162 of file Module.cc.

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 87 of file Module.cc.

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 92 of file Module.cc.

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 81 of file Module.cc.

◆ initialize()

void initialize ( )
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 53 of file SVDHotStripFinderModule.cc.

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 216 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 75 of file Module.cc.

◆ setName()

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

Set the name of the module.

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

Definition at line 216 of file Module.h.

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 236 of file Module.cc.

◆ setParamPythonDict()

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

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

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

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

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 229 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 222 of file Module.cc.

◆ setType()

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

Set the module type.

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

Definition at line 50 of file Module.cc.


The documentation for this class was generated from the following files:
Belle2::SVDHistograms< TH1F >
Belle2::SVDHotStripFinderModule::hm_occupancy
SVDHistograms< TH1F > * hm_occupancy
strip occupancy per sensor
Definition: SVDHotStripFinderModule.h:101
Belle2::SVDHotStripFinderModule::m_histoList_occu
TList * m_histoList_occu
occupancy for low charge clusters
Definition: SVDHotStripFinderModule.h:99
Belle2::SVDHotStripFinderModule::h_nevents
TH1F * h_nevents
number of events counting
Definition: SVDHotStripFinderModule.h:119
Belle2::SVDHotStripFinderModule::hm_occAll
SVDHistograms< TH1F > * hm_occAll
occupancy distribution - all strips
Definition: SVDHotStripFinderModule.h:104
Belle2::SVDHotStripFinderModule::h_tot_dist
TH1F * h_tot_dist
relative occupancy histogram
Definition: SVDHotStripFinderModule.h:116
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)
thf
Definition: SVDHotStripFinderModule.cc:586
Belle2::SVDHotStripFinderModule::h_tot_dist12
TH2F * h_tot_dist12
2d distributiuons of occupancies
Definition: SVDHotStripFinderModule.h:118
Belle2::SVDHotStripFinderModule::hm_occupancy_after
SVDHistograms< TH1F > * hm_occupancy_after
strip occupancy after removal of hot strips, per sensor
Definition: SVDHotStripFinderModule.h:103
Belle2::SVDHotStripFinderModule::hm_occAfter
SVDHistograms< TH1F > * hm_occAfter
occupancy distribution - not hot strips
Definition: SVDHotStripFinderModule.h:106
Belle2::SVDHotStripFinderModule::hm_occHot
SVDHistograms< TH1F > * hm_occHot
occupancy distribution - hot strips
Definition: SVDHotStripFinderModule.h:105
Belle2::SVDHotStripFinderModule::h_tot_dqm1
TH1F * h_tot_dqm1
number of hot strips per sensor for layer 3
Definition: SVDHotStripFinderModule.h:115
Belle2::SVDHotStripFinderModule::hm_hot_strips
SVDHistograms< TH1F > * hm_hot_strips
hot strips per sensor
Definition: SVDHotStripFinderModule.h:102
Belle2::SVDSummaryPlots
class to summarize SVD quantities per sensor and side
Definition: SVDSummaryPlots.h:35
Belle2::SVDHotStripFinderModule::h_tot_dist1
TH1F * h_tot_dist1
absolute occupany histogram
Definition: SVDHotStripFinderModule.h:117
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)
thf
Definition: SVDHotStripFinderModule.cc:603
Belle2::SVDHotStripFinderModule::h_tot_dqm
TH1F * h_tot_dqm
number of hot strips per sensor
Definition: SVDHotStripFinderModule.h:114
Belle2::SVDHotStripFinderModule::m_hHotStripsSummary
SVDSummaryPlots * m_hHotStripsSummary
hot strip summary histo
Definition: SVDHotStripFinderModule.h:112