P4EEtaPhiM Class Reference

#include <P4EEtaPhiM.h>

Inheritance diagram for P4EEtaPhiM:

Collaboration diagram for P4EEtaPhiM:

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

Public Member Functions
	P4EEtaPhiM (const double e, const double eta, const double phi, const double m)
	constructor with all data members
	P4EEtaPhiM ()
	default constructor
	P4EEtaPhiM (const CLHEP::HepLorentzVector &theHlv)
	constructor from hlv to allow conversion from hlv
	P4EEtaPhiM (const I4Momentum &theI4M)
	constructor from any 4Momentum reference
	P4EEtaPhiM (const I4Momentum *const pI4M)
	constructor from any 4Momentum pointer
virtual double	e () const
	get energy 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	setE (double theE)
	set energy 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	et () const
	transverse energy defined to be e*sin(theta)
virtual double	p () const
	magnitude of 3-momentum.
virtual double	p2 () const
	square of momentum magnitude
virtual double	m2 () const
	mass squared
virtual double	pt () const
	transverse momentum
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=std::cout) const
	Print I4Momentum content.

Protected Attributes
double	m_e
double	m_eta
double	m_phi
double	m_m

Detailed Description

Definition at line 24 of file P4EEtaPhiM.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

P4EEtaPhiM() [1/5]

P4EEtaPhiM::P4EEtaPhiM	(	const double	e,
		const double	eta,
		const double	phi,
		const double	m )

constructor with all data members

Definition at line 7 of file P4EEtaPhiM.cxx.

                                                                                        :
  m_e(e),m_eta(eta),m_phi(phi),m_m(m)
{ // could enforce phi range convention there
  // const double twopi =2.*M_PI;
  // const double threepi=3.*M_PI;
  // m_phi=fmod(phi+threepi,twopi)-M_PI;
}

P4EEtaPhiM() [2/5]

P4EEtaPhiM::P4EEtaPhiM ( )

inline

default constructor

Definition at line 82 of file P4EEtaPhiM.h.

                              :
  P4EEtaPhiMBase(),
  m_e   ( 0.*CLHEP::GeV ),
  m_eta ( 0. ),
  m_phi ( 0. ),
  m_m   ( 0.*CLHEP::GeV )
{}

P4EEtaPhiM() [3/5]

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

inline

constructor from hlv to allow conversion from hlv

Definition at line 90 of file P4EEtaPhiM.h.

{
  this->set4Mom(theHlv);
}

P4EEtaPhiM() [4/5]

P4EEtaPhiM::P4EEtaPhiM ( const I4Momentum & theI4M )

inline

constructor from any 4Momentum reference

Definition at line 95 of file P4EEtaPhiM.h.

{this->set4Mom(theI4Mom); }

P4EEtaPhiM() [5/5]

P4EEtaPhiM::P4EEtaPhiM ( const I4Momentum *const pI4M )

inline

constructor from any 4Momentum pointer

Definition at line 98 of file P4EEtaPhiM.h.

{this->set4Mom(*theI4Mom); }

Member Function Documentation

cosPhi()

double P4EEtaPhiMBase::cosPhi ( ) const

virtualinherited

cosinus phi

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 54 of file P4EEtaPhiMBase.cxx.

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

cosTh()

double P4EEtaPhiMBase::cosTh ( ) const

virtualinherited

cosinus theta

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 82 of file P4EEtaPhiMBase.cxx.

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

cotTh()

double P4EEtaPhiMBase::cotTh ( ) const

virtualinherited

cottan theta

Implements I4Momentum.

Reimplemented in CaloCell.

Definition at line 77 of file P4EEtaPhiMBase.cxx.

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

dump()

std::ostream & P4EEtaPhiMBase::dump ( std::ostream & out = std::cout ) const

virtualinherited

Print I4Momentum content.

Implements I4Momentum.

Definition at line 159 of file P4EEtaPhiMBase.cxx.

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

e()

double P4EEtaPhiM::e ( ) const

inlinevirtual

get energy data member

Implements I4Momentum.

Reimplemented in CaloCluster, and CaloTower.

Definition at line 102 of file P4EEtaPhiM.h.

{ return m_e;}

errors()

const I4MomentumError * P4EEtaPhiM::errors ( ) const

virtual

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

Reimplemented from P4EEtaPhiMBase.

Definition at line 15 of file P4EEtaPhiM.cxx.

{
  return 0;
}

et()

double P4EEtaPhiMBase::et ( ) const

virtualinherited

transverse energy defined to be e*sin(theta)

Implements I4Momentum.

Reimplemented in CaloCell.

Definition at line 106 of file P4EEtaPhiMBase.cxx.

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

eta()

double P4EEtaPhiM::eta ( void ) const

inlinevirtual

get eta data member

Implements I4Momentum.

Reimplemented in CaloCluster, and CaloTower.

Definition at line 105 of file P4EEtaPhiM.h.

{ return m_eta;}

hlv()

CLHEP::HepLorentzVector P4EEtaPhiMBase::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.

Reimplemented in CaloCluster.

Definition at line 134 of file P4EEtaPhiMBase.cxx.

{
  //minimize the number of calculation and dereference
  const double theCosTh=this->cosTh();  
 
  // DR from Frank Paige
  // negative energy point in opposite direction
  // BUT Eta and Phi still the same
  //  double theP=theE;
 
  const double theP=this->p();
 
  const double theSinTh=std::sqrt(1.-theCosTh*theCosTh);
  const double thePt=theP*theSinTh;
  const double thePx=thePt*this->cosPhi();
  const double thePy=thePt*this->sinPhi();
  const double thePz=theP*theCosTh;  
 
 
 return CLHEP::HepLorentzVector(thePx,thePy,thePz,this->e());
 
}

iPt()

double P4EEtaPhiMBase::iPt ( ) const

virtualinherited

inverse of transverse momentum

Implements I4Momentum.

Definition at line 111 of file P4EEtaPhiMBase.cxx.

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

kind()

I4Momentum::Kind P4EEtaPhiMBase::kind ( ) const

inlinevirtualinherited

tells what kind of P4XYZT this is

Implements I4Momentum.

Definition at line 65 of file P4EEtaPhiMBase.h.

{ return I4Momentum::P4EETAPHIM; };

m()

double P4EEtaPhiM::m ( void ) const

inlinevirtual

get mass data member

Implements I4Momentum.

Reimplemented in CaloCluster, and CaloTower.

Definition at line 111 of file P4EEtaPhiM.h.

{ return m_m;}

m2()

double P4EEtaPhiMBase::m2 ( ) const

virtualinherited

mass squared

Implements I4Momentum.

Definition at line 14 of file P4EEtaPhiMBase.cxx.

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

p()

double P4EEtaPhiMBase::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 21 of file P4EEtaPhiMBase.cxx.

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

p2()

double P4EEtaPhiMBase::p2 ( ) const

virtualinherited

square of momentum magnitude

This p2() implementaion is derived from the (somewhat unusual) Frank Paige implementation used to calculate p() above. What we do is look at what would happen if we were to square the answer returned by Frank's algorithm:

(1) The "eSign" would square to +1 and disappear, (2) The sqrt would disappear leaving theE*theE-theM*theM (3) In the event that theM==0, this theE*theE would indeed still equal theE*theE-theM*theM, so we simply return this quantity.

Implements I4Momentum.

Definition at line 39 of file P4EEtaPhiMBase.cxx.

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

phi()

double P4EEtaPhiM::phi ( void ) const

inlinevirtual

get phi data member

Implements I4Momentum.

Reimplemented in CaloCluster, and CaloTower.

Definition at line 108 of file P4EEtaPhiM.h.

{ return m_phi;}

pt()

double P4EEtaPhiMBase::pt ( ) const

virtualinherited

transverse momentum

Implements I4Momentum.

Definition at line 101 of file P4EEtaPhiMBase.cxx.

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

px()

double P4EEtaPhiMBase::px ( ) const

virtualinherited

x component of momentum

Implements I4Momentum.

Definition at line 122 of file P4EEtaPhiMBase.cxx.

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

py()

double P4EEtaPhiMBase::py ( ) const

virtualinherited

y component of momentum

Implements I4Momentum.

Definition at line 126 of file P4EEtaPhiMBase.cxx.

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

pz()

double P4EEtaPhiMBase::pz ( ) const

virtualinherited

z component of momentum

Implements I4Momentum.

Definition at line 130 of file P4EEtaPhiMBase.cxx.

   { return this->p()*this->cosTh();
   }

rapidity()

double P4EEtaPhiMBase::rapidity ( ) const

virtualinherited

rapidity

Implements I4Momentum.

Definition at line 115 of file P4EEtaPhiMBase.cxx.

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

set4Mom() [1/3]

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

inlinevirtual

set all 4-mom from a CLHEP HepLorentzVector

Reimplemented from P4EEtaPhiMBase.

Reimplemented in CaloCluster.

Definition at line 139 of file P4EEtaPhiM.h.

{
  m_e=theHlv.e();
  m_eta=theHlv.eta();
  //FIXME protect against negative energy
  //assert(m_e >= 0,"P4EEtaPhiM::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 P4EEtaPhiM::set4Mom ( const I4Momentum & theI4Mom )

inlinevirtual

set all 4-mom from another I4Momentum reference

Reimplemented from P4EEtaPhiMBase.

Reimplemented in CaloCluster.

Definition at line 126 of file P4EEtaPhiM.h.

{ 
  m_e=theI4Mom.e();
  m_eta=theI4Mom.eta();
  m_phi=theI4Mom.phi();
  m_m=theI4Mom.m();
}

set4Mom() [3/3]

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

inlinevirtual

set all 4-mom from another I4Momentum pointer

Reimplemented from P4EEtaPhiMBase.

Reimplemented in CaloCluster.

Definition at line 134 of file P4EEtaPhiM.h.

{ 
  this->set4Mom(*theI4Mom);
}

setE()

void P4EEtaPhiM::setE ( double theE )

inlinevirtual

set energy data member

Reimplemented in CaloCluster.

Definition at line 114 of file P4EEtaPhiM.h.

{ m_e = theE;}

setEta()

void P4EEtaPhiM::setEta ( double theEta )

inlinevirtual

set eta data member

Reimplemented in CaloCluster.

Definition at line 117 of file P4EEtaPhiM.h.

{ m_eta = theEta;}

setM()

void P4EEtaPhiM::setM ( double theM )

inlinevirtual

set mass data member

Reimplemented in CaloCluster.

Definition at line 123 of file P4EEtaPhiM.h.

{ m_m = theM;}

setPhi()

void P4EEtaPhiM::setPhi ( double thePhi )

inlinevirtual

set phi data member

Reimplemented in CaloCluster.

Definition at line 120 of file P4EEtaPhiM.h.

{ m_phi = thePhi;}

sinPhi()

double P4EEtaPhiMBase::sinPhi ( ) const

virtualinherited

sinus phi

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 59 of file P4EEtaPhiMBase.cxx.

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

sinTh()

double P4EEtaPhiMBase::sinTh ( ) const

virtualinherited

sinus theta

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 87 of file P4EEtaPhiMBase.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 P4EEtaPhiMBase::tanTh ( ) const

virtualinherited

tan theta

Implements I4Momentum.

Definition at line 64 of file P4EEtaPhiMBase.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./this->cotTh();
}

Member Data Documentation

m_e

double P4EEtaPhiM::m_e

protected

Definition at line 75 of file P4EEtaPhiM.h.

m_eta

double P4EEtaPhiM::m_eta

protected

Definition at line 76 of file P4EEtaPhiM.h.

m_m

double P4EEtaPhiM::m_m

protected

Definition at line 78 of file P4EEtaPhiM.h.

m_phi

double P4EEtaPhiM::m_phi

protected

Definition at line 77 of file P4EEtaPhiM.h.

---

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

• P4EEtaPhiM.h
• P4EEtaPhiM.cxx