eicsmear/erhic/VirtualParticle.h

0001 /**
0002  \file
0003  Declaration of class erhic::VirtualParticle.
0004
0005  \author    Thomas Burton
0006  \date      2011-08-19
0007  \copyright 2011 Brookhaven National Lab
0008  */
0009
0010 #ifndef INCLUDE_EICSMEAR_ERHIC_VIRTUALPARTICLE_H_
0011 #define INCLUDE_EICSMEAR_ERHIC_VIRTUALPARTICLE_H_
0012
0013 #include <TLorentzVector.h>
0014 #include <TVector3.h>
0015
0016 #include "eicsmear/erhic/Pid.h"
0017
0018 namespace erhic {
0019
0020 /**
0021  \brief Abstract base class for a general particle.
0022  */
0023 class VirtualParticle : public TObject {
0024  public:
0025   /**
0026    Destructor
0027    */
0028   virtual ~VirtualParticle() { }
0029
0030   /**
0031    Returns identity information for the Particle species.
0032    */
0033   virtual Pid Id() const = 0;
0034
0035   /**
0036    Returns the momentum-energy four-vector (px, py, pz, E).
0037    */
0038   virtual TLorentzVector Get4Vector() const = 0;
0039
0040   /**
0041    Returns the x component of 3-momentum.
0042    */
0043   virtual Double_t GetPx() const = 0;
0044
0045   /**
0046    Returns the y component of 3-momentum.
0047    */
0048   virtual Double_t GetPy() const = 0;
0049
0050   /**
0051    Returns the z component of 3-momentum.
0052    */
0053   virtual Double_t GetPz() const = 0;
0054
0055   /**
0056    Returns total energy.
0057    */
0058   virtual Double_t GetE() const = 0;
0059
0060   /**
0061    Returns the magnitude of 3-momentum (GeV).
0062    */
0063   virtual Double_t GetP() const = 0;
0064
0065   /**
0066    Returns invariant mass (GeV/c<sup>2</sup>).
0067    */
0068   virtual Double_t GetM() const = 0;
0069
0070   /**
0071    Returns momentum perpendicular to the beam direction.
0072    */
0073   virtual Double_t GetPt() const = 0;
0074
0075   /**
0076    Returns the polar angle in the range [0, pi] radians.
0077    */
0078   virtual Double_t GetTheta() const = 0;
0079
0080   /**
0081    Returns the polar angle in the range [0, 2pi] radians.
0082    */
0083   virtual Double_t GetPhi() const = 0;
0084
0085   /**
0086    Returns the rapidity.
0087    */
0088   virtual Double_t GetRapidity() const = 0;
0089
0090   /**
0091    Returns the pseudorapidity.
0092    */
0093   virtual Double_t GetEta() const = 0;
0094
0095   /**
0096    Returns the origin point of the particle in cm.
0097    (0,0,0) indicates a particle originating in the collision.
0098    */
0099   virtual TVector3 GetVertex() const = 0;
0100
0101   /**
0102    A general "status" code for the particle
0103    (definition depends on implementation).
0104    */
0105   virtual UShort_t GetStatus() const = 0;
0106
0107   /**
0108    Returns the index of the parent particle
0109    */
0110   virtual UShort_t GetParentIndex() const = 0;
0111
0112   /**
0113    Sets the origin coordinates
0114    */
0115   virtual void SetVertex(const TVector3& /* (x, y, z) */) = 0;
0116
0117   /**
0118    Sets the four-momentum of the particle.
0119    Changes are propagated to derived quantities.
0120    */
0121   virtual void Set4Vector(const TLorentzVector& /* (px, py, pz, E) */) = 0;
0122
0123   ClassDef(erhic::VirtualParticle, 1)
0124 };
0125
0126 }  // namespace erhic
0127
0128 #endif  // INCLUDE_EICSMEAR_ERHIC_VIRTUALPARTICLE_H_