SVDClusterEvaluationTrueInfoModule Class Reference

Clustering Performance, using true information. More...

#include <SVDClusterEvaluationTrueInfoModule.h>

Inheritance diagram for SVDClusterEvaluationTrueInfoModule:

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

Public Member Functions
	SVDClusterEvaluationTrueInfoModule ()
	constructor
virtual void	initialize () override
	Initialize the SVDClusterEvaluationTrueInfo.
virtual void	event () override
	This method is the core of the SVDClusterEvaluationTrueInfo.
virtual void	endRun () override
	This method is called if the current run ends.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
virtual void	beginRun ()
	Called when entering a new run.
virtual void	terminate ()
	This method is called at the end of the event processing.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T>
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

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

Static Protected Member Functions
static int	indexFromLayerSensorSide (int LayerNumber, int SensorNumber, int UVNumber)
	Function returning the index used for Histos.
static TString	IntExtFromIndex (int idx)
	Function returning "Internal" or "External" depending on the index.
static TString	FWFromIndex (int idx)
	Function returning "Forward" or "Backward" depending on the index.
static TString	UVFromIndex (int idx)
	Function returning "U" or "V" depending on the index.
static void	createEfficiencyGraph (const char *name, const char *title, const int vNum[m_Nsets], const 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.
static 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.
static 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 arbitrarily defined TGraph with arrays length equal to m_Nsets.
static 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 arbitrarily defined TGraph with arrays length equal to m_NsetsRed.

Protected Attributes
StoreObjPtr< SVDEventInfo >	m_storeSVDEvtInfo
	Storage for SVDEventInfo object.

Private Member Functions
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

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

Detailed Description

Clustering Performance, using true information.

Definition at line 34 of file SVDClusterEvaluationTrueInfoModule.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

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

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

SVDClusterEvaluationTrueInfoModule()

SVDClusterEvaluationTrueInfoModule

(

)

constructor

Definition at line 31 of file SVDClusterEvaluationTrueInfoModule.cc.

                                                                       : Module()
{
  setDescription("This modules generates performance plots on SVD clustering.");
 
  addParam("outputFileName", m_outputFileName, "output rootfile name", std::string("SVDClusterEvaluationTrueInfo.root"));
  addParam("SVDEventInfo", m_svdEventInfoName, "Defines the name of the EventInfo", std::string(""));
}

~SVDClusterEvaluationTrueInfoModule()

~SVDClusterEvaluationTrueInfoModule ( )

overridevirtual

Definition at line 40 of file SVDClusterEvaluationTrueInfoModule.cc.

{
}

Member Function Documentation

beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented in AnalysisPhase1StudyModule, ARICHBackgroundModule, arichBtestModule, ARICHDigitizerModule, ARICHDQMModule, ARICHRateCalModule, ARICHReconstructorModule, AWESOMEBasicModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgHitRateMonitorModule, BeamBkgNeutronModule, BeamSpotMonitorModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CATFinderModule, CaveModule, CDCCosmicAnalysisModule, CDCPackerModule, CDCUnpackerModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTrigger2DFinderModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerTSFModule, CDCTriggerUnpackerModule, CertifyParallelModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, Convert2RawDetModule, CreateFieldMapModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlTaggerModule, DAQMonitorModule, DAQPerfModule, DelayDQMModule, DeSerializerPXDModule, DetectorOccupanciesDQMModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEcmsMonObjModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputRootFileModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisKLMModule, DQMHistAnalysisKLMMonObjModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDBowModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTrackingHLTModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGGDLModule, DQMHistAnalysisTRGModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistInjectionModule, DqmHistoManagerModule, DQMHistoModuleBase, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLDQMInjectionModule, EclBackgroundStudyModule, ECLChargedPIDModule, ECLChargedPIDMVAModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDigitCalibratorModule, ECLDigitizerModule, EclDisplayModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLDQMOutOfTimeDigitsModule, ECLExpertModule, ECLFinalizerModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, EffPlotsModule, ElapsedTimeModule, EnergyBiasCorrectionModule, EventInfoPrinterModule, EventLimiterModule, EventsOfDoomBusterModule, EventT0DQMModule, EventT0ValidationModule, EvReductionModule, EvtGenDecayModule, EvtGenInputModule, ExportGeometryModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastRbuf2DsModule, FlippedRecoTracksMergerModule, FlipQualityModule, TRGGDLUnpackerModule, GearboxModule, GenRawSendModule, GetEventFromSocketModule, GRLNeuroModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HistoManagerModule, HLTDQM2ZMQModule, IoVDependentConditionModule, IPDQMModule, KinkFinderModule, KKGenInputModule, KLMDigitizerModule, KLMDigitTimeShifterModule, KLMDQM2Module, KLMDQMModule, KLMEventT0EstimatorModule, KLMExpertModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MaterialScanModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, MonitorDataModule, MuidModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, NtuplePhase1_v6Module, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, ParticleVertexFitterModule, Ph1bpipeModule, Ph1sustrModule, PhotonEfficiencySystematicsModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleEcmsBBModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PhysicsObjectsMiraBelleTauModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, ProgressModule, PXDBgTupleProducerModule, PXDClusterizerModule, PXDDAQDQMModule, PXDDigitizerModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDMCBgTupleProducerModule, PXDPackerModule, PXDRawDQMChipsModule, PXDRawDQMModule, PXDROIDQMModule, PXDUnpackerModule, PXDclusterFilterModule, PXDdigiFilterModule, PXDDQMBowingModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDPerformanceModule, PXDRawDQMCorrModule, PXDROIFinderAnalysisModule, PXDROIFinderModule, PXDTrackClusterDQMModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, QualityEstimatorVXDModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, RecoTracksReverterModule, ReprocessorModule, RxSocketModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SegmentNetworkProducerModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SoftwareTriggerHLTDQMModule, SoftwareTriggerModule, StatisticsTimingHLTDQMModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, SrsensorModule, StatisticsSummaryModule, StorageDeserializerModule, StorageSerializerModule, SubEventModule, SVDClusterizerModule, SVDDigitizerModule, SVDDQMDoseModule, SVDDQMInjectionModule, SVDMissingAPVsClusterCreatorModule, SVDPackerModule, SVDRecoDigitCreatorModule, SVDUnpackerModule, SVDB4CommissioningPlotsModule, SVDClusterCalibrationsMonitorModule, SVDClusterEvaluationModule, SVDDataFormatCheckModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, SVDDQMHitTimeModule, svdDumpModule, SVDEventInfoSetterModule, SVDEventT0EstimatorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsCheckModule, SVDLocalCalibrationsMonitorModule, SVDMaxStripTTreeModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPerformanceTTreeModule, SVDPositionErrorScaleFactorImporterModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDSpacePointCreatorModule, SVDTimeCalibrationsMonitorModule, SVDTimeGroupingModule, SVDUnpackerDQMModule, SwitchDataStoreModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelMaskerModule, TOPDigitizerModule, TOPDoublePulseGeneratorModule, TOPDQMModule, TOPModuleT0CalibratorModule, TOPRawDigitConverterModule, TOPTimeRecalibratorModule, TOPUnpackerModule, TrackAnaModule, TrackCreatorModule, TrackFinderMCTruthRecoTracksModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, TrackingAbortDQMModule, TrackingEnergyLossCorrectionModule, TrackingMomentumScaleFactorsModule, TrackingPerformanceEvaluationModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCHitsRemover >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackingUtilities::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackingUtilities::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackQualityEstimatorMVAModule, TreeFitterModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLInjectionVetoFromOverlayModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TTDDQMModule, TxModule, TxSocketModule, V0findingPerformanceEvaluationModule, V0ObjectsDQMModule, VXDMisalignmentModule, vxdDigitMaskingModule, VXDDQMExpressRecoModule, VXDQETrainingDataCollectorModule, VXDQualityEstimatorMVAModule, and VXDSimpleClusterizerModule.

Definition at line 146 of file Module.h.

{};

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.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

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 )

staticprotected

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

Definition at line 754 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  TCanvas* c = new TCanvas(name, title);
  TGraphErrors* g = new TGraphErrors(m_NsetsRed, x, y, xErr, yErr);
  g->SetName(name);
  g->SetTitle(title);
  g->GetXaxis()->SetTitle(xTitle.Data());
  g->GetYaxis()->SetTitle(yTitle.Data());
  g->Draw("AP");
  g->SetMarkerStyle(20);
  g->SetMarkerSize(0.8);
  TAxis* xAxis = g->GetXaxis();
 
  TText* t = new TText();
  t->SetTextAlign(32);
  t->SetTextSize(0.035);
  t->SetTextFont(72);
  TString labels[m_NsetsRed] = {"3", "456F", "456B"};
  for (Int_t i = 0; i < m_NsetsRed; i++) {
    xAxis->SetBinLabel(xAxis->FindBin(i + 1), labels[i].Data());
  }
 
  if (list)
    list->Add(c);
 
}

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 )

staticprotected

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

Definition at line 725 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  TCanvas* c = new TCanvas(name, title);
  TGraphErrors* g = new TGraphErrors(m_Nsets, x, y, xErr, yErr);
  g->SetName(name);
  g->SetTitle(title);
  g->GetXaxis()->SetTitle(xTitle.Data());
  g->GetYaxis()->SetTitle(yTitle.Data());
  g->Draw("AP");
  g->SetMarkerStyle(20);
  g->SetMarkerSize(0.8);
  TAxis* xAxis = g->GetXaxis();
 
  TText* t = new TText();
  t->SetTextAlign(32);
  t->SetTextSize(0.035);
  t->SetTextFont(72);
  TString labels[m_Nsets] = {"3U", "3V", "456FU", "456FV", "456BU", "456BV"};
  for (Int_t i = 0; i < m_Nsets; i++) {
    xAxis->SetBinLabel(xAxis->FindBin(i + 1), labels[i].Data());
  }
 
  if (list)
    list->Add(c);
 
}

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 )

staticprotected

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

Definition at line 714 of file SVDClusterEvaluationTrueInfoModule.cc.

{
  if (len == m_NsetsRed)
    createArbitraryGraphError_Red(name, title, x, xErr, y, yErr, xTitle, yTitle, list);
  else if (len == m_Nsets)
    createArbitraryGraphError_Std(name, title, x, xErr, y, yErr, xTitle, yTitle, list);
  else
    B2INFO("ERROR, WRONG LENGTH FOR MEANS TGRAPH CREATION!!!");
}

createEfficiencyGraph()

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

staticprotected

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 666 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  float ratio[m_Nsets];
  float ratioErr[m_Nsets];
  float x[m_Nsets];
  float xErr[m_Nsets];
 
  for (int set = 0; set < m_Nsets; set++) {
 
    x[set] = set + 1;
    xErr[set] = 0;
 
    if (vDen[set] > 0) {
      ratio[set] = (float)vNum[set] / (float)vDen[set];
      ratioErr[set] = sqrt(ratio[set] * (1 - ratio[set]) / (float)vDen[set]);
    }
 
  }
 
  TCanvas* c = new TCanvas(name, title);
  TGraphErrors* g = new TGraphErrors(m_Nsets, x, ratio, xErr, ratioErr);
  g->SetName(name);
  g->SetTitle(title);
  g->GetXaxis()->SetTitle(xTitle.Data());
  g->GetYaxis()->SetTitle(yTitle.Data());
  g->GetYaxis()->SetRangeUser(0.00001, 1.10);
  g->Draw("AP");
  g->SetMarkerStyle(20);
  g->SetMarkerSize(0.8);
  TAxis* xAxis = g->GetXaxis();
 
  TText* t = new TText();
  t->SetTextAlign(32);
  t->SetTextSize(0.035);
  t->SetTextFont(72);
  TString labels[m_Nsets] = {"3U", "3V", "456FU", "456FV", "456BU", "456BV"};
  for (Int_t i = 0; i < m_Nsets; i++) {
    xAxis->SetBinLabel(xAxis->FindBin(i + 1), labels[i].Data());
  }
 
  if (list)
    list->Add(c);
 
}

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 572 of file SVDClusterEvaluationTrueInfoModule.cc.

{
  TH1F* h = new TH1F(name, title, nbins, min, max);
 
  h->GetXaxis()->SetTitle(xtitle);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

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 586 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  TH2F* h = new TH2F(name, title, nbinsX, minX, maxX, nbinsY, minY, maxY);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

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 425 of file Module.h.

{ beginRun(); }

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 438 of file Module.h.

{ endRun(); }

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 431 of file Module.h.

{ event(); }

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 419 of file Module.h.

{ initialize(); }

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 444 of file Module.h.

{ terminate(); }

endRun()

void endRun ( void )

overridevirtual

This method is called if the current run ends.

Reimplemented from Module.

Definition at line 386 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  //extract mean and sigma values from histos to plot them in graphs
  for (int k = 0; k < m_Nsets; k ++) {
    m_mean_StripTimeResolution[k] = m_histo_StripTimeResolution[k]->GetMean();
    m_RMS_StripTimeResolution[k] = m_histo_StripTimeResolution[k]->GetRMS();
 
    m_mean_ClusterTimeResolution[k] = m_histo_ClusterTimeResolution[k]->GetMean();
    m_RMS_ClusterTimeResolution[k] = m_histo_ClusterTimeResolution[k]->GetRMS();
 
    m_mean_PurityInsideTMCluster[k] = m_histo_PurityInsideTMCluster[k]->GetMean();
    m_RMS_PurityInsideTMCluster[k] = m_histo_PurityInsideTMCluster[k]->GetRMS() / sqrt(m_histo_PurityInsideTMCluster[k]->GetEntries());
 
    m_mean_THinCluster[k] = m_histo_THinCluster[k]->GetMean();
    m_RMS_THinCluster[k] = m_histo_THinCluster[k]->GetRMS() / sqrt(m_histo_THinCluster[k]->GetEntries());
 
    m_mean_THinClusterTM[k] = m_histo_THinClusterTM[k]->GetMean();
    m_RMS_THinClusterTM[k] = m_histo_THinClusterTM[k]->GetRMS() / sqrt(m_histo_THinClusterTM[k]->GetEntries());
 
    m_mean_GoodTHinClusterTM[k] = m_histo_GoodTHinClusterTM[k]->GetMean();
    m_RMS_GoodTHinClusterTM[k] = m_histo_GoodTHinClusterTM[k]->GetRMS() / sqrt(m_histo_GoodTHinClusterTM[k]->GetEntries());
 
    m_mean_GoodTHinClusterTMGood[k] = m_histo_GoodTHinClusterTMGood[k]->GetMean();
    m_RMS_GoodTHinClusterTMGood[k] = m_histo_GoodTHinClusterTMGood[k]->GetRMS() / sqrt(m_histo_GoodTHinClusterTMGood[k]->GetEntries());
  }
  for (int k = 0; k < m_NsetsRed; k ++) {
    m_mean_ClusterUPositionResolution[k] = m_histo_ClusterUPositionResolution[k]->GetMean();
    m_RMS_ClusterUPositionResolution[k] = m_histo_ClusterUPositionResolution[k]->GetRMS();
 
    m_mean_ClusterVPositionResolution[k] = m_histo_ClusterVPositionResolution[k]->GetMean();
    m_RMS_ClusterVPositionResolution[k] = m_histo_ClusterVPositionResolution[k]->GetRMS();
  }
 
  //GRAPHS
  createEfficiencyGraph("recoEff", "Strip Fit Efficiency ( RecoDigits / ShaperDigits )", m_NumberOfRecoDigit, m_NumberOfShaperDigit,
                        "set", "efficiency", m_graphList);
 
  createEfficiencyGraph("clusterEff", "Clustering Efficiency ( Truth-Matched Clusters / TrueHits )", m_NumberOfClustersRelatedToTH,
                        m_NumberOfTH, "set", "efficiency", m_graphList);
 
  createEfficiencyGraph("clusterPurity", "Purity of Clusters ( Truth-Matched Clusters / All Clusters )", m_NumberOfTMClusters,
                        m_NumberOfClusters, "set", "purity", m_graphList);
 
  //means-from-histos graphs
  createArbitraryGraphErrorChooser("stripTime_Means", "Strip Time Resolution", m_OrderingVec, m_NullVec, m_mean_StripTimeResolution,
                                   m_RMS_StripTimeResolution, "set", "time residuals (ns)", m_graphList, m_Nsets);
 
  createArbitraryGraphErrorChooser("clusterTime_Means", "Cluster Time Resolution", m_OrderingVec, m_NullVec,
                                   m_mean_ClusterTimeResolution, m_RMS_ClusterTimeResolution, "set", "time residuals (ns)", m_graphList, m_Nsets);
 
  createArbitraryGraphErrorChooser("clusterUposition_Means", "Cluster U Position Resolution", m_OrderingVec, m_NullVec,
                                   m_mean_ClusterUPositionResolution, m_RMS_ClusterUPositionResolution, "set", "U position residuals (cm)", m_graphList,
                                   m_NsetsRed);
 
  createArbitraryGraphErrorChooser("clusterVposition_Means", "Cluster V Position Resolution", m_OrderingVec, m_NullVec,
                                   m_mean_ClusterVPositionResolution, m_RMS_ClusterVPositionResolution, "set", "V position residuals (cm)", m_graphList,
                                   m_NsetsRed);
 
  createArbitraryGraphErrorChooser("clusterInternalPurity_Means", "Fraction of Truth-matched Recos inside a Truth-matched Cluster",
                                   m_OrderingVec, m_NullVec, m_mean_PurityInsideTMCluster, m_RMS_PurityInsideTMCluster, "set",
                                   "number of TM recos / cluster size", m_graphList, m_Nsets);
 
  createArbitraryGraphErrorChooser("THinCluster_Means", "Number of True Hits inside a Cluster", m_OrderingVec, m_NullVec,
                                   m_mean_THinCluster, m_RMS_THinCluster, "set", "number of TH per cluster", m_graphList, m_Nsets);
 
  createArbitraryGraphErrorChooser("THinClusterTM_Means", "Number of True Hits inside a TM Cluster", m_OrderingVec, m_NullVec,
                                   m_mean_THinClusterTM, m_RMS_THinClusterTM, "set", "number of TH per TM cluster", m_graphList, m_Nsets);
 
  createArbitraryGraphErrorChooser("goodTHinClusterTM_Means", "Number of Good True Hits inside a TM Cluster", m_OrderingVec,
                                   m_NullVec,
                                   m_mean_GoodTHinClusterTM, m_RMS_GoodTHinClusterTM, "set", "number of Good TH per TM cluster", m_graphList, m_Nsets);
 
  createArbitraryGraphErrorChooser("goodTHinClusterTMGood_Means", "Number of Good True Hits inside a Good TM Cluster", m_OrderingVec,
                                   m_NullVec,
                                   m_mean_GoodTHinClusterTMGood, m_RMS_GoodTHinClusterTMGood, "set", "number of Good TH per Good TM cluster", m_graphList, m_Nsets);
  //WRITE HISTOS AND GRAPHS//
 
  if (m_outputFile != nullptr) {
    m_outputFile->cd();
 
    TDirectory* oldDir = gDirectory;
    TObject* obj;
 
    TDirectory* dir_strtime = oldDir->mkdir("strip_time");
    dir_strtime->cd();
    TIter nextH_strtime(m_histoList_StripTimeResolution);
    while ((obj = nextH_strtime()))
      obj->Write();
 
    TDirectory* dir_cltime = oldDir->mkdir("cluster_time");
    dir_cltime->cd();
    TIter nextH_cltime(m_histoList_ClusterTimeResolution);
    while ((obj = nextH_cltime()))
      obj->Write();
 
    TDirectory* dir_cltimepull = oldDir->mkdir("cluster_time_pull");
    dir_cltimepull->cd();
    TIter nextH_cltimepull(m_histoList_ClusterTimePull);
    while ((obj = nextH_cltimepull()))
      obj->Write();
 
    TDirectory* dir_clpos = oldDir->mkdir("cluster_position");
    dir_clpos->cd();
    TIter nextH_clpos(m_histoList_ClusterPositionResolution);
    while ((obj = nextH_clpos()))
      obj->Write();
 
    TDirectory* dir_clpospull = oldDir->mkdir("cluster_position_pull");
    dir_clpospull->cd();
    TIter nextH_clpospull(m_histoList_ClusterPositionPull);
    while ((obj = nextH_clpospull()))
      obj->Write();
 
    TDirectory* dir_clpostime = oldDir->mkdir("cluster_timeVSposition");
    dir_clpostime->cd();
    TIter nextH_clpostime(m_histo2DList_TresVsPosres);
    while ((obj = nextH_clpostime()))
      obj->Write();
 
    TDirectory* dir_clinpurTM = oldDir->mkdir("intra_cluster_purity_TM");
    dir_clinpurTM->cd();
    TIter nextH_clinpurTM(m_histoList_PurityInsideTMCluster);
    while ((obj = nextH_clinpurTM()))
      obj->Write();
 
    TDirectory* dir_clinpurTM2D = oldDir->mkdir("intra_cluster_purity_TM2D");
    dir_clinpurTM2D->cd();
    TIter nextH_clinpurTM2D(m_histo2DList_PurityInsideTMCluster);
    while ((obj = nextH_clinpurTM2D()))
      obj->Write();
 
    TDirectory* dir_clinpurNOTM = oldDir->mkdir("intra_cluster_purity_NOTM");
    dir_clinpurNOTM->cd();
    TIter nextH_clinpurNOTM(m_histoList_PurityInsideNOTMCluster);
    while ((obj = nextH_clinpurNOTM()))
      obj->Write();
 
    TDirectory* dir_puddle = oldDir->mkdir("trueHits_in_cluster");
    dir_puddle->cd();
    TIter nextH_puddle(m_histoList_THinCluster);
    while ((obj = nextH_puddle()))
      obj->Write();
 
    TDirectory* dir_puddleTM = oldDir->mkdir("trueHits_in_TMcluster");
    dir_puddleTM->cd();
    TIter nextH_puddleTM(m_histoList_THinClusterTM);
    while ((obj = nextH_puddleTM()))
      obj->Write();
 
    TDirectory* dir_goodPuddleTM = oldDir->mkdir("goodTrueHits_in_TMcluster");
    dir_goodPuddleTM->cd();
    TIter nextH_GoodPuddleTM(m_histoList_GoodTHinClusterTM);
    while ((obj = nextH_GoodPuddleTM()))
      obj->Write();
 
    TDirectory* dir_goodPuddleTMGood = oldDir->mkdir("goodTrueHits_in_GoodTMcluster");
    dir_goodPuddleTMGood->cd();
    TIter nextH_GoodPuddleTMGood(m_histoList_GoodTHinClusterTMGood);
    while ((obj = nextH_GoodPuddleTMGood()))
      obj->Write();
 
    TDirectory* dir_graph = oldDir->mkdir("graphs");
    dir_graph->cd();
    TIter nextH_graph(m_graphList);
    while ((obj = nextH_graph()))
      obj->Write();
 
    TDirectory* dir_controlsMC = oldDir->mkdir("controlMC");
    dir_controlsMC->cd();
    TIter nextH_controlsMC(m_histoList_Control);
    while ((obj = nextH_controlsMC()))
      obj->Write();
 
    m_outputFile->Close();
  }
}

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.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( void )

overridevirtual

This method is the core of the SVDClusterEvaluationTrueInfo.

Reimplemented from Module.

Definition at line 206 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  SVDModeByte modeByte = m_storeSVDEvtInfo->getModeByte();
 
  StoreArray<SVDShaperDigit> SVDShaperDigits;
  StoreArray<SVDRecoDigit> SVDRecoDigits;
  StoreArray<SVDCluster> SVDClusters;
  StoreArray<SVDTrueHit> SVDTrueHits;

  //STRIPS//
 
  //loop on ShaperDigits
  for (const SVDShaperDigit& shape : SVDShaperDigits) {
    indexForHistosAndGraphs = indexFromLayerSensorSide(shape.getSensorID().getLayerNumber(), shape.getSensorID().getSensorNumber(),
                                                       shape.isUStrip());
 
    RelationVector<SVDRecoDigit> relatVectorShaperToReco = DataStore::getRelationsWithObj<SVDRecoDigit>(&shape);
 
    //efficiency shaper to reco
    m_NumberOfShaperDigit[indexForHistosAndGraphs] ++;
    if (relatVectorShaperToReco.size() > 0)
      m_NumberOfRecoDigit[indexForHistosAndGraphs] ++;
  }
  //close loop on ShaperDigits
 
  //loop on RecoDigits
  for (const SVDRecoDigit& reco : SVDRecoDigits) {
    indexForHistosAndGraphs = indexFromLayerSensorSide(reco.getSensorID().getLayerNumber(), reco.getSensorID().getSensorNumber(),
                                                       reco.isUStrip());
 
    RelationVector<SVDTrueHit> relatVectorRecoToTH = DataStore::getRelationsWithObj<SVDTrueHit>(&reco);
 
    //strip time resolution
    if (relatVectorRecoToTH.size() > 0)
      m_histo_StripTimeResolution[indexForHistosAndGraphs]->Fill(reco.getTime() - (relatVectorRecoToTH[0])->getGlobalTime());
 
  }
  //close loop on RecoDigits

  //CLUSTERS//
 
  //loop on TrueHits
  for (const SVDTrueHit& trhi : SVDTrueHits) {
 
    if (goodTrueHit(&trhi)) { //enter only if the TH is related to a primary and charged MC particle
      indexForHistosAndGraphs = indexFromLayerSensorSide(trhi.getSensorID().getLayerNumber(), trhi.getSensorID().getSensorNumber(), 1);
 
      RelationVector<SVDCluster> relatVectorTHToClus = DataStore::getRelationsWithObj<SVDCluster>(&trhi);
 
      //efficiencies TH to cluster
      m_NumberOfTH[indexForHistosAndGraphs] ++; //U
      m_NumberOfTH[indexForHistosAndGraphs + 1] ++; //V
 
      bool hasU = false;
      bool hasV = false;
 
      for (int j = 0; j < (int) relatVectorTHToClus.size(); j ++) {
        indexForHistosAndGraphs = indexFromLayerSensorSide(relatVectorTHToClus[j]->getSensorID().getLayerNumber(),
                                                           relatVectorTHToClus[j]->getSensorID().getSensorNumber(), relatVectorTHToClus[j]->isUCluster());
 
        if (relatVectorTHToClus[j]->isUCluster() && ! hasU) {
          m_NumberOfClustersRelatedToTH[indexForHistosAndGraphs] ++;
          hasU = true;
        } else if (!relatVectorTHToClus[j]->isUCluster() && ! hasV) {
          m_NumberOfClustersRelatedToTH[indexForHistosAndGraphs] ++;
          hasV = true;
        }
      }
    }
  }
  //close loop on TrueHits
 
  //loop on Clusters
  for (const SVDCluster& clus : SVDClusters) {
    indexForHistosAndGraphs = indexFromLayerSensorSide(clus.getSensorID().getLayerNumber(), clus.getSensorID().getSensorNumber(),
                                                       clus.isUCluster());
 
    RelationVector<SVDTrueHit> relatVectorClusToTH = DataStore::getRelationsWithObj<SVDTrueHit>(&clus);
 
    //purity "outside" clusters
    m_NumberOfClusters[indexForHistosAndGraphs] ++;
    if (relatVectorClusToTH.size() > 0)
      m_NumberOfTMClusters[indexForHistosAndGraphs] ++;
 
    //fill the THinCluster histo with the number of TH a cluster is composed of
    m_histo_THinCluster[indexForHistosAndGraphs]->Fill(relatVectorClusToTH.size());
 
    //loop on the TH related to the cluster
    for (int q = 0; q < (int)relatVectorClusToTH.size(); q ++) {
      //cluster time resolution and pull
      m_histo_ClusterTimeResolution[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
 
      //get trigger bin
      int triggerBin = 0;
      triggerBin = (int)modeByte.getTriggerBin();
 
      if (triggerBin == 0)
        m_histo_ClusterTimeResolution_bin1[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
      else if (triggerBin == 1)
        m_histo_ClusterTimeResolution_bin2[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
      else if (triggerBin == 2)
        m_histo_ClusterTimeResolution_bin3[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
      else if (triggerBin == 3)
        m_histo_ClusterTimeResolution_bin4[indexForHistosAndGraphs]->Fill(clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime());
 
      m_histo_ClusterTimePull[indexForHistosAndGraphs]->Fill((clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime()) /
                                                             (clus.getClsTimeSigma()));
 
      //cluster position resolution and pull, also correlation between time res and position res
      if (clus.isUCluster()) {
        m_histo_ClusterUPositionResolution[indexForHistosAndGraphs / 2]->Fill(clus.getPosition((relatVectorClusToTH[q])->getV()) -
            (relatVectorClusToTH[q])->getU());
        m_histo_ClusterUPositionPull[indexForHistosAndGraphs / 2]->Fill((clus.getPosition((relatVectorClusToTH[q])->getV()) -
            (relatVectorClusToTH[q])->getU()) / (clus.getPositionSigma()));
        m_histo2D_TresVsPosres[indexForHistosAndGraphs]->Fill((clus.getPosition((relatVectorClusToTH[q])->getV()) -
                                                               (relatVectorClusToTH[q])->getU()), (clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime()));
      } else {
        m_histo_ClusterVPositionResolution[(indexForHistosAndGraphs - 1) / 2]->Fill(clus.getPosition() - (relatVectorClusToTH[q])->getV());
        m_histo_ClusterVPositionPull[(indexForHistosAndGraphs - 1) / 2]->Fill((clus.getPosition() - (relatVectorClusToTH[q])->getV()) /
            (clus.getPositionSigma()));
        m_histo2D_TresVsPosres[indexForHistosAndGraphs]->Fill((clus.getPosition() - (relatVectorClusToTH[q])->getV()),
                                                              (clus.getClsTime() - (relatVectorClusToTH[q])->getGlobalTime()));
      }
    }
 
    RelationVector<SVDRecoDigit> relatVectorClusToReco = DataStore::getRelationsWithObj<SVDRecoDigit>(&clus);
    //enter only if the cluster is TM
    if (relatVectorClusToTH.size() > 0) {
 
      //fill the THinCluster histo with the number of TH (and good TH) a TM cluster (and a Good TM cluster) is composed of
      m_histo_THinClusterTM[indexForHistosAndGraphs]->Fill(relatVectorClusToTH.size());
      int numberOfGoodTHInACluster = 0;
      int numberOfGoodTHInAClusterGood = 0;
      for (int k = 0; k < (int)(relatVectorClusToTH.size()); k ++) {
        if (goodTrueHit(relatVectorClusToTH[k])) {
          numberOfGoodTHInACluster ++;
          numberOfGoodTHInAClusterGood ++;
        }
      }
      m_histo_GoodTHinClusterTM[indexForHistosAndGraphs]->Fill(numberOfGoodTHInACluster);
      if (numberOfGoodTHInAClusterGood > 0)
        m_histo_GoodTHinClusterTMGood[indexForHistosAndGraphs]->Fill(numberOfGoodTHInAClusterGood);
 
      //count number of recodigit, composing the Truth-matched cluster, that are linked with a TH (internal purity)
      m_NumberOfTMRecoInTMCluster = 0;
      for (int k = 0; k < (int)relatVectorClusToReco.size(); k++) { //loop on the recodigits composing the TM cluster
        RelationVector<SVDTrueHit> relatVectorRecoFromClusToTH = DataStore::getRelationsWithObj<SVDTrueHit>(relatVectorClusToReco[k]);
 
        if (relatVectorRecoFromClusToTH.size() > 0)
          m_NumberOfTMRecoInTMCluster ++;
      }
 
      m_histo_PurityInsideTMCluster[indexForHistosAndGraphs]->Fill((float)m_NumberOfTMRecoInTMCluster / (float)(clus.getSize()));
      m_histo2D_PurityInsideTMCluster[indexForHistosAndGraphs]->Fill(clus.getSize(), m_NumberOfTMRecoInTMCluster);
 
    }
    //count number of recodigit, composing a NOT Truth-matched cluster, that are linked with a TH
    else {
 
      m_NumberOfTMRecoInNOTMCluster = 0;
      for (int k = 0; k < (int)relatVectorClusToReco.size(); k++) { //loop on the recodigits composing the NOTM cluster
        RelationVector<SVDTrueHit> relatVectorRecoFromClusToTH = DataStore::getRelationsWithObj<SVDTrueHit>(relatVectorClusToReco[k]);
 
        if (relatVectorRecoFromClusToTH.size() > 0)
          m_NumberOfTMRecoInNOTMCluster ++;
      }
 
      m_histo_PurityInsideNOTMCluster[indexForHistosAndGraphs]->Fill((float)m_NumberOfTMRecoInNOTMCluster / (float)(clus.getSize()));
 
    }
  }
  //close loop on clusters
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional paths */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "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.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

FWFromIndex()

TString FWFromIndex ( int idx )

staticprotected

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

Definition at line 642 of file SVDClusterEvaluationTrueInfoModule.cc.

{
  TString name = "";
 
  if (idx == 2 || idx == 3)
    name = "FWD";
  else
    name = "Barrel";
 
  return name;
}

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.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

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.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 313 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

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.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

{return m_description;}

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

Definition at line 133 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

{ 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 186 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

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

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

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 380 of file Module.h.

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

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

goodTrueHit()

bool goodTrueHit ( const SVDTrueHit * thino )

protected

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

Definition at line 783 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
 
  bool isGood = false;
 
  RelationVector<MCParticle> relatVectorTHToMC = thino->getRelationsFrom<MCParticle>();
 
  if (relatVectorTHToMC.size() > 0) {
 
    m_histoControl_THToMCsize->Fill(relatVectorTHToMC.size());
 
    float charge = relatVectorTHToMC[0]->getCharge();
    bool primary = relatVectorTHToMC[0]->isPrimaryParticle();
 
    m_histoControl_MCcharge->Fill(charge);
    m_histoControl_MCisPrimary->Fill(primary);
 
    if (charge != 0 && primary)
      isGood = true;
  }
 
  return isGood;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 310 of file Module.h.

{ 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

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 377 of file Module.h.

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

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

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

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

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

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

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

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

indexFromLayerSensorSide()

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

staticprotected

Function returning the index used for Histos.

Definition at line 604 of file SVDClusterEvaluationTrueInfoModule.cc.

{
  int Index;
 
  if (LayerNumber == 3) { //L3
    if (UVNumber) //U
      Index = 0;
    else //V
      Index = 1;
  } else { //L456
    if (SensorNumber == 1) { //FW
      if (UVNumber) //U
        Index = 2;
      else //V
        Index = 3;
    } else { //barrel
      if (UVNumber) //U
        Index = 4;
      else //V
        Index = 5;
    }
  }
 
  return Index;
}

initialize()

void initialize ( void )

overridevirtual

Initialize the SVDClusterEvaluationTrueInfo.

Reimplemented from Module.

Definition at line 45 of file SVDClusterEvaluationTrueInfoModule.cc.

{
 
  /* initialize useful store array */
  StoreArray<SVDShaperDigit> SVDShaperDigits;
  StoreArray<SVDRecoDigit> SVDRecoDigits;
  StoreArray<SVDCluster> SVDClusters;
  StoreArray<SVDTrueHit> SVDTrueHits;
 
  SVDShaperDigits.isRequired();
  SVDRecoDigits.isRequired();
  SVDClusters.isRequired();
  SVDTrueHits.isRequired();
  if (!m_storeSVDEvtInfo.isOptional(m_svdEventInfoName)) m_svdEventInfoName = "SVDEventInfoSim";
  m_storeSVDEvtInfo.isRequired(m_svdEventInfoName);
 
 
  m_outputFile = new TFile(m_outputFileName.c_str(), "RECREATE");
 
  m_histoList_StripTimeResolution = new TList;
  m_histoList_ClusterTimeResolution = new TList;
  m_histoList_ClusterTimePull = new TList;
  m_histoList_ClusterPositionResolution = new TList;
  m_histoList_ClusterPositionPull = new TList;
  m_histo2DList_TresVsPosres = new TList;
  m_histoList_PurityInsideTMCluster = new TList;
  m_histo2DList_PurityInsideTMCluster = new TList;
  m_histoList_PurityInsideNOTMCluster = new TList;
  m_histoList_THinCluster = new TList;
  m_histoList_THinClusterTM = new TList;
  m_histoList_GoodTHinClusterTM = new TList;
  m_histoList_GoodTHinClusterTMGood = new TList;
  m_graphList = new TList;
  //Control List
  m_histoList_Control = new TList;
 
  for (int i = 0; i < m_Nsets; i ++) {
 
    if (i % 2 == 0) { //even index, U side
      NameOfHisto = "histo_ClusterUPositionResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
      TitleOfHisto = "U-Cluster Position Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
      m_histo_ClusterUPositionResolution[i / 2] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -0.1, 0.1,
                                                  "U_reco - U_true (cm)",
                                                  m_histoList_ClusterPositionResolution);
 
      NameOfHisto = "histo_ClusterUPositionPull_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
      TitleOfHisto = "U-Cluster Position Pull (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
      m_histo_ClusterUPositionPull[i / 2] = createHistogram1D(NameOfHisto, TitleOfHisto, 210, -10, 11,
                                                              "(U_reco - U_true)/U_sigma",
                                                              m_histoList_ClusterPositionPull);
    } else { //odd index, V side
      NameOfHisto = "histo_ClusterVPositionResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
      TitleOfHisto = "V-Cluster Position Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
      m_histo_ClusterVPositionResolution[(i - 1) / 2] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -0.1, 0.1,
                                                        "V_reco - V_true (cm)", m_histoList_ClusterPositionResolution);
 
      NameOfHisto = "histo_ClusterVPositionPull_" + IntExtFromIndex(i) + "_" + FWFromIndex(i);
      TitleOfHisto = "Cluster V Position Pull (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ")";
      m_histo_ClusterVPositionPull[(i - 1) / 2] = createHistogram1D(NameOfHisto, TitleOfHisto, 210, -10, 11,
                                                  "(V_reco- V_true)/V_sigma", m_histoList_ClusterPositionPull);
    }
 
    NameOfHisto = "histo_StripTimeResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Strip Time Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
    m_histo_StripTimeResolution[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
                                                       m_histoList_StripTimeResolution);
 
    NameOfHisto = "histo_ClusterTimeResolution_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Cluster Time Resolution (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
    m_histo_ClusterTimeResolution[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
                                                         m_histoList_ClusterTimeResolution);
 
    NameOfHisto = "histo_ClusterTimeResolution_bin1_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Cluster Time Resolution TriggerBin=1(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
                     i) + ")";
    m_histo_ClusterTimeResolution_bin1[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
                                                              m_histoList_ClusterTimeResolution);
    NameOfHisto = "histo_ClusterTimeResolution_bin2_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Cluster Time Resolution TriggerBin=2(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
                     i) + ")";
    m_histo_ClusterTimeResolution_bin2[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
                                                              m_histoList_ClusterTimeResolution);
    NameOfHisto = "histo_ClusterTimeResolution_bin3_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Cluster Time Resolution TriggerBin=3(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
                     i) + ")";
    m_histo_ClusterTimeResolution_bin3[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
                                                              m_histoList_ClusterTimeResolution);
    NameOfHisto = "histo_ClusterTimeResolution_bin4_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Cluster Time Resolution TriggerBin=4(" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
                     i) + ")";
    m_histo_ClusterTimeResolution_bin4[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 400, -100, 100, "t_reco - t_true (ns)",
                                                              m_histoList_ClusterTimeResolution);
 
    NameOfHisto = "histo_ClusterTimePull_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Cluster Time Pull (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
    m_histo_ClusterTimePull[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 210, -10, 11, "(t_reco - t_true)/t_sigma",
                                                   m_histoList_ClusterTimePull);
 
    NameOfHisto = "histo2D_TresVsPosres_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Time Residuals Vs U/V Position Residuals (" + IntExtFromIndex(
                     i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
    m_histo2D_TresVsPosres[i] = createHistogram2D(NameOfHisto, TitleOfHisto, 200, -0.1, 0.1, "U/V_reco - U/V_true (cm)", 180, -120, 60,
                                                  "t_reco - t_true (ns)", m_histo2DList_TresVsPosres);
 
    NameOfHisto = "histo_PurityInsideTMCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Fraction of Truth-Matched RecoDigits inside a Truth-Matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
                     i) + ", side" + UVFromIndex(i) + ")";
    m_histo_PurityInsideTMCluster[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 110, 0, 1.10,
                                                         "number of TM recoDigits / cluster size",
                                                         m_histoList_PurityInsideTMCluster);
 
    NameOfHisto = "histo2D_PurityInsideTMCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Number of Truth-matched Recos vs Number of Recos inside a Truth-matched Cluster (" + IntExtFromIndex(
                     i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(i) + ")";
    m_histo2D_PurityInsideTMCluster[i] = createHistogram2D(NameOfHisto, TitleOfHisto, 42, 0, 42, "cluster size", 42, 0, 42,
                                                           "number of TM recos", m_histo2DList_PurityInsideTMCluster);
 
    NameOfHisto = "histo_PurityInsideNOTMCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Fraction of Truth-matched RecoDigits inside a NOT Truth-matched Cluster (" + IntExtFromIndex(
                     i) + ", " + FWFromIndex(
                     i) + ", side" + UVFromIndex(i) + ")";
    m_histo_PurityInsideNOTMCluster[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 110, 0, 1.10,
                                                           "number of TM recoDigits / cluster size",
                                                           m_histoList_PurityInsideNOTMCluster);
 
    NameOfHisto = "histo_THinCluster_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Number of True Hits inside a Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(i) + ", side" + UVFromIndex(
                     i) + ")";
    m_histo_THinCluster[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of TH per cluster",
                                               m_histoList_THinCluster);
 
    NameOfHisto = "histo_THinClusterTM_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Number of True Hits inside a Truth-matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
                     i) + ", side" + UVFromIndex(i) + ")";
    m_histo_THinClusterTM[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of TH per TM cluster",
                                                 m_histoList_THinClusterTM);
 
    NameOfHisto = "histo_GoodTHinClusterTM_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Number of Good True Hits inside a Truth-matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
                     i) + ", side" + UVFromIndex(i) + ")";
    m_histo_GoodTHinClusterTM[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of Good TH per TM cluster",
                                                     m_histoList_GoodTHinClusterTM);
 
    NameOfHisto = "histo_GoodTHinClusterTMGood_" + IntExtFromIndex(i) + "_" + FWFromIndex(i) + "_Side" + UVFromIndex(i);
    TitleOfHisto = "Number of Good True Hits inside a Good Truth-matched Cluster (" + IntExtFromIndex(i) + ", " + FWFromIndex(
                     i) + ", side" + UVFromIndex(i) + ")";
    m_histo_GoodTHinClusterTMGood[i] = createHistogram1D(NameOfHisto, TitleOfHisto, 15, 0, 15, "number of Good TH per Good TM cluster",
                                                         m_histoList_GoodTHinClusterTMGood);
  }
 
  //Control Histos
  m_histoControl_MCcharge = createHistogram1D("m_histoControl_MCcharge", "m_histoControl_MCcharge", 5, -2, 3,
                                              "charge of the first MC particle related to a True Hit", m_histoList_Control);
  m_histoControl_MCisPrimary = createHistogram1D("m_histoControl_MCisPrimary", "m_histoControl_MCisPrimary", 2, 0, 2,
                                                 "isPrimary of the first MC particle related to a True Hit", m_histoList_Control);
  m_histoControl_THToMCsize = createHistogram1D("m_histoControl_THToMCsize", "m_histoControl_THToMCsize", 10, -1, 9,
                                                "size of the THToMC relation arrau", m_histoList_Control);
}

IntExtFromIndex()

TString IntExtFromIndex ( int idx )

staticprotected

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

Definition at line 630 of file SVDClusterEvaluationTrueInfoModule.cc.

{
  TString name = "";
 
  if (idx < 2)
    name = "L3";
  else
    name = "L456";
 
  return name;
}

setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int logLevel, unsigned int logInfo )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

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

name	The name of the module

Definition at line 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

{ 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

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

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

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

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

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

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

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

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.

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

terminate()

virtual void terminate ( void )

inlinevirtualinherited

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

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented in AafhInputModule, AnalysisPhase1StudyModule, ARICHBackgroundModule, arichBtestModule, ARICHNtupleModule, arichToNtupleModule, AsyncWrapper, AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BabayagaNLOInputModule, BBBremInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgNeutronModule, BeamSpotMonitorModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BHWideInputModule, BKLMAnaModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCPackerModule, CDCUnpackerModule, CDCCrossTalkAdderModule, CDCDedxCorrectionModule, CDCDedxDQMModule, CDCDedxPIDModule, CDCDedxScanModule, CDCDedxSkimCDSTModule, CDCDedxSkimModule, CDCDedxValidationModule, CDCDigitizerModule, CDCInitialT0DeterminationModule, CDCTrigger2DFinderModule, CDCTriggerHoughETFModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDataModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNeuroIDHistModule, CDCTriggerTSFFirmwareModule, CDCTriggerTSFModule, CDCTriggerUnpackerModule, CertifyParallelModule, CheckErrorEventModule, Chi2MCTrackMatcherModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, CollectorTestModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CRYInputModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlingTrackCandSplitterModule, CurlTaggerModule, DAQPerfModule, DataWriterModule, DeSerializerModule, DeSerializerPXDModule, DisplayModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEcmsMonObjModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLMMonObjModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistAnalysisTRGModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DqmHistoManagerModule, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLLOMModule, EclBackgroundStudyModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLCompressBGOverlayModule, ECLCovarianceMatrixModule, EclCovMatrixNtupleModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigiStudyModule, EclDisplayModule, ECLExpertModule, ECLFillCellIdMappingModule, ECLFinalizerModule, ECLLocalMaximumFinderModule, ECLMatchingPerformanceExpertModule, ECLShowerCorrectorModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLTrackClusterMatchingParametrizationExpertModule, ECLTrackClusterMatchingPerformanceModule, ECLTRGInformationModule, eclWaveformCalibCollectorModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EvReductionModule, EvtGenDecayModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastBDTClassifierAnalyzerModule, FastBDTClassifierTrainingModule, FastRbuf2DsModule, FillTrackFitNtupleModule, FragmentationModule, FullSimModule, FullSimTimingModule, TRGGDLUnpackerModule, GeneratedVertexDisplacerModule, GeneratorPreselectionModule, GenRawSendModule, GeometryModule, GetEventFromSocketModule, GFTC2SPTCConverterModule, GRLNeuroModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HepevtOutputModule, HepMCInputModule, HepMCOutputModule, HerwigHepMCFragmentationModule, HerwigLHEWriterModule, HistoManagerModule, HitLevelInfoWriterModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, KinkFinderModule, KKGenInputModule, KLMClusterEfficiencyModule, KLMExpertModule, KLMMuonIDDNNExpertModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KoralWInputModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MasterClassModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MergeDataStoreModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, MonitorDataModule, MuidModule, MVAExpertModule, MVAMultipleExpertsModule, NtuplePhase1_v6Module, ParticleKinematicFitterModule, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, Ph1bpipeModule, Ph1sustrModule, PhaseSpaceAnalysisModule, PhokharaInputModule, PhysicsObjectsDQMModule, PIDNtupleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, ProfileModule, ProgressBarModule, PXDBackgroundModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDPackerErrModule, PXDPackerModule, PXDReadRawBonnDAQMatchedModule, PXDReadRawBonnDAQModule, PXDReadRawONSENModule, PXDUnpackerModule, PXDUnpackerOldModule, PXDUnpackerOTModule, PXDDQMEfficiencyNtupleModule, PXDDQMEfficiencyNtupleSelftrackModule, PXDDQMTrackRawNtupleModule, PXDROIFinderAnalysisModule, PXDSpacePointCreatorModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, RemoveMCParticlesModule, RemoveParticlesNotInListsModule, ReprocessorModule, ROIDQMModule, ROIReadTestModule, ROISenderModule, Root2BinaryModule, Root2RawModule, RootInputModule, RootOutputModule, RT2SPTCConverterModule, RxModule, RxSocketModule, ScanCDCGeoModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SegmentNetworkAnalyzerModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SkimFilterModule, SoftwareTriggerModule, SoftwareTriggerResultPrinterModule, SpacePoint2TrueHitConnectorModule, SPTC2GFTCConverterModule, SPTC2RTConverterModule, SPTCRefereeModule, SrsensorModule, StandardTrackingPerformanceModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, StudyMaterialEffectsModule, SubEventModule, SVDBackgroundModule, SVDDigitizerModule, SVDVariablesToStorageModule, SVDChannelMappingModule, SVDChargeSharingAnalysisModule, SVDClusterQualityEstimatorCalibrationModule, SVDClusterQualityEstimatorModule, SVDCrossTalkFinderModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, svdDumpModule, SVDEventT0PerformanceTTreeModule, SVDHotStripFinderModule, SVDMaxStripTTreeModule, SVDPerformanceTTreeModule, SVDROIFinderAnalysisDataModule, SVDROIFinderAnalysisModule, SVDSpacePointCreatorModule, SVDSpacePointQICalibrationModule, SwitchDataStoreModule, TCConvertersTestModule, TeeggInputModule, TOPAlignerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelT0CalibratorModule, TOPChannelT0MCModule, TOPCommonT0CalibratorModule, TOPCosmicT0FinderModule, TOPGainEfficiencyCalculatorModule, TOPLaserCalibratorModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPDFCheckerModule, TOPRingPlotterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TrackAnaModule, TrackFilterModule, TrackFinderVXDAnalizerModule, TrackingPerformanceEvaluationModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCHitsRemover >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackingUtilities::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackingUtilities::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackQETrainingDataCollectorModule, TreeFitterModule, TrepsInputModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TxModule, TxSocketModule, V0FinderModule, V0findingPerformanceEvaluationModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, VXDDedxPIDModule, VXDQETrainingDataCollectorModule, VXDTFTrainingDataCollectorModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 175 of file Module.h.

{};

UVFromIndex()

TString UVFromIndex ( int idx )

staticprotected

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

Definition at line 654 of file SVDClusterEvaluationTrueInfoModule.cc.

{
  TString name = "";
 
  if (idx % 2 == 0)
    name = "U";
  else
    name = "V";
 
  return name;
}

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

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_graphList

TList* m_graphList = nullptr

histo list, TGraphs

Definition at line 146 of file SVDClusterEvaluationTrueInfoModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

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

{nullptr};

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

{nullptr};

m_histo2DList_PurityInsideTMCluster

TList* m_histo2DList_PurityInsideTMCluster = nullptr

histo list truth matched cluster purity (2D)

Definition at line 140 of file SVDClusterEvaluationTrueInfoModule.h.

m_histo2DList_TresVsPosres

TList* m_histo2DList_TresVsPosres = nullptr

histo list ime tresol VS position resol

Definition at line 138 of file SVDClusterEvaluationTrueInfoModule.h.

m_histo_ClusterTimePull

TH1F* m_histo_ClusterTimePull[m_Nsets] = {nullptr}

Vector of histograms depicting Cluster Time Pull.

Definition at line 82 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

m_histo_ClusterTimeResolution

TH1F* m_histo_ClusterTimeResolution[m_Nsets] = {nullptr}

Vector of histograms depicting Cluster Time Residuals.

Definition at line 75 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

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

{nullptr}; 

m_histo_ClusterTimeResolution_bin2

TH1F* m_histo_ClusterTimeResolution_bin2[m_Nsets] = {nullptr}

TB2.

Definition at line 78 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr}; 

m_histo_ClusterTimeResolution_bin3

TH1F* m_histo_ClusterTimeResolution_bin3[m_Nsets] = {nullptr}

TB3.

Definition at line 79 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr}; 

m_histo_ClusterTimeResolution_bin4

TH1F* m_histo_ClusterTimeResolution_bin4[m_Nsets] = {nullptr}

TB4.

Definition at line 80 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr}; 

m_histo_ClusterUPositionPull

TH1F* m_histo_ClusterUPositionPull[m_NsetsRed] = {nullptr}

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

Definition at line 88 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

m_histo_ClusterUPositionResolution

TH1F* m_histo_ClusterUPositionResolution[m_NsetsRed] = {nullptr}

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

Definition at line 84 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

m_histo_ClusterVPositionPull

TH1F* m_histo_ClusterVPositionPull[m_NsetsRed] = {nullptr}

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

Definition at line 90 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

m_histo_ClusterVPositionResolution

TH1F* m_histo_ClusterVPositionResolution[m_NsetsRed] = {nullptr}

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

Definition at line 86 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

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

{nullptr};

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

{nullptr};

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

{nullptr};

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

{nullptr};

m_histo_StripTimeResolution

TH1F* m_histo_StripTimeResolution[m_Nsets] = {nullptr}

Vector of histograms depicting Strip Time Residuals.

Definition at line 73 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

m_histo_THinCluster

TH1F* m_histo_THinCluster[m_Nsets] = {nullptr}

Vector of histograms depicting Number of TH inside a Cluster.

Definition at line 100 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

m_histo_THinClusterTM

TH1F* m_histo_THinClusterTM[m_Nsets] = {nullptr}

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

Definition at line 102 of file SVDClusterEvaluationTrueInfoModule.h.

{nullptr};

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

m_histoControl_MCisPrimary

TH1F* m_histoControl_MCisPrimary = nullptr

control histo: MC is primary

Definition at line 160 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoControl_THToMCsize

TH1F* m_histoControl_THToMCsize = nullptr

control histo: true hit to mc size

Definition at line 161 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_ClusterPositionPull

TList* m_histoList_ClusterPositionPull = nullptr

histo list cluster position pull

Definition at line 137 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_ClusterPositionResolution

TList* m_histoList_ClusterPositionResolution = nullptr

histo list cluster position resolution

Definition at line 136 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_ClusterTimePull

TList* m_histoList_ClusterTimePull = nullptr

histo list cluster time pull

Definition at line 135 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_ClusterTimeResolution

TList* m_histoList_ClusterTimeResolution = nullptr

histo list cluster time resolution

Definition at line 134 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_Control

TList* m_histoList_Control = nullptr

control histo

Definition at line 162 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_GoodTHinClusterTM

TList* m_histoList_GoodTHinClusterTM = nullptr

histo list good true hits in cluster truth matched

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

m_histoList_PurityInsideNOTMCluster

TList* m_histoList_PurityInsideNOTMCluster = nullptr

histo list not truth matched cluster purity

Definition at line 141 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_PurityInsideTMCluster

TList* m_histoList_PurityInsideTMCluster = nullptr

histo list truth matched cluster purity (2D)

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

m_histoList_THinCluster

TList* m_histoList_THinCluster = nullptr

histo list true hits in cluster

Definition at line 142 of file SVDClusterEvaluationTrueInfoModule.h.

m_histoList_THinClusterTM

TList* m_histoList_THinClusterTM = nullptr

histo list true hits in clsuter truth match

Definition at line 143 of file SVDClusterEvaluationTrueInfoModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

m_mean_ClusterTimeResolution

float m_mean_ClusterTimeResolution[m_Nsets] = {0}

average cl time resid

Definition at line 111 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_mean_ClusterUPositionResolution

float m_mean_ClusterUPositionResolution[m_Nsets] = {0}

average cl U position resol

Definition at line 113 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_mean_ClusterVPositionResolution

float m_mean_ClusterVPositionResolution[m_Nsets] = {0}

average cl V position reosl

Definition at line 115 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_mean_GoodTHinClusterTM

float m_mean_GoodTHinClusterTM[m_Nsets] = {0}

good true hits in cluster truth matched average

Definition at line 123 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_mean_GoodTHinClusterTMGood

float m_mean_GoodTHinClusterTMGood[m_Nsets] = {0}

good true hits in cluster truth match good average

Definition at line 125 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_mean_PurityInsideTMCluster

float m_mean_PurityInsideTMCluster[m_Nsets] = {0}

cluster purity average

Definition at line 117 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

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

{0}; 

m_mean_THinCluster

float m_mean_THinCluster[m_Nsets] = {0}

true hits in cluster average

Definition at line 119 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_mean_THinClusterTM

float m_mean_THinClusterTM[m_Nsets] = {0}

true hits in truth matched cluster average

Definition at line 121 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 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 507 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 53 of file SVDClusterEvaluationTrueInfoModule.h.

m_NsetsRed

const int m_NsetsRed = 3

static

numbner of reduced sets

Definition at line 55 of file SVDClusterEvaluationTrueInfoModule.h.

m_NullVec

float m_NullVec[m_Nsets] = {0.}

null vector

Definition at line 130 of file SVDClusterEvaluationTrueInfoModule.h.

{0.}; 

m_NumberOfClusters

int m_NumberOfClusters[m_Nsets] = {0}

number of clusters

Definition at line 153 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_NumberOfClustersRelatedToTH

int m_NumberOfClustersRelatedToTH[m_Nsets] = {0}

number of clusters related to true hits

Definition at line 152 of file SVDClusterEvaluationTrueInfoModule.h.

{0};  

m_NumberOfRecoDigit

int m_NumberOfRecoDigit[m_Nsets] = {0}

number of reco digits

Definition at line 150 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_NumberOfShaperDigit

int m_NumberOfShaperDigit[m_Nsets] = {0}

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

Definition at line 149 of file SVDClusterEvaluationTrueInfoModule.h.

{0};

m_NumberOfTH

int m_NumberOfTH[m_Nsets] = {0}

number of true hits

Definition at line 151 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_NumberOfTMClusters

int m_NumberOfTMClusters[m_Nsets] = {0}

number of truth matched clusters

Definition at line 154 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_NumberOfTMRecoInNOTMCluster

int m_NumberOfTMRecoInNOTMCluster = 0

number of truth matched reco digits in not truth matched clusters

Definition at line 156 of file SVDClusterEvaluationTrueInfoModule.h.

m_NumberOfTMRecoInTMCluster

int m_NumberOfTMRecoInTMCluster = 0

number of true match reco digit in truth match cluster

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

{1., 2., 3., 4., 5., 6.};

m_outputFile

TFile* m_outputFile = nullptr

output file

Definition at line 58 of file SVDClusterEvaluationTrueInfoModule.h.

m_outputFileName

std::string m_outputFileName = ""

output file name

Definition at line 59 of file SVDClusterEvaluationTrueInfoModule.h.

m_package

std::string m_package

privateinherited

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

Definition at line 509 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 511 of file Module.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

m_RMS_ClusterTimeResolution

float m_RMS_ClusterTimeResolution[m_Nsets] = {0}

rms cluster time resid

Definition at line 112 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_ClusterUPositionResolution

float m_RMS_ClusterUPositionResolution[m_Nsets] = {0}

rms cl U position resol

Definition at line 114 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_ClusterVPositionResolution

float m_RMS_ClusterVPositionResolution[m_Nsets] = {0}

rms cl V position resol

Definition at line 116 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_GoodTHinClusterTM

float m_RMS_GoodTHinClusterTM[m_Nsets] = {0}

good true hits in cluster truth matched rms

Definition at line 124 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_GoodTHinClusterTMGood

float m_RMS_GoodTHinClusterTMGood[m_Nsets] = {0}

good true hits in cluster truth match good rms

Definition at line 126 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_PurityInsideTMCluster

float m_RMS_PurityInsideTMCluster[m_Nsets] = {0}

cluster purity rms

Definition at line 118 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_StripTimeResolution

float m_RMS_StripTimeResolution[m_Nsets] = {0}

rms of strip time residual

Definition at line 110 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_RMS_THinCluster

float m_RMS_THinCluster[m_Nsets] = {0}

true hits in cluster rms

Definition at line 120 of file SVDClusterEvaluationTrueInfoModule.h.

{0};

m_RMS_THinClusterTM

float m_RMS_THinClusterTM[m_Nsets] = {0}

true hits in truth matched cluster rms

Definition at line 122 of file SVDClusterEvaluationTrueInfoModule.h.

{0}; 

m_storeSVDEvtInfo

StoreObjPtr<SVDEventInfo> m_storeSVDEvtInfo

protected

Storage for SVDEventInfo object.

Definition at line 167 of file SVDClusterEvaluationTrueInfoModule.h.

m_svdEventInfoName

std::string m_svdEventInfoName

Name of the SVDEventInfo object.

Definition at line 62 of file SVDClusterEvaluationTrueInfoModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

NameOfHisto

TString NameOfHisto = ""

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

Definition at line 68 of file SVDClusterEvaluationTrueInfoModule.h.

TitleOfHisto

TString TitleOfHisto = ""

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

Definition at line 70 of file SVDClusterEvaluationTrueInfoModule.h.

---

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

• svd/modules/svdPerformance/include/SVDClusterEvaluationTrueInfoModule.h
• svd/modules/svdPerformance/src/SVDClusterEvaluationTrueInfoModule.cc