#include <CaloTools.h>

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

Static Public Member Functions
static int	bin16Eta (int ieta)

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 int	caloEta (int ietaMP)

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 unsigned int	gloriousDivision (uint32_t aNumerator, uint32_t aDenominator)

static int	gtEta (int ieta)

static int	gtPhi (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 int	mpEta (int ieta)

static math::PtEtaPhiMLorentzVector	p4Demux (l1t::L1Candidate *)

static math::PtEtaPhiMLorentzVector	p4MP (l1t::L1Candidate *)

static int	regionEta (int ieta)

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 int64_t	cos_coeff [72]

static const int	emul_to_data_sum_index_map [31]

static const int	kHBHEEnd = 28

static const int	kHBHENrPhi = 72

static const int	kHFBegin = 29

static const int	kHFEnd = 41

static const int	kHFNrPhi = 72 / kHFPhiSeg

static const int	kHFPhiSeg = 1

static const int	kNPhi = 72

static const int	kNrHBHETowers = kHBHEEnd * kHBHENrPhi * 2

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

static const int	kSatEcal = 510

static const int	kSatHcal = 509

static const int	kSatJet = 65535

static const int	kSatTower = 511

static const int64_t	sin_coeff [72]

Private Member Functions
	CaloTools ()

	~CaloTools ()

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

Static Private Attributes
static const float	kGTEtaLSB = 0.0435

static const float	kGTEtLSB = 0.5

static const float	kGTPhiLSB = 0.0435

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

◆ SubDet

enum l1t::CaloTools::SubDet

Enumerator
ECAL
HCAL
CALO

Definition at line 60 of file CaloTools.h.

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

l1t::CaloTools::CALO

Definition: CaloTools.h:60

l1t::CaloTools::ECAL

Definition: CaloTools.h:60

HCAL

Definition: HCAL.py:1

Constructor & Destructor Documentation

◆ CaloTools()

l1t::CaloTools::CaloTools ( )

inlineprivate

Definition at line 32 of file CaloTools.h.

32 {}

◆ ~CaloTools()

l1t::CaloTools::~CaloTools ( )

inlineprivate

Definition at line 33 of file CaloTools.h.

33 {}

Member Function Documentation

◆ bin16Eta()

int l1t::CaloTools::bin16Eta ( int ieta )

static

Definition at line 265 of file CaloTools.cc.

References funct::abs(), and LEDCalibrationChannels::ieta.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::calibrate().

                                    {
   int absIEta = abs(ieta);
 
   if (absIEta > 0 && absIEta <= 5)
     return 0;
   else if (absIEta <= 9)
     return 1;
   else if (absIEta <= 13)
     return 2;
   else if (absIEta <= 15)
     return 3;
   else if (absIEta <= 17)
     return 4;
   else if (absIEta <= 19)
     return 5;
   else if (absIEta <= 21)
     return 6;
   else if (absIEta == 22)
     return 7;
   else if (absIEta == 23)
     return 8;
   else if (absIEta == 24)
     return 9;
   else if (absIEta == 25)
     return 10;
   else if (absIEta == 26)
     return 11;
   else if (absIEta <= 28)
     return 12;
   else if (absIEta <= 32)
     return 13;
   else if (absIEta <= 36)
     return 14;
   else if (absIEta <= 41)
     return 15;
   else
     return -1;  // error
 }

◆ calHwEtSum() [1/2]

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 114 of file CaloTools.cc.

References l1tTowerCalibrationProducer_cfi::iEta, and HLT_2023v12_cff::towers.

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

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

◆ calHwEtSum() [2/2]

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 125 of file CaloTools.cc.

References funct::abs(), ECAL, l1tTowerCalibrationProducer_cfi::iEta, l1t::CaloStage2Nav::offsetIEta(), l1t::CaloStage2Nav::offsetIPhi(), l1tHGCalTowerProducer_cfi::tower, l1trig_cff::towerIEta, l1trig_cff::towerIPhi, and HLT_2023v12_cff::towers.

                                               {
   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;
 }

◆ calNrTowers()

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 153 of file CaloTools.cc.

References caloEta(), l1t::CaloStage2Nav::currIEta(), l1t::CaloStage2Nav::currIPhi(), l1t::CaloStage2Nav::east(), ECAL, getTower(), hcalTTPDigis_cfi::iEtaMax, hcalTTPDigis_cfi::iEtaMin, l1t::CaloStage2Nav::north(), l1t::CaloStage2Nav::resetIPhi(), l1tHGCalTowerProducer_cfi::tower, and HLT_2023v12_cff::towers.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent(), and l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::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, CaloTools::caloEta(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;
 }

◆ caloEta()

int l1t::CaloTools::caloEta ( int ietaMP )

static

Definition at line 234 of file CaloTools.cc.

Referenced by L1TStage2InputPatternWriter::analyze(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::calibratedPt(), calNrTowers(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::donutPUEstimate(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::getChunkyRing(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::getSumEtEtaMap(), l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent(), l1t::stage2::CaloTowerUnpacker::unpack(), l1t::stage2::MPUnpacker_0x10010033::unpack(), l1t::stage2::MPUnpacker_0x10010010::unpack(), l1t::stage2::MPUnpacker::unpack(), and l1t::stage2::MPUnpacker_0x1001000b::unpack().

                                    {
   if (mpEta >= kHFBegin)
     return mpEta + 1;
   else if (mpEta <= -1 * kHFBegin)
     return mpEta - 1;
   else
     return mpEta;
 }

◆ caloTowerHash()

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

static

Definition at line 81 of file CaloTools.cc.

References funct::abs(), and l1tTowerCalibrationProducer_cfi::iEta.

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

                                                      {
   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;
     }
   }
 }

◆ caloTowerHashMax()

size_t l1t::CaloTools::caloTowerHashMax ( )

static

Definition at line 102 of file CaloTools.cc.

Referenced by L1TStage2Layer2Producer::produce().

102 { return kNrTowers; }

l1t::CaloTools::kNrTowers

static const int kNrTowers

Definition: CaloTools.h:45

◆ egP4Demux()

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

static

Definition at line 322 of file CaloTools.cc.

References l1t::EGamma::footprintEt(), l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwIso(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), l1t::L1Candidate::hwQual(), l1t::EGamma::isoEt(), l1t::EGamma::nTT(), l1t::EGamma::rawEt(), l1t::EGamma::setTowerIPhi(), l1t::EGamma::shape(), l1t::EGamma::towerHoE(), l1t::EGamma::towerIEta(), and l1t::EGamma::towerIPhi().

Referenced by L1TStage2Layer2Producer::produce().

                                                {
   l1t::EGamma tmpEG(p4Demux(&eg), eg.hwPt(), eg.hwEta(), eg.hwPhi(), eg.hwQual(), eg.hwIso());
   tmpEG.setTowerIPhi(eg.towerIPhi());
   tmpEG.setTowerIEta(eg.towerIEta());
   tmpEG.setRawEt(eg.rawEt());
   tmpEG.setIsoEt(eg.isoEt());
   tmpEG.setFootprintEt(eg.footprintEt());
   tmpEG.setNTT(eg.nTT());
   tmpEG.setShape(eg.shape());
   tmpEG.setTowerHoE(eg.towerHoE());
 
   return tmpEG;
 }

◆ egP4MP()

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

static

Definition at line 374 of file CaloTools.cc.

References l1t::EGamma::footprintEt(), l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwIso(), l1t::L1Candidate::hwPhi(), l1t::L1Candidate::hwPt(), l1t::L1Candidate::hwQual(), l1t::EGamma::isoEt(), l1t::EGamma::nTT(), l1t::EGamma::rawEt(), l1t::EGamma::setTowerIPhi(), l1t::EGamma::shape(), l1t::EGamma::towerHoE(), l1t::EGamma::towerIEta(), and l1t::EGamma::towerIPhi().

Referenced by L1TStage2Layer2Producer::produce().

                                             {
   l1t::EGamma tmpEG(p4MP(&eg), eg.hwPt(), eg.hwEta(), eg.hwPhi(), eg.hwQual(), eg.hwIso());
   tmpEG.setTowerIPhi(eg.towerIPhi());
   tmpEG.setTowerIEta(eg.towerIEta());
   tmpEG.setRawEt(eg.rawEt());
   tmpEG.setIsoEt(eg.isoEt());
   tmpEG.setFootprintEt(eg.footprintEt());
   tmpEG.setNTT(eg.nTT());
   tmpEG.setShape(eg.shape());
   tmpEG.setTowerHoE(eg.towerHoE());
 
   return tmpEG;
 }

◆ etSumP4Demux()

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

static

Definition at line 364 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());
 }

◆ etSumP4MP()

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

static

Definition at line 416 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());
 }

◆ getCluster()

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

static

Definition at line 70 of file CaloTools.cc.

References bsc_activity_cfg::clusters, l1trig_cff::hwEta, and l1tTowerCalibrationProducer_cfi::iEta.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::filtering().

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

◆ getTower()

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

static

Definition at line 43 of file CaloTools.cc.

References funct::abs(), caloTowerHash(), l1trig_cff::hwEta, l1tTowerCalibrationProducer_cfi::iEta, kHFEnd, and HLT_2023v12_cff::towers.

                                                                                                     {
   if (abs(iEta) > CaloTools::kHFEnd)
     return nullTower_;
 
   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_;
 }

◆ gloriousDivision()

unsigned int l1t::CaloTools::gloriousDivision	(	uint32_t	aNumerator,
		uint32_t	aDenominator
	)

static

Definition at line 419 of file CaloTools.cc.

References mps_fire::result.

Referenced by l1t::Stage2Layer2DemuxSumsAlgoFirmwareImp1::processEvent().

                                                                                       {
   static const uint64_t lLut[] = {
       0,     16777215, 4194304, 1864135, 1048576, 671089, 466034, 342392, 262144, 207126, 167772, 138655, 116508, 99273,
       85598, 74565,    65536,   58053,   51782,   46474,  41943,  38044,  34664,  31715,  29127,  26844,  24818,  23014,
       21400, 19949,    18641,   17458,   16384,   15406,  14513,  13696,  12945,  12255,  11619,  11030,  10486,  9980,
       9511,  9074,     8666,    8285,    7929,    7595,   7282,   6988,   6711,   6450,   6205,   5973,   5754,   5546,
       5350,  5164,     4987,    4820,    4660,    4509,   4365,   4227,   4096,   3971,   3852,   3737,   3628,   3524,
       3424,  3328,     3236,    3148,    3064,    2983,   2905,   2830,   2758,   2688,   2621,   2557,   2495,   2435,
       2378,  2322,     2268,    2217,    2166,    2118,   2071,   2026,   1982,   1940,   1899,   1859,   1820,   1783,
       1747,  1712,     1678,    1645,    1613,    1581,   1551,   1522,   1493,   1465,   1438,   1412,   1387,   1362,
       1337,  1314,     1291,    1269,    1247,    1226,   1205,   1185,   1165,   1146,   1127,   1109,   1091,   1074,
       1057,  1040,     1024,    1008,    993,     978,    963,    948,    934,    921,    907,    894,    881,    868,
       856,   844,      832,     820,     809,     798,    787,    776,    766,    756,    746,    736,    726,    717,
       707,   698,      689,     681,     672,     664,    655,    647,    639,    631,    624,    616,    609,    602,
       594,   587,      581,     574,     567,     561,    554,    548,    542,    536,    530,    524,    518,    512,
       506,   501,      496,     490,     485,     480,    475,    470,    465,    460,    455,    450,    446,    441,
       437,   432,      428,     424,     419,     415,    411,    407,    403,    399,    395,    392,    388,    384,
       380,   377,      373,     370,     366,     363,    360,    356,    353,    350,    347,    344,    340,    337,
       334,   331,      328,     326,     323,     320,    317,    314,    312,    309,    306,    304,    301,    299,
       296,   294,      291,     289,     286,     284,    282,    280,    277,    275,    273,    271,    268,    266,
       264,   262,      260,     258,     256,     254,    252,    250,    248,    246,    244,    243,    241,    239,
       237,   235,      234,     232,     230,     228,    227,    225,    223,    222,    220,    219,    217,    216,
       214,   212,      211,     209,     208,     207,    205,    204,    202,    201,    199,    198,    197,    195,
       194,   193,      191,     190,     189,     188,    186,    185,    184,    183,    182,    180,    179,    178,
       177,   176,      175,     173,     172,     171,    170,    169,    168,    167,    166,    165,    164,    163,
       162,   161,      160,     159,     158,     157,    156,    155,    154,    153,    152,    151,    150,    149,
       149,   148,      147,     146,     145,     144,    143,    143,    142,    141,    140,    139,    139,    138,
       137,   136,      135,     135,     134,     133,    132,    132,    131,    130,    129,    129,    128,    127,
       127,   126,      125,     125,     124,     123,    123,    122,    121,    121,    120,    119,    119,    118,
       117,   117,      116,     116,     115,     114,    114,    113,    113,    112,    111,    111,    110,    110,
       109,   109,      108,     108,     107,     106,    106,    105,    105,    104,    104,    103,    103,    102,
       102,   101,      101,     100,     100,     99,     99,     98,     98,     97,     97,     96,     96,     96,
       95,    95,       94,      94,      93,      93,     92,     92,     92,     91,     91,     90,     90,     89,
       89,    89,       88,      88,      87,      87,     87,     86,     86,     85,     85,     85,     84,     84,
       84,    83,       83,      82,      82,      82,     81,     81,     81,     80,     80,     80,     79,     79,
       79,    78,       78,      78,      77,      77,     77,     76,     76,     76,     75,     75,     75,     74,
       74,    74,       73,      73,      73,      73,     72,     72,     72,     71,     71,     71,     70,     70,
       70,    70,       69,      69,      69,      68,     68,     68,     68,     67,     67,     67,     67,     66,
       66,    66,       66,      65,      65,      65,     65,     64};
 
   // Firmware uses 18bit integers - make sure we are in the same range
   aNumerator &= 0x3FFFF;
   aDenominator &= 0x3FFFF;
 
   // Shift the denominator to optimise the polynomial expansion
   // I limit the shift to half the denominator size in the firmware to save on resources
   uint32_t lBitShift(0);
   for (; lBitShift != 9; ++lBitShift) {
     if (aDenominator & 0x20000)
       break;  // There is a 1 in the MSB
     aDenominator <<= 1;
   }
 
   // The magical polynomial expansion Voodoo
   uint64_t lInverseDenominator(((aDenominator & 0x3FE00) - (aDenominator & 0x001FF)) * (lLut[aDenominator >> 9]));
 
   // Save on DSPs by throwing away a bunch of LSBs
   lInverseDenominator >>= 17;
 
   // Multiply the numerator by the inverse denominator
   uint64_t lResult(aNumerator * lInverseDenominator);
 
   // Add two bits to the result, to make the Voodoo below work (saves us having an if-else on the shift direction)
   lResult <<= 2;
 
   // Restore the scale by taking into account the bitshift applied above.
   // We are now 18 bit left-shifted, so the 18 LSBs are effectively the fractional part...
 
   uint32_t aFractional = (lResult >>= (9 - lBitShift)) & 0x3FFFF;
   // ...and the top 18 bits are the integer part
 
   // uint32_t aInteger    = ( lResult >>= 18 ) & 0x3FFFF;
 
   unsigned int result = aFractional >> 10;
 
   return result;
 
   // Simples!
 }

◆ gtEta()

int l1t::CaloTools::gtEta ( int ieta )

static

Definition at line 304 of file CaloTools.cc.

References PVValHelper::eta, and LEDCalibrationChannels::ieta.

Referenced by l1t::Stage2Layer2DemuxJetAlgoFirmwareImp1::processEvent().

                                 {
   double eta = towerEta(ieta);
   return round(eta / kGTEtaLSB);
 }

◆ gtPhi()

int l1t::CaloTools::gtPhi	(	int	ieta,
		int	iphi
	)

static

Definition at line 309 of file CaloTools.cc.

References LEDCalibrationChannels::ieta, LEDCalibrationChannels::iphi, and M_PI.

Referenced by l1t::Stage2Layer2DemuxJetAlgoFirmwareImp1::processEvent().

                                           {
   double phi = towerPhi(ieta, iphi);
   if (phi < 0)
     phi = phi + 2 * M_PI;
   return round(phi / kGTPhiLSB);
 }

◆ insertTower()

bool l1t::CaloTools::insertTower	(	std::vector< l1t::CaloTower > &	towers,
		const l1t::CaloTower &	tower
	)

static

Definition at line 32 of file CaloTools.cc.

References caloTowerHash(), l1tHGCalTowerProducer_cfi::tower, and HLT_2023v12_cff::towers.

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

◆ isValidIEtaIPhi()

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

static

Definition at line 104 of file CaloTools.cc.

References funct::abs(), and l1tTowerCalibrationProducer_cfi::iEta.

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

◆ jetP4Demux()

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

static

Definition at line 349 of file CaloTools.cc.

References metsig::jet, and l1t::Jet::setTowerIPhi().

Referenced by L1TStage2Layer2Producer::produce().

                                            {
   l1t::Jet tmpJet(p4Demux(&jet), jet.hwPt(), jet.hwEta(), jet.hwPhi(), jet.hwQual());
   tmpJet.setTowerIPhi(jet.towerIPhi());
   tmpJet.setTowerIEta(jet.towerIEta());
   tmpJet.setRawEt(jet.rawEt());
   tmpJet.setSeedEt(jet.seedEt());
   tmpJet.setPUEt(jet.puEt());
   tmpJet.setPUDonutEt(0, jet.puDonutEt(0));
   tmpJet.setPUDonutEt(1, jet.puDonutEt(1));
   tmpJet.setPUDonutEt(2, jet.puDonutEt(2));
   tmpJet.setPUDonutEt(3, jet.puDonutEt(3));
 
   return tmpJet;
 }

◆ jetP4MP()

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

static

Definition at line 401 of file CaloTools.cc.

References metsig::jet, and l1t::Jet::setTowerIPhi().

Referenced by L1TStage2Layer2Producer::produce().

                                         {
   l1t::Jet tmpJet(p4MP(&jet), jet.hwPt(), jet.hwEta(), jet.hwPhi(), jet.hwQual());
   tmpJet.setTowerIPhi(jet.towerIPhi());
   tmpJet.setTowerIEta(jet.towerIEta());
   tmpJet.setRawEt(jet.rawEt());
   tmpJet.setSeedEt(jet.seedEt());
   tmpJet.setPUEt(jet.puEt());
   tmpJet.setPUDonutEt(0, jet.puDonutEt(0));
   tmpJet.setPUDonutEt(1, jet.puDonutEt(1));
   tmpJet.setPUDonutEt(2, jet.puDonutEt(2));
   tmpJet.setPUDonutEt(3, jet.puDonutEt(3));
 
   return tmpJet;
 }

◆ mpEta()

int l1t::CaloTools::mpEta ( int ieta )

static

Definition at line 224 of file CaloTools.cc.

References LEDCalibrationChannels::ieta.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::calibrate(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::donutPUEstimate(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::getChunkyRing(), l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent(), l1t::Stage2Layer2JetSumAlgorithmFirmwareImp1::processEvent(), and l1t::Stage2Layer2DemuxJetAlgoFirmwareImp1::processEvent().

                                 {
   if (ieta > kHFBegin)
     return ieta - 1;
   else if (ieta < -1 * kHFBegin)
     return ieta + 1;
   else
     return ieta;
 }

◆ p4Demux()

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

static

Definition at line 317 of file CaloTools.cc.

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

                                                                      {
   return math::PtEtaPhiMLorentzVector(
       cand->hwPt() * kGTEtLSB + 1.E-6, cand->hwEta() * kGTEtaLSB, cand->hwPhi() * kGTPhiLSB, 0.);
 }

◆ p4MP()

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

static

Definition at line 369 of file CaloTools.cc.

Referenced by l1t::stage2::MPUnpacker::unpack(), l1t::stage2::MPUnpacker_0x10010033::unpack(), l1t::stage2::MPUnpacker_0x10010010::unpack(), and l1t::stage2::MPUnpacker_0x1001000b::unpack().

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

◆ regionEta()

int l1t::CaloTools::regionEta ( int ieta )

static

Definition at line 244 of file CaloTools.cc.

References funct::abs(), reco::ceil(), and LEDCalibrationChannels::ieta.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::calibrate().

                                     {
   // outside HF
   if (abs(ieta) > kHFEnd)
     return (ieta < 0 ? 0 : 21);
 
   // inside HBHE
   if (abs(ieta) <= kHFBegin) {
     if (ieta < 0)
       return 11 - ceil(double(abs(ieta) / 4.));
     else
       return ceil(double(abs(ieta) / 4.)) + 10;
   }
 
   // in HF
   if (ieta < 0)
     return 4 - ceil(double(abs(ieta) - 29) / 4.);
   else
     return ceil(double(abs(ieta) - 29) / 4.) + 17;
 }

◆ tauP4Demux()

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

static

Definition at line 336 of file CaloTools.cc.

References l1t::Tau::setTowerIPhi(), and metsig::tau.

Referenced by L1TStage2Layer2Producer::produce().

                                            {
   l1t::Tau tmpTau(p4Demux(&tau), tau.hwPt(), tau.hwEta(), tau.hwPhi(), tau.hwQual(), tau.hwIso());
   tmpTau.setTowerIPhi(tau.towerIPhi());
   tmpTau.setTowerIEta(tau.towerIEta());
   tmpTau.setRawEt(tau.rawEt());
   tmpTau.setIsoEt(tau.isoEt());
   tmpTau.setNTT(tau.nTT());
   tmpTau.setHasEM(tau.hasEM());
   tmpTau.setIsMerged(tau.isMerged());
 
   return tmpTau;
 }

◆ tauP4MP()

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

static

Definition at line 388 of file CaloTools.cc.

References l1t::Tau::setTowerIPhi(), and metsig::tau.

Referenced by L1TStage2Layer2Producer::produce().

                                         {
   l1t::Tau tmpTau(p4MP(&tau), tau.hwPt(), tau.hwEta(), tau.hwPhi(), tau.hwQual(), tau.hwIso());
   tmpTau.setTowerIPhi(tau.towerIPhi());
   tmpTau.setTowerIEta(tau.towerIEta());
   tmpTau.setRawEt(tau.rawEt());
   tmpTau.setIsoEt(tau.isoEt());
   tmpTau.setNTT(tau.nTT());
   tmpTau.setHasEM(tau.hasEM());
   tmpTau.setIsMerged(tau.isMerged());
 
   return tmpTau;
 }

◆ towerEta()

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

static

Definition at line 201 of file CaloTools.cc.

References PVValHelper::eta, LEDCalibrationChannels::ieta, and Validation_hcalonly_cfi::sign.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent(), L1TowerCalibrator::produce(), L1EGCrystalClusterEmulatorProducer::produce(), and L1TPFCaloProducer::readHcalDigis_().

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

◆ towerEtaBounds()

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

staticprivate

Definition at line 186 of file CaloTools.cc.

References funct::abs(), and LEDCalibrationChannels::ieta.

                                                            {
   if (ieta == 0)
     ieta = 1;
   if (ieta > kHFEnd)
     ieta = kHFEnd;
   if (ieta < (-1 * kHFEnd))
     ieta = -1 * kHFEnd;
   //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[42] = {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, 5.191};
   return std::make_pair(towerEtas[abs(ieta) - 1], towerEtas[abs(ieta)]);
 }

◆ towerEtaSize()

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

static

Definition at line 215 of file CaloTools.cc.

References LEDCalibrationChannels::ieta, and 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;
 }

◆ towerPhi()

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

static

Definition at line 208 of file CaloTools.cc.

References dqmMemoryStats::float, LEDCalibrationChannels::ieta, LEDCalibrationChannels::iphi, and M_PI.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent(), L1TowerCalibrator::produce(), L1EGCrystalClusterEmulatorProducer::produce(), and L1TPFCaloProducer::readHcalDigis_().

                                                {
   float phi = (float(iphi) - 0.5) * towerPhiSize(ieta);
   if (phi > M_PI)
     phi = phi - (2 * M_PI);
   return phi;
 }

◆ towerPhiSize()

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

static

Definition at line 221 of file CaloTools.cc.

References M_PI.

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

221 { return 2. * M_PI / kNPhi; }

l1t::CaloTools::kNPhi

static const int kNPhi

Definition: CaloTools.h:44

M_PI

#define M_PI

Definition: BXVectorInputProducer.cc:50

Member Data Documentation

◆ cos_coeff

const int64_t l1t::CaloTools::cos_coeff

static

Initial value:

= {
    1023,  1019,  1007,  988,  961,  927,  886,  838,  784,  723,  658,  587,  512,  432,  350,  265,  178,   89,
    0,     -89,   -178,  -265, -350, -432, -512, -587, -658, -723, -784, -838, -886, -927, -961, -988, -1007, -1019,
    -1023, -1019, -1007, -988, -961, -927, -886, -838, -784, -723, -658, -587, -512, -432, -350, -265, -178,  -89,
    0,     89,    178,   265,  350,  432,  511,  587,  658,  723,  784,  838,  886,  927,  961,  988,  1007,  1019}

Definition at line 137 of file CaloTools.h.

Referenced by l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent(), and l1t::Stage2Layer2JetSumAlgorithmFirmwareImp1::processEvent().

◆ emul_to_data_sum_index_map

const int l1t::CaloTools::emul_to_data_sum_index_map

static

Initial value:

= {
    9,  1,  19, 8,  0,  18, 10, 4,  6,  14,  
    28, 24, 13, 27, 23, 15, 5,  7,  22, 12,  
    3,  21, 11, 2,  20, 17, 30, 26, 16, 29,  
    25                                       
}

Definition at line 141 of file CaloTools.h.

Referenced by L1TStage2CaloLayer2Comp::compareSums().

◆ kGTEtaLSB

const float l1t::CaloTools::kGTEtaLSB = 0.0435

staticprivate

Definition at line 152 of file CaloTools.h.

◆ kGTEtLSB

const float l1t::CaloTools::kGTEtLSB = 0.5

staticprivate

Definition at line 154 of file CaloTools.h.

◆ kGTPhiLSB

const float l1t::CaloTools::kGTPhiLSB = 0.0435

staticprivate

Definition at line 153 of file CaloTools.h.

◆ kHBHEEnd

const int l1t::CaloTools::kHBHEEnd = 28

static

Definition at line 38 of file CaloTools.h.

◆ kHBHENrPhi

const int l1t::CaloTools::kHBHENrPhi = 72

static

Definition at line 43 of file CaloTools.h.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::donutPUEstimate(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::getChunkyRing(), l1t::Stage2Layer2JetSumAlgorithmFirmwareImp1::processEvent(), and l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent().

◆ kHFBegin

const int l1t::CaloTools::kHFBegin = 29

static

Definition at line 39 of file CaloTools.h.

Referenced by l1t::CaloStage2Nav::offsetIEta(), l1t::stage2::CaloTowerPacker::pack(), l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent(), and L1TowerCalibrator::produce().

◆ kHFEnd

const int l1t::CaloTools::kHFEnd = 41

static

Definition at line 40 of file CaloTools.h.

◆ kHFNrPhi

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

static

Definition at line 42 of file CaloTools.h.

◆ kHFPhiSeg

const int l1t::CaloTools::kHFPhiSeg = 1

static

Definition at line 41 of file CaloTools.h.

◆ kNPhi

const int l1t::CaloTools::kNPhi = 72

static

Definition at line 44 of file CaloTools.h.

◆ kNrHBHETowers

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

static

Definition at line 46 of file CaloTools.h.

◆ kNrTowers

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

static

Definition at line 45 of file CaloTools.h.

◆ kSatEcal

const int l1t::CaloTools::kSatEcal = 510

static

Definition at line 53 of file CaloTools.h.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), and l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent().

◆ kSatHcal

const int l1t::CaloTools::kSatHcal = 509

static

Definition at line 52 of file CaloTools.h.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), and l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent().

◆ kSatJet

const int l1t::CaloTools::kSatJet = 65535

static

Definition at line 57 of file CaloTools.h.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::calibrate(), l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), and l1t::Stage2Layer2JetSumAlgorithmFirmwareImp1::processEvent().

◆ kSatTower

const int l1t::CaloTools::kSatTower = 511

static

Definition at line 54 of file CaloTools.h.

Referenced by l1t::Stage2Layer2JetAlgorithmFirmwareImp1::create(), and l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent().

◆ nullCluster_

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

staticprivate

Definition at line 150 of file CaloTools.h.

◆ nullTower_

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

staticprivate

Definition at line 148 of file CaloTools.h.

◆ sin_coeff

const int64_t l1t::CaloTools::sin_coeff

static

Initial value:

= {
    0,     89,    178,   265,  350,  432,  512,  587,  658,  723,  784,  838,  886,  927,  961,  988,  1007,  1019,
    1023,  1019,  1007,  988,  961,  927,  886,  838,  784,  723,  658,  587,  512,  432,  350,  265,  178,   89,
    0,     -89,   -178,  -265, -350, -432, -512, -587, -658, -723, -784, -838, -886, -927, -961, -988, -1007, -1019,
    -1023, -1019, -1007, -988, -961, -927, -886, -838, -784, -723, -658, -587, -512, -432, -350, -265, -178,  -89}

Definition at line 138 of file CaloTools.h.

Referenced by l1t::Stage2Layer2EtSumAlgorithmFirmwareImp1::processEvent(), and l1t::Stage2Layer2JetSumAlgorithmFirmwareImp1::processEvent().

Public Types

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ SubDet

Constructor & Destructor Documentation

◆ CaloTools()

◆ ~CaloTools()

Member Function Documentation

◆ bin16Eta()

◆ calHwEtSum() [1/2]

◆ calHwEtSum() [2/2]

◆ calNrTowers()

◆ caloEta()

◆ caloTowerHash()

◆ caloTowerHashMax()

◆ egP4Demux()

◆ egP4MP()

◆ etSumP4Demux()

◆ etSumP4MP()

◆ getCluster()

◆ getTower()

◆ gloriousDivision()

◆ gtEta()

◆ gtPhi()

◆ insertTower()

◆ isValidIEtaIPhi()

◆ jetP4Demux()

◆ jetP4MP()

◆ mpEta()

◆ p4Demux()

◆ p4MP()

◆ regionEta()

◆ tauP4Demux()

◆ tauP4MP()

◆ towerEta()

◆ towerEtaBounds()

◆ towerEtaSize()

◆ towerPhi()

◆ towerPhiSize()

Member Data Documentation

◆ cos_coeff

◆ emul_to_data_sum_index_map

◆ kGTEtaLSB

◆ kGTEtLSB

◆ kGTPhiLSB

◆ kHBHEEnd

◆ kHBHENrPhi

◆ kHFBegin

◆ kHFEnd

◆ kHFNrPhi

◆ kHFPhiSeg

◆ kNPhi

◆ kNrHBHETowers

◆ kNrTowers

◆ kSatEcal

◆ kSatHcal

◆ kSatJet

◆ kSatTower

◆ nullCluster_

◆ nullTower_

◆ sin_coeff