xAOD::TruthEvent_v1 Class Reference

Class describing a signal truth event in the MC record. More...

#include <TruthEvent_v1.h>

Inheritance diagram for xAOD::TruthEvent_v1:

Collaboration diagram for xAOD::TruthEvent_v1:

Classes
struct	PdfInfo
	Helper struct holding a full set of PDF info values. More...

Public Member Functions
	TruthEvent_v1 ()
	Default constructor.
virtual 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.
Simple event properties
const std::vector< float > &	weights () const
	Const access to the weights vector.
void	setWeights (const std::vector< float > &weights)
	Set the event weights.
float	crossSection () const
	Get the cross section.
void	setCrossSection (float value)
	Set the cross-section.
float	crossSectionError () const
	Get the cross section error.
void	setCrossSectionError (float value)
	Set the cross-section error.
void	setCrossSection (float value, float error)
	Set the cross-section and its error.

Parton density info
Optional due to particle gun & NLO events where a single PDF info doesn't work.
enum	PdfParam {   PDGID1 = 0 , PDGID2 = 1 , PDFID1 = 2 , PDFID2 = 3 ,   X1 = 4 , X2 = 5 , SCALE = 6 , Q = 6 ,   PDF1 = 7 , PDF2 = 8 , XF1 = 7 , XF2 = 8 }
	Accessor enums for PDF info parameter lookup. More...
bool	pdfInfoParameter (int &value, PdfParam parameter) const
	Read an integer PDF info parameter.
bool	pdfInfoParameter (float &value, PdfParam parameter) const
	Read a floating point PDF info parameter.
bool	setPdfInfoParameter (int value, PdfParam parameter)
	Set an integer PDF info parameter.
bool	setPdfInfoParameter (float value, PdfParam parameter)
	Set a floating point PDF info parameter.
PdfInfo	pdfInfo () const
	Retrieve a full PdfInfo with a single call.

Heavy ion info
enum	HIParam {   NCOLLHARD = 0 , NPARTPROJ = 1 , NPARTTARG = 2 , NCOLL = 3 ,   SPECTATORNEUTRONS = 4 , SPECTATORPROTONS = 5 , NNWOUNDEDCOLLISIONS = 6 , NWOUNDEDNCOLLISIONS = 7 ,   NWOUNDEDNWOUNDEDCOLLISIONS = 8 , IMPACTPARAMETER = 9 , EVENTPLANEANGLE = 10 , ECCENTRICITY = 11 ,   SIGMAINELNN = 12 , CENTRALITY = 13 }
	Heavy ion parameter enum. More...
bool	heavyIonParameter (int &value, HIParam parameter) const
	Read an integer HI parameter.
bool	heavyIonParameter (float &value, HIParam parameter) const
	Read a floating point HI parameter.
bool	setHeavyIonParameter (int value, HIParam parameter)
	Set an integer HI parameter.
bool	setHeavyIonParameter (float value, HIParam parameter)
	Set a floating point HI parameter.

Links to particles and vertices in the event
typedef ElementLink< TruthVertexContainer >	TruthVertexLink_t
	Type of the links pointing at truth vertices.
typedef ElementLink< TruthParticleContainer >	TruthParticleLink_t
	Type of the links pointing at truth particles.
const TruthVertex *	signalProcessVertex () const
	Pointer to a vertex representing the primary beam interaction point.
const TruthVertexLink_t &	signalProcessVertexLink () const
	Link to the vertex representing the primary beam interaction point.
void	setSignalProcessVertexLink (const TruthVertexLink_t &link)
	Set pointer to a vertex representing the primary beam interaction point.
std::pair< const TruthParticle *, const TruthParticle * >	beamParticles () const
	Pair of pointers to the two incoming beam particles.
void	setBeamParticleLinks (const TruthParticleLink_t &pcl1, const TruthParticleLink_t &pcl2)
	Set incoming beam particles.
const TruthParticleLink_t &	beamParticle1Link () const
	Get the link to the first incoming beam particle.
void	setBeamParticle1Link (const TruthParticleLink_t &pcl1)
	Set one incoming beam particle.
const TruthParticleLink_t &	beamParticle2Link () const
	Get the link to the second incoming beam particle.
void	setBeamParticle2Link (const TruthParticleLink_t &pcl2)
	Set one incoming beam particle.

Access to all the particles associated with the event
typedef std::vector< TruthParticleLink_t >	TruthParticleLinks_t
	Type of the truth particle links vector.
const TruthParticleLinks_t &	truthParticleLinks () const
	Get all the truth particles.
void	setTruthParticleLinks (const TruthParticleLinks_t &plinks)
	Set all the truth particles.
size_t	nTruthParticles () const
	Get the number of truth particles.
const TruthParticleLink_t &	truthParticleLink (size_t index) const
	Get the link to one of the truth particles.
const TruthParticle *	truthParticle (size_t index) const
	Get a pointer to one of the truth particles.
void	addTruthParticleLink (const TruthParticleLink_t &plink)
	Add one truth particle.
void	clearTruthParticleLinks ()
	Remove all truth particles.

Access to all the vertices associated with the event
typedef std::vector< TruthVertexLink_t >	TruthVertexLinks_t
	Type of the truth particle links vector.
const TruthVertexLinks_t &	truthVertexLinks () const
	Get all the truth vertices.
void	setTruthVertexLinks (const TruthVertexLinks_t &links)
	Set all the truth vertices.
size_t	nTruthVertices () const
	Get the number of truth vertices.
const TruthVertexLink_t &	truthVertexLink (size_t index) const
	Get the link to one of the truth vertices.
const TruthVertex *	truthVertex (size_t index) const
	Get a pointer to one of the truth vertices.
void	addTruthVertexLink (const TruthVertexLink_t &vlink)
	Add one truth vertex.
void	clearTruthVertexLinks ()
	Remove all truth vertices.

Detailed Description

Class describing a signal truth event in the MC record.

Author

Jovan Mitervski Jovan.nosp@m..Mit.nosp@m.revsk.nosp@m.i@ce.nosp@m.rn.ch

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

Revision

761796

Date

2016-07-14 10:06:02 +0200 (Thu, 14 Jul 2016)

Definition at line 35 of file TruthEvent_v1.h.

Member Typedef Documentation

TruthParticleLink_t

typedef ElementLink< TruthParticleContainer > xAOD::TruthEvent_v1::TruthParticleLink_t

Type of the links pointing at truth particles.

Definition at line 177 of file TruthEvent_v1.h.

TruthParticleLinks_t

typedef std::vector< TruthParticleLink_t > xAOD::TruthEventBase_v1::TruthParticleLinks_t

inherited

Type of the truth particle links vector.

Definition at line 50 of file TruthEventBase_v1.h.

TruthVertexLink_t

typedef ElementLink< TruthVertexContainer > xAOD::TruthEvent_v1::TruthVertexLink_t

Type of the links pointing at truth vertices.

Definition at line 163 of file TruthEvent_v1.h.

TruthVertexLinks_t

typedef std::vector< TruthVertexLink_t > xAOD::TruthEventBase_v1::TruthVertexLinks_t

inherited

Type of the truth particle links vector.

Definition at line 75 of file TruthEventBase_v1.h.

Member Enumeration Documentation

HIParam

enum xAOD::TruthEvent_v1::HIParam

Heavy ion parameter enum.

Enumerator
NCOLLHARD	[int]
NPARTPROJ	[int]
NPARTTARG	[int]
NCOLL	[int]
SPECTATORNEUTRONS	[int]
SPECTATORPROTONS	[int]
NNWOUNDEDCOLLISIONS	[int]
NWOUNDEDNCOLLISIONS	[int]
NWOUNDEDNWOUNDEDCOLLISIONS	[int]
IMPACTPARAMETER	[float]
EVENTPLANEANGLE	[float]
ECCENTRICITY	[float]
SIGMAINELNN	[float]
CENTRALITY	[float]

Definition at line 130 of file TruthEvent_v1.h.

                   {
         NCOLLHARD = 0,                  
         NPARTPROJ = 1,                  
         NPARTTARG = 2,                  
         NCOLL = 3,                      
         SPECTATORNEUTRONS = 4,          
         SPECTATORPROTONS = 5,           
         NNWOUNDEDCOLLISIONS = 6,        
         NWOUNDEDNCOLLISIONS = 7,        
         NWOUNDEDNWOUNDEDCOLLISIONS = 8, 
         IMPACTPARAMETER = 9,            
         EVENTPLANEANGLE = 10,           
         ECCENTRICITY = 11,              
         SIGMAINELNN = 12,               
         CENTRALITY = 13,                
      }; // enum HIParam

PdfParam

enum xAOD::TruthEvent_v1::PdfParam

Accessor enums for PDF info parameter lookup.

Enumerator
PDGID1	[int]
PDGID2	[int]
PDFID1	[int]
PDFID2	[int]
X1	[float]
X2	[float]
SCALE	Not implemented!!!
Q	[float]
PDF1	Not implemented!!!
PDF2	Not implemented!!!
XF1	[float]
XF2	[float]

Definition at line 74 of file TruthEvent_v1.h.

                    {
         PDGID1 = 0, 
         PDGID2 = 1, 
         PDFID1 = 2, 
         PDFID2 = 3, 
         X1 = 4,     
         X2 = 5,     
         SCALE = 6,  
         Q = 6,      
         PDF1 = 7,   
         PDF2 = 8,   
         XF1 = 7,    
         XF2 = 8     
      }; // enum PdfParam

Constructor & Destructor Documentation

TruthEvent_v1()

xAOD::TruthEvent_v1::TruthEvent_v1

(

)

Default constructor.

Definition at line 20 of file TruthEvent_v1.cxx.

      : TruthEventBase_v1() {
 
   }

Member Function Documentation

addTruthParticleLink()

void xAOD::TruthEventBase_v1::addTruthParticleLink ( const TruthParticleLink_t & plink )

inherited

Add one truth particle.

Definition at line 68 of file TruthEventBase_v1.cxx.

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

addTruthVertexLink()

void xAOD::TruthEventBase_v1::addTruthVertexLink ( const TruthVertexLink_t & vlink )

inherited

Add one truth vertex.

Definition at line 129 of file TruthEventBase_v1.cxx.

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

beamParticle1Link()

const TruthParticleLink_t & xAOD::TruthEvent_v1::beamParticle1Link

(

)

const

Get the link to the first incoming beam particle.

beamParticle2Link()

const TruthParticleLink_t & xAOD::TruthEvent_v1::beamParticle2Link

(

)

const

Get the link to the second incoming beam particle.

beamParticles()

std::pair< const TruthParticle *, const TruthParticle * > xAOD::TruthEvent_v1::beamParticles

(

)

const

Pair of pointers to the two incoming beam particles.

Definition at line 226 of file TruthEvent_v1.cxx.

                                      {
 
      // Get the pointer to the first beam particle:
      const TruthParticle* p1 = nullptr;
      if( beamParticle1LinkAcc.isAvailable( *this ) ) {
         const TruthParticleLink_t& link = beamParticle1LinkAcc( *this );
         if( link.isValid() ) {
            p1 = *link;
         }
      }
 
      // Get the pointer to the second beam particle:
      const TruthParticle* p2 = nullptr;
      if( beamParticle2LinkAcc.isAvailable( *this ) ) {
         const TruthParticleLink_t& link = beamParticle2LinkAcc( *this );
         if( link.isValid() ) {
            p2 = *link;
         }
      }
 
      // Construct the returned object:
      return std::make_pair( p1, p2 );
   }

clearTruthParticleLinks()

void xAOD::TruthEventBase_v1::clearTruthParticleLinks ( )

inherited

Remove all truth particles.

Definition at line 74 of file TruthEventBase_v1.cxx.

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

clearTruthVertexLinks()

void xAOD::TruthEventBase_v1::clearTruthVertexLinks ( )

inherited

Remove all truth vertices.

Definition at line 135 of file TruthEventBase_v1.cxx.

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

crossSection()

float xAOD::TruthEvent_v1::crossSection

(

)

const

Get the cross section.

crossSectionError()

float xAOD::TruthEvent_v1::crossSectionError

(

)

const

Get the cross section error.

heavyIonParameter() [1/2]

bool xAOD::TruthEvent_v1::heavyIonParameter	(	float &	value,
		HIParam	parameter ) const

Read a floating point HI parameter.

Definition at line 150 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

heavyIonParameter() [2/2]

bool xAOD::TruthEvent_v1::heavyIonParameter	(	int &	value,
		HIParam	parameter ) const

Read an integer HI parameter.

Definition at line 138 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

nTruthParticles()

size_t xAOD::TruthEventBase_v1::nTruthParticles ( ) const

inherited

Get the number of truth particles.

nTruthVertices()

size_t xAOD::TruthEventBase_v1::nTruthVertices ( ) const

inherited

Get the number of truth vertices.

pdfInfo()

TruthEvent_v1::PdfInfo xAOD::TruthEvent_v1::pdfInfo

(

)

const

Retrieve a full PdfInfo with a single call.

Note

May have invalid values – use valid() to check.

Definition at line 114 of file TruthEvent_v1.cxx.

                                                     {
 
      // The result object:
      PdfInfo rtn;
 
      // Retrieve all of its elements:
      pdfInfoParameter( rtn.pdgId1, PDGID1 );
      pdfInfoParameter( rtn.pdgId2, PDGID2 );
      pdfInfoParameter( rtn.pdfId1, PDFID1 );
      pdfInfoParameter( rtn.pdfId2, PDFID2 );
      pdfInfoParameter( rtn.x1,     X1 );
      pdfInfoParameter( rtn.x2,     X2 );
      pdfInfoParameter( rtn.Q,      Q );
      pdfInfoParameter( rtn.xf1,    XF1 );
      pdfInfoParameter( rtn.xf2,    XF2 );
 
      return rtn;
   }

pdfInfoParameter() [1/2]

bool xAOD::TruthEvent_v1::pdfInfoParameter	(	float &	value,
		PdfParam	parameter ) const

Read a floating point PDF info parameter.

Definition at line 63 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

pdfInfoParameter() [2/2]

bool xAOD::TruthEvent_v1::pdfInfoParameter	(	int &	value,
		PdfParam	parameter ) const

Read an integer PDF info parameter.

Definition at line 51 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

setBeamParticle1Link()

void xAOD::TruthEvent_v1::setBeamParticle1Link

(

const TruthParticleLink_t &

pcl1

)

Set one incoming beam particle.

setBeamParticle2Link()

void xAOD::TruthEvent_v1::setBeamParticle2Link

(

const TruthParticleLink_t &

pcl2

)

Set one incoming beam particle.

setBeamParticleLinks()

void xAOD::TruthEvent_v1::setBeamParticleLinks	(	const TruthParticleLink_t &	pcl1,
		const TruthParticleLink_t &	pcl2 )

Set incoming beam particles.

Definition at line 250 of file TruthEvent_v1.cxx.

                                                                               {
 
      setBeamParticle1Link( pcl1 );
      setBeamParticle2Link( pcl2 );
      return;
   }

setCrossSection() [1/2]

void xAOD::TruthEvent_v1::setCrossSection

(

float

value

)

Set the cross-section.

setCrossSection() [2/2]

void xAOD::TruthEvent_v1::setCrossSection	(	float	value,
		float	error )

Set the cross-section and its error.

setCrossSectionError()

void xAOD::TruthEvent_v1::setCrossSectionError

(

float

value

)

Set the cross-section error.

setHeavyIonParameter() [1/2]

bool xAOD::TruthEvent_v1::setHeavyIonParameter	(	float	value,
		HIParam	parameter )

Set a floating point HI parameter.

Definition at line 174 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setHeavyIonParameter() [2/2]

bool xAOD::TruthEvent_v1::setHeavyIonParameter	(	int	value,
		HIParam	parameter )

Set an integer HI parameter.

Definition at line 162 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setPdfInfoParameter() [1/2]

bool xAOD::TruthEvent_v1::setPdfInfoParameter	(	float	value,
		PdfParam	parameter )

Set a floating point PDF info parameter.

Definition at line 87 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setPdfInfoParameter() [2/2]

bool xAOD::TruthEvent_v1::setPdfInfoParameter	(	int	value,
		PdfParam	parameter )

Set an integer PDF info parameter.

Definition at line 75 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setSignalProcessVertexLink()

void xAOD::TruthEvent_v1::setSignalProcessVertexLink

(

const TruthVertexLink_t &

link

)

Set pointer to a vertex representing the primary beam interaction point.

setTruthParticleLinks()

void xAOD::TruthEventBase_v1::setTruthParticleLinks ( const TruthParticleLinks_t & plinks )

inherited

Set all the truth particles.

setTruthVertexLinks()

void xAOD::TruthEventBase_v1::setTruthVertexLinks ( const TruthVertexLinks_t & links )

inherited

Set all the truth vertices.

setWeights()

void xAOD::TruthEvent_v1::setWeights

(

const std::vector< float > &

weights

)

Set the event weights.

Todo

Need to add named weight access: vector<string>

signalProcessVertex()

const TruthVertex * xAOD::TruthEvent_v1::signalProcessVertex

(

)

const

Pointer to a vertex representing the primary beam interaction point.

The naming of the function is a bit misleading. The returned vertex can only be interpreted as an interaction position.

Definition at line 195 of file TruthEvent_v1.cxx.

                                                               {
 
      // Check if the link variable is available:
      if( ! signalProcessVertexLinkAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Get the link:
      const TruthVertexLink_t& vertLink = signalProcessVertexLinkAcc( *this );
 
      // Check if it's valid:
      if( ! vertLink.isValid() ) {
         return nullptr;
      }
 
      // Return the de-referenced link:
      return *vertLink;
   }

signalProcessVertexLink()

const TruthVertexLink_t & xAOD::TruthEvent_v1::signalProcessVertexLink

(

)

const

Link to the vertex representing the primary beam interaction point.

toPersistent()

void xAOD::TruthEvent_v1::toPersistent

(

)

Function making sure that the object is ready for persistification.

Definition at line 274 of file TruthEvent_v1.cxx.

                                    {
 
      if( beamParticle1LinkAcc.isAvailableWritable( *this ) ) {
         beamParticle1LinkAcc( *this ).toPersistent();
      }
      if( beamParticle2LinkAcc.isAvailableWritable( *this ) ) {
         beamParticle2LinkAcc( *this ).toPersistent();
      }
      if( signalProcessVertexLinkAcc.isAvailableWritable( *this ) ) {
         signalProcessVertexLinkAcc( *this ).toPersistent();
      }
 
      TruthEventBase_v1::toPersistent();
      return;
   }

truthParticle()

const TruthParticle * xAOD::TruthEventBase_v1::truthParticle ( size_t index ) const

inherited

Get a pointer to one of the truth particles.

Definition at line 50 of file TruthEventBase_v1.cxx.

                                                                             {
 
      // Check if the variable is available:
      if( ! truthParticleLinksAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Check if the link is valid:
      const TruthParticleLinks_t& links = truthParticleLinksAcc( *this );
      if( ! links[ index ].isValid() ) {
         return nullptr;
      }
 
      // Return the de-referenced link:
      return *( links[ index ] );
   }

truthParticleLink()

const TruthEventBase_v1::TruthParticleLink_t & xAOD::TruthEventBase_v1::truthParticleLink ( size_t index ) const

inherited

Get the link to one of the truth particles.

Definition at line 45 of file TruthEventBase_v1.cxx.

                                                            {
 
      return truthParticleLinksAcc( *this ).at( index );
   }

truthParticleLinks()

const TruthParticleLinks_t & xAOD::TruthEventBase_v1::truthParticleLinks ( ) const

inherited

Get all the truth particles.

truthVertex()

const TruthVertex * xAOD::TruthEventBase_v1::truthVertex ( size_t index ) const

inherited

Get a pointer to one of the truth vertices.

Definition at line 112 of file TruthEventBase_v1.cxx.

                                                                         {
 
      // Check if the variable is available:
      if( ! truthVertexLinksAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Check if the link is valid:
      const TruthVertexLinks_t& links = truthVertexLinksAcc( *this );
      if( ! links[ index ].isValid() ) {
         return nullptr;
      }
 
      // Return the de-referenced link:
      return *( links[ index ] );
   }

truthVertexLink()

const TruthEventBase_v1::TruthVertexLink_t & xAOD::TruthEventBase_v1::truthVertexLink ( size_t index ) const

inherited

Get the link to one of the truth vertices.

Definition at line 107 of file TruthEventBase_v1.cxx.

                                                          {
 
      return truthVertexLinksAcc( *this ).at(index);
   }

truthVertexLinks()

const TruthVertexLinks_t & xAOD::TruthEventBase_v1::truthVertexLinks ( ) const

inherited

Get all the truth vertices.

type()

setBeamParticle2Link Type::ObjectType xAOD::TruthEvent_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Implements xAOD::TruthEventBase_v1.

Definition at line 269 of file TruthEvent_v1.cxx.

                                            {
 
      return Type::TruthEvent;
   }

weights()

const std::vector< float > & xAOD::TruthEvent_v1::weights

(

)

const

Const access to the weights vector.

Todo

Need to add the map-like interface for the weights: very important!

---

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

• TruthEvent_v1.h
• TruthEvent_v1.cxx