Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file inheritance tree (.pdf)

Sections: class description function members data members class charts

class HepParticle: public TObject


 Abstract HEP particle class

 Note for developers: Some often used values like Pt, Eta etc. are
 stored as transient data members for fast access. Their computation
 from the persistent data members is either done in the normal ctor
 or in SetPtEtaPhiE(), or triggered by the fCompute flag in case of
 using the default ctor.

 Also included here is a function allowing to print TLorentzVector
 Cartesian/(pt,eta,phi) coordinates.

 !!! IMPORTANT: Do not acces the transient data members directly,  !!!
 !!! but use ALWAYS their corresponding access function like Pt(), !!!
 !!! Eta()etc. to ensure that the variables are computed properly. !!!

 !!! IMPORTANT: Do not use Pt(), Pmag(), Thethe(), Phi(), Eta() in !!!
 !!! TTree::Draw() or TTree::Scan() since these functions make use !!!
 !!! of a cache which will NOT be updated when jumping to the next !!!
 !!! event inside TTree::Draw() or TTree::Scan().                  !!!


 Author: Oliver Maria Kind <mailto: kind@mail.desy.de>
 Update: $Id: HepParticle.cxx,v 1.28 2014/02/18 12:15:18 kind Exp $
 Copyright: 2008 (C) Oliver Maria Kind

Function Members (Methods)

public:

virtual	~HepParticle()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
Float_t	Charge() const
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	Clear(Option_t* option = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
Float_t	CosTheta()
virtual void	TObject::Delete(Option_t* option = "")MENU
Float_t	DeltaEta(HepParticle* prt)
Float_t	DeltaEta(HepJet* jet)
Float_t	DeltaPhi(HepParticle* prt) const
Float_t	DeltaPhi(HepJet* jet) const
Float_t	DeltaPtFrac(HepParticle* prt)
Float_t	DeltaPtFrac(HepJet* jet)
Float_t	DeltaR(HepParticle* prt)
Float_t	DeltaR(HepJet* jet)
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
Float_t	E() const
virtual void	TObject::Error(const char* method, const char* msgfmt) const
Float_t	Et() const
Float_t	Eta()
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual void	GetCovMatrixPtEtaPhi(TMatrixD& CovMatPtEtaPhi) const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	TObject::GetIconName() const
Int_t	GetId() const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
Int_t	GetPdgCode() const
const char*	GetPdgName() const
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
Bool_t	HasInvalidPdgCode() const
	HepParticle()
	HepParticle(const HepParticle&)
	HepParticle(Int_t Id, Float_t Px, Float_t Py, Float_t Pz, Float_t E, Int_t PdgCode)
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
Float_t	InvDeltaPtFrac(HepParticle* prt)
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	IsBeauty() const
Bool_t	IsBeautyBar() const
Bool_t	IsBeautyPrime() const
Bool_t	IsBeautyPrimeBar() const
Bool_t	IsBeautyPrimeQuark() const
Bool_t	IsBeautyQuark() const
Bool_t	IsChargedLepton() const
Bool_t	IsCharm() const
Bool_t	IsCharmBar() const
Bool_t	IsCharmQuark() const
Bool_t	IsDown() const
Bool_t	IsDownBar() const
Bool_t	IsDownQuark() const
Bool_t	IsElectron() const
Bool_t	IsElectronNeutrino() const
Bool_t	IsEMinus() const
Bool_t	IsEPlus() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	IsKaon() const
Bool_t	IsKMinus() const
Bool_t	IsKPlus() const
Bool_t	IsLightQuark() const
Bool_t	IsMuMinus() const
Bool_t	IsMuon() const
Bool_t	IsMuonNeutrino() const
Bool_t	IsMuPlus() const
Bool_t	IsNegative() const
Bool_t	IsNeutral() const
Bool_t	IsNeutrino() const
Bool_t	TObject::IsOnHeap() const
Bool_t	IsPhoton() const
Bool_t	IsPiMinus() const
Bool_t	IsPion() const
Bool_t	IsPiPlus() const
Bool_t	IsPositive() const
Bool_t	IsProton() const
Bool_t	IsQuark() const
virtual Bool_t	IsSortable() const
Bool_t	IsStrange() const
Bool_t	IsStrangeBar() const
Bool_t	IsStrangeQuark() const
Bool_t	IsStringOrCluster() const
Bool_t	IsTau() const
Bool_t	IsTauMinus() const
Bool_t	IsTauNeutrino() const
Bool_t	IsTauPlus() const
Bool_t	IsTop() const
Bool_t	IsTopBar() const
Bool_t	IsTopPrime() const
Bool_t	IsTopPrimeBar() const
Bool_t	IsTopPrimeQuark() const
Bool_t	IsTopQuark() const
Bool_t	IsUp() const
Bool_t	IsUpBar() const
Bool_t	IsUpQuark() const
Bool_t	IsWBoson() const
Bool_t	IsWMinus() const
Bool_t	IsWPlus() const
Bool_t	IsZ0Boson() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
Double_t	M(Option_t* option = "PDG") const
Double_t	Mass(Option_t* option = "PDG") const
void	TObject::MayNotUse(const char* method) const
Float_t	Mperp() const
Float_t	Mperp2() const
Float_t	Mt() const
Float_t	Mt2() const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
HepParticle&	operator=(const HepParticle&)
Bool_t	operator==(HepParticle Partner)
const TLorentzVector&	P() const
TVector3	P3() const
virtual void	TObject::Paint(Option_t* option = "")
Float_t	Phi()
Float_t	Pmag()
virtual void	TObject::Pop()
virtual void	Print(Option_t* option = "")
static void	PrintFooter()
static void	PrintHeader()
static void	PrintLorentzVector(TLorentzVector vec)
Float_t	Pt()
Float_t	Px() const
Float_t	Py() const
Float_t	Pz() const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	SetId(Int_t Id)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetP(const TLorentzVector& p)
void	SetPdgCode(Int_t pdg)
void	SetPtEtaPhiE(Float_t Pt, Float_t Eta, Float_t Phi, Float_t E)
void	SetPtEtaPhiM(Float_t Pt, Float_t Eta, Float_t Phi, Float_t M)
void	SetPxPyPzE(Float_t Px, Float_t Py, Float_t Pz, Float_t E)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
Float_t	Theta()
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()

private:

void	ComputeTransientVars()

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static TObject::(anonymous)	TObject::kSingleKey
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

static HepDatabasePDG*	fDbasePDG	! PDG database
Int_t	fId	Id number (for convenience only)
TLorentzVector	fP	4-momentum (Px, Py, Pz, E) in GeV
Int_t	fPdgCode	PDG code

private:

Bool_t	fCompute	! Compute the transient variables
Float_t	fCosTheta	! Cosine of the polar angle
Float_t	fEta	! Pseudo-rapidity of the 3-momentum
Float_t	fPhi	! Azimuth of the 3-momentum (rad)
Float_t	fPmag	! Magnitude of the 3-mom. vector (GeV)
Float_t	fPt	! Transverse momentum (GeV)
Float_t	fTheta	! Polar angle of the 3-momentum (rad)

Class Charts

Inheritance Chart:

TObject

←

HepParticle

←

HepDecayParticle

←

Hep2BodyDecay

←

AtlD0DecayKPi

AtlDstarDecayDPi

AtlK0sDecayPiPi

AtlLambdaDecayPPi

AtlPhiDecayKK

AtlPhotonConv

HepK0sDecay

HepTopDecay

[more...]

Function documentation

HepParticle()

 Default constructor

 The fCompute flag triggers the computation of the transient
 member variables the next time one of them is accessed. This
 mechanism is neccessary since the values of the persistent data
 members needed for the computation are filles AFTER the call to
 this ctor

HepParticle(Int_t Id, Float_t Px, Float_t Py, Float_t Pz, Float_t E, Int_t PdgCode)

 Normal constructor

~HepParticle()

 Default destructor

void Clear(Option_t* option = "")

 Clear object

Double_t Mass(Option_t* option = "PDG") const

 Particle mass

 Options available:
    "PDG" = mass as given in the PDG dbase (default)
    "REC" = 'reconstructed' invariant mass stored in
             the 4-momentum vector

Bool_t operator==(HepParticle Partner)

 Compare Particle with Partner w.r.t. PdgCode and 4-Momentum
 return kTRUE in case of Matching

 Comparison is made between Objects, not Pointers

Int_t Compare(const TObject* obj) const

 Compares transverse momentum of this particles with another.
 Necessary for sorting

Bool_t HasInvalidPdgCode() const

 Test validity of PDG code
 Compounds like eg. deuteron, tritium or alphas etc. are
 unknown to the PDG database

const char* GetPdgName() const

 Return particle's name

Float_t Charge() const

 Get charge in units of e
 (Note that in the PDG dbase the charges are stored in 1/3 of e)

Float_t DeltaPhi(HepParticle* prt) const

 Compute azimuth difference between this and the given particle
 in the range from -pi to +pi

Float_t DeltaPhi(HepJet* jet) const

 Compute azimuth difference between this particle and the given
 jet in the range from -pi to +pi

Float_t DeltaEta(HepParticle* prt)

 Compute (signed) pseudo-rapidity difference between this and
 the given particle

Float_t DeltaEta(HepJet* jet)

 Compute (signed) pseudo-rapidity difference between this
 particle and the given jet

Float_t DeltaR(HepParticle* prt)

 Compute distance in eta-phi plane between this and the given
 particle

Float_t DeltaR(HepJet* jet)

 Compute distance in eta-phi plane between this particle and the
 given jet

Float_t Mperp2() const

 Mt^2 = Et^2 - Pt^2

 Use this function for the Jacobian-peak method

Float_t DeltaPtFrac(HepParticle* prt)

 DeltaPtFrac = (Pt_1 - Pt_2)Pt_1

 Unsigned, for better checking systematic errors

Float_t DeltaPtFrac(HepJet* jet)

Float_t InvDeltaPtFrac(HepParticle* prt)

 An "Inverse" DeltaPtFrac is needed, due to Multiple Scattering in
 the Inner Detector
 InvDeltaPtFrac = ( 1/Pt_1 - 1/Pt_2)*Pt_1

 Unsigned again, for better checking systematic errors
 I dont know yet if I can write the same algorithm for the jets

void ComputeTransientVars()

 Compute transient variables like Pt, Theta, Eta etc. for fast
 access

void Print(Option_t* option = "")

 Print object information

 Options available:
   "nohead" - No header containing the variable names is
              displayed. Useful when printing a whole table
              for a list of particles

void PrintHeader()

 Print information header


 GINUS denotes (in this order):

 IsGenerator()
 IsGenInteracting()
 IsGenNonInteracting()
 IsGenSimulStable()
 IsGenStable()

void PrintFooter()

 Print footer

void GetCovMatrixPtEtaPhi(TMatrixD& CovMatPtEtaPhi) const

 Dummy for returning the covariance matrix in some derived
 classes (reconstructed electrons and muons, ...)

void PrintLorentzVector(TLorentzVector vec)

 Print the Cartesian and (pt, eta, phi) coordinates of a
 TLorentVector. Needed, since this functionality is not
 provided by RooT. Guards Eta() from Pt = 0.

HepParticle()

Int_t GetId() const

{ return fId; }

Int_t GetPdgCode() const

{ return fPdgCode; }

Bool_t IsPositive() const

{ return ( Charge() > 0. ) ? kTRUE : kFALSE; }

Bool_t IsNegative() const

{ return ( Charge() < 0. ) ? kTRUE : kFALSE; }

Bool_t IsNeutral() const

{ return ( Charge() == 0. ) ? kTRUE : kFALSE; }

Bool_t IsSortable() const

{ return kTRUE; }

Bool_t IsChargedLepton() const

 Particle is electron, mu or tau

Bool_t IsNeutrino() const

 Particle is neutrino or antineutrino

|| IsTauNeutrino()

 Particle is a neutrino

Bool_t IsPhoton() const

 Particle is Gamma

Bool_t IsElectron() const

 Particle is e+ or e-

Bool_t IsEMinus() const

 Particle is e-

Bool_t IsEPlus() const

 Particle is e+

Bool_t IsElectronNeutrino() const

 Particle is electron neutrino

Bool_t IsMuon() const

 Particle is mu+ or mu-

Bool_t IsMuPlus() const

 Particle is mu+-

Bool_t IsMuMinus() const

 Particle is mu-

Bool_t IsMuonNeutrino() const

 Particle is muon neutrino

Bool_t IsTau() const

 Particle is tau+ or tau-

Bool_t IsTauMinus() const

 Particle is tau-

Bool_t IsTauPlus() const

 Particle is tau+

Bool_t IsPion() const

 Particle is Pi+ or Pi-

Bool_t IsPiMinus() const

 Particle is Pi-

Bool_t IsPiPlus() const

 Particle is Pi+

Bool_t IsKaon() const

 Particle is K+ or K-

Bool_t IsProton() const

 Particle is p or antiproton

Bool_t IsKMinus() const

 Particle is K-

Bool_t IsKPlus() const

 Particle is Ki+

Bool_t IsStringOrCluster() const

 Particle is cluster (91) or string (92) on hadronisation level

Bool_t IsCharmQuark() const

 Particle is c or c_bar

Bool_t IsCharm() const

 Particle is c

Bool_t IsCharmBar() const

 Particle is c_bar

Bool_t IsBeautyQuark() const

 Particle is b or b_bar

Bool_t IsBeauty() const

 Particle is b

Bool_t IsBeautyBar() const

 Particle is b_bar

Bool_t IsDown() const

 Particle is d

Bool_t IsDownBar() const

 Particle is d_bar

Bool_t IsDownQuark() const

 Particle is d or d_bar quark

Bool_t IsUp() const

 Particle is u

Bool_t IsUpBar() const

 Particle is u_bar

Bool_t IsUpQuark() const

 Particle is u or u_bar quark

Bool_t IsStrange() const

 Particle is s

Bool_t IsStrangeBar() const

 Particle is s_bar

Bool_t IsStrangeQuark() const

 Particle is s or s_bar quark

Bool_t IsTopQuark() const

 Particle is t or t_bar

Bool_t IsTop() const

 Particle is t

Bool_t IsTopBar() const

 Particle is t_bar

Bool_t IsLightQuark() const

 Is any of u, u_bar, d, d_bar or s, s_bar

Bool_t IsQuark() const

 Is any of u, u_bar, d, d_bar, s, s_bar, c, c_bar, b, b_bar, t, t_bar

Bool_t IsBeautyPrimeQuark() const

 Particle is b' or b'_bar

Bool_t IsBeautyPrime() const

 Particle is b'

Bool_t IsBeautyPrimeBar() const

 Particle is b'_bar

Bool_t IsTopPrimeQuark() const

 Particle is t' or t'_bar

Bool_t IsTopPrime() const

 Particle is t'

Bool_t IsTopPrimeBar() const

 Particle is t'_bar

Bool_t IsWBoson() const

 Particle is W+ or W-

Bool_t IsWPlus() const

 Particle is W+

Bool_t IsWMinus() const

 Particle is W-

Bool_t IsZ0Boson() const

 Particle is Z0

Double_t M(Option_t* option = "PDG") const

 Alias for Mass()

Float_t Mt2() const

     Mt^2 = E^2 - Pz^2 = M^2 + Pt^2    (GeV^2)

 !!! Warning: Do not use this function for   !!!
 !!! the reconstruction of heavy particles   !!!
 !!! like the W-boson with the Jacobian-peak !!!
 !!! method. Use Mperp() instead             !!!

Float_t Mt() const

     Mt = Sqrt(E^2 - Pz^2 = M^2 + Pt^2)   (GeV)

 !!! Warning: Do not use this function for   !!!
 !!! the reconstruction of heavy particles   !!!
 !!! like the W-boson with the Jacobian-peak !!!
 !!! method. Use Mperp() instead             !!!

Float_t Mperp() const

 Mt = Sqrt(Et^2 - Pt^2)     (GeV)
 Use this function for the Jacobian-peak method

 Note that the mass is signed

const TLorentzVector& P() const

 Return 4-momentum vector (GeV)

TVector3 P3() const

 Return 3-momentum vector (GeV)

Float_t Pmag()

 Return magnitude of 3-momentum (GeV)

 !!! The return value is cached. Do not use this function !!!
 !!! inside TTree::Draw() or TTree::Scan().               !!!
 !!! Use eg "fElectrons.fP.Mag()" instead.                !!!

Float_t Pt()

 Return transvere momentum (GeV)

 !!! The return value is cached. Do not use this function !!!
 !!! inside TTree::Draw() or TTree::Scan().               !!!
 !!! Use eg "fElectrons.fP.Perp()" instead.               !!!

Float_t Px() const

 Return momentum x component (GeV)

Float_t Py() const

 Return momentum y component (GeV)

Float_t Pz() const

 Return momentum z component (GeV)

Float_t E() const

 Return energy (GeV)

Float_t Et() const

 Return transverse energy (GeV)

Float_t Eta()

 Return pseudo-rapidity

 !!! The return value is cached. Do not use this function !!!
 !!! inside TTree::Draw() or TTree::Scan().               !!!
 !!! Use eg "fElectrons.fP.Eta()" instead.                !!!

Float_t Phi()

 Return azimuth (rad)

 !!! The return value is cached. Do not use this function !!!
 !!! inside TTree::Draw() or TTree::Scan().               !!!
 !!! Use eg "fElectrons.fP.Phi()" instead.                !!!

Float_t Theta()

 Return polar angle (rad)

 !!! The return value is cached. Do not use this function !!!
 !!! inside TTree::Draw() or TTree::Scan().               !!!
 !!! Use eg "fElectrons.fP.Theta()" instead.              !!!

Float_t CosTheta()

 Return cosine of the polar angle

 !!! The return value is cached. Do not use this function !!!
 !!! inside TTree::Draw() or TTree::Scan().               !!!
 !!! Use eg "fElectrons.fP.CosTheta()" instead.           !!!

void SetId(Int_t Id)

{ fId = Id; }

void SetPdgCode(Int_t pdg)

{ fPdgCode = pdg; }

void SetPxPyPzE(Float_t Px, Float_t Py, Float_t Pz, Float_t E)

void SetPtEtaPhiE(Float_t Pt, Float_t Eta, Float_t Phi, Float_t E)

void SetPtEtaPhiM(Float_t Pt, Float_t Eta, Float_t Phi, Float_t M)

void SetP(const TLorentzVector& p)