P4PtEtaPhiM Class Reference

P4PtEtaPhiM is a class with 4-momentum behavior, for which Pt, Eta, Phi and M are data members. More...

#include <P4PtEtaPhiM.h>

Inheritance diagram for P4PtEtaPhiM:

Collaboration diagram for P4PtEtaPhiM:

Public Types
enum	Kind {   P4EETAPHIM , P4IPTCOTTHPHIM , P4PTETAPHIM , P4PXPYPZE ,   UNKNOWN }

Public Member Functions
	P4PtEtaPhiM (const double pt, const double eta, const double phi, const double m)
	constructor with all data members
	P4PtEtaPhiM ()
	default constructor
	P4PtEtaPhiM (const CLHEP::HepLorentzVector &theHlv)
	constructor from hlv to allow conversion from hlv
	P4PtEtaPhiM (const I4Momentum &theI4M)
	constructor from any 4Momentum reference
	P4PtEtaPhiM (const I4Momentum *const pI4M)
	constructor from any 4Momentum pointer
virtual double	pt () const
	get pt data member
virtual double	eta () const
	get eta data member
virtual double	phi () const
	get phi data member
virtual double	m () const
	get mass data member
virtual void	setPt (double thePt)
	set pt data member
virtual void	setEta (double theEta)
	set eta data member
virtual void	setPhi (double thePhi)
	set phi data member
virtual void	setM (double theM)
	set mass data member
virtual void	set4Mom (const I4Momentum &theI4Mom)
	set all 4-mom from another I4Momentum reference
virtual void	set4Mom (const I4Momentum *const theI4Mom)
	set all 4-mom from another I4Momentum pointer
virtual void	set4Mom (const CLHEP::HepLorentzVector &theHlv)
	set all 4-mom from a CLHEP HepLorentzVector
virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors.
virtual double	px () const
	x component of momentum
virtual double	py () const
	y component of momentum
virtual double	pz () const
	z component of momentum
virtual double	e () const
	energy
virtual double	p () const
	magnitude of 3-momentum.
virtual double	p2 () const
	square of momentum magnitude
virtual double	m2 () const
	mass squared
virtual double	et () const
	transverse energy defined to be e*sin(theta)
virtual double	iPt () const
	inverse of transverse momentum
virtual double	rapidity () const
	rapidity
virtual double	cosPhi () const
	cosinus phi
virtual double	sinPhi () const
	sinus phi
virtual double	cotTh () const
	cottan theta
virtual double	cosTh () const
	cosinus theta
virtual double	sinTh () const
	sinus theta
virtual double	tanTh () const
	tan theta
virtual CLHEP::HepLorentzVector	hlv () const
	HepLorentzVector Special implementation from Frank Paige : if negative energy, points in opposite direction but eta and phi still the same.
I4Momentum::Kind	kind () const
	tells what kind of P4XYZT this is
virtual std::ostream &	dump (std::ostream &out) const
	Print I4Momentum content.

Protected Attributes
double	m_pt
double	m_eta
double	m_phi
double	m_m

Detailed Description

P4PtEtaPhiM is a class with 4-momentum behavior, for which Pt, Eta, Phi and M are data members.

Author

Olga Igonkina olya@.nosp@m.cern.nosp@m..ch

Definition at line 24 of file P4PtEtaPhiM.h.

Member Enumeration Documentation

Kind

enum I4Momentum::Kind

inherited

Enumerator
P4EETAPHIM
P4IPTCOTTHPHIM
P4PTETAPHIM
P4PXPYPZE
UNKNOWN

Definition at line 33 of file I4Momentum.h.

{ P4EETAPHIM, P4IPTCOTTHPHIM, P4PTETAPHIM, P4PXPYPZE, UNKNOWN };

Constructor & Destructor Documentation

P4PtEtaPhiM() [1/5]

P4PtEtaPhiM::P4PtEtaPhiM ( const double pt, const double eta, const double phi, const double m )

inline

constructor with all data members

Definition at line 29 of file P4PtEtaPhiM.h.

    : m_pt(pt), m_eta(eta), m_phi(phi), m_m(m) {};

P4PtEtaPhiM() [2/5]

P4PtEtaPhiM::P4PtEtaPhiM ( )

inline

default constructor

Definition at line 83 of file P4PtEtaPhiM.h.

                                :
  P4PtEtaPhiMBase( ),
  m_pt  ( 0.*CLHEP::GeV ),
  m_eta ( 0. ),
  m_phi ( 0. ),
  m_m   ( 0.*CLHEP::GeV )
{}

P4PtEtaPhiM() [3/5]

P4PtEtaPhiM::P4PtEtaPhiM ( const CLHEP::HepLorentzVector & theHlv )

inline

constructor from hlv to allow conversion from hlv

Definition at line 91 of file P4PtEtaPhiM.h.

{
  this->set4Mom(theHlv);
}

P4PtEtaPhiM() [4/5]

P4PtEtaPhiM::P4PtEtaPhiM ( const I4Momentum & theI4M )

inline

constructor from any 4Momentum reference

Definition at line 96 of file P4PtEtaPhiM.h.

{this->set4Mom(theI4Mom); }

P4PtEtaPhiM() [5/5]

P4PtEtaPhiM::P4PtEtaPhiM ( const I4Momentum *const pI4M )

inline

constructor from any 4Momentum pointer

Definition at line 99 of file P4PtEtaPhiM.h.

{this->set4Mom(*theI4Mom); }

Member Function Documentation

cosPhi()

double P4PtEtaPhiMBase::cosPhi ( ) const

virtualinherited

cosinus phi

Implements I4Momentum.

Definition at line 55 of file P4PtEtaPhiMBase.cxx.

{
 return std::cos(this->phi());
}

cosTh()

double P4PtEtaPhiMBase::cosTh ( ) const

virtualinherited

cosinus theta

Implements I4Momentum.

Definition at line 70 of file P4PtEtaPhiMBase.cxx.

{
 return std::tanh(this->eta());
}

cotTh()

double P4PtEtaPhiMBase::cotTh ( ) const

virtualinherited

cottan theta

Implements I4Momentum.

Definition at line 65 of file P4PtEtaPhiMBase.cxx.

{
 return std::sinh(this->eta());
}

dump()

std::ostream & P4PtEtaPhiMBase::dump ( std::ostream & out ) const

virtualinherited

Print I4Momentum content.

Implements I4Momentum.

Definition at line 147 of file P4PtEtaPhiMBase.cxx.

{
  std::stringstream outx;
  outx << "[pt,eta,phi,m] ="
         << std::right << std::scientific << std::setprecision(8) 
         << std::setw(16) << this->pt()
         << std::setw(16) << this->eta()
         << std::setw(16) << this->phi()
         << std::setw(16) << this->m();
  out<<outx.str();
  
  return out;
  
}

e()

double P4PtEtaPhiMBase::e ( ) const

virtualinherited

energy

Implements I4Momentum.

Definition at line 13 of file P4PtEtaPhiMBase.cxx.

{
  const double theMass = this->m();
  const double thePt   = this->pt();
  const double thePz   = this->pz();
 
  //DR from Frank Paige
  // if negative pt point in the opposite direction
  // BUT eta and phi still the same !!!
 
    double eSign = (thePt >= 0.) ? +1. : -1.;
    return eSign*std::sqrt(thePt*thePt + thePz*thePz +  theMass*theMass);
}

errors()

const I4MomentumError * P4PtEtaPhiM::errors ( ) const

virtual

Access to errors, if available; returns 0 if no errors.

Reimplemented from P4PtEtaPhiMBase.

Definition at line 7 of file P4PtEtaPhiM.cxx.

{
  return 0;
}

et()

double P4PtEtaPhiMBase::et ( ) const

virtualinherited

transverse energy defined to be e*sin(theta)

Implements I4Momentum.

Definition at line 101 of file P4PtEtaPhiMBase.cxx.

   {
     return this->e()*this->sinTh();
   }

eta()

double P4PtEtaPhiM::eta ( void ) const

inlinevirtual

get eta data member

Implements I4Momentum.

Definition at line 106 of file P4PtEtaPhiM.h.

{ return m_eta;}

hlv()

CLHEP::HepLorentzVector P4PtEtaPhiMBase::hlv ( ) const

virtualinherited

HepLorentzVector Special implementation from Frank Paige : if negative energy, points in opposite direction but eta and phi still the same.

Implements I4Momentum.

Definition at line 128 of file P4PtEtaPhiMBase.cxx.

{
  //minimize the number of calculation and dereference
  const double theM = this->m();
  // note that pt can have negative sign : then it points in opposite direction but eta and phi are still on the same side
  const double thePt = this->pt();  
  
 
  const double thePx = thePt*this->cosPhi();
  const double thePy = thePt*this->sinPhi();
 
  const double thePz = thePt*this->cotTh();
  
  const double theE=std::sqrt(thePt*thePt+thePz*thePz+theM*theM);
  
 
  return CLHEP::HepLorentzVector( thePx, thePy, thePz, theE );
}

iPt()

double P4PtEtaPhiMBase::iPt ( ) const

virtualinherited

inverse of transverse momentum

Implements I4Momentum.

Definition at line 106 of file P4PtEtaPhiMBase.cxx.

  { return 1./this->pt();
   }

kind()

I4Momentum::Kind P4PtEtaPhiMBase::kind ( ) const

inlinevirtualinherited

tells what kind of P4XYZT this is

Implements I4Momentum.

Definition at line 64 of file P4PtEtaPhiMBase.h.

{ return I4Momentum::P4PTETAPHIM; };

m()

double P4PtEtaPhiM::m ( void ) const

inlinevirtual

get mass data member

Implements I4Momentum.

Definition at line 112 of file P4PtEtaPhiM.h.

{ return m_m;}

m2()

double P4PtEtaPhiMBase::m2 ( ) const

virtualinherited

mass squared

Implements I4Momentum.

Definition at line 50 of file P4PtEtaPhiMBase.cxx.

{ const double theM=this->m();
 return theM*theM;
}

p()

double P4PtEtaPhiMBase::p ( ) const

virtualinherited

magnitude of 3-momentum.

Special implementation from Frank Paige : if negative energy p is negative but eta and phi still the same.

Implements I4Momentum.

Definition at line 27 of file P4PtEtaPhiMBase.cxx.

{ 
  const double thePt = this->pt();
  const double thePz = this->pz();
 
  //DR from Frank Paige
  // if negative pt point in the opposite direction
  // BUT eta and phi still the same !!!
 
  double eSign = (thePt >= 0.) ? +1. : -1.;
  return eSign*std::sqrt(thePt*thePt + thePz*thePz);
}

p2()

double P4PtEtaPhiMBase::p2 ( ) const

virtualinherited

square of momentum magnitude

Implements I4Momentum.

Definition at line 40 of file P4PtEtaPhiMBase.cxx.

{ 
  /* This method has been implemented so as to give the same as would be obtained from pow((this->p()),2) with this->p() implemented according to Frank Paige's algorithm above. */
 
  const double thePt = this->pt();
  const double thePz = this->pz();
 
  return thePt*thePt + thePz*thePz;
}

phi()

double P4PtEtaPhiM::phi ( void ) const

inlinevirtual

get phi data member

Implements I4Momentum.

Definition at line 109 of file P4PtEtaPhiM.h.

{ return m_phi;}

pt()

double P4PtEtaPhiM::pt ( void ) const

inlinevirtual

get pt data member

Implements I4Momentum.

Definition at line 103 of file P4PtEtaPhiM.h.

{ return m_pt;}

px()

double P4PtEtaPhiMBase::px ( ) const

virtualinherited

x component of momentum

Implements I4Momentum.

Definition at line 117 of file P4PtEtaPhiMBase.cxx.

   { return this->pt()*this->cosPhi();
   }

py()

double P4PtEtaPhiMBase::py ( ) const

virtualinherited

y component of momentum

Implements I4Momentum.

Definition at line 121 of file P4PtEtaPhiMBase.cxx.

   { return this->pt()*this->sinPhi();
   }

pz()

double P4PtEtaPhiMBase::pz ( ) const

virtualinherited

z component of momentum

Implements I4Momentum.

Definition at line 125 of file P4PtEtaPhiMBase.cxx.

{ return this->pt()*this->cotTh();   }

rapidity()

double P4PtEtaPhiMBase::rapidity ( ) const

virtualinherited

rapidity

Implements I4Momentum.

Definition at line 110 of file P4PtEtaPhiMBase.cxx.

  {
    const double theE=this->e();
    const double thePz=this->pz();
    return 0.5*std::log((theE+thePz)/(theE-thePz));
   }

set4Mom() [1/3]

void P4PtEtaPhiM::set4Mom ( const CLHEP::HepLorentzVector & theHlv )

inlinevirtual

set all 4-mom from a CLHEP HepLorentzVector

Reimplemented from P4PtEtaPhiMBase.

Definition at line 140 of file P4PtEtaPhiM.h.

{
  m_pt=theHlv.perp();
  m_eta=theHlv.eta();
  //FIXME protect against negative energy
  //assert(m_e >= 0,"P4PtEtaPhiM::set4Mom cannot have negative energy");
  //assert(m_e >= 0);
  // FIXME of the FIXME in fact it is not necessary to prtoect against negative energy
  // and besides Seal assert does not work
  //  ASSERT( m_e >= 0 );
  m_phi=theHlv.phi();
  m_m=theHlv.m();
 
 
}

set4Mom() [2/3]

void P4PtEtaPhiM::set4Mom ( const I4Momentum & theI4Mom )

inlinevirtual

set all 4-mom from another I4Momentum reference

Reimplemented from P4PtEtaPhiMBase.

Definition at line 127 of file P4PtEtaPhiM.h.

{ 
  m_pt=theI4Mom.pt();
  m_eta=theI4Mom.eta();
  m_phi=theI4Mom.phi();
  m_m=theI4Mom.m();
}

set4Mom() [3/3]

void P4PtEtaPhiM::set4Mom ( const I4Momentum *const theI4Mom )

inlinevirtual

set all 4-mom from another I4Momentum pointer

Reimplemented from P4PtEtaPhiMBase.

Definition at line 135 of file P4PtEtaPhiM.h.

{ 
  this->set4Mom(*theI4Mom);
}

setEta()

void P4PtEtaPhiM::setEta ( double theEta )

inlinevirtual

set eta data member

Definition at line 118 of file P4PtEtaPhiM.h.

{ m_eta = theEta;}

setM()

void P4PtEtaPhiM::setM ( double theM )

inlinevirtual

set mass data member

Definition at line 124 of file P4PtEtaPhiM.h.

{ m_m = theM;}

setPhi()

void P4PtEtaPhiM::setPhi ( double thePhi )

inlinevirtual

set phi data member

Definition at line 121 of file P4PtEtaPhiM.h.

{ m_phi = thePhi;}

setPt()

void P4PtEtaPhiM::setPt ( double thePt )

inlinevirtual

set pt data member

Definition at line 115 of file P4PtEtaPhiM.h.

{ m_pt = thePt;}

sinPhi()

double P4PtEtaPhiMBase::sinPhi ( ) const

virtualinherited

sinus phi

Implements I4Momentum.

Definition at line 60 of file P4PtEtaPhiMBase.cxx.

{ 
 return std::sin(this->phi());
}

sinTh()

double P4PtEtaPhiMBase::sinTh ( ) const

virtualinherited

sinus theta

Implements I4Momentum.

Definition at line 75 of file P4PtEtaPhiMBase.cxx.

{
  // avoid numeric overflow if very large eta
 
  double aEta=std::abs(this->eta());
  if ( aEta>710) {
    aEta=710;
  }
 
  return 1./std::cosh(aEta);
}

tanTh()

double P4PtEtaPhiMBase::tanTh ( ) const

virtualinherited

tan theta

Implements I4Momentum.

Definition at line 87 of file P4PtEtaPhiMBase.cxx.

{
  // avoid numeric overflow if very large eta
 
  double theEta=this->eta();
  if ( std::abs(theEta)>710) {
    theEta=theEta>0 ? 710 : -710;
    return 1./std::sinh(theEta);
  }
 
  return 1./std::sinh(this->eta());
}

Member Data Documentation

m_eta

double P4PtEtaPhiM::m_eta

protected

Definition at line 77 of file P4PtEtaPhiM.h.

m_m

double P4PtEtaPhiM::m_m

protected

Definition at line 79 of file P4PtEtaPhiM.h.

m_phi

double P4PtEtaPhiM::m_phi

protected

Definition at line 78 of file P4PtEtaPhiM.h.

m_pt

double P4PtEtaPhiM::m_pt

protected

Definition at line 76 of file P4PtEtaPhiM.h.

---

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

• P4PtEtaPhiM.h
• P4PtEtaPhiM.cxx