Evaluate cell kinematics with a different vertex. More...

#include <CaloVertexedCell.h>

Inheritance diagram for CaloVertexedCell:

Collaboration diagram for CaloVertexedCell:

Classes
struct	compE
	Helper to compare two of these objects by energy. More...

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

Public Member Functions
	CaloVertexedCell (const CaloCell &cell)
	Constructor. More...

	CaloVertexedCell (const CaloCell &cell, const Amg::Vector3D &vx)
	Constructor. More...

const CaloCell &	cell () const
	Return the cell being proxied,. More...

virtual double	eta () const final
	The pseudorapidity of the particle. More...

virtual double	phi () const final
	The aximuthal angle of the particle. More...

virtual double	e () const final
	The energy of the particle. More...

virtual double	m () const final
	The mass of the particle. More...

virtual double	sinTh () const final
	The sine of the polar angle of the particle. More...

virtual double	cosTh () const final
	The cosine of the polar angle of the particle. More...

virtual double	sinPhi () const final
	The sine of the azimuthal angle of the particle. More...

virtual double	cosPhi () const final
	The cosine of the azimuthal angle of the particle. More...

double	energy () const
	The energy of the particle. More...

virtual double	px () const
	x component of momentum More...

virtual double	py () const
	y component of momentum More...

virtual double	pz () const
	z component of momentum More...

virtual double	et () const
	transverse energy defined to be e*sin(theta) More...

virtual double	p () const
	magnitude of 3-momentum. More...

virtual double	p2 () const
	square of momentum magnitude More...

virtual double	m2 () const
	mass squared More...

virtual double	pt () const
	transverse momentum More...

virtual double	iPt () const
	inverse of transverse momentum More...

virtual double	rapidity () const
	rapidity More...

virtual double	cotTh () const
	cottan theta More...

virtual double	tanTh () const
	tan theta More...

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 More...

virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors. More...

virtual void	set4Mom (const I4Momentum &theI4Mom)
	set all 4-mom from another I4Momentum reference DUMMY IMPLEMENTATION More...

virtual void	set4Mom (const I4Momentum *const theI4Mom)
	set all 4-mom from another I4Momentum pointer DUMMY IMPLEMENTATION More...

virtual void	set4Mom (const CLHEP::HepLorentzVector &theHlv)
	set all 4-mom from a CLHEP HepLorentzVector DUMMY IMPLEMENTATION More...

I4Momentum::Kind	kind () const
	tells what kind of P4XYZT this is More...

virtual std::ostream &	dump (std::ostream &out=std::cout) const
	Print `I4Momentum` content. More...

Private Member Functions
void	computeVertexCorr (const Amg::Vector3D &vx)
	Calculate cell kinematics for a given vertex. More...

Private Attributes
const CaloCell *	m_cell
	The cell being proxied. More...

double	m_eta
	The recalculated cell eta. More...

double	m_phi
	The recalculated cell phi. More...

double	m_sinth
	The recalculated cell sin(theta). More...

double	m_costh
	The recalculated cell cos(theta). More...

double	m_sinph
	The recalculated cell sin(phi). More...

double	m_cosph
	The recalculated cell cos(phi). More...

Detailed Description

Evaluate cell kinematics with a different vertex.

This class acts as a proxy for a cell object. It the same I4Momentum interface, except that the cell kinematics are recalculated for a different vertex.

Definition at line 35 of file CaloVertexedCell.h.

Member Enumeration Documentation

◆ Kind

enum I4Momentum::Kind

inherited

Enumerator
P4EETAPHIM
P4IPTCOTTHPHIM
P4PTETAPHIM
P4PXPYPZE
UNKNOWN

Definition at line 33 of file I4Momentum.h.

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

Constructor & Destructor Documentation

◆ CaloVertexedCell() [1/2]

CaloVertexedCell::CaloVertexedCell ( const CaloCell & cell )

Constructor.

Parameters

cell	The cell to proxy.

In this case, we'll return unchanged the kinematics of the cell.

Definition at line 24 of file CaloVertexedCell.cxx.

   : m_cell (&cell),
     m_eta (cell.eta()),
     m_phi (cell.phi()),
     m_sinth (cell.sinTh()),
     m_costh (cell.cosTh()),
     m_sinph (cell.sinPhi()),
     m_cosph (cell.cosPhi())
 {
 }

◆ CaloVertexedCell() [2/2]

CaloVertexedCell::CaloVertexedCell	(	const CaloCell &	cell,
		const Amg::Vector3D &	vx
	)

Constructor.

Parameters

cell	The cell to proxy.
vx	The vertex to use for calculating cell kinematics.

In this case, we'll return the kinematics of the cell relative to vertex vx.

Definition at line 44 of file CaloVertexedCell.cxx.

   : m_cell (&cell),
     m_eta (cell.eta()),
     m_phi (cell.phi()),
     m_sinth (cell.sinTh()),
     m_costh (cell.cosTh()),
     m_sinph (cell.sinPhi()),
     m_cosph (cell.cosPhi())
 {
   computeVertexCorr (vx);
 }

Member Function Documentation

◆ cell()

const CaloCell& CaloVertexedCell::cell ( ) const

inline

Return the cell being proxied,.

Definition at line 62 of file CaloVertexedCell.h.

62 { return *m_cell; }

◆ computeVertexCorr()

void CaloVertexedCell::computeVertexCorr ( const Amg::Vector3D & vx )

private

Calculate cell kinematics for a given vertex.

Parameters

vx	The vertex to use for calculating cell kinematics.

Definition at line 63 of file CaloVertexedCell.cxx.

 {
   const CaloDetDescrElement& dd = *m_cell->caloDDE();
   m_eta += ((vx.x()*dd.cosPhi()+vx.y()*dd.sinPhi())*dd.cosTh()-vx.z()*dd.sinTh())/dd.r();
   m_phi += (vx.x()*dd.sinPhi()-vx.y()*dd.cosPhi())/dd.r() ;
  
   m_sinth += (vx.z()*dd.sinTh() - (vx.x()*dd.cosPhi() + vx.y()*dd.sinPhi())*dd.cosTh()) * dd.cosTh()*dd.sinTh()/dd.r();
   m_costh += - (vx.z()*dd.sinTh() - (vx.x()*dd.cosPhi() + vx.y()*dd.sinPhi())*dd.cosTh()) * dd.sinTh()*dd.sinTh()/dd.r();
  
   m_sinph += - ( vx.y()*dd.cosPhi() - vx.x()*dd.sinPhi())*dd.cosPhi()/dd.r();
   m_cosph += + ( vx.y()*dd.cosPhi() - vx.x()*dd.sinPhi())*dd.sinPhi()/dd.r();
 }

◆ cosPhi()

virtual double CaloVertexedCell::cosPhi ( ) const

inlinefinalvirtual

The cosine of the azimuthal angle of the particle.

Reimplemented from P4EEtaPhiMBase.

Definition at line 86 of file CaloVertexedCell.h.

86 { return m_cosph; }

◆ cosTh()

virtual double CaloVertexedCell::cosTh ( ) const

inlinefinalvirtual

The cosine of the polar angle of the particle.

Reimplemented from P4EEtaPhiMBase.

Definition at line 80 of file CaloVertexedCell.h.

80 { return m_costh; }

◆ 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()

virtual double CaloVertexedCell::e ( ) const

inlinefinalvirtual

The energy of the particle.

Implements I4Momentum.

Definition at line 71 of file CaloVertexedCell.h.

71 { return m_cell->e(); }

◆ energy()

double CaloVertexedCell::energy ( ) const

inline

The energy of the particle.

Definition at line 89 of file CaloVertexedCell.h.

89 { return m_cell->energy(); }

◆ errors()

const I4MomentumError * P4EEtaPhiMBase::errors ( ) const

virtualinherited

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

Implements I4Momentum.

Reimplemented in P4EEtaPhiM.

Definition at line 175 of file P4EEtaPhiMBase.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()

virtual double CaloVertexedCell::eta ( ) const

inlinefinalvirtual

The pseudorapidity of the particle.

Implements I4Momentum.

Definition at line 65 of file CaloVertexedCell.h.

65 { 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.

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

113 }

◆ kind()

I4Momentum::Kind P4EEtaPhiMBase::kind ( ) const

inlinevirtualinherited

tells what kind of P4XYZT this is

Implements I4Momentum.

Definition at line 65 of file P4EEtaPhiMBase.h.

65 { return I4Momentum::P4EETAPHIM; };

◆ m()

virtual double CaloVertexedCell::m ( ) const

inlinefinalvirtual

The mass of the particle.

Implements I4Momentum.

Definition at line 74 of file CaloVertexedCell.h.

74 { return m_cell->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()

virtual double CaloVertexedCell::phi ( ) const

inlinefinalvirtual

The aximuthal angle of the particle.

Implements I4Momentum.

Definition at line 68 of file CaloVertexedCell.h.

68 { 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.

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

124 }

◆ py()

double P4EEtaPhiMBase::py ( ) const

virtualinherited

y component of momentum

Implements I4Momentum.

Definition at line 126 of file P4EEtaPhiMBase.cxx.

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

128 }

◆ pz()

double P4EEtaPhiMBase::pz ( ) const

virtualinherited

z component of momentum

Implements I4Momentum.

Definition at line 130 of file P4EEtaPhiMBase.cxx.

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

132 }

◆ 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 P4EEtaPhiMBase::set4Mom ( const CLHEP::HepLorentzVector & theHlv )

virtualinherited

set all 4-mom from a CLHEP HepLorentzVector DUMMY IMPLEMENTATION

Implements I4Momentum.

Reimplemented in CaloCell, P4EEtaPhiM, and CaloCluster.

Definition at line 194 of file P4EEtaPhiMBase.cxx.

 {
   std::cout << "FATAL ERROR dummy P4EEtaPhiMBase::set4Mom called " << std::endl ;
   std::abort();
 }

◆ set4Mom() [2/3]

void P4EEtaPhiMBase::set4Mom ( const I4Momentum & theI4Mom )

virtualinherited

set all 4-mom from another I4Momentum reference DUMMY IMPLEMENTATION

Implements I4Momentum.

Reimplemented in CaloCell, P4EEtaPhiM, and CaloCluster.

Definition at line 181 of file P4EEtaPhiMBase.cxx.

 { 
   std::cout << "FATAL ERROR dummy P4EEtaPhiMBase::set4Mom called " << std::endl; ;
   std::abort();
 }

◆ set4Mom() [3/3]

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

virtualinherited

set all 4-mom from another I4Momentum pointer DUMMY IMPLEMENTATION

Implements I4Momentum.

Reimplemented in CaloCell, P4EEtaPhiM, and CaloCluster.

Definition at line 187 of file P4EEtaPhiMBase.cxx.

 { 
   std::cout << "FATAL ERROR dummy P4EEtaPhiMBase::set4Mom called " << std::endl ;
   std::abort();
  
 }

◆ sinPhi()

virtual double CaloVertexedCell::sinPhi ( ) const

inlinefinalvirtual

The sine of the azimuthal angle of the particle.

Reimplemented from P4EEtaPhiMBase.

Definition at line 83 of file CaloVertexedCell.h.

83 { return m_sinph; }

◆ sinTh()

virtual double CaloVertexedCell::sinTh ( ) const

inlinefinalvirtual

The sine of the polar angle of the particle.

Reimplemented from P4EEtaPhiMBase.

Definition at line 77 of file CaloVertexedCell.h.

77 { return m_sinth; }

◆ 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_cell

const CaloCell* CaloVertexedCell::m_cell

private

The cell being proxied.

Definition at line 113 of file CaloVertexedCell.h.

◆ m_cosph

double CaloVertexedCell::m_cosph

private

The recalculated cell cos(phi).

Definition at line 131 of file CaloVertexedCell.h.

◆ m_costh

double CaloVertexedCell::m_costh

private

The recalculated cell cos(theta).

Definition at line 125 of file CaloVertexedCell.h.

◆ m_eta

double CaloVertexedCell::m_eta

private

The recalculated cell eta.

Definition at line 116 of file CaloVertexedCell.h.

◆ m_phi

double CaloVertexedCell::m_phi

private

The recalculated cell phi.

Definition at line 119 of file CaloVertexedCell.h.

◆ m_sinph

double CaloVertexedCell::m_sinph

private

The recalculated cell sin(phi).

Definition at line 128 of file CaloVertexedCell.h.

◆ m_sinth

double CaloVertexedCell::m_sinth

private

The recalculated cell sin(theta).

Definition at line 122 of file CaloVertexedCell.h.

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ CaloVertexedCell() [1/2]

◆ CaloVertexedCell() [2/2]

Member Function Documentation

◆ cell()

◆ computeVertexCorr()

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ dump()

◆ e()

◆ energy()

◆ errors()

◆ et()

◆ eta()

◆ hlv()

◆ iPt()

◆ kind()

◆ m()

◆ m2()

◆ p()

◆ p2()

◆ phi()

◆ pt()

◆ px()

◆ py()

◆ pz()

◆ rapidity()

◆ set4Mom() [1/3]

◆ set4Mom() [2/3]

◆ set4Mom() [3/3]

◆ sinPhi()

◆ sinTh()

◆ tanTh()

Member Data Documentation

◆ m_cell

◆ m_cosph

◆ m_costh

◆ m_eta

◆ m_phi

◆ m_sinph

◆ m_sinth