#include <CaloLayerCalculator.h>

Collaboration diagram for CaloLayerCalculator:

Classes
struct	Helper
	Helper class for layer variable calculation. More...

Public Member Functions
	CaloLayerCalculator ()
	Initialization. More...

template<typename Iterator >
void	fill (Iterator beg, Iterator end, double eta, double phi, double deta, double dphi, CaloSampling::CaloSample sampling, xAOD::CaloCluster *tofill=0)
	Calculate layer variables from cells in a list. More...

StatusCode	fill (const CaloDetDescrManager &mgr, const CaloCellContainer cell_container, double eta, double phi, double deta, double dphi, CaloSampling::CaloSample sampling, xAOD::CaloCluster tofill=0)
	Calculate layer variables from a cell container. More...

double	etam () const
	Data access. More...

double	phim () const
	Get the mean layer \(\phi\) value. More...

double	etas () const
	Get the RMS \(\eta\) size. More...

double	phis () const
	Get the RMS \(\phi\) size. More...

double	em () const
	Get the total energy. More...

double	etamax () const
	Get maximum \(\eta\) value. More...

double	phimax () const
	Get maximum \(\phi\) value. More...

double	emax () const
	Get the maximum energy. More...

double	phimr () const
	Similar as phim, etam, phimax, etamax, but with raw quantities. More...

double	etamr () const

double	phirmax () const

double	etarmax () const

Private Member Functions
void	reset ()
	Internals. More...

void	resetOnNegativeEnergy ()
	Reset output variables, but not m_em, allowing samplings to be negative. More...

void	resetOnNegativeEnergy (double eta, double phi)
	Reset output variables, but not m_em, allowing samplings to be negative, fill layer position with original eta,phi seed position. More...

double	get_weight (CaloClusterCellLink::const_iterator it)
	Get the weight from a cell iterator. More...

double	get_weight (CaloClusterCellLink::iterator it)
	Get the weight from a cell iterator. More...

template<typename CONT , typename RPAR , typename COLL >
double	get_weight (NavigableIterator< CONT, RPAR, COLL > it)
	Get the weight from a cell iterator. More...

Static Private Member Functions
template<typename Iterator >
static double	get_weight (Iterator it)
	Get the weight from a cell iterator. More...

Private Attributes
double	m_etam = 0.0
	Layer variables. More...

double	m_phim = 0.0

double	m_etas = 0.0

double	m_phis = 0.0

double	m_em = 0.0

double	m_etamax = 0.0

double	m_phimax = 0.0

double	m_emax = 0.0

double	m_etamr = 0.0

double	m_phimr = 0.0

double	m_etarmax = 0.0

double	m_phirmax = 0.0

Friends
struct	Helper

Detailed Description

Definition at line 81 of file CaloLayerCalculator.h.

Constructor & Destructor Documentation

◆ CaloLayerCalculator()

CaloLayerCalculator::CaloLayerCalculator ( )

Initialization.

Default constructor.

Sets the variables to invalid values.

Definition at line 23 of file CaloLayerCalculator.cxx.

 {
   reset();
 }

Member Function Documentation

◆ em()

double CaloLayerCalculator::em ( ) const

inline

Get the total energy.

Returns: The total energy of the selected cells.

Definition at line 445 of file CaloLayerCalculator.h.

 {
   return m_em;
 }

◆ emax()

double CaloLayerCalculator::emax ( ) const

inline

Get the maximum energy.

Returns: The energy of the selected cell with the most energy.

Definition at line 480 of file CaloLayerCalculator.h.

 {
   return m_emax;
 }

◆ etam()

double CaloLayerCalculator::etam ( ) const

inline

Data access.

Get the mean layer \(\eta\) value.

Returns: The mean \(\eta\) of the selected cells, or -999.; The mean \(\eta\) of the selected cells, or -999.

Definition at line 401 of file CaloLayerCalculator.h.

 {
   return m_etam;
 }

◆ etamax()

double CaloLayerCalculator::etamax ( ) const

inline

Get maximum \(\eta\) value.

Returns: The \(\eta\) center of the selected cell with the most energy, or -999.

Definition at line 457 of file CaloLayerCalculator.h.

 {
   return m_etamax;
 }

◆ etamr()

double CaloLayerCalculator::etamr ( ) const

inline

Definition at line 219 of file CaloLayerCalculator.h.

219 { return m_etamr; }

◆ etarmax()

double CaloLayerCalculator::etarmax ( ) const

inline

Definition at line 221 of file CaloLayerCalculator.h.

221 { return m_etarmax; }

◆ etas()

double CaloLayerCalculator::etas ( ) const

inline

Get the RMS \(\eta\) size.

Returns: The RMS \(\eta\) of the selected cells.

Definition at line 423 of file CaloLayerCalculator.h.

 {
   return m_etas;
 }

◆ fill() [1/2]

StatusCode CaloLayerCalculator::fill	(	const CaloDetDescrManager &	mgr,
		const CaloCellContainer *	cell_container,
		double	eta,
		double	phi,
		double	deta,
		double	dphi,
		CaloSampling::CaloSample	sampling,
		xAOD::CaloCluster *	tofill = `0`
	)

Calculate layer variables from a cell container.

Parameters

mgr	CaloDetDescrManager
cell_container	The cell container.
eta	The \(\eta\) center of the cluster, for cell selection.
phi	The \(\phi\) center of the cluster, for cell selection.
deta	The \(\eta\) full width for cell selection.
dphi	The \(\phi\) full width for cell selection.
sampling	The sampling for cell selection.
tofill	If non-null, then selected cells will be added to this cluster.

This takes a list of cells from a cell container, selects those within a deta by dphi window around eta, phi in layer sampling, and fills the layer variables from them. If tofill is non-null, then selected cells will also be added to the cluster tofill.

Parameters

cell_container	The cell container.
eta	The \(\eta\) center of the cluster, for cell selection.
phi	The \(\phi\) center of the cluster, for cell selection.
deta	The \(\eta\) full width for cell selection.
dphi	The \(\phi\) full width for cell selection.
sampling	The sampling for cell selection.
tofill	If non-null, then selected cells will be added to this cluster.

This takes a list of cells from a cell container, selects those within a deta by dphi window around eta, phi in layer sampling, and fills the layer variables from them. If tofill is non-null, then selected cells will also be added to the cluster tofill.

Definition at line 47 of file CaloLayerCalculator.cxx.

 {
  
   //Check if cell_container and cluster matches
   if (tofill) {
     if (tofill->getCellLinks()->getCellContainer()!=cell_container) {
       std::cout << "ERROR attempt to fill a cluster from different cell containers\n";
       return StatusCode::FAILURE;
     }
   }
  
   CaloCellList cell_list(&mgr,cell_container);
   cell_list.select(eta,phi,deta,dphi,sampling);
  
   fill (cell_list.begin(),
         cell_list.end(),
         eta, phi, deta, dphi, sampling, tofill);
  
   return StatusCode::SUCCESS;
 }

◆ fill() [2/2]

template<typename Iterator >

void CaloLayerCalculator::fill	(	Iterator	beg,
		Iterator	end,
		double	eta,
		double	phi,
		double	deta,
		double	dphi,
		CaloSampling::CaloSample	sampling,
		xAOD::CaloCluster *	tofill = `0`
	)

Calculate layer variables from cells in a list.

Parameters

beg	The starting iterator for the cell list.
end	The ending iterator for the cell list.
eta	The \(\eta\) center of the cluster, for cell selection.
phi	The \(\phi\) center of the cluster, for cell selection.
deta	The \(\eta\) full width for cell selection.
dphi	The \(\phi\) full width for cell selection.
sampling	The sampling for cell selection.
tofill	If non-null, then selected cells will be added to this cluster.

This takes a list of cells specified by beg and end, selects those within a deta by dphi window around eta, phi in layer sampling, and fills the layer variables from them. If the iterators come from a Navigable, then cell weights will be used in the calculation. If tofill and cell_container are non-null, then selected cells will also be added to the cluster tofill.

Parameters

beg	The starting iterator for the cell list.
end	The ending iterator for the cell list.
eta	The \(\eta\) center of the cluster, for cell selection.
phi	The \(\phi\) center of the cluster, for cell selection.
deta	The \(\eta\) full width for cell selection.
dphi	The \(\phi\) full width for cell selection.
sampling	The sampling for cell selection.
tofill	If non-null, then selected cells will be added to this cluster.
cell_container	If `tofill` is non-null, then this is this container from which the cells came.

This takes a list of cells specified by beg and end, selects those within a deta by dphi window around eta, phi in layer sampling, and fills the layer variables from them. If the iterators come from a Navigable, then cell weights will be used in the calculation. If tofill and cell_container are non-null, then selected cells will also be added to the cluster tofill; in this case, cell_container should be the container in storegate holding the cells.

Definition at line 376 of file CaloLayerCalculator.h.

 {
   reset();
   const CaloCellContainer* cell_container=0;
   if (tofill) cell_container=tofill->getCellLinks()->getCellContainer();
   if (beg != end) {
     Helper h (*this, eta, phi, deta, dphi, sampling, tofill, cell_container);
     for (; beg != end; ++beg)
       h.cell (*beg, get_weight (beg));
   }
 }

◆ get_weight() [1/4]

double CaloLayerCalculator::get_weight ( CaloClusterCellLink::const_iterator it )

inlineprivate

Get the weight from a cell iterator.

This is the version specialized for CaloClusterCellLink::const_iterator

Definition at line 506 of file CaloLayerCalculator.h.

 {
   return it.weight();
 }

◆ get_weight() [2/4]

double CaloLayerCalculator::get_weight ( CaloClusterCellLink::iterator it )

inlineprivate

Get the weight from a cell iterator.

This is the version specialized for CaloClusterCellLink::iterator

Definition at line 513 of file CaloLayerCalculator.h.

 {
   return it.weight();
 }

◆ get_weight() [3/4]

template<typename Iterator >

double CaloLayerCalculator::get_weight ( Iterator it )

inlinestaticprivate

Get the weight from a cell iterator.

This is the generic version, that always returns 1.

Definition at line 490 of file CaloLayerCalculator.h.

 {
   return 1;
 }

◆ get_weight() [4/4]

template<typename CONT , typename RPAR , typename COLL >

double CaloLayerCalculator::get_weight ( NavigableIterator< CONT, RPAR, COLL > it )

inlineprivate

Get the weight from a cell iterator.

This is the version specialized for a Navigable, which returns the Navigable parameter.

Definition at line 500 of file CaloLayerCalculator.h.

 {
   return it.getParameter();
 }

◆ phim()

double CaloLayerCalculator::phim ( ) const

inline

Get the mean layer \(\phi\) value.

Returns: The mean \(\phi\) of the selected cells, or -999.

Definition at line 412 of file CaloLayerCalculator.h.

 {
   return m_phim;
 }

◆ phimax()

double CaloLayerCalculator::phimax ( ) const

inline

Get maximum \(\phi\) value.

Returns: The \(\phi\) center of the selected cell with the most energy, or -999.

Definition at line 469 of file CaloLayerCalculator.h.

 {
   return m_phimax;
 }

◆ phimr()

double CaloLayerCalculator::phimr ( ) const

inline

Similar as phim, etam, phimax, etamax, but with raw quantities.

Definition at line 218 of file CaloLayerCalculator.h.

218 { return m_phimr; }

◆ phirmax()

double CaloLayerCalculator::phirmax ( ) const

inline

Definition at line 220 of file CaloLayerCalculator.h.

220 { return m_phirmax; }

◆ phis()

double CaloLayerCalculator::phis ( ) const

inline

Get the RMS \(\phi\) size.

Returns: The RMS \(\phi\) of the selected cells.

Definition at line 434 of file CaloLayerCalculator.h.

 {
   return m_phis;
 }

◆ reset()

void CaloLayerCalculator::reset ( )

private

Internals.

Reset output variables to invalid values.

Reset all variables to invalid values.

Definition at line 76 of file CaloLayerCalculator.cxx.

 {
   m_etam   = -999;
   m_phim   = -999;
   m_etamax = -999;
   m_phimax = -999;
   m_etarmax= -999;
   m_phirmax= -999;
  
   m_etas   = 0;
   m_phis   = 0;
   m_em     = 0;
   m_emax   = 0;
  
   // Added to cluster in the calorimeter frame
   m_etamr  = -999;
   m_phimr  = -999;
  
 }

◆ resetOnNegativeEnergy() [1/2]

void CaloLayerCalculator::resetOnNegativeEnergy ( )

private

Reset output variables, but not m_em, allowing samplings to be negative.

Definition at line 98 of file CaloLayerCalculator.cxx.

 {
   m_etam   = -999;
   m_phim   = -999;
   m_etamax = -999;
   m_phimax = -999;
   // Don't reset these --- that could prevent us from being able
   // to calculate the e2* variables in egammaMiddleShape if there
   // are negative energy cells just outside the cluster.
   //m_etarmax= -999;
   //m_phirmax= -999;
  
   m_etas   = 0;
   m_phis   = 0;
   //m_em     = 0;
   m_emax   = 0;
  
   // Added to cluster in the calorimeter frame
   m_etamr  = -999;
   m_phimr  = -999;
 }

◆ resetOnNegativeEnergy() [2/2]

void CaloLayerCalculator::resetOnNegativeEnergy	(	double	eta,
		double	phi
	)

private

Reset output variables, but not m_em, allowing samplings to be negative, fill layer position with original eta,phi seed position.

Reset output variables using seed position to fill eta,phi layer variables but not m_em, allowing samplings to be negative.

Definition at line 121 of file CaloLayerCalculator.cxx.

 {
   m_etam   = eta;
   m_phim   = phi;
   m_etamax = eta;
   m_phimax = phi;
   m_etarmax= eta;
   m_phirmax= phi;
  
   m_etas   = 0;
   m_phis   = 0;
   //m_em     = 0;
   m_emax   = 0;
  
   // Added to cluster in the calorimeter frame
   m_etamr  = eta;
   m_phimr  = phi;
 }

Friends And Related Function Documentation

◆ Helper

friend struct Helper

friend

Definition at line 347 of file CaloLayerCalculator.h.

Member Data Documentation

◆ m_em

double CaloLayerCalculator::m_em = 0.0

private

Definition at line 262 of file CaloLayerCalculator.h.

◆ m_emax

double CaloLayerCalculator::m_emax = 0.0

private

Definition at line 265 of file CaloLayerCalculator.h.

◆ m_etam

double CaloLayerCalculator::m_etam = 0.0

private

Layer variables.

Definition at line 258 of file CaloLayerCalculator.h.

◆ m_etamax

double CaloLayerCalculator::m_etamax = 0.0

private

Definition at line 263 of file CaloLayerCalculator.h.

◆ m_etamr

double CaloLayerCalculator::m_etamr = 0.0

private

Definition at line 268 of file CaloLayerCalculator.h.

◆ m_etarmax

double CaloLayerCalculator::m_etarmax = 0.0

private

Definition at line 270 of file CaloLayerCalculator.h.

◆ m_etas

double CaloLayerCalculator::m_etas = 0.0

private

Definition at line 260 of file CaloLayerCalculator.h.

◆ m_phim

double CaloLayerCalculator::m_phim = 0.0

private

Definition at line 259 of file CaloLayerCalculator.h.

◆ m_phimax

double CaloLayerCalculator::m_phimax = 0.0

private

Definition at line 264 of file CaloLayerCalculator.h.

◆ m_phimr

double CaloLayerCalculator::m_phimr = 0.0

private

Definition at line 269 of file CaloLayerCalculator.h.

◆ m_phirmax

double CaloLayerCalculator::m_phirmax = 0.0

private

Definition at line 271 of file CaloLayerCalculator.h.

◆ m_phis

double CaloLayerCalculator::m_phis = 0.0

private

Definition at line 261 of file CaloLayerCalculator.h.

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

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CaloLayerCalculator()

Member Function Documentation

◆ em()

◆ emax()

◆ etam()

◆ etamax()

◆ etamr()

◆ etarmax()

◆ etas()

◆ fill() [1/2]

◆ fill() [2/2]

◆ get_weight() [1/4]

◆ get_weight() [2/4]

◆ get_weight() [3/4]

◆ get_weight() [4/4]

◆ phim()

◆ phimax()

◆ phimr()

◆ phirmax()

◆ phis()

◆ reset()

◆ resetOnNegativeEnergy() [1/2]

◆ resetOnNegativeEnergy() [2/2]

Friends And Related Function Documentation

◆ Helper

Member Data Documentation

◆ m_em

◆ m_emax

◆ m_etam

◆ m_etamax

◆ m_etamr

◆ m_etarmax

◆ m_etas

◆ m_phim

◆ m_phimax

◆ m_phimr

◆ m_phirmax

◆ m_phis