base class for kinematics of composite calo object More...

#include <CaloCompositeKineBase.h>

Inheritance diagram for CaloCompositeKineBase:

Collaboration diagram for CaloCompositeKineBase:

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

Public Member Functions
virtual	~CaloCompositeKineBase ()
	Destructor. More...

virtual double	energy () const
	Return energy. More...

double	energy_nonvirt () const
	Return energy (nonvirtual version) More...

void	setRecoStatus (const CaloRecoStatus &recStatus)
	Set the reconstruction status. More...

void	setRecoStatus (const CaloRecoStatus::StatusIndicator &recIndic)
	Set the reconstruction status indicator (recommended) More...

bool	checkRecoStatus (const CaloRecoStatus::StatusIndicator &recIndic) const
	Check if a given indicator is set. More...

void	removeRecoStatus (const CaloRecoStatus::StatusIndicator &recIndic)
	Remove a given indicator. More...

void	removeRecoStatus ()
	Remove all indicators. More...

const CaloRecoStatus &	getRecoStatus () const
	Retrieve the reconstruction status. More...

virtual double	getBasicEnergy () const =0
	Return uncalibrated energy. More...

virtual void	setBasicEnergy (double theEnergy)=0
	Set uncalibrated energy. More...

virtual double	e () const
	get energy data member More...

virtual double	eta () const
	get eta data member More...

virtual double	phi () const
	get phi data member More...

virtual double	m () const
	get mass data member More...

virtual void	setE (double theE)
	set energy data member More...

virtual void	setEta (double theEta)
	set eta data member More...

virtual void	setPhi (double thePhi)
	set phi data member More...

virtual void	setM (double theM)
	set mass data member More...

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

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

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

virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors. 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	cosPhi () const
	cosinus phi More...

virtual double	sinPhi () const
	sinus phi More...

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

virtual double	cosTh () const
	cosinus theta More...

virtual double	sinTh () const
	sinus 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...

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

Protected Member Functions
	CaloCompositeKineBase ()
	Constructor. More...

Protected Attributes
CaloRecoStatus	m_status
	Calorimeter reconstruction status. More...

double	m_e

double	m_eta

double	m_phi

double	m_m

Detailed Description

base class for kinematics of composite calo object

Abstract base class provides a complete interface to all kinematic quantities available for composite calorimeter reconstruction objects. This class basically extends the P4EEtaPhiM base class.

Definition at line 12 of file CaloCompositeKineBase.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

◆ ~CaloCompositeKineBase()

CaloCompositeKineBase::~CaloCompositeKineBase ( )

virtual

Destructor.

Definition at line 13 of file CaloCompositeKineBase.cxx.

14 { }

◆ CaloCompositeKineBase()

CaloCompositeKineBase::CaloCompositeKineBase ( )

protected

Constructor.

All kinematic variables are reset when constructed.

Definition at line 8 of file CaloCompositeKineBase.cxx.

   : P4EEtaPhiM(0.,0.,0.,0.),
     m_status(CaloRecoStatus())
 { }

Member Function Documentation

◆ checkRecoStatus()

bool CaloCompositeKineBase::checkRecoStatus ( const CaloRecoStatus::StatusIndicator & recIndic ) const

inline

Check if a given indicator is set.

Definition at line 91 of file CaloCompositeKineBase.h.

93 { return m_status.checkStatus(recIndic); }

◆ 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

inlinevirtualinherited

get energy data member

Implements I4Momentum.

Reimplemented in CaloTower, and CaloCluster.

Definition at line 102 of file P4EEtaPhiM.h.

103 { return m_e;}

◆ energy()

double CaloCompositeKineBase::energy ( ) const

inlinevirtual

Return energy.

Definition at line 70 of file CaloCompositeKineBase.h.

71 { return this->e(); }

◆ energy_nonvirt()

double CaloCompositeKineBase::energy_nonvirt ( ) const

inline

Return energy (nonvirtual version)

Definition at line 74 of file CaloCompositeKineBase.h.

75 { return this->m_e; }

◆ errors()

const I4MomentumError * P4EEtaPhiM::errors ( ) const

virtualinherited

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

inlinevirtualinherited

get eta data member

Implements I4Momentum.

Reimplemented in CaloTower, and CaloCluster.

Definition at line 105 of file P4EEtaPhiM.h.

106 { return m_eta;}

◆ getBasicEnergy()

virtual double CaloCompositeKineBase::getBasicEnergy ( ) const

pure virtual

Return uncalibrated energy.

Implemented in CaloCluster.

◆ getRecoStatus()

const CaloRecoStatus & CaloCompositeKineBase::getRecoStatus ( ) const

inline

Retrieve the reconstruction status.

Definition at line 78 of file CaloCompositeKineBase.h.

79 { return m_status; }

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

double P4EEtaPhiM::m ( ) const

inlinevirtualinherited

get mass data member

Implements I4Momentum.

Reimplemented in CaloTower, and CaloCluster.

Definition at line 111 of file P4EEtaPhiM.h.

112 { 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 ( ) const

inlinevirtualinherited

get phi data member

Implements I4Momentum.

Reimplemented in CaloTower, and CaloCluster.

Definition at line 108 of file P4EEtaPhiM.h.

109 { 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));
    }

◆ removeRecoStatus() [1/2]

void CaloCompositeKineBase::removeRecoStatus ( )

inline

Remove all indicators.

Definition at line 101 of file CaloCompositeKineBase.h.

102 { m_status.resetStatus(); }

◆ removeRecoStatus() [2/2]

void CaloCompositeKineBase::removeRecoStatus ( const CaloRecoStatus::StatusIndicator & recIndic )

inline

Remove a given indicator.

Definition at line 96 of file CaloCompositeKineBase.h.

98 { m_status.resetStatus(recIndic); }

◆ set4Mom() [1/3]

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

inlinevirtualinherited

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 )

inlinevirtualinherited

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 )

inlinevirtualinherited

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);
 }

◆ setBasicEnergy()

virtual void CaloCompositeKineBase::setBasicEnergy ( double theEnergy )

pure virtual

Set uncalibrated energy.

Parameters

theEnergy basic energy signal

Implemented in CaloCluster.

◆ setE()

void P4EEtaPhiM::setE ( double theE )

inlinevirtualinherited

set energy data member

Reimplemented in CaloCluster.

Definition at line 114 of file P4EEtaPhiM.h.

115 { m_e = theE;}

◆ setEta()

void P4EEtaPhiM::setEta ( double theEta )

inlinevirtualinherited

set eta data member

Reimplemented in CaloCluster.

Definition at line 117 of file P4EEtaPhiM.h.

118 { m_eta = theEta;}

◆ setM()

void P4EEtaPhiM::setM ( double theM )

inlinevirtualinherited

set mass data member

Reimplemented in CaloCluster.

Definition at line 123 of file P4EEtaPhiM.h.

124 { m_m = theM;}

◆ setPhi()

void P4EEtaPhiM::setPhi ( double thePhi )

inlinevirtualinherited

set phi data member

Reimplemented in CaloCluster.

Definition at line 120 of file P4EEtaPhiM.h.

121 { m_phi = thePhi;}

◆ setRecoStatus() [1/2]

void CaloCompositeKineBase::setRecoStatus ( const CaloRecoStatus & recStatus )

inline

Set the reconstruction status.

Definition at line 82 of file CaloCompositeKineBase.h.

83 { m_status = theStatus; }

◆ setRecoStatus() [2/2]

void CaloCompositeKineBase::setRecoStatus ( const CaloRecoStatus::StatusIndicator & recIndic )

inline

Set the reconstruction status indicator (recommended)

Definition at line 86 of file CaloCompositeKineBase.h.

88 { m_status.setStatus(recIndic); }

◆ 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

protectedinherited

Definition at line 75 of file P4EEtaPhiM.h.

◆ m_eta

double P4EEtaPhiM::m_eta

protectedinherited

Definition at line 76 of file P4EEtaPhiM.h.

◆ m_m

double P4EEtaPhiM::m_m

protectedinherited

Definition at line 78 of file P4EEtaPhiM.h.

◆ m_phi

double P4EEtaPhiM::m_phi

protectedinherited

Definition at line 77 of file P4EEtaPhiM.h.

◆ m_status

CaloRecoStatus CaloCompositeKineBase::m_status

protected

Calorimeter reconstruction status.

Definition at line 58 of file CaloCompositeKineBase.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ ~CaloCompositeKineBase()

◆ CaloCompositeKineBase()

Member Function Documentation

◆ checkRecoStatus()

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ dump()

◆ e()

◆ energy()

◆ energy_nonvirt()

◆ errors()

◆ et()

◆ eta()

◆ getBasicEnergy()

◆ getRecoStatus()

◆ hlv()

◆ iPt()

◆ kind()

◆ m()

◆ m2()

◆ p()

◆ p2()

◆ phi()

◆ pt()

◆ px()

◆ py()

◆ pz()

◆ rapidity()

◆ removeRecoStatus() [1/2]

◆ removeRecoStatus() [2/2]

◆ set4Mom() [1/3]

◆ set4Mom() [2/3]

◆ set4Mom() [3/3]

◆ setBasicEnergy()

◆ setE()

◆ setEta()

◆ setM()

◆ setPhi()

◆ setRecoStatus() [1/2]

◆ setRecoStatus() [2/2]

◆ sinPhi()

◆ sinTh()

◆ tanTh()

Member Data Documentation

◆ m_e

◆ m_eta

◆ m_m

◆ m_phi

◆ m_status