P4ImplEEtaPhiM is a base class for classes with 4-momentum behavior, for which E, eta, phi and M are natural parameters, which is typically the case for a calorimeter object. More...

#include <P4ImplEEtaPhiM.h>

Inheritance diagram for P4ImplEEtaPhiM:

Collaboration diagram for P4ImplEEtaPhiM:

Public Types
typedef FourMomentumError< P4ImplEEtaPhiM >	ErrorType

Public Member Functions
	P4ImplEEtaPhiM ()
	Default constructor:
	P4ImplEEtaPhiM (const P4ImplEEtaPhiM &rhs)
	Copy constructor.
P4ImplEEtaPhiM &	operator= (const P4ImplEEtaPhiM &rhs)
	Assignment operator.
	P4ImplEEtaPhiM (const double e, const double eta, const double phi, const double m)
	constructor with all data members
	P4ImplEEtaPhiM (const CLHEP::HepLorentzVector &hlv)
	constructor from hlv to allow conversion from hlv
	P4ImplEEtaPhiM (const I4Momentum &theI4M)
	constructor from any I4Momentum reference
	P4ImplEEtaPhiM (const I4Momentum *const theI4M)
	constructor from any I4Momentum pointer
virtual	~P4ImplEEtaPhiM ()
	virtual destructor needed by pool
double	m () const
	{@ a la `I4Momentum` -like interface
double	eta () const
double	phi () const
double	e () const
virtual const I4MomentumError *	errors () const
I4Momentum::Kind	kind () const
void	setE (const double theE)
	set energy data member
void	setEta (const double theEta)
	set eta data member
void	setPhi (const double thePhi)
	set phi data member
void	setM (const double theM)
	set mass data member
void	set4Mom (const I4Momentum &theI4Mom)
	set all 4-mom from another I4Momentum reference
void	set4Mom (const I4Momentum *const theI4Mom)
	set all 4-mom from another I4Momentum pointer
void	set4Mom (const CLHEP::HepLorentzVector &theHlv)
	set all 4-mom from CLHEP HepLorentzVector
void	setErrors (const ErrorMatrixEEtaPhiM &err)
	set the errors
double	px () const
	{@ a la `I4Momentum` -like interface
double	py () const
double	pz () const
double	m2 () const
double	rapidity () const
double	p () const
double	p2 () const
double	et () const
double	pt () const
double	iPt () const
double	sinPhi () const
double	cosPhi () const
double	tanTh () const
double	cosTh () const
double	sinTh () const
double	cotTh () const
CLHEP::HepLorentzVector	hlv () const
std::ostream &	dump (std::ostream &out) const
	Print `I4Momentum` content.

Private Attributes
double	m_e
double	m_eta
double	m_phi
double	m_m
std::unique_ptr< ErrorType >	m_error

Friends
class	P4ImplEEtaPhiMCnv_p1

Detailed Description

P4ImplEEtaPhiM is a base class for classes with 4-momentum behavior, for which E, eta, phi and M are natural parameters, which is typically the case for a calorimeter object.

Any class deriving from it should implement e(), eta(), phi(), m().

Author: David Rousseau rouss.nosp@m.eau@.nosp@m.lal.i.nosp@m.n2p3.nosp@m..fr; Sebastien Binet binet.nosp@m.@cer.nosp@m.n.ch

Definition at line 39 of file P4ImplEEtaPhiM.h.

Member Typedef Documentation

◆ ErrorType

typedef FourMomentumError< P4ImplEEtaPhiM> P4ImplEEtaPhiM::ErrorType

Definition at line 45 of file P4ImplEEtaPhiM.h.

Constructor & Destructor Documentation

◆ P4ImplEEtaPhiM() [1/6]

P4ImplEEtaPhiM::P4ImplEEtaPhiM ( )

inline

Default constructor:

Definition at line 132 of file P4ImplEEtaPhiM.h.

                                       :
  P4BaseEEtaPhiM( ),
  m_e  ( 0.*CLHEP::GeV ),
  m_eta( 0. ),
  m_phi( 0. ),
  m_m  ( 0.*CLHEP::GeV ),
  m_error(nullptr)
{}

◆ P4ImplEEtaPhiM() [2/6]

P4ImplEEtaPhiM::P4ImplEEtaPhiM ( const P4ImplEEtaPhiM & rhs )

inlineexplicit

Copy constructor.

Definition at line 141 of file P4ImplEEtaPhiM.h.

                                                                 :
  P4BaseEEtaPhiM( ),
  m_e  ( rhs.m_e ),
  m_eta( rhs.m_eta ),
  m_phi( rhs.m_phi ),
  m_m  ( rhs.m_m ),
  m_error(nullptr)
{}

◆ P4ImplEEtaPhiM() [3/6]

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

inline

constructor with all data members

Definition at line 150 of file P4ImplEEtaPhiM.h.

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

◆ P4ImplEEtaPhiM() [4/6]

P4ImplEEtaPhiM::P4ImplEEtaPhiM ( const CLHEP::HepLorentzVector & hlv )

inlineexplicit

constructor from hlv to allow conversion from hlv

Definition at line 165 of file P4ImplEEtaPhiM.h.

                                                                        :
  P4BaseEEtaPhiM( ),
  m_e  ( hlv.e()   ),
  m_eta( hlv.eta() ),
  m_phi( hlv.phi() ),
  m_m  ( hlv.m()   ),
  m_error(nullptr)
{}

◆ P4ImplEEtaPhiM() [5/6]

P4ImplEEtaPhiM::P4ImplEEtaPhiM ( const I4Momentum & theI4M )

inlineexplicit

constructor from any I4Momentum reference

Definition at line 174 of file P4ImplEEtaPhiM.h.

                                                               :
  P4BaseEEtaPhiM( ),
  m_e  ( i4mom.e()   ),
  m_eta( i4mom.eta() ),
  m_phi( i4mom.phi() ),
  m_m  ( i4mom.m()   ),
  m_error(nullptr)
{}

◆ P4ImplEEtaPhiM() [6/6]

P4ImplEEtaPhiM::P4ImplEEtaPhiM ( const I4Momentum *const theI4M )

inlineexplicit

constructor from any I4Momentum pointer

Definition at line 183 of file P4ImplEEtaPhiM.h.

                                                                      :
  P4BaseEEtaPhiM( ),
  m_e  ( i4Mom->e()   ),
  m_eta( i4Mom->eta() ),
  m_phi( i4Mom->phi() ),
  m_m  ( i4Mom->m()   ),
  m_error(nullptr)
{}

◆ ~P4ImplEEtaPhiM()

P4ImplEEtaPhiM::~P4ImplEEtaPhiM ( )

inlinevirtual

virtual destructor needed by pool

Definition at line 192 of file P4ImplEEtaPhiM.h.

193{

194}

Member Function Documentation

◆ cosPhi()

double P4BaseEEtaPhiM::cosPhi ( ) const

inlineinherited

Definition at line 166 of file P4BaseEEtaPhiM.h.

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

◆ cosTh()

double P4BaseEEtaPhiM::cosTh ( ) const

inlineinherited

Definition at line 187 of file P4BaseEEtaPhiM.h.

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

◆ cotTh()

double P4BaseEEtaPhiM::cotTh ( ) const

inlineinherited

Definition at line 204 of file P4BaseEEtaPhiM.h.

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

◆ dump()

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

inlineinherited

Print I4Momentum content.

Definition at line 231 of file P4BaseEEtaPhiM.h.

{
  std::stringstream s;
  s << "[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 << s.str();
  return out;
 
}

◆ e()

double P4ImplEEtaPhiM::e ( ) const

inlinevirtual

Implements P4BaseEEtaPhiM.

Definition at line 211 of file P4ImplEEtaPhiM.h.

{ 
  return m_e;
}

◆ errors()

const I4MomentumError * P4ImplEEtaPhiM::errors ( ) const

inlinevirtual

Reimplemented in P4Impl< P4ImplEEtaPhiM >.

Definition at line 216 of file P4ImplEEtaPhiM.h.

{
  return m_error.get();
}

◆ et()

double P4BaseEEtaPhiM::et ( ) const

inlineinherited

Definition at line 144 of file P4BaseEEtaPhiM.h.

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

◆ eta()

double P4ImplEEtaPhiM::eta ( void ) const

inlinevirtual

Implements P4BaseEEtaPhiM.

Definition at line 201 of file P4ImplEEtaPhiM.h.

{ 
  return m_eta;
}

◆ hlv()

CLHEP::HepLorentzVector P4BaseEEtaPhiM::hlv ( ) const

inlineinherited

Definition at line 209 of file P4BaseEEtaPhiM.h.

{
  //minimize the number of calculation and dereference
  const double theE = this->e();
  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,theE);
}

◆ iPt()

double P4BaseEEtaPhiM::iPt ( ) const

inlineinherited

Definition at line 161 of file P4BaseEEtaPhiM.h.

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

◆ kind()

I4Momentum::Kind P4ImplEEtaPhiM::kind ( ) const

inline

Definition at line 88 of file P4ImplEEtaPhiM.h.

88{ return I4Momentum::P4EETAPHIM; };

I4Momentum::P4EETAPHIM

@ P4EETAPHIM

Definition I4Momentum.h:33

◆ m()

double P4ImplEEtaPhiM::m ( void ) const

inlinevirtual

{@ a la I4Momentum -like interface

Implements P4BaseEEtaPhiM.

Definition at line 196 of file P4ImplEEtaPhiM.h.

{
  return m_m;
}

◆ m2()

double P4BaseEEtaPhiM::m2 ( ) const

inlineinherited

Definition at line 105 of file P4BaseEEtaPhiM.h.

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

◆ operator=()

P4ImplEEtaPhiM & P4ImplEEtaPhiM::operator= ( const P4ImplEEtaPhiM & rhs )

Assignment operator.

Definition at line 14 of file P4ImplEEtaPhiM.cxx.

{
  if ( this != &rhs ) {
    m_e   = rhs.m_e;
    m_eta = rhs.m_eta;
    m_phi = rhs.m_phi;
    m_m   = rhs.m_m;
  }
  return *this;
}

◆ p()

double P4BaseEEtaPhiM::p ( ) const

inlineinherited

Definition at line 111 of file P4BaseEEtaPhiM.h.

{ 
  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 P4BaseEEtaPhiM::p2 ( ) const

inlineinherited

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.

Definition at line 129 of file P4BaseEEtaPhiM.h.

{ 
  const double mass = this->m();
  const double ene  = this->e();
  
  return ene*ene - mass*mass;
}

◆ phi()

double P4ImplEEtaPhiM::phi ( void ) const

inlinevirtual

Implements P4BaseEEtaPhiM.

Definition at line 206 of file P4ImplEEtaPhiM.h.

{ 
  return m_phi;
}

◆ pt()

double P4BaseEEtaPhiM::pt ( void ) const

inlineinherited

Definition at line 156 of file P4BaseEEtaPhiM.h.

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

◆ px()

double P4BaseEEtaPhiM::px ( ) const

inlineinherited

{@ a la I4Momentum -like interface

Definition at line 90 of file P4BaseEEtaPhiM.h.

{ 
  return this->pt()*cos(this->phi());
}

◆ py()

double P4BaseEEtaPhiM::py ( ) const

inlineinherited

Definition at line 95 of file P4BaseEEtaPhiM.h.

{ 
  return this->pt()*sin(this->phi());
}

◆ pz()

double P4BaseEEtaPhiM::pz ( ) const

inlineinherited

Definition at line 100 of file P4BaseEEtaPhiM.h.

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

◆ rapidity()

double P4BaseEEtaPhiM::rapidity ( ) const

inlineinherited

Definition at line 149 of file P4BaseEEtaPhiM.h.

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

◆ set4Mom() [1/3]

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

inline

set all 4-mom from CLHEP HepLorentzVector

Definition at line 254 of file P4ImplEEtaPhiM.h.

{
  m_e   = hlv.e();
  m_eta = hlv.eta();
  //FIXME protect against negative energy
  //assert(m_e >= 0,"P4::Impl::EEtaPhiM::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 = hlv.phi();
  m_m   = hlv.m();
}

◆ set4Mom() [2/3]

void P4ImplEEtaPhiM::set4Mom ( const I4Momentum & theI4Mom )

inline

set all 4-mom from another I4Momentum reference

Definition at line 241 of file P4ImplEEtaPhiM.h.

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

◆ set4Mom() [3/3]

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

inline

set all 4-mom from another I4Momentum pointer

Definition at line 249 of file P4ImplEEtaPhiM.h.

{
  this->set4Mom(*theI4Mom);
}

◆ setE()

void P4ImplEEtaPhiM::setE ( const double theE )

inline

set energy data member

Definition at line 221 of file P4ImplEEtaPhiM.h.

{ 
  m_e = theE;
}

◆ setErrors()

void P4ImplEEtaPhiM::setErrors ( const ErrorMatrixEEtaPhiM & err )

inline

set the errors

Definition at line 269 of file P4ImplEEtaPhiM.h.

{
  //  if (m_error != 0) delete m_error;
  //  if (err != 0) m_error = new FourMomentumError(*err);
  //  else m_error = 0;
 
  m_error = std::make_unique< ErrorType>(err, *this);
}

◆ setEta()

void P4ImplEEtaPhiM::setEta ( const double theEta )

inline

set eta data member

Definition at line 226 of file P4ImplEEtaPhiM.h.

{ 
  m_eta = theEta;
}

◆ setM()

void P4ImplEEtaPhiM::setM ( const double theM )

inline

set mass data member

Definition at line 236 of file P4ImplEEtaPhiM.h.

{ 
  m_m = theM;
}

◆ setPhi()

void P4ImplEEtaPhiM::setPhi ( const double thePhi )

inline

set phi data member

Definition at line 231 of file P4ImplEEtaPhiM.h.

{ 
  m_phi = thePhi;
}

◆ sinPhi()

double P4BaseEEtaPhiM::sinPhi ( ) const

inlineinherited

Definition at line 171 of file P4BaseEEtaPhiM.h.

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

◆ sinTh()

double P4BaseEEtaPhiM::sinTh ( ) const

inlineinherited

Definition at line 192 of file P4BaseEEtaPhiM.h.

{ 
  // 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 P4BaseEEtaPhiM::tanTh ( ) const

inlineinherited

Definition at line 177 of file P4BaseEEtaPhiM.h.

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

◆ P4ImplEEtaPhiMCnv_p1

friend class P4ImplEEtaPhiMCnv_p1

friend

Definition at line 41 of file P4ImplEEtaPhiM.h.

Member Data Documentation

◆ m_e

double P4ImplEEtaPhiM::m_e

private

Definition at line 120 of file P4ImplEEtaPhiM.h.

◆ m_error

std::unique_ptr< ErrorType> P4ImplEEtaPhiM::m_error

private

Definition at line 124 of file P4ImplEEtaPhiM.h.

◆ m_eta

double P4ImplEEtaPhiM::m_eta

private

Definition at line 121 of file P4ImplEEtaPhiM.h.

◆ m_m

double P4ImplEEtaPhiM::m_m

private

Definition at line 123 of file P4ImplEEtaPhiM.h.

◆ m_phi

double P4ImplEEtaPhiM::m_phi

private

Definition at line 122 of file P4ImplEEtaPhiM.h.

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

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ErrorType

Constructor & Destructor Documentation

◆ P4ImplEEtaPhiM() [1/6]

◆ P4ImplEEtaPhiM() [2/6]

◆ P4ImplEEtaPhiM() [3/6]

◆ P4ImplEEtaPhiM() [4/6]

◆ P4ImplEEtaPhiM() [5/6]

◆ P4ImplEEtaPhiM() [6/6]

◆ ~P4ImplEEtaPhiM()

Member Function Documentation

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ dump()

◆ e()

◆ errors()

◆ et()

◆ eta()

◆ hlv()

◆ iPt()

◆ kind()

◆ m()

◆ m2()

◆ operator=()

◆ p()

◆ p2()

◆ phi()

◆ pt()

◆ px()

◆ py()

◆ pz()

◆ rapidity()

◆ set4Mom() [1/3]

◆ set4Mom() [2/3]

◆ set4Mom() [3/3]

◆ setE()

◆ setErrors()

◆ setEta()

◆ setM()

◆ setPhi()

◆ sinPhi()

◆ sinTh()

◆ tanTh()

Friends And Related Symbol Documentation

◆ P4ImplEEtaPhiMCnv_p1

Member Data Documentation

◆ m_e

◆ m_error

◆ m_eta

◆ m_m

◆ m_phi