This class provides an interface to deal with regions in the neighbours finding. More...

#include <LArFCAL_region.h>

Collaboration diagram for LArFCAL_region:

Public Member Functions
	LArFCAL_region (void)
	LArFCAL_region (unsigned int &minHash, short int &nbEtaBins, short int &nPhi, float minEta, float granulEta, float minPhi, float granulPhi, bool fullSym, short int &prevEtaSamp, short int &nextEtaSamp)
	~LArFCAL_region (void)=default
short int	numberOfEta () const
	number of eta bins in the whole region
short int	phiN () const
	number of phi bins
float	etaGranularity () const
	eta granularity
float	phiGranularity () const
	phi granularity
bool	fullTwoPi () const
	true if detector covers full 2pi (== wraparound option in dictionary)
float	etaMin () const
	starting eta
float	etaMax () const
	end eta
float	phiMin () const
	starting phi
float	phiMax () const
	end phi
unsigned int	hashMin () const
	hash Id of the first cell of the region
unsigned int	hashMax () const
	hash Id of the last cell of the region +1
bool	isEtaMin (const unsigned int &index) const
	is the considered cell in the first eta bin of the region ?
bool	isEtaMax (const unsigned int &index) const
	is the considered cell in the last eta bin of the region ?
bool	isPhiMin (const unsigned int &index) const
	is the considered cell in the first phi bin of the region ?
bool	isPhiMax (const unsigned int &index) const
	is the considered cell in the last phi bin of the region ?
short int	prevSamplingRegion () const
	region number of the prev region in sampling
short int	nextSamplingRegion () const
	region number of the next region in sampling

Private Attributes
unsigned int	m_hashMin
short int	m_nbEtaBins
short int	m_nPhi
float	m_minEta
float	m_granulEta
float	m_minPhi
float	m_granulPhi
bool	m_fullSym
short int	m_prevSampReg
short int	m_nextSampReg

Detailed Description

This class provides an interface to deal with regions in the neighbours finding.

Definition at line 19 of file LArFCAL_region.h.

Constructor & Destructor Documentation

◆ LArFCAL_region() [1/2]

LArFCAL_region::LArFCAL_region ( void )

Definition at line 12 of file LArFCAL_region.cxx.

                              :
  m_hashMin(0)
  ,m_nbEtaBins(0)
  ,m_nPhi(0)
  ,m_minEta(99)
  ,m_granulEta(0)
  ,m_minPhi(99)
  ,m_granulPhi(0)
  ,m_fullSym(true)
  ,m_prevSampReg(63)
  ,m_nextSampReg(63)
{
}

◆ LArFCAL_region() [2/2]

LArFCAL_region::LArFCAL_region	(	unsigned int &	minHash,
		short int &	nbEtaBins,
		short int &	nPhi,
		float	minEta,
		float	granulEta,
		float	minPhi,
		float	granulPhi,
		bool	fullSym,
		short int &	prevEtaSamp,
		short int &	nextEtaSamp )

Definition at line 26 of file LArFCAL_region.cxx.

{
 
  m_hashMin     = minHash;
  m_nbEtaBins   = nbEtaBins;
  m_nPhi        = nPhi;
  m_minEta      = minEta;
  m_granulEta   = granulEta;
  m_minPhi      = minPhi;
  m_granulPhi   = granulPhi;
  m_fullSym     = fullSym;
  m_prevSampReg = prevSampReg;
  m_nextSampReg = nextSampReg;
 
}

◆ ~LArFCAL_region()

LArFCAL_region::~LArFCAL_region ( void )

default

Member Function Documentation

◆ etaGranularity()

float LArFCAL_region::etaGranularity ( ) const

eta granularity

Definition at line 56 of file LArFCAL_region.cxx.

{
  return m_granulEta ;
}

◆ etaMax()

float LArFCAL_region::etaMax ( ) const

end eta

Definition at line 76 of file LArFCAL_region.cxx.

{
  return (m_minEta + m_nbEtaBins*m_granulEta) ;
}

◆ etaMin()

float LArFCAL_region::etaMin ( ) const

starting eta

Definition at line 71 of file LArFCAL_region.cxx.

{
  return m_minEta ;
}

◆ fullTwoPi()

bool LArFCAL_region::fullTwoPi ( ) const

true if detector covers full 2pi (== wraparound option in dictionary)

Definition at line 66 of file LArFCAL_region.cxx.

{
  return m_fullSym ;
}

◆ hashMax()

unsigned int LArFCAL_region::hashMax ( ) const

hash Id of the last cell of the region +1

Definition at line 96 of file LArFCAL_region.cxx.

{
  return (m_hashMin + m_nbEtaBins * m_nPhi) ;
}

◆ hashMin()

unsigned int LArFCAL_region::hashMin ( ) const

hash Id of the first cell of the region

Definition at line 91 of file LArFCAL_region.cxx.

{
  return m_hashMin ;
}

◆ isEtaMax()

bool LArFCAL_region::isEtaMax ( const unsigned int & index ) const

is the considered cell in the last eta bin of the region ?

Definition at line 108 of file LArFCAL_region.cxx.

{
  bool result=false;
  if( ((hashMax()-m_nPhi)<=index) && (index<hashMax()))result=true;
  return result;
}

◆ isEtaMin()

bool LArFCAL_region::isEtaMin ( const unsigned int & index ) const

is the considered cell in the first eta bin of the region ?

Definition at line 101 of file LArFCAL_region.cxx.

{
  bool result=false;
  if( ((m_hashMin<=index) && (index<(m_hashMin+m_nPhi))))result=true;
  return result;
}

◆ isPhiMax()

bool LArFCAL_region::isPhiMax ( const unsigned int & index ) const

is the considered cell in the last phi bin of the region ?

Definition at line 122 of file LArFCAL_region.cxx.

{
  bool result=false;
  if( !m_fullSym && (index-m_hashMin+1)%m_nPhi == 0 )result=true;  
  return result;
}

◆ isPhiMin()

bool LArFCAL_region::isPhiMin ( const unsigned int & index ) const

is the considered cell in the first phi bin of the region ?

Definition at line 115 of file LArFCAL_region.cxx.

{
  bool result=false;
  if( !m_fullSym && (index-m_hashMin)%m_nPhi == 0 )result=true; 
  return result;
}

◆ nextSamplingRegion()

short int LArFCAL_region::nextSamplingRegion ( ) const

region number of the next region in sampling

Definition at line 129 of file LArFCAL_region.cxx.

{
  return  m_nextSampReg;
}

◆ numberOfEta()

short int LArFCAL_region::numberOfEta ( ) const

number of eta bins in the whole region

Definition at line 46 of file LArFCAL_region.cxx.

{
  return m_nbEtaBins ;
}

◆ phiGranularity()

float LArFCAL_region::phiGranularity ( ) const

phi granularity

Definition at line 61 of file LArFCAL_region.cxx.

{
  return m_granulPhi ;
}

◆ phiMax()

float LArFCAL_region::phiMax ( ) const

end phi

Definition at line 86 of file LArFCAL_region.cxx.

{
  return (m_minPhi + m_nPhi*m_granulPhi) ;
}

◆ phiMin()

float LArFCAL_region::phiMin ( ) const

starting phi

Definition at line 81 of file LArFCAL_region.cxx.

{
  return m_minPhi ;
}

◆ phiN()

short int LArFCAL_region::phiN ( ) const

number of phi bins

Definition at line 51 of file LArFCAL_region.cxx.

{
  return m_nPhi ;
}

◆ prevSamplingRegion()

short int LArFCAL_region::prevSamplingRegion ( ) const

region number of the prev region in sampling

Definition at line 134 of file LArFCAL_region.cxx.

{
  return  m_prevSampReg;
}

Member Data Documentation

◆ m_fullSym

bool LArFCAL_region::m_fullSym

private

Definition at line 92 of file LArFCAL_region.h.

◆ m_granulEta

float LArFCAL_region::m_granulEta

private

Definition at line 89 of file LArFCAL_region.h.

◆ m_granulPhi

float LArFCAL_region::m_granulPhi

private

Definition at line 91 of file LArFCAL_region.h.

◆ m_hashMin

unsigned int LArFCAL_region::m_hashMin

private

Definition at line 85 of file LArFCAL_region.h.

◆ m_minEta

float LArFCAL_region::m_minEta

private

Definition at line 88 of file LArFCAL_region.h.

◆ m_minPhi

float LArFCAL_region::m_minPhi

private

Definition at line 90 of file LArFCAL_region.h.

◆ m_nbEtaBins

short int LArFCAL_region::m_nbEtaBins

private

Definition at line 86 of file LArFCAL_region.h.

◆ m_nextSampReg

short int LArFCAL_region::m_nextSampReg

private

Definition at line 95 of file LArFCAL_region.h.

◆ m_nPhi

short int LArFCAL_region::m_nPhi

private

Definition at line 87 of file LArFCAL_region.h.

◆ m_prevSampReg

short int LArFCAL_region::m_prevSampReg

private

Definition at line 94 of file LArFCAL_region.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LArFCAL_region() [1/2]

◆ LArFCAL_region() [2/2]

◆ ~LArFCAL_region()

Member Function Documentation

◆ etaGranularity()

◆ etaMax()

◆ etaMin()

◆ fullTwoPi()

◆ hashMax()

◆ hashMin()

◆ isEtaMax()

◆ isEtaMin()

◆ isPhiMax()

◆ isPhiMin()

◆ nextSamplingRegion()

◆ numberOfEta()

◆ phiGranularity()

◆ phiMax()

◆ phiMin()

◆ phiN()

◆ prevSamplingRegion()

Member Data Documentation

◆ m_fullSym

◆ m_granulEta

◆ m_granulPhi

◆ m_hashMin

◆ m_minEta

◆ m_minPhi

◆ m_nbEtaBins

◆ m_nextSampReg

◆ m_nPhi

◆ m_prevSampReg