Implementation of navigation and kinematics for CaloCluster and CaloTower. More...

#include <CaloEnergyCluster.h>

Inheritance diagram for CaloEnergyCluster:

Collaboration diagram for CaloEnergyCluster:

Public Types
typedef CaloCellContainer::const_reference	const_cell_ptr
	Const pointer type for objects in the CaloCellContainer. More...

typedef Navigable< CaloCellContainer, double >::external_index_type	index_type
	Index type for CaloCellContainer. More...

typedef Navigable< CaloCellContainer, double >::object_iter	cell_iterator
	Iterator type for cell store. More...

typedef typename NavigationDefaults::DefaultChildColl< CaloCellContainer, double >::type	constituent_coll

typedef constituent_coll::iterator	constituent_iter

typedef constituent_coll::const_iterator	constituent_const_iter

typedef CaloCellContainer	container_type
	Object container type. More...

typedef double	parameter_type
	\ brief Relational parameter type More...

typedef NavigationDefaults::DefaultChildColl< container_type, parameter_type >	navhelper_t
	Collection manager type. More...

typedef CONT::base_value_type	constituent_type

typedef CONT::reference	constituent_ptr_ref

typedef CONT::const_reference	constituent_const_ptr_ref

typedef CONT::value_type	constituent_ptr

typedef SG::GenerateIndexingPolicy< CaloCellContainer >::type::index_type	external_index_type

typedef NavigableIterator< CaloCellContainer, double, typename NavigationDefaults::DefaultChildColl< CaloCellContainer, double >::type >	object_iter

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

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

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

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

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

void	addCell (const CaloCellContainer theContainer, const CaloCell theCell, double weight)
	Add a cell with global kinematic update (slow) More...

void	addCell (const CaloCellContainer *theContainer, index_type theIndex, double weight)
	Add a cell with global kinematic update (fast) More...

virtual void	addUniqueCell (const CaloCellContainer *theContainer, index_type theIndex, double weight, size_t size_hint=0)
	Add a cell with global kinematic update (fast) More...

void	addUniqueCellNoKine (const CaloCellContainer *theContainer, index_type theIndex, double weight, size_t size_hint=0)
	Add a cell (very fast) More...

void	addUniqueCellNoKine (const CaloCellContainer theContainer, index_type theIndex, IProxyDict sg, double weight, size_t size_hint=0)
	Add a cell (very fast) More...

void	addUniqueCellNoKine (const ElementLink< CaloCellContainer > &theContainer, index_type theIndex, double weight, size_t size_hint=0)
	Add a cell (fastest) More...

void	reweightCell (const CaloCell *theCell, double weight)
	Reweight a cell with kinematic update. More...

void	reweightCell (const CaloCellContainer *theContainer, index_type &theIndex, double weight)
	Reweight a cell with kinematic update. More...

void	reweightCell (cell_iterator &iterCell, double weight)
	Reweight a cell with kinematic update. More...

void	removeCell (const CaloCell *theCell)
	Remove a cell with kinematic update. More...

void	removeCell (const CaloCellContainer *theContainer, index_type &theIndex)
	Remove a cell with kinematic update. More...

void	removeCells ()
	Remove all cells without kinematic update. More...

double	getCellWeight (const CaloCell *theCell) const
	Retrieve the kinematic weight of a given cell. More...

double	getCellWeight (const CaloCellContainer *theContainer, index_type &theIndex) const
	Retrieve the kinematic weight of a given cell. More...

double	getCellWeight (cell_iterator &iterCell) const
	Retrieve the kinematic weight of a given cell. More...

const CaloCellContainer *	getCellContainer (const CaloCell *theCell) const
	Retrieve the pointer to the original cell container for a given cell. More...

bool	getCellIndex (const CaloCell *theCell, index_type &theIndex) const
	Retrieve the index of a given cell in the cell container. More...

cell_iterator	cell_begin () const
	Retrieve a STL-type begin() iterator for the cell store. More...

cell_iterator	cell_end () const
	Retrieve a STL-type end() iterator for the cell store. More...

unsigned int	getNumberOfCells () const
	Return the number of cells in the store. More...

void	setRecoStatus (CaloRecoStatus::StatusIndicator recStatus)
	Set the reconstruction status. More...

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

virtual void	fillToken (INavigationToken &navToken) const

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

void	putElement (const CaloCellContainer objectContainer, const constituent_type constituentObject, const double &objectParameter=double(), size_t sizeHint=0)

void	putElement (const CaloCellContainer *objectContainer, const external_index_type &theIndex, const double &objectParameter=double(), size_t sizeHint=0)

void	insertElement (const CaloCellContainer objectContainer, const constituent_type constituentObject, const double &objectParameter=double(), size_t sizeHint=0)

void	insertElement (const CaloCellContainer *objectContainer, const external_index_type &theIndex, const double &objectParameter=double(), size_t sizeHint=0)

void	insertElement (const CaloCellContainer objectContainer, const external_index_type &theIndex, IProxyDict sg, const double &objectParameter=double(), size_t sizeHint=0)

void	insertElement (const ElementLink< CaloCellContainer > &el, const double &objectParameter=double(), size_t sizeHint=0)

void	reweight (const constituent_type *constituentObject, const double &objectParameter=double())

void	reweight (const CaloCellContainer *objectContainer, const external_index_type &theIndex, const double &objectParameter=double())

void	reweight (object_iter &objectIter, const double &objectParameter=double())

bool	remove (const constituent_type *aConstituent)

bool	remove (const CaloCellContainer *objectContainer, const external_index_type &theIndex)

bool	removeAll ()

bool	replace (const CaloCellContainer *newObjectContainer)
	replace old object container with a new container assumes that all objects have been or will be inserted to the new container More...

bool	contains (const constituent_type *aConstituent) const

bool	contains (const CaloCellContainer *objectContainer, const external_index_type &theIndex) const

virtual object_iter	begin () const

virtual object_iter	end () const

virtual unsigned int	size () const

double	getParameter (const constituent_type *aConstituent) const

double	getParameter (const CaloCellContainer *objectContainer, const external_index_type &theIndex) const

double	getParameter (object_iter &theIter) const

const CaloCellContainer *	getContainer (const constituent_type *aConstituent) const

const CaloCellContainer *	getContainer (constituent_const_iter anIter) const

const CaloCellContainer *	getContainer (object_iter objectIter) const

bool	getIndex (const constituent_type *aConstituent, external_index_type &theIndex) const

bool	getIndex (constituent_const_iter anIter, external_index_type &theIndex) const

bool	getIndex (object_iter objectIter, external_index_type &theIndex) const

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

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)

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

static const AthenaBarCode_t	UNDEFINEDVERSION = UNDEFINEDBARCODE

Protected Member Functions
	CaloEnergyCluster ()
	Default constructor. More...

virtual void	updateKine (const CaloCell *theCell, double weight)=0
	Interface to kinematic update implementation. More...

const constituent_coll &	getConstituents () const

constituent_coll &	getConstituents ()

const constituent_coll *	getPtrToConstituents () const

constituent_coll *	getPtrToConstituents ()

virtual const constituent_type *	getConstituentPtr (constituent_iter iter) const

virtual const constituent_type *	getConstituentPtr (constituent_const_iter iter) const

virtual double	getConstituentPar (constituent_iter iter) const

virtual double	getConstituentPar (constituent_const_iter iter) const

void	dumpStore () const

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

double	m_e

double	m_eta

double	m_phi

double	m_m

Private Member Functions
virtual void	apply (NavigationToken< constituent_type > &navToken) const

virtual void	apply (NavigationToken< constituent_type, double > &navToken, const double &aParameter) const

virtual void	toKidsAfterAccept (INavigationToken &navToken) const

virtual void	toKidsAfterAccept (INavigationToken &navToken, const std::any &aParameter) const

virtual void	toKidsAfterReject (INavigationToken &navToken) const

virtual void	toKidsAfterReject (INavigationToken &navToken, const std::any &aParameter) const

Private Attributes
constituent_coll	m_constituents

Detailed Description

Implementation of navigation and kinematics for CaloCluster and CaloTower.

Author: P. Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Date: April 1, 2005

Version: 1

The CaloEnergyCluster class provides all common implementations to manage and navigate a store of pointers to CaloCell s and their kinematic weight in a CaloCluster or CaloTower, together with data members, set and access methods for the global kinematics of these objects.

Definition at line 22 of file CaloEnergyCluster.h.

Member Typedef Documentation

◆ cell_iterator

typedef Navigable<CaloCellContainer,double>::object_iter CaloEnergyCluster::cell_iterator

Iterator type for cell store.

Extracted from the Navigable<CaloCellContainer,double> prescription. Is generally equal to the standard size_t.

Definition at line 43 of file CaloEnergyCluster.h.

◆ const_cell_ptr

typedef CaloCellContainer::const_reference CaloEnergyCluster::const_cell_ptr

Const pointer type for objects in the CaloCellContainer.

Generally expands to const CaloCell*.

Definition at line 32 of file CaloEnergyCluster.h.

◆ constituent_coll

typedef typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_coll

inherited

Definition at line 101 of file Navigable.h.

◆ constituent_const_iter

typedef constituent_coll::const_iterator Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_const_iter

inherited

Definition at line 103 of file Navigable.h.

◆ constituent_const_ptr_ref

typedef CONT::const_reference Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_const_ptr_ref

inherited

Definition at line 151 of file Navigable.h.

◆ constituent_iter

typedef constituent_coll::iterator Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_iter

inherited

Definition at line 102 of file Navigable.h.

◆ constituent_ptr

typedef CONT::value_type Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_ptr

inherited

Definition at line 152 of file Navigable.h.

◆ constituent_ptr_ref

typedef CONT::reference Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_ptr_ref

inherited

Definition at line 150 of file Navigable.h.

◆ constituent_type

typedef CONT::base_value_type Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::constituent_type

inherited

Definition at line 149 of file Navigable.h.

◆ container_type

typedef CaloCellContainer Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::container_type

inherited

Object container type.

Definition at line 110 of file Navigable.h.

◆ external_index_type

typedef SG::GenerateIndexingPolicy<CaloCellContainer >::type::index_type Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::external_index_type

inherited

Definition at line 156 of file Navigable.h.

◆ index_type

typedef Navigable<CaloCellContainer,double>::external_index_type CaloEnergyCluster::index_type

Index type for CaloCellContainer.

Extracted from the Navigable<CaloCellContainer,double> prescription.

Definition at line 37 of file CaloEnergyCluster.h.

◆ navhelper_t

typedef NavigationDefaults::DefaultChildColl<container_type,parameter_type> Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::navhelper_t

inherited

Collection manager type.

Definition at line 114 of file Navigable.h.

◆ object_iter

typedef NavigableIterator<CaloCellContainer ,double ,typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type > Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::object_iter

inherited

Definition at line 159 of file Navigable.h.

◆ parameter_type

typedef double Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::parameter_type

inherited

\ brief Relational parameter type

Definition at line 112 of file Navigable.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

◆ ~CaloEnergyCluster()

CaloEnergyCluster::~CaloEnergyCluster ( )

virtualdefault

Destructor.

◆ CaloEnergyCluster()

CaloEnergyCluster::CaloEnergyCluster ( )

protected

Default constructor.

Definition at line 18 of file CaloEnergyCluster.cxx.

   : Navigable<CaloCellContainer,double>()
   , P4EEtaPhiM(0.,0.,0.,0.)
   , m_status(CaloRecoStatus())
 { }

Member Function Documentation

◆ addCell() [1/2]

void CaloEnergyCluster::addCell	(	const CaloCellContainer *	theContainer,
		const CaloCell *	theCell,
		double	weight
	)

Add a cell with global kinematic update (slow)

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theCell	input pointer to a CaloCell (unchanged)
weight	signal weight asociated with this cell

Forces search of CaloCellContainer for index of CaloCell, i.e. can be slow.

Adding a cell usually changes the global kinematics. The concrete implementation is left to the updateKine method, which needs to be implemented by derived classes.

Adding cells without updating the global kinematics is also possible by using the corresponding putElement method in the Navigable<CaloCellContainer,double> base class.

Definition at line 27 of file CaloEnergyCluster.cxx.

 {
   // cell already in collection
   if ( this->contains(theCell) )
     {
       // update weight
       double newWeight = weight + this->getCellWeight(theCell);
       // reweight the cell
       this->reweightCell(theCell,newWeight);
     }
   else
     {
       // from Navigable base
       this->insertElement(theContainer,theCell,weight);
       // update kinematics
       this->updateKine(theCell,weight);
     }
 }

◆ addCell() [2/2]

void CaloEnergyCluster::addCell	(	const CaloCellContainer *	theContainer,
		index_type	theIndex,
		double	weight
	)

Add a cell with global kinematic update (fast)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
weight	signal weight asociated with this cell

Faster as index is already available, but has to rely on client to provide the correct (and valid) index.

Definition at line 49 of file CaloEnergyCluster.cxx.

 {
   if ((int)theIndex < 0) abort();
  
   // cell already in collection
   if ( this->contains(theContainer,theIndex) )
     {
       //      try 
       //    {
       //      //      std::cout << "Replace CaloCell @" 
       //      //        << (theContainer->operator[])(theIndex)
       //      //        << " index " << theIndex
       //      //        << " with energy "
       //      //        << ((theContainer->operator[])(theIndex))->e()
       //      //        << std::endl;
       //      // update weight
       double newWeight = 
     weight + this->getCellWeight(theContainer,theIndex);
       // change weight
       this->reweightCell(theContainer,theIndex,newWeight);
       //    } catch(...) {
       //    std::cout << "     Object [" 
       //          << (typeid(*this)).name()
       //          << "] failed to insert cell @"
       //          << (theContainer->operator[])(theIndex)
       //          << " in container @"
       //          << theContainer
       //          << " with index <"
       //          << theIndex
       //          << ">" << std::endl;
       //    this->dumpStore();
       //      }
     }
   else
     {
       // from Navigable base
       //      try
       //    {
       this->insertElement(theContainer,theIndex,weight);
       //      std::cout << "Insert CaloCell @" 
       //        << (theContainer->operator[])(theIndex)
       //        << " index " << theIndex
       //        << " with energy "
       //        << ((theContainer->operator[])(theIndex))->e()
       //        << std::endl;
       // update kinematics
       this->updateKine((theContainer->operator[])(theIndex),weight);
       //    } catch(...) {
       //    std::cout << "     Object [" 
       //          << (typeid(*this)).name()
       //          << "] failed to insert cell @"
       //          << (theContainer->operator[])(theIndex)
       //          << " in container @"
       //          << theContainer
       //          << " with index <"
       //          << theIndex
       //      << ">" << std::endl;
       //    this->dumpStore();
     }
   //  this->dumpStore();
 }

◆ addUniqueCell()

void CaloEnergyCluster::addUniqueCell	(	const CaloCellContainer *	theContainer,
		index_type	theIndex,
		double	weight,
		size_t	size_hint = `0`
	)

virtual

Add a cell with global kinematic update (fast)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
weight	signal weight asociated with this cell
size_hint	if non-zero, a hint about many cells are likely to be in the cluster.

Faster as index is already available, but has to rely on client to provide the correct (and valid) index.

The caller also guarantees that the cell is not already in the cluster.

Definition at line 114 of file CaloEnergyCluster.cxx.

 {
   if ((int)theIndex < 0) abort();
   this->insertElement(theContainer,theIndex,weight,size_hint);
   this->updateKine((theContainer->operator[])(theIndex),weight);
 }

◆ addUniqueCellNoKine() [1/3]

void CaloEnergyCluster::addUniqueCellNoKine	(	const CaloCellContainer *	theContainer,
		index_type	theIndex,
		double	weight,
		size_t	size_hint = `0`
	)

Add a cell (very fast)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
weight	signal weight asociated with this cell

client has to provide the correct (and valid) index.

The caller also guarantees that the cell is not already in the cluster.

The caller MUST update Kinematics by himself

Definition at line 125 of file CaloEnergyCluster.cxx.

 {
   if ((int)theIndex < 0) abort();
   this->insertElement(theContainer,theIndex,weight,size_hint);
 }

◆ addUniqueCellNoKine() [2/3]

void CaloEnergyCluster::addUniqueCellNoKine	(	const CaloCellContainer *	theContainer,
		index_type	theIndex,
		IProxyDict *	sg,
		double	weight,
		size_t	size_hint = `0`
	)

Add a cell (very fast)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
sg	current event store instance
weight	signal weight asociated with this cell

client has to provide the correct (and valid) index.

The caller also guarantees that the cell is not already in the cluster.

The caller MUST update Kinematics by himself

Definition at line 136 of file CaloEnergyCluster.cxx.

 {
   if ((int)theIndex < 0) abort();
   this->insertElement(theContainer,theIndex,sg,weight,size_hint);
 }

◆ addUniqueCellNoKine() [3/3]

void CaloEnergyCluster::addUniqueCellNoKine	(	const ElementLink< CaloCellContainer > &	theContainer,
		index_type	theIndex,
		double	weight,
		size_t	size_hint = `0`
	)

Add a cell (fastest)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	link pointing to some element of a CaloCellContainer (unchanged) The element index is ignored; this is only to identify the container.
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
sg	current event store instance
weight	signal weight asociated with this cell

client has to provide the correct (and valid) index.

The caller also guarantees that the cell is not already in the cluster.

Using this method avoids having to look up the container in the event store.

The caller MUST update Kinematics by himself

Definition at line 148 of file CaloEnergyCluster.cxx.

 {
   if ((int)theIndex < 0) abort();
   ElementLink<CaloCellContainer> el (theContainer, theIndex);
   this->insertElement(el,weight,size_hint);
 }

◆ apply() [1/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::apply ( NavigationToken< constituent_type > & navToken ) const

privatevirtualinherited

◆ apply() [2/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::apply	(	NavigationToken< constituent_type, RPAR > &	navToken,
		const RPAR &	aParameter
	)		const

privatevirtualinherited

◆ begin()

virtual object_iter Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::begin ( ) const

virtualinherited

◆ cell_begin()

CaloEnergyCluster::cell_iterator CaloEnergyCluster::cell_begin ( ) const

Retrieve a STL-type begin() iterator for the cell store.

Definition at line 270 of file CaloEnergyCluster.cxx.

 {
   return this->begin();
 }

◆ cell_end()

CaloEnergyCluster::cell_iterator CaloEnergyCluster::cell_end ( ) const

Retrieve a STL-type end() iterator for the cell store.

Definition at line 275 of file CaloEnergyCluster.cxx.

 {
   return this->end();
 }

◆ contains() [1/2]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::contains	(	const CONT *	objectContainer,
		const external_index_type &	theIndex
	)		const

inherited

◆ contains() [2/2]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::contains ( const constituent_type * aConstituent ) const

inherited

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

◆ dumpStore()

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::dumpStore ( ) const

protectedinherited

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

◆ end()

virtual object_iter Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::end ( ) const

virtualinherited

◆ energy()

virtual double CaloEnergyCluster::energy ( ) const

inlinevirtual

Return energy.

Reimplemented in CaloTower.

Definition at line 49 of file CaloEnergyCluster.h.

49 { return P4EEtaPhiM::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;}

◆ fillToken() [1/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::fillToken ( INavigationToken & navToken ) const

virtualinherited

Implements INavigable.

◆ fillToken() [2/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::fillToken	(	INavigationToken &	navToken,
		const std::any &	parentParameter
	)		const

virtualinherited

Implements INavigable.

◆ getAthenaBarCode()

virtual AthenaBarCode_t IAthenaBarCode::getAthenaBarCode ( ) const

inlinevirtualinherited

Reimplemented in Rec::TrackParticle, Analysis::ParticleShallowClone, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, and AthenaBarCodeBase.

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

                                                    {
     return UNDEFINEDBARCODE;
   }

◆ getBasicEnergy()

virtual double CaloEnergyCluster::getBasicEnergy ( ) const

inlinevirtual

Return uncalibrated energy.

Reimplemented in CaloTower.

Definition at line 52 of file CaloEnergyCluster.h.

52 { return this->energy(); }

◆ getCellContainer()

const CaloCellContainer * CaloEnergyCluster::getCellContainer ( const CaloCell * theCell ) const

Retrieve the pointer to the original cell container for a given cell.

Parameters

theCell pointer to the cell (unchanged)

Returns 0 if cell not in store.

Definition at line 249 of file CaloEnergyCluster.cxx.

 {
   return this->getContainer(theCell);
 }

◆ getCellIndex()

bool CaloEnergyCluster::getCellIndex	(	const CaloCell *	theCell,
		index_type &	theIndex
	)		const

Retrieve the index of a given cell in the cell container.

Parameters

theCell	pointer to the cell (unchanged)
theIndex	reference to a modifiable index variable

Returns true and a valid index if cell is found in store. If cell is not found, the value of the index is unchanged (typically 0 if initialized properly by client).

Note that the index refers to the index of the cell in the cell container, not the index of the cell in the local store.

Definition at line 257 of file CaloEnergyCluster.cxx.

 {
   // from Navigable
   return this->getIndex(theCell,theIndex);
 }

◆ getCellWeight() [1/3]

double CaloEnergyCluster::getCellWeight ( cell_iterator & iterCell ) const

Retrieve the kinematic weight of a given cell.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

iterCell iterator pointing to a cell

Definition at line 243 of file CaloEnergyCluster.cxx.

 {
   return this->getParameter(iterCell);
 }

◆ getCellWeight() [2/3]

double CaloEnergyCluster::getCellWeight ( const CaloCell * theCell ) const

Retrieve the kinematic weight of a given cell.

Parameters

theCell pointer to the cell (unchanged)

Returns 0. if cell not in store.

Definition at line 223 of file CaloEnergyCluster.cxx.

 {
   // from Navigable
   return this->contains(theCell) 
     ? this->getParameter(theCell)
     : 0.;
 }

◆ getCellWeight() [3/3]

double CaloEnergyCluster::getCellWeight	(	const CaloCellContainer *	theContainer,
		index_type &	theIndex
	)		const

Retrieve the kinematic weight of a given cell.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	pointer to cell container (unchanged)
theIndex	index to cell in container (unchanged)

Definition at line 233 of file CaloEnergyCluster.cxx.

 {
   // from Navigable
   return this->contains(theContainer,theIndex)
     ? this->getParameter(theContainer,theIndex)
     : 0.;
 }

◆ getConstituentPar() [1/2]

virtual double Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getConstituentPar ( constituent_const_iter iter ) const

protectedvirtualinherited

◆ getConstituentPar() [2/2]

virtual double Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getConstituentPar ( constituent_iter iter ) const

protectedvirtualinherited

◆ getConstituentPtr() [1/2]

virtual const constituent_type* Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getConstituentPtr ( constituent_const_iter iter ) const

protectedvirtualinherited

◆ getConstituentPtr() [2/2]

virtual const constituent_type* Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getConstituentPtr ( constituent_iter iter ) const

protectedvirtualinherited

◆ getConstituents() [1/2]

constituent_coll& Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getConstituents ( )

inlineprotectedinherited

Definition at line 291 of file Navigable.h.

291 { return m_constituents; }

◆ getConstituents() [2/2]

const constituent_coll& Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getConstituents ( ) const

inlineprotectedinherited

Definition at line 290 of file Navigable.h.

290 { return m_constituents; }

◆ getContainer() [1/3]

const CaloCellContainer * Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getContainer ( const constituent_type * aConstituent ) const

inherited

◆ getContainer() [2/3]

const CaloCellContainer * Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getContainer ( constituent_const_iter anIter ) const

inherited

◆ getContainer() [3/3]

const CaloCellContainer * Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getContainer ( object_iter objectIter ) const

inherited

◆ getIndex() [1/3]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getIndex	(	const constituent_type *	aConstituent,
		external_index_type &	theIndex
	)		const

inherited

◆ getIndex() [2/3]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getIndex	(	constituent_const_iter	anIter,
		external_index_type &	theIndex
	)		const

inherited

◆ getIndex() [3/3]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getIndex	(	object_iter	objectIter,
		external_index_type &	theIndex
	)		const

inherited

◆ getNumberOfCells()

unsigned int CaloEnergyCluster::getNumberOfCells ( ) const

Return the number of cells in the store.

Definition at line 265 of file CaloEnergyCluster.cxx.

 {
   return this->size();
 }

◆ getParameter() [1/3]

double Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getParameter	(	const CONT *	objectContainer,
		const external_index_type &	theIndex
	)		const

inherited

◆ getParameter() [2/3]

double Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getParameter ( const constituent_type * aConstituent ) const

inherited

◆ getParameter() [3/3]

double Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getParameter ( object_iter & theIter ) const

inherited

◆ getPtrToConstituents() [1/2]

constituent_coll* Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getPtrToConstituents ( )

inlineprotectedinherited

Definition at line 296 of file Navigable.h.

297 { return &m_constituents; }

◆ getPtrToConstituents() [2/2]

const constituent_coll* Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::getPtrToConstituents ( ) const

inlineprotectedinherited

Definition at line 294 of file Navigable.h.

295 { return &m_constituents; }

◆ getRecoStatus()

const CaloRecoStatus & CaloEnergyCluster::getRecoStatus ( ) const

Retrieve the reconstruction status.

Definition at line 286 of file CaloEnergyCluster.cxx.

 {
   return m_status;
 }

◆ getVersion()

virtual AthenaBarCodeVersion_t IAthenaBarCode::getVersion ( ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, Rec::TrackParticle, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, and AthenaBarCodeBase.

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

                                                     {
     return UNDEFINEDVERSION;
   }

◆ hasSameAthenaBarCode()

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

inlinevirtualinherited

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

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

                                                                    {
     return false;
   }

◆ hasSameAthenaBarCodeExceptVersion()

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

inlinevirtualinherited

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

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

◆ insertElement() [1/4]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::insertElement	(	const CONT *	objectContainer,
		const constituent_type *	constituentObject,
		const RPAR &	objectParameter = `RPAR()`,
		size_t	sizeHint = `0`
	)

inherited

◆ insertElement() [2/4]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::insertElement	(	const CONT *	objectContainer,
		const external_index_type &	theIndex,
		const RPAR &	objectParameter = `RPAR()`,
		size_t	sizeHint = `0`
	)

inherited

◆ insertElement() [3/4]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::insertElement	(	const CONT *	objectContainer,
		const external_index_type &	theIndex,
		IProxyDict *	sg,
		const RPAR &	objectParameter = `RPAR()`,
		size_t	sizeHint = `0`
	)

inherited

◆ insertElement() [4/4]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::insertElement	(	const ElementLink< CONT > &	el,
		const RPAR &	objectParameter = `RPAR()`,
		size_t	sizeHint = `0`
	)

inherited

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

◆ newVersion()

virtual void IAthenaBarCode::newVersion ( )

inlinevirtualinherited

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

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

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

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

◆ putElement() [1/2]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::putElement	(	const CONT *	objectContainer,
		const constituent_type *	constituentObject,
		const RPAR &	objectParameter = `RPAR()`,
		size_t	sizeHint = `0`
	)

inherited

◆ putElement() [2/2]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::putElement	(	const CONT *	objectContainer,
		const external_index_type &	theIndex,
		const RPAR &	objectParameter = `RPAR()`,
		size_t	sizeHint = `0`
	)

inherited

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

◆ remove() [1/2]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::remove	(	const CONT *	objectContainer,
		const external_index_type &	theIndex
	)

inherited

◆ remove() [2/2]

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::remove ( const constituent_type * aConstituent )

inherited

◆ removeAll()

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::removeAll ( )

inlineinherited

Definition at line 237 of file Navigable.h.

237 { m_constituents.clear(); return this->size() == 0 ; }

◆ removeCell() [1/2]

void CaloEnergyCluster::removeCell ( const CaloCell * theCell )

Remove a cell with kinematic update.

Parameters

theCell pointer to a CaloCell object (unchanged)

Removes the cell pointed to by the input argument. The effect on the global kinematics is defined by the updateKine implementation in the derived classes.

The Navigable<CaloCellContainer,double> base class provides a remove method which can be used if no kinematic update is required.

Definition at line 160 of file CaloEnergyCluster.cxx.

 {
   if ( this->contains(theCell) )
     {
       // update kinematics
       this->updateKine(theCell,
                -(this->getCellWeight(theCell)));
       // from Navigable base
       this->remove(theCell);
     }
 }

◆ removeCell() [2/2]

void CaloEnergyCluster::removeCell	(	const CaloCellContainer *	theContainer,
		index_type &	theIndex
	)

Remove a cell with kinematic update.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	pointer to cell container (unchanged)
theIndex	index to cell in container (unchanged)

Definition at line 174 of file CaloEnergyCluster.cxx.

 {
   if ( this->contains(theContainer,theIndex) )
     {
       // update kinematics
       this->updateKine((*theContainer)[theIndex],
                -(this->getCellWeight(theContainer,theIndex)));
  
       // from Navigable
       this->remove(theContainer,theIndex);
     }
 }

◆ removeCells()

void CaloEnergyCluster::removeCells ( )

Remove all cells without kinematic update.

Definition at line 189 of file CaloEnergyCluster.cxx.

 {
   this->removeAll();
 }

◆ replace()

bool Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::replace ( const CONT * newObjectContainer )

inherited

replace old object container with a new container assumes that all objects have been or will be inserted to the new container

◆ reweight() [1/3]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::reweight	(	const CONT *	objectContainer,
		const external_index_type &	theIndex,
		const RPAR &	objectParameter = `RPAR()`
	)

inherited

◆ reweight() [2/3]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::reweight	(	const constituent_type *	constituentObject,
		const RPAR &	objectParameter = `RPAR()`
	)

inherited

◆ reweight() [3/3]

void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::reweight	(	object_iter &	objectIter,
		const RPAR &	objectParameter = `RPAR()`
	)

inherited

◆ reweightCell() [1/3]

void CaloEnergyCluster::reweightCell	(	cell_iterator &	iterCell,
		double	weight
	)

Reweight a cell with kinematic update.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

iterCell	input iterator referring to a cell (unchanged)
weight	input new signal weight associated with this cell

Changes the kinematic weight of a cell in the cluster. There is no check on the validity of the iterator.

Definition at line 214 of file CaloEnergyCluster.cxx.

 {
   // keep this implementation separated (faster!)
   double adjWeight = weight - this->getCellWeight(cellIter);
   this->reweight(cellIter,weight);
   this->updateKine(*cellIter,adjWeight);
 }

◆ reweightCell() [2/3]

void CaloEnergyCluster::reweightCell	(	const CaloCell *	theCell,
		double	weight
	)

Reweight a cell with kinematic update.

Parameters

theCell	input pointer to a CaloCell object (unchanged)
weight	input new signal weight associated with this cell

Changes the kinematic weight of a cell in the cluster. No action if cell not in cluster. In particular, the cell is not added.

Definition at line 195 of file CaloEnergyCluster.cxx.

 {
   double adjWeight = weight - this->getCellWeight(pCell);
   this->reweight(pCell,weight);
   this->updateKine(pCell,adjWeight);
 }

◆ reweightCell() [3/3]

void CaloEnergyCluster::reweightCell	(	const CaloCellContainer *	theContainer,
		index_type &	theIndex,
		double	weight
	)

Reweight a cell with kinematic update.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer object (unchanged)
theIndex	input index of a CaloCell in CaloCellContainer (unchanged)
weight	input new signal weight associated with this cell

Changes the kinematic weight of a cell in the cluster. No action if not a valid pointer.

Definition at line 203 of file CaloEnergyCluster.cxx.

 {
   this->reweightCell((pContainer->operator[])(refIndex),weight);
   //  double adjWeight = weight - this->getCellWeight(pContainer,refIndex);
   //  this->reweight(pContainer,refIndex,weight);
   //  this->updateKine((pContainer->operator[])(refIndex),adjWeight);
 }

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

◆ setAthenaBarCode()

virtual void IAthenaBarCode::setAthenaBarCode ( AthenaBarCode_t )

inlinevirtualinherited

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

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

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

◆ setBasicEnergy()

virtual void CaloEnergyCluster::setBasicEnergy ( double theEnergy )

inlinevirtual

Set uncalibrated energy.

Parameters

theEnergy basic energy signal

Reimplemented in CaloTower.

Definition at line 58 of file CaloEnergyCluster.h.

58 { this->setE(theEnergy); }

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

void CaloEnergyCluster::setRecoStatus ( CaloRecoStatus::StatusIndicator recStatus )

Set the reconstruction status.

Definition at line 280 of file CaloEnergyCluster.cxx.

 {
   m_status = recStatus;
 }

◆ setVersion()

virtual void IAthenaBarCode::setVersion ( AthenaBarCodeVersion_t )

inlinevirtualinherited

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

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

◆ size()

virtual unsigned int Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::size ( ) const

virtualinherited

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

◆ toKidsAfterAccept() [1/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::toKidsAfterAccept ( INavigationToken & navToken ) const

privatevirtualinherited

◆ toKidsAfterAccept() [2/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::toKidsAfterAccept	(	INavigationToken &	navToken,
		const std::any &	aParameter
	)		const

privatevirtualinherited

◆ toKidsAfterReject() [1/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::toKidsAfterReject ( INavigationToken & navToken ) const

privatevirtualinherited

◆ toKidsAfterReject() [2/2]

virtual void Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::toKidsAfterReject	(	INavigationToken &	navToken,
		const std::any &	aParameter
	)		const

privatevirtualinherited

◆ updateKine()

virtual void CaloEnergyCluster::updateKine	(	const CaloCell *	theCell,
		double	weight
	)

protectedpure virtual

Interface to kinematic update implementation.

Implemented in CaloTower.

Member Data Documentation

◆ m_constituents

constituent_coll Navigable< CaloCellContainer , double , typename NavigationDefaults::DefaultChildColl<CaloCellContainer , double >::type >::m_constituents

privateinherited

Definition at line 345 of file Navigable.h.

◆ 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 CaloEnergyCluster::m_status

protected

Calorimeter reconstruction status.

Definition at line 325 of file CaloEnergyCluster.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:

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ cell_iterator

◆ const_cell_ptr

◆ constituent_coll

◆ constituent_const_iter

◆ constituent_const_ptr_ref

◆ constituent_iter

◆ constituent_ptr

◆ constituent_ptr_ref

◆ constituent_type

◆ container_type

◆ external_index_type

◆ index_type

◆ navhelper_t

◆ object_iter

◆ parameter_type

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ ~CaloEnergyCluster()

◆ CaloEnergyCluster()

Member Function Documentation

◆ addCell() [1/2]

◆ addCell() [2/2]

◆ addUniqueCell()

◆ addUniqueCellNoKine() [1/3]

◆ addUniqueCellNoKine() [2/3]

◆ addUniqueCellNoKine() [3/3]

◆ apply() [1/2]

◆ apply() [2/2]

◆ begin()

◆ cell_begin()

◆ cell_end()

◆ contains() [1/2]

◆ contains() [2/2]

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ dump()

◆ dumpStore()

◆ e()

◆ end()

◆ energy()

◆ errors()

◆ et()

◆ eta()

◆ fillToken() [1/2]

◆ fillToken() [2/2]

◆ getAthenaBarCode()

◆ getBasicEnergy()

◆ getCellContainer()

◆ getCellIndex()

◆ getCellWeight() [1/3]

◆ getCellWeight() [2/3]

◆ getCellWeight() [3/3]

◆ getConstituentPar() [1/2]

◆ getConstituentPar() [2/2]

◆ getConstituentPtr() [1/2]

◆ getConstituentPtr() [2/2]

◆ getConstituents() [1/2]

◆ getConstituents() [2/2]

◆ getContainer() [1/3]

◆ getContainer() [2/3]

◆ getContainer() [3/3]

◆ getIndex() [1/3]

◆ getIndex() [2/3]

◆ getIndex() [3/3]

◆ getNumberOfCells()

◆ getParameter() [1/3]

◆ getParameter() [2/3]

◆ getParameter() [3/3]

◆ getPtrToConstituents() [1/2]