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

#include <P4ImplPtEtaPhiM.h>

Inheritance diagram for P4ImplPtEtaPhiM:

Collaboration diagram for P4ImplPtEtaPhiM:

Public Types
typedef FourMomentumError< P4ImplPtEtaPhiM >	ErrorType

Public Member Functions
	P4ImplPtEtaPhiM ()
	Default constructor:
	P4ImplPtEtaPhiM (const P4ImplPtEtaPhiM &rhs)
	Copy constructor.
P4ImplPtEtaPhiM &	operator= (const P4ImplPtEtaPhiM &rhs)
	Assignment operator.
	P4ImplPtEtaPhiM (const double pt, const double eta, const double phi, const double m)
	constructor with all data members
	P4ImplPtEtaPhiM (const CLHEP::HepLorentzVector &hlv)
	constructor from hlv to allow conversion from hlv
	P4ImplPtEtaPhiM (const I4Momentum &theI4M)
	constructor from any I4Momentum reference
	P4ImplPtEtaPhiM (const I4Momentum *const theI4M)
	constructor from any I4Momentum pointer
virtual	~P4ImplPtEtaPhiM ()
	virtual destructor needed by pool
double	m () const
	{@ a la `I4Momentum` -like interface
double	eta () const
double	phi () const
double	pt () const
virtual const I4MomentumError *	errors () const
I4Momentum::Kind	kind () const
void	setPt (const double thePt)
	set pt 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	setErrors (const ErrorMatrixPtEtaPhiM &err)
	set the errors
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
double	px () const
	{@ a la `I4Momentum` -like interface
double	py () const
double	pz () const
double	m2 () const
double	p () const
double	p2 () const
double	e () const
double	et () const
double	iPt () const
double	rapidity () const
double	cosPhi () const
double	sinPhi () 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_pt
double	m_eta
double	m_phi
double	m_m
std::unique_ptr< ErrorType >	m_error

Friends
class	P4ImplPtEtaPhiMCnv_p1

Detailed Description

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

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

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

Definition at line 40 of file P4ImplPtEtaPhiM.h.

Member Typedef Documentation

◆ ErrorType

typedef FourMomentumError< P4ImplPtEtaPhiM> P4ImplPtEtaPhiM::ErrorType

Definition at line 46 of file P4ImplPtEtaPhiM.h.

Constructor & Destructor Documentation

◆ P4ImplPtEtaPhiM() [1/6]

P4ImplPtEtaPhiM::P4ImplPtEtaPhiM ( )

inline

Default constructor:

Definition at line 134 of file P4ImplPtEtaPhiM.h.

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

◆ P4ImplPtEtaPhiM() [2/6]

P4ImplPtEtaPhiM::P4ImplPtEtaPhiM ( const P4ImplPtEtaPhiM & rhs )

inlineexplicit

Copy constructor.

Definition at line 143 of file P4ImplPtEtaPhiM.h.

                                                                    :
  P4BasePtEtaPhiM( ),
  m_pt ( rhs.m_pt  ),
  m_eta( rhs.m_eta ),
  m_phi( rhs.m_phi ),
  m_m  ( rhs.m_m   ),
  m_error(nullptr)
{}

◆ P4ImplPtEtaPhiM() [3/6]

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

inline

constructor with all data members

Definition at line 152 of file P4ImplPtEtaPhiM.h.

                                                        :
  P4BasePtEtaPhiM( ),
  m_pt ( pt  ),
  m_eta( eta ),
  m_phi( phi ),
  m_m  ( m   ),
  m_error(nullptr)
{}

◆ P4ImplPtEtaPhiM() [4/6]

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

inline

constructor from hlv to allow conversion from hlv

Definition at line 162 of file P4ImplPtEtaPhiM.h.

                                                                          :
  P4BasePtEtaPhiM(  ),
  m_pt ( hlv.perp() ),
  m_eta( hlv.eta()  ),
  m_phi( hlv.phi()  ),
  m_m  ( hlv.m()    ),
  m_error(nullptr)
{}

◆ P4ImplPtEtaPhiM() [5/6]

P4ImplPtEtaPhiM::P4ImplPtEtaPhiM ( const I4Momentum & theI4M )

inlineexplicit

constructor from any I4Momentum reference

Definition at line 171 of file P4ImplPtEtaPhiM.h.

                                                                 :
  P4BasePtEtaPhiM(   ),
  m_pt ( i4mom.pt()  ),
  m_eta( i4mom.eta() ),
  m_phi( i4mom.phi() ),
  m_m  ( i4mom.m()   ),
  m_error(nullptr)
{}

◆ P4ImplPtEtaPhiM() [6/6]

P4ImplPtEtaPhiM::P4ImplPtEtaPhiM ( const I4Momentum *const theI4M )

inlineexplicit

constructor from any I4Momentum pointer

Definition at line 180 of file P4ImplPtEtaPhiM.h.

                                                                        :
  P4BasePtEtaPhiM(    ),
  m_pt ( i4Mom->pt()  ),
  m_eta( i4Mom->eta() ),
  m_phi( i4Mom->phi() ),
  m_m  ( i4Mom->m()   ),
  m_error(nullptr)
{}

◆ ~P4ImplPtEtaPhiM()

P4ImplPtEtaPhiM::~P4ImplPtEtaPhiM ( )

inlinevirtual

virtual destructor needed by pool

Definition at line 189 of file P4ImplPtEtaPhiM.h.

190{}

Member Function Documentation

◆ cosPhi()

double P4BasePtEtaPhiM::cosPhi ( ) const

inlineinherited

Definition at line 172 of file P4BasePtEtaPhiM.h.

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

◆ cosTh()

double P4BasePtEtaPhiM::cosTh ( ) const

inlineinherited

Definition at line 184 of file P4BasePtEtaPhiM.h.

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

◆ cotTh()

double P4BasePtEtaPhiM::cotTh ( ) const

inlineinherited

Definition at line 201 of file P4BasePtEtaPhiM.h.

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

◆ dump()

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

inlineinherited

Print I4Momentum content.

Definition at line 236 of file P4BasePtEtaPhiM.h.

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

◆ e()

double P4BasePtEtaPhiM::e ( ) const

inlineinherited

Definition at line 141 of file P4BasePtEtaPhiM.h.

{
  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 !!!
 
  const double eSign = (thePt >= 0.) ? +1. : -1.;
  return eSign * std::sqrt( thePt*thePt + thePz*thePz +  theMass*theMass);
}

◆ errors()

const I4MomentumError * P4ImplPtEtaPhiM::errors ( ) const

inlinevirtual

Reimplemented in P4Impl< P4ImplPtEtaPhiM >.

Definition at line 212 of file P4ImplPtEtaPhiM.h.

{
  // check if the pointer is empty before dereferencing
  return m_error.get();
}

◆ et()

double P4BasePtEtaPhiM::et ( ) const

inlineinherited

Definition at line 155 of file P4BasePtEtaPhiM.h.

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

◆ eta()

double P4ImplPtEtaPhiM::eta ( void ) const

inlinevirtual

Implements P4BasePtEtaPhiM.

Definition at line 197 of file P4ImplPtEtaPhiM.h.

{ 
  return m_eta;
}

◆ hlv()

CLHEP::HepLorentzVector P4BasePtEtaPhiM::hlv ( ) const

inlineinherited

Definition at line 217 of file P4BasePtEtaPhiM.h.

{
  //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 P4BasePtEtaPhiM::iPt ( ) const

inlineinherited

Definition at line 160 of file P4BasePtEtaPhiM.h.

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

◆ kind()

I4Momentum::Kind P4ImplPtEtaPhiM::kind ( ) const

inline

Definition at line 89 of file P4ImplPtEtaPhiM.h.

89{ return I4Momentum::P4PTETAPHIM; }

I4Momentum::P4PTETAPHIM

@ P4PTETAPHIM

Definition I4Momentum.h:33

◆ m()

double P4ImplPtEtaPhiM::m ( void ) const

inlinevirtual

{@ a la I4Momentum -like interface

Implements P4BasePtEtaPhiM.

Definition at line 192 of file P4ImplPtEtaPhiM.h.

{ 
  return m_m;
}

◆ m2()

double P4BasePtEtaPhiM::m2 ( ) const

inlineinherited

Definition at line 110 of file P4BasePtEtaPhiM.h.

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

◆ operator=()

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

Assignment operator.

Definition at line 14 of file P4ImplPtEtaPhiM.cxx.

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

◆ p()

double P4BasePtEtaPhiM::p ( ) const

inlineinherited

Definition at line 116 of file P4BasePtEtaPhiM.h.

{ 
  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 !!!
 
  const double eSign = (thePt >= 0.) ? +1. : -1.;
  return eSign * std::sqrt( thePt*thePt + thePz*thePz );
}

◆ p2()

double P4BasePtEtaPhiM::p2 ( ) const

inlineinherited

Definition at line 129 of file P4BasePtEtaPhiM.h.

{ 
  // 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 pt = this->pt();
  const double pz = this->pz();
 
  return pt*pt + pz*pz;
}

◆ phi()

double P4ImplPtEtaPhiM::phi ( void ) const

inlinevirtual

Implements P4BasePtEtaPhiM.

Definition at line 202 of file P4ImplPtEtaPhiM.h.

{ 
  return m_phi;
}

◆ pt()

double P4ImplPtEtaPhiM::pt ( void ) const

inlinevirtual

Implements P4BasePtEtaPhiM.

Definition at line 207 of file P4ImplPtEtaPhiM.h.

{ 
  return m_pt;
}

◆ px()

double P4BasePtEtaPhiM::px ( ) const

inlineinherited

{@ a la I4Momentum -like interface

Definition at line 95 of file P4BasePtEtaPhiM.h.

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

◆ py()

double P4BasePtEtaPhiM::py ( ) const

inlineinherited

Definition at line 100 of file P4BasePtEtaPhiM.h.

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

◆ pz()

double P4BasePtEtaPhiM::pz ( ) const

inlineinherited

Definition at line 105 of file P4BasePtEtaPhiM.h.

{ 
  return this->pt()/this->tanTh();
}

◆ rapidity()

double P4BasePtEtaPhiM::rapidity ( ) const

inlineinherited

Definition at line 165 of file P4BasePtEtaPhiM.h.

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

◆ set4Mom() [1/3]

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

inline

set all 4-mom from CLHEP HepLorentzVector

Definition at line 253 of file P4ImplPtEtaPhiM.h.

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

inline

set all 4-mom from another I4Momentum reference

Definition at line 240 of file P4ImplPtEtaPhiM.h.

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

◆ set4Mom() [3/3]

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

inline

set all 4-mom from another I4Momentum pointer

Definition at line 248 of file P4ImplPtEtaPhiM.h.

{
  this->set4Mom(*theI4Mom);
}

◆ setErrors()

void P4ImplPtEtaPhiM::setErrors ( const ErrorMatrixPtEtaPhiM & err )

inline

set the errors

Definition at line 267 of file P4ImplPtEtaPhiM.h.

{
  m_error = std::make_unique< ErrorType>(err, *this);
}

◆ setEta()

void P4ImplPtEtaPhiM::setEta ( const double theEta )

inline

set eta data member

Definition at line 225 of file P4ImplPtEtaPhiM.h.

{ 
  m_eta = theEta;
}

◆ setM()

void P4ImplPtEtaPhiM::setM ( const double theM )

inline

set mass data member

Definition at line 235 of file P4ImplPtEtaPhiM.h.

{ 
  m_m = theM;
}

◆ setPhi()

void P4ImplPtEtaPhiM::setPhi ( const double thePhi )

inline

set phi data member

Definition at line 230 of file P4ImplPtEtaPhiM.h.

{ 
  m_phi = thePhi;
}

◆ setPt()

void P4ImplPtEtaPhiM::setPt ( const double thePt )

inline

set pt data member

Definition at line 220 of file P4ImplPtEtaPhiM.h.

{ 
  m_pt = thePt;
}

◆ sinPhi()

double P4BasePtEtaPhiM::sinPhi ( ) const

inlineinherited

Definition at line 177 of file P4BasePtEtaPhiM.h.

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

◆ sinTh()

double P4BasePtEtaPhiM::sinTh ( ) const

inlineinherited

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

inlineinherited

Definition at line 206 of file P4BasePtEtaPhiM.h.

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

◆ P4ImplPtEtaPhiMCnv_p1

friend class P4ImplPtEtaPhiMCnv_p1

friend

Definition at line 42 of file P4ImplPtEtaPhiM.h.

Member Data Documentation

◆ m_error

std::unique_ptr< ErrorType> P4ImplPtEtaPhiM::m_error

private

Definition at line 126 of file P4ImplPtEtaPhiM.h.

◆ m_eta

double P4ImplPtEtaPhiM::m_eta

private

Definition at line 123 of file P4ImplPtEtaPhiM.h.

◆ m_m

double P4ImplPtEtaPhiM::m_m

private

Definition at line 125 of file P4ImplPtEtaPhiM.h.

◆ m_phi

double P4ImplPtEtaPhiM::m_phi

private

Definition at line 124 of file P4ImplPtEtaPhiM.h.

◆ m_pt

double P4ImplPtEtaPhiM::m_pt

private

Definition at line 122 of file P4ImplPtEtaPhiM.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

◆ P4ImplPtEtaPhiM() [1/6]

◆ P4ImplPtEtaPhiM() [2/6]

◆ P4ImplPtEtaPhiM() [3/6]

◆ P4ImplPtEtaPhiM() [4/6]

◆ P4ImplPtEtaPhiM() [5/6]

◆ P4ImplPtEtaPhiM() [6/6]

◆ ~P4ImplPtEtaPhiM()

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]

◆ setErrors()

◆ setEta()

◆ setM()

◆ setPhi()

◆ setPt()

◆ sinPhi()

◆ sinTh()

◆ tanTh()

Friends And Related Symbol Documentation

◆ P4ImplPtEtaPhiMCnv_p1

Member Data Documentation

◆ m_error

◆ m_eta

◆ m_m

◆ m_phi

◆ m_pt