Describes a single element of the grid. More...

#include <PufitGrid.h>

Inheritance diagram for HLT::MET::PufitGrid::Tower:

Collaboration diagram for HLT::MET::PufitGrid::Tower:

Public Member Functions
	Tower (const PufitGrid *parent, std::size_t index)
	Create a tower with its parent. More...

	Tower (const Tower &)=default

Tower &	operator= (const Tower &other)
	Copy assignment operator. More...

double	ex () const
	The x-component of this tower's energy. More...

double	ey () const
	The y-component of this tower's energy. More...

double	ez () const
	The z-component of this tower's energy. More...

double	sumEt () const
	The total sumEt in this tower. More...

double	sumE () const
	The total sumE in this tower. More...

double	phi () const
	This tower's kinematic phi. More...

double	eta () const
	This tower's kinematic eta. More...

bool	masked () const
	Whether or not this tower was masked. More...

void	mask (bool value=true)
	Set the mask on this tower. More...

virtual const PufitGrid *	grid () const override
	The parent grid of this tower. More...

SignedKinematics	kinematics () const
	Build a kinematics object from this tower. More...

	operator SignedKinematics () const
	Conversion operator. More...

Tower &	operator+= (const SignedKinematics &kin)
	Add a signed object to this tower. More...

Tower &	operator-= (const SignedKinematics &kin)
	Remove the energy of a signed object from this tower. More...

Tower &	operator+= (const Tower &other)
	Add another tower's energies into this one. More...

Tower &	operator-= (const Tower &other)
	Subtract another tower's energies from this one. 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
const PufitGrid *const	m_parent
	The parent grid. More...

SignedKinematics	m_kin

double	m_sumEt {0.}
	The summed et. More...

double	m_sumE {0.}
	The summed energy. More...

bool	m_mask {false}
	The mask value. More...

std::size_t	m_index

Detailed Description

Describes a single element of the grid.

There are two sets of directions here - the 'kinematic' directions which result from the sums of objects going into the towers and the tower coordinates themselves.

Definition at line 59 of file PufitGrid.h.

Constructor & Destructor Documentation

◆ Tower() [1/2]

HLT::MET::PufitGrid::Tower::Tower	(	const PufitGrid *	parent,
		std::size_t	index
	)

Create a tower with its parent.

Parameters

parent	The parent grid of this tower
index	The index of this tower in its parent's grid

Definition at line 15 of file PufitGrid.cxx.

                                                                   : PeriodicGridBase::Tower(index),
                                                                           m_parent(parent)
     {
     }

◆ Tower() [2/2]

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

default

Member Function Documentation

◆ eta()

double HLT::MET::PufitGrid::Tower::eta ( ) const

This tower's kinematic eta.

Definition at line 35 of file PufitGrid.cxx.

35 { return kinematics().eta(); }

◆ etaIndex()

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

inherited

The eta index of this tower.

Definition at line 49 of file PeriodicGridBase.cxx.

     {
       return etaPhiIndex().first;
     }

◆ etaPhiIndex()

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

inherited

The eta/phi indices of the tower together.

Definition at line 59 of file PeriodicGridBase.cxx.

     {
       return grid()->etaPhiIndex(m_index);
     }

◆ ex()

double HLT::MET::PufitGrid::Tower::ex ( ) const

The x-component of this tower's energy.

Definition at line 29 of file PufitGrid.cxx.

29 { return m_kin.px(); }

◆ ey()

double HLT::MET::PufitGrid::Tower::ey ( ) const

The y-component of this tower's energy.

Definition at line 30 of file PufitGrid.cxx.

30 { return m_kin.py(); }

◆ ez()

double HLT::MET::PufitGrid::Tower::ez ( ) const

The z-component of this tower's energy.

Definition at line 31 of file PufitGrid.cxx.

31 { return m_kin.pz(); }

◆ grid()

const PufitGrid * HLT::MET::PufitGrid::Tower::grid ( ) const

overridevirtual

The parent grid of this tower.

Implements HLT::MET::PeriodicGridBase::Tower.

Definition at line 39 of file PufitGrid.cxx.

39 { return m_parent; }

◆ index()

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

inherited

The global index of this tower.

Definition at line 44 of file PeriodicGridBase.cxx.

     {
       return m_index;
     }

◆ kinematics()

SignedKinematics HLT::MET::PufitGrid::Tower::kinematics ( ) const

Build a kinematics object from this tower.

Definition at line 41 of file PufitGrid.cxx.

     {
       return m_kin;
     }

◆ mask()

void HLT::MET::PufitGrid::Tower::mask ( bool value = true )

Set the mask on this tower.

Definition at line 37 of file PufitGrid.cxx.

37 { m_mask = value; }

◆ masked()

bool HLT::MET::PufitGrid::Tower::masked ( ) const

Whether or not this tower was masked.

Definition at line 36 of file PufitGrid.cxx.

36 { return m_mask; }

◆ operator SignedKinematics()

HLT::MET::PufitGrid::Tower::operator SignedKinematics ( ) const

Conversion operator.

Definition at line 45 of file PufitGrid.cxx.

45 { return kinematics(); }

◆ operator+=() [1/2]

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

Add a signed object to this tower.

No check is done to make sure that this is the right bin. 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 47 of file PufitGrid.cxx.

     {
       m_kin += kin;
       m_sumEt += kin.pt();
       m_sumE += kin.energy();
       return *this;
     }

◆ operator+=() [2/2]

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

Add another tower's energies into this one.

Definition at line 61 of file PufitGrid.cxx.

     {
       m_kin += other.kinematics();
       m_sumEt += other.sumEt();
       m_sumE += other.sumE();
       return *this;
     }

◆ operator-=() [1/2]

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

Remove the energy of a signed object from this tower.

No check is done to make sure that this is the right bin. 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 54 of file PufitGrid.cxx.

     {
       m_kin -= kin;
       m_sumEt -= kin.pt();
       m_sumE -= kin.energy();
       return *this;
     }

◆ operator-=() [2/2]

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

Subtract another tower's energies from this one.

Definition at line 68 of file PufitGrid.cxx.

     {
       m_kin -= other.kinematics();
       m_sumEt -= other.sumEt();
       m_sumE -= other.sumE();
       return *this;
     }

◆ operator=()

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

Copy assignment operator.

This will not copy the other tower's parent. Each tower's parent is fixed from construction! This only copies the energy and masking information over.

Definition at line 20 of file PufitGrid.cxx.

     {
       m_kin = other.kinematics();
       m_sumEt = other.sumEt();
       m_sumE = other.sumE();
       m_mask = other.masked();
       return *this;
     }

◆ phi()

double HLT::MET::PufitGrid::Tower::phi ( ) const

This tower's kinematic phi.

Definition at line 34 of file PufitGrid.cxx.

34 { return kinematics().phi(); }

◆ phiIndex()

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

inherited

The phi index of this tower.

Definition at line 54 of file PeriodicGridBase.cxx.

     {
       return etaPhiIndex().second;
     }

◆ sumE()

double HLT::MET::PufitGrid::Tower::sumE ( ) const

The total sumE in this tower.

Definition at line 33 of file PufitGrid.cxx.

33 { return m_sumE; }

◆ sumEt()

double HLT::MET::PufitGrid::Tower::sumEt ( ) const

The total sumEt in this tower.

Definition at line 32 of file PufitGrid.cxx.

32 { return m_sumEt; }

◆ towerEta()

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

inherited

The central eta coordinate of this tower.

Definition at line 39 of file PeriodicGridBase.cxx.

     {
       return grid()->centralEta(m_index);
     }

◆ towerPhi()

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

inherited

The central phi coordinate of this tower.

Definition at line 34 of file PeriodicGridBase.cxx.

     {
       return grid()->centralPhi(m_index);
     }

Member Data Documentation

◆ m_index

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

privateinherited

Definition at line 109 of file PeriodicGridBase.h.

◆ m_kin

SignedKinematics HLT::MET::PufitGrid::Tower::m_kin

private

Definition at line 147 of file PufitGrid.h.

◆ m_mask

bool HLT::MET::PufitGrid::Tower::m_mask {false}

private

The mask value.

Definition at line 153 of file PufitGrid.h.

◆ m_parent

const PufitGrid* const HLT::MET::PufitGrid::Tower::m_parent

private

The parent grid.

Definition at line 145 of file PufitGrid.h.

◆ m_sumE

double HLT::MET::PufitGrid::Tower::m_sumE {0.}

private

The summed energy.

Definition at line 151 of file PufitGrid.h.

◆ m_sumEt

double HLT::MET::PufitGrid::Tower::m_sumEt {0.}

private

The summed et.

Definition at line 149 of file PufitGrid.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Tower() [1/2]

◆ Tower() [2/2]

Member Function Documentation

◆ eta()

◆ etaIndex()

◆ etaPhiIndex()

◆ ex()

◆ ey()

◆ ez()

◆ grid()

◆ index()

◆ kinematics()

◆ mask()

◆ masked()

◆ operator SignedKinematics()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator=()

◆ phi()

◆ phiIndex()

◆ sumE()

◆ sumEt()

◆ towerEta()

◆ towerPhi()

Member Data Documentation

◆ m_index

◆ m_kin

◆ m_mask

◆ m_parent

◆ m_sumE

◆ m_sumEt