The TrackFinderVXDAnalizerModule. More...

#include <TrackFinderVXDAnalizerModule.h>

Inheritance diagram for TrackFinderVXDAnalizerModule:

Collaboration diagram for TrackFinderVXDAnalizerModule:

[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
	TrackFinderVXDAnalizerModule ()
	constructor

	~TrackFinderVXDAnalizerModule ()
	destructor

void	initialize () override
	inizialize function

void	beginRun () override
	beginRun function

void	event () override
	event function More...

void	endRun () override
	endRun function More...

void	terminate () override
	terminate function

template<class PurityType >
PurityType	returnDominantParticleID (const std::vector< PurityType > &purities)
	of a vector of given particleIDs with their purities it returns the one which had the highest purity

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
StoreArray< SpacePointTrackCand >	m_referenceTCs
	StoreArray for the reference TCs provided by a reference TF (like trackFinderMCTruth).

StoreArray< SpacePointTrackCand >	m_testTCs
	StoreArray for the TCs provided by a TF to be tested (like VXDTF).

StoreArray< SpacePointTrackCand >	m_acceptedTCs
	StoreArray for accepted/successfully reconstructed track candidates.

StoreArray< SpacePointTrackCand >	m_lostTCs
	StoreArray for lost track candidates.

RootParameterTracker	m_rootParameterTracker
	takes care of collecting data and storing it to root branches

std::string	m_PARAMprintData
	depending on what value you set it, it will print data like momentum residuals or any other interesting info during endrun... More...

std::vector< std::vector< std::vector< std::string > > >	m_PARAMtrackedParametersDouble
	set here all parameters to be tracked which use an algorithm storing one double per tc. More...

std::vector< std::vector< std::vector< std::string > > >	m_PARAMtrackedParametersInt
	set here all parameters to be tracked which use an algorithm storing one int per tc. More...

std::vector< std::vector< std::vector< std::string > > >	m_PARAMtrackedParametersVecDouble
	set here all parameters to be tracked which use an algorithm storing one vector< double> per tc. More...

bool	m_PARAMwriteToRoot
	if true, analysis data is stored to root file with file name chosen by 'rootFileName'

std::vector< std::string >	m_PARAMrootFileName
	only two entries accepted, first one is the root filename, second one is 'RECREATE' or 'UPDATE' which is the write mode for the root file, parameter is used

std::vector< double >	m_PARAMorigin
	only allowed size: 3. More...

bool	m_PARAMuseMCDataForValues
	if true, for testTC the values of attached refTC will be stored instead of own values. More...

std::string	m_PARAMreferenceTCname
	the name of the storeArray container provided by the reference TF (has to be set manually there and here)

std::string	m_PARAMtestTCname
	the name of the storeArray container provided by the TF to be evaluated (has to be set manually there and here)

std::string	m_PARAMacceptedTCname
	the name of the trackCandidateCollection of successfully reconstructed track candidates determined by the TFAnalizer

std::string	m_PARAMlostTCname
	the name of the trackCandidateCollection of lost track candidates determined by the TFAnalizer

double	m_PARAMpurityThreshold
	choose value to filter TCs found by VXDTF. More...

unsigned int	m_PARAMminNDFThreshold
	defines how many measurements (numbers of degrees of freedom) the TC must have to be accepted as reconstructed. More...

bool	m_PARAMignoreDeadTCs
	if true, test-tc whose activation-state is set to false are skipped for analysis.

bool	m_PARAMdoEventSummary
	if true, for each event a summary will be given (WARNING produces a lot of output!

unsigned int	m_countReconstructedTCs = 0
	counts number of reconstructed TCs.

unsigned int	m_countAcceptedGFTCs = 0
	counts number of accepted TCs which are stored in separate container for external tests (e.g. More...

unsigned int	m_lostGFTCs = 0
	counts number of TCs found by MCTF but lost by VXDTF, they are stored for external tests in storaArray with name m_PARAMlostTCname.

unsigned int	m_eventCounter = 0
	knows current event number.

unsigned int	m_mcTrackCounter = 0
	counts number of tracks reconstructed by the mcTrackFinder.

unsigned int	m_totalRealHits = 0
	total number of hits (clusters/2) attached to mcTCs (therefore total number of real hits).

unsigned int	m_caTrackCounter = 0
	counts number of tracks reconstructed by the CATF.

unsigned int	m_countedPerfectRecoveries = 0
	counts number of tracks, where no foreign hits were attached ('clean') AND all hits of the mcTC were reconstructed.

unsigned int	m_countedCleanRecoveries = 0
	counts number of tracks, where no foreign hits were attached ('clean'), does NOT mean that all reconstructable hits had been found by CATF!

unsigned int	m_countedContaminatedRecoveries = 0
	counts number of tracks, where foreign hits werew attached but its purity was above the threshold.

unsigned int	m_countedTCsTooShort = 0
	counts number of tracks, which did not have enough hits at all.

unsigned int	m_countedGhosts = 0
	counts number of tracks, where a dominating TC was found, but the purity did not reach the threshold.

unsigned int	m_countedDoubleEntries = 0
	if a TC was found more than once with good (contaminated or clean ones) caTCs, it will be counted to find out how many of the ghost tcs are in fact good tcs but not combined to one tc.

unsigned int	m_countedLostTest = 0
	counts number of Lost test tcs.

unsigned int	m_countedLostRef = 0
	counts number of Lost reference tcs.

unsigned int	m_countedReferenceClones = 0
	counts number reference TCs which were marked as clones.

unsigned int	m_wrongChargeSignCounter = 0
	counts number of times, where assigned caTC guessed wrong sign of charge.

unsigned int	m_mcTrackVectorCounter = 0
	another counter of mcTCs, consideres size of datastores containing mcTCs.

unsigned int	m_nMcPXDHits = 0
	counts total number of pxdHits added by mcTF.

unsigned int	m_nMcSVDHits = 0
	counts total number of svdHits added by mcTF.

unsigned int	m_nCaPXDHits = 0
	counts total number of pxdHits added by caTF.

unsigned int	m_nCaSVDHits = 0
	counts total number of svdHits added by caTF.

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

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

Private Attributes
std::string	m_name
	The name of the module, saved as a string (user-modifiable)

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

The TrackFinderVXDAnalizerModule.

analyzes quality of SpacePointTrackCands delivered by a test-TF compared to a reference TF

Definition at line 35 of file TrackFinderVXDAnalizerModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

Member Function Documentation

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ endRun()

void endRun ( void )

overridevirtual

endRun function

old:

Reimplemented from Module.

Definition at line 504 of file TrackFinderVXDAnalizerModule.cc.

 {
   B2INFO("------------- >>>TrackFinderVXDAnalizerModule::endRun<<< -------------");
   B2DEBUG(20, "TrackFinderVXDAnalizerModule-explanation: \n" <<
           " perfect recovery means: all hits of mc-TC found again and clean TC. \n" <<
           " clean recovery means: no foreign hits within TC. \n" <<
           " ghost means: QI was below threshold or mcTC was found more than once (e.g. because of curlers) \n" <<
           " found more than once means: that there was more than one TC which was assigned to the same mcTC but each of them were good enough for themselves to be classified as reconstructed");
  
   B2INFO("TrackFinderVXDAnalizerModule: After " << m_eventCounter + 1 << " events there was a total number of " << m_mcTrackCounter <<
          " mcTrackCandidates and " << m_totalRealHits << " realHits. Of these TCs, " << m_mcTrackVectorCounter <<
          " mcTrackCandidates where used for analysis because of cutoffs.");
   B2INFO("TrackFinderVXDAnalizerModule: There were " << m_caTrackCounter << " caTrackCandidates, of those " << m_countAcceptedGFTCs <<
          " were stored in " << m_PARAMacceptedTCname << " and " << m_lostGFTCs << " lost TCs were stored in " << m_PARAMlostTCname <<
          " for further use, number of times where charge was guessed wrong: " << m_wrongChargeSignCounter <<
          ", number of caTCs which produced a double entry: " << m_countedDoubleEntries);
   B2INFO("TrackFinderVXDAnalizerModule:  totalCA|totalMC|ratio of pxdHits " << m_nCaPXDHits << "|" << m_nMcPXDHits << "|" << float(
            m_nCaPXDHits) / float(m_nMcPXDHits) <<
          ", svdHits " << m_nCaSVDHits << "|" << m_nMcSVDHits << "|" << float(m_nCaSVDHits) / float(m_nMcSVDHits) <<
          " found by the two TFs (ghost hits not removed, therefore only useful if ghost-rate is low)");
  
   B2INFO("TrackFinderVXDAnalizerModule: the VXDTF found:\n" <<
          "Absolute numbers: total/perfect/clean/contaminated/clone/tooShort/ghost: " << m_countReconstructedTCs <<
          "/" << m_countedPerfectRecoveries <<
          "/" << m_countedCleanRecoveries <<
          "/" << m_countedContaminatedRecoveries <<
          "/" << m_countedDoubleEntries <<
          "/" << m_countedTCsTooShort <<
          "/" << m_countedGhosts <<
          " efficiency : total/perfect/clean/contaminated/clone/tooShort/ghost: " << double(100 * m_countReconstructedTCs) / double(
            m_mcTrackVectorCounter) <<
          "%/" << double(100 * m_countedPerfectRecoveries) / double(m_mcTrackVectorCounter) <<
          "%/" << double(100 * m_countedCleanRecoveries) / double(m_mcTrackVectorCounter) <<
          "%/" << double(100 * m_countedContaminatedRecoveries) / double(m_mcTrackVectorCounter) <<
          "%/" << double(100 * m_countedDoubleEntries) / double(m_mcTrackVectorCounter) <<
          "%/" << double(100 * m_countedTCsTooShort) / double(m_mcTrackVectorCounter) <<
          "%/" << double(100 * m_countedGhosts) / double(m_mcTrackVectorCounter) <<
          "%");
  
   B2INFO("TrackFinderVXDAnalizerModule: additional numbers:\"" <<
          "nCountedLost (test/ref): " << m_countedLostTest <<
          "/" << m_countedLostRef <<
          ", nRefClones: " << m_countedReferenceClones <<
          ", in percent - nLost (test/ref): " << double(100 * m_countedLostTest) / double(m_mcTrackVectorCounter) <<
          "/" << double(100 * m_countedLostRef) / double(m_mcTrackVectorCounter) <<
          "%, nClones: " << double(100 * m_countedReferenceClones) / double(m_mcTrackVectorCounter) <<
          "%");
 //   B2INFO("TFAnalizerModule: the VXDTF found (total/perfect/clean/ghost)" << m_countReconstructedTCs << "/" <<
 //          m_countedPerfectRecoveries << "/" << m_countedCleanRecoveries << "/" << (m_caTrackCounter - m_countReconstructedTCs) <<
 //          " TCs -> efficiency(total/perfect/clean/ghost): " << double(100 * m_countReconstructedTCs) / double(
 //            m_mcTrackVectorCounter) << "%/" << double(100 * m_countedPerfectRecoveries) / double(m_mcTrackVectorCounter) << "%/" << double(
 //            100 * m_countedCleanRecoveries) / double(m_mcTrackVectorCounter) << "%/" << double(100 * (m_caTrackCounter -
 //                m_countReconstructedTCs)) / double(m_countReconstructedTCs) << "%")
 }

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

◆ event()

void event ( void )

overridevirtual

event function

collect all reference TCs

collect all test TCs

for each test TC there will be a reference TC assigned to it. This relation will be stored in a pair (.first == pointer to test TC, .second == pointer to reference TC. if nothing found, a NULL pointer is stored at the according position). in LostTCs for each unpaired Reference TC there will be attached a test TC (which will have below m_PARAMqiThreshold of purity) if found, or NULL if not.

additionally all the relevant stuff will be counted.

find unpaired testTCs and mark them as Ghost

find unpaired referenceTCs and mark them as Lost

fill counters:

providing some debug output

catch refTCs which are out of bounds (e.g. min/max-momentum-cuts): m_mcTrackVectorCounter do the acceptedTCs-stuff: m_countAcceptedGFTCs m_PARAMacceptedTCname m_lostGFTCs m_PARAMlostTCname do wrongCharargeSignCounter-stuff: m_wrongChargeSignCounter do nRecoTCs (how?): m_countReconstructedTCs

now deal with all the root-cases:

Reimplemented from Module.

Definition at line 265 of file TrackFinderVXDAnalizerModule.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.

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

Member Data Documentation

◆ m_countAcceptedGFTCs

unsigned int m_countAcceptedGFTCs = 0

protected

counts number of accepted TCs which are stored in separate container for external tests (e.g.

trackFitChecker) in storaArray with name m_PARAMacceptedTCname.

Definition at line 179 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMminNDFThreshold

unsigned int m_PARAMminNDFThreshold

protected

defines how many measurements (numbers of degrees of freedom) the TC must have to be accepted as reconstructed.

Standard is 5, values lower than 5 wouldn't make sense because of minimal info needed for track parameters

Definition at line 164 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMorigin

std::vector<double> m_PARAMorigin

protected

only allowed size: 3.

stores coordinates of the origin used

Definition at line 136 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMprintData

std::string m_PARAMprintData

protected

depending on what value you set it, it will print data like momentum residuals or any other interesting info during endrun...

(currently not in use).

Definition at line 103 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMpurityThreshold

double m_PARAMpurityThreshold

protected

choose value to filter TCs found by VXDTF.

TCs having purities lower than this value won't be marked as reconstructed (value 0-1). e.g. having a TC with 4 hits, 1 foreign, 3 good ones. would mean 0.75, a m_PARAMpurityThresholdThreshold with 0.7 would mark the track as 'reconstructed', a threshold of 0.8 would neglect this TC

Definition at line 159 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMtrackedParametersDouble

std::vector< std::vector<std::vector<std::string> > > m_PARAMtrackedParametersDouble

protected

set here all parameters to be tracked which use an algorithm storing one double per tc.

Accepts a vector of vector of vector of strings of entries. Sample usage in steering file: param('trackedParametersDouble', [ [ ["Perfect"], ["AnalyzingAlgorithmValuePX", "AnalyzingAlgorithmResidualP"] ] ]) first innermost vector storest the TCType to be tracked, second the algorithms which shall be applied on that tcType

Definition at line 111 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMtrackedParametersInt

std::vector< std::vector<std::vector<std::string> > > m_PARAMtrackedParametersInt

protected

set here all parameters to be tracked which use an algorithm storing one int per tc.

Accepts a vector of vector of vector of strings of entries. Sample usage in steering file: param('trackedParametersDouble', [ [ ["Contaminated"], ["AnalyzingAlgorithmLostUClusters", "AnalyzingAlgorithmLostVClusters"] ] ]) first innermost vector storest the TCType to be tracked, second the algorithms which shall be applied on that tcType

Definition at line 119 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMtrackedParametersVecDouble

std::vector< std::vector<std::vector<std::string> > > m_PARAMtrackedParametersVecDouble

protected

set here all parameters to be tracked which use an algorithm storing one vector< double> per tc.

Accepts a vector of vector of vector of strings of entries. Sample usage in steering file: param('trackedParametersDouble', [ [ ["Clean"], ["AnalyzingAlgorithmLostUEDep", "AnalyzingAlgorithmLostVEDep"] ] ]) first innermost vector storest the TCType to be tracked, second the algorithms which shall be applied on that tcType

Definition at line 127 of file TrackFinderVXDAnalizerModule.h.

◆ m_PARAMuseMCDataForValues

bool m_PARAMuseMCDataForValues

protected

if true, for testTC the values of attached refTC will be stored instead of own values.

why are there values of the refTC stored? we want to know the real data, not the guesses of the reconstructed data. Deviations of reference values to guesses of the reconstructed data will be stored in resiudals anyway.

Definition at line 139 of file TrackFinderVXDAnalizerModule.h.

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

tracking/modules/VXDTFHelperTools/include/TrackFinderVXDAnalizerModule.h
tracking/modules/VXDTFHelperTools/src/TrackFinderVXDAnalizerModule.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

Member Function Documentation

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_countAcceptedGFTCs

◆ m_PARAMminNDFThreshold

◆ m_PARAMorigin

◆ m_PARAMprintData

◆ m_PARAMpurityThreshold

◆ m_PARAMtrackedParametersDouble

◆ m_PARAMtrackedParametersInt

◆ m_PARAMtrackedParametersVecDouble

◆ m_PARAMuseMCDataForValues