l1t::CaloTools Class Reference

#include <CaloTools.h>

Public Types
enum	SubDet { ECAL =0x1, HCAL =0x2, CALO =0x3 }

Static Public Member Functions
static int	calHwEtSum (int iEta, int iPhi, const std::vector< l1t::CaloTower > &towers, int localEtaMin, int localEtaMax, int localPhiMin, int localPhiMax, SubDet etMode=CALO)
static int	calHwEtSum (int iEta, int iPhi, const std::vector< l1t::CaloTower > &towers, int localEtaMin, int localEtaMax, int localPhiMin, int localPhiMax, int iEtaAbsMax, SubDet etMode=CALO)
static size_t	calNrTowers (int iEtaMin, int iEtaMax, int iPhiMin, int iPhiMax, const std::vector< l1t::CaloTower > &towers, int minHwEt, int maxHwEt, SubDet etMode=CALO)
static size_t	caloTowerHash (int iEta, int iPhi)
static size_t	caloTowerHashMax ()
static const l1t::CaloCluster &	getCluster (const std::vector< l1t::CaloCluster > &clusters, int iEta, int iPhi)
static const l1t::CaloTower &	getTower (const std::vector< l1t::CaloTower > &towers, int iEta, int iPhi)
static bool	isValidIEtaIPhi (int iEta, int iPhi)
static float	towerEta (int ieta)
static float	towerEtaSize (int ieta)
static float	towerPhi (int ieta, int iphi)
static float	towerPhiSize (int ieta)

Private Member Functions
	CaloTools ()
	~CaloTools ()

Static Private Member Functions
static std::pair< float, float >	towerEtaBounds (int ieta)

Static Private Attributes
static const int	kHBHEEnd =28
static const int	kHBHENrPhi =72
static const int	kHFBegin =29
static const int	kHFEnd =32
static const int	kHFNrPhi =72/kHFPhiSeg
static const int	kHFPhiSeg =4
static const int	kNrHBHETowers = kHBHEEnd*kHBHENrPhi*2
static const int	kNrTowers = ((kHFEnd-kHFBegin+1)*kHFNrPhi + kHBHEEnd*kHBHENrPhi )*2
static const l1t::CaloCluster	nullCluster_
static const l1t::CaloTower	nullTower_

Detailed Description

Description: A collection of useful functions for the Calorimeter that are of generic interest

Implementation: currently implimented as a static class rather than a namespace, open to re-writing it as namespace

Author

: Sam Harper - RAL

Definition at line 22 of file CaloTools.h.

Member Enumeration Documentation

enum l1t::CaloTools::SubDet

Enumerator
ECAL
HCAL
CALO

Definition at line 42 of file CaloTools.h.

{ECAL=0x1,HCAL=0x2,CALO=0x3}; //CALO is a short cut for ECAL|HCAL

Constructor & Destructor Documentation

l1t::CaloTools::CaloTools ( )

inlineprivate

Definition at line 26 of file CaloTools.h.

{}

l1t::CaloTools::~CaloTools ( )

inlineprivate

Definition at line 27 of file CaloTools.h.

{}

Member Function Documentation

int l1t::CaloTools::calHwEtSum ( int  iEta, int  iPhi, const std::vector< l1t::CaloTower > &  towers, int  localEtaMin, int  localEtaMax, int  localPhiMin, int  localPhiMax, SubDet  etMode = CALO  )

static

Definition at line 81 of file CaloTools.cc.

Referenced by l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::isoCalEgHwFootPrint(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::isoCalTauHwFootPrint(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent().

{

  return calHwEtSum(iEta,iPhi,towers,localEtaMin,localEtaMax,localPhiMin,localPhiMax,kHFEnd,etMode);
}

int l1t::CaloTools::calHwEtSum ( int  iEta, int  iPhi, const std::vector< l1t::CaloTower > &  towers, int  localEtaMin, int  localEtaMax, int  localPhiMin, int  localPhiMax, int  iEtaAbsMax, SubDet  etMode = CALO  )

static

Definition at line 89 of file CaloTools.cc.

References funct::abs(), ECAL, HCAL, l1t::CaloTower::hwEtEm(), l1t::CaloTower::hwEtHad(), l1t::CaloStage2Nav::offsetIEta(), and l1t::CaloStage2Nav::offsetIPhi().

{
  int hwEtSum=0;
  for(int etaNr=localEtaMin;etaNr<=localEtaMax;etaNr++){
    for(int phiNr=localPhiMin;phiNr<=localPhiMax;phiNr++){
      
      int towerIEta = l1t::CaloStage2Nav::offsetIEta(iEta,etaNr);
      int towerIPhi = l1t::CaloStage2Nav::offsetIPhi(iPhi,phiNr);
      if(abs(towerIEta)<=iEtaAbsMax){
    const l1t::CaloTower& tower = getTower(towers,towerIEta,towerIPhi);
    if(etMode&ECAL) hwEtSum+=tower.hwEtEm();
    if(etMode&HCAL) hwEtSum+=tower.hwEtHad();
      } 
    }
  }
  return hwEtSum;
}

size_t l1t::CaloTools::calNrTowers ( int  iEtaMin, int  iEtaMax, int  iPhiMin, int  iPhiMax, const std::vector< l1t::CaloTower > &  towers, int  minHwEt, int  maxHwEt, SubDet  etMode = CALO  )

static

Definition at line 110 of file CaloTools.cc.

References l1t::CaloStage2Nav::currIEta(), l1t::CaloStage2Nav::currIPhi(), l1t::CaloStage2Nav::east(), ECAL, getTower(), HCAL, l1t::CaloTower::hwEtEm(), l1t::CaloTower::hwEtHad(), l1t::L1Candidate::hwPt(), l1t::CaloStage2Nav::north(), and l1t::CaloStage2Nav::resetIPhi().

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent().

{
  size_t nrTowers=0;
  l1t::CaloStage2Nav nav(iEtaMin,iPhiMin);
  while(nav.currIEta()<=iEtaMax){
    bool finishPhi = false;
    while(!finishPhi){
      const l1t::CaloTower& tower = l1t::CaloTools::getTower(towers,nav.currIEta(),nav.currIPhi());
      int towerHwEt =0;
      if(etMode&ECAL) towerHwEt+=tower.hwEtEm();
      if(etMode&HCAL) towerHwEt+=tower.hwEtHad();
      if(etMode&CALO) towerHwEt+=tower.hwPt();
      if(towerHwEt>=minHwEt && towerHwEt<=maxHwEt) nrTowers++;
      finishPhi = (nav.currIPhi() == iPhiMax);
      nav.north();
    }
    nav.east();
    nav.resetIPhi();
  }
  return nrTowers;
}

size_t l1t::CaloTools::caloTowerHash ( int  iEta, int  iPhi  )

static

Definition at line 45 of file CaloTools.cc.

References funct::abs().

Referenced by getTower(), and l1t::stage2::CaloTowerPacker::pack().

{

  if(!isValidIEtaIPhi(iEta,iPhi)) return caloTowerHashMax();
  else{
    const int absIEta = abs(iEta);
    if(absIEta>kHFEnd) return kNrTowers;
    else if(absIEta<=kHBHEEnd){ //HBHE
      int iEtaNoZero=iEta;
      if(iEta>0) iEtaNoZero--;
      return (iEtaNoZero+kHBHEEnd)*kHBHENrPhi+iPhi-1;
    }else{ //HF
      int iEtaIndex = iEta+kHFEnd; //iEta=-32 is 0
      if(iEta>0) iEtaIndex= iEta-kHBHEEnd+(kHFEnd-kHBHEEnd)-1; //but iEta=29 is 4
      return iEtaIndex*kHFNrPhi+iPhi/kHFPhiSeg + kNrHBHETowers;
    }
  }
}

size_t l1t::CaloTools::caloTowerHashMax ( )

static

Definition at line 65 of file CaloTools.cc.

{
  return kNrTowers;
}

const l1t::CaloCluster & l1t::CaloTools::getCluster ( const std::vector< l1t::CaloCluster > &  clusters, int  iEta, int  iPhi  )

static

Definition at line 32 of file CaloTools.cc.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::filtering(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::sharing().

{
  for(size_t clusterNr=0;clusterNr<clusters.size();clusterNr++){
    if(clusters[clusterNr].hwEta()==iEta && clusters[clusterNr].hwPhi()==iPhi) return clusters[clusterNr];
  }
  return nullCluster_;
}

const l1t::CaloTower & l1t::CaloTools::getTower ( const std::vector< l1t::CaloTower > &  towers, int  iEta, int  iPhi  )

static

Definition at line 11 of file CaloTools.cc.

References caloTowerHash(), and nullTower_.

Referenced by L1TStage2InputPatternWriter::analyze(), calNrTowers(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::chunkyDonutPUEstimate(), l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::donutPUEstimate(), l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::filtering(), l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent(), l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::refining(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::sharing().

{
  size_t towerIndex = CaloTools::caloTowerHash(iEta, iPhi);
  if(towerIndex<towers.size()){
    if(towers[towerIndex].hwEta()!=iEta || towers[towerIndex].hwPhi()!=iPhi){ //it failed, this is bad, but we will not log the error due to policy and silently attempt to do a brute force search instead 
      // std::cout <<"error, tower "<<towers[towerIndex].hwEta()<<" "<<towers[towerIndex].hwPhi()<<" does not match "<<iEta<<" "<<iPhi<<" index "<<towerIndex<<" nr towrs "<<towers.size()<<std::endl;
      for(size_t towerNr=0;towerNr<towers.size();towerNr++){
    if(towers[towerNr].hwEta()==iEta && towers[towerNr].hwPhi()==iPhi) return towers[towerNr];
      }     
    }else return towers[towerIndex];
  
  }
  else{// in case the vector of towers do not contain all the towers (towerIndex can be > towers.size())
    for(size_t towerNr=0;towerNr<towers.size();towerNr++){
      if(towers[towerNr].hwEta()==iEta && towers[towerNr].hwPhi()==iPhi) return towers[towerNr];
    }
  }

  return nullTower_;
}

bool l1t::CaloTools::isValidIEtaIPhi ( int  iEta, int  iPhi  )

static

Definition at line 71 of file CaloTools.cc.

References funct::abs().

{
  size_t absIEta = abs(iEta);
  if(iPhi<=0 || iPhi>kHBHENrPhi) return false;
  if(absIEta==0 || absIEta>kHFEnd) return false;
  if(absIEta>kHBHEEnd && iPhi%kHFPhiSeg!=1) return false;
  return true;

}

float l1t::CaloTools::towerEta ( int  ieta )

static

Definition at line 141 of file CaloTools.cc.

References eta(), and jetcorrextractor::sign().

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent().

{
  std::pair<float,float> bounds = towerEtaBounds(ieta);
  float eta = (bounds.second+bounds.first)/2.;
  float sign = ieta>0 ? 1. : -1.;
  return sign*eta; 
}

std::pair< float, float > l1t::CaloTools::towerEtaBounds ( int  ieta )

staticprivate

Definition at line 132 of file CaloTools.cc.

References funct::abs().

{
  if(ieta==0) ieta = 1;
  if(ieta>32) ieta = 32;
  if(ieta<-32) ieta = -32;
  const float towerEtas[33] = {0,0.087,0.174,0.261,0.348,0.435,0.522,0.609,0.696,0.783,0.870,0.957,1.044,1.131,1.218,1.305,1.392,1.479,1.566,1.653,1.740,1.830,1.930,2.043,2.172,2.322,2.5,2.650,3.000,3.5,4.0,4.5,5.0}; 
  return std::make_pair( towerEtas[abs(ieta)-1],towerEtas[abs(ieta)] );
}

float l1t::CaloTools::towerEtaSize ( int  ieta )

static

Definition at line 154 of file CaloTools.cc.

References findQualityFiles::size.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent().

{
  std::pair<float,float> bounds = towerEtaBounds(ieta);
  float size = (bounds.second-bounds.first);
  return size;
}

float l1t::CaloTools::towerPhi ( int  ieta, int  iphi  )

static

Definition at line 149 of file CaloTools.cc.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent().

{
  return (float(iphi)-0.5)*towerPhiSize(ieta);
}

float l1t::CaloTools::towerPhiSize ( int  ieta )

static

Definition at line 161 of file CaloTools.cc.

References funct::abs(), and M_PI.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent().

{
  if(abs(ieta)<=28) return 2.*M_PI/72.;
  else return 2.*M_PI/18.;
}

Member Data Documentation

const int l1t::CaloTools::kHBHEEnd =28

staticprivate

Definition at line 32 of file CaloTools.h.

const int l1t::CaloTools::kHBHENrPhi =72

staticprivate

Definition at line 37 of file CaloTools.h.

const int l1t::CaloTools::kHFBegin =29

staticprivate

Definition at line 33 of file CaloTools.h.

const int l1t::CaloTools::kHFEnd =32

staticprivate

Definition at line 34 of file CaloTools.h.

const int l1t::CaloTools::kHFNrPhi =72/kHFPhiSeg

staticprivate

Definition at line 36 of file CaloTools.h.

const int l1t::CaloTools::kHFPhiSeg =4

staticprivate

Definition at line 35 of file CaloTools.h.

const int l1t::CaloTools::kNrHBHETowers = kHBHEEnd*kHBHENrPhi*2

staticprivate

Definition at line 39 of file CaloTools.h.

const int l1t::CaloTools::kNrTowers = ((kHFEnd-kHFBegin+1)*kHFNrPhi + kHBHEEnd*kHBHENrPhi )*2

staticprivate

Definition at line 38 of file CaloTools.h.

const l1t::CaloCluster l1t::CaloTools::nullCluster_

staticprivate

Definition at line 81 of file CaloTools.h.

const l1t::CaloTower l1t::CaloTools::nullTower_

staticprivate

Definition at line 80 of file CaloTools.h.

Referenced by getTower().