CaloTowerGeometry Class Reference

Retrieve the list of towers associated with a calorimeter cell referenced by its hash identifier. More...

#include <CaloTowerGeometry.h>

Collaboration diagram for CaloTowerGeometry:

Public Types
typedef std::size_t	uint_t
	Type for unsigned integer.
typedef IdentifierHash::value_type	index_t
	Type for scalar (pseudorapidity,azimuth) index (is an unsigned int type)
typedef std::tuple< index_t, double >	element_t
	Type storing tower index and geometrical weight.
typedef std::vector< element_t >	elementvector_t
	Type for list of elements holding tower index and list of weights.
typedef std::vector< elementvector_t >	elementmap_t
	Type for lists of lists of elements (lookup table type)

Public Member Functions
	CaloTowerGeometry (const CaloDetDescrManager *caloDDM)
	Standard constructor.
	CaloTowerGeometry ()=delete
StatusCode	initialize (MsgStream &msg)
	Initialize object.
Retrieve towers for cells
StatusCode	access (IdentifierHash cellHash, std::vector< index_t > &towerIdx, std::vector< double > &towerWghts) const
elementvector_t	getTowers (IdentifierHash cellHash) const
	Retrieve the list of towers associated with a calorimeter cell referenced its hash identifier.
Tower bin descriptors and other size information
uint_t	maxCellHash () const
	Maximum cell hash value.
uint_t	totalNumberCells () const
	Total number of cells.
uint_t	etaBins () const
	Number of pseudorapidity bins.
double	etaMin () const
	Lower boundary of pseudorapidity range.
double	etaMax () const
	Upper boundary of pseudorapidity range.
double	etaWidth () const
	Width of pseudorapidity bin.
uint_t	phiBins () const
	Number of azimuth bins.
double	phiMin () const
	Lower boundary of azimuth.
double	phiMax () const
	Upper boundary of azimuth.
double	phiWidth () const
	Width of azimuth bin.
uint_t	towerBins () const
	Total number of towers.
double	towerArea () const
	Area of individual tower.
Tower index calculators, translaters, manipulators and converters
index_t	etaIndex (IdentifierHash cellHash) const
	Get tower \( \eta \) bin index for a calorimeter cell referenced by its hash identifier.
index_t	etaIndex (double eta) const
	Get tower \( \eta \) bin index for a given value of \( \eta \).
index_t	etaIndexFromTowerIndex (index_t towerIdx) const
	Get tower \( \eta \) bin index for a given global tower index.
index_t	phiIndex (IdentifierHash cellHash) const
	Get tower \( \phi \) bin index for a calorimeter cell referenced by its hash identifier.
index_t	phiIndex (double phi) const
	Get tower \( \phi \) bin index for a given value of \( \phi \).
index_t	phiIndexFromTowerIndex (index_t towerIdx) const
	Get tower \( \phi \) bin index for a given global tower index.
index_t	towerIndex (IdentifierHash cellHash) const
	Get global tower index for a calorimeter cell referenced by its hash identifier.
index_t	towerIndex (double eta, double phi) const
	Get global tower index for a pair of \( (\eta,\phi) \) values.
index_t	towerIndex (index_t etaIdx, index_t phiIdx) const
	Get global tower index for a pair of \( (\eta,\phi) \) indices.
index_t	towerIndex (const element_t &elm) const
	Get global tower index from payload data.
index_t	invalidIndex () const
	Returns value of invalid index.
bool	isInvalidIndex (index_t idx) const
	Returns true if argument is equal to the value provided by invalidIndex()
bool	isInvalidIndex (index_t idx, index_t maxIdx) const
	Returns true if first argument is equal to the value provided by invalidIndex() or if first argument is not smaller than second argument.
bool	isInvalidEtaIndex (index_t idx) const
	Returns true if argument is not a valid pseudorapidity index.
bool	isInvalidPhiIndex (index_t idx) const
	Returns true if argumant is not a valid azimuth index.
bool	isInvalidTowerIndex (index_t idx) const
	Returns true if argument is not a valid tower index.
Variable generators using tower indices
double	towerEtaLocal (index_t etaIndex) const
	Return pseudorapdity from local index (bin center)
double	towerPhiLocal (index_t phiIndex) const
	Return azimuth from local index (bin center)
double	towerEta (index_t towerIndex) const
	Return pseudorapidity from global tower index (bin center)
double	towerPhi (index_t towerIndex) const
	Return azimuth from global tower index (bin center)
double	invalidValue () const
	Return invalid value.
bool	isInvalidValue (double val) const
	Return true if given value is invalid.
Helper functions
double	cellWeight (const element_t &elm) const
	Retrieve cell signal weight from lookup table entry.
double	cellWeight (IdentifierHash cellHash, index_t towerIdx) const
	Retrieve cell signal weight from cell identifier and tower index.
Access to storage
elementmap_t::const_iterator	begin () const
	Iterator points to first entry in internal look-up table (only const access!)
elementmap_t::const_iterator	end () const
	Iterator marks end of internal look-up table (only const access)
size_t	size () const
	Size of internal look-up table.
bool	empty () const
	Internal look-up table is empty if true.

Protected Attributes
Internal stores and derived parameters
elementmap_t	m_towerLookup
	Cell-to-tower mapping lookup store.
double	m_towerEtaWidth
	Width of tower bin in pseudorapidity.
double	m_towerPhiWidth
	Width of tower bin in azimuth.
double	m_towerArea
	Area of individual tower.
uint_t	m_towerBins
	Maximum number of towers.
uint_t	m_maxCellHash
	Maximum cell hash value.
uint_t	m_numberOfCells {}
	Total number of cells.
Properties
uint_t	m_towerEtaBins
	Internally stored tower grid descriptors.
double	m_towerEtaMin
	Lower boundary \( \eta_{\rm min} \).
double	m_towerEtaMax
	Upper boundary \( \eta_{\rm max} \).
bool	m_adjustEta
	Adjust FCal cells to eta boundary (default true )
uint_t	m_towerPhiBins
	Number of \( \phi \) bins.
double	m_towerPhiMin
	Lower boundary \( \phi_{\rm min} \).
double	m_towerPhiMax
	Upper boundary \( \phi_{\rm max} \).
double	m_fcal1Xslice
	Number of x slices for cells in FCal1.
double	m_fcal1Yslice
	Number of y slices for cells in FCal1.
double	m_fcal2Xslice
	Number of x slices for cells in FCal2.
double	m_fcal2Yslice
	Number of y slices for cells in FCal2.
double	m_fcal3Xslice
	Number of x slices for cells in FCal3.
double	m_fcal3Yslice
	Number of y slices for cells in FCal3.
Stores
std::array< double, 3 >	m_ndxFCal {}
	Stores number of fragments along x for each FCal module.
std::array< double, 3 >	m_ndyFCal {}
	Stores number of fragments along y for each FCal module.
std::array< double, 3 >	m_wgtFCal {}
	Stores geometrical weights.

Private Member Functions
Helpers
StatusCode	f_setupTowerGrid (MsgStream &msg)
	Internally used function setting up the lookup store.
StatusCode	f_setupTowerGridFCal (const CaloDetDescrElement *pCaloDDE, MsgStream &msg)
	Internally used function mapping an FCal cell onto the tower grid.
StatusCode	f_setupTowerGridProj (const CaloDetDescrElement *pCaloDDE, MsgStream &msg)
	Internally used function mapping a projective cell onto the tower grid.
double	f_assign (IdentifierHash cellHash, index_t towerIdx, double wgt)
	Internally used function assigning tower to cell with update of weight if same tower is already assigned.

Private Attributes
Access to detector store and other services and stores
const CaloDetDescrManager *	m_caloDDM
	Pointer to calorimeter detector description.

Friends
class	CaloTowerGeometryCondAlg

Process flags, helpers and numerical constants
static const index_t	m_invalidIndex = index_t(-1)
	Invalid index indicator.
static const double	m_invalidValue = -999.
	Return value for out-of-range indices andother invalid conversions to a physical quantity.
const CaloDetDescrManager *	f_caloDDM () const
	Pointer to calorimeter detector description manager.
const CaloDetDescrElement *	f_caloDDE (IdentifierHash cellHash) const
	Retrieve calorimeter detector description element for a given cell hash identifier.
double	f_cellEta (IdentifierHash cellHash) const
	Retrieve calorimeter cell pseudorapidity for a given cell hash identifier.
double	f_cellPhi (IdentifierHash cellHash) const
	Retrieve calorimeter cell azimuth for a given cell hash identifier.

Detailed Description

Retrieve the list of towers associated with a calorimeter cell referenced by its hash identifier.

Returns

Returns a vector of (index,weight) pairs as a elementvector_t container. The container is empty if the cell does not have any overlap with a tower.

Parameters

[in]

cellHash

hash identifier referencing a calorimeter cell.

Tower geometry store and description provider

This service sets up a lookup table storing the geometrical area overlap fraction of a calorimeter cell with towers in a given grid. This lookup table is set up at instantiation of the service. It can only be defined at that time. The default setup is a \( \Delta\eta\times\Delta\phi = 0.1 \times \pi/32 \) grid. Any regular grid can be constructed. The grid definition can be provided as property.

The cell-to-tower information is stored internally as a (random access) lookup table. For a given cell, the hash index is used to retrieve a list of towers this cell overlaps with, and the overlap paramater (area fraction used as a geometrical weight). This indices and geometrical weights are represented by a list of pairs of int and double numbers. Each cell can potential overlap with more than one tower. A more detailed description of towers and the geometrical overlap is available on the calorimeter tower project page.

The lookup table is implemented for random access and using the cell hash identifier to retrieve the requested list of twoer indices and weights. Several retrieval mechanisms are supported (see documentation of the corresponding methods).

To map the azimuth of a cell to a tower, \( -\pi < \phi < \pi \) is used (ATLAS standard). For consistency, all \( \phi \) values are mapped into this range.

The service inherits from AthService and thus from the Service base class in Gaudi. The managed tower grid is defined by service properties, with the following naming convention:

• pseudorapidity range
  • number of bins TowerEtaBins (default 100)
  • lower boundary of pseudorapidity range TowerEtaMin (default -5.0)
  • upper boundary of pseudorapidity range TowerEtaMax (default 5.0)
• azimuth range
  • number of bins TowerPhiBins (default 64)
  • lower boundary of azimuthal range TowerPhiMin (default -π)
  • upper boundary of azimuthal range TowerPhiMax (default π)

Addtional properties of this service define the granularity of the cell splitting in the ATLAS FCal. This is used to map the FCal readout cells (rectangular slabs) onto the tower grid and calculate the geometrical (area) overlap fraction, which is used to distribute the cell energy to the towers.

• horizontal FCal cell splitting (along x axis)
  • number of x slices in FCal1 FCal1NSlicesX (default 4)
  • number of x slices in FCal2 FCal2NSlicesX (default 4)
  • number of x slices in FCal3 FCal3NSlicesX (default 6)
• vertical FCal cell splitting (along y axis)
  • number of y slices in FCal1 FCal1NSlicesY (default 4)
  • number of y slices in FCal2 FCal2NSlicesY (default 6)
  • number of y slices in FCal3 FCal3NSlicesY (default 6)

Warning

It is recommended to not change the parameters for the FCal cell slicing. This configuration option is provided for expert use for R & D purposes only.

Todo

Allow regional grids (varying segmentation as function of \( \eta \) . This requires additional interfaces (or interface changes) and and modifications of the index construction.

Author

Peter Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Definition at line 23 of file CaloTowerGeometry.h.

Member Typedef Documentation

element_t

typedef std::tuple<index_t,double> CaloTowerGeometry::element_t

Type storing tower index and geometrical weight.

Definition at line 28 of file CaloTowerGeometry.h.

elementmap_t

typedef std::vector<elementvector_t> CaloTowerGeometry::elementmap_t

Type for lists of lists of elements (lookup table type)

Definition at line 30 of file CaloTowerGeometry.h.

elementvector_t

typedef std::vector<element_t> CaloTowerGeometry::elementvector_t

Type for list of elements holding tower index and list of weights.

Definition at line 29 of file CaloTowerGeometry.h.

index_t

typedef IdentifierHash::value_type CaloTowerGeometry::index_t

Type for scalar (pseudorapidity,azimuth) index (is an unsigned int type)

Definition at line 27 of file CaloTowerGeometry.h.

uint_t

typedef std::size_t CaloTowerGeometry::uint_t

Type for unsigned integer.

Definition at line 26 of file CaloTowerGeometry.h.

Constructor & Destructor Documentation

CaloTowerGeometry() [1/2]

CaloTowerGeometry::CaloTowerGeometry

(

const CaloDetDescrManager *

caloDDM

)

Standard constructor.

Definition at line 9 of file CaloTowerGeometry.cxx.

                                                                       :
    m_caloDDM(caloDDM)
  , m_towerEtaWidth(0.)
  , m_towerPhiWidth(0.)
  , m_towerArea(0.)
  , m_towerBins(0)                              
  , m_maxCellHash(0)                            //----------------------------------------//
  , m_towerEtaBins(100)                         // Default tower definition is "hadronic" //
  , m_towerEtaMin(-5.0)                         // towers of size 0.1 x pi/32.            // 
  , m_towerEtaMax(5.0)                          //----------------------------------------//
  , m_adjustEta(true)
  , m_towerPhiBins(64)                          
  , m_towerPhiMin(-pi)                         //----------------------------------------//
  , m_towerPhiMax(pi)                          // FCal vertical and horizontal cell      //
  , m_fcal1Xslice(8.)                           // slicing creates "mini-cells" which are //
  , m_fcal1Yslice(8.)                           // then projected onto towers. The mini-  //
  , m_fcal2Xslice(8.)                           // cell signal is 1/(Nx x Ny) x Ecell,    //
  , m_fcal2Yslice(12.)                          // where Nx(y) are the number of x(y)     //
  , m_fcal3Xslice(12.)                          // slices.                                //
  , m_fcal3Yslice(12.)                          //----------------------------------------//
{}

CaloTowerGeometry() [2/2]

CaloTowerGeometry::CaloTowerGeometry ( )

delete

Member Function Documentation

access()

StatusCode CaloTowerGeometry::access	(	IdentifierHash	cellHash,
		std::vector< index_t > &	towerIdx,
		std::vector< double > &	towerWghts ) const

Definition at line 234 of file CaloTowerGeometry.cxx.

{
  towerIdx.clear();
  towerWghts.clear();
 
  uint_t cidx(static_cast<uint_t>(cellHash));
 
  if ( cidx >= m_towerLookup.size() ) { 
    //ATH_MSG_WARNING("Invalid cell hash index " << cellHash << ", corresponding index " << cidx << " not found in tower lookup");
    return StatusCode::SUCCESS;
  }
 
  if ( towerIdx.capacity()   < m_towerLookup.at(cidx).size() ) { towerIdx.reserve(m_towerLookup.at(cidx).size());   }
  if ( towerWghts.capacity() < m_towerLookup.at(cidx).size() ) { towerWghts.reserve(m_towerLookup.at(cidx).size()); }
 
  for ( const auto& elm : m_towerLookup.at(cidx) ) { towerIdx.push_back(towerIndex(elm)); towerWghts.push_back(cellWeight(elm)); }
 
  return StatusCode::SUCCESS;
}

begin()

CaloTowerGeometry::elementmap_t::const_iterator CaloTowerGeometry::begin ( ) const

inline

Iterator points to first entry in internal look-up table (only const access!)

Definition at line 329 of file CaloTowerGeometry.h.

{ return m_towerLookup.begin(); }

cellWeight() [1/2]

double CaloTowerGeometry::cellWeight ( const element_t & elm ) const

inline

Retrieve cell signal weight from lookup table entry.

Definition at line 337 of file CaloTowerGeometry.h.

{ return std::get<1>(elm); }

cellWeight() [2/2]

double CaloTowerGeometry::cellWeight	(	IdentifierHash	cellHash,
		index_t	towerIdx ) const

Retrieve cell signal weight from cell identifier and tower index.

Definition at line 270 of file CaloTowerGeometry.cxx.

{
  index_t cidx(static_cast<uint_t>(cellHash));
  double cwght(0.);
 
  if ( cidx < m_towerLookup.size() ) {
    for ( auto elm : m_towerLookup.at(cidx) ) { 
      if ( towerIndex(elm) == towerIdx ) { cwght = cellWeight(elm); break; } 
    } 
  }
  return cwght;
}

empty()

bool CaloTowerGeometry::empty ( ) const

inline

Internal look-up table is empty if true.

Definition at line 332 of file CaloTowerGeometry.h.

{ return m_towerLookup.empty(); }

end()

CaloTowerGeometry::elementmap_t::const_iterator CaloTowerGeometry::end ( ) const

inline

Iterator marks end of internal look-up table (only const access)

Definition at line 330 of file CaloTowerGeometry.h.

{ return m_towerLookup.end(); }

etaBins()

CaloTowerGeometry::uint_t CaloTowerGeometry::etaBins ( ) const

inline

Number of pseudorapidity bins.

Definition at line 283 of file CaloTowerGeometry.h.

{ return m_towerEtaBins;  }

etaIndex() [1/2]

CaloTowerGeometry::index_t CaloTowerGeometry::etaIndex

(

double

eta

)

const

Get tower \( \eta \) bin index for a given value of \( \eta \).

Definition at line 293 of file CaloTowerGeometry.cxx.

{ 
  return eta >= m_towerEtaMin && eta <= m_towerEtaMax 
    ? index_t(std::min(static_cast<uint_t>((eta-m_towerEtaMin)/m_towerEtaWidth),m_towerEtaBins-1))
    : invalidIndex(); 
}

etaIndex() [2/2]

CaloTowerGeometry::index_t CaloTowerGeometry::etaIndex

(

IdentifierHash

cellHash

)

const

Get tower \( \eta \) bin index for a calorimeter cell referenced by its hash identifier.

Definition at line 287 of file CaloTowerGeometry.cxx.

{
  const auto *const cdde = f_caloDDE(cellHash); 
  return cdde != nullptr ? etaIndex(cdde->eta()) : invalidIndex(); 
}

etaIndexFromTowerIndex()

CaloTowerGeometry::index_t CaloTowerGeometry::etaIndexFromTowerIndex ( index_t towerIdx ) const

inline

Get tower \( \eta \) bin index for a given global tower index.

Definition at line 315 of file CaloTowerGeometry.h.

{ return (index_t)(towerIdx/phiBins()); }

etaMax()

double CaloTowerGeometry::etaMax ( ) const

inline

Upper boundary of pseudorapidity range.

Definition at line 285 of file CaloTowerGeometry.h.

{ return m_towerEtaMax;   }

etaMin()

double CaloTowerGeometry::etaMin ( ) const

inline

Lower boundary of pseudorapidity range.

Definition at line 284 of file CaloTowerGeometry.h.

{ return m_towerEtaMin;   }

etaWidth()

double CaloTowerGeometry::etaWidth ( ) const

inline

Width of pseudorapidity bin.

Definition at line 286 of file CaloTowerGeometry.h.

{ return m_towerEtaWidth; }

f_assign()

double CaloTowerGeometry::f_assign ( IdentifierHash cellHash, index_t towerIdx, double wgt )

private

Internally used function assigning tower to cell with update of weight if same tower is already assigned.

Definition at line 218 of file CaloTowerGeometry.cxx.

{
  // check if cell-tower already related
  uint_t cidx(static_cast<uint_t>(cellHash));
  for ( element_t& elm : m_towerLookup.at(cidx) ) { 
    if ( towerIndex(elm) == towerIdx ) { std::get<1>(elm) += wght; return cellWeight(elm); }  
  }
  // not yet related
  m_towerLookup[cidx].emplace_back(towerIdx,wght);
  return cellWeight(m_towerLookup.at(cidx).back()); 
}

f_caloDDE()

const CaloDetDescrElement * CaloTowerGeometry::f_caloDDE ( IdentifierHash cellHash ) const

inlineprotected

Retrieve calorimeter detector description element for a given cell hash identifier.

Definition at line 344 of file CaloTowerGeometry.h.

{ return f_caloDDM()->get_element(cellHash); }

f_caloDDM()

const CaloDetDescrManager * CaloTowerGeometry::f_caloDDM ( ) const

inlineprotected

Pointer to calorimeter detector description manager.

Definition at line 343 of file CaloTowerGeometry.h.

{ return m_caloDDM; } 

f_cellEta()

double CaloTowerGeometry::f_cellEta ( IdentifierHash cellHash ) const

inlineprotected

Retrieve calorimeter cell pseudorapidity for a given cell hash identifier.

Definition at line 346 of file CaloTowerGeometry.h.

{ return f_caloDDE(cellHash)->eta(); }

f_cellPhi()

double CaloTowerGeometry::f_cellPhi ( IdentifierHash cellHash ) const

inlineprotected

Retrieve calorimeter cell azimuth for a given cell hash identifier.

Definition at line 347 of file CaloTowerGeometry.h.

{ return CaloPhiRange::fix(f_caloDDE(cellHash)->phi()); }

f_setupTowerGrid()

StatusCode CaloTowerGeometry::f_setupTowerGrid ( MsgStream & msg )

private

Internally used function setting up the lookup store.

Definition at line 61 of file CaloTowerGeometry.cxx.

{
  // initialized
  if ( m_maxCellHash == 0 ) { 
    msg << "Service not initialized? Maximum cell hash is " << m_maxCellHash << endmsg;
    return StatusCode::FAILURE;
  }
 
  // payload template
  elementvector_t ev;
 
  // set up lookup table
  msg << "Setting up cell-to-tower lookup for " << m_numberOfCells << " calorimeter cells" << endmsg;
  m_towerLookup.resize(m_numberOfCells,ev);
 
  // loop cells
  for ( auto fcell(m_caloDDM->element_begin()); fcell != m_caloDDM->element_end(); ++fcell ) {
    // reference cell descriptor
    const CaloDetDescrElement* pCaloDDE = *fcell; 
    // check hash id validity
    index_t cidx(pCaloDDE->calo_hash());
    if ( cidx >= m_towerLookup.size() ) { 
      msg << MSG::WARNING << "Cell hash identifier out of range " << cidx << "/" << m_towerLookup.size() << ", ignore cell" << endmsg;
    } else {
      if ( pCaloDDE->is_lar_fcal() ) { 
    if ( this->f_setupTowerGridFCal(pCaloDDE,msg).isFailure() ) { return StatusCode::FAILURE; }
      } else {
    if ( this->f_setupTowerGridProj(pCaloDDE,msg).isFailure() ) { return StatusCode::FAILURE; }
      } 
    } // cell hash in range?    
  } // loop cell descriptors
 
  return StatusCode::SUCCESS;
}

f_setupTowerGridFCal()

StatusCode CaloTowerGeometry::f_setupTowerGridFCal ( const CaloDetDescrElement * pCaloDDE, MsgStream & msg )

private

Internally used function mapping an FCal cell onto the tower grid.

Definition at line 96 of file CaloTowerGeometry.cxx.

{
  //-----------------------------------------------------------------------------------------//
  // FCal special - the rectangular (in linear space) calorimeter cells are sub-divided into //
  // small cells and then shared across as many towers as the small cells cover.             //
  //-----------------------------------------------------------------------------------------//
 
  // collect geometrical variables
  int    cLayer(pCaloDDE->getLayer()-1);   // FCal layer number 1..3 -> array indices 0..2
 
  double cXpos(pCaloDDE->x_raw());             // FCal cell x position (cell center)             
  double cYpos(pCaloDDE->y_raw());             // FCal cell y position (cell center)
  double cZpos(pCaloDDE->z_raw());             // FCal cell z position (cell center)
  double cZpos2(cZpos*cZpos); 
 
  double cXwid(pCaloDDE->dx());            // FCal cell x full width 
  double cYwid(pCaloDDE->dy());            // FCal cell y full width 
 
  // double xSlice(cXwid/m_ndxFCal[cLayer]);  // FCal cell x slize width
  // double ySlice(cYwid/m_ndyFCal[cLayer]);  // FCal cell y slice width
  double cWght(m_wgtFCal[cLayer]);         // FCal cell geometrical (signal) weight
 
  int nXslice((int)m_ndxFCal[cLayer]);     // FCal number of x slices
  int nYslice((int)m_ndyFCal[cLayer]);     // FCal number of y slices
  double cXstp(cXwid/((double)nXslice));   // FCal slice x width
  double cYstp(cYwid/((double)nYslice));   // FCal slice y width 
 
  // fill cell fragments
  //  double xoff(cXpos-cXwid/2.+cXstp/2.); double yoff(cYpos-cYwid/2.+cYstp/2.);
  double x(cXpos-(cXwid-cXstp)/2.); 
  double xlim(cXpos+cXwid/2.); double ylim(cYpos+cYwid/2.);
  double etaOrig(0.); 
  //  for ( int ix(0); ix < nXslice; ++ix ) {
  //   double x(xoff+ix*cXstp);
  while ( x < xlim ) { 
    //    for ( int iy(0); iy < nYslice; ++iy ) { 
    //      double y(yoff+iy*cYstp);
    double y(cYpos-(cYwid-cYstp)/2.);
    while ( y < ylim ) { 
      double r(std::sqrt(x*x+y*y+cZpos2));
      double eta(-0.5*std::log((r-cZpos)/(r+cZpos)));
      bool etaAdjusted(false);
      if ( m_adjustEta ) { 
    if ( eta < m_towerEtaMin ) {
      etaAdjusted = true;
      etaOrig     = eta;
      eta = m_towerEtaMin+m_towerEtaWidth/2.; 
    } else if ( eta > m_towerEtaMax ) {
      etaAdjusted = true;
      etaOrig     = eta;
      eta = m_towerEtaMax-m_towerEtaWidth/2.;
    }
      }
      double phi(CaloPhiRange::fix(std::atan2(y,x)));
      index_t towerIdx(this->towerIndex(eta,phi));
      // tower index not valid
      if ( isInvalidIndex(towerIdx) ) { 
    msg << MSG::WARNING << "Found invalid tower index for FCal cell (eta,phi) = (" << eta << "," << phi << ") at (x,y,z) = (" 
        << x << "," << y << "," << cZpos << ") [cell ignored]" << endmsg;
      } else { 
    // add tower to lookup
    if ( etaAdjusted ) { 
      msg << MSG::WARNING << "FCal cell direction (eta,phi) = (" << etaOrig << "," << phi << ") for cell at (x,y,z) = (" 
          << x << "," << y << "," << cZpos << ") adjusted to (eta,phi) = (" << eta << "," << phi << ") [cell adjusted]" << endmsg;
    }
    f_assign(pCaloDDE->calo_hash(),towerIdx,cWght);
      } // tower index ok
      y += cYstp;
    } // loop on y fragments
    x += cXstp;
  } // loop on x fragments
  return StatusCode::SUCCESS;
}

f_setupTowerGridProj()

StatusCode CaloTowerGeometry::f_setupTowerGridProj ( const CaloDetDescrElement * pCaloDDE, MsgStream & msg )

private

Internally used function mapping a projective cell onto the tower grid.

Definition at line 170 of file CaloTowerGeometry.cxx.

{
  // projective readout calos - collect geometrical variables
  double cEtaPos(pCaloDDE->eta_raw());            // projective cell center in pseudorapidity
  double cEtaWid(pCaloDDE->deta());               // projective cell width in pseudorapidity
  double cPhiPos(pCaloDDE->phi_raw());            // projective cell center in azimuth
  double cPhiWid(pCaloDDE->dphi());               // projective cell width in azimuth
 
  // check cell-tower overlap area fractions
  uint_t kEta(static_cast<uint_t>(cEtaWid/m_towerEtaWidth+0.5)); kEta = kEta == 0 ? 1 : kEta; // fully contained cell may have 0 fragments (protection)
  uint_t kPhi(static_cast<uint_t>(cPhiWid/m_towerPhiWidth+0.5)); kPhi = kPhi == 0 ? 1 : kPhi; 
 
  // print out
  if ( kEta > 1 || kPhi > 1 ) {
    msg << MSG::VERBOSE << "Found cell [" << pCaloDDE->calo_hash() << "/0x" << std::hex << pCaloDDE->identify().get_compact() 
    << std::dec << "] spawning several towers."
    << " Neta = " << kEta << ", Nphi = " << kPhi << endmsg;
  }
  
  // share cells
  double cWght(1./((double)kEta*kPhi));          // area weight
  double sEta(cEtaWid/((double)kEta));           // step size (pseudorapidity)
  double sPhi(cPhiWid/((double)kPhi));           // step size (azimuth)
  double oEta(cEtaPos-sEta/2.);                  // offset (pseudorapidity)
  double oPhi(cPhiPos-sPhi/2.);                  // offset (azimuth)
 
  // loop over cell fragments
  for ( uint_t ie(1); ie<=kEta; ++ie ) {
    double ceta(oEta+((double)ie-0.5)*sEta);     // eta of fragment
    for ( uint_t ip(1); ip<=kPhi; ++ip ) {
      double cphi(oPhi+((double)ip-0.5)*sPhi);   // phi fragment
      // tower index
      index_t towerIdx(this->towerIndex(ceta,cphi));
      if ( isInvalidIndex(towerIdx) ) { 
    msg << MSG::ERROR << "Found invalid tower index for non-FCal cell (id,eta,phi) = (" << pCaloDDE->calo_hash() 
        << "," << ceta << "," << cphi << ")" << endmsg;
    return StatusCode::FAILURE;
      } // invalid tower index
      f_assign(pCaloDDE->calo_hash(),towerIdx,cWght);
    } // phi fragment loop
  } // eta fragment loop
  return StatusCode::SUCCESS;
} 

getTowers()

CaloTowerGeometry::elementvector_t CaloTowerGeometry::getTowers

(

IdentifierHash

cellHash

)

const

Retrieve the list of towers associated with a calorimeter cell referenced its hash identifier.

The tower indices and weights are returned in two index-parallel vectors. Previous content of these two vectors is removed if this method finds towers for the cell.

Returns

Returns StatusCode::SUCCESS if list of towers found, else @s StatusCode::FAILURE.

Parameters

[in]	cellHash	hash identifier referencing a calorimeter cell.
[in]	towerIdx	reference to modifiable vector of indices (payload type index_t ); vector is filled if cell is successfully mapped.
[in]	towerWghts	reference to modifiable vector of weights (payload type double ); vector is filled if cell is successfully mapped.

Definition at line 254 of file CaloTowerGeometry.cxx.

{
  // check input
  uint_t cidx(static_cast<uint_t>(cellHash)); 
  if ( cidx >= m_towerLookup.size() ) { 
    //ATH_MSG_WARNING( CaloRec::Helpers::fmtMsg("invalid cell hash %6zu beyond range (max hash is %6zu)",cidx,m_maxCellHash) ); 
    return {};
  } else {
    return m_towerLookup.at(cidx);
  }
} 

initialize()

StatusCode CaloTowerGeometry::initialize

(

MsgStream &

msg

)

Initialize object.

Definition at line 32 of file CaloTowerGeometry.cxx.

{
  // prepare FCal segmentation 
  m_ndxFCal[0] = m_fcal1Xslice; m_ndxFCal[1] = m_fcal2Xslice; m_ndxFCal[2] = m_fcal3Xslice;
  m_ndyFCal[0] = m_fcal1Yslice; m_ndyFCal[1] = m_fcal2Yslice; m_ndyFCal[2] = m_fcal3Yslice;
  for ( uint_t i(0); i<m_ndxFCal.size(); ++i ) { m_wgtFCal[i] = 1./(m_ndxFCal.at(i)*m_ndyFCal.at(i)); }
 
  // other derived quantities
  if ( m_towerEtaBins > 0 ) { 
    m_towerEtaWidth = (m_towerEtaMax-m_towerEtaMin)/((double)m_towerEtaBins); 
  } else {
    msg << MSG::ERROR << "Number of tower eta bins is invalid (" << m_towerEtaBins << " bins)" << endmsg;
    return StatusCode::FAILURE;
  }
  if ( m_towerPhiBins > 0 ) { 
    m_towerPhiWidth = (m_towerPhiMax-m_towerPhiMin)/((double)m_towerPhiBins);
  } else {
    msg << MSG::ERROR << "Number of tower phi bins is invalid (" << m_towerPhiBins << " bins)" << endmsg;
    return StatusCode::FAILURE;
  }
 
  m_towerBins     = m_towerEtaBins*m_towerPhiBins;
  m_towerArea     = m_towerEtaWidth*m_towerPhiWidth;
  m_maxCellHash   = m_caloDDM->element_size()-1;
  m_numberOfCells = m_caloDDM->element_size(); 
 
  return f_setupTowerGrid(msg); 
}

invalidIndex()

CaloTowerGeometry::index_t CaloTowerGeometry::invalidIndex ( ) const

inline

Returns value of invalid index.

Definition at line 275 of file CaloTowerGeometry.h.

{ return m_invalidIndex; }

invalidValue()

double CaloTowerGeometry::invalidValue ( ) const

inline

Return invalid value.

Definition at line 322 of file CaloTowerGeometry.h.

{ return m_invalidValue; }

isInvalidEtaIndex()

bool CaloTowerGeometry::isInvalidEtaIndex ( index_t idx ) const

inline

Returns true if argument is not a valid pseudorapidity index.

Definition at line 301 of file CaloTowerGeometry.h.

{ return isInvalidIndex(idx,m_towerEtaBins); }

isInvalidIndex() [1/2]

bool CaloTowerGeometry::isInvalidIndex ( index_t idx ) const

inline

Returns true if argument is equal to the value provided by invalidIndex()

Definition at line 299 of file CaloTowerGeometry.h.

{ return idx == invalidIndex(); }

isInvalidIndex() [2/2]

bool CaloTowerGeometry::isInvalidIndex ( index_t idx, index_t maxIdx ) const

inline

Returns true if first argument is equal to the value provided by invalidIndex() or if first argument is not smaller than second argument.

Definition at line 300 of file CaloTowerGeometry.h.

{ return idx == invalidIndex() || idx >= maxIdx; }

isInvalidPhiIndex()

bool CaloTowerGeometry::isInvalidPhiIndex ( index_t idx ) const

inline

Returns true if argumant is not a valid azimuth index.

Definition at line 302 of file CaloTowerGeometry.h.

{ return isInvalidIndex(idx,m_towerPhiBins); }

isInvalidTowerIndex()

bool CaloTowerGeometry::isInvalidTowerIndex ( index_t idx ) const

inline

Returns true if argument is not a valid tower index.

Definition at line 303 of file CaloTowerGeometry.h.

{ return isInvalidIndex(idx,m_towerBins); }

isInvalidValue()

bool CaloTowerGeometry::isInvalidValue ( double val ) const

inline

Return true if given value is invalid.

Definition at line 323 of file CaloTowerGeometry.h.

{ return val == invalidValue(); }

maxCellHash()

CaloTowerGeometry::uint_t CaloTowerGeometry::maxCellHash ( ) const

inline

Maximum cell hash value.

Definition at line 280 of file CaloTowerGeometry.h.

{ return m_maxCellHash;   }

phiBins()

CaloTowerGeometry::uint_t CaloTowerGeometry::phiBins ( ) const

inline

Number of azimuth bins.

Definition at line 288 of file CaloTowerGeometry.h.

{ return m_towerPhiBins;  }

phiIndex() [1/2]

CaloTowerGeometry::index_t CaloTowerGeometry::phiIndex

(

double

phi

)

const

Get tower \( \phi \) bin index for a given value of \( \phi \).

Definition at line 306 of file CaloTowerGeometry.cxx.

{
  double dphi(CaloPhiRange::diff(phi,m_towerPhiMin));
  return dphi >= m_towerPhiMin && dphi <= m_towerPhiMax 
    ? index_t(std::min(static_cast<uint_t>((phi-m_towerPhiMin)/m_towerPhiWidth),m_towerPhiBins-1))
    : invalidIndex();
}

phiIndex() [2/2]

CaloTowerGeometry::index_t CaloTowerGeometry::phiIndex

(

IdentifierHash

cellHash

)

const

Get tower \( \phi \) bin index for a calorimeter cell referenced by its hash identifier.

Definition at line 300 of file CaloTowerGeometry.cxx.

{
  const auto *const cdde = f_caloDDE(cellHash);
  return cdde != nullptr ? phiIndex(cdde->phi()) : invalidIndex(); 
}

phiIndexFromTowerIndex()

CaloTowerGeometry::index_t CaloTowerGeometry::phiIndexFromTowerIndex ( index_t towerIdx ) const

inline

Get tower \( \phi \) bin index for a given global tower index.

Definition at line 316 of file CaloTowerGeometry.h.

{ return (index_t)(towerIdx%phiBins()); } 

phiMax()

double CaloTowerGeometry::phiMax ( ) const

inline

Upper boundary of azimuth.

Definition at line 290 of file CaloTowerGeometry.h.

{ return m_towerPhiMax;   }

phiMin()

double CaloTowerGeometry::phiMin ( ) const

inline

Lower boundary of azimuth.

Definition at line 289 of file CaloTowerGeometry.h.

{ return m_towerPhiMin;   }

phiWidth()

double CaloTowerGeometry::phiWidth ( ) const

inline

Width of azimuth bin.

Definition at line 291 of file CaloTowerGeometry.h.

{ return m_towerPhiWidth; }

size()

size_t CaloTowerGeometry::size ( ) const

inline

Size of internal look-up table.

Definition at line 331 of file CaloTowerGeometry.h.

{ return m_towerLookup.size(); }

totalNumberCells()

CaloTowerGeometry::uint_t CaloTowerGeometry::totalNumberCells ( ) const

inline

Total number of cells.

Definition at line 281 of file CaloTowerGeometry.h.

{ return m_numberOfCells; }  

towerArea()

double CaloTowerGeometry::towerArea ( ) const

inline

Area of individual tower.

Definition at line 294 of file CaloTowerGeometry.h.

{ return m_towerArea;     } 

towerBins()

CaloTowerGeometry::uint_t CaloTowerGeometry::towerBins ( ) const

inline

Total number of towers.

Definition at line 293 of file CaloTowerGeometry.h.

{ return m_towerBins;     }

towerEta()

double CaloTowerGeometry::towerEta ( index_t towerIndex ) const

inline

Return pseudorapidity from global tower index (bin center)

Definition at line 326 of file CaloTowerGeometry.h.

{ return towerEtaLocal(etaIndexFromTowerIndex(towerIdx)); }

towerEtaLocal()

double CaloTowerGeometry::towerEtaLocal ( index_t etaIndex ) const

inline

Return pseudorapdity from local index (bin center)

Definition at line 324 of file CaloTowerGeometry.h.

{ return !isInvalidEtaIndex(etaIdx) ? etaMin()+(static_cast<double>(etaIdx)+0.5)*etaWidth() : invalidValue(); }

towerIndex() [1/4]

CaloTowerGeometry::index_t CaloTowerGeometry::towerIndex ( const element_t & elm ) const

inline

Get global tower index from payload data.

Definition at line 313 of file CaloTowerGeometry.h.

{ return std::get<0>(elm); }

towerIndex() [2/4]

CaloTowerGeometry::index_t CaloTowerGeometry::towerIndex ( double eta, double phi ) const

inline

Get global tower index for a pair of \( (\eta,\phi) \) values.

Definition at line 310 of file CaloTowerGeometry.h.

{ return towerIndex(etaIndex(eta),phiIndex(phi)); }

towerIndex() [3/4]

CaloTowerGeometry::index_t CaloTowerGeometry::towerIndex ( IdentifierHash cellHash ) const

inline

Get global tower index for a calorimeter cell referenced by its hash identifier.

Definition at line 309 of file CaloTowerGeometry.h.

{ return towerIndex(etaIndex(cellHash),phiIndex(cellHash)); }

towerIndex() [4/4]

CaloTowerGeometry::index_t CaloTowerGeometry::towerIndex ( index_t etaIdx, index_t phiIdx ) const

inline

Get global tower index for a pair of \( (\eta,\phi) \) indices.

Definition at line 311 of file CaloTowerGeometry.h.

{ return !isInvalidEtaIndex(etaIdx) && !isInvalidPhiIndex(phiIdx) ? phiIdx+etaIdx*m_towerPhiBins :  invalidIndex(); } 

towerPhi()

double CaloTowerGeometry::towerPhi ( index_t towerIndex ) const

inline

Return azimuth from global tower index (bin center)

Definition at line 327 of file CaloTowerGeometry.h.

{ return towerPhiLocal(phiIndexFromTowerIndex(towerIdx)); }  

towerPhiLocal()

double CaloTowerGeometry::towerPhiLocal ( index_t phiIndex ) const

inline

Return azimuth from local index (bin center)

Definition at line 325 of file CaloTowerGeometry.h.

{ return !isInvalidPhiIndex(phiIdx) ? phiMin()+(static_cast<double>(phiIdx)+0.5)*phiWidth() : invalidValue(); }

Friends And Related Symbol Documentation

CaloTowerGeometryCondAlg

friend class CaloTowerGeometryCondAlg

friend

Definition at line 33 of file CaloTowerGeometry.h.

Member Data Documentation

m_adjustEta

bool CaloTowerGeometry::m_adjustEta

protected

Adjust FCal cells to eta boundary (default true )

Definition at line 142 of file CaloTowerGeometry.h.

m_caloDDM

const CaloDetDescrManager* CaloTowerGeometry::m_caloDDM

private

Pointer to calorimeter detector description.

Definition at line 120 of file CaloTowerGeometry.h.

m_fcal1Xslice

double CaloTowerGeometry::m_fcal1Xslice

protected

Number of x slices for cells in FCal1.

Definition at line 146 of file CaloTowerGeometry.h.

m_fcal1Yslice

double CaloTowerGeometry::m_fcal1Yslice

protected

Number of y slices for cells in FCal1.

Definition at line 147 of file CaloTowerGeometry.h.

m_fcal2Xslice

double CaloTowerGeometry::m_fcal2Xslice

protected

Number of x slices for cells in FCal2.

Definition at line 148 of file CaloTowerGeometry.h.

m_fcal2Yslice

double CaloTowerGeometry::m_fcal2Yslice

protected

Number of y slices for cells in FCal2.

Definition at line 149 of file CaloTowerGeometry.h.

m_fcal3Xslice

double CaloTowerGeometry::m_fcal3Xslice

protected

Number of x slices for cells in FCal3.

Definition at line 150 of file CaloTowerGeometry.h.

m_fcal3Yslice

double CaloTowerGeometry::m_fcal3Yslice

protected

Number of y slices for cells in FCal3.

Definition at line 151 of file CaloTowerGeometry.h.

m_invalidIndex

const CaloTowerGeometry::index_t CaloTowerGeometry::m_invalidIndex = index_t(-1)

staticprotected

Invalid index indicator.

Definition at line 156 of file CaloTowerGeometry.h.

m_invalidValue

const double CaloTowerGeometry::m_invalidValue = -999.

staticprotected

Return value for out-of-range indices andother invalid conversions to a physical quantity.

Definition at line 157 of file CaloTowerGeometry.h.

m_maxCellHash

uint_t CaloTowerGeometry::m_maxCellHash

protected

Maximum cell hash value.

Definition at line 132 of file CaloTowerGeometry.h.

m_ndxFCal

std::array<double,3> CaloTowerGeometry::m_ndxFCal {}

protected

Stores number of fragments along x for each FCal module.

Definition at line 169 of file CaloTowerGeometry.h.

{}; 

m_ndyFCal

std::array<double,3> CaloTowerGeometry::m_ndyFCal {}

protected

Stores number of fragments along y for each FCal module.

Definition at line 170 of file CaloTowerGeometry.h.

{}; 

m_numberOfCells

uint_t CaloTowerGeometry::m_numberOfCells {}

protected

Total number of cells.

Definition at line 133 of file CaloTowerGeometry.h.

{}; 

m_towerArea

double CaloTowerGeometry::m_towerArea

protected

Area of individual tower.

Definition at line 130 of file CaloTowerGeometry.h.

m_towerBins

uint_t CaloTowerGeometry::m_towerBins

protected

Maximum number of towers.

Definition at line 131 of file CaloTowerGeometry.h.

m_towerEtaBins

uint_t CaloTowerGeometry::m_towerEtaBins

protected

Internally stored tower grid descriptors.

Number of \( \eta \) bins

Definition at line 139 of file CaloTowerGeometry.h.

m_towerEtaMax

double CaloTowerGeometry::m_towerEtaMax

protected

Upper boundary \( \eta_{\rm max} \).

Definition at line 141 of file CaloTowerGeometry.h.

m_towerEtaMin

double CaloTowerGeometry::m_towerEtaMin

protected

Lower boundary \( \eta_{\rm min} \).

Definition at line 140 of file CaloTowerGeometry.h.

m_towerEtaWidth

double CaloTowerGeometry::m_towerEtaWidth

protected

Width of tower bin in pseudorapidity.

Definition at line 128 of file CaloTowerGeometry.h.

m_towerLookup

elementmap_t CaloTowerGeometry::m_towerLookup

protected

Cell-to-tower mapping lookup store.

Definition at line 127 of file CaloTowerGeometry.h.

m_towerPhiBins

uint_t CaloTowerGeometry::m_towerPhiBins

protected

Number of \( \phi \) bins.

Definition at line 143 of file CaloTowerGeometry.h.

m_towerPhiMax

double CaloTowerGeometry::m_towerPhiMax

protected

Upper boundary \( \phi_{\rm max} \).

Definition at line 145 of file CaloTowerGeometry.h.

m_towerPhiMin

double CaloTowerGeometry::m_towerPhiMin

protected

Lower boundary \( \phi_{\rm min} \).

Definition at line 144 of file CaloTowerGeometry.h.

m_towerPhiWidth

double CaloTowerGeometry::m_towerPhiWidth

protected

Width of tower bin in azimuth.

Definition at line 129 of file CaloTowerGeometry.h.

m_wgtFCal

std::array<double,3> CaloTowerGeometry::m_wgtFCal {}

protected

Stores geometrical weights.

Definition at line 171 of file CaloTowerGeometry.h.

{}; 

---

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

• CaloTowerGeometry.h
• CaloTowerGeometry.cxx