#include <Stage1Layer2EtSumAlgorithmImp.h>

Inheritance diagram for l1t::Stage1Layer2EtSumAlgorithmImpHW:

Classes
struct	SimpleRegion

Public Member Functions
void	processEvent (const std::vector< l1t::CaloRegion > &regions, const std::vector< l1t::CaloEmCand > &EMCands, const std::vector< l1t::Jet > jets, std::vector< l1t::EtSum > sums) override

	Stage1Layer2EtSumAlgorithmImpHW (CaloParamsHelper const *params)

	~Stage1Layer2EtSumAlgorithmImpHW () override=default

Public Member Functions inherited from l1t::Stage1Layer2EtSumAlgorithm
virtual	~Stage1Layer2EtSumAlgorithm ()

Private Types
enum	ETSumType { ETSumType::kHadronicSum, ETSumType::kEmSum }

Private Member Functions
int	cordicToMETPhi (int phase)

int	DiJetPhi (const std::vector< l1t::Jet > *jets) const

std::tuple< int, int, int >	doSumAndMET (const std::vector< SimpleRegion > &regionEt, ETSumType sumType)

uint16_t	MHToverHT (uint16_t, uint16_t) const

Private Attributes
CordicXilinx	cordic {24, 19}

std::array< int, 73 >	cordicPhiValues

std::array< long, 5 >	cosines

CaloParamsHelper const *const	params_

std::array< long, 5 >	sines

Detailed Description

Author: : Nick Smith (nick..nosp@m.smit.nosp@m.h@cer.nosp@m.n.ch)

Description: hardware emulation of et sum algorithm

Definition at line 49 of file Stage1Layer2EtSumAlgorithmImp.h.

Member Enumeration Documentation

enum l1t::Stage1Layer2EtSumAlgorithmImpHW::ETSumType

strongprivate

Enumerator
kHadronicSum
kEmSum

Definition at line 69 of file Stage1Layer2EtSumAlgorithmImp.h.

                          {
       kHadronicSum,
       kEmSum
     };

Constructor & Destructor Documentation

l1t::Stage1Layer2EtSumAlgorithmImpHW::Stage1Layer2EtSumAlgorithmImpHW ( CaloParamsHelper const * params )

Definition at line 19 of file Stage1Layer2EtSumAlgorithmImpHW.cc.

References cordicPhiValues, funct::cos(), cosines, objects.autophobj::float, mps_fire::i, M_PI, funct::pow(), funct::sin(), and sines.

                                                                                                   : params_(params)
 {
   //now do what ever initialization is needed
   for(size_t i=0; i<cordicPhiValues.size(); ++i) {
     cordicPhiValues[i] = static_cast<int>(pow(2.,16)*(((float) i)-36)*M_PI/36);
   }
   for(size_t i=0; i<sines.size(); ++i) {
     sines[i] = static_cast<long>(pow(2,30)*sin(i*20*M_PI/180));
     cosines[i] = static_cast<long>(pow(2,30)*cos(i*20*M_PI/180));
   }
 }

l1t::Stage1Layer2EtSumAlgorithmImpHW::~Stage1Layer2EtSumAlgorithmImpHW ( )

overridedefault

Member Function Documentation

int l1t::Stage1Layer2EtSumAlgorithmImpHW::cordicToMETPhi ( int phase )

private

Definition at line 232 of file Stage1Layer2EtSumAlgorithmImpHW.cc.

References funct::abs(), cordicPhiValues, and mps_fire::i.

Referenced by doSumAndMET().

 {
   assert(abs(phase)<=205887);
   for(size_t i=0; i<cordicPhiValues.size()-1; ++i)
     if ( phase >= cordicPhiValues[i] && phase < cordicPhiValues[i+1] )
       return i;
   // if phase == +205887 (+pi), return zero
   return 0;
 }

int l1t::Stage1Layer2EtSumAlgorithmImpHW::DiJetPhi ( const std::vector< l1t::Jet > * jets ) const

private

Definition at line 242 of file Stage1Layer2EtSumAlgorithmImpHW.cc.

References funct::abs(), and L1CaloRegionDetId::N_PHI.

Referenced by processEvent().

                                                                                       {
 
   int dphi = 10; // initialize to negative physical dphi value
   if (jets->size()<2) return dphi; // size() not really reliable as we pad the size to 8 (4cen+4for) in the sorter
   if ((*jets).at(0).hwPt() == 0) return dphi;
   if ((*jets).at(1).hwPt() == 0) return dphi;
 
 
   int iphi1 = (*jets).at(0).hwPhi();
   int iphi2 = (*jets).at(1).hwPhi();
 
   int difference=abs(iphi1-iphi2);
 
   if ( difference > 9 ) difference= L1CaloRegionDetId::N_PHI - difference ; // make Physical dphi always positive
   return difference;
 }

std::tuple< int, int, int > l1t::Stage1Layer2EtSumAlgorithmImpHW::doSumAndMET	(	const std::vector< SimpleRegion > &	regionEt,
		ETSumType	sumType
	)

private

Definition at line 148 of file Stage1Layer2EtSumAlgorithmImpHW.cc.

References funct::abs(), cordic, cordicToMETPhi(), cosines, mps_fire::i, kHadronicSum, checklumidiff::l, RazorAnalyzer::met, alignCSCRings::r, sines, and objects.METAnalyzer::sumEt.

Referenced by processEvent().

 {
   std::array<int, 18> sumEtaPos{};
   std::array<int, 18> sumEtaNeg{};
   for (const auto& r : regionEt)
   {
     if ( r.ieta < 11 )
       sumEtaNeg[r.iphi] += r.et;
     else
       sumEtaPos[r.iphi] += r.et;
   }
 
   std::array<int, 18> sumEta{};
   int sumEt(0);
   for(size_t i=0; i<sumEta.size(); ++i)
   {
     assert(sumEtaPos[i] >= 0 && sumEtaNeg[i] >= 0);
     sumEta[i] = sumEtaPos[i] + sumEtaNeg[i];
     sumEt += sumEta[i];
   }
 
   // 0, 20, 40, 60, 80 degrees
   std::array<int, 5> sumsForCos{};
   std::array<int, 5> sumsForSin{};
   for(size_t iphi=0; iphi<sumEta.size(); ++iphi)
   {
     if ( iphi < 5 )
     {
       sumsForCos[iphi] += sumEta[iphi];
       sumsForSin[iphi] += sumEta[iphi];
     }
     else if ( iphi < 9 )
     {
       sumsForCos[9-iphi] -= sumEta[iphi];
       sumsForSin[9-iphi] += sumEta[iphi];
     }
     else if ( iphi < 14 )
     {
       sumsForCos[iphi-9] -= sumEta[iphi];
       sumsForSin[iphi-9] -= sumEta[iphi];
     }
     else
     {
       sumsForCos[18-iphi] += sumEta[iphi];
       sumsForSin[18-iphi] -= sumEta[iphi];
     }
   }
 
   long sumX(0l);
   long sumY(0l);
   for(int i=0; i<5; ++i)
   {
     sumX += sumsForCos[i]*cosines[i];
     sumY += sumsForSin[i]*sines[i];
   }
   assert(abs(sumX)<(1l<<48) && abs(sumY)<(1l<<48));
   int cordicX = sumX>>25;
   int cordicY = sumY>>25;
 
   uint32_t cordicMag(0);
   int cordicPhase(0);
   cordic(cordicX, cordicY, cordicPhase, cordicMag);
 
   int met(0);
   int metPhi(0);
   if ( sumType == ETSumType::kHadronicSum )
   {
     met  = (cordicMag % (1<<7)) | ((cordicMag >= (1<<7)) ? (1<<7):0);
     metPhi = cordicToMETPhi(cordicPhase) >> 2;
     assert(metPhi >=0 && metPhi < 18);
   }
   else
   {
     met  = (cordicMag % (1<<12)) | ((cordicMag >= (1<<12)) ? (1<<12):0);
     metPhi = cordicToMETPhi(cordicPhase);
     assert(metPhi >=0 && metPhi < 72);
   }
 
   return std::make_tuple(sumEt, met, metPhi);
 }

uint16_t l1t::Stage1Layer2EtSumAlgorithmImpHW::MHToverHT	(	uint16_t	num,
		uint16_t	den
	)		const

private

Definition at line 259 of file Stage1Layer2EtSumAlgorithmImpHW.cc.

References pfDeepCMVADiscriminatorsJetTags_cfi::denominator, pfDeepCMVADiscriminatorsJetTags_cfi::numerator, and mps_fire::result.

Referenced by processEvent().

                                                                                        {
 
   uint16_t result;
   uint32_t numerator(num),denominator(den);
 
   if(numerator == denominator)
     result = 0x7f;
   else
     {
       numerator = numerator << 7;
       result = numerator/denominator;
       result = result & 0x7f;
     }
   return result;
 }

void l1t::Stage1Layer2EtSumAlgorithmImpHW::processEvent	(	const std::vector< l1t::CaloRegion > &	regions,
		const std::vector< l1t::CaloEmCand > &	EMCands,
		const std::vector< l1t::Jet > *	jets,
		std::vector< l1t::EtSum > *	sums
	)

overridevirtual

Implements l1t::Stage1Layer2EtSumAlgorithm.

Definition at line 33 of file Stage1Layer2EtSumAlgorithmImpHW.cc.

References DiJetPhi(), doSumAndMET(), l1t::Stage1Layer2EtSumAlgorithmImpHW::SimpleRegion::et, l1t::CaloParamsHelper::etSumEtaMax(), l1t::CaloParamsHelper::etSumEtaMin(), l1t::CaloParamsHelper::etSumEtThreshold(), l1t::EtSumToGtScales(), l1t::Stage1Layer2EtSumAlgorithmImpHW::SimpleRegion::ieta, createfilelist::int, l1t::Stage1Layer2EtSumAlgorithmImpHW::SimpleRegion::iphi, l1t::CaloParamsHelper::jetLsb(), kEmSum, kHadronicSum, L1Analysis::kMissingEt, L1Analysis::kMissingHt, L1Analysis::kTotalEt, L1Analysis::kTotalHt, nanoDQM_cfi::MET, nanoDQM_cfi::MHT, MHToverHT(), params_, alignCSCRings::r, and l1t::RegionCorrection().

                                                                 {
 
   std::vector<l1t::CaloRegion> subRegions;
 
 
   //Region Correction will return uncorrected subregions if
   //regionPUSType is set to None in the config
   double jetLsb=params_->jetLsb();
 
   int etSumEtaMinEt = params_->etSumEtaMin(0);
   int etSumEtaMaxEt = params_->etSumEtaMax(0);
   //double etSumEtThresholdEt = params_->etSumEtThreshold(0);
   int etSumEtThresholdEt = (int) (params_->etSumEtThreshold(0) / jetLsb);
 
   int etSumEtaMinHt = params_->etSumEtaMin(1);
   int etSumEtaMaxHt = params_->etSumEtaMax(1);
   //double etSumEtThresholdHt = params_->etSumEtThreshold(1);
   int etSumEtThresholdHt = (int) (params_->etSumEtThreshold(1) / jetLsb);
 
   RegionCorrection(regions, &subRegions, params_);
 
   std::vector<SimpleRegion> regionEtVect;
   std::vector<SimpleRegion> regionHtVect;
 
   // check the un-subtracted regions for overflow
   bool regionOverflowEt(false);
   bool regionOverflowHt(false);
   for (auto& region : regions) {
     if(region.hwEta() >= etSumEtaMinEt && region.hwEta() <= etSumEtaMaxEt)
     {
       if(region.hwPt() >= 1023)
       {
         regionOverflowEt = true;
       }
     }
     if ( region.hwEta() >= etSumEtaMinHt && region.hwEta() <= etSumEtaMaxHt)
     {
       if(region.hwPt() >= 1023)
       {
         regionOverflowHt = true;
       }
     }
   }
 
   // hwPt() is the sum ET+HT in region, for stage 1 this will be
   // the region sum input to MET algorithm
   // In stage 2, we would move to hwEtEm() and hwEtHad() for separate MET/MHT
   // Thresholds will be hardware values not physical
   for (auto& region : subRegions) {
     if ( region.hwEta() >= etSumEtaMinEt && region.hwEta() <= etSumEtaMaxEt)
     {
       if(region.hwPt() >= etSumEtThresholdEt)
       {
         SimpleRegion r;
         r.ieta = region.hwEta();
         r.iphi = region.hwPhi();
         r.et   = region.hwPt();
         regionEtVect.push_back(r);
       }
     }
     if ( region.hwEta() >= etSumEtaMinHt && region.hwEta() <= etSumEtaMaxHt)
     {
       if(region.hwPt() >= etSumEtThresholdHt)
       {
         SimpleRegion r;
         r.ieta = region.hwEta();
         r.iphi = region.hwPhi();
         r.et   = region.hwPt();
         regionHtVect.push_back(r);
       }
     }
   }
 
   int sumET, MET, iPhiET;
   std::tie(sumET, MET, iPhiET) = doSumAndMET(regionEtVect, ETSumType::kEmSum);
 
   int sumHT, MHT, iPhiHT;
   std::tie(sumHT, MHT, iPhiHT) = doSumAndMET(regionHtVect, ETSumType::kHadronicSum);
 
   // Set quality (i.e. overflow) bits appropriately
   int METqual = 0;
   int MHTqual = 0;
   int ETTqual = 0;
   int HTTqual = 0;
   if(MET > 0xfff || regionOverflowEt) // MET 12 bits
     METqual = 1;
   if(MHT > 0x7f || regionOverflowHt)  // MHT 7 bits
     MHTqual = 1;
   if(sumET > 0xfff || regionOverflowEt)
     ETTqual = 1;
   if(sumHT > 0xfff || regionOverflowHt)
     HTTqual = 1;
 
   MHT &= 127; // limit MHT to 7 bits as the firmware does, but only after checking for overflow.
   //MHT is replaced with MHT/HT
   uint16_t MHToHT=MHToverHT(MHT,sumHT);
   //iPhiHt is replaced by the dPhi between two most energetic jets
   iPhiHT = DiJetPhi(jets);
 
   const ROOT::Math::LorentzVector<ROOT::Math::PxPyPzE4D<double> > etLorentz(0,0,0,0);
   l1t::EtSum etMiss(*&etLorentz,EtSum::EtSumType::kMissingEt,MET&0xfff,0,iPhiET,METqual);
   l1t::EtSum htMiss(*&etLorentz,EtSum::EtSumType::kMissingHt,MHToHT&0x7f,0,iPhiHT,MHTqual);
   l1t::EtSum etTot (*&etLorentz,EtSum::EtSumType::kTotalEt,sumET&0xfff,0,0,ETTqual);
   l1t::EtSum htTot (*&etLorentz,EtSum::EtSumType::kTotalHt,sumHT&0xfff,0,0,HTTqual);
 
   std::vector<l1t::EtSum> preGtEtSums = {etMiss, htMiss, etTot, htTot};
 
   EtSumToGtScales(params_, &preGtEtSums, etsums);
 
 }