The MCTrackCandClassifier Definition Module. More...

#include <MCTrackCandClassifierModule.h>

Inheritance diagram for MCTrackCandClassifierModule:

Collaboration diagram for MCTrackCandClassifierModule:

[legend]

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
	MCTrackCandClassifierModule ()
	Constructor of the module. More...

void	initialize () override
	Initializes the Module.

void	beginRun () override
	Begin run.

void	event () override
	Event function.

void	endRun () override
	End run.

void	terminate () override
	Termination action.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules. More...

const std::string &	getName () const
	Returns the name of the module. More...

const std::string &	getType () const
	Returns the type of the module (i.e. More...

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module. More...

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...

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

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module. More...

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module. More...

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module. More...

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

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

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

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished. More...

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module. More...

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter. More...

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module. More...

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module. More...

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters. More...

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

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python. More...

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side. More...

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

void	setDescription (const std::string &description)
	Sets the description of the module. More...

void	setType (const std::string &type)
	Set the module type. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...

void	setReturnValue (int value)
	Sets the return value for this module as integer. More...

void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Protected Attributes
std::string	m_mcTrackCandsColName
	TrackCand list name.

std::string	m_mcParticlesName
	MCParticle list name.

std::string	m_rootFileName
	root file name

int	m_nSigma
	nSigma dR

bool	m_usePXD
	Whether to use PXD.

bool	m_applyAnnulus
	Whether to require that the hit is in the expected annulus.

bool	m_applySemiplane
	Wether to require that the hit is in the expected semiplane.

bool	m_applyLap
	Whether to require that the hit belongs to the first lap in the transverse plane.

bool	m_applyWedge
	Whether to require that the hit belong to the barrel part of the SVD.

bool	m_removeBadHits
	Whether to remove the clusters that do not satisfy the criteria from the idealMCTrackCands.

int	m_minHit
	Minimum number of 1D Clusters to classify the MCTrackCand as ideal.

double	m_fraction
	Fraction of lap.

int	nWedge = 0
	Counter for hits on wedged sensors.

int	nBarrel = 0
	Counter for hits on barrel sensors.

TFile *	m_rootFilePtr = nullptr
	Pointer to root file used for storing histograms.

TList *	m_histoList = nullptr
	List of histograms.

TH3F *	m_h3_MCParticle = nullptr
	Histogram.

TH3F *	m_h3_idealMCTrackCand = nullptr
	Histogram.

TH3F *	m_h3_MCTrackCand = nullptr
	Histogram.

TH1F *	m_h1_thetaMS_SVD = nullptr
	Histogram.

TH1F *	m_h1_thetaMS_PXD = nullptr
	Histogram.

TH1F *	m_h1_dR = nullptr
	Histogram.

TH1F *	m_h1_dRoverR = nullptr
	Histogram.

TH1F *	m_h1_distOVERdR = nullptr
	Histogram.

TH1F *	m_h1_hitRadius_accepted = nullptr
	Histogram.

TH1F *	m_h1_hitRadius_rejected = nullptr
	Histogram.

TH1F *	m_h1_hitDistance_accepted = nullptr
	Histogram.

TH1F *	m_h1_hitDistance_rejected = nullptr
	Histogram.

TH1F *	m_h1_MCTrackCandNhits = nullptr
	Histogram.

TH1F *	m_h1_firstRejectedHit = nullptr
	Histogram.

TH1F *	m_h1_firstRejectedOVERMCHit = nullptr
	Histogram.

TH1F *	m_h1_lapTime = nullptr
	Histogram.

TH1F *	m_h1_timeDifference = nullptr
	Histogram.

TH1F *	m_h1_diffOVERlap = nullptr
	Histogram.

TH1F *	m_h1_nGoodTrueHits = nullptr
	Histogram.

TH1F *	m_h1_nBadTrueHits = nullptr
	Histogram.

TH1F *	m_h1_nGood1dInfo = nullptr
	Histogram.

TH1F *	m_h1_nBad1dInfo = nullptr
	Histogram.

Private Member Functions
double	semiPlane (ROOT::Math::XYZVector vertex, ROOT::Math::XYZVector center, ROOT::Math::XYZVector hit)
	Function to get semiplane. More...

bool	isInSemiPlane (double semiPlane, double omega)
	Function to check if a omega value is in a given semiPlane. More...

double	theDistance (ROOT::Math::XYZVector center, ROOT::Math::XYZVector hit)
	Get distance between two points. More...

bool	isInAnnulus (double hitDistance, double R, double dR)
	Function to check if hitDistance is within a given annulus. More...

bool	isFirstLap (double FirstHitTime, double HitTime, double LapTime)
	Function to check if a hitTime is within a given lapTime, under consideration of m_fraction and with respect to first hit. More...

TH3F *	createHistogram3D (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, Int_t nbinsZ, Double_t minZ, Double_t maxZ, const char titleZ, TList histoList=nullptr)
	Create a 3D ROOT Histogram. More...

TH3F *	createHistogram3D (const char name, const char title, Int_t nbinsX, Double_t binsX, const char titleX, Int_t nbinsY, Double_t binsY, const char titleY, Int_t nbinsZ, Double_t binsZ, const char titleZ, TList *histoList=nullptr)
	Create a 3D ROOT Histogram. More...

TH1 *	duplicateHistogram (const char newname, const char newtitle, TH1 h, TList histoList=nullptr)
	Function to clone a histogram. More...

TH1F *	createHistogramsRatio (const char name, const char title, TH1 hNum, TH1 hDen, bool isEffPlot, int axisRef)
	Function to create a ratio histogram from two histograms. More...

void	addEfficiencyPlots (TList *graphList=nullptr)
	Function to create efficiency plots and add them to list. More...

void	addInefficiencyPlots (TList *graphList=nullptr)
	Function to create inefficiency plots and add them to list. More...

float	compute_dR (double thetaMS, double omega)
	Calculate dR. More...

float	compute_thetaMS (MCParticleInfo &mcParticleInfo, VXDTrueHit *aTrueHit)
	Calculate thetaMS. More...

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

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

Private Attributes
StoreArray< PXDCluster >	m_PXDClusters
	PXDClusters StoreArray.

StoreArray< SVDCluster >	m_SVDClusters
	SVDClusters StoreArray.

StoreArray< MCParticle >	m_MCParticles
	MCParticles StoreArray.

StoreArray< genfit::TrackCand >	m_GenfitMCTrackCands
	MC Genfit TrackCands StoreArray.

StoreArray< genfit::TrackCand >	m_GenfitIdealMCTrackCands
	Ideal Genfit TrackCands StoreArray.

ROOT::Math::XYZVector	m_magField
	magnetic field needed set particle info

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

The MCTrackCandClassifier Definition Module.

this module classifies the MCTrackCands in

idealMCTrackCands: MCTrackCand
fineMCTrackCands (not produced yet)
nastyMCTrackCands (not produced yet) on the basis of their properties in order to study the inefficiencies of the pattern recognition and the fitter

Definition at line 45 of file MCTrackCandClassifierModule.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.

Constructor & Destructor Documentation

◆ MCTrackCandClassifierModule()

MCTrackCandClassifierModule ( )

Constructor of the module.

Implementation.

Definition at line 26 of file MCTrackCandClassifierModule.cc.

                                                          : Module()
   , m_rootFilePtr(nullptr)
 {
   //Set module properties
   setDescription("This module is meant to classify the MCTrackCands as either ideal, fine and nasty");
   setPropertyFlags(c_ParallelProcessingCertified);
  
   addParam("MCParticlesName", m_mcParticlesName,
            "Name of MC Particle collection.",
            std::string(""));
  
   addParam("MCTrackCandCollName", m_mcTrackCandsColName,
            "Name of the input collection of MC track candidates",
            std::string(""));
  
   addParam("rootFileName", m_rootFileName,
            "Name of the root file",
            std::string("MCTrackCandClassifier.root"));
  
   addParam("isInAnnulusCriterium", m_applyAnnulus,
            "Require that the hit is in the expected annulus",
            bool(true));
   addParam("isInSemiplaneCriterium", m_applySemiplane,
            "Require that the hit is in the expected semiplane",
            bool(true));
   addParam("isInFirstLapCriterium", m_applyLap,
            "Require that the hit belong to the first lap in the transverse plane",
            bool(true));
   addParam("isInWedgePartCriterium", m_applyWedge,
            "Require that the hit belong to the barrel part of the SVD",
            bool(true));
   addParam("removeBadHits", m_removeBadHits,
            "Remove the clusters that do not satisfy the criteria from the idealMCTrackCands",
            bool(true));
  
   addParam("minNhits", m_minHit,
            "Minimum number of 1D Clusters to classify the MCTrackCand as ideal",
            int(5));
  
   addParam("nSigma_dR", m_nSigma, "n sigma dR", int(3));
  
   addParam("lapFraction", m_fraction, "Fraction of lap", double(1));
  
   addParam("usePXD", m_usePXD, "Use the PXD or not", bool(true));
 }

Member Function Documentation

◆ addEfficiencyPlots()

void addEfficiencyPlots ( TList * graphList = nullptr )

private

Function to create efficiency plots and add them to list.

Parameters

graphList pointer to list to add the plots to

Definition at line 655 of file MCTrackCandClassifierModule.cc.

◆ addInefficiencyPlots()

void addInefficiencyPlots ( TList * graphList = nullptr )

private

Function to create inefficiency plots and add them to list.

Parameters

graphList pointer to list to add the plots to

Definition at line 672 of file MCTrackCandClassifierModule.cc.

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

◆ compute_dR()

float compute_dR	(	double	thetaMS,
		double	omega
	)

private

Calculate dR.

Parameters

thetaMS	thetaMS of a hit
omega	omega value

Returns: dR value

Definition at line 795 of file MCTrackCandClassifierModule.cc.

◆ compute_thetaMS()

float compute_thetaMS	(	MCParticleInfo &	mcParticleInfo,
		VXDTrueHit *	aTrueHit
	)

private

Calculate thetaMS.

Parameters

mcParticleInfo	mcParticleInfo object
aTrueHit	pointer to vxd ture hit

Returns: thetaMS value

Definition at line 819 of file MCTrackCandClassifierModule.cc.

◆ createHistogram3D() [1/2]

TH3F * createHistogram3D	(	const char *	name,
		const char *	title,
		Int_t	nbinsX,
		Double_t *	binsX,
		const char *	titleX,
		Int_t	nbinsY,
		Double_t *	binsY,
		const char *	titleY,
		Int_t	nbinsZ,
		Double_t *	binsZ,
		const char *	titleZ,
		TList *	histoList = `nullptr`
	)

private

Create a 3D ROOT Histogram.

Parameters

name	name of histogram
title	title of histogram
nbinsX	number of bins on x axis
binsX	x bins
titleX	x axis title
nbinsY	number of bins on y axis
binsY	y bins
titleY	y axis title
nbinsZ	number of bins on z axis
binsZ	z bins
titleZ	z axis title
histoList	list of histograms to add this histogram to

Returns: the histogram

Definition at line 601 of file MCTrackCandClassifierModule.cc.

◆ createHistogram3D() [2/2]

TH3F * createHistogram3D	(	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,
		Int_t	nbinsZ,
		Double_t	minZ,
		Double_t	maxZ,
		const char *	titleZ,
		TList *	histoList = `nullptr`
	)

private

Create a 3D ROOT Histogram.

Parameters

name	name of histogram
title	title of histogram
nbinsX	number of bins on x axis
minX	minimal x value
maxX	maximal x value
titleX	x axis title
nbinsY	number of bins on y axis
minY	minimal y value
maxY	maximal y value
titleY	y axis title
nbinsZ	number of bins on z axis
minZ	minimal z value
maxZ	maximal z value
titleZ	z axis title
histoList	list of histograms to add this histogram to

Returns: the histogram

Definition at line 579 of file MCTrackCandClassifierModule.cc.

◆ createHistogramsRatio()

TH1F * createHistogramsRatio	(	const char *	name,
		const char *	title,
		TH1 *	hNum,
		TH1 *	hDen,
		bool	isEffPlot,
		int	axisRef
	)

private

Function to create a ratio histogram from two histograms.

Parameters

name	name of histogram
title	title of histogram
hNum	histogram for the numerator of the ratio
hDen	histogram for the denominator of the ratio
isEffPlot	if the result is a efficiency plot
axisRef	reference axis to use. (x=0, y=1, z=2)

Returns: the histogram

Definition at line 689 of file MCTrackCandClassifierModule.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ duplicateHistogram()

TH1 * duplicateHistogram	(	const char *	newname,
		const char *	newtitle,
		TH1 *	h,
		TList *	histoList = `nullptr`
	)

private

Function to clone a histogram.

Parameters

newname	new histogram name
newtitle	new title
h	histogram to clone
histoList	list of histograms to add this histogram to

Returns: the duplicated histogram

Definition at line 623 of file MCTrackCandClassifierModule.cc.

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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_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()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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.

◆ isFirstLap()

bool isFirstLap	(	double	FirstHitTime,
		double	HitTime,
		double	LapTime
	)

private

Function to check if a hitTime is within a given lapTime, under consideration of m_fraction and with respect to first hit.

Parameters

FirstHitTime	time of first hit
HitTime	hit time
LapTime	lap time

Returns: true if in first lap

Definition at line 558 of file MCTrackCandClassifierModule.cc.

◆ isInAnnulus()

bool isInAnnulus	(	double	hitDistance,
		double	R,
		double	dR
	)

private

Function to check if hitDistance is within a given annulus.

Parameters

hitDistance	distance between two hits
R	radius for annulus
dR	width of annulus

Returns: true if in annulus

Definition at line 541 of file MCTrackCandClassifierModule.cc.

◆ isInSemiPlane()

bool isInSemiPlane	(	double	semiPlane,
		double	omega
	)

private

Function to check if a omega value is in a given semiPlane.

Parameters

semiPlane	slope of semiplane
omega	Signed curvature

Returns: true if in semiplane

Definition at line 523 of file MCTrackCandClassifierModule.cc.

◆ semiPlane()

double semiPlane	(	ROOT::Math::XYZVector	vertex,
		ROOT::Math::XYZVector	center,
		ROOT::Math::XYZVector	hit
	)

private

Function to get semiplane.

Parameters

vertex	Vertex position
center	center positon
hit	hit position

Returns: difference in y-slope between hit and semiplane

Definition at line 502 of file MCTrackCandClassifierModule.cc.

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

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

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

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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.

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

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

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

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

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

◆ theDistance()

double theDistance	(	ROOT::Math::XYZVector	center,
		ROOT::Math::XYZVector	hit
	)

private

Get distance between two points.

Parameters

center	center position
hit	hit position

Returns: Distance between the two hits

Definition at line 532 of file MCTrackCandClassifierModule.cc.

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

tracking/modules/mcTrackCandClassifier/include/MCTrackCandClassifierModule.h
tracking/modules/mcTrackCandClassifier/src/MCTrackCandClassifierModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ MCTrackCandClassifierModule()

Member Function Documentation

◆ addEfficiencyPlots()

◆ addInefficiencyPlots()

◆ clone()

◆ compute_dR()

◆ compute_thetaMS()

◆ createHistogram3D() [1/2]

◆ createHistogram3D() [2/2]

◆ createHistogramsRatio()

◆ def_endRun()

◆ def_initialize()

◆ duplicateHistogram()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ isFirstLap()

◆ isInAnnulus()

◆ isInSemiPlane()

◆ semiPlane()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ theDistance()