The IMuonTrackTruthTool is a pure virtual interface for tools that recover hole on a track. More...

#include <IMuonTrackTruthTool.h>

Inheritance diagram for Muon::IMuonTrackTruthTool:

Collaboration diagram for Muon::IMuonTrackTruthTool:

Classes
struct	TruthTreeEntry

Public Types
typedef std::pair< const Trk::Track *, MuonTrackTruth >	MatchResult

typedef std::vector< MatchResult >	ResultVec

typedef std::pair< const Muon::MuonSegment *, MuonTrackTruth >	SegmentMatchResult

typedef std::vector< SegmentMatchResult >	SegmentResultVec

typedef std::map< int, TruthTreeEntry >	TruthTree

typedef TruthTree::iterator	TruthTreeIt

typedef TruthTree::const_iterator	TruthTreeConstIt

Public Member Functions
virtual ResultVec	match (const TruthTree &truth_tree, const TrackCollection &tracks) const =0
	perform truth matching for a given set of tracks More...

virtual SegmentResultVec	match (const TruthTree &truth_tree, const std::vector< const MuonSegment * > &segments) const =0
	perform truth matching for a given set of segments More...

virtual const TruthTree	createTruthTree (const TrackRecordCollection truthTrackCol, const McEventCollection mcEventCollection, const std::vector< const MuonSimDataCollection * > &muonSimData, const CscSimDataCollection *cscSimDataMap) const =0
	create truth tree from sim data More...

virtual MuonTrackTruth	getTruth (const TruthTree &truth_tree, const Trk::Track &track, bool restrictedTruth=false) const =0
	get track truth More...

virtual MuonTrackTruth	getTruth (const TruthTree &truth_tree, const std::vector< const MuonSegment * > &segments, bool restrictedTruth=false) const =0
	get segment truth for a list of segments, the segments will be considered to belong to the same muon More...

virtual MuonTrackTruth	getTruth (const TruthTree &truth_tree, const Muon::MuonSegment &segment) const =0
	get segment truth More...

virtual MuonTrackTruth	getTruth (const TruthTree &truth_tree, const std::vector< const Trk::MeasurementBase * > &measurements, bool restrictedTruth=false) const =0
	get truth for a give set of hits. More...

virtual HepMC::ConstGenParticlePtr	getMother (const TruthTrajectory &traj, const int barcodeIn) const =0
	returns the mother particle of the particle with barcodeIn if it is found in the truth trajectory It traces the decay chain until if finds the first particle that is different flavor from the starting one. More...

virtual HepMC::ConstGenParticlePtr	getAncestor (const TruthTrajectory &traj, const int barcodeIn) const =0
	Returns the ancestor particle of the particle with barcodeIn if it is found in the truth trajectory. More...

virtual HepMC::ConstGenParticlePtr	getInitial (const TruthTrajectory &traj, const int barcodeIn) const =0
	Returns the initial particle of the particle with barcodeIn if it is found in the truth trajectory. More...

virtual unsigned int	getNumberOfScatters (const TruthTrajectory &traj, const int barcodeIn) const =0
	Returns the number of steps a particle took while maintaining its PDG ID. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	access to tool interface More...

Detailed Description

The IMuonTrackTruthTool is a pure virtual interface for tools that recover hole on a track.

Definition at line 73 of file IMuonTrackTruthTool.h.

Member Typedef Documentation

◆ MatchResult

typedef std::pair<const Trk::Track*, MuonTrackTruth> Muon::IMuonTrackTruthTool::MatchResult

Definition at line 86 of file IMuonTrackTruthTool.h.

◆ ResultVec

typedef std::vector<MatchResult> Muon::IMuonTrackTruthTool::ResultVec

Definition at line 87 of file IMuonTrackTruthTool.h.

◆ SegmentMatchResult

typedef std::pair<const Muon::MuonSegment*, MuonTrackTruth> Muon::IMuonTrackTruthTool::SegmentMatchResult

Definition at line 89 of file IMuonTrackTruthTool.h.

◆ SegmentResultVec

typedef std::vector<SegmentMatchResult> Muon::IMuonTrackTruthTool::SegmentResultVec

Definition at line 90 of file IMuonTrackTruthTool.h.

◆ TruthTree

typedef std::map<int, TruthTreeEntry> Muon::IMuonTrackTruthTool::TruthTree

Definition at line 93 of file IMuonTrackTruthTool.h.

◆ TruthTreeConstIt

typedef TruthTree::const_iterator Muon::IMuonTrackTruthTool::TruthTreeConstIt

Definition at line 95 of file IMuonTrackTruthTool.h.

◆ TruthTreeIt

typedef TruthTree::iterator Muon::IMuonTrackTruthTool::TruthTreeIt

Definition at line 94 of file IMuonTrackTruthTool.h.

Member Function Documentation

◆ createTruthTree()

virtual const TruthTree Muon::IMuonTrackTruthTool::createTruthTree	(	const TrackRecordCollection *	truthTrackCol,
		const McEventCollection *	mcEventCollection,
		const std::vector< const MuonSimDataCollection * > &	muonSimData,
		const CscSimDataCollection *	cscSimDataMap
	)		const

pure virtual

create truth tree from sim data

Implemented in Muon::MuonTrackTruthTool.

◆ getAncestor()

virtual HepMC::ConstGenParticlePtr Muon::IMuonTrackTruthTool::getAncestor	(	const TruthTrajectory &	traj,
		const int	barcodeIn
	)		const

pure virtual

Returns the ancestor particle of the particle with barcodeIn if it is found in the truth trajectory.

Ancestor here means the last particle at generator level that has a status code different from final state, e.g. Z

Implemented in Muon::MuonTrackTruthTool.

◆ getInitial()

virtual HepMC::ConstGenParticlePtr Muon::IMuonTrackTruthTool::getInitial	(	const TruthTrajectory &	traj,
		const int	barcodeIn
	)		const

pure virtual

Returns the initial particle of the particle with barcodeIn if it is found in the truth trajectory.

For example a mu undergoing a mubrem would create a second mu, in which case this method returns the mu prior to bremsstrahlung.

Implemented in Muon::MuonTrackTruthTool.

◆ getMother()

virtual HepMC::ConstGenParticlePtr Muon::IMuonTrackTruthTool::getMother	(	const TruthTrajectory &	traj,
		const int	barcodeIn
	)		const

pure virtual

returns the mother particle of the particle with barcodeIn if it is found in the truth trajectory It traces the decay chain until if finds the first particle that is different flavor from the starting one.

Implemented in Muon::MuonTrackTruthTool.

◆ getNumberOfScatters()

virtual unsigned int Muon::IMuonTrackTruthTool::getNumberOfScatters	(	const TruthTrajectory &	traj,
		const int	barcodeIn
	)		const

pure virtual

Returns the number of steps a particle took while maintaining its PDG ID.

Implemented in Muon::MuonTrackTruthTool.

◆ getTruth() [1/4]

virtual MuonTrackTruth Muon::IMuonTrackTruthTool::getTruth	(	const TruthTree &	truth_tree,
		const Muon::MuonSegment &	segment
	)		const

pure virtual

get segment truth

Implemented in Muon::MuonTrackTruthTool.

◆ getTruth() [2/4]

virtual MuonTrackTruth Muon::IMuonTrackTruthTool::getTruth	(	const TruthTree &	truth_tree,
		const std::vector< const MuonSegment * > &	segments,
		bool	restrictedTruth = `false`
	)		const

pure virtual

get segment truth for a list of segments, the segments will be considered to belong to the same muon

Implemented in Muon::MuonTrackTruthTool.

◆ getTruth() [3/4]

virtual MuonTrackTruth Muon::IMuonTrackTruthTool::getTruth	(	const TruthTree &	truth_tree,
		const std::vector< const Trk::MeasurementBase * > &	measurements,
		bool	restrictedTruth = `false`
	)		const

pure virtual

get truth for a give set of hits.

If restrictedTruth is set to true only missed hits in chambers with hits will be counted.

Implemented in Muon::MuonTrackTruthTool.

◆ getTruth() [4/4]

virtual MuonTrackTruth Muon::IMuonTrackTruthTool::getTruth	(	const TruthTree &	truth_tree,
		const Trk::Track &	track,
		bool	restrictedTruth = `false`
	)		const

pure virtual

get track truth

Implemented in Muon::MuonTrackTruthTool.

◆ interfaceID()

const InterfaceID & Muon::IMuonTrackTruthTool::interfaceID ( )

inlinestatic

access to tool interface

Definition at line 144 of file IMuonTrackTruthTool.h.

144 { return IID_IMuonTrackTruthTool; }

◆ match() [1/2]

virtual SegmentResultVec Muon::IMuonTrackTruthTool::match	(	const TruthTree &	truth_tree,
		const std::vector< const MuonSegment * > &	segments
	)		const

pure virtual

perform truth matching for a given set of segments

Implemented in Muon::MuonTrackTruthTool.

◆ match() [2/2]

virtual ResultVec Muon::IMuonTrackTruthTool::match	(	const TruthTree &	truth_tree,
		const TrackCollection &	tracks
	)		const

pure virtual

perform truth matching for a given set of tracks

Implemented in Muon::MuonTrackTruthTool.

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

IMuonTrackTruthTool.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ MatchResult

◆ ResultVec

◆ SegmentMatchResult

◆ SegmentResultVec

◆ TruthTree

◆ TruthTreeConstIt

◆ TruthTreeIt

Member Function Documentation

◆ createTruthTree()

◆ getAncestor()

◆ getInitial()

◆ getMother()

◆ getNumberOfScatters()

◆ getTruth() [1/4]

◆ getTruth() [2/4]

◆ getTruth() [3/4]

◆ getTruth() [4/4]

◆ interfaceID()

◆ match() [1/2]

◆ match() [2/2]