LVL1::JetElementKeyBase Class Reference

The JetElementKeyBase object provides the key for each JetElement or JetInput depending on its eta,phi coords. More...

#include <JetElementKeyBase.h>

Inheritance diagram for LVL1::JetElementKeyBase:

Collaboration diagram for LVL1::JetElementKeyBase:

Public Types
enum	JERegion {   Barrel =0 , EndBarrel =1 , EndCap1 =2 , EndCap2 =3 ,   EndCap3 =4 , FCAL =5 }

Public Member Functions
virtual	~JetElementKeyBase ()
virtual unsigned int	jeKey (const xAOD::TriggerTower &tower)
	returns key of passed tower
virtual unsigned int	jeKey (const xAOD::JetElement &jetElement)
	returns key of passed jetelement
virtual unsigned int	jeKey (const double phi, const double eta)
	returns the key of the passed coords
virtual unsigned int	jeKey (const Coordinate coord)
	returns the key of the passed Coordinate
unsigned int	leftEtaKey (const double phi, const double eta)
	returns key of JE in +ve eta dir.
unsigned int	rightEtaKey (const double phi, const double eta)
	returns key of JE in -ve eta dir.
unsigned int	upPhiKey (const double phi, const double eta)
	returns key of next JE in +ve phi dir.
unsigned int	downPhiKey (const double phi, const double eta)
	returns key of next JE in -ve phi dir.
Coordinate	getCentre (const double phi, const double eta)
	returns the central coordinate of the JE which contains the passed coord
Coordinate	getCentre (const Coordinate coord)
	returns the central coordinate of the JE which contains the passed coord
Coordinate	rightEta (const double phi, const double eta)
	Functions for finding coordinates of neighbouring JEs.
Coordinate	leftEta (const double phi, const double eta)
	returns key of JE in -ve eta dir.
Coordinate	downPhi (const double phi, const double eta)
	returns coord of next JE in -ve phi dir.
Coordinate	upPhi (const double phi, const double eta)
	returns coord of next JE in +ve phi dir.
Coordinate	rightEta (const Coordinate coord)
	returns eta coord of JE in +ve eta dir.
Coordinate	leftEta (const Coordinate coord)
	returns key of JE in -ve eta dir.
Coordinate	downPhi (const Coordinate coord)
	returns coord of next JE in -ve phi dir.
Coordinate	upPhi (const Coordinate coord)
	returns coord of next JE in +ve phi dir.
Coordinate	upperLeft (const double phi, const double eta)
Coordinate	upperRight (const double phi, const double eta)
Coordinate	lowerLeft (const double phi, const double eta)
Coordinate	lowerRight (const double phi, const double eta)
Coordinate	upperLeft (const Coordinate coord)
Coordinate	upperRight (const Coordinate coord)
Coordinate	lowerLeft (const Coordinate coord)
Coordinate	lowerRight (const Coordinate coord)
double	dPhi (const double phi, const double eta) const
	return height of JE
double	dPhi () const
	return height of JE
double	dPhi (const Coordinate &coord) const
	return height of JE
double	dEta (const double phi, const double eta) const
	return width of JE
double	dEta () const
	return width of JE
double	dEta (const Coordinate &coord) const
	return width of JE
unsigned int	region (double eta) const
	returns region number at eta, where region is:
JERegion	jeRegion (const Coordinate &coord) const
bool	isFCAL (double eta) const
	returns TRUE if this coordinate is in the FCAL
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
	JetElementKeyBase (double phi, double eta)
	takes phi and eta and constructs a JetElementKeyBase object which can return the key for this coord
	JetElementKeyBase (const Coordinate coord)
	constructs a JetElementKeyBase object
	JetElementKeyBase ()
	constructs a JetElementKeyBase object
void	setupRegionData ()
	get region data from TrigT1CaloDefs and put in more useful format - vectors
void	setupJetRegionData ()
	Does same as setupRegionData, except in FCAL where uses phi granularity appropriate for the jet trigger.
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
BinAndCoord *	calculateTriggerBin (ICoordinate *iCoord)
	converts integer phi, eta coordinates to phi, eta trigger bins.
void	analCoordChecking (const Coordinate &coord)
	this is a bit over the top, but it looks to see if the calculated coordinate matches a coordinate centre that JetElementKeyBase would return.

Private Attributes
bool	m_debugKeyBase
	set to true to turn debugging info on
std::vector< double >	m_regionEtaCentre
	holds central coords of JEs in regions: Region Eta 0 <2.2 1 2.2-2.4 2 2.4-2.7 3 2.7-2.9 4 2.9-3.2 5 3.2-4.9
std::vector< double >	m_regionWidth
	holds width of JEs in regions:
std::vector< double >	m_regionHeight
	holds height of JEs in regions:

Detailed Description

The JetElementKeyBase object provides the key for each JetElement or JetInput 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.

Definition at line 48 of file JetElementKeyBase.h.

Member Enumeration Documentation

JERegion

enum LVL1::JetElementKeyBase::JERegion

Enumerator
Barrel
EndBarrel
EndCap1
EndCap2
EndCap3
FCAL

Definition at line 51 of file JetElementKeyBase.h.

                {
    Barrel=0,
    EndBarrel=1,
    EndCap1=2,
    EndCap2=3,
    EndCap3=4,
    FCAL=5
  };

Constructor & Destructor Documentation

~JetElementKeyBase()

LVL1::JetElementKeyBase::~JetElementKeyBase ( )

virtual

Definition at line 63 of file JetElementKeyBase.cxx.

                                     {
}

JetElementKeyBase() [1/3]

LVL1::JetElementKeyBase::JetElementKeyBase ( double phi, double eta )

protected

takes phi and eta and constructs a JetElementKeyBase object which can return the key for this coord

Definition at line 34 of file JetElementKeyBase.cxx.

                                                           :
    KeyUtilities(phi,eta),
    m_debugKeyBase(false)
    {
    if (m_debugKeyBase) { std::cout << "JetElementKeyBase: m_debugKeyBase output turned on...."<<std::endl; }
    //setupRegionData();
    //setupThisKeyValues();
}

JetElementKeyBase() [2/3]

LVL1::JetElementKeyBase::JetElementKeyBase ( const Coordinate coord )

protected

constructs a JetElementKeyBase object

Definition at line 54 of file JetElementKeyBase.cxx.

                                                           :
    KeyUtilities(coord.phi(),coord.eta()),
    m_debugKeyBase(false)
    {
    if (m_debugKeyBase) { std::cout << "JetElementKeyBase: m_debugKeyBase output turned on...."<<std::endl; }
    //setupRegionData();
    //setupThisKeyValues();
}

JetElementKeyBase() [3/3]

LVL1::JetElementKeyBase::JetElementKeyBase ( )

protected

constructs a JetElementKeyBase object

Definition at line 44 of file JetElementKeyBase.cxx.

                                     :
    KeyUtilities(),
    m_debugKeyBase(false)
    {
    if (m_debugKeyBase) { std::cout << "JetElementKeyBase: m_debugKeyBase output turned on...."<<std::endl; }
    //setupRegionData();
    //setupThisKeyValues();
}

Member Function Documentation

analCoordChecking()

void LVL1::JetElementKeyBase::analCoordChecking ( const Coordinate & coord )

private

this is a bit over the top, but it looks to see if the calculated coordinate matches a coordinate centre that JetElementKeyBase would return.

It doesn't return any errors or anything as it's purely being used in tests external to Athena

Definition at line 502 of file JetElementKeyBase.cxx.

                                                                    {
  Coordinate centre( getCentre( coord.phi(), coord.eta() ) );
  double allowedSpread=0.0002;// I don't mind a bit of a rounding error....
  if ( (coord.phi()<(centre.phi()-allowedSpread))||(coord.phi()>(centre.phi()+allowedSpread) ) )
    std::cout << "PHI ERROR: "<< coord.phi() <<"!="<<centre.phi()<<std::endl;
  if ( (coord.eta()<(centre.eta()-allowedSpread))||(coord.eta()>(centre.eta()+allowedSpread) ) )
    std::cout << "ETA ERROR: "<< coord.eta() <<"!="<<centre.eta()<<std::endl;
  return;
}

calculateTriggerBin()

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

privatevirtual

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

Returns coordinates of centre of JEs

Implements LVL1::KeyUtilities.

Definition at line 70 of file JetElementKeyBase.cxx.

                                                                      {
 
  int iphi=iCoord->phi();
  int ieta=iCoord->eta();
  double centralPhi=0.0;
  double centralEta=0.0;
  int phiBin=0; int etaBin=0;
  int abs_ieta=abs(ieta);
  int sign=ieta/abs_ieta;
 
  if (m_debugKeyBase){
    std::cout << "JetElementKeyBase: start calculateTriggerBin"<<std::endl;
    //std::cout << "phi, eta   : ("<<m_phi<<", "<<m_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==TrigT1CaloDefs::RegionERROREtaBin){
  
    // okay this JE has been deliberately labelled as a wrong 'un.
    // so basically ignore it.
    phiBin=0;
    centralPhi=0.0;
    etaBin=20*sign;
    centralEta=TrigT1CaloDefs::RegionERROREtaCentre;
    
  }else{
  
    int region;
    if ( abs_ieta<23 ) {
      region = 0;
      etaBin=(ieta+1)/2; 
    }
    else if ( abs_ieta<25 ) { // can't see why this region != region 0??
      region = 1;
      etaBin=(ieta+1)/2; 
    }
    else if ( abs_ieta<28 ) { // remaining regions only have 1 eta bin, varying sizes
      region = 2;
      etaBin=13*sign;
    }
    else if ( abs_ieta<30 ) {
      region = 3;
      etaBin=14*sign;
    }
    else if ( abs_ieta<=32 ) {
      region = 4;
      etaBin=15*sign;
    }
    else {
      region = 5;
      etaBin=16*sign;
    }
    
    // Get centre of JE in eta and phi
    if (region == 0) {
      centralEta=(static_cast<double>(etaBin)*0.2)-0.1; 
    }
    else {
      centralEta=m_regionEtaCentre[region]*sign;
    }
    
    // Phi bin size depends on region - this should take care of that
    int nTTperJE = static_cast<int>( 0.5 + (m_regionHeight[region]/(M_PI/32)) );
    phiBin=iphi/nTTperJE;
    centralPhi=(static_cast<double>(phiBin)+0.5)*m_regionHeight[region];
    
  }
  
  if (m_debugKeyBase) std::cout << "central : ("<<centralPhi<<", "<<centralEta<<")"
                      << " bin : ("<<phiBin<<","<<etaBin<<")"<<std::endl;
  Coordinate* centralCoords = new Coordinate(centralPhi, centralEta);
  BinAndCoord* bandc = new BinAndCoord(phiBin,etaBin,centralCoords);
  return bandc;
}

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 105 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;
    ICoordinate* iCoord=new ICoordinate(iphi, ieta, eta);
    return iCoord;
}

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() [1/3]

double LVL1::JetElementKeyBase::dEta

(

)

const

return width of JE

return width of this JE

Definition at line 381 of file JetElementKeyBase.cxx.

                                    {
  return dEta(m_phi,m_eta);
}

dEta() [2/3]

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

virtual

return width of JE

Implements LVL1::KeyUtilities.

Definition at line 386 of file JetElementKeyBase.cxx.

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

dEta() [3/3]

double LVL1::JetElementKeyBase::dEta	(	const double	phi,
		const double	eta ) const

return width of JE

return width of JE at (phi,eta)

Definition at line 373 of file JetElementKeyBase.cxx.

                                                                    {
  unsigned int reg=region(eta);
  if (reg==TrigT1CaloDefs::RegionError) return 0.0;
 
  return m_regionWidth[reg];
}

downPhi() [1/2]

Coordinate LVL1::JetElementKeyBase::downPhi

(

const Coordinate

coord

)

returns coord of next JE in -ve phi dir.

Definition at line 299 of file JetElementKeyBase.cxx.

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

downPhi() [2/2]

Coordinate LVL1::JetElementKeyBase::downPhi	(	const double	phi,
		const double	eta )

returns coord of next JE in -ve phi dir.

Definition at line 283 of file JetElementKeyBase.cxx.

                                                                       {
  Coordinate centre=getCentre(phi,eta);
  double temp_phi=centre.phi();
  unsigned int reg=region(centre.eta());
  if (reg==TrigT1CaloDefs::RegionError) {
//    std::cout << "Out of bounds error in JetElementKeyBase::downPhi"<<std::endl;
    temp_phi=0.0;
  }else{
    temp_phi-= m_regionHeight[reg];
  }
  centre.setCoords(temp_phi,centre.eta());
  analCoordChecking(centre);  
  return centre;
}

downPhiKey()

unsigned int LVL1::JetElementKeyBase::downPhiKey	(	const double	phi,
		const double	eta )

returns key of next JE in -ve phi dir.

Definition at line 305 of file JetElementKeyBase.cxx.

                                                                            {
    Coordinate coord=downPhi(phi,eta);
    return jeKey(coord.phi(),coord.eta());
}

dPhi() [1/3]

double LVL1::JetElementKeyBase::dPhi

(

)

const

return height of JE

return height of this JE

Definition at line 363 of file JetElementKeyBase.cxx.

                                    {
    return dPhi(m_phi,m_eta);
}

dPhi() [2/3]

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

virtual

return height of JE

Implements LVL1::KeyUtilities.

Definition at line 368 of file JetElementKeyBase.cxx.

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

dPhi() [3/3]

double LVL1::JetElementKeyBase::dPhi	(	const double	phi,
		const double	eta ) const

return height of JE

return height of JE at (phi,eta)

Definition at line 355 of file JetElementKeyBase.cxx.

                                                                     {
    unsigned int reg=region(eta);
 
    if (reg==TrigT1CaloDefs::RegionError) return 0.0;
    return m_regionHeight[reg];
}

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

                                  {
  return m_centralEta;
}

getCentre() [1/2]

Coordinate LVL1::JetElementKeyBase::getCentre

(

const Coordinate

coord

)

returns the central coordinate of the JE which contains the passed coord

Definition at line 491 of file JetElementKeyBase.cxx.

                                                             {
  Coordinate centre = getCentre( coord.phi(), coord.eta() );
  return centre;
}

getCentre() [2/2]

Coordinate LVL1::JetElementKeyBase::getCentre	(	const double	phi,
		const double	eta )

returns the central coordinate of the JE which contains the passed coord

Definition at line 482 of file JetElementKeyBase.cxx.

                                                                         {
  ICoordinate* iCoord = convertCoordsToIntegers(phi, eta);
  BinAndCoord* bandc  = calculateTriggerBin(iCoord);
  Coordinate yuck=*(bandc->coords() ); // this is horrible, but easier than changing other stuff
  delete iCoord; delete bandc ;
  return yuck;
}

isFCAL()

bool LVL1::JetElementKeyBase::isFCAL

(

double

eta

)

const

returns TRUE if this coordinate is in the FCAL

Definition at line 423 of file JetElementKeyBase.cxx.

                                              {
  return (region(eta)==5);
}

jeKey() [1/4]

unsigned int LVL1::JetElementKeyBase::jeKey ( const Coordinate coord )

virtual

returns the key of the passed Coordinate

returns trigger tower key of passed Coordinate

Definition at line 171 of file JetElementKeyBase.cxx.

                                                           {
  if (m_debugKeyBase) std::cout << "JetElementKeyBase: returning key for Coord: ("<<coord.phi()<<","<<coord.eta()<<")"<<std::endl;
  return key(coord.phi(), coord.eta());
}

jeKey() [2/4]

unsigned int LVL1::JetElementKeyBase::jeKey ( const double phi, const double eta )

virtual

returns the key of the passed coords

returns trigger tower key of passed coords

Definition at line 165 of file JetElementKeyBase.cxx.

                                                                       {
  if (m_debugKeyBase) std::cout << "JetElementKeyBase: returning key for coords ("<<phi<<","<<eta<<")"<<std::endl;
  return key(phi, eta);
}

jeKey() [3/4]

unsigned int LVL1::JetElementKeyBase::jeKey ( const xAOD::JetElement & jetElement )

virtual

returns key of passed jetelement

returns the key of the passed tower

Definition at line 156 of file JetElementKeyBase.cxx.

                                                                      {
  if (m_debugKeyBase) std::cout << "JetElementKeyBase: returning key for coords ("<<jetElement.phi()<<","<<jetElement.eta()<<")"<<std::endl;
  return key(jetElement.phi(), jetElement.eta());
}

jeKey() [4/4]

unsigned int LVL1::JetElementKeyBase::jeKey ( const xAOD::TriggerTower & tower )

virtual

returns key of passed tower

Definition at line 150 of file JetElementKeyBase.cxx.

                                                                    {
  if (m_debugKeyBase) std::cout << "JetElementKeyBase: returning key for coords ("<<tower.phi()<<","<<tower.eta()<<")"<<std::endl;
  return key(tower.phi(), tower.eta());
}

jeRegion()

JetElementKeyBase::JERegion LVL1::JetElementKeyBase::jeRegion

(

const Coordinate &

coord

)

const

Definition at line 408 of file JetElementKeyBase.cxx.

                                                                                  {
  // really unhappy about this. It'll go horribly wrong if anyone alters the enum.
  // Ideally I'd like region(eta) to return an enum, and have a
  // separate numRegion(eta) which returns ints.
  // That will require a lot of re-writing though....
  unsigned int reg=region(coord.eta());
  if (reg==5) return FCAL;
  if (reg==4) return EndCap3;
  if (reg==3) return EndCap2;
  if (reg==2) return EndCap1;
  if (reg==1) return EndBarrel;
  return Barrel;
  
}

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 96 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();
  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);
}

leftEta() [1/2]

Coordinate LVL1::JetElementKeyBase::leftEta

(

const Coordinate

coord

)

returns key of JE in -ve eta dir.

Definition at line 206 of file JetElementKeyBase.cxx.

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

leftEta() [2/2]

Coordinate LVL1::JetElementKeyBase::leftEta	(	const double	phi,
		const double	eta )

returns key of JE in -ve eta dir.

Definition at line 179 of file JetElementKeyBase.cxx.

                                                                        {
  Coordinate centre=getCentre(phi,eta);
  double temp_eta=centre.eta();
 
  // look in method for definition of regions
  unsigned int reg=region(temp_eta);
  // suppress leftEta in -ve region 5
  unsigned int maxRegion=5+((temp_eta>0.0)? 0:-1);
  if ( reg==0 ){
    temp_eta-=m_regionWidth[0];
  }else{
    if ((reg==TrigT1CaloDefs::RegionError)||(reg>maxRegion)) {
      temp_eta=TrigT1CaloDefs::RegionERROREtaCentre;
   }else{
      int sign = ((temp_eta>0.0)? 1:-1);
      temp_eta= sign*m_regionEtaCentre[reg-sign];    }
  }
  // there's a complication here ... moving left can move us
  // into a JE with a different phi height, and so phi can change.
  // However we want to keep eta at 8.0, so reset eta afterwards.
  Coordinate coord( getCentre(phi,temp_eta) );
  coord.setCoords(coord.phi(), temp_eta) ;
//  analCoordChecking(coord);
    return coord;
}

leftEtaKey()

unsigned int LVL1::JetElementKeyBase::leftEtaKey	(	const double	phi,
		const double	eta )

returns key of JE in +ve eta dir.

returns key of JE in -ve eta dir.

Definition at line 211 of file JetElementKeyBase.cxx.

                                                                            {
  Coordinate coord=leftEta(phi,eta);
  return jeKey(coord.phi(),coord.eta());
}

lowerLeft() [1/2]

Coordinate LVL1::JetElementKeyBase::lowerLeft

(

const Coordinate

coord

)

Definition at line 344 of file JetElementKeyBase.cxx.

                                                             {
    Coordinate newCoord=lowerLeft(coord.phi(),coord.eta());
    return newCoord;
}

lowerLeft() [2/2]

Coordinate LVL1::JetElementKeyBase::lowerLeft	(	const double	phi,
		const double	eta )

Definition at line 322 of file JetElementKeyBase.cxx.

                                                                        {
    Coordinate coord=downPhi(phi,eta);
    coord=leftEta(coord.phi(),coord.eta());
    return coord;
}

lowerRight() [1/2]

Coordinate LVL1::JetElementKeyBase::lowerRight

(

const Coordinate

coord

)

Definition at line 349 of file JetElementKeyBase.cxx.

                                                              {
    Coordinate newCoord=lowerRight(coord.phi(),coord.eta());
    return newCoord;
}

lowerRight() [2/2]

Coordinate LVL1::JetElementKeyBase::lowerRight	(	const double	phi,
		const double	eta )

Definition at line 328 of file JetElementKeyBase.cxx.

                                                                         {
    Coordinate coord=downPhi(phi,eta);
    coord=rightEta(coord.phi(),coord.eta());
    return coord;
}

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

                                  {
  return m_centralPhi;
}

region()

unsigned int LVL1::JetElementKeyBase::region

(

double

eta

)

const

returns region number at eta, where region is:

Definition at line 390 of file JetElementKeyBase.cxx.

                                                      {
  unsigned int reg=TrigT1CaloDefs::RegionError;
  int sign=((eta>0.0) ? 1:-1);
  if (eta==0.0) sign=1;
  double abs_eta=eta*sign;
  if (abs_eta<2.2){
    // barrel
    reg=0;
  }else{
    if((abs_eta>2.2)&&(abs_eta<=2.4)) reg=1;
    if((abs_eta>2.4)&&(abs_eta<=2.7)) reg=2;
    if((abs_eta>2.7)&&(abs_eta<=2.9)) reg=3;
    if((abs_eta>2.9)&&(abs_eta<=3.2)) reg=4;
    if((abs_eta>3.2)&&(abs_eta<=4.9)) reg=5;
  }//end if
  return reg;
}

rightEta() [1/2]

Coordinate LVL1::JetElementKeyBase::rightEta

(

const Coordinate

coord

)

returns eta coord of JE in +ve eta dir.

Definition at line 250 of file JetElementKeyBase.cxx.

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

rightEta() [2/2]

Coordinate LVL1::JetElementKeyBase::rightEta	(	const double	phi,
		const double	eta )

Functions for finding coordinates of neighbouring JEs.

returns eta coord of JE in +ve eta dir.

Definition at line 223 of file JetElementKeyBase.cxx.

                                                                       {
  Coordinate centre=getCentre(phi,eta);
  double temp_eta=centre.eta();
 
  unsigned int reg=region(temp_eta);
  // supress rightEta in +ve region 5
  unsigned int maxRegion=5+((temp_eta>0.0)? -1:0);
  if ( reg==0 ){
    temp_eta+=m_regionWidth[0];
  }else{
    if ((reg==TrigT1CaloDefs::RegionError)||(reg>maxRegion)) {
      temp_eta=TrigT1CaloDefs::RegionERROREtaCentre;
    }else{
      int sign = ((temp_eta>0.0)? 1:-1);
      temp_eta= sign*m_regionEtaCentre[reg+sign];
    }
  }
  // there's a complication here ... moving right can move us
  // into a JE with a different phi height, and so phi can change.
  // However we want to keep eta at 8.0, so reset eta afterwards.
  Coordinate coord( getCentre(phi,temp_eta) );
  coord.setCoords(coord.phi(), temp_eta) ;
//  analCoordChecking(coord);
  return coord;
}

rightEtaKey()

unsigned int LVL1::JetElementKeyBase::rightEtaKey	(	const double	phi,
		const double	eta )

returns key of JE in -ve eta dir.

returns key of JE in +ve eta dir.

Definition at line 217 of file JetElementKeyBase.cxx.

                                                                             {
  Coordinate coord=rightEta(phi,eta);
  return jeKey(coord.phi(),coord.eta());
}

round()

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

protectedinherited

rounds number to nearest whole number

Definition at line 180 of file KeyUtilities.cxx.

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

setupJetRegionData()

void LVL1::JetElementKeyBase::setupJetRegionData ( )

protected

Does same as setupRegionData, except in FCAL where uses phi granularity appropriate for the jet trigger.

Definition at line 456 of file JetElementKeyBase.cxx.

                                          {
    // the first case is a bit weird - it's actually the centre
    // of the outermost cell of region 0
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region0EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region1EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region2EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region3EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region4EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region5EtaCentre);
 
    m_regionWidth.push_back(TrigT1CaloDefs::Region0Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region1Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region2Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region3Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region4Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region5Width);
 
    m_regionHeight.push_back(TrigT1CaloDefs::Region0Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region1Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region2Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region3Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region4Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region5JetHeight);
}

setupRegionData()

void LVL1::JetElementKeyBase::setupRegionData ( )

protected

get region data from TrigT1CaloDefs and put in more useful format - vectors

Definition at line 429 of file JetElementKeyBase.cxx.

                                       {
    // the first case is a bit weird - it's actually the centre
    // of the outermost cell of region 0
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region0EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region1EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region2EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region3EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region4EtaCentre);
    m_regionEtaCentre.push_back(TrigT1CaloDefs::Region5EtaCentre);
 
    m_regionWidth.push_back(TrigT1CaloDefs::Region0Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region1Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region2Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region3Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region4Width);
    m_regionWidth.push_back(TrigT1CaloDefs::Region5Width);
 
    m_regionHeight.push_back(TrigT1CaloDefs::Region0Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region1Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region2Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region3Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region4Height);
    m_regionHeight.push_back(TrigT1CaloDefs::Region5Height);
}

setupThisKeyValues()

void LVL1::KeyUtilities::setupThisKeyValues ( )

protectedinherited

Definition at line 168 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();
  delete bandc;
  delete iCoord;
}

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 185 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 189 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 164 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 159 of file KeyUtilities.cxx.

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

upperLeft() [1/2]

Coordinate LVL1::JetElementKeyBase::upperLeft

(

const Coordinate

coord

)

Definition at line 334 of file JetElementKeyBase.cxx.

                                                             {
    Coordinate newCoord=upperLeft(coord.phi(),coord.eta());
    return newCoord;
}

upperLeft() [2/2]

Coordinate LVL1::JetElementKeyBase::upperLeft	(	const double	phi,
		const double	eta )

Definition at line 310 of file JetElementKeyBase.cxx.

                                                                        {
    Coordinate coord=upPhi(phi,eta);
    coord=leftEta(coord.phi(),coord.eta());
    return coord;
}

upperRight() [1/2]

Coordinate LVL1::JetElementKeyBase::upperRight

(

const Coordinate

coord

)

Definition at line 339 of file JetElementKeyBase.cxx.

                                                              {
    Coordinate newCoord=upperRight(coord.phi(),coord.eta());
    return newCoord;
}

upperRight() [2/2]

Coordinate LVL1::JetElementKeyBase::upperRight	(	const double	phi,
		const double	eta )

Definition at line 316 of file JetElementKeyBase.cxx.

                                                                         {
    Coordinate coord=upPhi(phi,eta);
    coord=rightEta(coord.phi(),coord.eta());
    return coord;
}

upPhi() [1/2]

Coordinate LVL1::JetElementKeyBase::upPhi

(

const Coordinate

coord

)

returns coord of next JE in +ve phi dir.

Definition at line 272 of file JetElementKeyBase.cxx.

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

upPhi() [2/2]

Coordinate LVL1::JetElementKeyBase::upPhi	(	const double	phi,
		const double	eta )

returns coord of next JE in +ve phi dir.

Definition at line 256 of file JetElementKeyBase.cxx.

                                                                     {
  Coordinate centre=getCentre(phi,eta);
  double temp_phi=centre.phi();
  unsigned int reg=region(centre.eta());
  if (reg==TrigT1CaloDefs::RegionError) {
//    std::cout << "Out of bounds error in JetElementKeyBase::upPhi"<<std::endl;
    temp_phi=0.0;
  }else{
    temp_phi+= m_regionHeight[reg];
  }
  centre.setCoords(temp_phi,centre.eta());
  analCoordChecking(centre);
  return centre;
}

upPhiKey()

unsigned int LVL1::JetElementKeyBase::upPhiKey	(	const double	phi,
		const double	eta )

returns key of next JE in +ve phi dir.

Definition at line 277 of file JetElementKeyBase.cxx.

                                                                          {
    Coordinate coord=upPhi(phi,eta);
    return jeKey(coord.phi(),coord.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 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_debugKeyBase

bool LVL1::JetElementKeyBase::m_debugKeyBase

private

set to true to turn debugging info on

Definition at line 152 of file JetElementKeyBase.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.

m_regionEtaCentre

std::vector<double> LVL1::JetElementKeyBase::m_regionEtaCentre

private

holds central coords of JEs in regions: Region Eta 0 <2.2 1 2.2-2.4 2 2.4-2.7 3 2.7-2.9 4 2.9-3.2 5 3.2-4.9

Definition at line 161 of file JetElementKeyBase.h.

m_regionHeight

std::vector<double> LVL1::JetElementKeyBase::m_regionHeight

private

holds height of JEs in regions:

Definition at line 165 of file JetElementKeyBase.h.

m_regionWidth

std::vector<double> LVL1::JetElementKeyBase::m_regionWidth

private

holds width of JEs in regions:

Definition at line 163 of file JetElementKeyBase.h.

---

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

• JetElementKeyBase.h
• JetElementKeyBase.cxx