TrackFinderVXDAnalizerModule Class Reference

The TrackFinderVXDAnalizerModule. More...

#include <TrackFinderVXDAnalizerModule.h>

Inheritance diagram for TrackFinderVXDAnalizerModule:

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
void	endRun () override
	endRun function
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.
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.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Protected Attributes
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... (currently not in use).
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.
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.
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.
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.
bool	m_PARAMuseMCDataForValues
	if true, for testTC the values of attached refTC will be stored instead of own values.
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.
unsigned int	m_PARAMminNDFThreshold
	defines how many measurements (numbers of degrees of freedom) the TC must have to be accepted as reconstructed.
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.
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.
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

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

TrackFinderVXDAnalizerModule()

TrackFinderVXDAnalizerModule

(

)

constructor

Definition at line 39 of file TrackFinderVXDAnalizerModule.cc.

                                                           : Module()
{
  B2INFO("TrackFinderVXDAnalizer-initialize");
 
  std::vector<std::string> rootFileNameVals;
  rootFileNameVals.push_back("TrackFinderVXDAnalizerResults");
  rootFileNameVals.push_back("RECREATE");
 
 
  std::vector< std::vector< std::vector< std::string> > > trackedParametersDouble = {
    { {"Reference"},
      {"AnalyzingAlgorithmValueP", "AnalyzingAlgorithmValuePT", "AnalyzingAlgorithmValuePTheta", "AnalyzingAlgorithmValuePPhi", "AnalyzingAlgorithmValueDistSeed2IPXY", "AnalyzingAlgorithmValueDistSeed2IPZ", "AnalyzingAlgorithmValueQI"}
    },
    { {"Lost"},
      {"AnalyzingAlgorithmValueP", "AnalyzingAlgorithmValuePT", "AnalyzingAlgorithmValuePTheta", "AnalyzingAlgorithmValuePPhi", "AnalyzingAlgorithmValueDistSeed2IPXY", "AnalyzingAlgorithmValueDistSeed2IPZ", "AnalyzingAlgorithmValueQI"}
    },
    { {"Contaminated"},
      {
        "AnalyzingAlgorithmValueP", "AnalyzingAlgorithmValuePT", "AnalyzingAlgorithmValuePTheta", "AnalyzingAlgorithmValuePPhi", "AnalyzingAlgorithmValueDistSeed2IPXY", "AnalyzingAlgorithmValueDistSeed2IPZ", "AnalyzingAlgorithmValueQI",
        "AnalyzingAlgorithmResidualP", "AnalyzingAlgorithmResidualPT", "AnalyzingAlgorithmResidualPTheta", "AnalyzingAlgorithmResidualPPhi", "AnalyzingAlgorithmResidualPTAngle"
      }
    },
    { {"Clean"},
      {
        "AnalyzingAlgorithmValueP", "AnalyzingAlgorithmValuePT", "AnalyzingAlgorithmValuePTheta", "AnalyzingAlgorithmValuePPhi", "AnalyzingAlgorithmValueDistSeed2IPXY", "AnalyzingAlgorithmValueDistSeed2IPZ", "AnalyzingAlgorithmValueQI",
        "AnalyzingAlgorithmResidualP", "AnalyzingAlgorithmResidualPT", "AnalyzingAlgorithmResidualPTheta", "AnalyzingAlgorithmResidualPPhi", "AnalyzingAlgorithmResidualPTAngle"
      }
    },
    { {"Perfect"},
      {
        "AnalyzingAlgorithmValueP", "AnalyzingAlgorithmValuePT", "AnalyzingAlgorithmValuePTheta", "AnalyzingAlgorithmValuePPhi", "AnalyzingAlgorithmValueDistSeed2IPXY", "AnalyzingAlgorithmValueDistSeed2IPZ", "AnalyzingAlgorithmValueQI",
        "AnalyzingAlgorithmResidualP", "AnalyzingAlgorithmResidualPT", "AnalyzingAlgorithmResidualPTheta", "AnalyzingAlgorithmResidualPPhi", "AnalyzingAlgorithmResidualPTAngle"
      }
    },
  };
 
  std::vector< std::vector< std::vector< std::string> > > trackedParametersInt = {
    { {"Reference"},
      {"AnalyzingAlgorithmTotalUClusters", "AnalyzingAlgorithmTotalVClusters"}
    },
    { {"Lost"},
      {"AnalyzingAlgorithmTotalUClusters", "AnalyzingAlgorithmTotalVClusters"}
    },
    { {"Contaminated"},
      {"AnalyzingAlgorithmTotalUClusters", "AnalyzingAlgorithmTotalVClusters", "AnalyzingAlgorithmLostUClusters", "AnalyzingAlgorithmLostVClusters"}
    },
    { {"Clean"},
      {"AnalyzingAlgorithmTotalUClusters", "AnalyzingAlgorithmTotalVClusters", "AnalyzingAlgorithmLostUClusters", "AnalyzingAlgorithmLostVClusters"}
    },
    { {"Perfect"},
      {"AnalyzingAlgorithmTotalUClusters", "AnalyzingAlgorithmTotalVClusters", "AnalyzingAlgorithmLostUClusters", "AnalyzingAlgorithmLostVClusters"}
    }
  };
 
 
  std::vector< std::vector< std::vector< std::string> > > trackedParametersVecDouble = {
    { {"Reference"},
      {"AnalyzingAlgorithmTotalUEDep", "AnalyzingAlgorithmTotalVEDep"}
    },
    { {"Lost"},
      {"AnalyzingAlgorithmTotalUEDep", "AnalyzingAlgorithmTotalVEDep"}
    },
    { {"Contaminated"},
      {"AnalyzingAlgorithmTotalUEDep", "AnalyzingAlgorithmTotalVEDep", "AnalyzingAlgorithmLostUEDep", "AnalyzingAlgorithmLostVEDep"}
    },
    { {"Clean"},
      {"AnalyzingAlgorithmTotalUEDep", "AnalyzingAlgorithmTotalVEDep", "AnalyzingAlgorithmLostUEDep", "AnalyzingAlgorithmLostVEDep"}
    },
    { {"Perfect"},
      {"AnalyzingAlgorithmTotalUEDep", "AnalyzingAlgorithmTotalVEDep", "AnalyzingAlgorithmLostUEDep", "AnalyzingAlgorithmLostVEDep"}
    }
  };
 
  //Set module properties
  setDescription("analyzes quality of SpacePointTrackCands delivered by a test-TF compared to a reference TF");
  setPropertyFlags(c_ParallelProcessingCertified);
 
 
  addParam("referenceTCname", m_PARAMreferenceTCname, "the name of the storeArray container provided by the reference TF",
           std::string("mcTracks"));
  addParam("testTCname", m_PARAMtestTCname, "the name of the storeArray container provided by the TF to be evaluated",
           std::string(""));
  addParam("acceptedTCname", m_PARAMacceptedTCname, "special name for accepted/successfully reconstructed track candidates",
           std::string("acceptedVXDTFTracks"));
  addParam("lostTCname", m_PARAMlostTCname, "special name for lost track candidates", std::string("lostTracks"));
  addParam("purityThreshold", m_PARAMpurityThreshold,
           " chose value to filter TCs found by Test TF. TCs having purities lower than this value won't be marked as reconstructed",
           double(0.7));
  addParam("minNDFThreshold", m_PARAMminNDFThreshold,
           " defines how many measurements (numbers of degrees of freedom) the TC must have to be accepted as reconstructed, standard is 5",
           unsigned(5));
 
  addParam("writeToRoot", m_PARAMwriteToRoot,
           " if true, analysis data is stored to root file with file name chosen by 'rootFileName'", bool(true));
  addParam("rootFileName", 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 only if 'writeToRoot'=true  ",
           rootFileNameVals);
 
  addParam("trackedParametersDouble", m_PARAMtrackedParametersDouble,
           "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",
           trackedParametersDouble);
 
  addParam("trackedParametersInt", m_PARAMtrackedParametersInt,
           "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",
           trackedParametersInt);
 
  addParam("trackedParametersVecDouble", m_PARAMtrackedParametersVecDouble,
           "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",
           trackedParametersVecDouble);
 
 
  addParam("origin", m_PARAMorigin, " only allowed size: 3. stores coordinates of the origin used", {0, 0, 0});
  addParam("useMCDataForValues", m_PARAMuseMCDataForValues,
           "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."
           , bool(true));
 
  addParam("ignoreDeadTCs", m_PARAMignoreDeadTCs,
           " if true, test-tc whose activation-state is set to false are skipped for analysis", bool(true));
 
  addParam("doEventSummary", m_PARAMdoEventSummary,
           "if true, for each event a summary will be given (WARNING produces a lot of output!", bool(false));
}

~TrackFinderVXDAnalizerModule()

~TrackFinderVXDAnalizerModule ( )

inline

destructor

Definition at line 44 of file TrackFinderVXDAnalizerModule.h.

{}

Member Function Documentation

beginRun()

void beginRun ( void  )

inlineoverridevirtual

beginRun function

Reimplemented from Module.

Definition at line 52 of file TrackFinderVXDAnalizerModule.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;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ 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 439 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 432 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 420 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 445 of file Module.h.

{ terminate(); }

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.

{
  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

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.

{
 
  StoreObjPtr<EventMetaData> eventMetaDataPtr("EventMetaData", DataStore::c_Event);
  m_eventCounter = eventMetaDataPtr->getEvent();
  B2DEBUG(20, "################## entering TrackFinderVXDAnalizerModule - event " << m_eventCounter << " ######################");
 
  int nReferenceTCs = m_referenceTCs.getEntries();
  m_mcTrackCounter += nReferenceTCs;
  m_mcTrackVectorCounter += nReferenceTCs; // WARNING temporal solution!
  int nTestTCs = m_testTCs.getEntries();
  m_caTrackCounter += nTestTCs;
 
 
  unsigned nTC = 0;
  std::vector<AnalizerTCInfo> referenceTCVector;
  for (SpacePointTrackCand& aTC : m_referenceTCs) {
    std::vector<MCVXDPurityInfo > purities = createPurityInfos(aTC);
 
    MCVXDPurityInfo particleInfo = returnDominantParticleID(purities);
    B2DEBUG(25, "Calculating purities for reference TC " << nTC << ", name. Dominating iD " << particleInfo.getParticleID() <<
            " with purity " << particleInfo.getPurity().second << " was found among " << purities.size() << " assigned particles");
 
    AnalizerTCInfo referenceTC = AnalizerTCInfo::createTC(true, particleInfo, aTC);
    referenceTCVector.push_back(referenceTC);
    nTC++;
 
    if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 1, PACKAGENAME())) { aTC.print(1); }
  }
 
 
  nTC = 0;
  std::vector<AnalizerTCInfo> testTCVector;
  for (SpacePointTrackCand& aTC : m_testTCs) {
    if (m_PARAMignoreDeadTCs and aTC.hasRefereeStatus(SpacePointTrackCand::c_isActive) == false) { continue; }
    std::vector<MCVXDPurityInfo > purities = createPurityInfos(aTC);
 
    MCVXDPurityInfo particleInfo = returnDominantParticleID(purities);
    B2DEBUG(25, "Calculating purities for test TC " << nTC << ", name. Dominating iD " << particleInfo.getParticleID() <<
            " with purity" << particleInfo.getPurity().second << " was found among " << purities.size() << " assigned particles");
 
    AnalizerTCInfo testTC = AnalizerTCInfo::createTC(false, particleInfo, aTC);
    testTCVector.push_back(testTC);
    nTC++;
 
    if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 1, PACKAGENAME())) { aTC.print(1); }
  }
 
 
  std::vector<std::pair<AnalizerTCInfo*, AnalizerTCInfo*> > pairedTCs;
  for (AnalizerTCInfo& testTC : testTCVector) {
    int testID = testTC.assignedID.getParticleID();
 
    for (AnalizerTCInfo& referenceTC : referenceTCVector) {
      int refID = referenceTC.assignedID.getParticleID();
      B2DEBUG(29, "test TC with assigned ID " << testID << " was matched with refID " << refID);
      if (refID != testID) continue;
 
      testTC.tcType = AnalizerTCInfo::classifyTC(referenceTC, testTC, m_PARAMpurityThreshold, m_PARAMminNDFThreshold);
 
      B2DEBUG(29, "test TC with assigned ID " << testID <<
              " was classified for the corresponding with type for testTC/refTC: " << TCType::getTypeName(testTC.tcType) <<
              "/" << TCType::getTypeName(referenceTC.tcType) << " and will now paired up");
 
      referenceTC.pairUp(&testTC);
 
      pairedTCs.push_back({ &testTC, &referenceTC});
    }
  }
 
  AnalizerTCInfo::markUnused(testTCVector, TCType::Ghost);
 
  AnalizerTCInfo::markUnused(referenceTCVector, TCType::Lost);
 
 
  // good cases:
  unsigned int nPerfectTCs = 0, nCleanTCs = 0, nContaminatedTCs = 0, nFound = 0;
  // not so good cases:
  unsigned int nClonedTCs = 0, nSmallTCs = 0, nGhostTCs = 0, nLostTestTCs = 0, nLostRefTCs = 0;
  // bad cases: counts nTimes when the TC could not be identified/classified at all
  unsigned int nBadCases = 0, nRefClones = 0; // refClones, cases when reference TCs were marked as clones
  // hitCounters:
  unsigned int refPXDClusters = 0, refSVDClusters = 0, testPXDClusters = 0, testSVDClusters = 0;
 
  for (AnalizerTCInfo& aTC : testTCVector) {
    testPXDClusters += aTC.assignedID.getNPXDClustersTotal();
    testSVDClusters += aTC.assignedID.getNSVDUClustersTotal() + aTC.assignedID.getNSVDVClustersTotal();
 
    switch (aTC.tcType) {
      case TCType::Perfect: { nPerfectTCs++; nFound++; break; }
      case TCType::Clean: { nCleanTCs++; nFound++; break; }
      case TCType::Contaminated: { nContaminatedTCs++; nFound ++; break; }
      case TCType::Clone: { nClonedTCs++; break; }
      case TCType::SmallStump: { nSmallTCs++; break; }
      case TCType::Ghost: { nGhostTCs++; break; }
      case TCType::Lost: { nLostTestTCs++; break; }
      default: {
        nBadCases++;
        B2WARNING("TrackFinderVXDAnalizer::event(): test TC got type " << TCType::getTypeName(aTC.tcType) <<
                  " which is not counted for efficiency-calculation");
      }
    }
  }
 
  for (AnalizerTCInfo& aTC : referenceTCVector) {
    refPXDClusters += aTC.assignedID.getNPXDClustersTotal();
    refSVDClusters += aTC.assignedID.getNSVDUClustersTotal() + aTC.assignedID.getNSVDVClustersTotal();
 
    switch (aTC.tcType) {
      case TCType::Reference: { break; }
      case TCType::Clone: { nRefClones++; break; }
      case TCType::Lost: { nLostRefTCs++; break; }
      default: {
        nBadCases++;
        B2WARNING("TrackFinderVXDAnalizer::event(): reference TC got type " << TCType::getTypeName(aTC.tcType) <<
                  " which is not counted for efficiency-calculation");
      }
    }
  }
 
 
  std::string summary1 = "TrackFinderVXDAnalizer-Event " + std::to_string(m_eventCounter) +
                         ": the tested TrackFinder found: " +
                         " IDs (total/perfect/clean/contaminated/clone/tooShort/ghost: " + std::to_string(nFound) +
                         "/" + std::to_string(nPerfectTCs) +
                         "/" + std::to_string(nCleanTCs) +
                         "/" + std::to_string(nContaminatedTCs) +
                         "/" + std::to_string(nClonedTCs) +
                         "/" + std::to_string(nSmallTCs) +
                         "/" + std::to_string(nGhostTCs) +
                         ") within " + std::to_string(nTestTCs) +
                         " TCs and lost (test/ref) " + std::to_string(nLostTestTCs) +
                         "/" + std::to_string(nLostRefTCs) +
                         " TCs. nBadCases: " + std::to_string(nBadCases) +
                         " refClones: " + std::to_string(nRefClones) +
                         "\n" +
                         "There are " + std::to_string(nReferenceTCs) +
                         " referenceTCs, with mean of " + std::to_string((float(refPXDClusters) / float(nReferenceTCs))) +
                         "/" + std::to_string((float(refSVDClusters) / float(nReferenceTCs))) + " PXD/SVD clusters"
                         "\n" +
                         "There are " + std::to_string(nTestTCs) +
                         " testTCs, with mean of " + std::to_string((float(testPXDClusters) / float(nTestTCs))) +
                         "/" + std::to_string((float(testSVDClusters) / float(nTestTCs))) + " PXD/SVD clusters";
 
  std::string summary2 = "TrackFinderVXDAnalizer-Event " + std::to_string(m_eventCounter) +
                         ": the tested TrackFinder had an efficiency : total/perfect/clean/contaminated/clone/tooShort/ghost: " +
                         std::to_string(double(100 * nFound) / double(nReferenceTCs)) +
                         "%/" + std::to_string(double(100 * nPerfectTCs) / double(nReferenceTCs)) +
                         "%/" + std::to_string(double(100 * nCleanTCs) / double(nReferenceTCs)) +
                         "%/" + std::to_string(double(100 * nContaminatedTCs) / double(nReferenceTCs)) +
                         "%/" + std::to_string(double(100 * nClonedTCs) / double(nReferenceTCs)) +
                         "%/" + std::to_string(double(100 * nSmallTCs) / double(nReferenceTCs)) +
                         "%/" + std::to_string(double(100 * nGhostTCs) / double(nReferenceTCs)) + "%";
 
  std::string summary3 = "TrackFinderVXDAnalizer-Event " + std::to_string(m_eventCounter) +
                         ": totalCA|totalMC|ratio of pxdHits " + std::to_string(testPXDClusters) +
                         "|" + std::to_string(refPXDClusters) +
                         "|" + std::to_string(float(testPXDClusters) / float(refPXDClusters)) +
                         ", svdHits " + std::to_string(testSVDClusters) +
                         "|" + std::to_string(refSVDClusters) +
                         "|" + std::to_string(float(testSVDClusters) / float(refSVDClusters)) + " found by the two TFs";
 
  if (m_PARAMdoEventSummary) {
    B2INFO(summary1);
    B2INFO(summary2);
    B2INFO(summary3);
  } else {
    B2DEBUG(20, summary1);
    B2DEBUG(20, summary2);
    B2DEBUG(20, summary3);
  }
 
  m_totalRealHits += refPXDClusters + refSVDClusters;
  m_nCaPXDHits += testPXDClusters;
  m_nMcPXDHits += refPXDClusters;
  m_nCaSVDHits += testSVDClusters;
  m_nMcSVDHits += refSVDClusters;
  m_countReconstructedTCs += nFound;
  m_countedPerfectRecoveries += nPerfectTCs;
  m_countedCleanRecoveries += nCleanTCs;
  m_countedContaminatedRecoveries  += nContaminatedTCs;
  m_countedDoubleEntries += nClonedTCs;
  m_countedTCsTooShort  += nSmallTCs;
  m_countedGhosts  += nGhostTCs;
  m_countedLostTest += nLostTestTCs;
  m_countedLostRef += nLostRefTCs;
  m_countedReferenceClones += nRefClones;
 
 
  // TODO:
//   int acceptedTCs = m_acceptedTCs.getEntries();
//   m_countAcceptedGFTCs += acceptedTCs;
//   m_lostGFTCs += nLostTCs;
//   B2DEBUG(1, " of " << nTestTCs << " TCs produced by the tested TrackFinder, " << acceptedTCs <<
//           " were recognized safely and stored into the container of accepted TCs, " << nLostTCs <<
//           " were lost and their MCTF-TCs were stored in lostTCs")
//   for (unsigned int ID : foundIDs) {
//     B2DEBUG(1, " - ID " << ID << " recovered")
//   }
 
 
  if (m_PARAMwriteToRoot == false) { return; }
  // TODO:
 
  m_rootParameterTracker.collectData(testTCVector);
  m_rootParameterTracker.collectData(referenceTCVector);
 
  m_rootParameterTracker.fillRoot();
 
}

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 pathes */
  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://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  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)

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

Definition at line 134 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 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 363 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 381 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;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ 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 378 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://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.

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

initialize()

void initialize ( void  )

overridevirtual

inizialize function

Reimplemented from Module.

Definition at line 163 of file TrackFinderVXDAnalizerModule.cc.

{
  m_referenceTCs.isRequired(m_PARAMreferenceTCname);
  m_testTCs.isRequired(m_PARAMtestTCname);
  m_acceptedTCs.registerInDataStore(m_PARAMacceptedTCname, DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
  m_lostTCs.registerInDataStore(m_PARAMlostTCname, DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
 
 
  if (m_PARAMorigin.size() != 3) {
    B2ERROR("TrackFinderVXDAnalizerModule::initialize() passed parameter 'origin' has wrong number of entries (allowed: 3) of " <<
            m_PARAMorigin.size() << " reset to standard (0, 0, 0)");
    m_PARAMorigin = {0, 0, 0};
  }
 
  // deal with root-related stuff
  if (m_PARAMwriteToRoot == false) { return; }
 
  if ((m_PARAMrootFileName.size()) != 2) {
    std::string output;
    for (std::string& entry : m_PARAMrootFileName) {
      output += "'" + entry + "' ";
    }
    B2FATAL("TrackFinderVXDAnalizer::initialize(), rootFileName is set wrong, although parameter 'writeToRoot' is enabled! Actual entries are: "
            << output);
  }
 
  // deal with algorithms:
  m_rootParameterTracker.initialize(m_PARAMrootFileName[0] + ".root", m_PARAMrootFileName[1]);
  // typedef for increased readability:
  using AlgorithmDouble = AnalyzingAlgorithmBase<double, AnalizerTCInfo, B2Vector3D>;
  using AlgorithmInt = AnalyzingAlgorithmBase<int, AnalizerTCInfo, B2Vector3D>;
  using AlgorithmVecDouble = AnalyzingAlgorithmBase<std::vector<double>, AnalizerTCInfo, B2Vector3D>;
 
 
  // prepare all algorithms which store a double per tc:
  for (auto& parameterPackage : m_PARAMtrackedParametersDouble) {
    // check if parameterPackage has two entries: first is TCType, second is vector of algorithms
    if (parameterPackage.size() != 2) { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersDouble' was mis-used! Please read the documentation! (wrong number of added parameters)"); }
 
    // check if vector for tcType is really only one entry
    if (parameterPackage.front().size() != 1) { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersDouble' was mis-used! Please read the documentation! (wrong number of added parameters)"); }
 
    std::string tcTypeName = parameterPackage.front()[0];
    if (TCType::isValidName(tcTypeName) == false)
    { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersDouble' was mis-used! Please read the documentation! (invalid tcType: " << tcTypeName << ")"); }
 
    // for each algorithm, store a branch:
    for (auto& algorithm : parameterPackage.back()) {
      if (AlgoritmType::isValidName(algorithm) == false)
      { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersDouble' was mis-used! Please read the documentation! (invalid algorithmType: " << algorithm << ")"); }
      m_rootParameterTracker.addParameters4DoubleAlgorithms(tcTypeName, algorithm);
    }
  }
  AlgorithmDouble::setOrigin(B2Vector3D(m_PARAMorigin[0], m_PARAMorigin[1], m_PARAMorigin[2]));
  AlgorithmDouble::setWillRefTCdataBeUsed4TestTCs(m_PARAMuseMCDataForValues);
 
  // prepare all algorithms which store an int per tc:
  for (auto& parameterPackage : m_PARAMtrackedParametersInt) {
    // check if parameterPackage has two entries: first is TCType, second is vector of algorithms
    if (parameterPackage.size() != 2) { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersInt' was mis-used! Please read the documentation! (wrong number of added parameters)"); }
 
    // check if vector for tcType is really only one entry
    if (parameterPackage.front().size() != 1) { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersInt' was mis-used! Please read the documentation! (wrong number of added parameters)"); }
 
    std::string tcTypeName = parameterPackage.front()[0];
    if (TCType::isValidName(tcTypeName) == false)
    { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersInt' was mis-used! Please read the documentation! (invalid tcType: " << tcTypeName << ")"); }
 
    // for each algorithm, store a branch:
    for (auto& algorithm : parameterPackage.back()) {
      if (AlgoritmType::isValidName(algorithm) == false)
      { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersInt' was mis-used! Please read the documentation! (invalid algorithmType: " << algorithm << ")"); }
      m_rootParameterTracker.addParameters4IntAlgorithms(tcTypeName, algorithm);
    }
  }
  AlgorithmInt::setOrigin(B2Vector3D(m_PARAMorigin[0], m_PARAMorigin[1], m_PARAMorigin[2]));
  AlgorithmInt::setWillRefTCdataBeUsed4TestTCs(m_PARAMuseMCDataForValues);
 
  // prepare all algorithms which store a vector< double> per tc:
  for (auto& parameterPackage : m_PARAMtrackedParametersVecDouble) {
    // check if parameterPackage has two entries: first is TCType, second is vector of algorithms
    if (parameterPackage.size() != 2) { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersVecDouble' was mis-used! Please read the documentation! (wrong number of added parameters)"); }
 
    // check if vector for tcType is really only one entry
    if (parameterPackage.front().size() != 1) { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersVecDouble' was mis-used! Please read the documentation! (wrong number of added parameters)"); }
 
    std::string tcTypeName = parameterPackage.front()[0];
    if (TCType::isValidName(tcTypeName) == false)
    { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersVecDouble' was mis-used! Please read the documentation! (invalid tcType: " << tcTypeName << ")"); }
 
    // for each algorithm, store a branch:
    for (auto& algorithm : parameterPackage.back()) {
      if (AlgoritmType::isValidName(algorithm) == false)
      { B2FATAL("TrackFinderVXDAnalizer::initialize(), parameter 'trackedParametersVecDouble' was mis-used! Please read the documentation! (invalid algorithmType: " << algorithm << ")"); }
      m_rootParameterTracker.addParameters4VecDoubleAlgorithms(tcTypeName, algorithm);
    }
  }
  AlgorithmVecDouble::setOrigin(B2Vector3D(m_PARAMorigin[0], m_PARAMorigin[1], m_PARAMorigin[2]));
  AlgorithmVecDouble::setWillRefTCdataBeUsed4TestTCs(m_PARAMuseMCDataForValues);
}

returnDominantParticleID()

PurityType returnDominantParticleID ( const std::vector< PurityType > &  purities )

inline

of a vector of given particleIDs with their purities it returns the one which had the highest purity

Definition at line 69 of file TrackFinderVXDAnalizerModule.h.

      {
        PurityType bestResult = PurityType();
 
        for (const PurityType& iD : purities) {
          // cppcheck-suppress useStlAlgorithm
          if (iD > bestResult) { bestResult = iD; }
        }
        return bestResult;
      }

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

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 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()

void terminate ( void  )

overridevirtual

terminate function

Reimplemented from Module.

Definition at line 561 of file TrackFinderVXDAnalizerModule.cc.

{
 
  if (m_PARAMwriteToRoot == false) { return; }
  m_rootParameterTracker.terminate();
}

Member Data Documentation

m_acceptedTCs

StoreArray<SpacePointTrackCand> m_acceptedTCs

protected

StoreArray for accepted/successfully reconstructed track candidates.

Definition at line 91 of file TrackFinderVXDAnalizerModule.h.

m_caTrackCounter

unsigned int m_caTrackCounter = 0

protected

counts number of tracks reconstructed by the CATF.

Definition at line 194 of file TrackFinderVXDAnalizerModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_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_countedCleanRecoveries

unsigned int m_countedCleanRecoveries = 0

protected

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

Definition at line 200 of file TrackFinderVXDAnalizerModule.h.

m_countedContaminatedRecoveries

unsigned int m_countedContaminatedRecoveries = 0

protected

counts number of tracks, where foreign hits werew attached but its purity was above the threshold.

Definition at line 203 of file TrackFinderVXDAnalizerModule.h.

m_countedDoubleEntries

unsigned int m_countedDoubleEntries = 0

protected

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.

Definition at line 212 of file TrackFinderVXDAnalizerModule.h.

m_countedGhosts

unsigned int m_countedGhosts = 0

protected

counts number of tracks, where a dominating TC was found, but the purity did not reach the threshold.

Definition at line 209 of file TrackFinderVXDAnalizerModule.h.

m_countedLostRef

unsigned int m_countedLostRef = 0

protected

counts number of Lost reference tcs.

Definition at line 218 of file TrackFinderVXDAnalizerModule.h.

m_countedLostTest

unsigned int m_countedLostTest = 0

protected

counts number of Lost test tcs.

Definition at line 215 of file TrackFinderVXDAnalizerModule.h.

m_countedPerfectRecoveries

unsigned int m_countedPerfectRecoveries = 0

protected

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

Definition at line 197 of file TrackFinderVXDAnalizerModule.h.

m_countedReferenceClones

unsigned int m_countedReferenceClones = 0

protected

counts number reference TCs which were marked as clones.

Definition at line 221 of file TrackFinderVXDAnalizerModule.h.

m_countedTCsTooShort

unsigned int m_countedTCsTooShort = 0

protected

counts number of tracks, which did not have enough hits at all.

Definition at line 206 of file TrackFinderVXDAnalizerModule.h.

m_countReconstructedTCs

unsigned int m_countReconstructedTCs = 0

protected

counts number of reconstructed TCs.

Definition at line 176 of file TrackFinderVXDAnalizerModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_eventCounter

unsigned int m_eventCounter = 0

protected

knows current event number.

Definition at line 185 of file TrackFinderVXDAnalizerModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_lostGFTCs

unsigned int m_lostGFTCs = 0

protected

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

Definition at line 182 of file TrackFinderVXDAnalizerModule.h.

m_lostTCs

StoreArray<SpacePointTrackCand> m_lostTCs

protected

StoreArray for lost track candidates.

Definition at line 94 of file TrackFinderVXDAnalizerModule.h.

m_mcTrackCounter

unsigned int m_mcTrackCounter = 0

protected

counts number of tracks reconstructed by the mcTrackFinder.

Definition at line 188 of file TrackFinderVXDAnalizerModule.h.

m_mcTrackVectorCounter

unsigned int m_mcTrackVectorCounter = 0

protected

another counter of mcTCs, consideres size of datastores containing mcTCs.

Definition at line 227 of file TrackFinderVXDAnalizerModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

m_nCaPXDHits

unsigned int m_nCaPXDHits = 0

protected

counts total number of pxdHits added by caTF.

Definition at line 236 of file TrackFinderVXDAnalizerModule.h.

m_nCaSVDHits

unsigned int m_nCaSVDHits = 0

protected

counts total number of svdHits added by caTF.

Definition at line 239 of file TrackFinderVXDAnalizerModule.h.

m_nMcPXDHits

unsigned int m_nMcPXDHits = 0

protected

counts total number of pxdHits added by mcTF.

Definition at line 230 of file TrackFinderVXDAnalizerModule.h.

m_nMcSVDHits

unsigned int m_nMcSVDHits = 0

protected

counts total number of svdHits added by mcTF.

Definition at line 233 of file TrackFinderVXDAnalizerModule.h.

m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

m_PARAMacceptedTCname

std::string m_PARAMacceptedTCname

protected

the name of the trackCandidateCollection of successfully reconstructed track candidates determined by the TFAnalizer

Definition at line 148 of file TrackFinderVXDAnalizerModule.h.

m_PARAMdoEventSummary

bool m_PARAMdoEventSummary

protected

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

Definition at line 170 of file TrackFinderVXDAnalizerModule.h.

m_PARAMignoreDeadTCs

bool m_PARAMignoreDeadTCs

protected

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

Definition at line 167 of file TrackFinderVXDAnalizerModule.h.

m_PARAMlostTCname

std::string m_PARAMlostTCname

protected

the name of the trackCandidateCollection of lost track candidates determined by the TFAnalizer

Definition at line 151 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_PARAMreferenceTCname

std::string m_PARAMreferenceTCname

protected

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

Definition at line 142 of file TrackFinderVXDAnalizerModule.h.

m_PARAMrootFileName

std::vector<std::string> m_PARAMrootFileName

protected

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

Definition at line 133 of file TrackFinderVXDAnalizerModule.h.

m_PARAMtestTCname

std::string m_PARAMtestTCname

protected

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

Definition at line 145 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.

m_PARAMwriteToRoot

bool m_PARAMwriteToRoot

protected

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

Definition at line 130 of file TrackFinderVXDAnalizerModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

m_referenceTCs

StoreArray<SpacePointTrackCand> m_referenceTCs

protected

StoreArray for the reference TCs provided by a reference TF (like trackFinderMCTruth).

Definition at line 85 of file TrackFinderVXDAnalizerModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_rootParameterTracker

RootParameterTracker m_rootParameterTracker

protected

takes care of collecting data and storing it to root branches

Definition at line 97 of file TrackFinderVXDAnalizerModule.h.

m_testTCs

StoreArray<SpacePointTrackCand> m_testTCs

protected

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

Definition at line 88 of file TrackFinderVXDAnalizerModule.h.

m_totalRealHits

unsigned int m_totalRealHits = 0

protected

total number of hits (clusters/2) attached to mcTCs (therefore total number of real hits).

Definition at line 191 of file TrackFinderVXDAnalizerModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

m_wrongChargeSignCounter

unsigned int m_wrongChargeSignCounter = 0

protected

counts number of times, where assigned caTC guessed wrong sign of charge.

Definition at line 224 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