LArCell Class Reference

Data object for LAr calorimeter readout cell. More...

#include <LArCell.h>

Inheritance diagram for LArCell:

Collaboration diagram for LArCell:

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

Public Member Functions
	LArCell ()
	default constructor (should not be used, only there for persistency reason)
	LArCell (const CaloDetDescrElement *caloDDE, double energy, double time, double quality, CaloGain::CaloGain gain)
	Legacy constructor.
	LArCell (const CaloDetDescrElement *caloDDE, double energy, double time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain)
	Main constructor.
	LArCell (const CaloDetDescrElement *caloDDE, const Identifier &id, double energy, double time, double quality, CaloGain::CaloGain gain)
	Legacy constructor with ID.
	LArCell (const CaloDetDescrElement *caloDDE, const Identifier &id, double energy, double time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain)
	constructor with ID
virtual	~LArCell ()
	default destructor
LArCell &	operator= (const LArCell &)=default
LArCell &	operator= (LArCell &&)=default
void	assign (const CaloDetDescrElement *caloDDE, const Identifier &id, double energy, double time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain)
	For initializing a cell we get from a DataPool.
double	deltaR (const LArCell *other) const
	get deltaR (using 4mom helper) with respect to another cell
void	print (void) const
	print all relevant info about this cell
virtual std::unique_ptr< CaloCell >	clone () const override final
	clone this cell into another one
void	add_energy (double energy)
	Add energy to this cell.
void	setEnergyFast (float e)
	set Energy to this cell with inline method.
void	setQualityFast (float q)
	set Quality to this cell with inline method.
void	setTimeFast (float t)
	set Time to this cell with inline method.
virtual bool	badcell () const override final
	Check from provenance bit is cell is dead.
void	assign (const CaloDetDescrElement *caloDDE, const Identifier &ID, float energy, float time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain)
	For initializing a cell we get from a DataPool.
double	energy () const
	get energy (data member)
float	x () const
	get x (through CaloDetDescrElement)
float	y () const
	get y (through CaloDetDescrElement)
float	z () const
	get z (through CaloDetDescrElement)
Identifier	ID () const
	get ID (from cached data member) non-virtual and inline for fast access
float	time () const
	get time (data member)
uint16_t	quality () const
	get quality (data member)
uint16_t	provenance () const
	get provenance (data member)
CaloGain::CaloGain	gain () const
	get gain (data member )
const CaloDetDescrElement *	caloDDE () const
	get pointer to CaloDetDescrElement (data member)
void	setCaloDDE (const CaloDetDescrElement *caloDDE)
	set pointer to CaloDetDescrElement
void	addEnergy (float energy)
	add energy
void	addTime (float delta)
	add time
void	setProvenance (uint16_t prov)
	set Provenance
void	setGain (CaloGain::CaloGain gain=CaloGain::INVALIDGAIN)
	set gain
void	setQuality (uint16_t quality)
	set quality
void	setQuality (double quality)
	set Quality (obsolete)
virtual void	set4Mom (const I4Momentum *const theI4Mom) override final
	set 4Momentum (will throw exception since cannot be implemented)
virtual void	set4Mom (const I4Momentum &theI4Mom) override final
	set 4Momentum (will throw exception since cannot be implemented)
virtual void	set4Mom (const CLHEP::HepLorentzVector &theHlv) override final
	set 4Momentum (will throw exception since cannot be implemented)
void	set (const CaloDetDescrElement *caloDDE, const Identifier &ID)
	Fast method to change the identity of a cell.
void	set (float energy, float time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain)
	Fast method to change the data of a cell.
void	set (float energy, float time, double quality, CaloGain::CaloGain gain)
	Fast method to change the data of a cell.
virtual void	fillToken (INavigationToken &) const
virtual void	fillToken (INavigationToken &, const std::any &) const
virtual double	px () const
	x component of momentum
virtual double	py () const
	y component of momentum
virtual double	pz () const
	z component of momentum
virtual double	p () const
	magnitude of 3-momentum.
virtual double	p2 () const
	square of momentum magnitude
virtual double	m2 () const
	mass squared
virtual double	pt () const
	transverse momentum
virtual double	iPt () const
	inverse of transverse momentum
virtual double	rapidity () const
	rapidity
virtual double	tanTh () const
	tan theta
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.
virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors.
I4Momentum::Kind	kind () const
	tells what kind of P4XYZT this is
virtual std::ostream &	dump (std::ostream &out=std::cout) const
	Print I4Momentum content.
virtual AthenaBarCode_t	getAthenaBarCode () const
virtual void	setAthenaBarCode (AthenaBarCode_t)
virtual bool	hasSameAthenaBarCode (const IAthenaBarCode &) const
virtual bool	hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &) const
virtual AthenaBarCodeVersion_t	getVersion () const
virtual void	newVersion ()
virtual void	setVersion (AthenaBarCodeVersion_t)
P4EEtaPhiMBase functions.
These can be made final.
virtual double	phi () const override final
	get phi (through CaloDetDescrElement)
virtual double	eta () const override final
	get eta (through CaloDetDescrElement)
virtual double	sinTh () const override final
	get sin(theta) (through CaloDetDescrElement)
virtual double	cosTh () const override final
	get cos(theta) (derived from sinTh)
virtual double	sinPhi () const override final
	get sin(phi)
virtual double	cosPhi () const override final
	get cos(phi)
virtual double	cotTh () const override final
	get cottan(theta)
virtual double	m () const override final
	get mass (hardcoded to be null)
virtual double	e () const override final
	get energy (data member) (synonym to method energy()
virtual double	et () const override final
	get et
virtual functions
That get overriden by TileCell/LarCell
virtual void	setEnergy (float energy)
	set energy
virtual void	scaleEnergy (float scale)
	scale energy
virtual void	setTime (float time)
	set time

Static Public Attributes
static const AthenaBarCode_t	UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)
static const AthenaBarCode_t	UNDEFINEDVERSION = UNDEFINEDBARCODE

Protected Attributes
float	m_energy
	energy (in MeV)
float	m_time
	time
union {
int   m_quality = 0
uint16_t   m_qualProv [2]
uint8_t   m_tileQual [4]
};
	quality
Identifier	m_ID
	offline identifier
CaloGain::CaloGain	m_gain
	gain
const CaloDetDescrElement *	m_caloDDE
	pointer to static CaloDetDescrElement to access information that does not change from event to event

Detailed Description

Data object for LAr calorimeter readout cell.

LArCell does not add any information to its parent CaloCell. It is kept mainly for historical reasons, but also if it turns out to be necessary to add data members pertaining only to LArCell and not to TileCell.

Author

Hong Ma

Srini Rajagopalan

Definition at line 51 of file LArCell.h.

Member Enumeration Documentation

Kind

enum I4Momentum::Kind

inherited

Enumerator
P4EETAPHIM
P4IPTCOTTHPHIM
P4PTETAPHIM
P4PXPYPZE
UNKNOWN

Definition at line 33 of file I4Momentum.h.

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

Constructor & Destructor Documentation

LArCell() [1/5]

LArCell::LArCell ( )

inline

default constructor (should not be used, only there for persistency reason)

Definition at line 151 of file LArCell.h.

                        : CaloCell()
{}

LArCell() [2/5]

LArCell::LArCell ( const CaloDetDescrElement * caloDDE, double energy, double time, double quality, CaloGain::CaloGain gain )

inline

Legacy constructor.

Definition at line 154 of file LArCell.h.

    :
    CaloCell(caloDDE,energy,time,quality,gain)
{}

LArCell() [3/5]

LArCell::LArCell ( const CaloDetDescrElement * caloDDE, double energy, double time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain )

inline

Main constructor.

Definition at line 173 of file LArCell.h.

    :
    CaloCell(caloDDE,energy,time,quality,provenance,gain)
{}

LArCell() [4/5]

LArCell::LArCell ( const CaloDetDescrElement * caloDDE, const Identifier & id, double energy, double time, double quality, CaloGain::CaloGain gain )

inline

Legacy constructor with ID.

Definition at line 163 of file LArCell.h.

    :
    CaloCell(caloDDE,id,energy,time,quality,gain)
{}

LArCell() [5/5]

LArCell::LArCell ( const CaloDetDescrElement * caloDDE, const Identifier & id, double energy, double time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain )

inline

constructor with ID

Definition at line 183 of file LArCell.h.

    :
    CaloCell(caloDDE,id,energy,time,quality,provenance,gain)
{}

~LArCell()

LArCell::~LArCell ( )

virtual

default destructor

Definition at line 13 of file LArCell.cxx.

{  }

Member Function Documentation

add_energy()

void LArCell::add_energy ( double energy )

inline

Add energy to this cell.

This is typically used in case of duplicate cells where only one LArCell Object is created and all duplicate cells are summed.

Definition at line 208 of file LArCell.h.

{
m_energy += energy;
}

addEnergy()

void CaloCell::addEnergy ( float energy )

inlineinherited

add energy

Definition at line 449 of file CaloCell.h.

                                     {
  m_energy += energy;
}

addTime()

void CaloCell::addTime ( float delta )

inlineinherited

add time

Definition at line 454 of file CaloCell.h.

{
  m_time += delta;
}

assign() [1/2]

void CaloCell::assign ( const CaloDetDescrElement * caloDDE, const Identifier & ID, float energy, float time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain )

inlineinherited

For initializing a cell we get from a DataPool.

Definition at line 275 of file CaloCell.h.

{
  m_energy = energy;
  m_time = time;
  m_ID = ID;
  m_gain = gain;
  m_caloDDE = caloDDE;
  m_qualProv[0]=quality;
  m_qualProv[1]=provenance;
}

assign() [2/2]

void LArCell::assign ( const CaloDetDescrElement * caloDDE, const Identifier & id, double energy, double time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain )

inline

For initializing a cell we get from a DataPool.

Definition at line 196 of file LArCell.h.

{
  CaloCell::assign(caloDDE,id,energy,time,quality,provenance,gain);
}

badcell()

bool LArCell::badcell ( void ) const

finaloverridevirtual

Check from provenance bit is cell is dead.

Reimplemented from CaloCell.

Definition at line 45 of file LArCell.cxx.

{
  return LArProv::test(this->provenance(),LArProv::MASKED);  
}

caloDDE()

const CaloDetDescrElement * CaloCell::caloDDE ( ) const

inlineinherited

get pointer to CaloDetDescrElement (data member)

Definition at line 321 of file CaloCell.h.

                                                  {
   return m_caloDDE;
}

clone()

std::unique_ptr< CaloCell > LArCell::clone ( ) const

finaloverridevirtual

clone this cell into another one

Reimplemented from CaloCell.

Definition at line 33 of file LArCell.cxx.

{
  return std::make_unique<LArCell>(this->caloDDE(),
                   this->ID(),
                   this->energy(),
                   this->time(),
                   this->quality(),
                   this->provenance(),
                   this->gain()); 
}

cosPhi()

double CaloCell::cosPhi ( ) const

inlinefinaloverridevirtualinherited

get cos(phi)

Reimplemented from P4EEtaPhiMBase.

Definition at line 417 of file CaloCell.h.

{
  return m_caloDDE->cosPhi();
}

cosTh()

double CaloCell::cosTh ( ) const

inlinefinaloverridevirtualinherited

get cos(theta) (derived from sinTh)

Reimplemented from P4EEtaPhiMBase.

Definition at line 396 of file CaloCell.h.

{
  return m_caloDDE->cosTh();
}

cotTh()

double CaloCell::cotTh ( ) const

inlinefinaloverridevirtualinherited

get cottan(theta)

Reimplemented from P4EEtaPhiMBase.

Definition at line 403 of file CaloCell.h.

{
  return m_caloDDE->cotTh();
}

deltaR()

double LArCell::deltaR

(

const LArCell *

other

)

const

get deltaR (using 4mom helper) with respect to another cell

Definition at line 17 of file LArCell.cxx.

{
  
  return P4Helpers::deltaR(this,other);
  
}

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 CaloCell::e ( ) const

inlinefinaloverridevirtualinherited

get energy (data member) (synonym to method energy()

Implements I4Momentum.

Definition at line 333 of file CaloCell.h.

{
  return m_energy;
}

energy()

double CaloCell::energy ( ) const

inlineinherited

get energy (data member)

Definition at line 327 of file CaloCell.h.

{
  return m_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 CaloCell::et ( ) const

inlinefinaloverridevirtualinherited

get et

Reimplemented from P4EEtaPhiMBase.

Definition at line 423 of file CaloCell.h.

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

eta()

double CaloCell::eta ( void ) const

inlinefinaloverridevirtualinherited

get eta (through CaloDetDescrElement)

Implements I4Momentum.

Definition at line 382 of file CaloCell.h.

{
  return m_caloDDE->eta();
}

fillToken() [1/2]

virtual void NavigableTerminalNode::fillToken ( INavigationToken & ) const

inlinevirtualinherited

Implements INavigable.

Definition at line 31 of file NavigableTerminalNode.h.

{ };

fillToken() [2/2]

virtual void NavigableTerminalNode::fillToken ( INavigationToken & , const std::any &  ) const

inlinevirtualinherited

Implements INavigable.

Definition at line 32 of file NavigableTerminalNode.h.

{ };

gain()

CaloGain::CaloGain CaloCell::gain ( ) const

inlineinherited

get gain (data member )

Definition at line 361 of file CaloCell.h.

{
  return m_gain;
}

getAthenaBarCode()

virtual AthenaBarCode_t IAthenaBarCode::getAthenaBarCode ( ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 67 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                   {
    return UNDEFINEDBARCODE;
  }

getVersion()

virtual AthenaBarCodeVersion_t IAthenaBarCode::getVersion ( ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 85 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                    {
    return UNDEFINEDVERSION;
  }

hasSameAthenaBarCode()

virtual bool IAthenaBarCode::hasSameAthenaBarCode ( const IAthenaBarCode & ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 77 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                                   {
    return false;
  }

hasSameAthenaBarCodeExceptVersion()

virtual bool IAthenaBarCode::hasSameAthenaBarCodeExceptVersion ( const IAthenaBarCode & ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 81 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                                                {
    return false;
  }

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

ID()

Identifier CaloCell::ID ( ) const

inlineinherited

get ID (from cached data member) non-virtual and inline for fast access

Definition at line 295 of file CaloCell.h.

                                     {
  return m_ID;
}

iPt()

double P4EEtaPhiMBase::iPt ( ) const

virtualinherited

inverse of transverse momentum

Implements I4Momentum.

Definition at line 111 of file P4EEtaPhiMBase.cxx.

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

kind()

I4Momentum::Kind P4EEtaPhiMBase::kind ( ) const

inlinevirtualinherited

tells what kind of P4XYZT this is

Implements I4Momentum.

Definition at line 65 of file P4EEtaPhiMBase.h.

{ return I4Momentum::P4EETAPHIM; };

m()

double CaloCell::m ( void ) const

inlinefinaloverridevirtualinherited

get mass (hardcoded to be null)

Implements I4Momentum.

Definition at line 340 of file CaloCell.h.

{
  // zero mass by convention
  return 0.;
}

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

newVersion()

virtual void IAthenaBarCode::newVersion ( )

inlinevirtualinherited

Reimplemented in AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 89 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                            {
    //    throw std::runtime_error("IAthenaBarCode::newVersion():: can't newVersion() in the dummy implementation");
  }

operator=() [1/2]

LArCell & LArCell::operator= ( const LArCell & )

default

operator=() [2/2]

LArCell & LArCell::operator= ( LArCell && )

default

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 CaloCell::phi ( void ) const

inlinefinaloverridevirtualinherited

get phi (through CaloDetDescrElement)

Implements I4Momentum.

Definition at line 375 of file CaloCell.h.

{
  return m_caloDDE->phi();
}

print()

void LArCell::print

(

void

)

const

print all relevant info about this cell

Definition at line 25 of file LArCell.cxx.

{
  std::cout << "ID         = " << this->ID().get_compact()<< std::endl;
  std::cout << "Energy     = " << this->e()<< std::endl;
  std::cout << "Eta        = " << this->eta() << std::endl;
  std::cout << "Phi        = " << this->phi() << std::endl;
}

provenance()

uint16_t CaloCell::provenance ( ) const

inlineinherited

get provenance (data member)

Definition at line 354 of file CaloCell.h.

{
  // cppcheck-suppress objectIndex
  return m_qualProv[1];
}

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.

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

py()

double P4EEtaPhiMBase::py ( ) const

virtualinherited

y component of momentum

Implements I4Momentum.

Definition at line 126 of file P4EEtaPhiMBase.cxx.

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

pz()

double P4EEtaPhiMBase::pz ( ) const

virtualinherited

z component of momentum

Implements I4Momentum.

Definition at line 130 of file P4EEtaPhiMBase.cxx.

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

quality()

uint16_t CaloCell::quality ( ) const

inlineinherited

get quality (data member)

Definition at line 348 of file CaloCell.h.

{
  return m_qualProv[0];
}

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

scaleEnergy()

void CaloCell::scaleEnergy ( float scale )

inlinevirtualinherited

scale energy

Reimplemented in TileCell.

Definition at line 478 of file CaloCell.h.

{
  m_energy *= scale ;
}

set() [1/3]

void CaloCell::set ( const CaloDetDescrElement * caloDDE, const Identifier & ID )

inlineinherited

Fast method to change the identity of a cell.

Definition at line 511 of file CaloCell.h.

                                         {
  m_ID = ID;
  m_caloDDE = caloDDE;
}

set() [2/3]

void CaloCell::set ( float energy, float time, double quality, CaloGain::CaloGain gain )

inherited

Fast method to change the data of a cell.

OBSOLETE

Definition at line 104 of file CaloCell.cxx.

{
  m_energy = energy;
  m_time = time;
  m_quality = (int)(quality);
  m_gain = gain;
}

set() [3/3]

void CaloCell::set ( float energy, float time, uint16_t quality, uint16_t provenance, CaloGain::CaloGain gain )

inherited

Fast method to change the data of a cell.

Definition at line 89 of file CaloCell.cxx.

{
  m_energy = energy;
  m_time = time;
  m_gain = gain;
  m_qualProv[0]=quality;
  // cppcheck-suppress objectIndex
  m_qualProv[1]=provenance;
}

set4Mom() [1/3]

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

finaloverridevirtualinherited

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

Reimplemented from P4EEtaPhiMBase.

Definition at line 127 of file CaloCell.cxx.

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

set4Mom() [2/3]

void CaloCell::set4Mom ( const I4Momentum & theI4Mom )

finaloverridevirtualinherited

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

Reimplemented from P4EEtaPhiMBase.

Definition at line 121 of file CaloCell.cxx.

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

set4Mom() [3/3]

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

finaloverridevirtualinherited

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

Reimplemented from P4EEtaPhiMBase.

Definition at line 115 of file CaloCell.cxx.

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

setAthenaBarCode()

virtual void IAthenaBarCode::setAthenaBarCode ( AthenaBarCode_t )

inlinevirtualinherited

Reimplemented in AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 71 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                   {
    //    throw std::runtime_error("IAthenaBarCode::setAthenaBarCode():: can't set AthenaBarCode in the dummy implementation");
  }

setCaloDDE()

void CaloCell::setCaloDDE ( const CaloDetDescrElement * caloDDE )

inlineinherited

set pointer to CaloDetDescrElement

Definition at line 503 of file CaloCell.h.

                                                            {
  m_caloDDE = caloDDE;
  if (m_caloDDE) {
    m_ID = m_caloDDE->identify();
  }
}

setEnergy()

void CaloCell::setEnergy ( float energy )

inlinevirtualinherited

set energy

Reimplemented in TileCell.

Definition at line 472 of file CaloCell.h.

{
  m_energy = energy ;
}

setEnergyFast()

void LArCell::setEnergyFast ( float e )

inline

set Energy to this cell with inline method.

This is requested by HLT to build LArCell fast.

Definition at line 214 of file LArCell.h.

{
  m_energy = e ;
}

setGain()

void CaloCell::setGain ( CaloGain::CaloGain gain = CaloGain::INVALIDGAIN )

inlineinherited

set gain

Definition at line 497 of file CaloCell.h.

{
  m_gain = gain;
}

setProvenance()

void CaloCell::setProvenance ( uint16_t prov )

inlineinherited

set Provenance

Definition at line 490 of file CaloCell.h.

{
  // cppcheck-suppress objectIndex
  m_qualProv[1] = prov;
}

setQuality() [1/2]

void CaloCell::setQuality ( double quality )

inlineinherited

set Quality (obsolete)

Definition at line 466 of file CaloCell.h.

{
  m_quality = (int)(quality);
}

setQuality() [2/2]

void CaloCell::setQuality ( uint16_t quality )

inlineinherited

set quality

Definition at line 460 of file CaloCell.h.

{
  m_qualProv[0] = quality;
}

setQualityFast()

void LArCell::setQualityFast ( float q )

inline

set Quality to this cell with inline method.

This is requested by HLT to build LArCell fast.

Definition at line 220 of file LArCell.h.

{
  m_quality = (int)(q) ;
}

setTime()

void CaloCell::setTime ( float time )

inlinevirtualinherited

set time

Reimplemented in TileCell.

Definition at line 484 of file CaloCell.h.

{
  m_time = time;
}

setTimeFast()

void LArCell::setTimeFast ( float t )

inline

set Time to this cell with inline method.

This is requested by HLT to build LArCell fast.

Definition at line 226 of file LArCell.h.

{
  m_time = t ;
}

setVersion()

virtual void IAthenaBarCode::setVersion ( AthenaBarCodeVersion_t )

inlinevirtualinherited

Reimplemented in AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 93 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                    {
    //    throw std::runtime_error("IAthenaBarCode::setVersion():: can't setVersion() in the dummy implementation");
  }

sinPhi()

double CaloCell::sinPhi ( ) const

inlinefinaloverridevirtualinherited

get sin(phi)

Reimplemented from P4EEtaPhiMBase.

Definition at line 410 of file CaloCell.h.

{
  return m_caloDDE->sinPhi();
}

sinTh()

double CaloCell::sinTh ( ) const

inlinefinaloverridevirtualinherited

get sin(theta) (through CaloDetDescrElement)

Reimplemented from P4EEtaPhiMBase.

Definition at line 389 of file CaloCell.h.

{
  return m_caloDDE->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();
}

time()

float CaloCell::time ( ) const

inlineinherited

get time (data member)

Definition at line 368 of file CaloCell.h.

{
  return m_time;
}

x()

float CaloCell::x ( ) const

inlineinherited

get x (through CaloDetDescrElement)

Definition at line 429 of file CaloCell.h.

{
  return m_caloDDE->x();
}

y()

float CaloCell::y ( ) const

inlineinherited

get y (through CaloDetDescrElement)

Definition at line 436 of file CaloCell.h.

{
  return m_caloDDE->y();
}

z()

float CaloCell::z ( ) const

inlineinherited

get z (through CaloDetDescrElement)

Definition at line 443 of file CaloCell.h.

{
  return m_caloDDE->z();
}

Member Data Documentation

[union]

union { ... } CaloCell

quality

m_caloDDE

const CaloDetDescrElement* CaloCell::m_caloDDE

protectedinherited

pointer to static CaloDetDescrElement to access information that does not change from event to event

Definition at line 256 of file CaloCell.h.

m_energy

float CaloCell::m_energy

protectedinherited

energy (in MeV)

Definition at line 230 of file CaloCell.h.

m_gain

CaloGain::CaloGain CaloCell::m_gain

protectedinherited

gain

Definition at line 253 of file CaloCell.h.

m_ID

Identifier CaloCell::m_ID

protectedinherited

offline identifier

Definition at line 251 of file CaloCell.h.

m_quality

int CaloCell::m_quality = 0

inherited

Definition at line 245 of file CaloCell.h.

m_qualProv

uint16_t CaloCell::m_qualProv[2]

inherited

Definition at line 246 of file CaloCell.h.

m_tileQual

uint8_t CaloCell::m_tileQual[4]

inherited

Definition at line 247 of file CaloCell.h.

m_time

float CaloCell::m_time

protectedinherited

time

Definition at line 232 of file CaloCell.h.

UNDEFINEDBARCODE

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)

staticinherited

Definition at line 52 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

UNDEFINEDVERSION

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDVERSION = UNDEFINEDBARCODE

staticinherited

Definition at line 53 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

---

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

• LArCell.h
• LArCell.cxx