ATLAS Offline Software
Public Member Functions | Private Attributes | List of all members
HLT::MET::PeriodicGridBase::Tower Class Referenceabstract

Base class for towers belonging to the grids. More...

#include <PeriodicGridBase.h>

Inheritance diagram for HLT::MET::PeriodicGridBase::Tower:
Collaboration diagram for HLT::MET::PeriodicGridBase::Tower:

Public Member Functions

 Tower (std::size_t index)
 
virtual ~Tower ()=default
 
virtual const PeriodicGridBasegrid () const =0
 The grid which owns this tower. More...
 
double towerPhi () const
 The central phi coordinate of this tower. More...
 
double towerEta () const
 The central eta coordinate of this tower. More...
 
std::size_t index () const
 The global index of this tower. More...
 
std::size_t etaIndex () const
 The eta index of this tower. More...
 
std::size_t phiIndex () const
 The phi index of this tower. More...
 
std::pair< std::size_t, std::size_t > etaPhiIndex () const
 The eta/phi indices of the tower together. More...
 

Private Attributes

std::size_t m_index
 

Detailed Description

Base class for towers belonging to the grids.

Definition at line 81 of file PeriodicGridBase.h.

Constructor & Destructor Documentation

◆ Tower()

HLT::MET::PeriodicGridBase::Tower::Tower ( std::size_t  index)

Definition at line 32 of file PeriodicGridBase.cxx.

32 : m_index(index) {}

◆ ~Tower()

virtual HLT::MET::PeriodicGridBase::Tower::~Tower ( )
virtualdefault

Member Function Documentation

◆ etaIndex()

std::size_t HLT::MET::PeriodicGridBase::Tower::etaIndex ( ) const

The eta index of this tower.

Definition at line 49 of file PeriodicGridBase.cxx.

50  {
51  return etaPhiIndex().first;
52  }

◆ etaPhiIndex()

std::pair< std::size_t, std::size_t > HLT::MET::PeriodicGridBase::Tower::etaPhiIndex ( ) const

The eta/phi indices of the tower together.

Definition at line 59 of file PeriodicGridBase.cxx.

60  {
61  return grid()->etaPhiIndex(m_index);
62  }

◆ grid()

virtual const PeriodicGridBase* HLT::MET::PeriodicGridBase::Tower::grid ( ) const
pure virtual

The grid which owns this tower.

Implemented in HLT::MET::PufitMultiGrid< N >::Tower, and HLT::MET::PufitGrid::Tower.

◆ index()

std::size_t HLT::MET::PeriodicGridBase::Tower::index ( ) const

The global index of this tower.

Definition at line 44 of file PeriodicGridBase.cxx.

45  {
46  return m_index;
47  }

◆ phiIndex()

std::size_t HLT::MET::PeriodicGridBase::Tower::phiIndex ( ) const

The phi index of this tower.

Definition at line 54 of file PeriodicGridBase.cxx.

55  {
56  return etaPhiIndex().second;
57  }

◆ towerEta()

double HLT::MET::PeriodicGridBase::Tower::towerEta ( ) const

The central eta coordinate of this tower.

Definition at line 39 of file PeriodicGridBase.cxx.

40  {
41  return grid()->centralEta(m_index);
42  }

◆ towerPhi()

double HLT::MET::PeriodicGridBase::Tower::towerPhi ( ) const

The central phi coordinate of this tower.

Definition at line 34 of file PeriodicGridBase.cxx.

35  {
36  return grid()->centralPhi(m_index);
37  }

Member Data Documentation

◆ m_index

std::size_t HLT::MET::PeriodicGridBase::Tower::m_index
private

Definition at line 109 of file PeriodicGridBase.h.


The documentation for this class was generated from the following files:
HLT::MET::PeriodicGridBase::Tower::etaPhiIndex
std::pair< std::size_t, std::size_t > etaPhiIndex() const
The eta/phi indices of the tower together.
Definition: PeriodicGridBase.cxx:59
index
Definition: index.py:1
HLT::MET::PeriodicGridBase::etaPhiIndex
std::pair< std::size_t, std::size_t > etaPhiIndex(std::size_t index) const
Convert a global index to an eta/phi index pair.
Definition: PeriodicGridBase.cxx:124
HLT::MET::PeriodicGridBase::Tower::grid
virtual const PeriodicGridBase * grid() const =0
The grid which owns this tower.
HLT::MET::PeriodicGridBase::centralPhi
double centralPhi(std::size_t iPhi) const
Central phi coordinate of the given phi.
Definition: PeriodicGridBase.cxx:133
HLT::MET::PeriodicGridBase::centralEta
double centralEta(std::size_t iEta) const
Central eta coordinate of the given eta index.
Definition: PeriodicGridBase.cxx:129
HLT::MET::PeriodicGridBase::Tower::m_index
std::size_t m_index
Definition: PeriodicGridBase.h:109