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

#include <TriggerTowerKey.h>

Inheritance diagram for LVL1::TriggerTowerKey:

Collaboration diagram for LVL1::TriggerTowerKey:

Public Types
enum	TriggerTowerRegion { TTBarrel =0, TTEndCap1 =1, TTEndCap2 =2, TTFCAL =3, TTRegionError =999 }

Public Member Functions
	TriggerTowerKey (double m_phi, double m_eta)
	takes phi and eta and constructs a TriggerTowerKey object which can return the key for this coord *todo This method must be phased out - it will not work when this class simulates the hardware completely More...

	TriggerTowerKey ()
	constructs a TriggerTowerKey object More...

virtual	~TriggerTowerKey ()

virtual unsigned int	ttKey (const TriggerTower &tower)
	returns the key of the passed tower More...

unsigned int	ttKey (const CaloCell &calocell)
	returns the key of the passed calo cell More...

unsigned int	ttKey (const double phi, const double eta)
	returns trigger tower key of passed coords More...

TriggerTowerRegion	region (const Coordinate &coord) const
	returns the TT region that the coordinate corresponds to. More...

double	dEta (const Coordinate &coord) const
	returns eta width of trigger tower at coordinate coord More...

double	dPhi (const Coordinate &coord) const
	returns phi height of trigger tower at coordinate coord More...

virtual double	eta () const
	returns the centre of the TT at eta_coord: More...

virtual double	phi () const
	returns phi coordinate of centre of relevant trigger tower. More...

unsigned int	key (double phi, double eta)
	calculates a map key from passed phi, eta coordinates More...

unsigned int	key (const Coordinate &coord)
	returns the key of the passed Coordinate More...

Coordinate	coord () const
	return central coords of current key value. More...

Protected Member Functions
ICoordinate *	convertCoordsToIntegers (double phi, double eta)
	converts the coordinates and corrects for overflows etc. More...

virtual int	sign (int temp) const
	returns -1 if temp is -ve and +1 if it is +ve. More...

virtual int	sign (double temp) const
	returns -1 if temp is -ve and +1 if it is +ve. More...

int	round (double a) const
	rounds number to nearest whole number More...

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. More...

int	sharpRound2 (int a, int b) const
	divides a/b and returns a number as follows (where +b means +ve b): if 0<a<+b, then n=1, if +b<a<+2b, n=2, if -b<a<0, n=-1, if -2b<a<-b, n=-2 More...

void	setupThisKeyValues ()

Protected Attributes
int	m_iphi
	integer phi coord More...

int	m_ieta
	integer eta coord More...

double	m_eta
	eta coordinate of key More...

double	m_phi
	phi coordinate of key More...

int	m_phiBin
	phi bin More...

int	m_etaBin
	eta bin More...

double	m_centralPhi
	this is the coordinate of the centre of the relevant trigger tower. More...

double	m_centralEta
	this is the coordinate of the centre of the relevant trigger tower. More...

bool	m_debug
	turns DEBUG code on and off More...

Private Member Functions
BinAndCoord *	calculateTriggerBin (ICoordinate *iCoord)
	converts integer phi, eta coordinates to phi, eta trigger bins. More...

Detailed Description

The TriggerTowerKey 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 56 of file TriggerTowerKey.h.

Member Enumeration Documentation

◆ TriggerTowerRegion

enum LVL1::TriggerTowerKey::TriggerTowerRegion

Enumerator
TTBarrel
TTEndCap1
TTEndCap2
TTFCAL
TTRegionError

Definition at line 64 of file TriggerTowerKey.h.

86 : // Private methods

Constructor & Destructor Documentation

◆ TriggerTowerKey() [1/2]

LVL1::TriggerTowerKey::TriggerTowerKey	(	double	m_phi,
		double	m_eta
	)

takes phi and eta and constructs a TriggerTowerKey object which can return the key for this coord *todo This method must be phased out - it will not work when this class simulates the hardware completely

Definition at line 36 of file TriggerTowerKey.cxx.

42 {

43 m_phi=0.0;

◆ TriggerTowerKey() [2/2]

LVL1::TriggerTowerKey::TriggerTowerKey ( )

constructs a TriggerTowerKey object

Definition at line 47 of file TriggerTowerKey.cxx.

                                  {
 }
  

◆ ~TriggerTowerKey()

LVL1::TriggerTowerKey::~TriggerTowerKey ( )

virtual

Definition at line 56 of file TriggerTowerKey.cxx.

56 {

57

Member Function Documentation

◆ calculateTriggerBin()

BinAndCoord * LVL1::TriggerTowerKey::calculateTriggerBin ( ICoordinate * iCoord )

privatevirtual

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

Implements LVL1::KeyUtilities.

Definition at line 61 of file TriggerTowerKey.cxx.

               {
     std::cout << "TriggerTowerKey: start calcTrigBin"<<std::endl;
     std::cout << "phi, eta   : ("<<iCoord->phi()<<", "<<iCoord->eta()<<")"<<std::endl;
     std::cout << "iphi, ieta : ("<<iphi<<", "<<ieta<<")"<<std::endl;
     std::cout << "abs_ieta : ("<<abs_ieta<<" and sign :  "<<sign<<std::endl;
   }
  
   if ( abs_ieta<=25 ){
     /* in 0.1x0.1 barrel region
     This extends from -2.4 to +2.4 in eta, and has divisions of 0.1 in eta.
     ieta extends from -24 to +24, and the centres of ieta=+/-1,2,3 are at
     centralEta=+/-0.05, 0.15, 0.25 etc.*/
     phiBin=iphi;
     etaBin=ieta;
     centralEta=( (static_cast<double>(abs_ieta)*0.1)-0.05)*sign;
     centralPhi=(iphi*phiBinWidth)+(phiBinWidth/2);
     if (m_debug) std::cout << "central : ("<<centralPhi<<", "<<centralEta<<")"<<std::endl;
     //    std::cout<<etaBin<<std::endl;
   }else{
     if (abs_ieta>25 && abs_ieta<=32){
       //std::cout <<"0.2x0.2 :";
       /* in 0.2 x 0.2 region.
       Here we have three 0.2 cells from eta=+-2.5-3.2 (etaBin=26,27,28),
       then a final 0.1 cell from +-3.1 to 3.2 (etaBin=-32).*/
       etaBin=( ( (abs_ieta-24) /2 )+25)*sign;
       // this ^ perhaps seems slightly counter-intuitive ...
       // The point is we have cells like |'|''|''|''|
       // (where the edge of the first cell is ieta=-32) - i.e. the first
       // cell is 0.1x0.2 instead of 0.2x0.2.
       // so if we did (ieta-33)/2+29 as you might expect
       // our algorithm will (wrongly) behave as if the cells are
       // |''|''|''|'| instead.
       phiBin=iphi/2;
       centralPhi=(static_cast<double>(phiBin)*2.0+1.0)*phiBinWidth;
       // it's a bit harder for the centralEta case though so:
       if (abs_ieta<32){
         centralEta=((static_cast<double>(static_cast<int>((abs_ieta-26)/2))*0.2)+2.6)*sign;
       }else{
         //in weird 0.1x0.2 region
         centralEta=3.15*sign;
       }
     }else{
       // in FCAL
       // there's a complication here, namely that the eta bins aren't multiples
       // of 0.1.We therefore must work in doubles ...
       
       double fcalEtaSize=0.425; //=(4.9-3.2)/4
  
       double abs_eta = iCoord->dEta()*sign;
       double temp=static_cast<double>(abs_eta-3.2);
       temp = (temp/ fcalEtaSize );
       int iTemp=static_cast<int>(temp);
       etaBin=(iTemp+32)*sign;
      
       phiBin=iphi/4;
      
       centralEta=((static_cast<double>(iTemp)*fcalEtaSize)+3.2+(fcalEtaSize/2))*sign;
 //std::cout<<"eb: "<<etaBin<<" iTemp"<<iTemp<<std::endl;
       centralPhi=(static_cast<double>(phiBin)*phiBinWidth*4)+(phiBinWidth*2);
     }// end else: in .4x.4
   }// end of not in 0.1x0.1
   if (m_debug) std::cout << "central     : /t("<<centralPhi<<", "<<centralEta<<")"<<std::endl;
   Coordinate* centralCoords = new Coordinate(centralPhi, centralEta);
   BinAndCoord* bandc = new BinAndCoord(phiBin,etaBin,centralCoords);
   return bandc;
 }
  
 #ifndef  TRIGGERSPACE
 // these methods are only applicable if running in Athena
  

◆ 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 110 of file KeyUtilities.cxx.

                                 : (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;
     ICoordinate* iCoord=new ICoordinate(iphi, ieta, eta);
     return iCoord;
 }
  
  
 double LVL1::KeyUtilities::eta() const{

◆ coord()

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

inherited

return central coords of current key value.

Definition at line 199 of file KeyUtilities.cxx.

                                             {
   return Coordinate(m_centralPhi,m_centralEta);
 }

◆ dEta()

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

virtual

returns eta width of trigger tower at coordinate coord

Implements LVL1::KeyUtilities.

Definition at line 171 of file TriggerTowerKey.cxx.

                                                              {
   TriggerTowerRegion reg = region(coord);
   if (reg==TTBarrel) return 0.1;
   if (reg==TTEndCap1) return 0.2;
   if (reg==TTEndCap2) return 0.1;
   if (reg==TTFCAL) return 0.425;
   return 0;
 }

◆ dPhi()

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

virtual

returns phi height of trigger tower at coordinate coord

Implements LVL1::KeyUtilities.

Definition at line 181 of file TriggerTowerKey.cxx.

                                                              {
   TriggerTowerRegion reg = region(coord);
   if (reg==TTBarrel) return M_PI/32;//0.0981748;//PI/32
   if (reg==TTEndCap1) return M_PI/16;//0.19635;//PI/16
   if (reg==TTEndCap2) return M_PI/16;//0.19635;
   if (reg==TTFCAL) return M_PI/8;//0.392699;//PI/8
   return TTRegionError;
 }

◆ 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 150 of file KeyUtilities.cxx.

◆ 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 101 of file KeyUtilities.cxx.

◆ 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 82 of file KeyUtilities.cxx.

                               : key: got bandc "<<std::endl;
   m_phiBin=bandc->phiBin();
   m_etaBin=bandc->etaBin();
   m_centralPhi=bandc->coords()->phi();
   m_centralEta=bandc->coords()->eta();
   delete bandc;
   delete iCoord;
   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);
 }
  
 unsigned int KeyUtilities::key(const Coordinate& coord) {
   return key(coord.phi(), coord.eta());
 }

◆ 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 159 of file KeyUtilities.cxx.

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

◆ region()

LVL1::TriggerTowerKey::TriggerTowerRegion LVL1::TriggerTowerKey::region ( const Coordinate & coord ) const

returns the TT region that the coordinate corresponds to.

Definition at line 158 of file TriggerTowerKey.cxx.

                                                             {
   double absEta=fabs(coord.eta());
   if (absEta<2.5) return TTBarrel;
   if ((absEta>=2.5)&&(absEta<3.1)) return TTEndCap1;
   if ((absEta>=3.1)&&(absEta<3.2)) return TTEndCap2;
   if ((absEta>=3.2)&&(absEta<=4.9)) return TTFCAL;
   std::cerr <<"TriggerTowerKey::region UNKNOWN REGION"
             << "Coordinate is ("<<coord.phi()<<", "<<coord.eta()<<")"
             <<std::endl;
   return TTRegionError;
 }

◆ round()

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

protectedinherited

rounds number to nearest whole number

Definition at line 185 of file KeyUtilities.cxx.

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

◆ setupThisKeyValues()

void LVL1::KeyUtilities::setupThisKeyValues ( )

protectedinherited

Definition at line 173 of file KeyUtilities.cxx.

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

◆ 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 190 of file KeyUtilities.cxx.

◆ 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<a<+b, then n=1, if +b<a<+2b, n=2, if -b<a<0, n=-1, if -2b<a<-b, n=-2

Definition at line 194 of file KeyUtilities.cxx.

◆ 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 169 of file KeyUtilities.cxx.

◆ 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 164 of file KeyUtilities.cxx.

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

◆ ttKey() [1/3]

unsigned int LVL1::TriggerTowerKey::ttKey ( const CaloCell & calocell )

returns the key of the passed calo cell

Definition at line 148 of file TriggerTowerKey.cxx.

149 {

150 if (m_debug) std::cout << "TTK: returning key for coords ("<<phi<<","<<eta<<")"<<std::endl;

◆ ttKey() [2/3]

unsigned int LVL1::TriggerTowerKey::ttKey	(	const double	phi,
		const double	eta
	)

returns trigger tower key of passed coords

Definition at line 154 of file TriggerTowerKey.cxx.

◆ ttKey() [3/3]

unsigned int LVL1::TriggerTowerKey::ttKey ( const TriggerTower & tower )

virtual

returns the key of the passed tower

Definition at line 143 of file TriggerTowerKey.cxx.

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

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 122 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 119 of file KeyUtilities.h.

◆ m_debug

bool LVL1::KeyUtilities::m_debug

protectedinherited

turns DEBUG code on and off

Definition at line 124 of file KeyUtilities.h.

◆ m_eta

double LVL1::KeyUtilities::m_eta

protectedinherited

eta coordinate of key

Definition at line 110 of file KeyUtilities.h.

◆ m_etaBin

int LVL1::KeyUtilities::m_etaBin

protectedinherited

eta bin

Definition at line 116 of file KeyUtilities.h.

◆ m_ieta

int LVL1::KeyUtilities::m_ieta

protectedinherited

integer eta coord

Definition at line 108 of file KeyUtilities.h.

◆ m_iphi

int LVL1::KeyUtilities::m_iphi

protectedinherited

integer phi coord

Definition at line 106 of file KeyUtilities.h.

◆ m_phi

double LVL1::KeyUtilities::m_phi

protectedinherited

phi coordinate of key

Definition at line 112 of file KeyUtilities.h.

◆ m_phiBin

int LVL1::KeyUtilities::m_phiBin

protectedinherited

phi bin

Definition at line 114 of file KeyUtilities.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ TriggerTowerRegion

Constructor & Destructor Documentation

◆ TriggerTowerKey() [1/2]

◆ TriggerTowerKey() [2/2]

◆ ~TriggerTowerKey()

Member Function Documentation

◆ calculateTriggerBin()

◆ convertCoordsToIntegers()

◆ coord()

◆ dEta()

◆ dPhi()

◆ eta()

◆ key() [1/2]

◆ key() [2/2]

◆ phi()

◆ region()

◆ round()

◆ setupThisKeyValues()

◆ sharpRound()

◆ sharpRound2()

◆ sign() [1/2]

◆ sign() [2/2]

◆ ttKey() [1/3]

◆ ttKey() [2/3]

◆ ttKey() [3/3]

Member Data Documentation

◆ m_centralEta

◆ m_centralPhi

◆ m_debug

◆ m_eta

◆ m_etaBin

◆ m_ieta

◆ m_iphi

◆ m_phi

◆ m_phiBin