TrackFinderMCTruthRecoTracksModule Class Reference

This module uses the simulated truth information (MCParticles and their relations) to determine which hits belong to which particles and writes track candidates filled with necessary information into the DataStore. More...

#include <TrackFinderMCTruthRecoTracksModule.h>

Inheritance diagram for TrackFinderMCTruthRecoTracksModule:

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

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

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.

Private Member Functions
template<class THit , class TSimHit >
bool	isWithinNLoops (double Bz, const THit *aHit, double nLoops)
	helper function which returns true if the current hit is within n loops the template give the hit type and the according sim hit type (e.g.
template<class THit , class TSimHit >
bool	didParticleExitCDC (const THit *aHit)
	helper function which returns true if the current hit has a creation time after the MCParticle left the CDC and entered TOP.
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
bool	m_usePXDHits
	Boolean to select if PXDHits should be used.
bool	m_useSVDHits
	Boolean to select if SVDHits should be used.
bool	m_useCDCHits
	Boolean to select if CDCHits should be used.
bool	m_useOnlyAxialCDCHits
	Boolean to select if only axial CDCHits should be used.
bool	m_useOnlyBeforeTOP
	Boolean to select if hits after TOP detector are discarded.
float	m_useNLoops
	Number of loops to include in the MC tracks.
bool	m_useReassignedHits
	Boolean to select the inclusion of hits form discarded secondary daughters.
bool	m_useSecondCDCHits
	Also includes the CDC 2nd hit information in the mc tracks.
bool	m_enforceTrueHit
	If set true only cluster hits that have a relation to a TrueHit will be included in the track candidate.
std::vector< std::string >	m_whichParticles
	List of keywords to mark what properties particles must have to get a track candidate .
int	m_particleProperties
	Internal encoding of m_whichParticles to avoid string comparisons.
double	m_energyCut
	Create track candidates only for MCParticles with energy above this cut.
bool	m_neutrals
	Boolean to mark if track candidates should also be created for neutral particles.
bool	m_mergeDecayInFlight
	Boolean to merge decay in flight chains that involve a single charged particle.
bool	m_setTimeSeed
	Boolean to forward the production time as seed time.
double	m_smearing
	Smearing of MCMomentum and MCVertex in %.
std::vector< double >	m_smearingCov
	Covariance matrix used to smear the true pos and mom before passed to track candidate.
TMatrixDSym	m_initialCov
	The std::vector m_smearingCov will be translated into this TMatrixD.
int	m_notEnoughtHitsCounter
	will hold number of tracks that do not have enough hits to form a track candidate (total NDF less than 5)
int	m_noTrueHitCounter
	will hold number of cluster hits that do not have a corresponding true hit
int	m_nRecoTracks = 0
	will hold the total number of created track candidates
std::string	m_recoTracksStoreArrayName
	RecoTracks StoreArray name.
int	m_minPXDHits
	Minimum number of PXD hits per track to allow track candidate creation.
int	m_minSVDHits
	Minimum number of SVD hits per track to allow track candidate creation.
int	m_minCDCAxialHits
	Minimum number of CDC hits from axial wires per track to allow track candidate creation.
int	m_minCDCStereoHits
	Minimum number of CDC hits from stereo wires per track to allow track candidate creation.
bool	m_allowFirstCDCSuperLayerOnly
	Boolean to allow tracks to pass the stereo hit requirement if they touched only the first (axial) CDC layer.
int	m_minimalNdf
	Minimum number of total hits per track to allow track candidate creation.
std::vector< int >	m_fromPdgCodes
	if size() is not 0, only for particles having an ancestor (parent or parent of parent etc) with PDG codes same as in this vector a track candidate be created
std::vector< int >	m_particlePdgCodes
	if size() is not 0, only for particles with PDG codes same as in this vector a track candidate will be created
bool	m_onlyCheckDirectParentPdgCode = false
	To be used together with WhichParticles to select the ancestor and daughters.
bool	m_mcParticlesPresent
	This flag is set to false if there are no MC Particles in the data store (probably data run?) and we can not create MC Reco tracks.
double	m_splitAfterDeltaT
	Minimal time delay between two sim hits (in ns) after which MC reco track will be split into seperate tracks.
bool	m_discardAuxiliaryHits = false
	if true hits marked as auxiliary will not be included in the RecoTrack
std::vector< uint >	m_param_useCDCSuperLayers
	List of super layers to be used.
std::vector< uint >	m_param_useCDCLayers
	List of layers to be used.
std::vector< uint >	m_param_ignoreCDCLayers
	List of layers to be ignored in tracking.
std::array< bool, 9 >	m_useCDCSuperLayers {}
	Bits for the used super layers ATTENTION: hardcoded value for number of super layers.
std::array< bool, 56 >	m_useCDCLayers {}
	Bits for the used layers ATTENTION: hardcoded value for number of layers.
StoreArray< MCParticle >	m_MCParticles
	MCParticles StoreArray.
StoreArray< RecoTrack >	m_RecoTracks
	RecoTracks StoreArray.
StoreArray< PXDTrueHit >	m_PXDTrueHits
	PXDTrueHits StoreArray.
StoreArray< PXDCluster >	m_PXDClusters
	PXDClusters StoreArray.
StoreArray< SVDTrueHit >	m_SVDTrueHits
	SVDTrueHits StoreArray.
StoreArray< SVDCluster >	m_SVDClusters
	SVDTrueHits StoreArray.
StoreArray< CDCHit >	m_CDCHits
	CDCHits StoreArray.
StoreArray< CDCSimHit >	m_CDCSimHits
	CDCSimHits StoreArray.
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

This module uses the simulated truth information (MCParticles and their relations) to determine which hits belong to which particles and writes track candidates filled with necessary information into the DataStore.

The Relations MCParticles -> Hits for PXD, SVD and CDC are used. At the moment CDCHits, PXDTrueHits, SVDTrueHits, PXDCluster hits and SVDCluster hits can be used By default only track candidates for primary particles (= particles from the generator) are created but this can be changed with the WhichParticles option. For every hit the true time information is extracted from the trueHits or simHit hits. This Information is used to sort the hits in the correct order for the fitting of curling tracks. The created genfit::TrackCandidates can be fitted with GenFitterModule.

Definition at line 43 of file TrackFinderMCTruthRecoTracksModule.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

TrackFinderMCTruthRecoTracksModule()

TrackFinderMCTruthRecoTracksModule

(

)

Constructor of the module.

Sets the description of the module.

Definition at line 42 of file TrackFinderMCTruthRecoTracksModule.cc.

                                                                       : Module()
{
  //Set module properties
  setDescription("Uses the MC information to create genfit::TrackCandidates for primary MCParticles and Relations between them. "
                 "Fills the created genfit::TrackCandidates with all information (start values, hit indices) needed for the fitting.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // choose which hits to use, all hits assigned to the track candidate will be used in the fit
  addParam("UsePXDHits",
           m_usePXDHits,
           "Set true if PXDHits or PXDClusters should be used",
           true);
  addParam("UseSVDHits",
           m_useSVDHits,
           "Set true if SVDHits or SVDClusters should be used",
           true);
  addParam("UseCDCHits",
           m_useCDCHits,
           "Set true if CDCHits should be used",
           true);
  addParam("UseOnlyAxialCDCHits",
           m_useOnlyAxialCDCHits,
           "Set true if only the axial CDCHits should be used",
           false);
  addParam("UseNLoops",
           m_useNLoops,
           "Set the number of loops whose hits will be marked as priortiy hits. All other hits "
           "will be marked as auxiliary and therfore not considered for efficiency computations "
           "By default, all hits will be priority hits.",
           INFINITY);
  addParam("UseOnlyBeforeTOP",
           m_useOnlyBeforeTOP,
           "Mark hits as auxiliary after the track left the CDC and touched the TOP detector.",
           false);
  addParam("UseReassignedHits",
           m_useReassignedHits,
           "Include hits reassigned from discarded seconardy daughters in the tracks.",
           false);
  addParam("UseSecondCDCHits",
           m_useSecondCDCHits,
           "Also includes the CDC 2nd hit information in the MC tracks.",
           false);
  addParam("MinPXDHits",
           m_minPXDHits,
           "Minimum number of PXD hits needed to allow the created of a track candidate",
           0);
  addParam("MinSVDHits",
           m_minSVDHits,
           "Minimum number of SVD hits needed to allow the created of a track candidate",
           0);
  addParam("MinCDCAxialHits",
           m_minCDCAxialHits,
           "Minimum number of CDC hits form an axial wire needed to allow the created of a track candidate",
           0);
  addParam("MinCDCStereoHits",
           m_minCDCStereoHits,
           "Minimum number of CDC hits form a stereo wire needed to allow the created of a track candidate",
           0);
  addParam("AllowFirstCDCSuperLayerOnly",
           m_allowFirstCDCSuperLayerOnly,
           "Allow tracks to pass the stereo hit requirement if they touched only the first (axial) CDC layer",
           false);
 
  addParam("MinimalNDF",
           m_minimalNdf,
           "Minimum number of total hits needed to allow the creation of a track candidate. "
           "It is called NDF (number of degrees of freedom) because it counts the dimensionality. "
           "2D hits are counted as 2",
           5);
 
  //choose for which particles a track candidate should be created
  //this is just an attempt to find out what is the most suitable way to select particles, if you have other/better ideas, communicate it to the tracking group...
  addParam("WhichParticles",
           m_whichParticles,
           "List of keywords to mark what properties particles must have to get a track candidate. "
           "If several properties are given all of them must be true: "
           "\"primary\" particle must come from the generator, "
           "\"PXD\", \"SVD\", \"CDC\", \"TOP\", \"ARICH\", \"ECL\" or \"KLM\" particle must have hits in the subdetector with that name. "
           "\"is:X\" where X is a PDG code: particle must have this code. "
           "\"from:X\" any of the particles's ancestors must have this (X) code",
           std::vector<std::string>(1, "primary"));
  addParam("onlyCheckDirectParentPdgCode",
           m_onlyCheckDirectParentPdgCode,
           "To be used together with WhichParticles to select the ancestor and daughters. "
           "If true, only check the direct parent to be contained in the list of possible ancestors. "
           "If false, check all ancestors in in the list of possible ancestors. "
           "This could be used to e.g. only create MCRecoTracks for slow pions from D* decays instead of creating an MCRecoTrack "
           "for every pion as long as the D* is one of its ancestors.",
           m_onlyCheckDirectParentPdgCode);
 
  addParam("EnergyCut",
           m_energyCut,
           "Track candidates are only created for MCParticles with energy larger than this cut ",
           double(0.0));
 
  addParam("Neutrals",
           m_neutrals,
           "Set true if track candidates should be created also for neutral particles",
           bool(false));
 
  addParam("MergeDecayInFlight",
           m_mergeDecayInFlight,
           "Merge decay in flights that produce a single charged particle to the parent particle",
           bool(false));
 
  addParam("SetTimeSeed",
           m_setTimeSeed,
           "Set true to forward the production time as time seed of the particles to the RecoTrack",
           true);
 
  //smearing of MCMomentum
  addParam("Smearing",
           m_smearing,
           "Smearing of MCMomentum/MCVertex prior to storing it in genfit::TrackCandidate (in %). "
           "A negative value will switch off smearing. This is also the default.",
           -1.0);
 
  addParam("SmearingCov",
           m_smearingCov,
           "Covariance matrix used to smear the true pos and mom before passed to track candidate. "
           "This matrix will also passed to Genfit as the initial covarance matrix. "
           "If any diagonal value is negative this feature will not be used. "
           "OFF DIAGONAL ELEMENTS DO NOT HAVE AN EFFECT AT THE MOMENT",
           std::vector<double>(36, -1.0));
 
  addParam("SplitAfterDeltaT",
           m_splitAfterDeltaT,
           "Minimal time delay between two sim hits (in ns) after which MC reco track will be "
           "split into seperate tracks. If < 0, don't do splitting."
           "This feature was designed to be used in MC cosmics reconstruction to get two MCRecoTracks"
           "when track pass through empty SVD region, so that number of MCRecoTracks can be compared with"
           "number of non merged reco tracks. ",
           -1.0);
 
  // names of output containers
  addParam("RecoTracksStoreArrayName",
           m_recoTracksStoreArrayName,
           "Name of store array holding the RecoTracks (output)",
           std::string(""));
 
  addParam("TrueHitMustExist",
           m_enforceTrueHit,
           "If set true only cluster hits that have a relation to a TrueHit will be included in the track candidate",
           false);
 
  addParam("discardAuxiliaryHits",
           m_discardAuxiliaryHits,
           "If set true hits marked as auxiliary (e.g. hits in higher loops) will not be included in the track candidate.",
           m_discardAuxiliaryHits);
 
  addParam("useCDCSuperLayers",
           m_param_useCDCSuperLayers,
           "List of CDC super layers to be used.",
           m_param_useCDCSuperLayers);
 
  addParam("useCDCLayers",
           m_param_useCDCLayers,
           "List of layers to be used. "
           "If a layer number is given in 'ignoreLayers', too, this will result on a B2FATAL. "
           "Either use 'useLayers' and provide a set of layers to be used, "
           "or use 'ignoreLayers' and provide a list of layers to be ignored, but not both at the same time.",
           m_param_useCDCLayers);
 
  addParam("ignoreCDCLayers",
           m_param_ignoreCDCLayers,
           "List of layers to be ignored. "
           "If a layer number is given in 'useLayers', too, this will result on a B2FATAL. "
           "Either use 'useLayers' and provide a set of layers to be used, "
           "or use 'ignoreLayers' and provide a list of layers to be ignored, but not both at the same time.",
           m_param_ignoreCDCLayers);
 
 
 
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 320 of file TrackFinderMCTruthRecoTracksModule.cc.

{
  m_notEnoughtHitsCounter = 0;
  m_noTrueHitCounter = 0;
  m_nRecoTracks = 0;
}

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(); }

didParticleExitCDC()

bool didParticleExitCDC ( const THit *  aHit )

private

helper function which returns true if the current hit has a creation time after the MCParticle left the CDC and entered TOP.

These tracks that re-enter the tracking volume are more difficult to reconstruct due to the energy loss in the CDC outer all and in TOP. The template gives the hit type and the according sim hit type (e.g. CDCHit and CDCSimHit)

Parameters

aHit	pointer to the hit under investiation

Returns

: returns true if the the track left CDC and entered TOP before this hit was registered

Definition at line 982 of file TrackFinderMCTruthRecoTracksModule.cc.

{
  const TSimHit* simHit = ahit->template getRelated<TSimHit>();
  if (not simHit) return false;
 
  const MCParticle* mcParticle = simHit->template getRelated<MCParticle>();
  if (not mcParticle) return false;
  if (not mcParticle->hasSeenInDetector(Const::TOP)) return false;
 
  RelationVector<TOPBarHit> topHits = mcParticle->getRelationsWith<TOPBarHit>();
  if (topHits.size() == 0) return false;
 
  // Get hit with the smallest time.
  auto lessTime = [](const TOPBarHit & lhs, const TOPBarHit & rhs) {
    return lhs.getTime() < rhs.getTime();
  };
  auto itFirstTopHit = std::min_element(topHits.begin(), topHits.end(), lessTime);
 
  return simHit->getGlobalTime() > itFirstTopHit->getTime();
};

endRun()

void endRun ( void  )

overridevirtual

This method is called if the current run ends.

Reimplemented from Module.

Definition at line 1005 of file TrackFinderMCTruthRecoTracksModule.cc.

{
  if (m_notEnoughtHitsCounter != 0) {
    B2WARNING(m_notEnoughtHitsCounter << " tracks had not enough hits to have at least " << m_minimalNdf <<
              " number of degrees of freedom (NDF). No Track Candidates were created from them so they will not be passed to the track fitter");
  }
  if (m_noTrueHitCounter != 0) {
    B2WARNING(m_noTrueHitCounter <<
              " cluster hits did not have a relation to a true hit and were therefore not included in a track candidate");
  }
  B2INFO("The MCTrackFinder created a total of " << m_nRecoTracks << " track candidates");
}

evalCondition()

bool evalCondition ( ) const

inherited

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

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

Returns

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

Definition at line 96 of file Module.cc.

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

event()

void event ( void  )

overridevirtual

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

Reimplemented from Module.

Definition at line 328 of file TrackFinderMCTruthRecoTracksModule.cc.

{
  // Skip in the case there are no MC particles present.
  if (not m_mcParticlesPresent) {
    B2DEBUG(20, "Skipping MC Track Finder as there are no MC Particles registered in the DataStore.");
    return;
  }
 
  StoreObjPtr<EventMetaData> eventMetaDataPtr("EventMetaData", DataStore::c_Event);
  const int eventCounter = eventMetaDataPtr->getEvent();
  B2DEBUG(20, "*******   MCTrackFinderModule processing event number: " << eventCounter << " *******");
 
  //all the input containers. First: MCParticles
  const int nMcParticles = m_MCParticles.getEntries();
  B2DEBUG(20, "MCTrackFinder: total Number of MCParticles: " << nMcParticles);
 
  //PXD trueHits
  const int nPXDHits = m_PXDTrueHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of PXDTrueHits: " << nPXDHits);
 
  RelationArray mcPartToPXDTrueHits(m_MCParticles, m_PXDTrueHits);
  const int nMcPartToPXDHits = mcPartToPXDTrueHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of relations between MCParticles and PXDHits: " << nMcPartToPXDHits);
 
  //PXD clusters
  const int nPXDClusters = m_PXDClusters.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of PXDClusters: " << nPXDClusters);
 
  RelationArray pxdClusterToMCParticle(m_PXDClusters, m_MCParticles);
  const int nPxdClusterToMCPart = pxdClusterToMCParticle.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of relations between PXDCluster and MCParticles: " << nPxdClusterToMCPart);
 
  //SVD truehits
  const int nSVDHits = m_SVDTrueHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of SVDDHits: " << nSVDHits);
 
  RelationArray mcPartToSVDTrueHits(m_MCParticles, m_SVDTrueHits);
  const int nMcPartToSVDHits = mcPartToSVDTrueHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of relations between MCParticles and SVDHits: " << nMcPartToSVDHits);
 
  //SVD clusters
  const int nSVDClusters = m_SVDClusters.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of SVDClusters: " << nSVDClusters);
 
  RelationArray svdClusterToMCParticle(m_SVDClusters, m_MCParticles);
  const int nSvdClusterToMCPart = svdClusterToMCParticle.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of relations between SVDCluster and MCParticles: " << nSvdClusterToMCPart);
 
  //CDC
  const int nCDCHits = m_CDCHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of CDCHits: " << nCDCHits);
 
  RelationArray mcPartToCDCHits(m_MCParticles, m_CDCHits);
  const int nMcPartToCDCHits = mcPartToCDCHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of relations between MCParticles and CDCHits: " << nMcPartToCDCHits);
 
  const int nCDCSimHits = m_CDCSimHits.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of CDCSimHits: " << nCDCSimHits);
 
  RelationArray cdcSimHitToHitRel(m_CDCSimHits, m_CDCHits);
  const int nCdcSimHitToHitRel = cdcSimHitToHitRel.getEntries();
  B2DEBUG(20, "MCTrackFinder: Number of relations between CDCSimHit and CDCHits: " << nCdcSimHitToHitRel);
 
  // prepare rejection of CDC/PXD/SVD hits from higher order loops
  const double Bz = BFieldManager::getField(0, 0, 0).Z() / Unit::T;
 
  // loop over MCParticles. And check several user selected properties. Make a track candidate only if MCParticle has properties wanted by user options.
  std::set<int> alreadyConsumedMCParticles;
  for (int iPart = 0; iPart < nMcParticles; ++iPart) {
    if (alreadyConsumedMCParticles.count(iPart)) continue;
    alreadyConsumedMCParticles.insert(iPart);
 
    MCParticle* aMcParticlePtr = m_MCParticles[iPart];
    // Ignore particles that didn't propagate significantly, they cannot make tracks.
    if ((aMcParticlePtr->getDecayVertex() - aMcParticlePtr->getProductionVertex()).R() < 1 * Unit::cm) {
      B2DEBUG(20, "Particle that did not propagate significantly cannot make track.");
      continue;
    }
 
    //set the property mask for this particle and compare it to the one generated from user input
    int mcParticleProperties = 0;
    if (aMcParticlePtr->hasStatus(MCParticle::c_PrimaryParticle)) {
      mcParticleProperties += 1;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::PXD)) {
      mcParticleProperties += 2;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::SVD)) {
      mcParticleProperties += 4;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::CDC)) {
      mcParticleProperties += 8;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::TOP)) {
      mcParticleProperties += 16;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::ARICH)) {
      mcParticleProperties += 32;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::ECL)) {
      mcParticleProperties += 64;
    }
    if (aMcParticlePtr->hasSeenInDetector(Const::KLM)) {
      mcParticleProperties += 128;
    }
    // check all "seen in" properties that the mcparticle should have in one line.
    if ((mcParticleProperties bitand m_particleProperties) != m_particleProperties) {
      B2DEBUG(20, "PDG: " << aMcParticlePtr->getPDG() <<  " | property mask of particle " <<  mcParticleProperties <<
              " demanded property mask " << m_particleProperties);
      continue; //goto next mcParticle, do not make track candidate
    }
    //make links only for interesting MCParticles: energy cut
    if (aMcParticlePtr->getEnergy() < m_energyCut) {
      B2DEBUG(20, "particle energy too low.  MC particle will be skipped");
      continue; //goto next mcParticle, do not make track candidate
    }
 
    //check if particle has the pdg code the user wants to have. If user did not set any pdg code every code is fine for track candidate creation
 
    const int nPdgCodes = m_particlePdgCodes.size();
    if (nPdgCodes not_eq 0) {
      const int currentPdgCode = aMcParticlePtr->getPDG();
      int nFalsePdgCodes = 0;
      for (int i = 0; i not_eq nPdgCodes; ++i) {
        if (m_particlePdgCodes[i] not_eq currentPdgCode) {
          ++nFalsePdgCodes;
        }
      }
      if (nFalsePdgCodes == nPdgCodes) {
        B2DEBUG(20, "particle does not have one of the user provided pdg codes and will therefore be skipped");
        continue; //goto next mcParticle, do not make track candidate
      }
    }
 
 
    //check if particle has an ancestor selected by the user. If user did not set any pdg code every code is fine for track candidate creation
    const int nFromPdgCodes = m_fromPdgCodes.size();
    if (nFromPdgCodes not_eq 0) {
      MCParticle* currentParent = aMcParticlePtr->getMother();
      int nFalsePdgCodes = 0;
      int nAncestor = 0;
      bool foundParent = false;
      while (currentParent not_eq nullptr) {
        int currentParentPdgCode = currentParent->getPDG();
        for (int i = 0; i not_eq nFromPdgCodes; ++i) {
          if (m_fromPdgCodes[i] not_eq currentParentPdgCode) {
            ++nFalsePdgCodes;
          } else {
            foundParent = true;
            // if (m_onlyCheckDirectParentPdgCode) {
            //   break;
            // }
          }
        }
 
        if (m_onlyCheckDirectParentPdgCode) {
          currentParent = nullptr;
        } else {
          currentParent = currentParent->getMother();
          ++nAncestor;
        }
      }
      if (nFalsePdgCodes == (nAncestor * nFromPdgCodes) or not(m_onlyCheckDirectParentPdgCode and foundParent)) {
        B2DEBUG(20, "particle does not have and ancestor with one of the user provided pdg codes and will therefore be skipped");
        continue; //goto next mcParticle, do not make track candidate
      }
    }
 
    // Ignore baryons, except for deuteron.  The purpose is mainly to
    // avoid an error message when getCharge() is called below.
    if (abs(aMcParticlePtr->getPDG()) > 1000000000
        && abs(aMcParticlePtr->getPDG()) != Const::deuteron.getPDGCode()) {
      B2DEBUG(20, "Skipped Baryon.");
      continue; //goto next mcParticle, do not make track candidate
 
    }
 
    // ignore neutrals (unless requested) (and unless monopoles)
    if (!m_neutrals && (aMcParticlePtr->getCharge() == 0 && abs(aMcParticlePtr->getPDG()) != Monopoles::c_monopolePDGCode)) {
      B2DEBUG(20, "particle does not have the right charge. MC particle will be skipped");
      continue; //goto next mcParticle, do not make track candidate
    }
 
 
    B2DEBUG(20, "Build a track for the MCParticle with index: " << iPart << " (PDG: " << aMcParticlePtr->getPDG() << ")");
 
    std::vector<const MCParticle*> trackMCParticles;
    trackMCParticles.push_back(aMcParticlePtr);
 
    if (m_mergeDecayInFlight and aMcParticlePtr->getCharge() != 0) {
      std::vector<MCParticle*> daughters = aMcParticlePtr->getDaughters();
      std::vector<MCParticle*> decayInFlightParticles;
      for (MCParticle* daughter : daughters) {
        if (daughter->getSecondaryPhysicsProcess() > 200 and daughter->getCharge() != 0) {
          decayInFlightParticles.push_back(daughter);
        }
      }
      if (decayInFlightParticles.size() == 1) {
        trackMCParticles.push_back(decayInFlightParticles.front());
        alreadyConsumedMCParticles.insert(trackMCParticles.back()->getArrayIndex());
      }
    }
 
    //assign indices of the Hits from all detectors.
    // entry 0: global event of each hit
    // entry 1: indices in the respective hit arrays (PXD, SVD, CDC, ...)
    // entry 2: the category of the hit: either a high priority and should be found or not so important
    // entry 3: identifier for the detector type
    typedef std::tuple<double, int, RecoHitInformation::OriginTrackFinder, Const::EDetector> TimeHitIDDetector;
    std::vector<TimeHitIDDetector> hitsWithTimeAndDetectorInformation;
 
    int ndf = 0; // count the ndf of one track candidate
 
    // create a list containing the indices to the PXDHits that belong to one track
    if (m_usePXDHits) {
      int hitCounter = 0;
      for (const MCParticle* trackMCParticle : trackMCParticles) {
        const RelationVector<PXDCluster>& relatedClusters = trackMCParticle->getRelationsFrom<PXDCluster>();
 
        for (size_t i = 0; i < relatedClusters.size(); ++i) {
          bool isReassigned = relatedClusters.weight(i) < 0;
          if (!m_useReassignedHits && isReassigned) continue;  // skip hits from secondary particles
 
          // currently only priority Hits for PXD
          auto mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderPriorityHit;
 
          // Reassigned hits are auxiliary
          if (isReassigned) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // Mark higher order hits as auxiliary, if m_useNLoops has been set
          if (std::isfinite(m_useNLoops) and not isWithinNLoops<PXDCluster, PXDTrueHit>(Bz, relatedClusters.object(i), m_useNLoops)) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // check if the particle left hits in TOP and add mark hits after that as auxiliary.
          if (m_useOnlyBeforeTOP and didParticleExitCDC<PXDCluster, PXDTrueHit>(relatedClusters.object(i))) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // if flag is set discard all auxiliary hits:
          if (m_discardAuxiliaryHits and mcFinder == RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit) continue;
 
          const PXDCluster* pxdCluster = relatedClusters.object(i);
          const RelationVector<PXDTrueHit>& relatedTrueHits = pxdCluster->getRelationsTo<PXDTrueHit>();
 
          if (relatedTrueHits.size() == 0 and m_enforceTrueHit) {
            // there is not trueHit! throw away hit because there is no time information for sorting
            ++m_noTrueHitCounter;
            continue;
          }
 
          float time = NAN;
          for (const PXDTrueHit& pxdTrueHit : relatedTrueHits) {
            // Make sure only a true hit is taken that really comes from the current mcParticle.
            // This must be carefully checked because several trueHits from different real tracks can be melted into one cluster
            const RelationVector<MCParticle>& relatedMCParticles = pxdTrueHit.getRelationsFrom<MCParticle>();
            if (std::find_if(relatedMCParticles.begin(),
                             relatedMCParticles.end(),
            [trackMCParticle](const MCParticle & mcParticle) {
            return &mcParticle == trackMCParticle;
          }) != relatedMCParticles.end()) {
              time = pxdTrueHit.getGlobalTime();
              break;
            }
          }
          if (not std::isnan(time)) {
            hitsWithTimeAndDetectorInformation.emplace_back(time, pxdCluster->getArrayIndex(), mcFinder, Const::PXD);
            ++hitCounter;
            ndf += 2;
          }
        }
 
        B2DEBUG(20, "     add " << hitCounter << " PXDClusters. " << relatedClusters.size() - hitCounter <<
                " PXDClusters were not added because they do not have a corresponding PXDTrueHit");
      } // next trackMCParticle
 
      if (hitCounter < m_minPXDHits) {
        ++m_notEnoughtHitsCounter;
        continue; //goto next mcParticle, do not make track candidate
      }
    } // end if m_usePXDHits
 
    // create a list containing the indices to the SVDHits that belong to one track
    if (m_useSVDHits) {
      int hitCounter = 0;
      for (const MCParticle* trackMCParticle : trackMCParticles) {
        const RelationVector<SVDCluster>& relatedClusters = trackMCParticle->getRelationsFrom<SVDCluster>();
 
        for (size_t i = 0; i < relatedClusters.size(); ++i) {
          bool isReassigned = relatedClusters.weight(i) < 0;
          if (!m_useReassignedHits && isReassigned) continue;  // skip hits from secondary particles
 
          auto mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderPriorityHit;
 
          // Reassigned hits are auxiliary
          if (isReassigned) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // Mark higher order hits as auxiliary, if m_useNLoops has been set
          if (std::isfinite(m_useNLoops) and not isWithinNLoops<SVDCluster, SVDTrueHit>(Bz, relatedClusters.object(i), m_useNLoops)) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // check if the particle left hits in TOP and add mark hits after that as auxiliary.
          if (m_useOnlyBeforeTOP and didParticleExitCDC<SVDCluster, SVDTrueHit>(relatedClusters.object(i))) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // if flag is set discard all auxiliary hits:
          if (m_discardAuxiliaryHits and mcFinder == RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit) continue;
 
          const SVDCluster* svdCluster = relatedClusters.object(i);
          const RelationVector<SVDTrueHit>& relatedTrueHits = svdCluster->getRelationsTo<SVDTrueHit>();
 
          if (relatedTrueHits.size() == 0 and m_enforceTrueHit) {
            // there is not trueHit! throw away hit because there is no time information for sorting
            ++m_noTrueHitCounter;
            continue;
          }
 
          float time = NAN;
          for (const SVDTrueHit& svdTrueHit : relatedTrueHits) {
            // Make sure only a true hit is taken that really comes from the current mcParticle.
            // This must be carefully checked because several trueHits from different real tracks can be melted into one cluster
            const RelationVector<MCParticle>& relatedMCParticles = svdTrueHit.getRelationsFrom<MCParticle>();
            if (std::find_if(relatedMCParticles.begin(),
                             relatedMCParticles.end(),
            [trackMCParticle](const MCParticle & mcParticle) {
            return &mcParticle == trackMCParticle;
          }) != relatedMCParticles.end()) {
              time = svdTrueHit.getGlobalTime();
              break;
            }
          }
          if (not std::isnan(time)) {
            hitsWithTimeAndDetectorInformation.emplace_back(time, svdCluster->getArrayIndex(), mcFinder, Const::SVD);
            ++hitCounter;
            ndf += 1;
          }
        }
 
        B2DEBUG(20, "     add " << hitCounter << " SVDClusters. " << relatedClusters.size() - hitCounter <<
                " SVDClusters were not added because they do not have a corresponding SVDTrueHit");
      }
 
      if (hitCounter < m_minSVDHits) {
        ++m_notEnoughtHitsCounter;
        continue; //goto next mcParticle, do not make track candidate
      }
    } // end if m_useSVDHits
 
    if (m_useCDCHits) {
      // create a list containing the indices to the CDCHits that belong to one track
      int nAxialHits = 0;
      int nStereoHits = 0;
      std::array<int, 9> nHitsBySuperLayerId{};
 
      for (const MCParticle* trackMCParticle : trackMCParticles) {
        const RelationVector<CDCHit>& relatedHits = trackMCParticle->getRelationsTo<CDCHit>();
 
        for (size_t i = 0; i < relatedHits.size(); ++i) {
          bool isReassigned = relatedHits.weight(i) < 0;
          if (!m_useReassignedHits && isReassigned) continue;  // skip hits from secondary particles
 
          const CDCHit* cdcHit = relatedHits.object(i);
 
          unsigned short superLayerId = cdcHit->getISuperLayer();
          if (not m_useCDCSuperLayers[superLayerId]) continue;
          unsigned short layerID = cdcHit->getICLayer();
          if (not m_useCDCLayers[layerID]) continue;
 
          // continue if this is a 2nd CDC hit information and we do not want to use it
          if (!m_useSecondCDCHits && cdcHit->is2ndHit()) {
            continue;
          }
 
          auto mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderPriorityHit;
 
          // Reassigned hits are auxiliary
          if (isReassigned) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // Mark higher order hits as auxiliary, if m_useNLoops has been set
          if (std::isfinite(m_useNLoops) and not isWithinNLoops<CDCHit, CDCSimHit>(Bz, cdcHit, m_useNLoops)) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // check if the particle left hits in TOP and add mark hits after that as auxiliary.
          if (m_useOnlyBeforeTOP and didParticleExitCDC<CDCHit, CDCSimHit>(cdcHit)) {
            mcFinder = RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit;
          }
 
          // if flag is set discard all auxiliary hits:
          if (m_discardAuxiliaryHits and mcFinder == RecoHitInformation::OriginTrackFinder::c_MCTrackFinderAuxiliaryHit) continue;
 
 
          const CDCSimHit* aCDCSimHitPtr = cdcHit->getRelatedFrom<CDCSimHit>();
          if (not aCDCSimHitPtr) {
            B2DEBUG(20, "     Skipping CDCHit without related CDCSimHit.");
            continue;
          }
          double time = aCDCSimHitPtr->getFlightTime();
 
          // Here it is hardcoded what superlayer has axial wires and what has stereo wires.
          // Maybe it would be better if the WireId would know this
          if (superLayerId % 2 == 0) {
            hitsWithTimeAndDetectorInformation.emplace_back(time, cdcHit->getArrayIndex(), mcFinder, Const::CDC);
            ndf += 1;
            ++nAxialHits;
            ++nHitsBySuperLayerId[superLayerId];
          } else {
            if (not m_useOnlyAxialCDCHits) {
              hitsWithTimeAndDetectorInformation.emplace_back(time, cdcHit->getArrayIndex(), mcFinder, Const::CDC);
              ndf += 1;
              ++nStereoHits;
              ++nHitsBySuperLayerId[superLayerId];
            }
          }
        }
      } // next trackMCParticle
      B2DEBUG(20, "    added " << nAxialHits << " axial and " << nStereoHits << " stereo CDCHits");
      if (nAxialHits < m_minCDCAxialHits) {
        // Not enough axial hits. Next MCParticle.
        ++m_notEnoughtHitsCounter;
        continue;
      }
 
      if (not m_useOnlyAxialCDCHits and (nStereoHits < m_minCDCStereoHits)) {
        if (m_allowFirstCDCSuperLayerOnly and
            nHitsBySuperLayerId[0] == nAxialHits and
            (nAxialHits + nStereoHits >= m_minCDCAxialHits + m_minCDCStereoHits)) {
          // Special rule for low momentum tracks that only touch the first axial superlayer
          // If there still enough hits combined from the axial and stereo hit limit -> keep the track.
        } else {
          // Not enough stereo hits. Next MCParticle.
          ++m_notEnoughtHitsCounter;
          continue;
        }
      }
    } // end if m_useCDCHits
 
    if (m_initialCov(0, 0) > 0.0) { //using a user set initial cov and corresponding smearing of inital state adds information
      ndf += 5;
    }
    if (ndf < m_minimalNdf) {
      ++m_notEnoughtHitsCounter;
      continue; //goto next mcParticle, do not make track candidate
    }
 
    std::sort(hitsWithTimeAndDetectorInformation.begin(), hitsWithTimeAndDetectorInformation.end(),
    [](const TimeHitIDDetector & rhs, const TimeHitIDDetector & lhs) {
      return std::get<0>(rhs) < std::get<0>(lhs);
    });
 
    // Now create vectors of vectors, which will either contain hits the full vector WithTimeanddetectorInformation
    // or slices of it, when cutting SplitAfterDeltaT is positive, each slice corresponding to a (sub-) reco track
    // created by the MC particle.
    std::vector< std::vector<TimeHitIDDetector> > hitsWithTimeAndDetectorInformationVectors;
 
    if (m_splitAfterDeltaT < 0.0) { // no splitting, vector will only contain a single hitInformation vector
      hitsWithTimeAndDetectorInformationVectors.push_back(hitsWithTimeAndDetectorInformation);
    } else { // split on delta t
 
      std::vector<TimeHitIDDetector>::size_type splitFromIdx = 0; // whenever splitting subtrack, start slice from this index
      for (std::vector<TimeHitIDDetector>::size_type i = 1; i != hitsWithTimeAndDetectorInformation.size(); i++) {
 
        double delta_t = (std::get<0>(hitsWithTimeAndDetectorInformation[i])
                          - std::get<0>(hitsWithTimeAndDetectorInformation[i - 1]));
 
        if (delta_t > m_splitAfterDeltaT) {
          // push slice of `hitsWithTimeAndDetectorInformation' between splitFromidx  and previous index
          hitsWithTimeAndDetectorInformationVectors
          .emplace_back(hitsWithTimeAndDetectorInformation.begin() + splitFromIdx,
                        hitsWithTimeAndDetectorInformation.begin() + i);
          splitFromIdx = i;
        }
      }
      // add subtrack after last splitting to list of tracks
      hitsWithTimeAndDetectorInformationVectors
      .emplace_back(hitsWithTimeAndDetectorInformation.begin() + splitFromIdx,
                    hitsWithTimeAndDetectorInformation.end());
    }
 
    //Now create TrackCandidate
    int counter = m_RecoTracks.getEntries();
    B2DEBUG(20, "We came pass all filter of the MCPartile and hit properties. TrackCandidate " << counter <<
            " will be created from the MCParticle with index: " << iPart << " (PDG: " << aMcParticlePtr->getPDG() << ")");
 
 
 
    //set track parameters from MCParticle information
    ROOT::Math::XYZVector positionTrue = aMcParticlePtr->getProductionVertex();
    ROOT::Math::XYZVector momentumTrue = aMcParticlePtr->getMomentum();
    double timeTrue = aMcParticlePtr->getProductionTime();
 
    // if no kind of smearing is activated the initial values (seeds) for track fit will be the simulated truth
    ROOT::Math::XYZVector momentum = momentumTrue;
    ROOT::Math::XYZVector position = positionTrue;
    double time = timeTrue;
    TVectorD stateSeed(6); //this will
    TMatrixDSym covSeed(6);
    covSeed.Zero(); // just to be save
    covSeed(0, 0) = 1; covSeed(1, 1) = 1; covSeed(2, 2) = 2 * 2;
    covSeed(3, 3) = 0.1 * 0.1; covSeed(4, 4) = 0.1 * 0.1; covSeed(5, 5) = 0.2 * 0.2;
    //it may have positive effect on the fit not to start with exactly precise true values (or it may be just interesting to study this)
    //one can smear the starting momentum values with a gaussian
    //this calculation is always performed, but with the default value of m_smearing = 0 it has no effect on momentum and position (true values are taken)
 
    if (m_smearing > 0.0) {
      double smearing = m_smearing / 100.0;  //the module parameter m_smearing goes from 0 to 100, smearing should go from 0 to 1
 
      double smearedX = gRandom->Gaus(positionTrue.x(), smearing * positionTrue.x());
      double smearedY = gRandom->Gaus(positionTrue.y(), smearing * positionTrue.y());
      double smearedZ = gRandom->Gaus(positionTrue.z(), smearing * positionTrue.z());
      position.SetXYZ(smearedX, smearedY, smearedZ);
      double smearedPX = gRandom->Gaus(momentumTrue.x(), smearing * momentumTrue.x());
      double smearedPY = gRandom->Gaus(momentumTrue.y(), smearing * momentumTrue.y());
      double smearedPZ = gRandom->Gaus(momentumTrue.z(), smearing * momentumTrue.z());
      momentum.SetXYZ(smearedPX, smearedPY, smearedPZ);
    }
 
    //Errors for the position/momentum values can also be passed to genfit::TrackCandidate
    //Default values in Genfit are (1.,1.,1.,), they seem to be not good!!
    //The best way to set the 'correct' errors has to be investigated....
    if (m_initialCov(0, 0) > 0.0) { // alternative seamring with according to a covariance matrix
      double smearedX = gRandom->Gaus(positionTrue.x(), sqrt(m_initialCov(0, 0)));
      double smearedY = gRandom->Gaus(positionTrue.y(), sqrt(m_initialCov(1, 1)));
      double smearedZ = gRandom->Gaus(positionTrue.z(), sqrt(m_initialCov(2, 2)));
      position.SetXYZ(smearedX, smearedY, smearedZ);
      double smearedPX = gRandom->Gaus(momentumTrue.x(), sqrt(m_initialCov(3, 3)));
      double smearedPY = gRandom->Gaus(momentumTrue.y(), sqrt(m_initialCov(4, 4)));
      double smearedPZ = gRandom->Gaus(momentumTrue.z(), sqrt(m_initialCov(5, 5)));
      momentum.SetXYZ(smearedPX, smearedPY, smearedPZ);
      covSeed = m_initialCov;
    }
 
    // Finally create RecoTracks for MC particle.
    // Either only one or multiple tracks, if SplitAfterDeltaT is positive
    for (const auto& hitInformationVector : hitsWithTimeAndDetectorInformationVectors) {
 
      // TODO: In former times, the track candidate also stored the PDG code!!!
      short int charge = static_cast<short int>(aMcParticlePtr->getCharge());
 
      // extrapolate the position and momentum to the point of the first hit on the helix
      if (hitInformationVector.size() != 0) {
        // reset the time to the time of the first hit  (assumes time > production time)
        time = std::get<0>(hitInformationVector.at(0));
        const double deltaT = time - aMcParticlePtr->getProductionTime();
        const double energy = sqrt(momentum.Mag2() + aMcParticlePtr->get4Vector().M() * aMcParticlePtr->get4Vector().M());
        const double beta_xy = momentum.Rho() / energy;
        // calculate arclength in 2D of the track
        const double arclength2D = beta_xy * Const::speedOfLight * deltaT;
 
        // get the position and momentum from the helix at the acrlength corresponding to the first hit
        Belle2::Helix helix = Belle2::Helix(position, momentum, charge, Bz);
        momentum = helix.getMomentumAtArcLength2D(arclength2D, Bz);
        position = helix.getPositionAtArcLength2D(arclength2D);
      }
 
 
      RecoTrack* newRecoTrack = m_RecoTracks.appendNew(B2Vector3D(position), B2Vector3D(momentum), charge);
      if (m_setTimeSeed) {
        newRecoTrack->setTimeSeed(time);
      }
      ++m_nRecoTracks;
 
      //create relation between the track candidates and the mcParticle (redundant to saving the MCId)
      newRecoTrack->addRelationTo(aMcParticlePtr);
      B2DEBUG(20, " --- Create relation between genfit::TrackCand " << counter << " and MCParticle " << iPart);
 
      int hitCounter = 0;
      for (const TimeHitIDDetector& hitInformation : hitInformationVector) {
 
        const Const::EDetector& detectorInformation = std::get<3>(hitInformation);
        const int hitID = std::get<1>(hitInformation);
        const auto hitOriginMCFinderType = std::get<2>(hitInformation);
 
 
        if (detectorInformation == Const::CDC) {
          const CDCHit* cdcHit = m_CDCHits[hitID];
          const CDCSimHit* aCDCSimHitPtr = cdcHit->getRelatedFrom<CDCSimHit>();
 
          //now determine the correct sign to resolve the left right ambiguity in the fitter
          ROOT::Math::XYZVector simHitPos = aCDCSimHitPtr->getPosTrack();
          ROOT::Math::XYZVector simMom = aCDCSimHitPtr->getMomentum();
          ROOT::Math::XYZVector simHitPosOnWire = aCDCSimHitPtr->getPosWire();
 
          CDC::CDCGeometryPar& cdcGeometry = CDC::CDCGeometryPar::Instance();
          const unsigned short isRightHit = cdcGeometry.getNewLeftRightRaw(simHitPosOnWire, simHitPos, simMom);
 
          if (isRightHit) {
            newRecoTrack->addCDCHit(cdcHit, hitCounter, RecoHitInformation::RightLeftInformation::c_right, hitOriginMCFinderType);
          } else {
            newRecoTrack->addCDCHit(cdcHit, hitCounter, RecoHitInformation::RightLeftInformation::c_left, hitOriginMCFinderType);
          }
          B2DEBUG(20, "CDC hit " << hitID << " has reft/right sign " << isRightHit);
        } else if (detectorInformation == Const::PXD) {
          const PXDCluster* pxdCluster = m_PXDClusters[hitID];
          newRecoTrack->addPXDHit(pxdCluster, hitCounter, hitOriginMCFinderType);
        } else if (detectorInformation == Const::SVD) {
          const SVDCluster* svdCluster = m_SVDClusters[hitID];
          newRecoTrack->addSVDHit(svdCluster, hitCounter, hitOriginMCFinderType);
        }
        ++hitCounter;
      } // end loop over hits
 
      B2DEBUG(20, "New RecoTrack: #PXDHits: " << newRecoTrack->getPXDHitList().size() <<
              " #SVDHits: " << newRecoTrack->getSVDHitList().size() <<
              " #CDCHits: " << newRecoTrack->getCDCHitList().size());
 
    } // end loop over vector
  }//end loop over MCParticles
}

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

Initialize the Module.

This method is called only once before the actual event processing starts.

Reimplemented from Module.

Definition at line 217 of file TrackFinderMCTruthRecoTracksModule.cc.

{
  if (m_MCParticles.isOptional()) {
    m_mcParticlesPresent = true;
 
    //output store arrays have to be registered in initialize()
    m_RecoTracks.registerInDataStore(m_recoTracksStoreArrayName, DataStore::c_ErrorIfAlreadyRegistered);
 
    m_RecoTracks.registerRelationTo(m_MCParticles);
 
    RecoTrack::registerRequiredRelations(m_RecoTracks);
 
    // build a bit mask with all properties a MCParticle should have to lead to the creation of a track candidate
    m_particleProperties = 0;
    int aPdgCode = 0;
    const int nProperties = m_whichParticles.size();
    for (int i = 0; i not_eq nProperties; ++i) {
      if (m_whichParticles[i] == "primary") {
        m_particleProperties += 1;
      } else if (m_whichParticles[i] == "PXD") {
        m_particleProperties += 2;
      } else if (m_whichParticles[i] == "SVD") {
        m_particleProperties += 4;
      } else if (m_whichParticles[i] == "CDC") {
        m_particleProperties += 8;
      } else if (m_whichParticles[i] == "TOP") {
        m_particleProperties += 16;
      } else if (m_whichParticles[i] == "ARICH") {
        m_particleProperties += 32;
      } else if (m_whichParticles[i] == "ECL") {
        m_particleProperties += 64;
      } else if (m_whichParticles[i] == "KLM") {
        m_particleProperties += 128;
      } else if (m_whichParticles[i].substr(0, 3) == "is:") {
        std::string pdgCodeString = m_whichParticles[i].substr(3);
        std::stringstream(pdgCodeString) >> aPdgCode;
        B2DEBUG(20, "PDG code added to m_particlePdgCodes " << aPdgCode << " *******");
        m_particlePdgCodes.push_back(aPdgCode);
      } else if (m_whichParticles[i].substr(0, 5) == "from:") {
        std::string pdgCodeString = m_whichParticles[i].substr(5);
        std::stringstream(pdgCodeString) >> aPdgCode;
        B2DEBUG(20, "PDG code added to m_fromPdgCodes " << aPdgCode << " *******");
        m_fromPdgCodes.push_back(aPdgCode);
      } else {
        B2FATAL("Invalid values were given to the MCTrackFinder parameter WhichParticles");
      }
    }
 
 
 
    //transfom the smearingCov vector into a TMatrixD
    //first check if it can be transformed into a 6x6 matrix
    if (m_smearingCov.size() != 36) {
      B2FATAL("SmearingCov does not have exactly 36 elements. So 6x6 covariance matrix can be formed from it");
    }
    m_initialCov.ResizeTo(6, 6);
    m_initialCov = TMatrixDSym(6, &m_smearingCov[0]);
    for (int i = 0; i != 6; ++i) {
      if (m_initialCov(i, i) < 0.0) {
        m_initialCov(0, 0) = -1.0; // if first element of matrix is negative this using this matrix will be switched off
      }
    }
 
    if (m_smearing > 0.0 && m_initialCov(0, 0) > 0.0) {
      B2FATAL("Both relative smearing (Smearing) and using a smearing cov (SmearingCov) is activated but only one of both can be used");
    }
  }
 
  if (not m_param_useCDCSuperLayers.empty()) {
    for (const uint useSuperLayer : m_param_useCDCSuperLayers) {
      m_useCDCSuperLayers.at(useSuperLayer) = true;
    }
  } else {
    m_useCDCSuperLayers.fill(true);
  }
 
  // Check for common value in the two vectors for using / ignoring layers
  for (const uint useLayer : m_param_useCDCLayers) {
    for (const uint ingoreLayer : m_param_ignoreCDCLayers) {
      if (useLayer == ingoreLayer) {
        B2FATAL("You chose to use and ignore CDC layer " << useLayer << " at the same time. "
                "Please decide to either use or to ignore the layer.");
      }
    }
  }
 
  // fill all layers that should be used
  if (not m_param_useCDCLayers.empty()) {
    for (const uint layer : m_param_useCDCLayers) {
      m_useCDCLayers.at(layer) = true;
    }
  } else {
    m_useCDCLayers.fill(true);
  }
  // set layers that should be ignored to false
  if (not m_param_ignoreCDCLayers.empty()) {
    for (const uint layer : m_param_ignoreCDCLayers) {
      m_useCDCLayers.at(layer) = false;
    }
  }
 
}

isWithinNLoops()

bool isWithinNLoops ( double  Bz, const THit *  aHit, double  nLoops  )

private

helper function which returns true if the current hit is within n loops the template give the hit type and the according sim hit type (e.g.

CDCHit and CDCSimHit)

Parameters

Bz	the z-component of the B field
aHit	pointer to the hit under investiation
nLoops	the number of loops the hit should be in

Returns

: returns true if the hit is on the < nLoops th loop of the track

Definition at line 949 of file TrackFinderMCTruthRecoTracksModule.cc.

{
  // for SVD there are cases with more than one simhit attached
  const RelationVector<TSimHit>& relatedSimHits = aHit->template getRelationsWith<TSimHit>();
 
  // take the first best simhit with mcParticle attached
  const MCParticle* mcParticle = nullptr;
  const TSimHit* aSimHit = nullptr;
  for (const auto& thisSimHit : relatedSimHits) {
    mcParticle = thisSimHit.template getRelated<MCParticle>();
    aSimHit = &thisSimHit;
    if (mcParticle) break;
  }
  if (not mcParticle or not aSimHit) {
    return false;
  }
 
  // subtract the production time here in order for this classification to also work
  // for particles produced at times t' > t0
  const double tof = aSimHit->getGlobalTime() - mcParticle->getProductionTime();
  const double speed = mcParticle->get4Vector().Beta() * Const::speedOfLight;
  const float absMom3D = mcParticle->getMomentum().R();
 
  const double loopLength = 2 * M_PI * absMom3D / (Bz * 0.00299792458);
  const double loopTOF =  loopLength / speed;
  if (tof > loopTOF * nLoops) {
    return false;
  } else {
    return true;
  }
}

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

virtual void terminate ( void  )

inlinevirtualinherited

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

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

This method can be implemented by subclasses.

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

Definition at line 176 of file Module.h.

{};

Member Data Documentation

m_allowFirstCDCSuperLayerOnly

bool m_allowFirstCDCSuperLayerOnly

private

Boolean to allow tracks to pass the stereo hit requirement if they touched only the first (axial) CDC layer.

Definition at line 125 of file TrackFinderMCTruthRecoTracksModule.h.

m_CDCHits

StoreArray<CDCHit> m_CDCHits

private

CDCHits StoreArray.

Definition at line 160 of file TrackFinderMCTruthRecoTracksModule.h.

m_CDCSimHits

StoreArray<CDCSimHit> m_CDCSimHits

private

CDCSimHits StoreArray.

Definition at line 161 of file TrackFinderMCTruthRecoTracksModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_discardAuxiliaryHits

bool m_discardAuxiliaryHits = false

private

if true hits marked as auxiliary will not be included in the RecoTrack

Definition at line 142 of file TrackFinderMCTruthRecoTracksModule.h.

m_energyCut

double m_energyCut

private

Create track candidates only for MCParticles with energy above this cut.

Definition at line 105 of file TrackFinderMCTruthRecoTracksModule.h.

m_enforceTrueHit

bool m_enforceTrueHit

private

If set true only cluster hits that have a relation to a TrueHit will be included in the track candidate.

Definition at line 100 of file TrackFinderMCTruthRecoTracksModule.h.

m_fromPdgCodes

std::vector<int> m_fromPdgCodes

private

if size() is not 0, only for particles having an ancestor (parent or parent of parent etc) with PDG codes same as in this vector a track candidate be created

Definition at line 128 of file TrackFinderMCTruthRecoTracksModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_initialCov

TMatrixDSym m_initialCov

private

The std::vector m_smearingCov will be translated into this TMatrixD.

Definition at line 114 of file TrackFinderMCTruthRecoTracksModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_MCParticles

StoreArray<MCParticle> m_MCParticles

private

MCParticles StoreArray.

Definition at line 154 of file TrackFinderMCTruthRecoTracksModule.h.

m_mcParticlesPresent

bool m_mcParticlesPresent

private

Initial value:

=
      false

This flag is set to false if there are no MC Particles in the data store (probably data run?) and we can not create MC Reco tracks.

Definition at line 138 of file TrackFinderMCTruthRecoTracksModule.h.

m_mergeDecayInFlight

bool m_mergeDecayInFlight

private

Boolean to merge decay in flight chains that involve a single charged particle.

Definition at line 107 of file TrackFinderMCTruthRecoTracksModule.h.

m_minCDCAxialHits

int m_minCDCAxialHits

private

Minimum number of CDC hits from axial wires per track to allow track candidate creation.

Definition at line 123 of file TrackFinderMCTruthRecoTracksModule.h.

m_minCDCStereoHits

int m_minCDCStereoHits

private

Minimum number of CDC hits from stereo wires per track to allow track candidate creation.

Definition at line 124 of file TrackFinderMCTruthRecoTracksModule.h.

m_minimalNdf

int m_minimalNdf

private

Minimum number of total hits per track to allow track candidate creation.

2D hits are counted as 2

Definition at line 126 of file TrackFinderMCTruthRecoTracksModule.h.

m_minPXDHits

int m_minPXDHits

private

Minimum number of PXD hits per track to allow track candidate creation.

Definition at line 121 of file TrackFinderMCTruthRecoTracksModule.h.

m_minSVDHits

int m_minSVDHits

private

Minimum number of SVD hits per track to allow track candidate creation.

Definition at line 122 of file TrackFinderMCTruthRecoTracksModule.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_neutrals

bool m_neutrals

private

Boolean to mark if track candidates should also be created for neutral particles.

Definition at line 106 of file TrackFinderMCTruthRecoTracksModule.h.

m_notEnoughtHitsCounter

int m_notEnoughtHitsCounter

private

Initial value:

=
      0

will hold number of tracks that do not have enough hits to form a track candidate (total NDF less than 5)

Definition at line 115 of file TrackFinderMCTruthRecoTracksModule.h.

m_noTrueHitCounter

int m_noTrueHitCounter

private

Initial value:

=
      0

will hold number of cluster hits that do not have a corresponding true hit

Definition at line 117 of file TrackFinderMCTruthRecoTracksModule.h.

m_nRecoTracks

int m_nRecoTracks = 0

private

will hold the total number of created track candidates

Definition at line 119 of file TrackFinderMCTruthRecoTracksModule.h.

m_onlyCheckDirectParentPdgCode

bool m_onlyCheckDirectParentPdgCode = false

private

To be used together with WhichParticles to select the ancestor and daughters.

If true, only check the direct parent to be contained in the list of possible ancestors. If false, check all ancestors in in the list of possible ancestors. This could be used to e.g. only create MCRecoTracks for slow pions from D* decays.

Definition at line 136 of file TrackFinderMCTruthRecoTracksModule.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_param_ignoreCDCLayers

std::vector<uint> m_param_ignoreCDCLayers

private

List of layers to be ignored in tracking.

Definition at line 148 of file TrackFinderMCTruthRecoTracksModule.h.

m_param_useCDCLayers

std::vector<uint> m_param_useCDCLayers

private

List of layers to be used.

Definition at line 146 of file TrackFinderMCTruthRecoTracksModule.h.

m_param_useCDCSuperLayers

std::vector<uint> m_param_useCDCSuperLayers

private

List of super layers to be used.

Definition at line 144 of file TrackFinderMCTruthRecoTracksModule.h.

m_particlePdgCodes

std::vector<int> m_particlePdgCodes

private

if size() is not 0, only for particles with PDG codes same as in this vector a track candidate will be created

Definition at line 130 of file TrackFinderMCTruthRecoTracksModule.h.

m_particleProperties

int m_particleProperties

private

Initial value:

=
      0

Internal encoding of m_whichParticles to avoid string comparisons.

Definition at line 103 of file TrackFinderMCTruthRecoTracksModule.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_PXDClusters

StoreArray<PXDCluster> m_PXDClusters

private

PXDClusters StoreArray.

Definition at line 157 of file TrackFinderMCTruthRecoTracksModule.h.

m_PXDTrueHits

StoreArray<PXDTrueHit> m_PXDTrueHits

private

PXDTrueHits StoreArray.

Definition at line 156 of file TrackFinderMCTruthRecoTracksModule.h.

m_RecoTracks

StoreArray<RecoTrack> m_RecoTracks

private

RecoTracks StoreArray.

Definition at line 155 of file TrackFinderMCTruthRecoTracksModule.h.

m_recoTracksStoreArrayName

std::string m_recoTracksStoreArrayName

private

RecoTracks StoreArray name.

Definition at line 120 of file TrackFinderMCTruthRecoTracksModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_setTimeSeed

bool m_setTimeSeed

private

Boolean to forward the production time as seed time.

Definition at line 109 of file TrackFinderMCTruthRecoTracksModule.h.

m_smearing

double m_smearing

private

Smearing of MCMomentum and MCVertex in %.

This adds a relative error to the initial values without changing the default large initial covariance matrix using for fitting

Definition at line 110 of file TrackFinderMCTruthRecoTracksModule.h.

m_smearingCov

std::vector<double> m_smearingCov

private

Covariance matrix used to smear the true pos and mom before passed to track candidate.

This matrix will also passed to Genfit as the initial covarance matrix. If any diagonal value is negative this feature will not be used. OFF DIAGNOLA ELEMENTS DO NOT HAVE AN EFFECT AT THE MOMENT

Definition at line 112 of file TrackFinderMCTruthRecoTracksModule.h.

m_splitAfterDeltaT

double m_splitAfterDeltaT

private

Minimal time delay between two sim hits (in ns) after which MC reco track will be split into seperate tracks.

If < 0, don't do splitting.

Definition at line 140 of file TrackFinderMCTruthRecoTracksModule.h.

m_SVDClusters

StoreArray<SVDCluster> m_SVDClusters

private

SVDTrueHits StoreArray.

Definition at line 159 of file TrackFinderMCTruthRecoTracksModule.h.

m_SVDTrueHits

StoreArray<SVDTrueHit> m_SVDTrueHits

private

SVDTrueHits StoreArray.

Definition at line 158 of file TrackFinderMCTruthRecoTracksModule.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_useCDCHits

bool m_useCDCHits

private

Boolean to select if CDCHits should be used.

Definition at line 93 of file TrackFinderMCTruthRecoTracksModule.h.

m_useCDCLayers

std::array<bool, 56> m_useCDCLayers {}

private

Bits for the used layers ATTENTION: hardcoded value for number of layers.

Definition at line 152 of file TrackFinderMCTruthRecoTracksModule.h.

m_useCDCSuperLayers

std::array<bool, 9> m_useCDCSuperLayers {}

private

Bits for the used super layers ATTENTION: hardcoded value for number of super layers.

Definition at line 150 of file TrackFinderMCTruthRecoTracksModule.h.

m_useNLoops

float m_useNLoops

private

Number of loops to include in the MC tracks.

Definition at line 96 of file TrackFinderMCTruthRecoTracksModule.h.

m_useOnlyAxialCDCHits

bool m_useOnlyAxialCDCHits

private

Boolean to select if only axial CDCHits should be used.

Definition at line 94 of file TrackFinderMCTruthRecoTracksModule.h.

m_useOnlyBeforeTOP

bool m_useOnlyBeforeTOP

private

Boolean to select if hits after TOP detector are discarded.

Definition at line 95 of file TrackFinderMCTruthRecoTracksModule.h.

m_usePXDHits

bool m_usePXDHits

private

Boolean to select if PXDHits should be used.

Definition at line 91 of file TrackFinderMCTruthRecoTracksModule.h.

m_useReassignedHits

bool m_useReassignedHits

private

Boolean to select the inclusion of hits form discarded secondary daughters.

Definition at line 97 of file TrackFinderMCTruthRecoTracksModule.h.

m_useSecondCDCHits

bool m_useSecondCDCHits

private

Also includes the CDC 2nd hit information in the mc tracks.

Definition at line 98 of file TrackFinderMCTruthRecoTracksModule.h.

m_useSVDHits

bool m_useSVDHits

private

Boolean to select if SVDHits should be used.

Definition at line 92 of file TrackFinderMCTruthRecoTracksModule.h.

m_whichParticles

std::vector<std::string> m_whichParticles

private

List of keywords to mark what properties particles must have to get a track candidate .

Definition at line 102 of file TrackFinderMCTruthRecoTracksModule.h.

---

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

• tracking/modules/trackFinderMCTruth/include/TrackFinderMCTruthRecoTracksModule.h
• tracking/modules/trackFinderMCTruth/src/TrackFinderMCTruthRecoTracksModule.cc