#include <CaloTPGTranscoderULUT.h>

Inheritance diagram for CaloTPGTranscoderULUT:

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

virtual EcalTriggerPrimitiveSample	ecalCompress (const EcalTrigTowerDetId &id, unsigned int sample, bool fineGrain) const
	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

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

virtual double	hcaletValue (const int &ieta, const int &compressedValue) const

virtual double	hcaletValue (const int &ieta, const int &iphi, const int &compressedValue) const

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

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

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

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

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

virtual	~CaloTPGTranscoderULUT ()

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 unsigned int	LUT

typedef std::vector< double >	RCTdecompression

Private Member Functions
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

std::vector< int >	LUTfactor

double	nominal_gain_

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

double	rctlsb_factor_

const HcalTopology *	theTopology

std::vector< int >	ZS

Static Private Attributes
static float	LSB_HBHE = 0.25f

static float	LSB_HF = 0.5f

static const bool	newHFphi = true

static const int	NOUTLUTS = 4176

static const unsigned int	OUTPUT_LUT_SIZE = 1024

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 18 of file CaloTPGTranscoderULUT.h.

Member Typedef Documentation

typedef unsigned int CaloTPGTranscoderULUT::LUT

private

Definition at line 43 of file CaloTPGTranscoderULUT.h.

typedef std::vector<double> CaloTPGTranscoderULUT::RCTdecompression

private

Definition at line 44 of file CaloTPGTranscoderULUT.h.

Constructor & Destructor Documentation

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

Definition at line 21 of file CaloTPGTranscoderULUT.cc.

References outputLUT_.

                                                 : theTopology(0),
                                                   nominal_gain_(0.), rctlsb_factor_(0.),
                                                   compressionFile_(compressionFile),
                                                   decompressionFile_(decompressionFile)
 {
   outputLUT_.clear();
 }

CaloTPGTranscoderULUT::~CaloTPGTranscoderULUT ( )

virtual

Definition at line 31 of file CaloTPGTranscoderULUT.cc.

31 {

32 }

Member Function Documentation

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

virtual

Compression from linear samples+fine grain in the ECAL.

Implements CaloTPGTranscoder.

Definition at line 167 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 205 of file CaloTPGTranscoderULUT.cc.

References getOutputLUTId(), and outputLUT_.

Referenced by HcalLutManager::getCompressionLutXmlFromCoder().

                                                                                                           {
    int itower = getOutputLUTId(id);
    return outputLUT_[itower];
 }

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

virtual

Definition at line 190 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

virtual

Definition at line 197 of file CaloTPGTranscoderULUT.cc.

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

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

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

virtual

Compression from linear samples+fine grain in the HTR.

Implements CaloTPGTranscoder.

Definition at line 111 of file CaloTPGTranscoderULUT.cc.

References Exception, getOutputLUTId(), OUTPUT_LUT_SIZE, and outputLUT_.

                                                                                                                                       {
   int itower = getOutputLUTId(id);
 
   if (sample >= OUTPUT_LUT_SIZE) {
     throw cms::Exception("Out of Range") << "LUT has 1024 entries for " << itower << " but " << sample << " was requested.";
     sample=OUTPUT_LUT_SIZE - 1;
   }
 
   return HcalTriggerPrimitiveSample(outputLUT_[itower][sample],fineGrain,0,0);
 }

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

virtual

Implements CaloTPGTranscoder.

Definition at line 135 of file CaloTPGTranscoderULUT.cc.

References getOutputLUTId(), hcaluncomp_, HTvalid(), and TPGMAX.

                                                                                   {
 // This is now an obsolete method; we return the AVERAGE over all the allowed iphi channels if it's invoked
 // The user is encouraged to use hcaletValue(const int& ieta, const int& iphi, const int& compET) instead
 
   double etvalue = 0.;
   if (compET < 0 || compET >= (int) TPGMAX) {
     edm::LogError("CaloTPGTranscoderULUT") << "Compressed value out of range: eta, cET = " << ieta << ", " << compET;
   } else {
     int nphi = 0;
     for (int iphi=1; iphi <= 72; iphi++) {
         if (HTvalid(ieta,iphi)) {
             nphi++;
             int itower = getOutputLUTId(ieta,iphi);
             etvalue += hcaluncomp_[itower][compET];
         }
     }
     if (nphi > 0) {
         etvalue /= nphi;
     } else {
         edm::LogError("CaloTPGTranscoderULUT") << "No decompression LUTs found for any iphi for ieta = " << ieta;
     }
   }
   return(etvalue);
 }

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

virtual

Implements CaloTPGTranscoder.

Definition at line 122 of file CaloTPGTranscoderULUT.cc.

References getOutputLUTId(), hcaluncomp_, and TPGMAX.

                                                                                                    {
   double etvalue = 0.;
   int itower = getOutputLUTId(ieta,iphi);
   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

virtual

Implements CaloTPGTranscoder.

Definition at line 160 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

virtual

Definition at line 182 of file CaloTPGTranscoderULUT.cc.

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

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

                                                                           {
     HcalTrigTowerDetId id(ieta, iphiin);
     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 34 of file CaloTPGTranscoderULUT.cc.

References funct::abs(), Exception, HcalTrigTowerGeometry::firstHFTower(), HcalCondObjectContainer< Item >::getAllChannels(), HcalLutMetadatum::getLutGranularity(), getOutputLUTId(), HcalLutMetadatum::getOutputLutThreshold(), HcalCondObjectContainer< Item >::getValues(), hcaluncomp_, i, cmsHarvester::index, HcalGenericDetId::isHcalDetId(), HcalGenericDetId::isHcalTrigTowerDetId(), dqm-mbProfile::log, min(), nominal_gain_, OUTPUT_LUT_SIZE, outputLUT_, rctlsb_factor_, mathSSE::sqrt(), theTopology, dtDQMClient_cfg::threshold, HcalTrigTowerGeometry::towerEtaBounds(), TPGMAX, HcalTopology::validHT(), relativeConstraints::value, and relval_steps::version.

Referenced by setup().

                                                                                                 {
     // Initialize analytical compression LUT's here
     if (OUTPUT_LUT_SIZE != (unsigned int) 0x400)
         edm::LogError("CaloTPGTranscoderULUT") << "Analytic compression expects 10-bit LUT; found LUT with " << OUTPUT_LUT_SIZE << " entries instead";
 
     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> identityLUT;
 
     // Compute compression LUT
     for (unsigned int i=0; i < OUTPUT_LUT_SIZE; i++) {
     analyticalLUT[i] = (unsigned int)(sqrt(14.94*log(1.+i/14.94)*i) + 0.5);
     identityLUT[i] = min(i, 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())
         edm::LogWarning("CaloTPGTranscoderULUT") << "Encountered invalid HcalDetId " << HcalGenericDetId(*i);
         continue;
     }
     
     HcalTrigTowerDetId id(*i); 
     if(!theTopology->validHT(id)) continue;
 
 
     unsigned int index = getOutputLUTId(id); 
 
     if(index >= outputLUT_.size()){
         outputLUT_.resize(index+1);
         hcaluncomp_.resize(index+1);
     }
 
     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)); 
 
     for (unsigned int i = 0; i < threshold; ++i) outputLUT_[index].push_back(0);
     for (unsigned int i = threshold; i < OUTPUT_LUT_SIZE; ++i){
         LUT value =  isHBHE ? analyticalLUT[i] : identityLUT[i];
         outputLUT_[index].push_back(value);
         }
 
     //now uncompression LUTs
     hcaluncomp_[index].resize(TPGMAX);
 
     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(); 
 
     double factor = isHBHE ?  (nominal_gain_ / cosh_ieta * granularity) : rctlsb_factor_;
 
         LUT tpg = outputLUT_[index][0];
         int low = 0;
         for (unsigned int i = 0; i < OUTPUT_LUT_SIZE; ++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;
     }
 }

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

virtual

Uncompression for the Electron/Photon path in the RCT.

Implements CaloTPGTranscoder.

Definition at line 171 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

virtual

Uncompression for the JET path in the RCT.

Implements CaloTPGTranscoder.

Definition at line 176 of file CaloTPGTranscoderULUT.cc.

References Exception.

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

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

virtual

Definition at line 210 of file CaloTPGTranscoderULUT.cc.

References compressionFile_, decompressionFile_, Exception, HcalLutMetadata::getNominalGain(), HcalLutMetadata::getRctLsb(), loadHCALCompress(), LSB_HBHE, LSB_HF, nominal_gain_, rctlsb_factor_, theTopology, and HcalCondObjectContainerBase::topo().

 {
     theTopology = lutMetadata.topo();
     nominal_gain_ = lutMetadata.getNominalGain();
     float rctlsb =lutMetadata.getRctLsb();
     if (rctlsb != LSB_HBHE && rctlsb != LSB_HF)
     throw cms::Exception("RCTLSB") << " value=" << rctlsb << " (should be " << LSB_HBHE
         << " or " << LSB_HF << ")" << std::endl;
     rctlsb_factor_ = rctlsb;
 
     if (compressionFile_.empty() && decompressionFile_.empty()) {
     loadHCALCompress(lutMetadata,theTrigTowerGeometry);
     }
     else {
     throw cms::Exception("Not Implemented") << "setup of CaloTPGTranscoderULUT from text files";
    }
 }

Member Data Documentation

std::string CaloTPGTranscoderULUT::compressionFile_

private

Definition at line 62 of file CaloTPGTranscoderULUT.h.

Referenced by setup().

std::string CaloTPGTranscoderULUT::decompressionFile_

private

Definition at line 63 of file CaloTPGTranscoderULUT.h.

Referenced by setup().

std::vector<RCTdecompression> CaloTPGTranscoderULUT::hcaluncomp_

private

Definition at line 70 of file CaloTPGTranscoderULUT.h.

Referenced by hcaletValue(), and loadHCALCompress().

std::vector<int> CaloTPGTranscoderULUT::ietah

private

Definition at line 65 of file CaloTPGTranscoderULUT.h.

std::vector<int> CaloTPGTranscoderULUT::ietal

private

Definition at line 64 of file CaloTPGTranscoderULUT.h.

float CaloTPGTranscoderULUT::LSB_HBHE = 0.25f

staticprivate

Definition at line 53 of file CaloTPGTranscoderULUT.h.

Referenced by setup().

float CaloTPGTranscoderULUT::LSB_HF = 0.5f

staticprivate

Definition at line 54 of file CaloTPGTranscoderULUT.h.

Referenced by setup().

std::vector<int> CaloTPGTranscoderULUT::LUTfactor

private

Definition at line 67 of file CaloTPGTranscoderULUT.h.

const bool CaloTPGTranscoderULUT::newHFphi = true

staticprivate

Definition at line 51 of file CaloTPGTranscoderULUT.h.

double CaloTPGTranscoderULUT::nominal_gain_

private

Definition at line 60 of file CaloTPGTranscoderULUT.h.

Referenced by loadHCALCompress(), and setup().

const int CaloTPGTranscoderULUT::NOUTLUTS = 4176

staticprivate

Definition at line 48 of file CaloTPGTranscoderULUT.h.

const unsigned int CaloTPGTranscoderULUT::OUTPUT_LUT_SIZE = 1024

staticprivate

Definition at line 49 of file CaloTPGTranscoderULUT.h.

Referenced by hcalCompress(), and loadHCALCompress().

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

private

Definition at line 69 of file CaloTPGTranscoderULUT.h.

Referenced by CaloTPGTranscoderULUT(), getCompressionLUT(), hcalCompress(), and loadHCALCompress().

double CaloTPGTranscoderULUT::rctlsb_factor_

private

Definition at line 61 of file CaloTPGTranscoderULUT.h.

Referenced by loadHCALCompress(), and setup().

const HcalTopology* CaloTPGTranscoderULUT::theTopology

private

Definition at line 46 of file CaloTPGTranscoderULUT.h.

Referenced by getOutputLUTId(), HTvalid(), loadHCALCompress(), and setup().

const unsigned int CaloTPGTranscoderULUT::TPGMAX = 256

staticprivate

Definition at line 50 of file CaloTPGTranscoderULUT.h.

Referenced by hcaletValue(), and loadHCALCompress().

std::vector<int> CaloTPGTranscoderULUT::ZS

private

Definition at line 66 of file CaloTPGTranscoderULUT.h.

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation