eic-smear  1.0.3
A collection of ROOT classes for Monte Carlo events and a fast-smearing code simulating detector effects for the Electron-Ion Collider task force
Public Member Functions | List of all members
erhic::VirtualParticle Class Referenceabstract

Abstract base class for a general particle. More...

#include <VirtualParticle.h>

Inheritance diagram for erhic::VirtualParticle:
erhic::hadronic::ParticleMC erhic::ParticleMC Smear::ParticleMCS

Public Member Functions

virtual ~VirtualParticle ()
 
virtual Pid Id () const =0
 
virtual TLorentzVector Get4Vector () const =0
 
virtual Double_t GetPx () const =0
 
virtual Double_t GetPy () const =0
 
virtual Double_t GetPz () const =0
 
virtual Double_t GetE () const =0
 
virtual Double_t GetP () const =0
 
virtual Double_t GetM () const =0
 
virtual Double_t GetPt () const =0
 
virtual Double_t GetTheta () const =0
 
virtual Double_t GetPhi () const =0
 
virtual Double_t GetRapidity () const =0
 
virtual Double_t GetEta () const =0
 
virtual TVector3 GetVertex () const =0
 
virtual UShort_t GetStatus () const =0
 
virtual UShort_t GetParentIndex () const =0
 
virtual void SetVertex (const TVector3 &)=0
 
virtual void Set4Vector (const TLorentzVector &)=0
 

Detailed Description

Abstract base class for a general particle.

Definition at line 23 of file VirtualParticle.h.

Constructor & Destructor Documentation

virtual erhic::VirtualParticle::~VirtualParticle ( )
inlinevirtual

Destructor

Definition at line 28 of file VirtualParticle.h.

Member Function Documentation

virtual TLorentzVector erhic::VirtualParticle::Get4Vector ( ) const
pure virtual

Returns the momentum-energy four-vector (px, py, pz, E).

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual Double_t erhic::VirtualParticle::GetE ( ) const
pure virtual

Returns total energy.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Double_t erhic::VirtualParticle::GetEta ( ) const
pure virtual

Returns the pseudorapidity.

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual Double_t erhic::VirtualParticle::GetM ( ) const
pure virtual

Returns invariant mass (GeV/c2).

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Double_t erhic::VirtualParticle::GetP ( ) const
pure virtual

Returns the magnitude of 3-momentum (GeV).

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual UShort_t erhic::VirtualParticle::GetParentIndex ( ) const
pure virtual

Returns the index of the parent particle

Implemented in Smear::ParticleMCS, erhic::hadronic::ParticleMC, and erhic::ParticleMC.

virtual Double_t erhic::VirtualParticle::GetPhi ( ) const
pure virtual

Returns the polar angle in the range [0, 2pi] radians.

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual Double_t erhic::VirtualParticle::GetPt ( ) const
pure virtual

Returns momentum perpendicular to the beam direction.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Double_t erhic::VirtualParticle::GetPx ( ) const
pure virtual

Returns the x component of 3-momentum.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Double_t erhic::VirtualParticle::GetPy ( ) const
pure virtual

Returns the y component of 3-momentum.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Double_t erhic::VirtualParticle::GetPz ( ) const
pure virtual

Returns the z component of 3-momentum.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Double_t erhic::VirtualParticle::GetRapidity ( ) const
pure virtual

Returns the rapidity.

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual UShort_t erhic::VirtualParticle::GetStatus ( ) const
pure virtual

A general "status" code for the particle (definition depends on implementation).

Implemented in erhic::hadronic::ParticleMC, Smear::ParticleMCS, and erhic::ParticleMC.

virtual Double_t erhic::VirtualParticle::GetTheta ( ) const
pure virtual

Returns the polar angle in the range [0, pi] radians.

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual TVector3 erhic::VirtualParticle::GetVertex ( ) const
pure virtual

Returns the origin point of the particle in cm. (0,0,0) indicates a particle originating in the collision.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual Pid erhic::VirtualParticle::Id ( ) const
pure virtual

Returns identity information for the Particle species.

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

virtual void erhic::VirtualParticle::Set4Vector ( const TLorentzVector &  )
pure virtual

Sets the four-momentum of the particle. Changes are propagated to derived quantities.

Implemented in erhic::ParticleMC, erhic::hadronic::ParticleMC, and Smear::ParticleMCS.

virtual void erhic::VirtualParticle::SetVertex ( const TVector3 &  )
pure virtual

Sets the origin coordinates

Implemented in erhic::ParticleMC, Smear::ParticleMCS, and erhic::hadronic::ParticleMC.

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