CaloTowerSeg Class Reference

Data object stores CaloTower segmentation. More...

#include <CaloTowerSeg.h>

Collaboration diagram for CaloTowerSeg:

Classes
class	SubSeg
	A rectangular window within the segmentation. More...
class	SubSegIterator
	Iterator over a rectangular window of towers. More...

Public Types
typedef size_t	index_t
	Type for eta, phi indices. More...

Public Member Functions
	CaloTowerSeg ()
	Default constructor. More...
	CaloTowerSeg (index_t neta, index_t nphi, double etamin, double etamax, double phimin=s_range.phi_min(), double phimax=s_range.phi_max())
	Constructor. More...
	~CaloTowerSeg ()
	Destructor. More...
index_t	neta () const
	Retrieve number of \( \eta \) bins. More...
index_t	nphi () const
	Retrieve number of \( \varphi \) bins. More...
double	deta () const
	Retrieve bin size \( \Delta \eta \). More...
double	dphi () const
	Retrieve bin size \( \Delta \varphi \). More...
double	etamin () const
	Retrieve lower boundary \( \eta \) value range. More...
double	etamax () const
	Retrieve upper boundary \( \eta \) value range. More...
double	phimin () const
	Retrieve lower boundary \( \varphi \) value range. More...
double	phimax () const
	Retrieve upper boundary \( \varphi \) value range. More...
bool	inbound (index_t etaInd, index_t phiInd) const
	Check index range in \( \eta \) and \( \varphi \). More...
bool	inbound (double etaVal, double phiVal) const
	Check value range in \( \eta \) and \( \varphi \). More...
index_t	etaphi (index_t etaInd, index_t phiInd) const
	Returns combined continous index from \( \eta \), \( \varphi \) indices. More...
double	eta (index_t etaInd) const
	Returns \( \eta \) value for a given \( \eta \) index. More...
index_t	etaIndex (double etaVal) const
	Returns \( \eta \) index for a given \( \eta \) value. More...
index_t	etaIndex (index_t comInd) const
	Returns \( \eta \) index for a given combined index. More...
double	phi (index_t phiInd) const
	Returns \( \varphi \) value for a given \( \varphi \) index. More...
index_t	phiIndex (double phiVal) const
	Returns \( \varphi \) index for a given \( \varphi \) value. More...
index_t	phiIndex (index_t comInd) const
	Returns \( \varphi \) index for a given combined index. More...
SubSeg	subseg (double eta, double deta, double phi, double dphi) const
	Return a window within the current segmentation. More...

Static Public Attributes
static const index_t	outOfRange = static_cast<index_t> (-1)
	Used to flag out-of-range indices. More...

Private Attributes
index_t	m_neta
	Number of \( \eta \) bins. More...
index_t	m_nphi
	Number of \( \varphi \) bins. More...
double	m_etamin
	Lower boundary \( \eta \) value range. More...
double	m_etamax
	Upper boundary \( \eta \) value range. More...
double	m_phimin
	Lower boundary \( \varphi \) value range. More...
double	m_phimax
	Upper boundary \( \varphi \) value range. More...
double	m_deta
	Bin size \( \Delta \eta \). More...
double	m_dphi
	Bin size \( \Delta \varphi \). More...

Static Private Attributes
static const CaloPhiRange	s_range

Friends
class	CaloTowerSegCnv_p1

Detailed Description

Data object stores CaloTower segmentation.

Author

S. Rajagopalan srini.nosp@m.r@bn.nosp@m.l.gov

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

Date

April 1, 2005

Version

2

The CaloTowerSeg class generates an object which stores the tower segmentation in reguar \( \Delta \eta \times \Delta \varphi \) bins. The bin index convention is \( i \in [1,n] \), where \( n \) is the number of bins for a given variable. In addition a continously running index \( k \) is providing by combining the \( \eta \) and \( \varphi \) indices, with \( k \in [0,N-1] \). \( N \) is total number of bins (sum of the numbers of \( \eta \) and \( \varphi \) bins).

Definition at line 36 of file CaloTowerSeg.h.

Member Typedef Documentation

index_t

typedef size_t CaloTowerSeg::index_t

Type for eta, phi indices.

Definition at line 59 of file CaloTowerSeg.h.

Constructor & Destructor Documentation

CaloTowerSeg() [1/2]

CaloTowerSeg::CaloTowerSeg ( )

inline

Default constructor.

Instantiates useless empty tower grid.

Definition at line 69 of file CaloTowerSeg.h.

                                           :
    m_neta(neta),m_nphi(nphi),

CaloTowerSeg() [2/2]

CaloTowerSeg::CaloTowerSeg ( index_t  neta, index_t  nphi, double  etamin, double  etamax, double  phimin = s_range.phi_min(), double  phimax = s_range.phi_max()  )

inline

Constructor.

Parameters

neta	input number of \( \eta \) bins
nphi	input number of \( \varphi \) bins
etamin	input lower boundary \( \eta \) value range
etamax	input upper boundary \( \eta \) value range
phimin	input lower boundary \( \varphi \) value range
phimax	input upper boundary \( \varphi \) value range

\( \varphi \) by default covers the full circle. CaloPhiRange::phi_min() and CaloPhiRange::phi_max() are used to implement the correct \( \varphi \) range convention.

May have phimin > phimax for the case of wraparound.

Only regular (equidistant) bins are supported in both directions.

Definition at line 93 of file CaloTowerSeg.h.

  {

~CaloTowerSeg()

CaloTowerSeg::~CaloTowerSeg ( )

inline

Destructor.

Definition at line 105 of file CaloTowerSeg.h.

  {

Member Function Documentation

deta()

double CaloTowerSeg::deta ( ) const

inline

Retrieve bin size \( \Delta \eta \).

Definition at line 433 of file CaloTowerSeg.h.

{
  return m_deta;
}

dphi()

double CaloTowerSeg::dphi ( ) const

inline

Retrieve bin size \( \Delta \varphi \).

Definition at line 438 of file CaloTowerSeg.h.

{
  return m_dphi;
}

eta()

double CaloTowerSeg::eta ( index_t  etaInd ) const

inline

Returns \( \eta \) value for a given \( \eta \) index.

Parameters

etaInd

input \( \eta \) index

Can return \( \eta \) value outside of allowed value range if index out of range (no internal check).

Definition at line 516 of file CaloTowerSeg.h.

{
 return  m_etamin + (etaInd-0.5) * m_deta ; 
}

etaIndex() [1/2]

CaloTowerSeg::index_t CaloTowerSeg::etaIndex ( double  etaVal ) const

inline

Returns \( \eta \) index for a given \( \eta \) value.

Parameters

etaVal

input \( \eta \) value

Returns size_t(-1) in case of \( \eta \) being out of allowed value range.

Definition at line 489 of file CaloTowerSeg.h.

{
  return ( etaVal >= m_etamin && etaVal <= m_etamax )
    ? (index_t)floor( ( etaVal - m_etamin ) / m_deta ) + 1
    : outOfRange;
}

etaIndex() [2/2]

CaloTowerSeg::index_t CaloTowerSeg::etaIndex ( index_t  comInd ) const

inline

Returns \( \eta \) index for a given combined index.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

comInd

input combined index

Can return an invalid \( \eta \) index if comInd is invalid.

Definition at line 495 of file CaloTowerSeg.h.

{
  return (index_t)(comInd/m_nphi) + 1;
}

etamax()

double CaloTowerSeg::etamax ( ) const

inline

Retrieve upper boundary \( \eta \) value range.

Definition at line 448 of file CaloTowerSeg.h.

{
  return m_etamax;
}

etamin()

double CaloTowerSeg::etamin ( ) const

inline

Retrieve lower boundary \( \eta \) value range.

Definition at line 443 of file CaloTowerSeg.h.

{
  return m_etamin;
}

etaphi()

size_t CaloTowerSeg::etaphi ( index_t  etaInd, index_t  phiInd  ) const

inline

Returns combined continous index from \( \eta \), \( \varphi \) indices.

Parameters

etaInd	input \( \eta \) index
phiInd	input \( \varphi \) index

Calculates a common running index from \(\eta\) and \(\phi\) . Returns size_t(-1) if input outside of allowed index ranges.

Definition at line 481 of file CaloTowerSeg.h.

{
  return this->inbound(etaInd,phiInd) 
    ? (etaInd-1) * m_nphi + (phiInd-1) 
    : outOfRange; 
}

inbound() [1/2]

bool CaloTowerSeg::inbound ( double  etaVal, double  phiVal  ) const

inline

Check value range in \( \eta \) and \( \varphi \).

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

etaVal	input \( \eta \) coordinate
phiVal	input \( \varphi \) coordinate

Returns true when both eta and phi are inside their respective allowed value ranges.

Definition at line 470 of file CaloTowerSeg.h.

{
  if ( ! ( etaVal >= m_etamin && etaVal <= m_etamax ) ) return false;
  if (m_phimax > m_phimin)
    return phiVal >= m_phimin && phiVal <= m_phimax;
  else
    return phiVal <= m_phimax || phiVal >= m_phimin;
}

inbound() [2/2]

bool CaloTowerSeg::inbound ( index_t  etaInd, index_t  phiInd  ) const

inline

Check index range in \( \eta \) and \( \varphi \).

Parameters

etaInd	input \( \eta \) index
phiInd	input \( \varphi \) index

Returns true when both eta and phi are within their respective allowed index ranges.

Definition at line 463 of file CaloTowerSeg.h.

{
  return 
    etaInd >= 1 && etaInd <= m_neta && 
    phiInd >= 1 && phiInd <= m_nphi; 
}

neta()

CaloTowerSeg::index_t CaloTowerSeg::neta ( ) const

inline

Retrieve number of \( \eta \) bins.

Definition at line 423 of file CaloTowerSeg.h.

{
    return m_neta; 
}

nphi()

CaloTowerSeg::index_t CaloTowerSeg::nphi ( ) const

inline

Retrieve number of \( \varphi \) bins.

Definition at line 428 of file CaloTowerSeg.h.

{
    return m_nphi; 
}

phi()

double CaloTowerSeg::phi ( index_t  phiInd ) const

inline

Returns \( \varphi \) value for a given \( \varphi \) index.

Parameters

phiInd

input \( \varphi \) index

Can return \( \varphi \) value outside of allowed value range if index out of range (no internal check).

Definition at line 521 of file CaloTowerSeg.h.

{
  double ret = m_phimin + (phiInd-0.5) * m_dphi;
  if (m_phimin > m_phimax)
    ret = s_range.fix (ret);
  return ret;
}

phiIndex() [1/2]

CaloTowerSeg::index_t CaloTowerSeg::phiIndex ( double  phiVal ) const

inline

Returns \( \varphi \) index for a given \( \varphi \) value.

Parameters

phiVal

input \( \varphi \) value

Returns size_t(-1) in case of \( \varphi \) being out of allowed value range.

Definition at line 499 of file CaloTowerSeg.h.

{
  if (m_phimax > m_phimin)
    return ( phiVal >= m_phimin && phiVal <= m_phimax )
      ? (index_t)floor( ( phiVal - m_phimin ) / m_dphi ) + 1
      : outOfRange;
  else
    return ( phiVal >= m_phimin || phiVal <= m_phimax )
      ? (index_t)floor( s_range.diff ( phiVal, m_phimin ) / m_dphi ) + 1
      : outOfRange;
}

phiIndex() [2/2]

CaloTowerSeg::index_t CaloTowerSeg::phiIndex ( index_t  comInd ) const

inline

Returns \( \varphi \) index for a given combined index.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

comInd

input combined index

Can return an invalid \( \varphi \) index if comInd is invalid.

Definition at line 510 of file CaloTowerSeg.h.

{
  return (index_t)(comInd % m_nphi) + 1;
}

phimax()

double CaloTowerSeg::phimax ( ) const

inline

Retrieve upper boundary \( \varphi \) value range.

Definition at line 458 of file CaloTowerSeg.h.

{
  return m_phimax;
}

phimin()

double CaloTowerSeg::phimin ( ) const

inline

Retrieve lower boundary \( \varphi \) value range.

Definition at line 453 of file CaloTowerSeg.h.

{
  return m_phimin;
}

subseg()

CaloTowerSeg::SubSeg CaloTowerSeg::subseg	(	double	eta,
		double	deta,
		double	phi,
		double	dphi
	)		const

Return a window within the current segmentation.

The window is centered at eta/phi with half-widths deta/dphi.

Definition at line 23 of file CaloTowerSeg.cxx.

{
  using index_t = SubSeg::index_t;
 
  index_t etamin = this->etaIndex (eta - deta + 0.001);
  if (etamin == CaloTowerSeg::outOfRange)
    etamin = 1;
 
  index_t etamax = this->etaIndex (eta + deta - 0.001);
  if (etamax == CaloTowerSeg::outOfRange)
    etamax = this->neta();
 
  index_t phimin = this->phiIndex (CaloPhiRange::fix (phi - dphi + 0.001));
  if (phimin == CaloTowerSeg::outOfRange)
    phimin = this->phiIndex (this->phimin());
 
  index_t phimax = this->phiIndex (CaloPhiRange::fix (phi + dphi - 0.001));
  if (phimax == CaloTowerSeg::outOfRange)
    phimax = this->phiIndex (this->phimax() - this->dphi()/2);
 
  return SubSeg (*this, etamin, etamax, phimin, phimax);
}

Friends And Related Function Documentation

CaloTowerSegCnv_p1

friend class CaloTowerSegCnv_p1

friend

Definition at line 407 of file CaloTowerSeg.h.

Member Data Documentation

m_deta

double CaloTowerSeg::m_deta

private

Bin size \( \Delta \eta \).

Definition at line 429 of file CaloTowerSeg.h.

m_dphi

double CaloTowerSeg::m_dphi

private

Bin size \( \Delta \varphi \).

Definition at line 431 of file CaloTowerSeg.h.

m_etamax

double CaloTowerSeg::m_etamax

private

Upper boundary \( \eta \) value range.

Definition at line 422 of file CaloTowerSeg.h.

m_etamin

double CaloTowerSeg::m_etamin

private

Lower boundary \( \eta \) value range.

Definition at line 420 of file CaloTowerSeg.h.

m_neta

index_t CaloTowerSeg::m_neta

private

Number of \( \eta \) bins.

Definition at line 415 of file CaloTowerSeg.h.

m_nphi

index_t CaloTowerSeg::m_nphi

private

Number of \( \varphi \) bins.

Definition at line 417 of file CaloTowerSeg.h.

m_phimax

double CaloTowerSeg::m_phimax

private

Upper boundary \( \varphi \) value range.

Definition at line 426 of file CaloTowerSeg.h.

m_phimin

double CaloTowerSeg::m_phimin

private

Lower boundary \( \varphi \) value range.

Definition at line 424 of file CaloTowerSeg.h.

outOfRange

const index_t CaloTowerSeg::outOfRange = static_cast<index_t> (-1)

static

Used to flag out-of-range indices.

Definition at line 62 of file CaloTowerSeg.h.

s_range

const CaloPhiRange CaloTowerSeg::s_range

staticprivate

Definition at line 435 of file CaloTowerSeg.h.

---

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

• CaloTowerSeg.h
• CaloTowerSeg.cxx