Bins energy deposits into a grid. More...

#include <PufitGrid.h>

Inheritance diagram for HLT::MET::PufitGrid:

Collaboration diagram for HLT::MET::PufitGrid:

Classes
class	Tower
	Describes a single element of the grid. More...

Public Types
enum class	SumStrategy { All , Masked , Unmasked }
	Helper enum to describe how to sum over towers. More...

Public Member Functions
	PufitGrid (double maxEta, std::size_t nEtaTowers, std::size_t nPhiTowers, bool displaceEta=false, bool displacePhi=false)
	Create a new tower grid.
	PufitGrid (const GridParameters &parameters)
	Construct a grid from the provided parameters.
	PufitGrid (const PufitGrid &other)
	Copy constructor.
PufitGrid &	operator= (const PufitGrid &other)
	Assignment operator.
void	reset ()
	Reset the internal storage.
PufitGrid &	operator+= (const SignedKinematics &kin)
	Add a signed object to this grid.
PufitGrid &	operator-= (const SignedKinematics &kin)
	Remove the energy of a signed object from this grid.
Tower &	operator[] (const std::pair< std::size_t, std::size_t > &indices)
	Access stored value by eta/phi index (access is bounds-checked)
const Tower &	operator[] (const std::pair< std::size_t, std::size_t > &indices) const
	Access stored value by eta/phi index (access is bounds checked)
Tower &	operator[] (std::size_t index)
	Access stored value by global index number (access is bounds checked)
const Tower &	operator[] (std::size_t index) const
	Access stored value by global index number (access is bounds checked)
std::vector< Tower >::iterator	begin ()
	Access by iterator.
std::vector< Tower >::const_iterator	begin () const
	Access by iterator.
std::vector< Tower >::iterator	end ()
	Iterator end point.
std::vector< Tower >::const_iterator	end () const
	Iterator end point.
METComponent	sum (SumStrategy strategy=SumStrategy::All) const
PufitGrid &	operator+= (const PufitGrid &other)
	Add a whole grid into this.
PufitGrid &	operator-= (const PufitGrid &other)
	Subtract a whole grid from this.
std::size_t	getIndex (double eta, double phi, bool &outOfRange) const
	Get the index for the given eta, phi values.
std::size_t	getEtaIndex (double eta, bool &outOfRange) const
	Get the eta index for the given value.
std::size_t	getPhiIndex (double phi) const
	Get the phi index for the given value.
std::size_t	globalIndex (std::size_t iEta, std::size_t iPhi) const
	Convert eta and phi to a global index.
std::pair< std::size_t, std::size_t >	etaPhiIndex (std::size_t index) const
	Convert a global index to an eta/phi index pair.
double	centralEta (std::size_t iEta) const
	Central eta coordinate of the given eta index.
double	centralPhi (std::size_t iPhi) const
	Central phi coordinate of the given phi.
const GridParameters &	parameters () const
	The grid parameters.
double	maxEta () const
	The maximum eta range for the grid.
std::size_t	nEtaTowers () const
	The number of eta bins.
std::size_t	nPhiTowers () const
	The number of phi bins.
std::size_t	nTowers () const
	The number of bins.
bool	displaceEta () const
	Whether or not this is displaced in eta.
bool	displacePhi () const
	Whether or not this is displaced in phi.
GridDisplacement	displacement () const
	The grid displacement.
double	etaWidth () const
	The bin width in eta.
double	phiWidth () const
	The bin width in phi.

Private Attributes
std::vector< Tower >	m_towers
const GridParameters	m_params
	The grid's parameters.

Detailed Description

Bins energy deposits into a grid.

The grid can be displaced in eta and/or phi. In this case the grid will be moved by half a bin in the relevant directions. For these purposes the grid will be treated as periodic in eta, even though the calorimeter isn't really.

Definition at line 37 of file PufitGrid.h.

Member Enumeration Documentation

◆ SumStrategy

enum class HLT::MET::PufitGrid::SumStrategy

strong

Helper enum to describe how to sum over towers.

Enumerator
All
Masked
Unmasked

Definition at line 220 of file PufitGrid.h.

      {
        All,     //> Sum all towers, regardless of masks
        Masked,  //> Only sum masked towers
        Unmasked //> Only sum unmasked towers
      };

Constructor & Destructor Documentation

◆ PufitGrid() [1/3]

HLT::MET::PufitGrid::PufitGrid	(	double	maxEta,
		std::size_t	nEtaTowers,
		std::size_t	nPhiTowers,
		bool	displaceEta = false,
		bool	displacePhi = false )

Create a new tower grid.

Parameters

maxEta	The maximum eta range for the grid
nEtaTowers	The number of eta towers
nPhiTowers	The number of phi towers
displaceEta	Whether to displace eta
displacePhi	Whether to displace phi

Definition at line 76 of file PufitGrid.cxx.

        : PufitGrid(GridParameters{maxEta, nEtaTowers, nPhiTowers, displaceEta, displacePhi})
    {
    }

◆ PufitGrid() [2/3]

HLT::MET::PufitGrid::PufitGrid ( const GridParameters & parameters )

Construct a grid from the provided parameters.

Definition at line 86 of file PufitGrid.cxx.

        : PeriodicGridBase(parameters)
    {
      m_towers.reserve(nTowers());
      for (std::size_t index = 0; index < nTowers(); ++index)
        m_towers.emplace_back(this, index);
    }

◆ PufitGrid() [3/3]

HLT::MET::PufitGrid::PufitGrid ( const PufitGrid & other )

Copy constructor.

Definition at line 94 of file PufitGrid.cxx.

                                               : PufitGrid(other.parameters())
    {
      *this = other;
    }

Member Function Documentation

◆ begin() [1/2]

std::vector< PufitGrid::Tower >::iterator HLT::MET::PufitGrid::begin ( )

Access by iterator.

Definition at line 154 of file PufitGrid.cxx.

    {
      return m_towers.begin();
    }

◆ begin() [2/2]

std::vector< PufitGrid::Tower >::const_iterator HLT::MET::PufitGrid::begin ( ) const

Access by iterator.

Definition at line 158 of file PufitGrid.cxx.

    {
      return m_towers.begin();
    }

◆ centralEta()

double HLT::MET::PeriodicGridBase::centralEta ( std::size_t iEta ) const

inherited

Central eta coordinate of the given eta index.

Definition at line 129 of file PeriodicGridBase.cxx.

    {
      return -maxEta() + etaWidth() * (iEta + 0.5) + (displaceEta() ? etaWidth() / 2 : 0);
    }

◆ centralPhi()

double HLT::MET::PeriodicGridBase::centralPhi ( std::size_t iPhi ) const

inherited

Central phi coordinate of the given phi.

Definition at line 133 of file PeriodicGridBase.cxx.

    {
      return phiWidth() * (iPhi + 0.5) + (displacePhi() ? phiWidth() / 2 : 0);
    }

◆ displaceEta()

bool HLT::MET::PeriodicGridBase::displaceEta ( ) const

inherited

Whether or not this is displaced in eta.

Definition at line 143 of file PeriodicGridBase.cxx.

143{ return parameters().displaceEta; }

HLT::MET::GridParameters::displaceEta

bool displaceEta

Whether the grid is displaced in eta.

Definition PeriodicGridBase.h:51

◆ displacement()

GridDisplacement HLT::MET::PeriodicGridBase::displacement ( ) const

inherited

The grid displacement.

Definition at line 145 of file PeriodicGridBase.cxx.

    {
      return parameters().displacement();
    }

◆ displacePhi()

bool HLT::MET::PeriodicGridBase::displacePhi ( ) const

inherited

Whether or not this is displaced in phi.

Definition at line 144 of file PeriodicGridBase.cxx.

144{ return parameters().displacePhi; }

HLT::MET::GridParameters::displacePhi

bool displacePhi

Whether the grid is displaced in phi.

Definition PeriodicGridBase.h:53

◆ end() [1/2]

std::vector< PufitGrid::Tower >::iterator HLT::MET::PufitGrid::end ( )

Iterator end point.

Definition at line 162 of file PufitGrid.cxx.

    {
      return m_towers.end();
    }

◆ end() [2/2]

std::vector< PufitGrid::Tower >::const_iterator HLT::MET::PufitGrid::end ( ) const

Iterator end point.

Definition at line 166 of file PufitGrid.cxx.

    {
      return m_towers.end();
    }

◆ etaPhiIndex()

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

inherited

Convert a global index to an eta/phi index pair.

Definition at line 124 of file PeriodicGridBase.cxx.

    {
      return std::make_pair(index / nPhiTowers(), index % nPhiTowers());
    }

◆ etaWidth()

double HLT::MET::PeriodicGridBase::etaWidth ( ) const

inherited

The bin width in eta.

Definition at line 149 of file PeriodicGridBase.cxx.

149{ return 2 * maxEta() / nEtaTowers(); }

◆ getEtaIndex()

std::size_t HLT::MET::PeriodicGridBase::getEtaIndex	(	double	eta,
		bool &	outOfRange ) const

inherited

Get the eta index for the given value.

Parameters

	eta	The eta value
[out]	outOfRange	Set to true if outside of the eta range

If it's out of range the returned index will be nEta

Definition at line 87 of file PeriodicGridBase.cxx.

    {
      if (std::abs(eta) >= maxEta())
      {
        outOfRange = true;
        return nEtaTowers();
      }
      outOfRange = false;
      if (displaceEta())
      {
        // Apply the displacement by adding the displacement to the input
        // coordinate. This shifts the grid in the negative direction
        eta += etaWidth() / 2;
        // If necessary apply eta periodicity here
        if (eta >= maxEta())
          eta -= 2 * maxEta();
      }
      return (eta + maxEta()) / etaWidth();
    }

◆ getIndex()

std::size_t HLT::MET::PeriodicGridBase::getIndex	(	double	eta,
		double	phi,
		bool &	outOfRange ) const

inherited

Get the index for the given eta, phi values.

Parameters

	eta	The eta value
	phi	The phi value
[out]	outOfRange	Set to true if outside of the eta range

If it's out of range the returned index will be nTowers

Definition at line 79 of file PeriodicGridBase.cxx.

    {
      std::size_t etaIndex = getEtaIndex(eta, outOfRange);
      if (outOfRange)
        return nTowers();
      return globalIndex(etaIndex, getPhiIndex(phi));
    }

◆ getPhiIndex()

std::size_t HLT::MET::PeriodicGridBase::getPhiIndex ( double phi ) const

inherited

Get the phi index for the given value.

Definition at line 107 of file PeriodicGridBase.cxx.

    {
      if (displacePhi())
        // Apply the displacement by adding the displacement to the input
        // coordinate. This shifts the grid in the negative direction
        phi += phiWidth() / 2;
      // Apply periodicity
      phi = std::fmod(phi, 2 * M_PI);
      if (phi < 0)
        phi += 2 * M_PI;
      return phi / phiWidth();
    }

◆ globalIndex()

std::size_t HLT::MET::PeriodicGridBase::globalIndex	(	std::size_t	iEta,
		std::size_t	iPhi ) const

inherited

Convert eta and phi to a global index.

Definition at line 120 of file PeriodicGridBase.cxx.

    {
      return iEta * nPhiTowers() + iPhi;
    }

◆ maxEta()

double HLT::MET::PeriodicGridBase::maxEta ( ) const

inherited

The maximum eta range for the grid.

Definition at line 139 of file PeriodicGridBase.cxx.

139{ return parameters().maxEta; }

HLT::MET::GridParameters::maxEta

double maxEta

The maximum |eta| value.

Definition PeriodicGridBase.h:45

◆ nEtaTowers()

std::size_t HLT::MET::PeriodicGridBase::nEtaTowers ( ) const

inherited

The number of eta bins.

Definition at line 140 of file PeriodicGridBase.cxx.

140{ return parameters().nEtaTowers; }

HLT::MET::GridParameters::nEtaTowers

std::size_t nEtaTowers

The number of divisions along the eta axis.

Definition PeriodicGridBase.h:47

◆ nPhiTowers()

std::size_t HLT::MET::PeriodicGridBase::nPhiTowers ( ) const

inherited

The number of phi bins.

Definition at line 141 of file PeriodicGridBase.cxx.

141{ return parameters().nPhiTowers; }

HLT::MET::GridParameters::nPhiTowers

std::size_t nPhiTowers

The number of divisions along the phi axis.

Definition PeriodicGridBase.h:49

◆ nTowers()

std::size_t HLT::MET::PeriodicGridBase::nTowers ( ) const

inherited

The number of bins.

Definition at line 142 of file PeriodicGridBase.cxx.

142{ return nEtaTowers() * nPhiTowers(); }

◆ operator+=() [1/2]

PufitGrid & HLT::MET::PufitGrid::operator+= ( const PufitGrid & other )

Add a whole grid into this.

Definition at line 194 of file PufitGrid.cxx.

    {
      if (parameters() != other.parameters())
        throw std::invalid_argument("Grid parameters do not match");
      auto itr = begin();
      auto otherItr = other.begin();
      for (; itr != end(); ++itr, ++otherItr)
        *itr += *otherItr;
      return *this;
    }

◆ operator+=() [2/2]

PufitGrid & HLT::MET::PufitGrid::operator+= ( const SignedKinematics & kin )

Add a signed object to this grid.

The object will be assigned to the relevant bin. It will not be added if it falls outside of the eta range. The momentum of the kinematics will be used. If you do not want this (i.e. you want mass to be ignored) you should construct the kinematics without mass.

Definition at line 115 of file PufitGrid.cxx.

    {
      // Find the right tower to add to
      bool outOfRange = false;
      std::size_t index = getIndex(kin.eta(), kin.phi(), outOfRange);
      if (!outOfRange)
        operator[](index) += kin;
      return *this;
    }

◆ operator-=() [1/2]

PufitGrid & HLT::MET::PufitGrid::operator-= ( const PufitGrid & other )

Subtract a whole grid from this.

Definition at line 204 of file PufitGrid.cxx.

    {
      if (parameters() != other.parameters())
        throw std::invalid_argument("Grid parameters do not match");
      auto itr = begin();
      auto otherItr = other.begin();
      for (; itr != end(); ++itr, ++otherItr)
        *itr -= *otherItr;
      return *this;
    }

◆ operator-=() [2/2]

PufitGrid & HLT::MET::PufitGrid::operator-= ( const SignedKinematics & kin )

Remove the energy of a signed object from this grid.

The object will be assigned to the relevant bin. It will not be added if it falls outside of the eta range. The momentum of the kinematics will be used. If you do not want this (i.e. you want mass to be ignored) you should construct the kinematics without mass.

Definition at line 124 of file PufitGrid.cxx.

    {
      // Find the right tower to subtract from
      bool outOfRange = false;
      std::size_t index = getIndex(kin.eta(), kin.phi(), outOfRange);
      if (!outOfRange)
        operator[](index) -= kin;
      return *this;
    }

◆ operator=()

PufitGrid & HLT::MET::PufitGrid::operator= ( const PufitGrid & other )

Assignment operator.

Parameters

other The grid whose towers to take @except std::invalid_argument If other's parameters don't match ours.

Take the tower energies/masking from the other grid. This is only allowed between two grids with matching parameters.

Definition at line 99 of file PufitGrid.cxx.

    {
      if (parameters() != other.parameters())
        throw std::invalid_argument("Grid parameters do not match!");
      std::copy(other.begin(), other.end(), m_towers.begin());
      return *this;
    }

◆ operator[]() [1/4]

PufitGrid::Tower & HLT::MET::PufitGrid::operator[] ( const std::pair< std::size_t, std::size_t > & indices )

Access stored value by eta/phi index (access is bounds-checked)

Definition at line 134 of file PufitGrid.cxx.

    {
      return operator[](globalIndex(indices.first, indices.second));
    }

◆ operator[]() [2/4]

const PufitGrid::Tower & HLT::MET::PufitGrid::operator[] ( const std::pair< std::size_t, std::size_t > & indices ) const

Access stored value by eta/phi index (access is bounds checked)

Definition at line 139 of file PufitGrid.cxx.

    {
      return operator[](globalIndex(indices.first, indices.second));
    }

◆ operator[]() [3/4]

PufitGrid::Tower & HLT::MET::PufitGrid::operator[] ( std::size_t index )

Access stored value by global index number (access is bounds checked)

Definition at line 145 of file PufitGrid.cxx.

    {
      return m_towers.at(index);
    }

◆ operator[]() [4/4]

const PufitGrid::Tower & HLT::MET::PufitGrid::operator[] ( std::size_t index ) const

Access stored value by global index number (access is bounds checked)

Definition at line 149 of file PufitGrid.cxx.

    {
      return m_towers.at(index);
    }

◆ parameters()

const GridParameters & HLT::MET::PeriodicGridBase::parameters ( ) const

inherited

The grid parameters.

Definition at line 138 of file PeriodicGridBase.cxx.

138{ return m_params; }

HLT::MET::PeriodicGridBase::m_params

const GridParameters m_params

The grid's parameters.

Definition PeriodicGridBase.h:191

◆ phiWidth()

double HLT::MET::PeriodicGridBase::phiWidth ( ) const

inherited

The bin width in phi.

Definition at line 150 of file PeriodicGridBase.cxx.

150{ return 2 * M_PI / nPhiTowers(); }

◆ reset()

void HLT::MET::PufitGrid::reset ( )

Reset the internal storage.

Definition at line 107 of file PufitGrid.cxx.

    {
      // Here we construct a standalone tower to copy in 0 values to the tower
      // kinematics. This kind of object is safe here but in general it's not a
      // good idea to have one.
      std::fill(begin(), end(), Tower(nullptr, -1));
    }

◆ sum()

METComponent HLT::MET::PufitGrid::sum ( SumStrategy strategy = SumStrategy::All ) const

Definition at line 171 of file PufitGrid.cxx.

    {
      METComponent total;
      switch (strategy)
      {
      case SumStrategy::All:
        for (const Tower &tower : *this)
          total += tower;
        break;
      case SumStrategy::Masked:
        for (const Tower &tower : *this)
          if (tower.masked())
            total += tower;
        break;
      case SumStrategy::Unmasked:
        for (const Tower &tower : *this)
          if (!tower.masked())
            total += tower;
        break;
      }
      return total;
    }

Member Data Documentation

◆ m_params

const GridParameters HLT::MET::PeriodicGridBase::m_params

privateinherited

The grid's parameters.

Definition at line 191 of file PeriodicGridBase.h.

◆ m_towers

std::vector<Tower> HLT::MET::PufitGrid::m_towers

private

Definition at line 235 of file PufitGrid.h.

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

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ SumStrategy

Constructor & Destructor Documentation

◆ PufitGrid() [1/3]

◆ PufitGrid() [2/3]

◆ PufitGrid() [3/3]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ centralEta()

◆ centralPhi()

◆ displaceEta()

◆ displacement()

◆ displacePhi()

◆ end() [1/2]

◆ end() [2/2]

◆ etaPhiIndex()

◆ etaWidth()

◆ getEtaIndex()

◆ getIndex()

◆ getPhiIndex()

◆ globalIndex()

◆ maxEta()

◆ nEtaTowers()

◆ nPhiTowers()

◆ nTowers()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator=()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ parameters()

◆ phiWidth()

◆ reset()

◆ sum()

Member Data Documentation

◆ m_params

◆ m_towers