Base class for grids used in some of the pufit algorithms. More...

#include <PeriodicGridBase.h>

Inheritance diagram for HLT::MET::PeriodicGridBase:

Collaboration diagram for HLT::MET::PeriodicGridBase:

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

Public Member Functions
	PeriodicGridBase (const GridParameters &parameters)
	Construct the grid from its parameters. More...

	PeriodicGridBase (double maxEta, std::size_t nEtaTowers, std::size_t nPhiTowers, bool displaceEta=false, bool displacePhi=false)
	Construct the grid from its parameters provided directly. More...

std::size_t	getIndex (double eta, double phi, bool &outOfRange) const
	Get the index for the given eta, phi values. More...

std::size_t	getEtaIndex (double eta, bool &outOfRange) const
	Get the eta index for the given value. More...

std::size_t	getPhiIndex (double phi) const
	Get the phi index for the given value. More...

std::size_t	globalIndex (std::size_t iEta, std::size_t iPhi) const
	Convert eta and phi to a global index. More...

std::pair< std::size_t, std::size_t >	etaPhiIndex (std::size_t index) const
	Convert a global index to an eta/phi index pair. More...

double	centralEta (std::size_t iEta) const
	Central eta coordinate of the given eta index. More...

double	centralPhi (std::size_t iPhi) const
	Central phi coordinate of the given phi. More...

const GridParameters &	parameters () const
	The grid parameters. More...

double	maxEta () const
	The maximum eta range for the grid. More...

std::size_t	nEtaTowers () const
	The number of eta bins. More...

std::size_t	nPhiTowers () const
	The number of phi bins. More...

std::size_t	nTowers () const
	The number of bins. More...

bool	displaceEta () const
	Whether or not this is displaced in eta. More...

bool	displacePhi () const
	Whether or not this is displaced in phi. More...

GridDisplacement	displacement () const
	The grid displacement. More...

double	etaWidth () const
	The bin width in eta. More...

double	phiWidth () const
	The bin width in phi. More...

Private Attributes
const GridParameters	m_params
	The grid's parameters. More...

Detailed Description

Base class for grids used in some of the pufit algorithms.

Many versions of the pufit technique require breaking the calorimeter into a grid in order to measure the variance of energy deposits across the detector and to identify areas which have a significantly high energy.

These grids must also support being displaced slightly in eta and phi to ensure that high energy deposits are not artificially divided between two towers.

The grids are also periodic in phi - i.e. the tower located at phi is the same one located at phi + 2pi.

Definition at line 75 of file PeriodicGridBase.h.

Constructor & Destructor Documentation

◆ PeriodicGridBase() [1/2]

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

Construct the grid from its parameters.

Definition at line 64 of file PeriodicGridBase.cxx.

         : m_params(parameters)
     {
     }

◆ PeriodicGridBase() [2/2]

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

Construct the grid from its parameters provided directly.

Definition at line 69 of file PeriodicGridBase.cxx.

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

Member Function Documentation

◆ centralEta()

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

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

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

Whether or not this is displaced in eta.

Definition at line 143 of file PeriodicGridBase.cxx.

143 { return parameters().displaceEta; }

◆ displacement()

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

The grid displacement.

Definition at line 145 of file PeriodicGridBase.cxx.

     {
       return parameters().displacement();
     }

◆ displacePhi()

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

Whether or not this is displaced in phi.

Definition at line 144 of file PeriodicGridBase.cxx.

144 { return parameters().displacePhi; }

◆ etaPhiIndex()

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

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

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

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

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

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

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

The maximum eta range for the grid.

Definition at line 139 of file PeriodicGridBase.cxx.

139 { return parameters().maxEta; }

◆ nEtaTowers()

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

The number of eta bins.

Definition at line 140 of file PeriodicGridBase.cxx.

140 { return parameters().nEtaTowers; }

◆ nPhiTowers()

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

The number of phi bins.

Definition at line 141 of file PeriodicGridBase.cxx.

141 { return parameters().nPhiTowers; }

◆ nTowers()

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

The number of bins.

Definition at line 142 of file PeriodicGridBase.cxx.

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

◆ parameters()

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

The grid parameters.

Definition at line 138 of file PeriodicGridBase.cxx.

138 { return m_params; }

◆ phiWidth()

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

The bin width in phi.

Definition at line 150 of file PeriodicGridBase.cxx.

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

Member Data Documentation

◆ m_params

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

private

The grid's parameters.

Definition at line 191 of file PeriodicGridBase.h.

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

Classes

Public Member Functions

Private Attributes