#include <CaloTPGTranscoderULUT.h>

Inheritance diagram for CaloTPGTranscoderULUT:

Public Member Functions
	CaloTPGTranscoderULUT (const std::string &compressionFile="", const std::string &decompressionFile="")

EcalTriggerPrimitiveSample	ecalCompress (const EcalTrigTowerDetId &id, unsigned int sample, bool fineGrain) const override
	Compression from linear samples+fine grain in the ECAL. More...

virtual const std::vector< unsigned int >	getCompressionLUT (const HcalTrigTowerDetId &id) const

virtual int	getOutputLUTId (const HcalTrigTowerDetId &id) const

virtual int	getOutputLUTId (const int ieta, const int iphi, const int version) const

HcalTriggerPrimitiveSample	hcalCompress (const HcalTrigTowerDetId &id, unsigned int sample, int fineGrain) const override
	Compression from linear samples+fine grain in the HTR. More...

double	hcaletValue (const int &ieta, const int &iphi, const int &version, const int &compressedValue) const override

double	hcaletValue (const HcalTrigTowerDetId &hid, const HcalTriggerPrimitiveSample &hc) const override

virtual bool	HTvalid (const int ieta, const int iphi, const int version) const

void	rctEGammaUncompress (const HcalTrigTowerDetId &hid, const HcalTriggerPrimitiveSample &hc, const EcalTrigTowerDetId &eid, const EcalTriggerPrimitiveSample &ec, unsigned int &et, bool &egVecto, bool &activity) const override
	Uncompression for the Electron/Photon path in the RCT. More...

void	rctJetUncompress (const HcalTrigTowerDetId &hid, const HcalTriggerPrimitiveSample &hc, const EcalTrigTowerDetId &eid, const EcalTriggerPrimitiveSample &ec, unsigned int &et) const override
	Uncompression for the JET path in the RCT. More...

virtual void	setup (HcalLutMetadata const &, HcalTrigTowerGeometry const &, int, int)

	~CaloTPGTranscoderULUT () override

Public Member Functions inherited from CaloTPGTranscoder
	CaloTPGTranscoder ()

boost::shared_ptr< const EcalTPGCompressor >	getEcalCompressor () const

boost::shared_ptr< const HcalTPGCompressor >	getHcalCompressor () const

virtual	~CaloTPGTranscoder ()

Private Types
typedef uint8_t	LUT

typedef std::array< float, TPGMAX >	RCTdecompression

Private Member Functions
unsigned int	getOutputLUTSize (const HcalTrigTowerDetId &id) const

void	loadHCALCompress (HcalLutMetadata const &, HcalTrigTowerGeometry const &)

Private Attributes
std::string	compressionFile_

std::string	decompressionFile_

std::vector< RCTdecompression >	hcaluncomp_

std::vector< int >	ietah

std::vector< int >	ietal

double	lsb_factor_

std::vector< int >	LUTfactor

double	nct_factor_

double	nominal_gain_

std::vector< std::vector< LUT > >	outputLUT_

std::set< HcalDetId >	plan1_towers_

double	rct_factor_

const HcalTopology *	theTopology

std::vector< int >	ZS

Static Private Attributes
static const bool	newHFphi = true

static const int	NOUTLUTS = 4176

static const unsigned int	OUTPUT_LUT_SIZE = std::max({QIE8_OUTPUT_LUT_SIZE, QIE10_OUTPUT_LUT_SIZE, QIE11_OUTPUT_LUT_SIZE})

static const unsigned int	QIE10_OUTPUT_LUT_SIZE = REDUCE11BIT

static const unsigned int	QIE11_OUTPUT_LUT_SIZE = REDUCE11BIT

static const unsigned int	QIE8_OUTPUT_LUT_SIZE = REDUCE10BIT

static const unsigned int	REDUCE10BIT = 1024

static const unsigned int	REDUCE11BIT = 2048

static const unsigned int	TPGMAX = 256

Additional Inherited Members
Public Types inherited from CaloTPGTranscoder
enum	Mode { All =0, RCT =1, HcalTPG =2, EcalTPG =3 }

Detailed Description

Author: J. Mans - Minnesota

Definition at line 19 of file CaloTPGTranscoderULUT.h.

Member Typedef Documentation

typedef uint8_t CaloTPGTranscoderULUT::LUT

private

Definition at line 57 of file CaloTPGTranscoderULUT.h.

typedef std::array<float, TPGMAX> CaloTPGTranscoderULUT::RCTdecompression

private

Definition at line 58 of file CaloTPGTranscoderULUT.h.

Constructor & Destructor Documentation

CaloTPGTranscoderULUT::CaloTPGTranscoderULUT	(	const std::string &	compressionFile = `""`,
		const std::string &	decompressionFile = `""`
	)

Definition at line 19 of file CaloTPGTranscoderULUT.cc.

                                                 : theTopology(nullptr),
                                                   nominal_gain_(0.), lsb_factor_(0.), rct_factor_(1.), nct_factor_(1.),
                                                   compressionFile_(compressionFile),
                                                   decompressionFile_(decompressionFile)
 {
 }

CaloTPGTranscoderULUT::~CaloTPGTranscoderULUT ( )

override

Definition at line 28 of file CaloTPGTranscoderULUT.cc.

28 {

29 }

Member Function Documentation

EcalTriggerPrimitiveSample CaloTPGTranscoderULUT::ecalCompress	(	const EcalTrigTowerDetId &	id,
		unsigned int	sample,
		bool	fineGrain
	)		const

overridevirtual

Compression from linear samples+fine grain in the ECAL.

Implements CaloTPGTranscoder.

Definition at line 152 of file CaloTPGTranscoderULUT.cc.

References Exception.

                                                                                                                                       {
   throw cms::Exception("Not Implemented") << "CaloTPGTranscoderULUT::ecalCompress";
 }

const std::vector< unsigned int > CaloTPGTranscoderULUT::getCompressionLUT ( const HcalTrigTowerDetId & id ) const

virtual

Definition at line 234 of file CaloTPGTranscoderULUT.cc.

References getOutputLUTId(), lumiPlot::lut, outputLUT_, and mps_fire::result.

Referenced by HcalLutManager::getCompressionLutXmlFromCoder().

                                                                                                          {
    int itower = getOutputLUTId(id);
    auto lut = outputLUT_[itower];
    std::vector<unsigned int> result(lut.begin(), lut.end());
    return result;
 }

int CaloTPGTranscoderULUT::getOutputLUTId ( const HcalTrigTowerDetId & id ) const

virtual

Definition at line 176 of file CaloTPGTranscoderULUT.cc.

References HcalTopology::detId2denseIdHT(), Exception, and theTopology.

Referenced by getCompressionLUT(), hcalCompress(), hcaletValue(), loadHCALCompress(), and L1CaloHcalScaleConfigOnlineProd::newObject().

                                                                             {
     if (!theTopology) {
         throw cms::Exception("CaloTPGTranscoderULUT") << "Topology not set! Use CaloTPGTranscoderULUT::setup(...) first!";
     }
     return theTopology->detId2denseIdHT(id);
 }

int CaloTPGTranscoderULUT::getOutputLUTId	(	const int	ieta,
		const int	iphi,
		const int	version
	)		const

virtual

Definition at line 183 of file CaloTPGTranscoderULUT.cc.

References HcalTopology::detId2denseIdHT(), Exception, triggerObjects_cff::id, and theTopology.

                                                                                                    {
     if (!theTopology) {
         throw cms::Exception("CaloTPGTranscoderULUT") << "Topology not set! Use CaloTPGTranscoderULUT::setup(...) first!";
     }
     HcalTrigTowerDetId id(ieta, iphiin);
     id.setVersion(version);
     return theTopology->detId2denseIdHT(id);
 }

unsigned int CaloTPGTranscoderULUT::getOutputLUTSize ( const HcalTrigTowerDetId & id ) const

private

Definition at line 193 of file CaloTPGTranscoderULUT.cc.

References Exception, HcalTopology::lastHBRing(), HcalTopology::lastHERing(), plan1_towers_, QIE10_OUTPUT_LUT_SIZE, QIE11_OUTPUT_LUT_SIZE, QIE8_OUTPUT_LUT_SIZE, theTopology, HcalTopology::triggerMode(), HcalTopologyMode::TriggerMode_2009, HcalTopologyMode::TriggerMode_2016, HcalTopologyMode::TriggerMode_2017, HcalTopologyMode::TriggerMode_2017plan1, HcalTopologyMode::TriggerMode_2018, HcalTopologyMode::TriggerMode_2018legacy, and HcalTopologyMode::TriggerMode_2019.

Referenced by hcalCompress(), and loadHCALCompress().

 {
    if (!theTopology)
       throw cms::Exception("CaloTPGTranscoderULUT")
          << "Topology not set! Use CaloTPGTranscoderULUT::setup(...) first!";
 
    switch (theTopology->triggerMode()) {
       case HcalTopologyMode::TriggerMode_2009:
       case HcalTopologyMode::TriggerMode_2016:
          return QIE8_OUTPUT_LUT_SIZE;
       case HcalTopologyMode::TriggerMode_2017:
          if (id.ietaAbs() <= theTopology->lastHERing())
             return QIE8_OUTPUT_LUT_SIZE;
          else
             return QIE10_OUTPUT_LUT_SIZE;
       case HcalTopologyMode::TriggerMode_2017plan1:
          if (plan1_towers_.find(id) != plan1_towers_.end())
             return QIE11_OUTPUT_LUT_SIZE;
          else if (id.ietaAbs() <= theTopology->lastHERing())
             return QIE8_OUTPUT_LUT_SIZE;
          else
             return QIE10_OUTPUT_LUT_SIZE;
       case HcalTopologyMode::TriggerMode_2018legacy:
       case HcalTopologyMode::TriggerMode_2018:
          if (id.ietaAbs() <= theTopology->lastHBRing())
             return QIE8_OUTPUT_LUT_SIZE;
          else if (id.ietaAbs() <= theTopology->lastHERing())
             return QIE11_OUTPUT_LUT_SIZE;
          else
             return QIE10_OUTPUT_LUT_SIZE;
       case HcalTopologyMode::TriggerMode_2019:
          if (id.ietaAbs() <= theTopology->lastHERing())
             return QIE11_OUTPUT_LUT_SIZE;
          else
             return QIE10_OUTPUT_LUT_SIZE;
       default:
          throw cms::Exception("CaloTPGTranscoderULUT")
             << "Unknown trigger mode used by the topology!";
    }
 }

HcalTriggerPrimitiveSample CaloTPGTranscoderULUT::hcalCompress	(	const HcalTrigTowerDetId &	id,
		unsigned int	sample,
		int	fineGrain
	)		const

overridevirtual

Compression from linear samples+fine grain in the HTR.

Implements CaloTPGTranscoder.

Definition at line 119 of file CaloTPGTranscoderULUT.cc.

References Exception, getOutputLUTId(), getOutputLUTSize(), triggerObjects_cff::id, and outputLUT_.

                                                                                                                                      {
   unsigned int itower = getOutputLUTId(id);
 
   if (sample >= getOutputLUTSize(id))
     throw cms::Exception("Out of Range")
        << "LUT has " << getOutputLUTSize(id) << " entries for " << id << " but " << sample << " was requested.";
 
   if(itower >= outputLUT_.size())
     throw cms::Exception("Out of Range") << "No decompression LUT found for " << id;
 
   return HcalTriggerPrimitiveSample(outputLUT_[itower][sample], fineGrain);
 }

double CaloTPGTranscoderULUT::hcaletValue	(	const int &	ieta,
		const int &	iphi,
		const int &	version,
		const int &	compressedValue
	)		const

overridevirtual

Implements CaloTPGTranscoder.

Definition at line 132 of file CaloTPGTranscoderULUT.cc.

References getOutputLUTId(), hcaluncomp_, and TPGMAX.

                                                                                                                        {
   double etvalue = 0.;
   int itower = getOutputLUTId(ieta,iphi, version);
   if (itower < 0) {
     edm::LogError("CaloTPGTranscoderULUT") << "No decompression LUT found for ieta, iphi = " << ieta << ", " << iphi;
   } else if (compET < 0 || compET >= (int) TPGMAX) {
     edm::LogError("CaloTPGTranscoderULUT") << "Compressed value out of range: eta, phi, cET = " << ieta << ", " << iphi << ", " << compET;
   } else {
     etvalue = hcaluncomp_[itower][compET];
   }
   return(etvalue);
 }

double CaloTPGTranscoderULUT::hcaletValue	(	const HcalTrigTowerDetId &	hid,
		const HcalTriggerPrimitiveSample &	hc
	)		const

overridevirtual

Implements CaloTPGTranscoder.

Definition at line 145 of file CaloTPGTranscoderULUT.cc.

References HcalTriggerPrimitiveSample::compressedEt(), getOutputLUTId(), and hcaluncomp_.

                                                                                                                    {
   int compET = hc.compressedEt();   // to be within the range by the class
   int itower = getOutputLUTId(hid);
   double etvalue = hcaluncomp_[itower][compET];
   return etvalue;
 }

bool CaloTPGTranscoderULUT::HTvalid	(	const int	ieta,
		const int	iphi,
		const int	version
	)		const

virtual

Definition at line 167 of file CaloTPGTranscoderULUT.cc.

References Exception, triggerObjects_cff::id, theTopology, and HcalTopology::validHT().

Referenced by HcalLutManager::getCompressionLutXmlFromAsciiMaster(), HcalLutManager::getCompressionLutXmlFromCoder(), and L1CaloHcalScaleConfigOnlineProd::newObject().

                                                                                              {
     HcalTrigTowerDetId id(ieta, iphiin);
     id.setVersion(version);
     if (!theTopology) {
         throw cms::Exception("CaloTPGTranscoderULUT") << "Topology not set! Use CaloTPGTranscoderULUT::setup(...) first!";
     }
     return theTopology->validHT(id);
 }

void CaloTPGTranscoderULUT::loadHCALCompress	(	HcalLutMetadata const &	lutMetadata,
		HcalTrigTowerGeometry const &	theTrigTowerGeometry
	)

private

Definition at line 31 of file CaloTPGTranscoderULUT.cc.

References funct::abs(), Exception, HcalTrigTowerGeometry::firstHFTower(), HcalCondObjectContainer< Item >::getAllChannels(), HcalLutMetadatum::getLutGranularity(), getOutputLUTId(), getOutputLUTSize(), HcalLutMetadatum::getOutputLutThreshold(), HcalCondObjectContainer< Item >::getValues(), hcaluncomp_, mps_fire::i, triggerObjects_cff::id, diffTreeTool::index, HcalGenericDetId::isHcalCastorDetId(), HcalGenericDetId::isHcalDetId(), HcalGenericDetId::isHcalTrigTowerDetId(), HcalGenericDetId::isHcalZDCDetId(), cmsBatch::log, lsb_factor_, min(), nct_factor_, nominal_gain_, OUTPUT_LUT_SIZE, outputLUT_, rct_factor_, mathSSE::sqrt(), theTopology, electronIdCutBased_cfi::threshold, HcalTrigTowerGeometry::towerEtaBounds(), TPGMAX, HcalTopology::validHT(), and jets_cff::version.

Referenced by setup().

                                                                                                 {
     if (!theTopology) {
         throw cms::Exception("CaloTPGTranscoderULUT") << "Topology not set! Use CaloTPGTranscoderULUT::setup(...) first!";
     }
 
     std::array<unsigned int, OUTPUT_LUT_SIZE> analyticalLUT;
     std::array<unsigned int, OUTPUT_LUT_SIZE> linearRctLUT;
     std::array<unsigned int, OUTPUT_LUT_SIZE> linearNctLUT;
 
     // Compute compression LUT
     for (unsigned int i=0; i < OUTPUT_LUT_SIZE; i++) {
     analyticalLUT[i] = min((unsigned int)(sqrt(14.94*log(1.+i/14.94)*i) + 0.5), TPGMAX - 1);
     linearRctLUT[i] = min((unsigned int)(i/rct_factor_), TPGMAX - 1);
     linearNctLUT[i] = min((unsigned int)(i/nct_factor_), TPGMAX - 1);
     }
  
     std::vector<DetId> allChannels = lutMetadata.getAllChannels();
 
     for(std::vector<DetId>::iterator i=allChannels.begin(); i!=allChannels.end(); ++i){
 
     if (not HcalGenericDetId(*i).isHcalTrigTowerDetId()) {
       if ((not HcalGenericDetId(*i).isHcalDetId()) and
           (not HcalGenericDetId(*i).isHcalZDCDetId()) and
           (not HcalGenericDetId(*i).isHcalCastorDetId()))
         edm::LogWarning("CaloTPGTranscoderULUT") << "Encountered invalid HcalDetId " << HcalGenericDetId(*i);
       continue; 
     }
     
     HcalTrigTowerDetId id(*i); 
     if(!theTopology->validHT(id)) continue;
 
     unsigned int index = getOutputLUTId(id); 
 
     const HcalLutMetadatum *meta = lutMetadata.getValues(id);
     unsigned int threshold       = meta->getOutputLutThreshold();
 
     int ieta=id.ieta();
     int version=id.version();
     bool isHBHE = (abs(ieta) < theTrigTowerGeometry.firstHFTower(version)); 
 
         unsigned int lutsize = getOutputLUTSize(id);
     outputLUT_[index].resize(lutsize);
 
         for (unsigned int i = 0; i < threshold; ++i)
            outputLUT_[index][i] = 0;
 
         if (isHBHE) {
            for (unsigned int i = threshold; i < lutsize; ++i)
               outputLUT_[index][i] = analyticalLUT[i];
     } else {
            for (unsigned int i = threshold; i < lutsize; ++i)
               outputLUT_[index][i] = version == 0 ? linearRctLUT[i] : linearNctLUT[i];
         }
 
     double eta_low = 0., eta_high = 0.;
     theTrigTowerGeometry.towerEtaBounds(ieta,version,eta_low,eta_high); 
     double cosh_ieta   = fabs(cosh((eta_low + eta_high)/2.));
     double granularity =  meta->getLutGranularity(); 
 
     if(isHBHE){
         double factor = nominal_gain_ / cosh_ieta * granularity;
         LUT tpg = outputLUT_[index][0];
         int low = 0;
         for (unsigned int i = 0; i < getOutputLUTSize(id); ++i){
         if (outputLUT_[index][i] != tpg){
            unsigned int mid = (low + i)/2; 
            hcaluncomp_[index][tpg] = (tpg == 0 ? low : factor * mid);
            low = i;
            tpg = outputLUT_[index][i];
         }
         }
         hcaluncomp_[index][tpg] = factor * low;
     }
     else{
         LUT tpg = outputLUT_[index][0];
         hcaluncomp_[index][tpg]=0;
         for (unsigned int i = 0; i < getOutputLUTSize(id); ++i){
         if (outputLUT_[index][i] != tpg){
            tpg = outputLUT_[index][i];
            hcaluncomp_[index][tpg] = lsb_factor_ * i / (version==0?rct_factor_:nct_factor_);
         }
         }
     }
     }
 
 }

void CaloTPGTranscoderULUT::rctEGammaUncompress	(	const HcalTrigTowerDetId &	hid,
		const HcalTriggerPrimitiveSample &	hc,
		const EcalTrigTowerDetId &	eid,
		const EcalTriggerPrimitiveSample &	ec,
		unsigned int &	et,
		bool &	egVeto,
		bool &	activity
	)		const

overridevirtual

Uncompression for the Electron/Photon path in the RCT.

Implements CaloTPGTranscoder.

Definition at line 156 of file CaloTPGTranscoderULUT.cc.

References Exception.

                                                                                {
   throw cms::Exception("Not Implemented") << "CaloTPGTranscoderULUT::rctEGammaUncompress";
 }

void CaloTPGTranscoderULUT::rctJetUncompress	(	const HcalTrigTowerDetId &	hid,
		const HcalTriggerPrimitiveSample &	hc,
		const EcalTrigTowerDetId &	eid,
		const EcalTriggerPrimitiveSample &	ec,
		unsigned int &	et
	)		const

overridevirtual

Uncompression for the JET path in the RCT.

Implements CaloTPGTranscoder.

Definition at line 161 of file CaloTPGTranscoderULUT.cc.

References Exception.

                                                  {
   throw cms::Exception("Not Implemented") << "CaloTPGTranscoderULUT::rctJetUncompress";
 }

void CaloTPGTranscoderULUT::setup	(	HcalLutMetadata const &	lutMetadata,
		HcalTrigTowerGeometry const &	theTrigTowerGeometry,
		int	nctScaleShift,
		int	rctScaleShift
	)

virtual

Definition at line 241 of file CaloTPGTranscoderULUT.cc.

References compressionFile_, HcalTopology::dddConstants(), decompressionFile_, Exception, HcalCondObjectContainer< Item >::getAllChannels(), HcalTopology::getHTSize(), HcalLutMetadata::getNominalGain(), HcalLutMetadata::getRctLsb(), DetId::Hcal, hcaluncomp_, HcalDDDRecConstants::isPlan1(), loadHCALCompress(), HcaluLUTTPGCoder::lsb_, lsb_factor_, nct_factor_, nominal_gain_, outputLUT_, plan1_towers_, rct_factor_, theTopology, HcalCondObjectContainerBase::topo(), HcalTrigTowerGeometry::towerIds(), and HcalTopology::valid().

Referenced by o2olib.O2OTool::execute().

 {
     theTopology     = lutMetadata.topo();
     nominal_gain_   = lutMetadata.getNominalGain();
     lsb_factor_     = lutMetadata.getRctLsb();
 
     rct_factor_  = lsb_factor_/(HcaluLUTTPGCoder::lsb_*(1<<rctScaleShift));
     nct_factor_  = lsb_factor_/(HcaluLUTTPGCoder::lsb_*(1<<nctScaleShift));
 
     outputLUT_.resize(theTopology->getHTSize());
     hcaluncomp_.resize(theTopology->getHTSize());
 
     plan1_towers_.clear();
     for (const auto& id: lutMetadata.getAllChannels()) {
        if (not (id.det() == DetId::Hcal and theTopology->valid(id)))
           continue;
        HcalDetId cell(id);
        if (not theTopology->dddConstants()->isPlan1(cell))
           continue;
        for (const auto& tower: theTrigTowerGeometry.towerIds(cell))
           plan1_towers_.emplace(tower);
     }
 
     if (compressionFile_.empty() && decompressionFile_.empty()) {
     loadHCALCompress(lutMetadata,theTrigTowerGeometry);
     }
     else {
     throw cms::Exception("Not Implemented") << "setup of CaloTPGTranscoderULUT from text files";
     }
 }