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

#include <LArHEC_region.h>

Collaboration diagram for LArHEC_region:

Public Member Functions
	LArHEC_region (void)
	LArHEC_region (unsigned int &minHash, short int &nbEtaBins, short int &nPhi, float minEta, float granulEta, float minPhi, float granulPhi, bool fullSym, short int &prevEtaReg, short int &nextEtaReg, std::vector< short int > &prevEtaSamp, std::vector< short int > &nextEtaSamp)
	~LArHEC_region (void)
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
short int	prevEtaRegion () const
	region number of the previous region in eta
short int	nextEtaRegion () const
	region number of the next region in eta
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 ?
const std::vector< short int > &	prevSamplingRegion () const
	region number of the prev region in sampling
const std::vector< 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_prevEtaReg
short int	m_nextEtaReg
std::vector< short int >	m_prevSampReg
std::vector< short int >	m_nextSampReg

Detailed Description

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

Definition at line 20 of file LArHEC_region.h.

Constructor & Destructor Documentation

◆ LArHEC_region() [1/2]

LArHEC_region::LArHEC_region ( void )

Definition at line 11 of file LArHEC_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_prevEtaReg(63)
  ,m_nextEtaReg(63)
{
}

◆ LArHEC_region() [2/2]

LArHEC_region::LArHEC_region	(	unsigned int &	minHash,
		short int &	nbEtaBins,
		short int &	nPhi,
		float	minEta,
		float	granulEta,
		float	minPhi,
		float	granulPhi,
		bool	fullSym,
		short int &	prevEtaReg,
		short int &	nextEtaReg,
		std::vector< short int > &	prevEtaSamp,
		std::vector< short int > &	nextEtaSamp )

Definition at line 25 of file LArHEC_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_prevEtaReg (prevEtaReg),
    m_nextEtaReg (nextEtaReg),
    m_prevSampReg(prevSampReg),
    m_nextSampReg(nextSampReg)
{
 
 
}

◆ ~LArHEC_region()

LArHEC_region::~LArHEC_region ( void )

default

Member Function Documentation

◆ etaGranularity()

float LArHEC_region::etaGranularity ( ) const

eta granularity

Definition at line 59 of file LArHEC_region.cxx.

{
  return m_granulEta ;
}

◆ etaMax()

float LArHEC_region::etaMax ( ) const

end eta

Definition at line 79 of file LArHEC_region.cxx.

{
  return (m_minEta + m_nbEtaBins*m_granulEta) ;
}

◆ etaMin()

float LArHEC_region::etaMin ( ) const

starting eta

Definition at line 74 of file LArHEC_region.cxx.

{
  return m_minEta ;
}

◆ fullTwoPi()

bool LArHEC_region::fullTwoPi ( ) const

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

Definition at line 69 of file LArHEC_region.cxx.

{
  return m_fullSym ;
}

◆ hashMax()

unsigned int LArHEC_region::hashMax ( ) const

hash Id of the last cell of the region +1

Definition at line 99 of file LArHEC_region.cxx.

{
  return (m_hashMin + m_nbEtaBins * m_nPhi) ;
}

◆ hashMin()

unsigned int LArHEC_region::hashMin ( ) const

hash Id of the first cell of the region

Definition at line 94 of file LArHEC_region.cxx.

{
  return m_hashMin ;
}

◆ isEtaMax()

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

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

Definition at line 121 of file LArHEC_region.cxx.

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

◆ isEtaMin()

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

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

Definition at line 114 of file LArHEC_region.cxx.

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

◆ isPhiMax()

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

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

Definition at line 135 of file LArHEC_region.cxx.

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

◆ isPhiMin()

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

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

Definition at line 128 of file LArHEC_region.cxx.

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

◆ nextEtaRegion()

short int LArHEC_region::nextEtaRegion ( ) const

region number of the next region in eta

Definition at line 109 of file LArHEC_region.cxx.

{
  return m_nextEtaReg;
}

◆ nextSamplingRegion()

const std::vector< short int > & LArHEC_region::nextSamplingRegion ( ) const

region number of the next region in sampling

Definition at line 142 of file LArHEC_region.cxx.

{
  return m_nextSampReg;
}

◆ numberOfEta()

short int LArHEC_region::numberOfEta ( ) const

number of eta bins in the whole region

Definition at line 49 of file LArHEC_region.cxx.

{
  return m_nbEtaBins ;
}

◆ phiGranularity()

float LArHEC_region::phiGranularity ( ) const

phi granularity

Definition at line 64 of file LArHEC_region.cxx.

{
  return m_granulPhi ;
}

◆ phiMax()

float LArHEC_region::phiMax ( ) const

end phi

Definition at line 89 of file LArHEC_region.cxx.

{
  return (m_minPhi + m_nPhi*m_granulPhi) ;
}

◆ phiMin()

float LArHEC_region::phiMin ( ) const

starting phi

Definition at line 84 of file LArHEC_region.cxx.

{
  return m_minPhi ;
}

◆ phiN()

short int LArHEC_region::phiN ( ) const

number of phi bins

Definition at line 54 of file LArHEC_region.cxx.

{
  return m_nPhi ;
}

◆ prevEtaRegion()

short int LArHEC_region::prevEtaRegion ( ) const

region number of the previous region in eta

Definition at line 104 of file LArHEC_region.cxx.

{
  return m_prevEtaReg;
}

◆ prevSamplingRegion()

const std::vector< short int > & LArHEC_region::prevSamplingRegion ( ) const

region number of the prev region in sampling

Definition at line 147 of file LArHEC_region.cxx.

{
  return m_prevSampReg;
}

Member Data Documentation

◆ m_fullSym

bool LArHEC_region::m_fullSym

private

Definition at line 100 of file LArHEC_region.h.

◆ m_granulEta

float LArHEC_region::m_granulEta

private

Definition at line 97 of file LArHEC_region.h.

◆ m_granulPhi

float LArHEC_region::m_granulPhi

private

Definition at line 99 of file LArHEC_region.h.

◆ m_hashMin

unsigned int LArHEC_region::m_hashMin

private

Definition at line 93 of file LArHEC_region.h.

◆ m_minEta

float LArHEC_region::m_minEta

private

Definition at line 96 of file LArHEC_region.h.

◆ m_minPhi

float LArHEC_region::m_minPhi

private

Definition at line 98 of file LArHEC_region.h.

◆ m_nbEtaBins

short int LArHEC_region::m_nbEtaBins

private

Definition at line 94 of file LArHEC_region.h.

◆ m_nextEtaReg

short int LArHEC_region::m_nextEtaReg

private

Definition at line 103 of file LArHEC_region.h.

◆ m_nextSampReg

std::vector<short int> LArHEC_region::m_nextSampReg

private

Definition at line 105 of file LArHEC_region.h.

◆ m_nPhi

short int LArHEC_region::m_nPhi

private

Definition at line 95 of file LArHEC_region.h.

◆ m_prevEtaReg

short int LArHEC_region::m_prevEtaReg

private

Definition at line 102 of file LArHEC_region.h.

◆ m_prevSampReg

std::vector<short int> LArHEC_region::m_prevSampReg

private

Definition at line 104 of file LArHEC_region.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LArHEC_region() [1/2]

◆ LArHEC_region() [2/2]

◆ ~LArHEC_region()

Member Function Documentation

◆ etaGranularity()

◆ etaMax()

◆ etaMin()

◆ fullTwoPi()

◆ hashMax()

◆ hashMin()

◆ isEtaMax()

◆ isEtaMin()

◆ isPhiMax()

◆ isPhiMin()

◆ nextEtaRegion()

◆ nextSamplingRegion()

◆ numberOfEta()

◆ phiGranularity()

◆ phiMax()

◆ phiMin()

◆ phiN()

◆ prevEtaRegion()

◆ prevSamplingRegion()

Member Data Documentation

◆ m_fullSym

◆ m_granulEta

◆ m_granulPhi

◆ m_hashMin

◆ m_minEta

◆ m_minPhi

◆ m_nbEtaBins

◆ m_nextEtaReg

◆ m_nextSampReg

◆ m_nPhi

◆ m_prevEtaReg

◆ m_prevSampReg