#include <TruthParticle.h>

Inheritance diagram for TruthParticle:

Collaboration diagram for TruthParticle:

Public Types
typedef ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >	TruthParticleImpl_t

typedef std::size_t	evtIndex_t

typedef TruthParticleNavigation	navigable_type
	publish the type of the base class (ie: 'traits-itize' it) More...

typedef TruthParticleMomentum	momentum_type
	publish the type of the base class (ie: 'traits-itize' it) More...

typedef TruthParticleBase	particle_type
	publish the type of the base class (ie: 'traits-itize' it) More...

typedef ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >	self_type
	publish the type of the base class (ie: 'traits-itize' it) More...

enum	Kind { P4EETAPHIM, P4IPTCOTTHPHIM, P4PTETAPHIM, P4PXPYPZE, UNKNOWN }

Public Member Functions
	TruthParticle ()
	Default constructor. More...

	TruthParticle (const TruthParticle &rhs)
	Copy constructor. More...

	TruthParticle (HepMC::ConstGenParticlePtr genParticle, const TruthParticleContainer *container=0)
	Constructor with parameters: construct a `TruthParticle` from a `HepMC::GenParticle` and the `TruthParticleContainer` holding this `TruthParticle`. More...

TruthParticle &	operator= (const TruthParticle &rhs)
	Assignment operator. More...

	~TruthParticle ()
	Default constructor: More...

HepMC::ConstGenParticlePtr	genMother (const std::size_t i=0) const
	Retrieve the GenParticle mother of this TruthParticle. More...

HepMC::ConstGenParticlePtr	genParticle () const
	Retrieve the GenParticle this TruthParticle has been made from (if any) More...

HepMC::ConstGenParticlePtr	genChild (const std::size_t i) const
	Retrieve the i-th child (GenParticle) of this TruthParticle. More...

const TruthParticle *	mother (const std::size_t i=0) const
	Retrieve the i-th mother (TruthParticle) of this TruthParticle. More...

const TruthParticle *	child (const std::size_t i) const
	Retrieve the i-th child (TruthParticle) of this TruthParticle. More...

bool	hasMother (const int pdgId) const
	Return true if the given PDG::id to match can be found within the parents of this TruthParticle. More...

bool	hasChild (const int pdgId) const
	Return true if the given PDG::id to match can be found within the children of this TruthParticle. More...

bool	hasMother (const int pdgId, std::vector< unsigned int > &indices) const
	Return true if the given PDG::id to match can be found within the parents of this TruthParticle. More...

bool	hasChild (const int pdgId, std::vector< unsigned int > &indices) const
	Return true if the given PDG::id to match can be found within the children of this TruthParticle. More...

bool	hasEtIsol () const
	Return true if one has filled the Et isolation infos for this `TruthParticle`. More...

double	etIsol (const TruthParticleParameters::ConeSize coneIdx) const
	Return the transverse energy in a given cone size of isolation. More...

const TruthEtIsolations::EtIsol_t *	etIsol () const
	Return the transverse energies for all the isolation cones. More...

unsigned int	nParents () const
	Number of parents of this particle. More...

unsigned int	nDecay () const
	Number of children of this particle. More...

CLHEP::HepLorentzVector	transformVector (const HepMC::FourVector &) const
	returns a Pointer to a CLHEP::LorentzVector from a HepMC::FourVector More...

CLHEP::HepLorentzVector	pDecay (const std::size_t i) const
	Return the 4-vec of i-th child of this particle. More...

int	pdgDecay (const std::size_t i) const
	Return the PDG-Id of the i-th child of this particle. More...

	operator const HepMC::GenParticle & () const
	conversion operator: convert a `TruthParticle` to its underlying `HepMC::GenParticle` More...

evtIndex_t	genEventIndex () const

void	setCharge (const ChargeType charge)
	Set the charge of this TruthParticle. More...

void	set4Mom (const HepMC::FourVector &hlv)

void	setGenEventIndex (size_t index)
	set the GenEvent index More...

const navigable_type &	navigableBase () const
	access to underlying base type (INavigable-like) More...

navigable_type &	navigableBase ()
	access to underlying base type (INavigable-like) More...

const momentum_type &	momentumBase () const
	access to underlying base type (I4Momentum-like) More...

momentum_type &	momentumBase ()
	access to underlying base type (I4Momentum-like) More...

const particle_type &	particleBase () const
	access to underlying base type (IParticle-like) More...

particle_type &	particleBase ()
	access to underlying base type (IParticle-like) More...

virtual AthenaBarCode_t	getAthenaBarCode () const

virtual AthenaBarCodeVersion_t	getVersion () const

virtual double	px () const =0
	x component of momentum More...

virtual double	py () const =0
	y component of momentum More...

virtual double	pz () const =0
	z component of momentum More...

virtual double	m () const =0
	mass More...

virtual double	m2 () const =0
	mass squared More...

virtual double	p () const =0
	momentum magnitude More...

virtual double	p2 () const =0
	square of momentum magnitude More...

virtual double	rapidity () const =0
	rapidity More...

virtual double	eta () const =0
	pseudo rapidity More...

virtual double	phi () const =0
	phi in [-pi,pi[ More...

virtual double	e () const =0
	energy More...

virtual double	et () const =0
	transverse energy defined to be e*sin(theta) More...

virtual double	pt () const =0
	transverse momentum More...

virtual double	iPt () const =0
	inverse of transverse momentum More...

virtual double	cosPhi () const =0
	cosinus phi More...

virtual double	sinPhi () const =0
	sinus phi More...

virtual double	tanTh () const =0
	tan theta More...

virtual double	cosTh () const =0
	cosinus theta More...

virtual double	sinTh () const =0
	sinus theta More...

virtual double	cotTh () const =0
	cottan theta More...

virtual CLHEP::HepLorentzVector	hlv () const =0
	CLHEP HepLorentzVector. More...

virtual const I4MomentumError *	errors () const =0
	Access to errors, if available; returns 0 if no errors. More...

virtual Kind	kind () const =0
	tells what kind of P4XYZT this is More...

virtual ParticleDataType::DataType	dataType () const =0
	Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4} More...

virtual const Trk::RecVertex *	origin () const =0
	Return a RecVertex corresponding to particle Origin More...

virtual const ElementLink< VxContainer > &	originLink () const =0
	Return an ElementLink corresponding to particle's Origin. More...

virtual bool	hasCharge () const =0
	method to check if charge information is available More...

virtual ChargeType	charge () const =0
	returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface More...

virtual bool	hasPdgId () const =0
	method to check if particle id information is available More...

virtual int	pdgId () const =0
	Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h More...

virtual void	set4Mom (const I4Momentum &p4)
	set 4Momentum (will throw exception if cannot be implemented) More...

virtual void	set4Mom (const I4Momentum *const p4)
	set 4Momentum (will throw exception if cannot be implemented) More...

virtual void	set4Mom (const CLHEP::HepLorentzVector &hlv)
	set 4Momentum (will throw exception if cannot be implemented) More...

virtual void	set_dataType (ParticleDataType::DataType x)

virtual void	set_charge (ChargeType x)

virtual void	set_pdgId (int x)

virtual void	set_origin (const VxContainer *theContainer, int index)

virtual void	set_origin (const VxContainer theContainer, const Trk::VxCandidate vertex)

void	set_origin (const ElementLink< VxContainer > &origin)


virtual void	fillToken (INavigationToken &thisToken) const

virtual void	fillToken (INavigationToken &thisToken, const std::any &weight) const


AthenaBarCode_t	getAthenaBarCode () const

void	setAthenaBarCode (AthenaBarCode_t)

bool	hasSameAthenaBarCode (const IAthenaBarCode &) const

bool	hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &) const

AthenaBarCodeVersion_t	getVersion () const

void	newVersion ()

void	setVersion (AthenaBarCodeVersion_t newversion)


virtual double	px () const
	x component of momentum More...

virtual double	py () const
	y component of momentum More...

virtual double	pz () const
	z component of momentum More...

virtual double	m () const
	mass More...

virtual double	m2 () const
	mass squared More...

virtual double	p () const
	mass momentum magnitude More...

virtual double	p2 () const
	square of momentum magnitude More...

virtual double	rapidity () const
	rapidity More...

virtual double	eta () const
	pseudo rapidity More...

virtual double	phi () const
	phi in [-pi,pi[ More...

virtual double	e () const
	energy More...

virtual double	et () const
	transverse energy defined to be e*sin(theta) More...

virtual double	pt () const
	transverse momentum More...

virtual double	iPt () const
	inverse of transverse momentum More...

virtual double	cosPhi () const
	cosinus phi More...

virtual double	sinPhi () const
	sinus phi More...

virtual double	tanTh () const
	tan theta More...

virtual double	cosTh () const
	cosinus theta More...

virtual double	sinTh () const
	sinus theta More...

virtual double	cotTh () const
	cottan theta More...

virtual CLHEP::HepLorentzVector	hlv () const
	CLHEP HepLorentzVector. More...

virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors. More...

virtual I4Momentum::Kind	kind () const
	add Kind which tells what kind (P4XYZ) the underlying implementation has More...

virtual std::ostream &	dump (std::ostream &out) const
	Print `I4Momentum` content. More...

virtual ParticleDataType::DataType	dataType () const
	Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4} More...

virtual const Trk::RecVertex *	origin () const
	Return a RecVertex corresponding to particle Origin More...

virtual const ElementLink< VxContainer > &	originLink () const
	Return an ElementLink corresponding to particle's Origin. More...

virtual bool	hasCharge () const
	method to check if charge information is available More...

virtual ChargeType	charge () const
	returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface More...

virtual bool	hasPdgId () const
	method to check if particle id information is available More...

virtual int	pdgId () const
	Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h More...


int	status () const
	Forwards the HepMC::GenParticle::status() information. More...

const HepMC::Flow	flow () const
	Forwards the HepMC::GenParticle::flow() information. More...

int	flow (int code_index) const
	Forwards the HepMC::GenParticle::flow(idx) information. More...

const HepMC::Polarization	polarization () const
	Forwards the HepMC::GenParticle::polarization() information. More...

int	barcode () const
	Forwards the HepMC::GenParticle::barcode() information. More...

long	compressedExtBarCode () const
	Forwards the HepMC::GenParticle::barcode() information. More...


virtual void	fillToken (INavigationToken &thisToken) const

virtual void	fillToken (INavigationToken &thisToken, const std::any &weight) const


AthenaBarCode_t	getAthenaBarCode () const

void	setAthenaBarCode (AthenaBarCode_t)

bool	hasSameAthenaBarCode (const IAthenaBarCode &) const

bool	hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &) const

AthenaBarCodeVersion_t	getVersion () const

void	newVersion ()

void	setVersion (AthenaBarCodeVersion_t newversion)


virtual double	px () const
	x component of momentum More...

virtual double	py () const
	y component of momentum More...

virtual double	pz () const
	z component of momentum More...

virtual double	m () const
	mass More...

virtual double	m2 () const
	mass squared More...

virtual double	p () const
	mass momentum magnitude More...

virtual double	p2 () const
	square of momentum magnitude More...

virtual double	rapidity () const
	rapidity More...

virtual double	eta () const
	pseudo rapidity More...

virtual double	phi () const
	phi in [-pi,pi[ More...

virtual double	e () const
	energy More...

virtual double	et () const
	transverse energy defined to be e*sin(theta) More...

virtual double	pt () const
	transverse momentum More...

virtual double	iPt () const
	inverse of transverse momentum More...

virtual double	cosPhi () const
	cosinus phi More...

virtual double	sinPhi () const
	sinus phi More...

virtual double	tanTh () const
	tan theta More...

virtual double	cosTh () const
	cosinus theta More...

virtual double	sinTh () const
	sinus theta More...

virtual double	cotTh () const
	cottan theta More...

virtual CLHEP::HepLorentzVector	hlv () const
	CLHEP HepLorentzVector. More...

virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors. More...

virtual I4Momentum::Kind	kind () const
	add Kind which tells what kind (P4XYZ) the underlying implementation has More...

virtual std::ostream &	dump (std::ostream &out) const
	Print `I4Momentum` content. More...

virtual ParticleDataType::DataType	dataType () const
	Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4} More...

virtual const Trk::RecVertex *	origin () const
	Return a RecVertex corresponding to particle Origin More...

virtual const ElementLink< VxContainer > &	originLink () const
	Return an ElementLink corresponding to particle's Origin. More...

virtual bool	hasCharge () const
	method to check if charge information is available More...

virtual ChargeType	charge () const
	returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface More...

virtual bool	hasPdgId () const
	method to check if particle id information is available More...

virtual int	pdgId () const
	Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h More...

Static Public Attributes
static const AthenaBarCode_t	UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)

static const AthenaBarCode_t	UNDEFINEDVERSION = UNDEFINEDBARCODE

Protected Member Functions
void	setGenParticle (HepMC::ConstGenParticlePtr particle)
	Fill the data members of ParticleBase from the GenParticle. More...

Protected Attributes
const TruthParticleContainer *	m_container
	Pointer to the collection holding ourself. More...

std::vector< int >	m_mothers
	vector of barcodes of all the mothers of this particle. More...

std::vector< int >	m_children
	vector of barcodes of all the children of this particle. More...

evtIndex_t	m_nGenEventIdx
	the index of the GenEvent this particle is in More...

Private Attributes
TruthParticleNavigation	m_nav
	The navigable part. More...

TruthParticleMomentum	m_mom
	The 4-momentum part. More...

TruthParticleBase	m_part
	The particle-id part. More...

Detailed Description

(HepMC) Monte Carlo particle.

Adds isolation information. Adapts the HepMC::GenParticle to the IParticle interface.

Definition at line 53 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

Member Typedef Documentation

◆ evtIndex_t

typedef std::size_t TruthParticle::evtIndex_t

Definition at line 71 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

◆ momentum_type

typedef TruthParticleMomentum ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::momentum_type

inherited

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 52 of file ParticleImpl.h.

◆ navigable_type

typedef TruthParticleNavigation ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::navigable_type

inherited

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 48 of file ParticleImpl.h.

◆ particle_type

typedef TruthParticleBase ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::particle_type

inherited

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 56 of file ParticleImpl.h.

◆ self_type

typedef ParticleImpl<TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase > ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::self_type

inherited

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 62 of file ParticleImpl.h.

◆ TruthParticleImpl_t

typedef ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase > TruthParticle::TruthParticleImpl_t

Definition at line 69 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

Member Enumeration Documentation

◆ Kind

enum I4Momentum::Kind

inherited

Enumerator
P4EETAPHIM
P4IPTCOTTHPHIM
P4PTETAPHIM
P4PXPYPZE
UNKNOWN

Definition at line 33 of file I4Momentum.h.

33 { P4EETAPHIM, P4IPTCOTTHPHIM, P4PTETAPHIM, P4PXPYPZE, UNKNOWN };

Constructor & Destructor Documentation

◆ TruthParticle() [1/3]

TruthParticle::TruthParticle ( )

Default constructor.

Definition at line 33 of file TruthParticle.cxx.

                              :
   INavigable          ( ),
   I4Momentum          ( ),
   INavigable4Momentum ( ),
   TruthParticleImpl_t ( ),
   m_container    ( 0 ),
   m_mothers      ( 0 ),
   m_children     ( 0 ),
   m_nGenEventIdx ( 0 )
 {}

◆ TruthParticle() [2/3]

TruthParticle::TruthParticle ( const TruthParticle & rhs )

Copy constructor.

Definition at line 44 of file TruthParticle.cxx.

                                                        :
   IAthenaBarCode      ( rhs ),
   INavigable          ( rhs ),
   I4Momentum          ( rhs ),
   INavigable4Momentum ( rhs ),
   TruthParticleImpl_t ( rhs ),
   m_container      ( rhs.m_container ),
   m_mothers        ( rhs.m_mothers ),
   m_children       ( rhs.m_children ),
   m_nGenEventIdx   ( rhs.m_nGenEventIdx )
 {}

◆ TruthParticle() [3/3]

TruthParticle::TruthParticle	(	HepMC::ConstGenParticlePtr	genParticle,
		const TruthParticleContainer *	container = `0`
	)

Constructor with parameters: construct a TruthParticle from a HepMC::GenParticle and the TruthParticleContainer holding this TruthParticle.

Definition at line 56 of file TruthParticle.cxx.

                                                                          :
   INavigable          ( ),
   I4Momentum          ( ),
   INavigable4Momentum ( ),
   TruthParticleImpl_t ( ),
   m_container      ( container ),
   m_mothers        ( 0 ),
   m_children       ( 0 ),
   m_nGenEventIdx   ( 0 )
 {
   setGenParticle( particle );
   m_nGenEventIdx = container ? container->genEventIdx() : 0;
 }

◆ ~TruthParticle()

TruthParticle::~TruthParticle ( )

inline

Default constructor:

Definition at line 276 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

277 {}

Member Function Documentation

◆ barcode()

int TruthParticle::barcode ( ) const

inline

Forwards the HepMC::GenParticle::barcode() information.

Definition at line 304 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return HepMC::barcode(genParticle());
 }

◆ charge() [1/2]

ChargeType ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::charge

inlinevirtualinherited

returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface

Definition at line 248 of file ParticleImpl.h.

 {
   return m_part.charge();
 }

◆ charge() [2/2]

virtual ChargeType IParticle::charge ( ) const

pure virtualinherited

returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ child()

const TruthParticle * TruthParticle::child ( const std::size_t i ) const

Retrieve the i-th child (TruthParticle) of this TruthParticle.

Definition at line 98 of file TruthParticle.cxx.

 {
   if ( m_children.empty()     || 
        i >= m_children.size() ||
        nullptr == m_container       ) return nullptr;
   return m_container->truthParticle(m_children[i], m_nGenEventIdx);
 }

◆ compressedExtBarCode()

long TruthParticle::compressedExtBarCode ( ) const

inline

Forwards the HepMC::GenParticle::barcode() information.

Definition at line 138 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

138 { return 0; };

◆ cosPhi() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::cosPhi

inlinevirtualinherited

cosinus phi

Definition at line 188 of file ParticleImpl.h.

 {
   return m_mom.cosPhi();
 }

◆ cosPhi() [2/2]

virtual double I4Momentum::cosPhi ( ) const

pure virtualinherited

cosinus phi

Implemented in CaloCell, CaloVertexedCell, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ cosTh() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::cosTh

inlinevirtualinherited

cosinus theta

Definition at line 200 of file ParticleImpl.h.

 {
   return m_mom.cosTh();
 }

◆ cosTh() [2/2]

virtual double I4Momentum::cosTh ( ) const

pure virtualinherited

cosinus theta

Implemented in CaloCell, CaloVertexedCell, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ cotTh() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::cotTh

inlinevirtualinherited

cottan theta

Definition at line 208 of file ParticleImpl.h.

 {
   return m_mom.cotTh();
 }

◆ cotTh() [2/2]

virtual double I4Momentum::cotTh ( ) const

pure virtualinherited

cottan theta

Implemented in CaloCell, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiM, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ dataType() [1/2]

ParticleDataType::DataType ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::dataType

inlinevirtualinherited

Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4}

IParticle interface forwarding

Definition at line 230 of file ParticleImpl.h.

 {
   return m_part.dataType();
 }

◆ dataType() [2/2]

virtual ParticleDataType::DataType IParticle::dataType ( ) const

pure virtualinherited

Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4}

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ dump()

std::ostream & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::dump ( std::ostream & out ) const

inlinevirtualinherited

Print I4Momentum content.

Implements I4Momentum.

Definition at line 221 of file ParticleImpl.h.

 {
   m_mom.dump ( out );
   out << "\n";
   m_part.dump( out );
   return out;
 }

◆ e() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::e

inlinevirtualinherited

energy

Definition at line 172 of file ParticleImpl.h.

 {
   return m_mom.e();
 }

◆ e() [2/2]

virtual double I4Momentum::e ( ) const

pure virtualinherited

energy

Implemented in CaloTower, CaloCell, CaloVertexedCell, CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4PxPyPzE, TrigT2Jet, P4EEtaPhiM, P4PtEtaPhiMBase, and P4IPtCotThPhiMBase.

◆ errors() [1/2]

const I4MomentumError * ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::errors

inlinevirtualinherited

Access to errors, if available; returns 0 if no errors.

Definition at line 214 of file ParticleImpl.h.

 {
   return m_mom.errors();
 }

◆ errors() [2/2]

virtual const I4MomentumError* I4Momentum::errors ( ) const

pure virtualinherited

Access to errors, if available; returns 0 if no errors.

Implemented in egamma, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4PtEtaPhiM, P4PxPyPzE, P4EEtaPhiM, P4IPtCotThPhiM, P4EEtaPhiMBase, P4PtEtaPhiMBase, P4IPtCotThPhiMBase, and P4PxPyPzEBase.

◆ et() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::et

inlinevirtualinherited

transverse energy defined to be e*sin(theta)

Definition at line 176 of file ParticleImpl.h.

 {
   return m_mom.et();
 }

◆ et() [2/2]

virtual double I4Momentum::et ( ) const

pure virtualinherited

transverse energy defined to be e*sin(theta)

Implemented in CaloCell, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4PtEtaPhiMBase, P4PxPyPzEBase, P4IPtCotThPhiMBase, and P4EEtaPhiMBase.

◆ eta() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::eta

inlinevirtualinherited

pseudo rapidity

Definition at line 164 of file ParticleImpl.h.

 {
   return m_mom.eta();
 }

◆ eta() [2/2]

virtual double I4Momentum::eta ( ) const

pure virtualinherited

◆ etIsol() [1/2]

const TruthEtIsolations::EtIsol_t * TruthParticle::etIsol ( ) const

Return the transverse energies for all the isolation cones.

Definition at line 188 of file TruthParticle.cxx.

 {
   return m_container->etIsolations( barcode() );
 }

◆ etIsol() [2/2]

double TruthParticle::etIsol ( const TruthParticleParameters::ConeSize coneIdx ) const

Return the transverse energy in a given cone size of isolation.

Note that the size of the code must be one of the encoded sizes (see TruthParticleParamDefs.h file) and that the index is checked for out of bounds.

Definition at line 194 of file TruthParticle.cxx.

 { 
   if ( coneIdx >= 0 && // just to be sure... as it is a signed integer...
        coneIdx < TruthParticleParameters::NbrOfCones ) {
     return m_container->etIsol( barcode(), coneIdx );
   } else {
     std::string error = "WRONG index for TruthParticle::etIsol(coneIdx)";
     throw std::out_of_range(error);
   }
 }

◆ fillToken() [1/2]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::fillToken ( INavigationToken & thisToken ) const

inlinevirtualinherited

INavigable interface forwarding

Implements INavigable.

Definition at line 104 of file ParticleImpl.h.

 {
   m_nav.fillToken( thisToken );
 }

◆ fillToken() [2/2]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::fillToken	(	INavigationToken &	thisToken,
		const std::any &	weight
	)		const

inlinevirtualinherited

Implements INavigable.

Definition at line 106 of file ParticleImpl.h.

 {
   m_nav.fillToken( thisToken, weight );
 }

◆ flow() [1/2]

const HepMC::Flow TruthParticle::flow ( ) const

inline

Forwards the HepMC::GenParticle::flow() information.

Definition at line 289 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return HepMC::flow(genParticle());
 }

◆ flow() [2/2]

int TruthParticle::flow ( int code_index ) const

inline

Forwards the HepMC::GenParticle::flow(idx) information.

Definition at line 294 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return HepMC::flow(genParticle(),code_index);
 }

◆ genChild()

HepMC::ConstGenParticlePtr TruthParticle::genChild ( const std::size_t i ) const

Retrieve the i-th child (GenParticle) of this TruthParticle.

Definition at line 118 of file TruthParticle.cxx.

 {
   if ( i < m_children.size() ) {
     auto child = this->child(i);
     return child ? child->genParticle() : nullptr;
   } else {
     std::string error = "WRONG index for TruthParticle::genChild(index)";
     throw std::out_of_range(error);
   }
 }

◆ genEventIndex()

evtIndex_t TruthParticle::genEventIndex ( ) const

inline

Definition at line 211 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

211 {return m_nGenEventIdx;}

◆ genMother()

HepMC::ConstGenParticlePtr TruthParticle::genMother ( const std::size_t i = 0 ) const

Retrieve the GenParticle mother of this TruthParticle.

Definition at line 107 of file TruthParticle.cxx.

 {
   if ( i < m_mothers.size() ) {
     auto mother = this->mother(i);
     return mother ? mother->genParticle() : nullptr;
   } else {
     std::string error = "WRONG index for TruthParticle::genMother(index)";
     throw std::out_of_range(error);
   }
 }

◆ genParticle()

HepMC::ConstGenParticlePtr TruthParticle::genParticle ( ) const

inline

Retrieve the GenParticle this TruthParticle has been made from (if any)

Definition at line 279 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return this->particleBase().genParticle();
 }

◆ getAthenaBarCode() [1/2]

virtual AthenaBarCode_t IAthenaBarCode::getAthenaBarCode ( ) const

inlinevirtualinherited

Reimplemented in Rec::TrackParticle, Analysis::ParticleShallowClone, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, and AthenaBarCodeBase.

Definition at line 67 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                    {
     return UNDEFINEDBARCODE;
   }

◆ getAthenaBarCode() [2/2]

AthenaBarCode_t ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::getAthenaBarCode

inlineinherited

IAthenaBarCode interface forwarding

Definition at line 114 of file ParticleImpl.h.

 {
   return particleBase().getAthenaBarCodeImpl().getAthenaBarCode();
 }

◆ getVersion() [1/2]

virtual AthenaBarCodeVersion_t IAthenaBarCode::getVersion ( ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, Rec::TrackParticle, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, and AthenaBarCodeBase.

Definition at line 85 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                     {
     return UNDEFINEDVERSION;
   }

◆ getVersion() [2/2]

AthenaBarCodeVersion_t ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::getVersion

inlineinherited

Definition at line 119 of file ParticleImpl.h.

 {
   return particleBase().getAthenaBarCodeImpl().getVersion();
 }

◆ hasCharge() [1/2]

bool ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::hasCharge

inlinevirtualinherited

method to check if charge information is available

Definition at line 242 of file ParticleImpl.h.

 {
   return m_part.hasCharge();
 }

◆ hasCharge() [2/2]

virtual bool IParticle::hasCharge ( ) const

pure virtualinherited

method to check if charge information is available

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ hasChild() [1/2]

bool TruthParticle::hasChild ( const int pdgId ) const

Return true if the given PDG::id to match can be found within the children of this TruthParticle.

Definition at line 141 of file TruthParticle.cxx.

 {
   const std::size_t nChildren = m_children.size();
   for ( std::size_t iChild = 0; iChild != nChildren; ++iChild ) {
     auto child = this->child(iChild);
     if ( child && ( pdgId == child->pdgId() ) ) {
       return true;
     }
   }
   return false;
 }

◆ hasChild() [2/2]

bool TruthParticle::hasChild	(	const int	pdgId,
		std::vector< unsigned int > &	indices
	)		const

Return true if the given PDG::id to match can be found within the children of this TruthParticle.

It also fills the given vector with the indices toward the matching particles.

Definition at line 168 of file TruthParticle.cxx.

 {
   bool found = false;
   const std::size_t nChildren = m_children.size();
   for ( std::size_t iChild = 0; iChild != nChildren; ++iChild ) {
     auto child = this->child(iChild);
     if ( child && ( pdgId == child->pdgId() ) ) {
       found = true;
       indices.push_back(iChild);
     }
   }
   return found;
 }

◆ hasEtIsol()

bool TruthParticle::hasEtIsol ( ) const

Return true if one has filled the Et isolation infos for this TruthParticle.

Definition at line 183 of file TruthParticle.cxx.

 {
   return m_container->hasEtIsol( barcode() );
 }

◆ hasMother() [1/2]

bool TruthParticle::hasMother ( const int pdgId ) const

Return true if the given PDG::id to match can be found within the parents of this TruthParticle.

Definition at line 129 of file TruthParticle.cxx.

 {
   const std::size_t nMothers = m_mothers.size();
   for ( std::size_t iMother = 0; iMother != nMothers; ++iMother ) {
     auto mother = this->mother(iMother);
     if ( mother && ( pdgId == mother->pdgId() ) ) {
       return true;
     }
   }
   return false;
 }

◆ hasMother() [2/2]

bool TruthParticle::hasMother	(	const int	pdgId,
		std::vector< unsigned int > &	indices
	)		const

Return true if the given PDG::id to match can be found within the parents of this TruthParticle.

It also fills the given vector with the indices toward the matching particles.

Definition at line 153 of file TruthParticle.cxx.

 {
   bool found = false;
   const std::size_t nMothers = m_mothers.size();
   for ( std::size_t iMother = 0; iMother != nMothers; ++iMother ) {
     auto mother = this->mother(iMother);
     if ( mother && ( pdgId == mother->pdgId() ) ) {
       found = true;
       indices.push_back(iMother);
     }
   }
   return found;
 }

◆ hasPdgId() [1/2]

bool ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::hasPdgId

inlinevirtualinherited

method to check if particle id information is available

Definition at line 252 of file ParticleImpl.h.

 {
   return m_part.hasPdgId();
 }

◆ hasPdgId() [2/2]

virtual bool IParticle::hasPdgId ( ) const

pure virtualinherited

method to check if particle id information is available

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ hasSameAthenaBarCode()

bool ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::hasSameAthenaBarCode ( const IAthenaBarCode & bc ) const

inlinevirtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 117 of file ParticleImpl.h.

 {
   return particleBase().getAthenaBarCodeImpl().hasSameAthenaBarCode(bc);
 }

◆ hasSameAthenaBarCodeExceptVersion()

bool ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::hasSameAthenaBarCodeExceptVersion ( const IAthenaBarCode & bc ) const

inlinevirtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 118 of file ParticleImpl.h.

 {
   return particleBase().getAthenaBarCodeImpl().hasSameAthenaBarCodeExceptVersion(bc);
 }

◆ hlv() [1/2]

CLHEP::HepLorentzVector ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::hlv

inlinevirtualinherited

CLHEP HepLorentzVector.

Definition at line 212 of file ParticleImpl.h.

 {
   return m_mom.hlv();
 }

◆ hlv() [2/2]

virtual CLHEP::HepLorentzVector I4Momentum::hlv ( ) const

pure virtualinherited

CLHEP HepLorentzVector.

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4EEtaPhiMBase, P4PtEtaPhiMBase, P4IPtCotThPhiMBase, and P4PxPyPzEBase.

◆ iPt() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::iPt

inlinevirtualinherited

inverse of transverse momentum

Definition at line 184 of file ParticleImpl.h.

 {
   return m_mom.iPt();
 }

◆ iPt() [2/2]

virtual double I4Momentum::iPt ( ) const

pure virtualinherited

inverse of transverse momentum

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiM, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ kind() [1/2]

I4Momentum::Kind ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::kind

inlinevirtualinherited

add Kind which tells what kind (P4XYZ) the underlying implementation has

Definition at line 217 of file ParticleImpl.h.

 {
   return m_mom.kind();
 }

◆ kind() [2/2]

virtual Kind I4Momentum::kind ( ) const

pure virtualinherited

tells what kind of P4XYZT this is

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4EEtaPhiMBase, P4PtEtaPhiMBase, P4IPtCotThPhiMBase, and P4PxPyPzEBase.

◆ m() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::m

inlinevirtualinherited

mass

Definition at line 144 of file ParticleImpl.h.

 {
   return m_mom.m();
 }

◆ m() [2/2]

virtual double I4Momentum::m ( ) const

pure virtualinherited

◆ m2() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::m2

inlinevirtualinherited

mass squared

Definition at line 148 of file ParticleImpl.h.

 {
   return m_mom.m2();
 }

◆ m2() [2/2]

virtual double I4Momentum::m2 ( ) const

pure virtualinherited

mass squared

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4EEtaPhiMBase, P4IPtCotThPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ momentumBase() [1/2]

TruthParticleMomentum & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::momentumBase

inlineinherited

access to underlying base type (I4Momentum-like)

Definition at line 272 of file ParticleImpl.h.

 {
   return m_mom;
 }

◆ momentumBase() [2/2]

const TruthParticleMomentum & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::momentumBase

inlineinherited

access to underlying base type (I4Momentum-like)

Definition at line 95 of file ParticleImpl.h.

 {
   return m_mom;
 }

◆ mother()

const TruthParticle * TruthParticle::mother ( const std::size_t i = 0 ) const

Retrieve the i-th mother (TruthParticle) of this TruthParticle.

Definition at line 90 of file TruthParticle.cxx.

 {
   if ( m_mothers.empty()     || 
        i >= m_mothers.size() || 
        nullptr == m_container      ) return nullptr;
   return m_container->truthParticle(m_mothers[i], m_nGenEventIdx);
 }

◆ navigableBase() [1/2]

TruthParticleNavigation & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::navigableBase

inlineinherited

access to underlying base type (INavigable-like)

Definition at line 268 of file ParticleImpl.h.

 {
   return m_nav;
 }

◆ navigableBase() [2/2]

const TruthParticleNavigation & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::navigableBase

inlineinherited

access to underlying base type (INavigable-like)

Definition at line 91 of file ParticleImpl.h.

 {
   return m_nav;
 }

◆ nDecay()

unsigned int TruthParticle::nDecay ( ) const

inline

Number of children of this particle.

Definition at line 312 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

313 { return m_children.size(); }

◆ newVersion()

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::newVersion

inlinevirtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 120 of file ParticleImpl.h.

 {
   particleBase().getAthenaBarCodeImpl().newVersion();
 }

◆ nParents()

unsigned int TruthParticle::nParents ( ) const

inline

Number of parents of this particle.

Definition at line 309 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

310 { return m_mothers.size(); }

◆ operator const HepMC::GenParticle &()

TruthParticle::operator const HepMC::GenParticle & ( ) const

inline

conversion operator: convert a TruthParticle to its underlying HepMC::GenParticle

Definition at line 321 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return *genParticle();
 }

◆ operator=()

TruthParticle & TruthParticle::operator= ( const TruthParticle & rhs )

Assignment operator.

Definition at line 71 of file TruthParticle.cxx.

 {
   if ( this != &rhs ) {
     INavigable::operator=(rhs);
     I4Momentum::operator=(rhs);
     INavigable4Momentum::operator=(rhs);
     TruthParticleImpl_t::operator=(rhs);
     m_container = rhs.m_container;
     m_mothers   = rhs.m_mothers;
     m_children  = rhs.m_children;
     m_nGenEventIdx=rhs.m_nGenEventIdx;
   }
   return *this;
 }

◆ origin() [1/2]

const Trk::RecVertex * ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::origin

inlinevirtualinherited

Return a RecVertex corresponding to particle Origin

Definition at line 234 of file ParticleImpl.h.

 {
   return m_part.origin();
 }

◆ origin() [2/2]

virtual const Trk::RecVertex* IParticle::origin ( ) const

pure virtualinherited

Return a RecVertex corresponding to particle Origin

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ originLink() [1/2]

const ElementLink< VxContainer > & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::originLink

inlinevirtualinherited

Return an ElementLink corresponding to particle's Origin.

Definition at line 238 of file ParticleImpl.h.

 {
   return m_part.originLink();
 }

◆ originLink() [2/2]

virtual const ElementLink<VxContainer>& IParticle::originLink ( ) const

pure virtualinherited

Return an ElementLink corresponding to particle's Origin.

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ p() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::p

inlinevirtualinherited

mass momentum magnitude

Definition at line 152 of file ParticleImpl.h.

 {
   return m_mom.p();
 }

◆ p() [2/2]

virtual double I4Momentum::p ( ) const

pure virtualinherited

momentum magnitude

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ p2() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::p2

inlinevirtualinherited

square of momentum magnitude

Definition at line 156 of file ParticleImpl.h.

 {
   return m_mom.p2();
 }

◆ p2() [2/2]

virtual double I4Momentum::p2 ( ) const

pure virtualinherited

square of momentum magnitude

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ particleBase() [1/2]

TruthParticleBase & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::particleBase

inlineinherited

access to underlying base type (IParticle-like)

Definition at line 276 of file ParticleImpl.h.

 {
   return m_part;
 }

◆ particleBase() [2/2]

const TruthParticleBase & ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::particleBase

inlineinherited

access to underlying base type (IParticle-like)

Definition at line 99 of file ParticleImpl.h.

 {
   return m_part;
 }

◆ pDecay()

CLHEP::HepLorentzVector TruthParticle::pDecay ( const std::size_t i ) const

Return the 4-vec of i-th child of this particle.

Definition at line 205 of file TruthParticle.cxx.

 { 
   if ( i < m_children.size() ) {
     auto child = this->child(i);
     if ( child ) {
       return child->hlv(); 
     } else {
       const std::string error = "Caught INVALID pointer to child in TruthParticle::pDecay call!";
       throw std::out_of_range(error);
     }
   } else {
     std::string error = "Caught INVALID pointer to child in TruthParticle::pDecay call!";
     throw std::out_of_range(error);
   }
 }

◆ pdgDecay()

int TruthParticle::pdgDecay ( const std::size_t i ) const

Return the PDG-Id of the i-th child of this particle.

Definition at line 221 of file TruthParticle.cxx.

 { 
   if ( i < m_children.size() ) {
     auto child = this->child(i);
     if ( child ) {
       return child->pdgId(); 
     } else {
       const std::string error = "Caught INVALID pointer to child in TruthParticle::pdgDecay call!";
       throw std::out_of_range(error);
     }
   } else {
     const std::string error = "Caught INVALID pointer to child in TruthParticle::pdgDecay call!";
     throw std::out_of_range(error);
   }
 }

◆ pdgId() [1/2]

int ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::pdgId

inlinevirtualinherited

Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h

Definition at line 257 of file ParticleImpl.h.

 {
   return m_part.pdgId();
 }

◆ pdgId() [2/2]

virtual int IParticle::pdgId ( ) const

pure virtualinherited

Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Analysis::ParticleShallowClone, and ParticleBase.

◆ phi() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::phi

inlinevirtualinherited

phi in [-pi,pi[

Definition at line 168 of file ParticleImpl.h.

 {
   return m_mom.phi();
 }

◆ phi() [2/2]

virtual double I4Momentum::phi ( ) const

pure virtualinherited

◆ polarization()

const HepMC::Polarization TruthParticle::polarization ( ) const

inline

Forwards the HepMC::GenParticle::polarization() information.

Definition at line 299 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return HepMC::polarization(genParticle());
 }

◆ pt() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::pt

inlinevirtualinherited

transverse momentum

Definition at line 180 of file ParticleImpl.h.

 {
   return m_mom.pt();
 }

◆ pt() [2/2]

virtual double I4Momentum::pt ( ) const

pure virtualinherited

transverse momentum

Implemented in TileTrackMuFeature, IsoMuonFeature, CombinedMuonFeature, TrigMuonClusterFeature, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, Muon_ROI, EmTau_ROI, Jet_ROI, P4PtEtaPhiM, P4IPtCotThPhiMBase, P4EEtaPhiMBase, and P4PxPyPzEBase.

◆ px() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::px

inlinevirtualinherited

x component of momentum

I4Momentum interface forwarding

Definition at line 132 of file ParticleImpl.h.

 {
   return m_mom.px();
 }

◆ px() [2/2]

virtual double I4Momentum::px ( ) const

pure virtualinherited

x component of momentum

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4PxPyPzE, P4IPtCotThPhiMBase, P4EEtaPhiMBase, and P4PtEtaPhiMBase.

◆ py() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::py

inlinevirtualinherited

y component of momentum

Definition at line 136 of file ParticleImpl.h.

 {
   return m_mom.py();
 }

◆ py() [2/2]

virtual double I4Momentum::py ( ) const

pure virtualinherited

y component of momentum

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4PxPyPzE, P4IPtCotThPhiMBase, P4EEtaPhiMBase, and P4PtEtaPhiMBase.

◆ pz() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::pz

inlinevirtualinherited

z component of momentum

Definition at line 140 of file ParticleImpl.h.

 {
   return m_mom.pz();
 }

◆ pz() [2/2]

virtual double I4Momentum::pz ( ) const

pure virtualinherited

z component of momentum

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4PxPyPzE, P4IPtCotThPhiMBase, P4EEtaPhiMBase, and P4PtEtaPhiMBase.

◆ rapidity() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::rapidity

inlinevirtualinherited

rapidity

Definition at line 160 of file ParticleImpl.h.

 {
   return m_mom.rapidity();
 }

◆ rapidity() [2/2]

virtual double I4Momentum::rapidity ( ) const

pure virtualinherited

rapidity

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ set4Mom() [1/4]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set4Mom ( const CLHEP::HepLorentzVector & hlv )

inlinevirtualinherited

set 4Momentum (will throw exception if cannot be implemented)

Implements I4Momentum.

Definition at line 285 of file ParticleImpl.h.

 {
   return m_mom.set4Mom( hlv );
 }

◆ set4Mom() [2/4]

void TruthParticle::set4Mom ( const HepMC::FourVector & hlv )

inline

Definition at line 222 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

223 { this->momentumBase().set4Mom(hlv); }

◆ set4Mom() [3/4]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set4Mom ( const I4Momentum & p4 )

inlinevirtualinherited

set 4Momentum (will throw exception if cannot be implemented)

Implements I4Momentum.

Definition at line 281 of file ParticleImpl.h.

 {
   return m_mom.set4Mom( p4 );
 }

◆ set4Mom() [4/4]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set4Mom ( const I4Momentum *const p4 )

inlinevirtualinherited

set 4Momentum (will throw exception if cannot be implemented)

Implements I4Momentum.

Definition at line 283 of file ParticleImpl.h.

 {
   return m_mom.set4Mom( p4 );
 }

◆ set_charge()

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set_charge ( ChargeType x )

inlinevirtualinherited

Definition at line 291 of file ParticleImpl.h.

 {
   m_part.set_charge(x);
 }

◆ set_dataType()

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set_dataType ( ParticleDataType::DataType x )

inlinevirtualinherited

Definition at line 289 of file ParticleImpl.h.

 {
   m_part.set_dataType(x);
 }

◆ set_origin() [1/3]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set_origin ( const ElementLink< VxContainer > & origin )

inlineinherited

Definition at line 299 of file ParticleImpl.h.

 {
   m_part.set_origin(origin);
 }

◆ set_origin() [2/3]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set_origin	(	const VxContainer *	theContainer,
		const Trk::VxCandidate *	vertex
	)

inlinevirtualinherited

Definition at line 297 of file ParticleImpl.h.

 {
   m_part.set_origin(theContainer, vertex);
 }

◆ set_origin() [3/3]

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set_origin	(	const VxContainer *	theContainer,
		int	index
	)

inlinevirtualinherited

Definition at line 295 of file ParticleImpl.h.

 {
   m_part.set_origin(theContainer, index);
 }

◆ set_pdgId()

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::set_pdgId ( int x )

inlinevirtualinherited

Definition at line 293 of file ParticleImpl.h.

 {
   m_part.set_pdgId(x);
 }

◆ setAthenaBarCode()

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::setAthenaBarCode ( AthenaBarCode_t id )

inlinevirtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 115 of file ParticleImpl.h.

 {
   particleBase().getAthenaBarCodeImpl().setAthenaBarCode(id);
 }

◆ setCharge()

void TruthParticle::setCharge ( const ChargeType charge )

inline

Set the charge of this TruthParticle.

Definition at line 327 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   this->particleBase().setCharge( charge );
 }

◆ setGenEventIndex()

void TruthParticle::setGenEventIndex ( size_t index )

inline

set the GenEvent index

Definition at line 338 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

                                                          {
   m_nGenEventIdx = index;
 }

◆ setGenParticle()

void TruthParticle::setGenParticle ( HepMC::ConstGenParticlePtr particle )

protected

Fill the data members of ParticleBase from the GenParticle.

Definition at line 240 of file TruthParticle.cxx.

 {
   this->particleBase().setGenParticle( particle );
  
   if ( particle ) {
     this->set4Mom(particle->momentum());
  
     // children
     auto dcyVtx = particle->end_vertex();
 #ifdef HEPMC3
     m_children.reserve( dcyVtx ? dcyVtx->particles_out().size() : 0 );
  
     if ( dcyVtx ) {
       for ( const auto&  itr: dcyVtx->particles_out()) {
         m_children.push_back( HepMC::barcode(itr) );
       }//> end loop over outgoing particles
     }//> decay vertex exists
  
     // parents
     auto prodVtx = particle->production_vertex();
     m_mothers.reserve( prodVtx ? prodVtx->particles_in().size() : 0 );
     if ( prodVtx ) {
       for (const auto& itr:  prodVtx->particles_in()) {
         m_mothers.push_back( HepMC::barcode(itr) );
       }//> end loop over ingoing particles
     }//> production vertex exists
 #else
  
     m_children.reserve( dcyVtx ? dcyVtx->particles_out_size() : 0 );
  
     if ( dcyVtx ) {
       for ( HepMC::GenVertex::particles_out_const_iterator itr = 
               dcyVtx->particles_out_const_begin();
             itr != dcyVtx->particles_out_const_end();
             ++itr ) {
         m_children.push_back( (*itr)->barcode() );
       }//> end loop over outgoing particles
     }//> decay vertex exists
  
     // parents
     auto prodVtx = particle->production_vertex();
     m_mothers.reserve( prodVtx ? prodVtx->particles_in_size() : 0 );
     if ( prodVtx ) {
       for ( HepMC::GenVertex::particles_in_const_iterator itr = 
               prodVtx->particles_in_const_begin();
             itr != prodVtx->particles_in_const_end();
             ++itr ) {
         m_mothers.push_back( (*itr)->barcode() );
       }//> end loop over ingoing particles
     }//> production vertex exists
  
 #endif
   } else {
     m_mothers.resize( 0 );
     m_children.resize( 0 );
   }
 }

◆ setVersion()

void ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::setVersion ( AthenaBarCodeVersion_t newversion )

inlinevirtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 121 of file ParticleImpl.h.

 {
   particleBase().getAthenaBarCodeImpl().setVersion(newversion);
 }

◆ sinPhi() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::sinPhi

inlinevirtualinherited

sinus phi

Definition at line 192 of file ParticleImpl.h.

 {
   return m_mom.sinPhi();
 }

◆ sinPhi() [2/2]

virtual double I4Momentum::sinPhi ( ) const

pure virtualinherited

sinus phi

Implemented in CaloCell, CaloVertexedCell, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ sinTh() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::sinTh

inlinevirtualinherited

sinus theta

Definition at line 204 of file ParticleImpl.h.

 {
   return m_mom.sinTh();
 }

◆ sinTh() [2/2]

virtual double I4Momentum::sinTh ( ) const

pure virtualinherited

sinus theta

Implemented in CaloCell, CaloVertexedCell, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4IPtCotThPhiMBase, P4EEtaPhiMBase, P4PtEtaPhiMBase, and P4PxPyPzEBase.

◆ status()

int TruthParticle::status ( ) const

inline

Forwards the HepMC::GenParticle::status() information.

HepMC::GenParticle forwarding interface

Definition at line 284 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
   return genParticle()->status();
 }

◆ tanTh() [1/2]

double ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::tanTh

inlinevirtualinherited

tan theta

Definition at line 196 of file ParticleImpl.h.

 {
   return m_mom.tanTh();
 }

◆ tanTh() [2/2]

virtual double I4Momentum::tanTh ( ) const

pure virtualinherited

tan theta

Implemented in ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, Nav4MomWrapper< Navigable_t, P4Momentum_t >, P4Impl< P4Mom_t >, P4EEtaPhiMBase, P4PtEtaPhiMBase, P4IPtCotThPhiMBase, and P4PxPyPzEBase.

◆ transformVector()

CLHEP::HepLorentzVector TruthParticle::transformVector ( const HepMC::FourVector & fv ) const

inline

returns a Pointer to a CLHEP::LorentzVector from a HepMC::FourVector

Definition at line 332 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

 {
     CLHEP::HepLorentzVector hlv(fv.x(),fv.y(),fv.z(),fv.t());
     return hlv;
 }  

Member Data Documentation

◆ m_children

std::vector<int> TruthParticle::m_children

protected

vector of barcodes of all the children of this particle.

This will be forwarded to the container holding ourself to be able to retrieve TruthParticle pointers.

Definition at line 260 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

◆ m_container

const TruthParticleContainer* TruthParticle::m_container

protected

Pointer to the collection holding ourself.

Definition at line 248 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

◆ m_mom

TruthParticleMomentum ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::m_mom

privateinherited

The 4-momentum part.

Definition at line 310 of file ParticleImpl.h.

◆ m_mothers

std::vector<int> TruthParticle::m_mothers

protected

vector of barcodes of all the mothers of this particle.

This will be forwarded to the container holding ourself to be able to retrieve TruthParticle pointers.

Definition at line 254 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

◆ m_nav

TruthParticleNavigation ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::m_nav

privateinherited

The navigable part.

Definition at line 307 of file ParticleImpl.h.

◆ m_nGenEventIdx

evtIndex_t TruthParticle::m_nGenEventIdx

protected

the index of the GenEvent this particle is in

Definition at line 263 of file PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h.

◆ m_part

TruthParticleBase ParticleImpl< TruthParticleNavigation , TruthParticleMomentum , TruthParticleBase >::m_part

privateinherited

The particle-id part.

Definition at line 313 of file ParticleImpl.h.

◆ UNDEFINEDBARCODE

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)

staticinherited

Definition at line 52 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

◆ UNDEFINEDVERSION

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDVERSION = UNDEFINEDBARCODE

staticinherited

Definition at line 53 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ evtIndex_t

◆ momentum_type

◆ navigable_type

◆ particle_type

◆ self_type

◆ TruthParticleImpl_t

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ TruthParticle() [1/3]

◆ TruthParticle() [2/3]

◆ TruthParticle() [3/3]

◆ ~TruthParticle()

Member Function Documentation

◆ barcode()

◆ charge() [1/2]

◆ charge() [2/2]

◆ child()

◆ compressedExtBarCode()

◆ cosPhi() [1/2]

◆ cosPhi() [2/2]

◆ cosTh() [1/2]

◆ cosTh() [2/2]

◆ cotTh() [1/2]

◆ cotTh() [2/2]

◆ dataType() [1/2]

◆ dataType() [2/2]

◆ dump()

◆ e() [1/2]

◆ e() [2/2]

◆ errors() [1/2]

◆ errors() [2/2]

◆ et() [1/2]

◆ et() [2/2]

◆ eta() [1/2]

◆ eta() [2/2]

◆ etIsol() [1/2]

◆ etIsol() [2/2]

◆ fillToken() [1/2]

◆ fillToken() [2/2]

◆ flow() [1/2]

◆ flow() [2/2]

◆ genChild()

◆ genEventIndex()

◆ genMother()

◆ genParticle()

◆ getAthenaBarCode() [1/2]

◆ getAthenaBarCode() [2/2]

◆ getVersion() [1/2]

◆ getVersion() [2/2]

◆ hasCharge() [1/2]

◆ hasCharge() [2/2]

◆ hasChild() [1/2]

◆ hasChild() [2/2]

◆ hasEtIsol()

◆ hasMother() [1/2]

◆ hasMother() [2/2]

◆ hasPdgId() [1/2]

◆ hasPdgId() [2/2]

◆ hasSameAthenaBarCode()

◆ hasSameAthenaBarCodeExceptVersion()

◆ hlv() [1/2]

◆ hlv() [2/2]

◆ iPt() [1/2]

◆ iPt() [2/2]

◆ kind() [1/2]

◆ kind() [2/2]

◆ m() [1/2]

◆ m() [2/2]

◆ m2() [1/2]

◆ m2() [2/2]

◆ momentumBase() [1/2]