LVL1::ClusterProcessorModuleKey Class Reference

The ClusterProcessorModuleKey object provides the key for each trigger tower depending on its eta-phi coords. More...

#include <ClusterProcessorModuleKey.h>

Inheritance diagram for LVL1::ClusterProcessorModuleKey:

Collaboration diagram for LVL1::ClusterProcessorModuleKey:

Public Member Functions
	ClusterProcessorModuleKey ()
	constructs a ClusterProcessorModuleKey object
virtual	~ClusterProcessorModuleKey ()
unsigned int	cpmKey (unsigned int crate, unsigned int module)
	calculates key from crate and module index
virtual double	dPhi (const Coordinate &coord) const override
	height
virtual double	dEta (const Coordinate &coord) const override
	width
unsigned int	cpm (const Coordinate &coord) const
	returns CPM number within a crate for a TriggerTower or RoI coordinate
virtual double	eta () const
	returns the centre of the TT at eta_coord:
virtual double	phi () const
	returns phi coordinate of centre of relevant trigger tower.
unsigned int	key (double phi, double eta)
	calculates a map key from passed phi, eta coordinates
unsigned int	key (const Coordinate &coord)
	returns the key of the passed Coordinate
Coordinate	coord () const
	return central coords of current key value.

Protected Member Functions
ICoordinate	convertCoordsToIntegers (double phi, double eta)
	converts the coordinates and corrects for overflows etc.
virtual int	sign (int temp) const
	returns -1 if temp is -ve and +1 if it is +ve.
virtual int	sign (double temp) const
	returns -1 if temp is -ve and +1 if it is +ve.
int	round (double a) const
	rounds number to nearest whole number
int	sharpRound (double a) const
	rounds number as follows (-1.0 to 0.0) -> -1, (0.0 to 1.0) -> 0, (1.0 to 2.0)->1 etc.
int	sharpRound2 (int a, int b) const
	divides a/b and returns a number as follows (where +b means +ve b): if 0
void	setupThisKeyValues ()

Protected Attributes
int	m_iphi
	integer phi coord
int	m_ieta
	integer eta coord
double	m_eta
	eta coordinate of key
double	m_phi
	phi coordinate of key
int	m_phiBin
	phi bin
int	m_etaBin
	eta bin
double	m_centralPhi
	this is the coordinate of the centre of the relevant trigger tower.
double	m_centralEta
	this is the coordinate of the centre of the relevant trigger tower.
bool	m_debug
	turns DEBUG code on and off

Private Member Functions
virtual BinAndCoord	calculateTriggerBin (const ICoordinate &iCoord) override
	converts integer phi, eta coordinates to phi, eta trigger bins, and central coords
void	setBins (const ICoordinate &iCoord, unsigned int &phiBin, int &etaBin)
	sets the eta and phi bins
unsigned int	phiQuadrant (const double phi) const
	returns the quadrant number associated with the phi coordinate, 0 - 90 = 0 90 - 180 = 1 180-270 = 2 270-360 = 3

Private Attributes
bool	m_debugModuleKey
	set to true to turn debugging info on

Detailed Description

The ClusterProcessorModuleKey object provides the key for each trigger tower depending on its eta-phi coords.

The key is an integer number that uniquely identifies each tower, and is needed by the STL map container: the map holds trigger towers and we retrieve them using their keys.

Author

Edward Moyse

Definition at line 44 of file ClusterProcessorModuleKey.h.

Constructor & Destructor Documentation

ClusterProcessorModuleKey()

LVL1::ClusterProcessorModuleKey::ClusterProcessorModuleKey

(

)

constructs a ClusterProcessorModuleKey object

Definition at line 34 of file ClusterProcessorModuleKey.cxx.

                                                     : KeyUtilities(), m_debugModuleKey(false){
  if (m_debugModuleKey) std::cout << "ClusterProcessorModuleKey: m_debugModuleKey output turned on...."<<std::endl;
}

~ClusterProcessorModuleKey()

LVL1::ClusterProcessorModuleKey::~ClusterProcessorModuleKey ( )

virtual

Definition at line 38 of file ClusterProcessorModuleKey.cxx.

                                                     {
}

Member Function Documentation

calculateTriggerBin()

LVL1::BinAndCoord LVL1::ClusterProcessorModuleKey::calculateTriggerBin ( const ICoordinate & iCoord )

overrideprivatevirtual

converts integer phi, eta coordinates to phi, eta trigger bins, and central coords

converts integer phi, eta coordinates to phi, eta trigger bins.

Returns coordinates of centre of JEs

Implements LVL1::KeyUtilities.

Definition at line 87 of file ClusterProcessorModuleKey.cxx.

                                                                                           {
  int abs_ieta=abs(iCoord.eta() );
  int sign=( iCoord.eta() )/abs_ieta;
 
  int etaBin=0; unsigned int phiBin=0;
  setBins(iCoord,phiBin,etaBin);
 
  double centralPhi=( static_cast<double>(phiBin)*TrigT1CaloDefs::cpmPhiSize )
    + TrigT1CaloDefs::cpmPhiSize*0.5;
  double centralEta=( static_cast<double>(etaBin)*TrigT1CaloDefs::cpmEtaSize )
     - (TrigT1CaloDefs::cpmEtaSize)*sign*0.5;
  if (m_debugModuleKey){
    std::cout << "ClusterProcessorModuleKey: start calcTrigBin"<<std::endl;
    std::cout << "phi, eta   : ("<<m_phi<<", "<<m_eta<<")"<<std::endl;
    std::cout << "iphi, ieta : ("<<( iCoord.phi() )<<", "<<( iCoord.eta() )<<")"<<std::endl;
    std::cout << "abs_ieta : ("<<abs_ieta<<" and sign :  "<<sign<<std::endl;
    std::cout << "central : ("<<centralPhi<<", "<<centralEta<<")"
        << "bin : ("<<phiBin<<","<<etaBin<<")"<<std::endl;
  }
 
  Coordinate centralCoords (centralPhi, centralEta);
  if (m_debugModuleKey) std::cout <<" ClusterProcessorModuleKey : created coord "<<centralCoords<<std::endl;
  return BinAndCoord(phiBin,etaBin,centralCoords);
}

convertCoordsToIntegers()

ICoordinate LVL1::KeyUtilities::convertCoordsToIntegers ( double phi, double eta )

protectedinherited

converts the coordinates and corrects for overflows etc.

For instance, if phi is negative this routine converts to the equivalent positive position.

For instance, if phi is negative this routine converts to the equivalent positive position. *todo tidy up a bit.

Definition at line 103 of file KeyUtilities.cxx.

                                                                       {
 
    double phiBinWidth=((2*M_PI)/64.0);
    // there are a maximum of 64 cells in the phi direction
    // stretching from 0 to ~2*PI.
    if (m_debug) std::cout << "KU : (phi, eta) ("<<phi<<","<<eta<<")"<<std::endl;
    int iphi=sharpRound(phi/phiBinWidth);
    int ieta=0;
 
    // Now check that m_iphi is between 0 and 64.
  iphi = iphi%64;
    if (iphi<0) iphi = 64+iphi;
 
    // Make m_ieta symmetrical:
    // o no cell at m_ieta=0
    // o first cells at +-1
    // o last cells at about +- 50
    // this gives us a more useful numerical symmetry.
 
    // So to get integer value we do:
    int temp_sign=sign(eta);
    double temp_abs=eta*temp_sign;
 
    double temp_double=(temp_abs*10.0+1.0)*temp_sign;
  if (m_debug) std::cout << "KU : temp_abs, temp_sign, temp_double : "<<temp_abs<<","<<temp_sign<<","<<temp_double<<std::endl;
//  if (m_eta>=0.0){
//    temp_double=m_eta*10.0+1.0;
//  }else{
//    temp_double=m_eta*10.0-1.0;
//  }
 
    ieta=static_cast<int>(temp_double);
    if (m_debug) std::cout << "KU : (iphi, ieta) ("<<iphi<<","<<ieta<<")"<<std::endl;
    return ICoordinate(iphi, ieta, eta);
}

coord()

LVL1::Coordinate LVL1::KeyUtilities::coord ( ) const

inherited

return central coords of current key value.

Definition at line 194 of file KeyUtilities.cxx.

                                            {
  return Coordinate(m_centralPhi,m_centralEta);
}

cpm()

unsigned int LVL1::ClusterProcessorModuleKey::cpm

(

const Coordinate &

coord

)

const

returns CPM number within a crate for a TriggerTower or RoI coordinate

Returns CPM number for TT coordinate.

TT and RoI coordinates are offset by 0.5*tower width. Shift by 0.25*tower width to allow common code without rounding errors

Definition at line 70 of file ClusterProcessorModuleKey.cxx.

                                                                              {
  double eta = coord.eta() - 0.025; 
  if (fabs(eta)<=2.5) { //  check within range
    double offset=2.8;  // Offset chosen to get RoI->module without rounding errors 
    double temp = (eta+offset)/TrigT1CaloDefs::cpmEtaSize + 1.;
    return static_cast<unsigned int>(temp);
  }
  else {  
    return 999;
  } 
}

cpmKey()

unsigned int LVL1::ClusterProcessorModuleKey::cpmKey	(	unsigned int	crate,
		unsigned int	module )

calculates key from crate and module index

returns trigger tower key of passed crate+module

Definition at line 42 of file ClusterProcessorModuleKey.cxx.

                                                                                      {
  double eta = module*TrigT1CaloDefs::cpmEtaSize - 3.0; // so module 1 spans -2.8<eta<-2.4
  double phi = (crate+0.5)*TrigT1CaloDefs::cpmPhiSize;
  return key(phi, eta);
}

dEta()

double LVL1::ClusterProcessorModuleKey::dEta ( const Coordinate & coord ) const

overridevirtual

width

return width of JE

Implements LVL1::KeyUtilities.

Definition at line 53 of file ClusterProcessorModuleKey.cxx.

                                                               {
  return TrigT1CaloDefs::cpmEtaSize;
}

dPhi()

double LVL1::ClusterProcessorModuleKey::dPhi ( const Coordinate & coord ) const

overridevirtual

height

return height of CPM

Implements LVL1::KeyUtilities.

Definition at line 48 of file ClusterProcessorModuleKey.cxx.

                                                               {
  return TrigT1CaloDefs::cpmPhiSize;// one quadrant
}

eta()

double LVL1::KeyUtilities::eta ( ) const

virtualinherited

returns the centre of the TT at eta_coord:

returns the eta coord of the centre of the relevent trigger tower

Definition at line 142 of file KeyUtilities.cxx.

                                  {
  return m_centralEta;
}

key() [1/2]

unsigned int LVL1::KeyUtilities::key ( const Coordinate & coord )

inherited

returns the key of the passed Coordinate

returns trigger tower key of passed Coordinate

Definition at line 94 of file KeyUtilities.cxx.

                                                      {
  return key(coord.phi(), coord.eta());
}

key() [2/2]

unsigned int LVL1::KeyUtilities::key ( double phi, double eta )

inherited

calculates a map key from passed phi, eta coordinates

returns key

calculates a map key from passed phi, eta coordinates

Definition at line 77 of file KeyUtilities.cxx.

                                                      {
  m_eta=eta;
  m_phi=phi;
  ICoordinate iCoord = convertCoordsToIntegers(m_phi, m_eta);
  BinAndCoord bandc  = calculateTriggerBin(iCoord);
  if (m_debug) std::cout << "KU : key: got bandc "<<std::endl;
  m_phiBin=bandc.phiBin();
  m_etaBin=bandc.etaBin();
  m_centralPhi=bandc.coords().phi();
  m_centralEta=bandc.coords().eta();
  int temp=((m_etaBin+50)<<6) + m_phiBin;
 
  if (m_debug) std::cout << "KU : key: returning - "<<temp<<std::endl;
    return static_cast<unsigned int>(temp);
}

phi()

double LVL1::KeyUtilities::phi ( ) const

virtualinherited

returns phi coordinate of centre of relevant trigger tower.

returns phi coordinate of the centre of the relevent trigger tower.

Definition at line 151 of file KeyUtilities.cxx.

                                  {
  return m_centralPhi;
}

phiQuadrant()

unsigned int LVL1::ClusterProcessorModuleKey::phiQuadrant ( const double phi ) const

private

returns the quadrant number associated with the phi coordinate, 0 - 90 = 0 90 - 180 = 1 180-270 = 2 270-360 = 3

Definition at line 119 of file ClusterProcessorModuleKey.cxx.

                                                                              {
  double temp = phi/TrigT1CaloDefs::cpmPhiSize; // Good for TT coord, not RoI
  unsigned int quad =  static_cast<unsigned int>(temp);
  quad=(quad > 3 ? 0 : quad);
 
  return static_cast<unsigned int>(quad);
}

round()

int LVL1::KeyUtilities::round ( double a ) const

protectedinherited

rounds number to nearest whole number

Definition at line 175 of file KeyUtilities.cxx.

                                          {
  return static_cast<int>(a<0.0?ceil(a-0.5):a>0.0?floor(a+0.5):0.0);
}

setBins()

void LVL1::ClusterProcessorModuleKey::setBins ( const ICoordinate & iCoord, unsigned int & phiBin, int & etaBin )

private

sets the eta and phi bins

Definition at line 60 of file ClusterProcessorModuleKey.cxx.

                                                                                                       {
  unsigned int iPhiSize=16 ; // 64 bins in total, so 16/module
  phiBin=( iCoord.phi() )/(iPhiSize);
  int iEtaSize=4;// CPMs are 0.4 in eta, so ietaSize=4
  etaBin=sharpRound2(iCoord.eta(),iEtaSize);
 
  return;
}

setupThisKeyValues()

void LVL1::KeyUtilities::setupThisKeyValues ( )

protectedinherited

Definition at line 165 of file KeyUtilities.cxx.

                                         {
  ICoordinate iCoord = convertCoordsToIntegers(m_phi, m_eta);
  BinAndCoord bandc  = calculateTriggerBin(iCoord);
  m_phiBin=bandc.phiBin();
  m_etaBin=bandc.etaBin();
  m_centralPhi=bandc.coords().phi();
  m_centralEta=bandc.coords().eta();
}

sharpRound()

int LVL1::KeyUtilities::sharpRound ( double a ) const

protectedinherited

rounds number as follows (-1.0 to 0.0) -> -1, (0.0 to 1.0) -> 0, (1.0 to 2.0)->1 etc.

Definition at line 180 of file KeyUtilities.cxx.

                                               {
  return static_cast<int>(a<0.0?(a-1.0):a>0.0?(a):0.0);
}

sharpRound2()

int LVL1::KeyUtilities::sharpRound2 ( int a, int b ) const

protectedinherited

divides a/b and returns a number as follows (where +b means +ve b): if 0

Definition at line 184 of file KeyUtilities.cxx.

                                                    {
  int temp=(abs(a)-1)/b+1;
  return temp*sign(a);
}

sign() [1/2]

int LVL1::KeyUtilities::sign ( double temp ) const

protectedvirtualinherited

returns -1 if temp is -ve and +1 if it is +ve.

returns 0 if temp =0

Definition at line 161 of file KeyUtilities.cxx.

                                           {
  return ((temp >= 0.0) ? 1 : -1);
}

sign() [2/2]

int LVL1::KeyUtilities::sign ( int temp ) const

protectedvirtualinherited

returns -1 if temp is -ve and +1 if it is +ve.

returns 0 if temp =0

Definition at line 156 of file KeyUtilities.cxx.

                                        {
  return ((temp >= 0) ? 1 : -1);
}

Member Data Documentation

m_centralEta

double LVL1::KeyUtilities::m_centralEta

protectedinherited

this is the coordinate of the centre of the relevant trigger tower.

Definition at line 112 of file KeyUtilities.h.

m_centralPhi

double LVL1::KeyUtilities::m_centralPhi

protectedinherited

this is the coordinate of the centre of the relevant trigger tower.

Definition at line 109 of file KeyUtilities.h.

m_debug

bool LVL1::KeyUtilities::m_debug

protectedinherited

turns DEBUG code on and off

Definition at line 114 of file KeyUtilities.h.

m_debugModuleKey

bool LVL1::ClusterProcessorModuleKey::m_debugModuleKey

private

set to true to turn debugging info on

Definition at line 74 of file ClusterProcessorModuleKey.h.

m_eta

double LVL1::KeyUtilities::m_eta

protectedinherited

eta coordinate of key

Definition at line 100 of file KeyUtilities.h.

m_etaBin

int LVL1::KeyUtilities::m_etaBin

protectedinherited

eta bin

Definition at line 106 of file KeyUtilities.h.

m_ieta

int LVL1::KeyUtilities::m_ieta

protectedinherited

integer eta coord

Definition at line 98 of file KeyUtilities.h.

m_iphi

int LVL1::KeyUtilities::m_iphi

protectedinherited

integer phi coord

Definition at line 96 of file KeyUtilities.h.

m_phi

double LVL1::KeyUtilities::m_phi

protectedinherited

phi coordinate of key

Definition at line 102 of file KeyUtilities.h.

m_phiBin

int LVL1::KeyUtilities::m_phiBin

protectedinherited

phi bin

Definition at line 104 of file KeyUtilities.h.

---

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

• ClusterProcessorModuleKey.h
• ClusterProcessorModuleKey.cxx