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 l1t::EGamma	egP4Demux (l1t::EGamma &)
static l1t::EGamma	egP4MP (l1t::EGamma &)
static l1t::EtSum	etSumP4Demux (l1t::EtSum &)
static l1t::EtSum	etSumP4MP (l1t::EtSum &)
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	insertTower (std::vector< l1t::CaloTower > &towers, const l1t::CaloTower &tower)
static bool	isValidIEtaIPhi (int iEta, int iPhi)
static l1t::Jet	jetP4Demux (l1t::Jet &)
static l1t::Jet	jetP4MP (l1t::Jet &)
static math::PtEtaPhiMLorentzVector	p4Demux (l1t::L1Candidate *)
static math::PtEtaPhiMLorentzVector	p4MP (l1t::L1Candidate *)
static l1t::Tau	tauP4Demux (l1t::Tau &)
static l1t::Tau	tauP4MP (l1t::Tau &)
static float	towerEta (int ieta)
static float	towerEtaSize (int ieta)
static float	towerPhi (int ieta, int iphi)
static float	towerPhiSize (int ieta)

Static Public Attributes
static const int	kHBHEEnd =28
static const int	kHBHENrPhi =72
static const int	kHFBegin =29
static const int	kHFEnd =40
static const int	kHFNrPhi =72/kHFPhiSeg
static const int	kHFPhiSeg =1
static const int	kNrHBHETowers = kHBHEEnd*kHBHENrPhi*2
static const int	kNrTowers = ((kHFEnd-kHFBegin+1)*kHFNrPhi + kHBHEEnd*kHBHENrPhi )*2

Private Member Functions
	CaloTools ()
	~CaloTools ()

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

Static Private Attributes
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 29 of file CaloTools.h.

Member Enumeration Documentation

enum l1t::CaloTools::SubDet

Enumerator
ECAL
HCAL
CALO

Definition at line 49 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 33 of file CaloTools.h.

{}

l1t::CaloTools::~CaloTools ( )

inlineprivate

Definition at line 34 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 91 of file CaloTools.cc.

Referenced by l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::isoCalEgHwFootPrint(), 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 99 of file CaloTools.cc.

References funct::abs(), ECAL, HCAL, l1t::CaloTower::hwEtEm(), l1t::CaloTower::hwEtHad(), l1t::L1Candidate::hwPt(), 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();
    else if(etMode==HCAL) hwEtSum+=tower.hwEtHad();
    else if(etMode==CALO) hwEtSum+=tower.hwPt();
      } 
    }
  }
  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 121 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();
      else if(etMode==HCAL) towerHwEt+=tower.hwEtHad();
      else 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 55 of file CaloTools.cc.

References funct::abs().

Referenced by getTower(), insertTower(), 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 75 of file CaloTools.cc.

{
  return kNrTowers;
}

l1t::EGamma l1t::CaloTools::egP4Demux ( l1t::EGamma &  eg )

static

Definition at line 193 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwIso(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), and l1t::L1Candidate::hwQual().

Referenced by L1TStage2Layer2Producer::produce().

                                               {
  
  return l1t::EGamma( p4Demux(&eg),
              eg.hwPt(),
              eg.hwEta(),
              eg.hwPhi(),
              eg.hwQual(),
              eg.hwIso() );

}

l1t::EGamma l1t::CaloTools::egP4MP ( l1t::EGamma &  eg )

static

Definition at line 251 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwIso(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), and l1t::L1Candidate::hwQual().

Referenced by L1TStage2Layer2Producer::produce().

                                            {

  return l1t::EGamma( p4MP(&eg),
              eg.hwPt(),
              eg.hwEta(),
              eg.hwPhi(),
              eg.hwQual(),
              eg.hwIso() );
}

l1t::EtSum l1t::CaloTools::etSumP4Demux ( l1t::EtSum &  etsum )

static

Definition at line 228 of file CaloTools.cc.

References l1t::EtSum::getType(), l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), and l1t::L1Candidate::hwQual().

Referenced by L1TStage2Layer2Producer::produce().

                                                   {

  return l1t::EtSum( p4Demux(&etsum),
             etsum.getType(),
             etsum.hwPt(),
             etsum.hwEta(),
             etsum.hwPhi(),
             etsum.hwQual() );
  
}

l1t::EtSum l1t::CaloTools::etSumP4MP ( l1t::EtSum &  etsum )

static

Definition at line 283 of file CaloTools.cc.

References l1t::EtSum::getType(), l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), and l1t::L1Candidate::hwQual().

Referenced by L1TStage2Layer2Producer::produce().

                                                {

  return l1t::EtSum( p4MP(&etsum),
             etsum.getType(),
             etsum.hwPt(),
             etsum.hwEta(),
             etsum.hwPhi(),
             etsum.hwQual() );
  
}

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

static

Definition at line 42 of file CaloTools.cc.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::filtering(), 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 21 of file CaloTools.cc.

References caloTowerHash().

Referenced by L1TStage2InputPatternWriter::analyze(), calNrTowers(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::chunkyDonutPUEstimate(), l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::donutPUEstimate(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::is3x3Maximum(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::makeSecClusters(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), 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::insertTower ( std::vector< l1t::CaloTower > &  towers, const l1t::CaloTower &  tower  )

static

Definition at line 10 of file CaloTools.cc.

References caloTowerHash(), l1t::L1Candidate::hwEta(), and l1t::L1Candidate::hwPhi().

                                                                                         {
  size_t towerIndex = CaloTools::caloTowerHash(tower.hwEta(), tower.hwPhi());
  if (towers.size() > towerIndex) {
    towers.at(towerIndex) = tower;
    return true;
  }
  else return false;
}

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

static

Definition at line 81 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;

}

l1t::Jet l1t::CaloTools::jetP4Demux ( l1t::Jet &  jet )

static

Definition at line 217 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), l1t::L1Candidate::hwQual(), and configurableAnalysis::Jet.

Referenced by L1TStage2Layer2Producer::produce().

                                           {

  return l1t::Jet( p4Demux(&jet),
           jet.hwPt(),
           jet.hwEta(),
           jet.hwPhi(),
           jet.hwQual() );
  
}

l1t::Jet l1t::CaloTools::jetP4MP ( l1t::Jet &  jet )

static

Definition at line 273 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), l1t::L1Candidate::hwQual(), and configurableAnalysis::Jet.

Referenced by L1TStage2Layer2Producer::produce().

                                        {

  return l1t::Jet( p4MP(&jet),
           jet.hwPt(),
           jet.hwEta(),
           jet.hwPhi(),
           jet.hwQual() );

}

math::PtEtaPhiMLorentzVector l1t::CaloTools::p4Demux ( l1t::L1Candidate *  cand )

static

Definition at line 183 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), and l1t::L1Candidate::hwPt().

Referenced by l1t::stage2::EtSumUnpacker::unpack(), l1t::stage2::TauUnpacker::unpack(), l1t::stage2::JetUnpacker::unpack(), and l1t::stage2::EGammaUnpacker::unpack().

                                                                     {

  return math::PtEtaPhiMLorentzVector( cand->hwPt() * 0.5 + 1.E-6,
                       cand->hwEta() * 0.0435,
                       cand->hwPhi() * 0.0435,
                       0. ) ;
  
}

math::PtEtaPhiMLorentzVector l1t::CaloTools::p4MP ( l1t::L1Candidate *  cand )

static

Definition at line 242 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), and l1t::L1Candidate::hwPt().

Referenced by l1t::stage2::MPUnpacker::unpack().

                                                                  {

  return math::PtEtaPhiMLorentzVector( cand->hwPt() * 0.5 + 1.E-6,
                       towerEta(cand->hwEta()),
                       towerPhi(cand->hwEta(), cand->hwPhi()),
                       0. ) ;

}

l1t::Tau l1t::CaloTools::tauP4Demux ( l1t::Tau &  tau )

static

Definition at line 205 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwIso(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), and l1t::L1Candidate::hwQual().

Referenced by L1TStage2Layer2Producer::produce().

                                           {

  return l1t::Tau( p4Demux(&tau),
           tau.hwPt(),
           tau.hwEta(),
           tau.hwPhi(),
           tau.hwQual(),
           tau.hwIso() );

}

l1t::Tau l1t::CaloTools::tauP4MP ( l1t::Tau &  tau )

static

Definition at line 262 of file CaloTools.cc.

References l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwIso(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), and l1t::L1Candidate::hwQual().

Referenced by L1TStage2Layer2Producer::produce().

                                        {

  return l1t::Tau( p4MP(&tau),
           tau.hwPt(),
           tau.hwEta(),
           tau.hwPhi(),
           tau.hwQual(),
           tau.hwIso() );
}

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

static

Definition at line 153 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 143 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}; 
  const float towerEtas[41] = {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,2.853,3.139,3.314,3.489,3.664,3.839,4.013,4.191,4.363,4.538,4.716,4.889,5.191};
  return std::make_pair( towerEtas[abs(ieta)-1],towerEtas[abs(ieta)] );
}

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

static

Definition at line 166 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 161 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 173 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

static

Definition at line 39 of file CaloTools.h.

const int l1t::CaloTools::kHBHENrPhi =72

static

Definition at line 44 of file CaloTools.h.

const int l1t::CaloTools::kHFBegin =29

static

Definition at line 40 of file CaloTools.h.

const int l1t::CaloTools::kHFEnd =40

static

Definition at line 41 of file CaloTools.h.

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

static

Definition at line 43 of file CaloTools.h.

const int l1t::CaloTools::kHFPhiSeg =1

static

Definition at line 42 of file CaloTools.h.

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

static

Definition at line 46 of file CaloTools.h.

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

static

Definition at line 45 of file CaloTools.h.

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

staticprivate

Definition at line 103 of file CaloTools.h.

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

staticprivate

Definition at line 102 of file CaloTools.h.