Belle II Software development
SVDClusterEvaluationTrueInfoModule Class Reference

Clustering Performance, using true informations. More...

#include <SVDClusterEvaluationTrueInfoModule.h>

Inheritance diagram for SVDClusterEvaluationTrueInfoModule:
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

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

Static Public Member Functions

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

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

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.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

std::string m_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 34 of file SVDClusterEvaluationTrueInfoModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

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,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ SVDClusterEvaluationTrueInfoModule()

constructor

Definition at line 31 of file SVDClusterEvaluationTrueInfoModule.cc.

31 : Module()
32{
33 setDescription("This modules generates performance plots on SVD clustering.");
34
35 addParam("outputFileName", m_outputFileName, "output rootfile name", std::string("SVDClusterEvaluationTrueInfo.root"));
36 addParam("SVDEventInfo", m_svdEventInfoName, "Defines the name of the EventInfo", std::string(""));
37}
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Module()
Constructor.
Definition: Module.cc:30
std::string m_svdEventInfoName
Name of the SVDEventInfo object.
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

◆ ~SVDClusterEvaluationTrueInfoModule()

Definition at line 40 of file SVDClusterEvaluationTrueInfoModule.cc.

41{
42}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 205 of file SVDClusterEvaluationTrueInfoModule.cc.

206{
207}

◆ clone()

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

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ createArbitraryGraphError_Red()

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 
)
protected

Function returning an arbitrarly defined TGraph with arrays length equal to m_NsetsRed.

Definition at line 762 of file SVDClusterEvaluationTrueInfoModule.cc.

764{
765
766 TCanvas* c = new TCanvas(name, title);
767 TGraphErrors* g = new TGraphErrors(m_NsetsRed, x, y, xErr, yErr);
768 g->SetName(name);
769 g->SetTitle(title);
770 g->GetXaxis()->SetTitle(xTitle.Data());
771 g->GetYaxis()->SetTitle(yTitle.Data());
772 g->Draw("AP");
773 g->SetMarkerStyle(20);
774 g->SetMarkerSize(0.8);
775 TAxis* xAxis = g->GetXaxis();
776
777 TText* t = new TText();
778 t->SetTextAlign(32);
779 t->SetTextSize(0.035);
780 t->SetTextFont(72);
781 TString labels[m_NsetsRed] = {"3", "456F", "456B"};
782 for (Int_t i = 0; i < m_NsetsRed; i++) {
783 xAxis->SetBinLabel(xAxis->FindBin(i + 1), labels[i].Data());
784 }
785
786 if (list)
787 list->Add(c);
788
789}
static const int m_NsetsRed
numbner of reduced sets

◆ createArbitraryGraphError_Std()

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 
)
protected

Function returning an arbitrarly defined TGraph with arrays length equal to m_Nsets.

Definition at line 733 of file SVDClusterEvaluationTrueInfoModule.cc.

735{
736
737 TCanvas* c = new TCanvas(name, title);
738 TGraphErrors* g = new TGraphErrors(m_Nsets, x, y, xErr, yErr);
739 g->SetName(name);
740 g->SetTitle(title);
741 g->GetXaxis()->SetTitle(xTitle.Data());
742 g->GetYaxis()->SetTitle(yTitle.Data());
743 g->Draw("AP");
744 g->SetMarkerStyle(20);
745 g->SetMarkerSize(0.8);
746 TAxis* xAxis = g->GetXaxis();
747
748 TText* t = new TText();
749 t->SetTextAlign(32);
750 t->SetTextSize(0.035);
751 t->SetTextFont(72);
752 TString labels[m_Nsets] = {"3U", "3V", "456FU", "456FV", "456BU", "456BV"};
753 for (Int_t i = 0; i < m_Nsets; i++) {
754 xAxis->SetBinLabel(xAxis->FindBin(i + 1), labels[i].Data());
755 }
756
757 if (list)
758 list->Add(c);
759
760}
static const int m_Nsets
number of sets: L3-barrel-U, L3-barrel-V, L456-barrel-U, L456-barrel-V, L456-slanted-U,...

◆ createArbitraryGraphErrorChooser()

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 
)
protected

Function choosing between the two following functions depending on the length of the provided arrays.

Definition at line 722 of file SVDClusterEvaluationTrueInfoModule.cc.

724{
725 if (len == m_NsetsRed)
726 createArbitraryGraphError_Red(name, title, x, xErr, y, yErr, xTitle, yTitle, list);
727 else if (len == m_Nsets)
728 createArbitraryGraphError_Std(name, title, x, xErr, y, yErr, xTitle, yTitle, list);
729 else
730 B2INFO("ERROR, WRONG LENGTH FOR MEANS TGRAPH CREATION!!!");
731}
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.
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.

◆ createEfficiencyGraph()

void createEfficiencyGraph ( const char *  name,
const char *  title,
int  vNum[m_Nsets],
int  vDen[m_Nsets],
TString  xTitle,
TString  yTitle,
TList *  list 
)
protected

Function returning a TGraph with Y axis limited to 1 given numerator and denumerator vectors and plotting the ratio and corresponding uncertainty.

Definition at line 674 of file SVDClusterEvaluationTrueInfoModule.cc.

677{
678
679 float ratio[m_Nsets];
680 float ratioErr[m_Nsets];
681 float x[m_Nsets];
682 float xErr[m_Nsets];
683
684 for (int set = 0; set < m_Nsets; set++) {
685
686 x[set] = set + 1;
687 xErr[set] = 0;
688
689 if (vDen[set] > 0) {
690 ratio[set] = (float)vNum[set] / (float)vDen[set];
691 ratioErr[set] = sqrt(ratio[set] * (1 - ratio[set]) / (float)vDen[set]);
692 }
693
694 }
695
696 TCanvas* c = new TCanvas(name, title);
697 TGraphErrors* g = new TGraphErrors(m_Nsets, x, ratio, xErr, ratioErr);
698 g->SetName(name);
699 g->SetTitle(title);
700 g->GetXaxis()->SetTitle(xTitle.Data());
701 g->GetYaxis()->SetTitle(yTitle.Data());
702 g->GetYaxis()->SetRangeUser(0.00001, 1.10);
703 g->Draw("AP");
704 g->SetMarkerStyle(20);
705 g->SetMarkerSize(0.8);
706 TAxis* xAxis = g->GetXaxis();
707
708 TText* t = new TText();
709 t->SetTextAlign(32);
710 t->SetTextSize(0.035);
711 t->SetTextFont(72);
712 TString labels[m_Nsets] = {"3U", "3V", "456FU", "456FV", "456BU", "456BV"};
713 for (Int_t i = 0; i < m_Nsets; i++) {
714 xAxis->SetBinLabel(xAxis->FindBin(i + 1), labels[i].Data());
715 }
716
717 if (list)
718 list->Add(c);
719
720}
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28

◆ createHistogram1D()

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

Function returning a TH1F.

Definition at line 580 of file SVDClusterEvaluationTrueInfoModule.cc.

583{
584 TH1F* h = new TH1F(name, title, nbins, min, max);
585
586 h->GetXaxis()->SetTitle(xtitle);
587
588 if (histoList)
589 histoList->Add(h);
590
591 return h;
592}

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

Function returning TH2F.

Definition at line 594 of file SVDClusterEvaluationTrueInfoModule.cc.

599{
600
601 TH2F* h = new TH2F(name, title, nbinsX, minX, maxX, nbinsY, minY, maxY);
602
603 h->GetXaxis()->SetTitle(titleX);
604 h->GetYaxis()->SetTitle(titleY);
605
606 if (histoList)
607 histoList->Add(h);
608
609 return h;
610}

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

This method is called if the current run ends.

Reimplemented from Module.

Definition at line 390 of file SVDClusterEvaluationTrueInfoModule.cc.

391{
392
393 //extract mean and sigma values from histos to plot them in graphs
394 for (int k = 0; k < m_Nsets; k ++) {
397
400
403
404 m_mean_THinCluster[k] = m_histo_THinCluster[k]->GetMean();
405 m_RMS_THinCluster[k] = m_histo_THinCluster[k]->GetRMS() / sqrt(m_histo_THinCluster[k]->GetEntries());
406
408 m_RMS_THinClusterTM[k] = m_histo_THinClusterTM[k]->GetRMS() / sqrt(m_histo_THinClusterTM[k]->GetEntries());
409
412
415 }
416 for (int k = 0; k < m_NsetsRed; k ++) {
419
422 }
423
424 //GRAPHS
425 createEfficiencyGraph("recoEff", "Strip Fit Efficiency ( RecoDigits / ShaperDigits )", m_NumberOfRecoDigit, m_NumberOfShaperDigit,
426 "set", "efficiency", m_graphList);
427
428 createEfficiencyGraph("clusterEff", "Clustering Efficiency ( Truth-Matched Clusters / TrueHits )", m_NumberOfClustersRelatedToTH,
429 m_NumberOfTH, "set", "efficiency", m_graphList);
430
431 createEfficiencyGraph("clusterPurity", "Purity of Clusters ( Truth-Matched Clusters / All Clusters )", m_NumberOfTMClusters,
432 m_NumberOfClusters, "set", "purity", m_graphList);
433
434 //means-from-histos graphs
435 createArbitraryGraphErrorChooser("stripTime_Means", "Strip Time Resolution", m_OrderingVec, m_NullVec, m_mean_StripTimeResolution,
436 m_RMS_StripTimeResolution, "set", "time residuals (ns)", m_graphList, m_Nsets);
437
438 createArbitraryGraphErrorChooser("clusterTime_Means", "Cluster Time Resolution", m_OrderingVec, m_NullVec,
440
441 createArbitraryGraphErrorChooser("clusterUposition_Means", "Cluster U Position Resolution", m_OrderingVec, m_NullVec,
443 m_NsetsRed);
444
445 createArbitraryGraphErrorChooser("clusterVposition_Means", "Cluster V Position Resolution", m_OrderingVec, m_NullVec,
447 m_NsetsRed);
448
449 createArbitraryGraphErrorChooser("clusterInternalPurity_Means", "Fraction of Truth-matched Recos inside a Truth-matched Cluster",
451 "number of TM recos / cluster size", m_graphList, m_Nsets);
452
453 createArbitraryGraphErrorChooser("THinCluster_Means", "Number of True Hits inside a Cluster", m_OrderingVec, m_NullVec,
454 m_mean_THinCluster, m_RMS_THinCluster, "set", "number of TH per cluster", m_graphList, m_Nsets);
455
456 createArbitraryGraphErrorChooser("THinClusterTM_Means", "Number of True Hits inside a TM Cluster", m_OrderingVec, m_NullVec,
457 m_mean_THinClusterTM, m_RMS_THinClusterTM, "set", "number of TH per TM cluster", m_graphList, m_Nsets);
458
459 createArbitraryGraphErrorChooser("goodTHinClusterTM_Means", "Number of Good True Hits inside a TM Cluster", m_OrderingVec,
460 m_NullVec,
461 m_mean_GoodTHinClusterTM, m_RMS_GoodTHinClusterTM, "set", "number of Good TH per TM cluster", m_graphList, m_Nsets);
462
463 createArbitraryGraphErrorChooser("goodTHinClusterTMGood_Means", "Number of Good True Hits inside a Good TM Cluster", m_OrderingVec,
464 m_NullVec,
465 m_mean_GoodTHinClusterTMGood, m_RMS_GoodTHinClusterTMGood, "set", "number of Good TH per Good TM cluster", m_graphList, m_Nsets);
467 //WRITE HISTOS AND GRAPHS//
469
470 if (m_outputFile != nullptr) {
471 m_outputFile->cd();
472
473 TDirectory* oldDir = gDirectory;
474 TObject* obj;
475
476 TDirectory* dir_strtime = oldDir->mkdir("strip_time");
477 dir_strtime->cd();
478 TIter nextH_strtime(m_histoList_StripTimeResolution);
479 while ((obj = nextH_strtime()))
480 obj->Write();
481
482 TDirectory* dir_cltime = oldDir->mkdir("cluster_time");
483 dir_cltime->cd();
484 TIter nextH_cltime(m_histoList_ClusterTimeResolution);
485 while ((obj = nextH_cltime()))
486 obj->Write();
487
488 TDirectory* dir_cltimepull = oldDir->mkdir("cluster_time_pull");
489 dir_cltimepull->cd();
490 TIter nextH_cltimepull(m_histoList_ClusterTimePull);
491 while ((obj = nextH_cltimepull()))
492 obj->Write();
493
494 TDirectory* dir_clpos = oldDir->mkdir("cluster_position");
495 dir_clpos->cd();
496 TIter nextH_clpos(m_histoList_ClusterPositionResolution);
497 while ((obj = nextH_clpos()))
498 obj->Write();
499
500 TDirectory* dir_clpospull = oldDir->mkdir("cluster_position_pull");
501 dir_clpospull->cd();
502 TIter nextH_clpospull(m_histoList_ClusterPositionPull);
503 while ((obj = nextH_clpospull()))
504 obj->Write();
505
506 TDirectory* dir_clpostime = oldDir->mkdir("cluster_timeVSposition");
507 dir_clpostime->cd();
508 TIter nextH_clpostime(m_histo2DList_TresVsPosres);
509 while ((obj = nextH_clpostime()))
510 obj->Write();
511
512 TDirectory* dir_clinpurTM = oldDir->mkdir("intra_cluster_purity_TM");
513 dir_clinpurTM->cd();
514 TIter nextH_clinpurTM(m_histoList_PurityInsideTMCluster);
515 while ((obj = nextH_clinpurTM()))
516 obj->Write();
517
518 TDirectory* dir_clinpurTM2D = oldDir->mkdir("intra_cluster_purity_TM2D");
519 dir_clinpurTM2D->cd();
520 TIter nextH_clinpurTM2D(m_histo2DList_PurityInsideTMCluster);
521 while ((obj = nextH_clinpurTM2D()))
522 obj->Write();
523
524 TDirectory* dir_clinpurNOTM = oldDir->mkdir("intra_cluster_purity_NOTM");
525 dir_clinpurNOTM->cd();
526 TIter nextH_clinpurNOTM(m_histoList_PurityInsideNOTMCluster);
527 while ((obj = nextH_clinpurNOTM()))
528 obj->Write();
529
530 TDirectory* dir_puddle = oldDir->mkdir("trueHits_in_cluster");
531 dir_puddle->cd();
532 TIter nextH_puddle(m_histoList_THinCluster);
533 while ((obj = nextH_puddle()))
534 obj->Write();
535
536 TDirectory* dir_puddleTM = oldDir->mkdir("trueHits_in_TMcluster");
537 dir_puddleTM->cd();
538 TIter nextH_puddleTM(m_histoList_THinClusterTM);
539 while ((obj = nextH_puddleTM()))
540 obj->Write();
541
542 TDirectory* dir_goodPuddleTM = oldDir->mkdir("goodTrueHits_in_TMcluster");
543 dir_goodPuddleTM->cd();
544 TIter nextH_GoodPuddleTM(m_histoList_GoodTHinClusterTM);
545 while ((obj = nextH_GoodPuddleTM()))
546 obj->Write();
547
548 TDirectory* dir_goodPuddleTMGood = oldDir->mkdir("goodTrueHits_in_GoodTMcluster");
549 dir_goodPuddleTMGood->cd();
550 TIter nextH_GoodPuddleTMGood(m_histoList_GoodTHinClusterTMGood);
551 while ((obj = nextH_GoodPuddleTMGood()))
552 obj->Write();
553
554 TDirectory* dir_graph = oldDir->mkdir("graphs");
555 dir_graph->cd();
556 TIter nextH_graph(m_graphList);
557 while ((obj = nextH_graph()))
558 obj->Write();
559
560 TDirectory* dir_controlsMC = oldDir->mkdir("controlMC");
561 dir_controlsMC->cd();
562 TIter nextH_controlsMC(m_histoList_Control);
563 while ((obj = nextH_controlsMC()))
564 obj->Write();
565
566 m_outputFile->Close();
567 }
568}
TH1F * m_histo_StripTimeResolution[m_Nsets]
Vector of histograms depicting Strip Time Residuals.
TList * m_histoList_StripTimeResolution
Lists used to easily Draw the corresponding histos; last one is used to draw the TGraphs.
float m_RMS_GoodTHinClusterTM[m_Nsets]
good true hits in cluster truth matched rms
float m_mean_ClusterTimeResolution[m_Nsets]
average cl time resid
int m_NumberOfClustersRelatedToTH[m_Nsets]
number of clusters related to true hits
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.
TList * m_histoList_PurityInsideTMCluster
histo list truth matched cluster purity (2D)
float m_RMS_ClusterTimeResolution[m_Nsets]
rms cluster time resid
TH1F * m_histo_ClusterUPositionResolution[m_NsetsRed]
Vector of histograms depicting Cluster U Position Residual (Reduced length!)
TList * m_histoList_ClusterTimeResolution
histo list cluster time resolution
int m_NumberOfShaperDigit[m_Nsets]
Vectors used to compute the quantities depicted in Histos and Graphs.
float m_RMS_THinClusterTM[m_Nsets]
true hits in truth matched cluster rms
float m_RMS_THinCluster[m_Nsets]
true hits in cluster rms
TList * m_histo2DList_TresVsPosres
histo list ime tresol VS position resol
float m_mean_GoodTHinClusterTM[m_Nsets]
good true hits in cluster truth matched average
int m_NumberOfTMClusters[m_Nsets]
number of truth matched clusters
float m_mean_ClusterVPositionResolution[m_Nsets]
average cl V position reosl
TH1F * m_histo_THinCluster[m_Nsets]
Vector of histograms depicting Number of TH inside a Cluster.
float m_mean_ClusterUPositionResolution[m_Nsets]
average cl U position resol
TH1F * m_histo_GoodTHinClusterTM[m_Nsets]
Vector of histograms depicting Number of Good TH inside a TM Cluster.
TList * m_histoList_ClusterTimePull
histo list cluster time pull
TList * m_histoList_GoodTHinClusterTMGood
histo list goo true hits in cluster truth match good
float m_RMS_StripTimeResolution[m_Nsets]
rms of strip time residual
float m_mean_THinClusterTM[m_Nsets]
true hits in truth matched cluster average
float m_RMS_ClusterVPositionResolution[m_Nsets]
rms cl V position resol
float m_OrderingVec[m_Nsets]
Vectors used to Draw the TGraphs (defined in the cc) depicting the averages and the means of the hist...
TList * m_histoList_ClusterPositionPull
histo list cluster position pull
TList * m_histo2DList_PurityInsideTMCluster
histo list truth matched cluster purity (2D)
TList * m_histoList_PurityInsideNOTMCluster
histo list not truth matched cluster purity
TH1F * m_histo_PurityInsideTMCluster[m_Nsets]
Vector of histograms depicting Cluster Internal Purity (TM Recos over Reco inside a Cluster)
TH1F * m_histo_ClusterTimeResolution[m_Nsets]
Vector of histograms depicting Cluster Time Residuals.
TList * m_histoList_GoodTHinClusterTM
histo list good true hits in cluster truth matched
float m_mean_PurityInsideTMCluster[m_Nsets]
cluster purity average
float m_RMS_ClusterUPositionResolution[m_Nsets]
rms cl U position resol
float m_RMS_GoodTHinClusterTMGood[m_Nsets]
good true hits in cluster truth match good rms
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 plot...
TH1F * m_histo_GoodTHinClusterTMGood[m_Nsets]
Vector of histograms depicting Number of Good TH inside a Good TM Cluster.
TH1F * m_histo_ClusterVPositionResolution[m_NsetsRed]
Vector of histograms depicting Cluster V Position Residual (Reduced length!)
TList * m_histoList_THinCluster
histo list true hits in cluster
float m_mean_GoodTHinClusterTMGood[m_Nsets]
good true hits in cluster truth match good average
TList * m_histoList_ClusterPositionResolution
histo list cluster position resolution
float m_mean_StripTimeResolution[m_Nsets]
Vectors of floats containing the mean and the RMS from the corresponding histo.
TH1F * m_histo_THinClusterTM[m_Nsets]
Vector of histograms depicting Number of TH inside a TM Cluster.
TList * m_histoList_THinClusterTM
histo list true hits in clsuter truth match
float m_mean_THinCluster[m_Nsets]
true hits in cluster average

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

This method is the core of the SVDClusterEvaluationTrueInfo.

Reimplemented from Module.

Definition at line 210 of file SVDClusterEvaluationTrueInfoModule.cc.

211{
212
213 SVDModeByte modeByte = m_storeSVDEvtInfo->getModeByte();
214
215 StoreArray<SVDShaperDigit> SVDShaperDigits;
216 StoreArray<SVDRecoDigit> SVDRecoDigits;
217 StoreArray<SVDCluster> SVDClusters;
218 StoreArray<SVDTrueHit> SVDTrueHits;
219
221 //STRIPS//
223
224 //loop on ShaperDigits
225 for (const SVDShaperDigit& shape : SVDShaperDigits) {
226 indexForHistosAndGraphs = indexFromLayerSensorSide(shape.getSensorID().getLayerNumber(), shape.getSensorID().getSensorNumber(),
227 shape.isUStrip());
228
229 RelationVector<SVDRecoDigit> relatVectorShaperToReco = DataStore::getRelationsWithObj<SVDRecoDigit>(&shape);
230
231 //efficiency shaper to reco
233 if (relatVectorShaperToReco.size() > 0)
235 }
236 //close loop on ShaperDigits
237
238 //loop on RecoDigits
239 for (const SVDRecoDigit& reco : SVDRecoDigits) {
240 indexForHistosAndGraphs = indexFromLayerSensorSide(reco.getSensorID().getLayerNumber(), reco.getSensorID().getSensorNumber(),
241 reco.isUStrip());
242
243 RelationVector<SVDTrueHit> relatVectorRecoToTH = DataStore::getRelationsWithObj<SVDTrueHit>(&reco);
244
245 //strip time resolution
246 if (relatVectorRecoToTH.size() > 0)
247 m_histo_StripTimeResolution[indexForHistosAndGraphs]->Fill(reco.getTime() - (relatVectorRecoToTH[0])->getGlobalTime());
248
249 }
250 //close loop on RecoDigits
251
253 //CLUSTERS//
255
256 //loop on TrueHits
257 for (const SVDTrueHit& trhi : SVDTrueHits) {
258
259 if (goodTrueHit(&trhi)) { //enter only if the TH is related to a primary and charged MC particle
260 indexForHistosAndGraphs = indexFromLayerSensorSide(trhi.getSensorID().getLayerNumber(), trhi.getSensorID().getSensorNumber(), 1);
261
262 RelationVector<SVDCluster> relatVectorTHToClus = DataStore::getRelationsWithObj<SVDCluster>(&trhi);
263
264 //efficiencies TH to cluster
267
268 bool hasU = false;
269 bool hasV = false;
270
271 for (int j = 0; j < (int) relatVectorTHToClus.size(); j ++) {
272 indexForHistosAndGraphs = indexFromLayerSensorSide(relatVectorTHToClus[j]->getSensorID().getLayerNumber(),
273 relatVectorTHToClus[j]->getSensorID().getSensorNumber(), relatVectorTHToClus[j]->isUCluster());
274
275 if (relatVectorTHToClus[j]->isUCluster() && ! hasU) {
277 hasU = true;
278 } else if (!relatVectorTHToClus[j]->isUCluster() && ! hasV) {
280 hasV = true;
281 }
282 }
283 }
284 }
285 //close loop on TrueHits
286
287 //loop on Clusters
288 for (const SVDCluster& clus : SVDClusters) {
289 indexForHistosAndGraphs = indexFromLayerSensorSide(clus.getSensorID().getLayerNumber(), clus.getSensorID().getSensorNumber(),
290 clus.isUCluster());
291
292 RelationVector<SVDTrueHit> relatVectorClusToTH = DataStore::getRelationsWithObj<SVDTrueHit>(&clus);
293
294 //purity "outside" clusters
296 if (relatVectorClusToTH.size() > 0)
298
299 //fill the THinCluster histo with the number of TH a cluster is composed of
300 m_histo_THinCluster[indexForHistosAndGraphs]->Fill(relatVectorClusToTH.size());
301
302 //loop on the TH related to the cluster
303 for (int q = 0; q < (int)relatVectorClusToTH.size(); q ++) {
304 //cluster time resolution and pull
305 m_histo_ClusterTimeResolution[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
306
307 //get trigger bin
308 int triggerBin = 0;
309 triggerBin = (int)modeByte.getTriggerBin();
310
311 if (triggerBin == 0)
312 m_histo_ClusterTimeResolution_bin1[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
313 else if (triggerBin == 1)
314 m_histo_ClusterTimeResolution_bin2[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
315 else if (triggerBin == 2)
316 m_histo_ClusterTimeResolution_bin3[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
317 else if (triggerBin == 3)
318 m_histo_ClusterTimeResolution_bin4[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
319
320 m_histo_ClusterTimePull[indexForHistosAndGraphs]->Fill((clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime()) /
321 (clus.getClsTimeSigma()));
322
323 //cluster position resolution and pull, also correlation between time res and position res
324 if (clus.isUCluster()) {
325 m_histo_ClusterUPositionResolution[indexForHistosAndGraphs / 2]->Fill(clus.getPosition((relatVectorClusToTH[q])->getV()) -
326 (relatVectorClusToTH[q])->getU());
327 m_histo_ClusterUPositionPull[indexForHistosAndGraphs / 2]->Fill((clus.getPosition((relatVectorClusToTH[q])->getV()) -
328 (relatVectorClusToTH[q])->getU()) / (clus.getPositionSigma()));
329 m_histo2D_TresVsPosres[indexForHistosAndGraphs]->Fill((clus.getPosition((relatVectorClusToTH[q])->getV()) -
330 (relatVectorClusToTH[q])->getU()), (clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime()));
331 } else {
332 m_histo_ClusterVPositionResolution[(indexForHistosAndGraphs - 1) / 2]->Fill(clus.getPosition() - (relatVectorClusToTH[q])->getV());
333 m_histo_ClusterVPositionPull[(indexForHistosAndGraphs - 1) / 2]->Fill((clus.getPosition() - (relatVectorClusToTH[q])->getV()) /
334 (clus.getPositionSigma()));
335 m_histo2D_TresVsPosres[indexForHistosAndGraphs]->Fill((clus.getPosition() - (relatVectorClusToTH[q])->getV()),
336 (clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime()));
337 }
338 }
339
340 RelationVector<SVDRecoDigit> relatVectorClusToReco = DataStore::getRelationsWithObj<SVDRecoDigit>(&clus);
341 //enter only if the cluster is TM
342 if (relatVectorClusToTH.size() > 0) {
343
344 //fill the THinCluster histo with the number of TH (and good TH) a TM cluster (and a Good TM cluster) is composed of
345 m_histo_THinClusterTM[indexForHistosAndGraphs]->Fill(relatVectorClusToTH.size());
346 int numberOfGoodTHInACluster = 0;
347 int numberOfGoodTHInAClusterGood = 0;
348 for (int k = 0; k < (int)(relatVectorClusToTH.size()); k ++) {
349 if (goodTrueHit(relatVectorClusToTH[k])) {
350 numberOfGoodTHInACluster ++;
351 numberOfGoodTHInAClusterGood ++;
352 }
353 }
354 m_histo_GoodTHinClusterTM[indexForHistosAndGraphs]->Fill(numberOfGoodTHInACluster);
355 if (numberOfGoodTHInAClusterGood > 0)
356 m_histo_GoodTHinClusterTMGood[indexForHistosAndGraphs]->Fill(numberOfGoodTHInAClusterGood);
357
358 //count number of recodigit, composing the Truth-matched cluster, that are linked with a TH (internal purity)
360 for (int k = 0; k < (int)relatVectorClusToReco.size(); k++) { //loop on the recodigits composing the TM cluster
361 RelationVector<SVDTrueHit> relatVectorRecoFromClusToTH = DataStore::getRelationsWithObj<SVDTrueHit>(relatVectorClusToReco[k]);
362
363 if (relatVectorRecoFromClusToTH.size() > 0)
365 }
366
369
370 }
371 //count number of recodigit, composing a NOT Truth-matched cluster, that are linked with a TH
372 else {
373
375 for (int k = 0; k < (int)relatVectorClusToReco.size(); k++) { //loop on the recodigits composing the NOTM cluster
376 RelationVector<SVDTrueHit> relatVectorRecoFromClusToTH = DataStore::getRelationsWithObj<SVDTrueHit>(relatVectorClusToReco[k]);
377
378 if (relatVectorRecoFromClusToTH.size() > 0)
380 }
381
383
384 }
385 }
386 //close loop on clusters
387}
Class for type safe access to objects that are referred to in relations.
size_t size() const
Get number of relations.
TH1F * m_histo_ClusterUPositionPull[m_NsetsRed]
Vector of histograms depicting Cluster U Position Pull (Reduced length!)
int m_NumberOfTMRecoInNOTMCluster
number of truth matched reco digits in not truth matched clusters
int indexForHistosAndGraphs
Index used for the lists and for the vectors of histograms: it indicates the set of sensors we are lo...
TH1F * m_histo_ClusterVPositionPull[m_NsetsRed]
Vector of histograms depicting Cluster U Position Pull (Reduced length!)
TH1F * m_histo_ClusterTimeResolution_bin1[m_Nsets]
Vector of histograms depicting Cluster Time Residuals, divided by TriggerBin.
TH2F * m_histo2D_TresVsPosres[m_Nsets]
Vector of 2D histograms depicting Time Residuals Vs Position (U/V) Residuals for Histos.
TH1F * m_histo_ClusterTimePull[m_Nsets]
Vector of histograms depicting Cluster Time Pull.
int indexFromLayerSensorSide(int LayerNumber, int SensorNumber, int UVNumber)
Function returning the index used for Histos.
bool goodTrueHit(const SVDTrueHit *thino)
Function defining if a TH is good (based on charge and primaryness)
TH2F * m_histo2D_PurityInsideTMCluster[m_Nsets]
Vector of 2D histograms depicting TM Reco Vs Total Reco inside a TM Cluster.
StoreObjPtr< SVDEventInfo > m_storeSVDEvtInfo
Storage for SVDEventInfo object.
TH1F * m_histo_PurityInsideNOTMCluster[m_Nsets]
Vector of histograms depicting TM Cluster Internal Purity (TM Recos over Reco inside a Cluster)
int m_NumberOfTMRecoInTMCluster
numnber of true match reco digit in truth match cluster
The SVD Cluster class This class stores all information about reconstructed SVD clusters.
Definition: SVDCluster.h:29
Class to store SVD mode information.
Definition: SVDModeByte.h:69
baseType getTriggerBin() const
Get the triggerBin id.
Definition: SVDModeByte.h:140
The SVD RecoDigit class.
Definition: SVDRecoDigit.h:43
The SVD ShaperDigit class.
Class SVDTrueHit - Records of tracks that either enter or leave the sensitive volume.
Definition: SVDTrueHit.h:33
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ FWFromIndex()

TString FWFromIndex ( int  idx)
protected

Function returning "Forward" or "Backword" depending on the index.

Definition at line 650 of file SVDClusterEvaluationTrueInfoModule.cc.

651{
652 TString name = "";
653
654 if (idx == 2 || idx == 3)
655 name = "FWD";
656 else
657 name = "Barrel";
658
659 return name;
660}

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

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

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


Definition at line 113 of file Module.cc.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:511

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

135 {
136 return std::vector<std::string>();
137 }

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ return std::list<ModulePtr>(); }

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ goodTrueHit()

bool goodTrueHit ( const SVDTrueHit thino)
protected

Function defining if a TH is good (based on charge and primaryness)

Definition at line 791 of file SVDClusterEvaluationTrueInfoModule.cc.

792{
793
794
795 bool isGood = false;
796
797 RelationVector<MCParticle> relatVectorTHToMC = thino->getRelationsFrom<MCParticle>();
798
799 if (relatVectorTHToMC.size() > 0) {
800
801 m_histoControl_THToMCsize->Fill(relatVectorTHToMC.size());
802
803 float charge = relatVectorTHToMC[0]->getCharge();
804 bool primary = relatVectorTHToMC[0]->isPrimaryParticle();
805
806 m_histoControl_MCcharge->Fill(charge);
807 m_histoControl_MCisPrimary->Fill(primary);
808
809 if (charge != 0 && primary)
810 isGood = true;
811 }
812
813 return isGood;
814}
A Class to store the Monte Carlo particle information.
Definition: MCParticle.h:32
RelationVector< FROM > getRelationsFrom(const std::string &name="", const std::string &namedRelation="") const
Get the relations that point from another store array to this object.
TH1F * m_histoControl_MCcharge
Control Histos and List to check if the function used to define a TH as "good" is working fine.
TH1F * m_histoControl_THToMCsize
control histo: true hit to mc size
double charge(int pdgCode)
Returns electric charge of a particle with given pdg code.
Definition: EvtPDLUtil.cc:44

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

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

Definition at line 79 of file Module.cc.

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

◆ indexFromLayerSensorSide()

int indexFromLayerSensorSide ( int  LayerNumber,
int  SensorNumber,
int  UVNumber 
)
protected

Function returning the index used for Histos.

Definition at line 612 of file SVDClusterEvaluationTrueInfoModule.cc.

613{
614 int Index;
615
616 if (LayerNumber == 3) { //L3
617 if (UVNumber) //U
618 Index = 0;
619 else //V
620 Index = 1;
621 } else { //L456
622 if (SensorNumber == 1) { //FW
623 if (UVNumber) //U
624 Index = 2;
625 else //V
626 Index = 3;
627 } else { //barrel
628 if (UVNumber) //U
629 Index = 4;
630 else //V
631 Index = 5;
632 }
633 }
634
635 return Index;
636}

◆ initialize()

void initialize ( void  )
overridevirtual

Initialize the SVDClusterEvaluationTrueInfo.

Reimplemented from Module.

Definition at line 45 of file SVDClusterEvaluationTrueInfoModule.cc.

46{
47
48 /* initialize useful store array */
49 StoreArray<SVDShaperDigit> SVDShaperDigits;
50 StoreArray<SVDRecoDigit> SVDRecoDigits;
51 StoreArray<SVDCluster> SVDClusters;
52 StoreArray<SVDTrueHit> SVDTrueHits;
53
54 SVDShaperDigits.isRequired();
55 SVDRecoDigits.isRequired();
56 SVDClusters.isRequired();
57 SVDTrueHits.isRequired();
58 if (!m_storeSVDEvtInfo.isOptional(m_svdEventInfoName)) m_svdEventInfoName = "SVDEventInfoSim";
60
61
62 m_outputFile = new TFile(m_outputFileName.c_str(), "RECREATE");
63
73 m_histoList_THinCluster = new TList;
74 m_histoList_THinClusterTM = new TList;
77 m_graphList = new TList;
78 //Control List
79 m_histoList_Control = new TList;
80
81 for (int i = 0; i < m_Nsets; i ++) {
82
83 if (i % 2 == 0) { //even index, U side
84 NameOfHisto = "histo_ClusterUPositionResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
85 TitleOfHisto = "U-Cluster Position Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
87 "U_reco - U_true (cm)",
89
90 NameOfHisto = "histo_ClusterUPositionPull_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
91 TitleOfHisto = "U-Cluster Position Pull (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
93 "(U_reco - U_true)/U_sigma",
95 } else { //odd index, V side
96 NameOfHisto = "histo_ClusterVPositionResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
97 TitleOfHisto = "V-Cluster Position Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
99 "V_reco - V_true (cm)", m_histoList_ClusterPositionResolution);
100
101 NameOfHisto = "histo_ClusterVPositionPull_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
102 TitleOfHisto = "Cluster V Position Pull (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
104 "(V_reco- V_true)/V_sigma", m_histoList_ClusterPositionPull);
105 }
106
107 NameOfHisto = "histo_StripTimeResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
108 TitleOfHisto = "Strip Time Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
109 m_histo_StripTimeResolution[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
111
112 NameOfHisto = "histo_ClusterTimeResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
113 TitleOfHisto = "Cluster Time Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
114 m_histo_ClusterTimeResolution[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
116
117 NameOfHisto = "histo_ClusterTimeResolution_bin1_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
118 TitleOfHisto = "Cluster Time Resolution TriggerBin=1(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
119 i) + ")";
120 m_histo_ClusterTimeResolution_bin1[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
122 NameOfHisto = "histo_ClusterTimeResolution_bin2_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
123 TitleOfHisto = "Cluster Time Resolution TriggerBin=2(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
124 i) + ")";
125 m_histo_ClusterTimeResolution_bin2[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
127 NameOfHisto = "histo_ClusterTimeResolution_bin3_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
128 TitleOfHisto = "Cluster Time Resolution TriggerBin=3(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
129 i) + ")";
130 m_histo_ClusterTimeResolution_bin3[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
132 NameOfHisto = "histo_ClusterTimeResolution_bin4_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
133 TitleOfHisto = "Cluster Time Resolution TriggerBin=4(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
134 i) + ")";
135 m_histo_ClusterTimeResolution_bin4[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
137
138 NameOfHisto = "histo_ClusterTimePull_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
139 TitleOfHisto = "Cluster Time Pull (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
140 m_histo_ClusterTimePull[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 210, -10, 11, "(t_reco - t_true)/t_sigma",
142
143 NameOfHisto = "histo2D_TresVsPosres_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
144 TitleOfHisto = "Time Residuals Vs U/V Position Residuals (" + IntExtFromIndex(
145 i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
146 m_histo2D_TresVsPosres[i] = createHistogram2D(NameOfHisto, TitleOfHisto, 200, -0.1, 0.1, "U/V_reco - U/V_true (cm)", 180, -120, 60,
147 "t_reco - t_true (ns)", m_histo2DList_TresVsPosres);
148
149 NameOfHisto = "histo_PurityInsideTMCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
150 TitleOfHisto = "Fraction of Truth-Matched RecoDigits inside a Truth-Matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
151 i) + ", side" + UVFromIndex(i) + ")";
153 "number of TM recoDigits / cluster size",
155
156 NameOfHisto = "histo2D_PurityInsideTMCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
157 TitleOfHisto = "Number of Truth-matched Recos vs Number of Recos inside a Truth-matched Cluster (" + IntExtFromIndex(
158 i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
159 m_histo2D_PurityInsideTMCluster[i] = createHistogram2D(NameOfHisto, TitleOfHisto, 42, 0, 42, "cluster size", 42, 0, 42,
160 "number of TM recos", m_histo2DList_PurityInsideTMCluster);
161
162 NameOfHisto = "histo_PurityInsideNOTMCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
163 TitleOfHisto = "Fraction of Truth-matched RecoDigits inside a NOT Truth-matched Cluster (" + IntExtFromIndex(
164 i) + ", " + FWFromIndex(
165 i) + ", side" + UVFromIndex(i) + ")";
167 "number of TM recoDigits / cluster size",
169
170 NameOfHisto = "histo_THinCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
171 TitleOfHisto = "Number of True Hits inside a Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
172 i) + ")";
173 m_histo_THinCluster[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of TH per cluster",
175
176 NameOfHisto = "histo_THinClusterTM_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
177 TitleOfHisto = "Number of True Hits inside a Truth-matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
178 i) + ", side" + UVFromIndex(i) + ")";
179 m_histo_THinClusterTM[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of TH per TM cluster",
181
182 NameOfHisto = "histo_GoodTHinClusterTM_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
183 TitleOfHisto = "Number of Good True Hits inside a Truth-matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
184 i) + ", side" + UVFromIndex(i) + ")";
185 m_histo_GoodTHinClusterTM[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of Good TH per TM cluster",
187
188 NameOfHisto = "histo_GoodTHinClusterTMGood_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
189 TitleOfHisto = "Number of Good True Hits inside a Good Truth-matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
190 i) + ", side" + UVFromIndex(i) + ")";
191 m_histo_GoodTHinClusterTMGood[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of Good TH per Good TM cluster",
193 }
194
195 //Control Histos
196 m_histoControl_MCcharge = createHistogram1D("m_histoControl_MCcharge", "m_histoControl_MCcharge", 5, -2, 3,
197 "charge of the first MC particle related to a True Hit", m_histoList_Control);
198 m_histoControl_MCisPrimary = createHistogram1D("m_histoControl_MCisPrimary", "m_histoControl_MCisPrimary", 2, 0, 2,
199 "isPrimary of the first MC particle related to a True Hit", m_histoList_Control);
200 m_histoControl_THToMCsize = createHistogram1D("m_histoControl_THToMCsize", "m_histoControl_THToMCsize", 10, -1, 9,
201 "size of the THToMC relation arrau", m_histoList_Control);
202}
TString NameOfHisto
Strings to pass names of the histos in the vectors of hitos.
TString UVFromIndex(int idx)
Function returning "U" or "V" depending on the index.
TString TitleOfHisto
Strings to pass titles of the histos in the vectors of hitos.
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.
TString FWFromIndex(int idx)
Function returning "Forward" or "Backword" depending on the index.
TString IntExtFromIndex(int idx)
Function returning "Internal" or "External" 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.
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.

◆ IntExtFromIndex()

TString IntExtFromIndex ( int  idx)
protected

Function returning "Internal" or "External" depending on the index.

Definition at line 638 of file SVDClusterEvaluationTrueInfoModule.cc.

639{
640 TString name = "";
641
642 if (idx < 2)
643 name = "L3";
644 else
645 name = "L456";
646
647 return name;
648}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ setName()

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

Set the name of the module.

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

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ setType()

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

Set the module type.

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

Definition at line 48 of file Module.cc.

49{
50 if (!m_type.empty())
51 B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
52 m_type = type;
53}

◆ terminate()

void terminate ( void  )
overridevirtual

This method is called at the end of the event processing.

Reimplemented from Module.

Definition at line 571 of file SVDClusterEvaluationTrueInfoModule.cc.

572{
573}

◆ UVFromIndex()

TString UVFromIndex ( int  idx)
protected

Function returning "U" or "V" depending on the index.

Definition at line 662 of file SVDClusterEvaluationTrueInfoModule.cc.

663{
664 TString name = "";
665
666 if (idx % 2 == 0)
667 name = "U";
668 else
669 name = "V";
670
671 return name;
672}

Member Data Documentation

◆ indexForHistosAndGraphs

int indexForHistosAndGraphs = 0

Index used for the lists and for the vectors of histograms: it indicates the set of sensors we are looking at.

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

TList* m_graphList = nullptr

histo list, TGraphs

Definition at line 152 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_histo2D_PurityInsideTMCluster

TH2F* m_histo2D_PurityInsideTMCluster[m_Nsets] = {nullptr}

Vector of 2D histograms depicting TM Reco Vs Total Reco inside a TM Cluster.

Definition at line 102 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo2D_TresVsPosres

TH2F* m_histo2D_TresVsPosres[m_Nsets] = {nullptr}

Vector of 2D histograms depicting Time Residuals Vs Position (U/V) Residuals for Histos.

Definition at line 98 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo2DList_PurityInsideTMCluster

TList* m_histo2DList_PurityInsideTMCluster = nullptr

histo list truth matched cluster purity (2D)

Definition at line 146 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo2DList_TresVsPosres

TList* m_histo2DList_TresVsPosres = nullptr

histo list ime tresol VS position resol

Definition at line 144 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterTimePull

TH1F* m_histo_ClusterTimePull[m_Nsets] = {nullptr}

Vector of histograms depicting Cluster Time Pull.

Definition at line 88 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterTimeResolution

TH1F* m_histo_ClusterTimeResolution[m_Nsets] = {nullptr}

Vector of histograms depicting Cluster Time Residuals.

Definition at line 81 of file SVDClusterEvaluationTrueInfoModule.h.

◆ 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 83 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterTimeResolution_bin2

TH1F* m_histo_ClusterTimeResolution_bin2[m_Nsets] = {nullptr}

TB2.

Definition at line 84 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterTimeResolution_bin3

TH1F* m_histo_ClusterTimeResolution_bin3[m_Nsets] = {nullptr}

TB3.

Definition at line 85 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterTimeResolution_bin4

TH1F* m_histo_ClusterTimeResolution_bin4[m_Nsets] = {nullptr}

TB4.

Definition at line 86 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterUPositionPull

TH1F* m_histo_ClusterUPositionPull[m_NsetsRed] = {nullptr}

Vector of histograms depicting Cluster U Position Pull (Reduced length!)

Definition at line 94 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterUPositionResolution

TH1F* m_histo_ClusterUPositionResolution[m_NsetsRed] = {nullptr}

Vector of histograms depicting Cluster U Position Residual (Reduced length!)

Definition at line 90 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterVPositionPull

TH1F* m_histo_ClusterVPositionPull[m_NsetsRed] = {nullptr}

Vector of histograms depicting Cluster U Position Pull (Reduced length!)

Definition at line 96 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_ClusterVPositionResolution

TH1F* m_histo_ClusterVPositionResolution[m_NsetsRed] = {nullptr}

Vector of histograms depicting Cluster V Position Residual (Reduced length!)

Definition at line 92 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_GoodTHinClusterTM

TH1F* m_histo_GoodTHinClusterTM[m_Nsets] = {nullptr}

Vector of histograms depicting Number of Good TH inside a TM Cluster.

Definition at line 110 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_GoodTHinClusterTMGood

TH1F* m_histo_GoodTHinClusterTMGood[m_Nsets] = {nullptr}

Vector of histograms depicting Number of Good TH inside a Good TM Cluster.

Definition at line 112 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_PurityInsideNOTMCluster

TH1F* m_histo_PurityInsideNOTMCluster[m_Nsets] = {nullptr}

Vector of histograms depicting TM Cluster Internal Purity (TM Recos over Reco inside a Cluster)

Definition at line 104 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_PurityInsideTMCluster

TH1F* m_histo_PurityInsideTMCluster[m_Nsets] = {nullptr}

Vector of histograms depicting Cluster Internal Purity (TM Recos over Reco inside a Cluster)

Definition at line 100 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_StripTimeResolution

TH1F* m_histo_StripTimeResolution[m_Nsets] = {nullptr}

Vector of histograms depicting Strip Time Residuals.

Definition at line 79 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_THinCluster

TH1F* m_histo_THinCluster[m_Nsets] = {nullptr}

Vector of histograms depicting Number of TH inside a Cluster.

Definition at line 106 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histo_THinClusterTM

TH1F* m_histo_THinClusterTM[m_Nsets] = {nullptr}

Vector of histograms depicting Number of TH inside a TM Cluster.

Definition at line 108 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 165 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoControl_MCisPrimary

TH1F* m_histoControl_MCisPrimary = nullptr

control histo: MC is primary

Definition at line 166 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoControl_THToMCsize

TH1F* m_histoControl_THToMCsize = nullptr

control histo: true hit to mc size

Definition at line 167 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_ClusterPositionPull

TList* m_histoList_ClusterPositionPull = nullptr

histo list cluster position pull

Definition at line 143 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_ClusterPositionResolution

TList* m_histoList_ClusterPositionResolution = nullptr

histo list cluster position resolution

Definition at line 142 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_ClusterTimePull

TList* m_histoList_ClusterTimePull = nullptr

histo list cluster time pull

Definition at line 141 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_ClusterTimeResolution

TList* m_histoList_ClusterTimeResolution = nullptr

histo list cluster time resolution

Definition at line 140 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_Control

TList* m_histoList_Control = nullptr

control histo

Definition at line 168 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_GoodTHinClusterTM

TList* m_histoList_GoodTHinClusterTM = nullptr

histo list good true hits in cluster truth matched

Definition at line 150 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_GoodTHinClusterTMGood

TList* m_histoList_GoodTHinClusterTMGood = nullptr

histo list goo true hits in cluster truth match good

Definition at line 151 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_PurityInsideNOTMCluster

TList* m_histoList_PurityInsideNOTMCluster = nullptr

histo list not truth matched cluster purity

Definition at line 147 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_PurityInsideTMCluster

TList* m_histoList_PurityInsideTMCluster = nullptr

histo list truth matched cluster purity (2D)

Definition at line 145 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 139 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_THinCluster

TList* m_histoList_THinCluster = nullptr

histo list true hits in cluster

Definition at line 148 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_histoList_THinClusterTM

TList* m_histoList_THinClusterTM = nullptr

histo list true hits in clsuter truth match

Definition at line 149 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mean_ClusterTimeResolution

float m_mean_ClusterTimeResolution[m_Nsets] = {0}

average cl time resid

Definition at line 117 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_ClusterUPositionResolution

float m_mean_ClusterUPositionResolution[m_Nsets] = {0}

average cl U position resol

Definition at line 119 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_ClusterVPositionResolution

float m_mean_ClusterVPositionResolution[m_Nsets] = {0}

average cl V position reosl

Definition at line 121 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_GoodTHinClusterTM

float m_mean_GoodTHinClusterTM[m_Nsets] = {0}

good true hits in cluster truth matched average

Definition at line 129 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_GoodTHinClusterTMGood

float m_mean_GoodTHinClusterTMGood[m_Nsets] = {0}

good true hits in cluster truth match good average

Definition at line 131 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_PurityInsideTMCluster

float m_mean_PurityInsideTMCluster[m_Nsets] = {0}

cluster purity average

Definition at line 123 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 115 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_THinCluster

float m_mean_THinCluster[m_Nsets] = {0}

true hits in cluster average

Definition at line 125 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_mean_THinClusterTM

float m_mean_THinClusterTM[m_Nsets] = {0}

true hits in truth matched cluster average

Definition at line 127 of file SVDClusterEvaluationTrueInfoModule.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_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 59 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NsetsRed

const int m_NsetsRed = 3
static

numbner of reduced sets

Definition at line 61 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NullVec

float m_NullVec[m_Nsets] = {0.}

null vector

Definition at line 136 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfClusters

int m_NumberOfClusters[m_Nsets] = {0}

number of clusters

Definition at line 159 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfClustersRelatedToTH

int m_NumberOfClustersRelatedToTH[m_Nsets] = {0}

number of clusters related to true hits

Definition at line 158 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfRecoDigit

int m_NumberOfRecoDigit[m_Nsets] = {0}

number of reco digits

Definition at line 156 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfShaperDigit

int m_NumberOfShaperDigit[m_Nsets] = {0}

Vectors used to compute the quantities depicted in Histos and Graphs.

Definition at line 155 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfTH

int m_NumberOfTH[m_Nsets] = {0}

numner of true hits

Definition at line 157 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfTMClusters

int m_NumberOfTMClusters[m_Nsets] = {0}

number of truth matched clusters

Definition at line 160 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfTMRecoInNOTMCluster

int m_NumberOfTMRecoInNOTMCluster = 0

number of truth matched reco digits in not truth matched clusters

Definition at line 162 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_NumberOfTMRecoInTMCluster

int m_NumberOfTMRecoInTMCluster = 0

numnber of true match reco digit in truth match cluster

Definition at line 161 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_OrderingVec

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.

Definition at line 135 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_outputFile

TFile* m_outputFile = nullptr

output file

Definition at line 64 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_outputFileName

std::string m_outputFileName = ""

output file name

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

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_RMS_ClusterTimeResolution

float m_RMS_ClusterTimeResolution[m_Nsets] = {0}

rms cluster time resid

Definition at line 118 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_ClusterUPositionResolution

float m_RMS_ClusterUPositionResolution[m_Nsets] = {0}

rms cl U position resol

Definition at line 120 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_ClusterVPositionResolution

float m_RMS_ClusterVPositionResolution[m_Nsets] = {0}

rms cl V position resol

Definition at line 122 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_GoodTHinClusterTM

float m_RMS_GoodTHinClusterTM[m_Nsets] = {0}

good true hits in cluster truth matched rms

Definition at line 130 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_GoodTHinClusterTMGood

float m_RMS_GoodTHinClusterTMGood[m_Nsets] = {0}

good true hits in cluster truth match good rms

Definition at line 132 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_PurityInsideTMCluster

float m_RMS_PurityInsideTMCluster[m_Nsets] = {0}

cluster purity rms

Definition at line 124 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_StripTimeResolution

float m_RMS_StripTimeResolution[m_Nsets] = {0}

rms of strip time residual

Definition at line 116 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_THinCluster

float m_RMS_THinCluster[m_Nsets] = {0}

true hits in cluster rms

Definition at line 126 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_RMS_THinClusterTM

float m_RMS_THinClusterTM[m_Nsets] = {0}

true hits in truth matched cluster rms

Definition at line 128 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_storeSVDEvtInfo

StoreObjPtr<SVDEventInfo> m_storeSVDEvtInfo
protected

Storage for SVDEventInfo object.

Definition at line 173 of file SVDClusterEvaluationTrueInfoModule.h.

◆ m_svdEventInfoName

std::string m_svdEventInfoName

Name of the SVDEventInfo object.

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

◆ NameOfHisto

TString NameOfHisto = ""

Strings to pass names of the histos in the vectors of hitos.

Definition at line 74 of file SVDClusterEvaluationTrueInfoModule.h.

◆ TitleOfHisto

TString TitleOfHisto = ""

Strings to pass titles of the histos in the vectors of hitos.

Definition at line 76 of file SVDClusterEvaluationTrueInfoModule.h.


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