Class describing a truth vertex in the MC record. More...

#include <TruthVertex_v1.h>

Inheritance diagram for xAOD::TruthVertex_v1:

Collaboration diagram for xAOD::TruthVertex_v1:

Public Member Functions
	TruthVertex_v1 ()
	Default constructor.
Type::ObjectType	type () const
	The type of the object as a simple enumeration.
void	toPersistent ()
	Function making sure that the object is ready for persistification.
Functions identifying the vertex in the MC record
int	status () const
	Get the vertex status.
void	setStatus (int value)
	Set the vertex status.
int	uid () const
	Get the vertex unique ID.
void	setUid (int value)
	Set the vertex unique ID.

Links to the particles associated with this vertex
typedef ElementLink< TruthParticleContainer >	TPLink_t
	Type of one truth particle link.
typedef std::vector< TPLink_t >	TPLinks_t
	Type used to save the links to incoming and outgoing particles.
const TPLinks_t &	incomingParticleLinks () const
	Get all the incoming particles.
void	setIncomingParticleLinks (const TPLinks_t &links)
	Set all the incoming particles.
size_t	nIncomingParticles () const
	Get the number of incoming particles.
const TruthParticle_v1 *	incomingParticle (size_t index) const
	Get one of the incoming particles.
void	addIncomingParticleLink (const TPLink_t &link)
	Add one incoming particle.
void	clearIncomingParticleLinks ()
	Remove all incoming particles.
const TPLinks_t &	outgoingParticleLinks () const
	Get all the outgoing particles.
void	setOutgoingParticleLinks (const TPLinks_t &links)
	Set all the outgoing particles.
size_t	nOutgoingParticles () const
	Get the number of outgoing particles.
const TruthParticle_v1 *	outgoingParticle (size_t index) const
	Get one of the outgoing particles.
std::vector< const TruthParticle * >	particles_in () const
	Get the incoming particles.
std::vector< const TruthParticle * >	particles_out () const
	Get the outgoing particles.
void	addOutgoingParticleLink (const TPLink_t &link)
	Add one outgoing particle.
void	clearOutgoingParticleLinks ()
	Remove all outgoing particles.

Vertex position functions
typedef TLorentzVector	FourVec_t
	The 4-vector type.
typedef ROOT::Math::LorentzVector< ROOT::Math::PxPyPzE4D< double > >	GenVecFourVec_t
	Base 4 Momentum type for TruthVector.
float	x () const
	Vertex x displacement.
void	setX (float value)
	Set the x displacement of the vertex.
float	y () const
	Vertex y displacement.
void	setY (float value)
	Set the y displacement of the vertex.
float	z () const
	Vertex longitudinal distance along the beam line form the origin.
void	setZ (float value)
	Set the vertex's longitudinal distance from the origin.
float	perp () const
	Vertex transverse distance from the beam line.
float	eta () const
	Vertex pseudorapidity.
float	phi () const
	Vertex azimuthal angle.
float	t () const
	Vertex time.
void	setT (float value)
	Set the vertex time.
FourVec_t	v4 () const
	The full 4-vector of the vertex.
GenVecFourVec_t	genvecV4 () const
	The full 4-vector of the particle : GenVector form.

Detailed Description

Class describing a truth vertex in the MC record.

The xAOD truth record mimicks the structure of HepMC. Truth particles and truth vertices form a decay tree. Where each truth particle is connected to a single production and decay vertex. And each vertex is connected to one or more incoming, and one or more outgoing particles.

Author: Andy Buckley Andy..nosp@m.Buck.nosp@m.ley@c.nosp@m.ern..nosp@m.ch

Definition at line 37 of file TruthVertex_v1.h.

Member Typedef Documentation

◆ FourVec_t

typedef TLorentzVector xAOD::TruthVertex_v1::FourVec_t

The 4-vector type.

Definition at line 129 of file TruthVertex_v1.h.

◆ GenVecFourVec_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PxPyPzE4D<double> > xAOD::TruthVertex_v1::GenVecFourVec_t

Base 4 Momentum type for TruthVector.

Definition at line 135 of file TruthVertex_v1.h.

◆ TPLink_t

typedef ElementLink< TruthParticleContainer > xAOD::TruthVertex_v1::TPLink_t

Type of one truth particle link.

Definition at line 62 of file TruthVertex_v1.h.

◆ TPLinks_t

typedef std::vector< TPLink_t > xAOD::TruthVertex_v1::TPLinks_t

Type used to save the links to incoming and outgoing particles.

Definition at line 64 of file TruthVertex_v1.h.

Constructor & Destructor Documentation

◆ TruthVertex_v1()

xAOD::TruthVertex_v1::TruthVertex_v1 ( )

Default constructor.

Definition at line 17 of file TruthVertex_v1.cxx.

   : SG::AuxElement() {
 
   }

Member Function Documentation

◆ addIncomingParticleLink()

void xAOD::TruthVertex_v1::addIncomingParticleLink ( const TPLink_t & link )

Add one incoming particle.

Definition at line 88 of file TruthVertex_v1.cxx.

                                                                      {
 
      incomingParticleLinksAcc( *this ).push_back( link );
      return;
   }

◆ addOutgoingParticleLink()

void xAOD::TruthVertex_v1::addOutgoingParticleLink ( const TPLink_t & link )

Add one outgoing particle.

Definition at line 138 of file TruthVertex_v1.cxx.

                                                                      {
 
      outgoingParticleLinksAcc( *this ).push_back( link );
      return;
   }

◆ clearIncomingParticleLinks()

void xAOD::TruthVertex_v1::clearIncomingParticleLinks ( )

Remove all incoming particles.

Definition at line 94 of file TruthVertex_v1.cxx.

                                                   {
 
      incomingParticleLinksAcc( *this ).clear();
      return;
   }

◆ clearOutgoingParticleLinks()

void xAOD::TruthVertex_v1::clearOutgoingParticleLinks ( )

Remove all outgoing particles.

Definition at line 144 of file TruthVertex_v1.cxx.

                                                   {
 
      outgoingParticleLinksAcc( *this ).clear();
      return;
   }

◆ eta()

float xAOD::TruthVertex_v1::eta ( ) const

Vertex pseudorapidity.

Definition at line 171 of file TruthVertex_v1.cxx.

                                   {
 
      // This is not necessarily what Andy was thinking about...
      return genvecV4().Eta();
   }

◆ genvecV4()

TruthVertex_v1::GenVecFourVec_t xAOD::TruthVertex_v1::genvecV4 ( ) const

The full 4-vector of the particle : GenVector form.

Definition at line 189 of file TruthVertex_v1.cxx.

                                                                {
      return GenVecFourVec_t(x(), y(), z(), t());
   }

◆ incomingParticle()

const TruthParticle * xAOD::TruthVertex_v1::incomingParticle ( size_t index ) const

Get one of the incoming particles.

Definition at line 70 of file TruthVertex_v1.cxx.

                                                                             {
 
      // Check that the variable exists, and that it has enough elements in it:
      if( ( ! incomingParticleLinksAcc.isAvailable( *this ) ) ||
          ( incomingParticleLinksAcc( *this ).size() <= index ) ) {
         return nullptr;
      }
 
      // Retrieve the link object and check its validity:
      const TPLink_t& ipl = incomingParticleLinksAcc( *this )[ index ];
      if( ! ipl.isValid() ) {
         return nullptr;
      }
 
      // Finally, de-reference the link:
      return *ipl;
   }

◆ incomingParticleLinks()

const TPLinks_t & xAOD::TruthVertex_v1::incomingParticleLinks ( ) const

Get all the incoming particles.

◆ nIncomingParticles()

size_t xAOD::TruthVertex_v1::nIncomingParticles ( ) const

Get the number of incoming particles.

◆ nOutgoingParticles()

size_t xAOD::TruthVertex_v1::nOutgoingParticles ( ) const

Get the number of outgoing particles.

◆ outgoingParticle()

const TruthParticle * xAOD::TruthVertex_v1::outgoingParticle ( size_t index ) const

Get one of the outgoing particles.

Definition at line 120 of file TruthVertex_v1.cxx.

                                                                             {
 
      // Check that the variable exists, and that it has enough elements in it:
      if( ( ! outgoingParticleLinksAcc.isAvailable( *this ) ) ||
          ( outgoingParticleLinksAcc( *this ).size() <= index ) ) {
         return nullptr;
      }
 
      // Retrieve the link object and check its validity:
      const TPLink_t& opl = outgoingParticleLinksAcc( *this )[ index ];
      if( ! opl.isValid() ) {
         return nullptr;
      }
 
      // Finally, de-reference the link:
      return *opl;
   }

◆ outgoingParticleLinks()

const TPLinks_t & xAOD::TruthVertex_v1::outgoingParticleLinks ( ) const

Get all the outgoing particles.

◆ particles_in()

std::vector< const TruthParticle * > xAOD::TruthVertex_v1::particles_in ( ) const

Get the incoming particles.

Definition at line 60 of file TruthVertex_v1.cxx.

                                                                      {
     std::vector<const TruthParticle*> res;
     for (size_t i=0; i<nIncomingParticles();i++) res.push_back(incomingParticle(i));
     return res;
   }

◆ particles_out()

std::vector< const TruthParticle * > xAOD::TruthVertex_v1::particles_out ( ) const

Get the outgoing particles.

Definition at line 65 of file TruthVertex_v1.cxx.

                                                                       {
     std::vector<const TruthParticle*> res;
     for (size_t i=0; i<nOutgoingParticles();i++) res.push_back(outgoingParticle(i));
     return res;
   }

◆ perp()

float xAOD::TruthVertex_v1::perp ( ) const

Vertex transverse distance from the beam line.

Definition at line 164 of file TruthVertex_v1.cxx.

                                    {
 
      // Do the calculation by hand. Could make it faster than this even in a
      // future iteration...
      return std::sqrt( x() * x() + y() * y() );
   }

◆ phi()

float xAOD::TruthVertex_v1::phi ( ) const

Vertex azimuthal angle.

Definition at line 177 of file TruthVertex_v1.cxx.

                                   {
 
      // This is not necessarily what Andy was thinking about...
      return genvecV4().Phi();
   }

◆ setIncomingParticleLinks()

void xAOD::TruthVertex_v1::setIncomingParticleLinks ( const TPLinks_t & links )

Set all the incoming particles.

◆ setOutgoingParticleLinks()

void xAOD::TruthVertex_v1::setOutgoingParticleLinks ( const TPLinks_t & links )

Set all the outgoing particles.

◆ setStatus()

void xAOD::TruthVertex_v1::setStatus ( int value )

Set the vertex status.

◆ setT()

void xAOD::TruthVertex_v1::setT ( float value )

Set the vertex time.

◆ setUid()

void xAOD::TruthVertex_v1::setUid ( int value )

Set the vertex unique ID.

◆ setX()

void xAOD::TruthVertex_v1::setX ( float value )

Set the x displacement of the vertex.

◆ setY()

void xAOD::TruthVertex_v1::setY ( float value )

Set the y displacement of the vertex.

◆ setZ()

void xAOD::TruthVertex_v1::setZ ( float value )

Set the vertex's longitudinal distance from the origin.

◆ status()

int xAOD::TruthVertex_v1::status ( ) const

Get the vertex status.

◆ t()

float xAOD::TruthVertex_v1::t ( ) const

Vertex time.

◆ toPersistent()

void xAOD::TruthVertex_v1::toPersistent ( )

Function making sure that the object is ready for persistification.

Definition at line 201 of file TruthVertex_v1.cxx.

                                     {
 
      // Prepare the incoming particle links for persistification:
      if( incomingParticleLinksAcc.isAvailableWritable( *this ) ) {
         TPLinks_t::iterator itr = incomingParticleLinksAcc( *this ).begin();
         TPLinks_t::iterator end = incomingParticleLinksAcc( *this ).end();
         for( ; itr != end; ++itr ) {
            itr->toPersistent();
         }
      }
 
      // Prepare the outgoing particle links for persistification:
      if( outgoingParticleLinksAcc.isAvailableWritable( *this ) ) {
         TPLinks_t::iterator itr = outgoingParticleLinksAcc( *this ).begin();
         TPLinks_t::iterator end = outgoingParticleLinksAcc( *this ).end();
         for( ; itr != end; ++itr ) {
            itr->toPersistent();
         }
      }
 
      return;
   }

◆ type()

Type::ObjectType xAOD::TruthVertex_v1::type ( ) const

The type of the object as a simple enumeration.

Definition at line 196 of file TruthVertex_v1.cxx.

                                             {
 
      return Type::TruthVertex;
   }

◆ uid()

int xAOD::TruthVertex_v1::uid ( ) const

Get the vertex unique ID.

◆ v4()

TruthVertex_v1::FourVec_t xAOD::TruthVertex_v1::v4 ( ) const

The full 4-vector of the vertex.

Definition at line 185 of file TruthVertex_v1.cxx.

                                                    {
      return FourVec_t(x(), y(), z(), t());
   }

◆ x()

float xAOD::TruthVertex_v1::x ( ) const

Vertex x displacement.

◆ y()

float xAOD::TruthVertex_v1::y ( ) const

Vertex y displacement.

◆ z()

float xAOD::TruthVertex_v1::z ( ) const

Vertex longitudinal distance along the beam line form the origin.

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

Public Member Functions

Links to the particles associated with this vertex

Vertex position functions