TruthParticleMomentum Class Reference

#include <TruthParticleMomentum.h>

Collaboration diagram for TruthParticleMomentum:

Public Member Functions
	TruthParticleMomentum ()
	Default constructor:
	TruthParticleMomentum (const TruthParticleMomentum &rhs)
	Copy constructor:
TruthParticleMomentum &	operator= (const TruthParticleMomentum &rhs)
	Assignment operator:
	TruthParticleMomentum (const HepMC::FourVector &hlv)
	Constructor with parameters:
virtual	~TruthParticleMomentum ()
	Destructor:
double	px () const
	{@ a la I4Momentum -like interface
double	py () const
double	pz () const
double	m () const
double	m2 () const
double	p () const
double	p2 () const
double	rapidity () const
double	eta () const
double	phi () const
double	e () const
double	et () const
double	pt () const
double	iPt () const
double	sinPhi () const
double	cosPhi () const
double	tanTh () const
double	cotTh () const
double	cosTh () const
double	sinTh () const
CLHEP::HepLorentzVector	hlv () const
const I4MomentumError *	errors () const
I4Momentum::Kind	kind () const
std::ostream &	dump (std::ostream &out) const
	Print I4Momentum content.
virtual void	set4Mom (const I4Momentum *const theI4Mom)
	set 4Momentum (will throw exception if cannot be implemented)
virtual void	set4Mom (const I4Momentum &theI4Mom)
	set 4Momentum (will throw exception if cannot be implemented)
virtual void	set4Mom (const CLHEP::HepLorentzVector &theHlv)
	set 4Momentum (will throw exception if cannot be implemented)
void	set4Mom (const HepMC::FourVector &hlv)
	reset the proxied CLHEP HepLorentzVector

Private Attributes
const HepMC::FourVector *	m_hlv
	The CLHEP::LorentzVector we are proxying (from the HepMC::GenParticle which is also being proxied).

Detailed Description

Definition at line 27 of file TruthParticleMomentum.h.

Constructor & Destructor Documentation

TruthParticleMomentum() [1/3]

TruthParticleMomentum::TruthParticleMomentum

(

)

Default constructor:

Definition at line 28 of file TruthParticleMomentum.cxx.

                                             :
  m_hlv( 0 )
{}

TruthParticleMomentum() [2/3]

TruthParticleMomentum::TruthParticleMomentum

(

const TruthParticleMomentum &

rhs

)

Copy constructor:

Definition at line 32 of file TruthParticleMomentum.cxx.

                                                                               :
  m_hlv( rhs.m_hlv )
{}

TruthParticleMomentum() [3/3]

TruthParticleMomentum::TruthParticleMomentum

(

const HepMC::FourVector &

hlv

)

Constructor with parameters:

Definition at line 46 of file TruthParticleMomentum.cxx.

                                                                         :
  m_hlv( &hlv )
{}

~TruthParticleMomentum()

TruthParticleMomentum::~TruthParticleMomentum ( )

virtual

Destructor:

Definition at line 50 of file TruthParticleMomentum.cxx.

{}

Member Function Documentation

cosPhi()

double TruthParticleMomentum::cosPhi ( ) const

inline

Definition at line 239 of file TruthParticleMomentum.h.

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

cosTh()

double TruthParticleMomentum::cosTh ( ) const

inline

Definition at line 254 of file TruthParticleMomentum.h.

{ 
  return this->pz()/this->p();
}

cotTh()

double TruthParticleMomentum::cotTh ( ) const

inline

Definition at line 264 of file TruthParticleMomentum.h.

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

dump()

std::ostream & TruthParticleMomentum::dump

(

std::ostream &

out

)

const

Print I4Momentum content.

Definition at line 57 of file TruthParticleMomentum.cxx.

{
  std::stringstream buf;
  buf << "[px,py,pz,e] ="
      << std::right << std::scientific << std::setprecision(8) 
      << std::setw(16) << this->px()
      << std::setw(16) << this->py()
      << std::setw(16) << this->pz()
      << std::setw(16) << this->e();
  return out << buf.str();
}

e()

double TruthParticleMomentum::e ( ) const

inline

Definition at line 212 of file TruthParticleMomentum.h.

{ 
  return m_hlv ? m_hlv->e() : 0.*CLHEP::GeV;
}

errors()

const I4MomentumError * TruthParticleMomentum::errors ( ) const

inline

Definition at line 85 of file TruthParticleMomentum.h.

{return 0;}

et()

double TruthParticleMomentum::et ( ) const

inline

Definition at line 217 of file TruthParticleMomentum.h.

{
     //to be improved
  const double theE     = this->e();
  const double theSinTh = this->sinTh();
  
  return theE*theSinTh;
}

eta()

double TruthParticleMomentum::eta ( ) const

inline

Definition at line 189 of file TruthParticleMomentum.h.

{ 
  const double px=this->px();
  const double py=this->py();
  const double pz=this->pz();
  // FIXME: should we use a more underflow-friendly formula:
  //  sqrt(a**2 + b**2) 
  //   => y.sqrt(1+(x/y)**2) where y=max(|a|,|b|) and x=min(|a|,|b|)
  const double p =std::sqrt (px*px + py*py + pz*pz);
  if (p==0.0) return 0.0;
  if (p==+pz) return +std::numeric_limits<double>::infinity();
  if (p==-pz) return -std::numeric_limits<double>::infinity();
  return 0.5*log((p+pz)/(p-pz));
}

hlv()

CLHEP::HepLorentzVector TruthParticleMomentum::hlv ( ) const

inline

Definition at line 269 of file TruthParticleMomentum.h.

{ 
  if(!m_hlv)[[unlikely]]{
    std::cout << " FATAL ERROR : TruthParticleMomentum::hlv called with m_hlv = nullptr. " << std::endl ;
    std::abort();
  }
  return CLHEP::HepLorentzVector(m_hlv->px(), m_hlv->py(),
                 m_hlv->pz(), m_hlv->e() );
}

iPt()

double TruthParticleMomentum::iPt ( ) const

inline

Definition at line 234 of file TruthParticleMomentum.h.

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

kind()

I4Momentum::Kind TruthParticleMomentum::kind ( ) const

inline

Definition at line 88 of file TruthParticleMomentum.h.

{ return I4Momentum::P4PXPYPZE; };

m()

double TruthParticleMomentum::m ( ) const

inline

Definition at line 143 of file TruthParticleMomentum.h.

{
  const double m2 = this->m2();
  return m2 < 0. ? -std::sqrt(-m2) : std::sqrt(m2);
}

m2()

double TruthParticleMomentum::m2 ( ) const

inline

Definition at line 149 of file TruthParticleMomentum.h.

{
  const double thePx = this->px();
  const double thePy = this->py();
  const double thePz = this->pz();
  const double theE  = this->e();
  
  const double theM2= 
    theE*theE - ( thePx*thePx +
          thePy*thePy +
          thePz*thePz );
  
  return theM2;
 
}

operator=()

TruthParticleMomentum & TruthParticleMomentum::operator=

(

const TruthParticleMomentum &

rhs

)

Assignment operator:

Definition at line 38 of file TruthParticleMomentum.cxx.

{
  if ( this != &rhs ) {
    m_hlv = rhs.m_hlv;
  }
  return *this;
}

p()

double TruthParticleMomentum::p ( ) const

inline

Definition at line 165 of file TruthParticleMomentum.h.

{ 
  return std::sqrt( this->p2() );
}

p2()

double TruthParticleMomentum::p2 ( ) const

inline

Definition at line 170 of file TruthParticleMomentum.h.

{ 
  const double px = this->px();
  const double py = this->py();
  const double pz = this->pz();
 
  return px*px + py*py + pz*pz;
}

phi()

double TruthParticleMomentum::phi ( ) const

inline

Definition at line 204 of file TruthParticleMomentum.h.

{ 
  const double thePx = this->px();
  const double thePy = this->py();
  return thePx == 0.0 && thePy == 0.0 ? 0.0 : std::atan2(thePy,thePx);
}

pt()

double TruthParticleMomentum::pt ( ) const

inline

Definition at line 226 of file TruthParticleMomentum.h.

{
  const double thePx = this->px();
  const double thePy = this->py();
  
  return std::sqrt(thePx*thePx+thePy*thePy);
}

px()

double TruthParticleMomentum::px ( ) const

inline

{@ a la I4Momentum -like interface

Definition at line 128 of file TruthParticleMomentum.h.

{ 
  return m_hlv ? m_hlv->px() : 0.*CLHEP::GeV;
}

py()

double TruthParticleMomentum::py ( ) const

inline

Definition at line 133 of file TruthParticleMomentum.h.

{ 
  return m_hlv ? m_hlv->py() : 0.*CLHEP::GeV;
}

pz()

double TruthParticleMomentum::pz ( ) const

inline

Definition at line 138 of file TruthParticleMomentum.h.

{ 
  return m_hlv ? m_hlv->pz() : 0.*CLHEP::GeV;
}

rapidity()

double TruthParticleMomentum::rapidity ( ) const

inline

Definition at line 179 of file TruthParticleMomentum.h.

{ 
  const double e =this->e();
  const double pz=this->pz();
  if (e==0.0) return 0.0;
  if (e==+pz) return +std::numeric_limits<double>::infinity();
  if (e==-pz) return -std::numeric_limits<double>::infinity();
  return 0.5*std::log((e+pz)/(e-pz));
}

set4Mom() [1/4]

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

inlinevirtual

set 4Momentum (will throw exception if cannot be implemented)

Definition at line 295 of file TruthParticleMomentum.h.

{
  std::cout << " FATAL ERROR : TruthParticleMomentum::set4Mom called. Cannot change 4mom " << std::endl ;
  std::abort();
}

set4Mom() [2/4]

void TruthParticleMomentum::set4Mom ( const HepMC::FourVector & hlv )

inline

reset the proxied CLHEP HepLorentzVector

Definition at line 303 of file TruthParticleMomentum.h.

{
  m_hlv = &hlv;
}

set4Mom() [3/4]

void TruthParticleMomentum::set4Mom ( const I4Momentum & theI4Mom )

inlinevirtual

set 4Momentum (will throw exception if cannot be implemented)

Definition at line 279 of file TruthParticleMomentum.h.

{
  std::cout << " FATAL ERROR : TruthParticleMomentum::set4Mom called. Cannot change 4mom " << std::endl ;
  std::abort();
 
  
}

set4Mom() [4/4]

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

inlinevirtual

set 4Momentum (will throw exception if cannot be implemented)

Definition at line 287 of file TruthParticleMomentum.h.

{
  std::cout << " FATAL ERROR : TruthParticleMomentum::set4Mom called. Cannot change 4mom " << std::endl ;
  std::abort();
 
 
}

sinPhi()

double TruthParticleMomentum::sinPhi ( ) const

inline

Definition at line 244 of file TruthParticleMomentum.h.

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

sinTh()

double TruthParticleMomentum::sinTh ( ) const

inline

Definition at line 259 of file TruthParticleMomentum.h.

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

tanTh()

double TruthParticleMomentum::tanTh ( ) const

inline

Definition at line 249 of file TruthParticleMomentum.h.

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

Member Data Documentation

m_hlv

const HepMC::FourVector* TruthParticleMomentum::m_hlv

private

The CLHEP::LorentzVector we are proxying (from the HepMC::GenParticle which is also being proxied).

Definition at line 121 of file TruthParticleMomentum.h.

---

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

• TruthParticleMomentum.h
• TruthParticleMomentum.cxx