Belle II Software  release-08-01-10
SVDClusterEvaluationTrueInfoModule Class Reference

Clustering Performance, using true informations. More...

#include <SVDClusterEvaluationTrueInfoModule.h>

Inheritance diagram for SVDClusterEvaluationTrueInfoModule:
Collaboration diagram for SVDClusterEvaluationTrueInfoModule:

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

 SVDClusterEvaluationTrueInfoModule ()
 constructor
 
virtual void initialize () override
 Initialize the SVDClusterEvaluationTrueInfo.
 
virtual void beginRun () override
 Called when entering a new run.
 
virtual void event () override
 This method is the core of the SVDClusterEvaluationTrueInfo.
 
virtual void endRun () override
 This method is called if the current run ends.
 
virtual void terminate () override
 This method is called at the end of the event processing.
 
virtual std::vector< std::string > getFileNames (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.
 

Public Attributes

TFile * m_outputFile = nullptr
 output file
 
std::string m_outputFileName = ""
 output file name
 
std::string m_svdEventInfoName
 Name of the SVDEventInfo object.
 
int indexForHistosAndGraphs = 0
 Index used for the lists and for the vectors of histograms: it indicates the set of sensors we are looking at.
 
TString NameOfHisto = ""
 Strings to pass names of the histos in the vectors of hitos.
 
TString TitleOfHisto = ""
 Strings to pass titles of the histos in the vectors of hitos.
 
TH1F * m_histo_StripTimeResolution [m_Nsets] = {nullptr}
 Vector of histograms depicting Strip Time Residuals.
 
TH1F * m_histo_ClusterTimeResolution [m_Nsets] = {nullptr}
 Vector of histograms depicting Cluster Time Residuals.
 
TH1F * m_histo_ClusterTimeResolution_bin1 [m_Nsets] = {nullptr}
 Vector of histograms depicting Cluster Time Residuals, divided by TriggerBin. More...
 
TH1F * m_histo_ClusterTimeResolution_bin2 [m_Nsets] = {nullptr}
 TB2.
 
TH1F * m_histo_ClusterTimeResolution_bin3 [m_Nsets] = {nullptr}
 TB3.
 
TH1F * m_histo_ClusterTimeResolution_bin4 [m_Nsets] = {nullptr}
 TB4.
 
TH1F * m_histo_ClusterTimePull [m_Nsets] = {nullptr}
 Vector of histograms depicting Cluster Time Pull.
 
TH1F * m_histo_ClusterUPositionResolution [m_NsetsRed] = {nullptr}
 Vector of histograms depicting Cluster U Position Residual (Reduced length!)
 
TH1F * m_histo_ClusterVPositionResolution [m_NsetsRed] = {nullptr}
 Vector of histograms depicting Cluster V Position Residual (Reduced length!)
 
TH1F * m_histo_ClusterUPositionPull [m_NsetsRed] = {nullptr}
 Vector of histograms depicting Cluster U Position Pull (Reduced length!)
 
TH1F * m_histo_ClusterVPositionPull [m_NsetsRed] = {nullptr}
 Vector of histograms depicting Cluster U Position Pull (Reduced length!)
 
TH2F * m_histo2D_TresVsPosres [m_Nsets] = {nullptr}
 Vector of 2D histograms depicting Time Residuals Vs Position (U/V) Residuals for Histos.
 
TH1F * m_histo_PurityInsideTMCluster [m_Nsets] = {nullptr}
 Vector of histograms depicting Cluster Internal Purity (TM Recos over Reco inside a Cluster)
 
TH2F * m_histo2D_PurityInsideTMCluster [m_Nsets] = {nullptr}
 Vector of 2D histograms depicting TM Reco Vs Total Reco inside a TM Cluster.
 
TH1F * m_histo_PurityInsideNOTMCluster [m_Nsets] = {nullptr}
 Vector of histograms depicting TM Cluster Internal Purity (TM Recos over Reco inside a Cluster)
 
TH1F * m_histo_THinCluster [m_Nsets] = {nullptr}
 Vector of histograms depicting Number of TH inside a Cluster.
 
TH1F * m_histo_THinClusterTM [m_Nsets] = {nullptr}
 Vector of histograms depicting Number of TH inside a TM Cluster.
 
TH1F * m_histo_GoodTHinClusterTM [m_Nsets] = {nullptr}
 Vector of histograms depicting Number of Good TH inside a TM Cluster.
 
TH1F * m_histo_GoodTHinClusterTMGood [m_Nsets] = {nullptr}
 Vector of histograms depicting Number of Good TH inside a Good TM Cluster.
 
float m_mean_StripTimeResolution [m_Nsets] = {0}
 Vectors of floats containing the mean and the RMS from the corresponding histo. More...
 
float m_RMS_StripTimeResolution [m_Nsets] = {0}
 rms of strip time residual
 
float m_mean_ClusterTimeResolution [m_Nsets] = {0}
 average cl time resid
 
float m_RMS_ClusterTimeResolution [m_Nsets] = {0}
 rms cluster time resid
 
float m_mean_ClusterUPositionResolution [m_Nsets] = {0}
 average cl U position resol
 
float m_RMS_ClusterUPositionResolution [m_Nsets] = {0}
 rms cl U position resol
 
float m_mean_ClusterVPositionResolution [m_Nsets] = {0}
 average cl V position reosl
 
float m_RMS_ClusterVPositionResolution [m_Nsets] = {0}
 rms cl V position resol
 
float m_mean_PurityInsideTMCluster [m_Nsets] = {0}
 cluster purity average
 
float m_RMS_PurityInsideTMCluster [m_Nsets] = {0}
 cluster purity rms
 
float m_mean_THinCluster [m_Nsets] = {0}
 true hits in cluster average
 
float m_RMS_THinCluster [m_Nsets] = {0}
 true hits in cluster rms
 
float m_mean_THinClusterTM [m_Nsets] = {0}
 true hits in truth matched cluster average
 
float m_RMS_THinClusterTM [m_Nsets] = {0}
 true hits in truth matched cluster rms
 
float m_mean_GoodTHinClusterTM [m_Nsets] = {0}
 good true hits in cluster truth matched average
 
float m_RMS_GoodTHinClusterTM [m_Nsets] = {0}
 good true hits in cluster truth matched rms
 
float m_mean_GoodTHinClusterTMGood [m_Nsets] = {0}
 good true hits in cluster truth match good average
 
float m_RMS_GoodTHinClusterTMGood [m_Nsets] = {0}
 good true hits in cluster truth match good rms
 
float m_OrderingVec [m_Nsets] = {1., 2., 3., 4., 5., 6.}
 Vectors used to Draw the TGraphs (defined in the cc) depicting the averages and the means of the histos above for the various sets of sensor.
 
float m_NullVec [m_Nsets] = {0.}
 null vector
 
TList * m_histoList_StripTimeResolution = nullptr
 Lists used to easily Draw the corresponding histos; last one is used to draw the TGraphs. More...
 
TList * m_histoList_ClusterTimeResolution = nullptr
 histo list cluster time resolution
 
TList * m_histoList_ClusterTimePull = nullptr
 histo list cluster time pull
 
TList * m_histoList_ClusterPositionResolution = nullptr
 histo list cluster position resolution
 
TList * m_histoList_ClusterPositionPull = nullptr
 histo list cluster position pull
 
TList * m_histo2DList_TresVsPosres = nullptr
 histo list ime tresol VS position resol
 
TList * m_histoList_PurityInsideTMCluster = nullptr
 histo list truth matched cluster purity (2D)
 
TList * m_histo2DList_PurityInsideTMCluster = nullptr
 histo list truth matched cluster purity (2D)
 
TList * m_histoList_PurityInsideNOTMCluster = nullptr
 histo list not truth matched cluster purity
 
TList * m_histoList_THinCluster = nullptr
 histo list true hits in cluster
 
TList * m_histoList_THinClusterTM = nullptr
 histo list true hits in clsuter truth match
 
TList * m_histoList_GoodTHinClusterTM = nullptr
 histo list good true hits in cluster truth matched
 
TList * m_histoList_GoodTHinClusterTMGood = nullptr
 histo list goo true hits in cluster truth match good
 
TList * m_graphList = nullptr
 histo list, TGraphs
 
int m_NumberOfShaperDigit [m_Nsets] = {0}
 Vectors used to compute the quantities depicted in Histos and Graphs.
 
int m_NumberOfRecoDigit [m_Nsets] = {0}
 number of reco digits
 
int m_NumberOfTH [m_Nsets] = {0}
 numner of true hits
 
int m_NumberOfClustersRelatedToTH [m_Nsets] = {0}
 number of clusters related to true hits
 
int m_NumberOfClusters [m_Nsets] = {0}
 number of clusters
 
int m_NumberOfTMClusters [m_Nsets] = {0}
 number of truth matched clusters
 
int m_NumberOfTMRecoInTMCluster = 0
 numnber of true match reco digit in truth match cluster
 
int m_NumberOfTMRecoInNOTMCluster = 0
 number of truth matched reco digits in not truth matched clusters
 
TH1F * m_histoControl_MCcharge = nullptr
 Control Histos and List to check if the function used to define a TH as "good" is working fine. More...
 
TH1F * m_histoControl_MCisPrimary = nullptr
 control histo: MC is primary
 
TH1F * m_histoControl_THToMCsize = nullptr
 control histo: true hit to mc size
 
TList * m_histoList_Control = nullptr
 control histo
 

Static Public Attributes

static const int m_Nsets
 number of sets: L3-barrel-U, L3-barrel-V, L456-barrel-U, L456-barrel-V, L456-slanted-U, L456-slanted-V More...
 
static const int m_NsetsRed = 3
 numbner of reduced sets
 

Protected Member Functions

int indexFromLayerSensorSide (int LayerNumber, int SensorNumber, int UVNumber)
 Function returning the index used for Histos.
 
TString IntExtFromIndex (int idx)
 Function returning "Internal" or "External" depending on the index.
 
TString FWFromIndex (int idx)
 Function returning "Forward" or "Backword" depending on the index.
 
TString UVFromIndex (int idx)
 Function returning "U" or "V" depending on the index.
 
TH1F * createHistogram1D (const char *name, const char *title, Int_t nbins, Double_t min, Double_t max, const char *xtitle, TList *histoList)
 Function returning a TH1F.
 
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)
 Function returning TH2F.
 
void createEfficiencyGraph (const char *name, const char *title, int vNum[m_Nsets], int vDen[m_Nsets], TString xTitle, TString yTitle, TList *list)
 Function returning a TGraph with Y axis limited to 1 given numerator and denumerator vectors and plotting the ratio and corresponding uncertainty.
 
void createArbitraryGraphErrorChooser (const char *name, const char *title, float x[m_Nsets], float xErr[m_Nsets], float y[m_Nsets], float yErr[m_Nsets], TString xTitle, TString yTitle, TList *list, int len)
 Function choosing between the two following functions depending on the length of the provided arrays.
 
void createArbitraryGraphError_Std (const char *name, const char *title, float x[m_Nsets], float xErr[m_Nsets], float y[m_Nsets], float yErr[m_Nsets], TString xTitle, TString yTitle, TList *list)
 Function returning an arbitrarly defined TGraph with arrays length equal to m_Nsets.
 
void createArbitraryGraphError_Red (const char *name, const char *title, float x[m_NsetsRed], float xErr[m_NsetsRed], float y[m_NsetsRed], float yErr[m_NsetsRed], TString xTitle, TString yTitle, TList *list)
 Function returning an arbitrarly defined TGraph with arrays length equal to m_NsetsRed.
 
bool goodTrueHit (const SVDTrueHit *thino)
 Function defining if a TH is good (based on charge and primaryness)
 
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.
 

Protected Attributes

StoreObjPtr< SVDEventInfom_storeSVDEvtInfo
 Storage for SVDEventInfo object.
 

Private Member Functions

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

std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Clustering Performance, using true informations.

Definition at line 37 of file SVDClusterEvaluationTrueInfoModule.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.

Member Function Documentation

◆ clone()

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

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 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 439 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 420 of file Module.h.

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

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

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

◆ 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 RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 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 187 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 279 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 381 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 41 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 160 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 85 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 90 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 79 of file Module.cc.

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 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 73 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 214 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 234 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 249 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 208 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 227 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 220 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 48 of file Module.cc.

Member Data Documentation

◆ m_histo_ClusterTimeResolution_bin1

TH1F* m_histo_ClusterTimeResolution_bin1[m_Nsets] = {nullptr}

Vector of histograms depicting Cluster Time Residuals, divided by TriggerBin.

TB1

Definition at line 86 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoControl_MCcharge

TH1F* m_histoControl_MCcharge = nullptr

Control Histos and List to check if the function used to define a TH as "good" is working fine.

control histo: MC charge

Definition at line 168 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_StripTimeResolution

TList* m_histoList_StripTimeResolution = nullptr

Lists used to easily Draw the corresponding histos; last one is used to draw the TGraphs.

histo list strip time resolution

Definition at line 142 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_StripTimeResolution

float m_mean_StripTimeResolution[m_Nsets] = {0}

Vectors of floats containing the mean and the RMS from the corresponding histo.

average strip time residual

Definition at line 118 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_Nsets

const int m_Nsets
static
Initial value:
=
6

number of sets: L3-barrel-U, L3-barrel-V, L456-barrel-U, L456-barrel-V, L456-slanted-U, L456-slanted-V

Definition at line 62 of file SVDClusterEvaluationTrueInfoModule.h.


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