xAOD::TruthEvent_v1 Class Reference

#include <TruthEvent_v1.h>

Inheritance diagram for xAOD::TruthEvent_v1:
xAOD::TruthEventBase_v1 SG::AuxElement SG::IAuxElement

List of all members.

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
void setWeights (const std::vector< float > &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

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 TruthVertexsignalProcessVertex () const
const TruthVertexLink_tsignalProcessVertexLink () 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_tbeamParticle1Link () const
 Get the link to the first incoming beam particle.
void setBeamParticle1Link (const TruthParticleLink_t &pcl1)
 Set one incoming beam particle.
const TruthParticleLink_tbeamParticle2Link () const
 Get the link to the second incoming beam particle.
void setBeamParticle2Link (const TruthParticleLink_t &pcl2)
 Set one incoming beam particle.

Detailed Description

Class describing a signal truth event in the MC record

Author:
Jovan Mitervski <Jovan.Mitrevski@cern.ch>
Andy Buckley <Andy.Buckley@cern.ch>
Revision
761796
Date
2016-07-14 10:06:02 +0200 (Thu, 14 Jul 2016)

Member Enumeration Documentation

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]

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]


Member Function Documentation

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.
void xAOD::TruthEvent_v1::setWeights ( const std::vector< float > &  weights  ) 

Set the event weights

Todo:
Need to add named weight access: vector<string>
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*.

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1