L1GctPrintLuts Class Reference

#include <L1Trigger/L1GlobalCaloTrigger/plugins/L1GctPrintLuts.cc>

Inheritance diagram for L1GctPrintLuts:

Public Types
typedef L1GlobalCaloTrigger::lutPtr	lutPtr
	typedefs More...
typedef L1GlobalCaloTrigger::lutPtrVector	lutPtrVector
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
	L1GctPrintLuts (const edm::ParameterSet &)
	~L1GctPrintLuts () override
Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzer ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
ModuleDescription const &	moduleDescription () const
std::string	workerType () const
	~EDAnalyzer () override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override
void	beginJob () override
int	configureGct (const edm::EventSetup &c)
void	endJob () override

Private Attributes
edm::ESGetToken< L1CaloEtScale, L1JetEtScaleRcd >	m_etScaleToken
L1GlobalCaloTrigger *	m_gct
edm::ESGetToken< L1CaloEtScale, L1HfRingEtScaleRcd >	m_hfRingEtScaleToken
std::string	m_hfSumLutOutFileName
std::string	m_htMissLutOutFileName
edm::ESGetToken< L1CaloEtScale, L1HtMissScaleRcd >	m_htMissScaleToken
lutPtrVector	m_jetEtCalibLuts
std::string	m_jetRanksOutFileName
edm::ESGetToken< L1GctJetFinderParams, L1GctJetFinderParamsRcd >	m_jfParsToken

Additional Inherited Members
Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
static bool	wantsGlobalLuminosityBlocks ()
static bool	wantsGlobalRuns ()
static bool	wantsInputProcessBlocks ()
static bool	wantsProcessBlocks ()
static bool	wantsStreamLuminosityBlocks ()
static bool	wantsStreamRuns ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Description: print Gct lookup table contents to a file

Definition at line 45 of file L1GctPrintLuts.h.

Member Typedef Documentation

lutPtr

typedef L1GlobalCaloTrigger::lutPtr L1GctPrintLuts::lutPtr

typedefs

Definition at line 48 of file L1GctPrintLuts.h.

lutPtrVector

typedef L1GlobalCaloTrigger::lutPtrVector L1GctPrintLuts::lutPtrVector

Definition at line 49 of file L1GctPrintLuts.h.

Constructor & Destructor Documentation

L1GctPrintLuts()

L1GctPrintLuts::L1GctPrintLuts ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 23 of file L1GctPrintLuts.cc.

    : m_jetRanksOutFileName(iConfig.getUntrackedParameter<std::string>("jetRanksFilename", "gctJetRanksContents.txt")),
      m_hfSumLutOutFileName(iConfig.getUntrackedParameter<std::string>("hfSumLutFilename", "gctHfSumLutContents.txt")),
      m_htMissLutOutFileName(
          iConfig.getUntrackedParameter<std::string>("htMissLutFilename", "gctHtMissLutContents.txt")),
      m_gct(new L1GlobalCaloTrigger(L1GctJetLeafCard::hardwareJetFinder)),
      m_jetEtCalibLuts() {
  // Fill the jetEtCalibLuts vector
  lutPtr nextLut(new L1GctJetEtCalibrationLut());
 
  for (unsigned ieta = 0; ieta < L1GctJetFinderBase::COL_OFFSET; ieta++) {
    nextLut->setEtaBin(ieta);
    m_jetEtCalibLuts.push_back(nextLut);
    nextLut.reset(new L1GctJetEtCalibrationLut());
  }
  m_jfParsToken = esConsumes<L1GctJetFinderParams, L1GctJetFinderParamsRcd>();
  m_etScaleToken = esConsumes<L1CaloEtScale, L1JetEtScaleRcd>();
  m_htMissScaleToken = esConsumes<L1CaloEtScale, L1HtMissScaleRcd>();
  m_hfRingEtScaleToken = esConsumes<L1CaloEtScale, L1HfRingEtScaleRcd>();
}

References L1GctJetFinderBase::COL_OFFSET, LEDCalibrationChannels::ieta, m_etScaleToken, m_hfRingEtScaleToken, m_htMissScaleToken, m_jetEtCalibLuts, and m_jfParsToken.

~L1GctPrintLuts()

L1GctPrintLuts::~L1GctPrintLuts ( )

override

Definition at line 44 of file L1GctPrintLuts.cc.

                                {
  // do anything here that needs to be done at desctruction time
  // (e.g. close files, deallocate resources etc.)
}

Member Function Documentation

analyze()

void L1GctPrintLuts::analyze ( const edm::Event &  iEvent, const edm::EventSetup &  iSetup  )

overrideprivatevirtual

Implements edm::EDAnalyzer.

Definition at line 54 of file L1GctPrintLuts.cc.

                                                                                {
  // get config data from EventSetup
  // check this has been done successfully before proceeding
  if (configureGct(iSetup) == 0) {
    // Write to a new file
    struct stat buffer;
    if (!stat(m_jetRanksOutFileName.c_str(), &buffer)) {
      edm::LogWarning("LutFileExists") << "File " << m_jetRanksOutFileName
                                       << " already exists. It will not be overwritten." << std::endl;
    } else {
      std::ofstream file;
      file.open(m_jetRanksOutFileName.c_str());
 
      if (file.good()) {
        // Print the calibration lut contents
        file << " Gct lookup table printout \n"
             << "===========================\n\n"
             << "Jet Et Calibration lut contents\n"
             << std::endl;
        for (unsigned ieta = 0; ieta < m_jetEtCalibLuts.size(); ieta++) {
          file << *m_jetEtCalibLuts.at(ieta) << std::endl;
        }
      } else {
        edm::LogWarning("LutFileError") << "Error opening file " << m_jetRanksOutFileName
                                        << ". No lookup tables written." << std::endl;
      }
      file.close();
    }
 
    if (!stat(m_hfSumLutOutFileName.c_str(), &buffer)) {
      edm::LogWarning("LutFileExists") << "File " << m_hfSumLutOutFileName
                                       << " already exists. It will not be overwritten." << std::endl;
    } else {
      std::ofstream file;
      file.open(m_hfSumLutOutFileName.c_str());
 
      if (file.good()) {
        // Print the Hf luts
        file << "\n\n Hf ring jet bit count luts:" << std::endl;
        file << "\n Positive eta, ring1" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getBCLut(L1GctHfEtSumsLut::bitCountPosEtaRing1)
             << std::endl;
        file << "\n Positive eta, ring2" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getBCLut(L1GctHfEtSumsLut::bitCountPosEtaRing2)
             << std::endl;
        file << "\n Negative eta, ring1" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getBCLut(L1GctHfEtSumsLut::bitCountNegEtaRing1)
             << std::endl;
        file << "\n Negative eta, ring2" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getBCLut(L1GctHfEtSumsLut::bitCountNegEtaRing2)
             << std::endl;
        file << "\n\n Hf Et sum luts:" << std::endl;
        file << "\n Positive eta, ring1" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getESLut(L1GctHfEtSumsLut::etSumPosEtaRing1)
             << std::endl;
        file << "\n Positive eta, ring2" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getESLut(L1GctHfEtSumsLut::etSumPosEtaRing2)
             << std::endl;
        file << "\n Negative eta, ring1" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getESLut(L1GctHfEtSumsLut::etSumNegEtaRing1)
             << std::endl;
        file << "\n Negative eta, ring2" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHfSumProcessor()->getESLut(L1GctHfEtSumsLut::etSumNegEtaRing2)
             << std::endl;
      } else {
        edm::LogWarning("LutFileError") << "Error opening file " << m_hfSumLutOutFileName
                                        << ". No lookup tables written." << std::endl;
      }
      file.close();
    }
 
    if (!stat(m_htMissLutOutFileName.c_str(), &buffer)) {
      edm::LogWarning("LutFileExists") << "File " << m_htMissLutOutFileName
                                       << " already exists. It will not be overwritten." << std::endl;
    } else {
      std::ofstream file;
      file.open(m_htMissLutOutFileName.c_str());
 
      if (file.good()) {
        // Print the HtMiss luts
        file << "\n\n missing Ht lut:" << std::endl;
        file << *m_gct->getEnergyFinalStage()->getHtMissLut() << std::endl;
      } else {
        edm::LogWarning("LutFileError") << "Error opening file " << m_hfSumLutOutFileName
                                        << ". No lookup tables written." << std::endl;
      }
      file.close();
    }
  }
}

References L1GctHfEtSumsLut::bitCountNegEtaRing1, L1GctHfEtSumsLut::bitCountNegEtaRing2, L1GctHfEtSumsLut::bitCountPosEtaRing1, L1GctHfEtSumsLut::bitCountPosEtaRing2, edmScanValgrind::buffer, configureGct(), L1GctHfEtSumsLut::etSumNegEtaRing1, L1GctHfEtSumsLut::etSumNegEtaRing2, L1GctHfEtSumsLut::etSumPosEtaRing1, L1GctHfEtSumsLut::etSumPosEtaRing2, FrontierConditions_GlobalTag_cff::file, L1GctGlobalHfSumAlgos::getBCLut(), L1GlobalCaloTrigger::getEnergyFinalStage(), L1GctGlobalHfSumAlgos::getESLut(), L1GctGlobalEnergyAlgos::getHfSumProcessor(), L1GctGlobalEnergyAlgos::getHtMissLut(), LEDCalibrationChannels::ieta, m_gct, m_hfSumLutOutFileName, m_htMissLutOutFileName, m_jetEtCalibLuts, m_jetRanksOutFileName, and edm_modernize_messagelogger::stat.

beginJob()

void L1GctPrintLuts::beginJob ( void  )

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 147 of file L1GctPrintLuts.cc.

{}

configureGct()

int L1GctPrintLuts::configureGct ( const edm::EventSetup &  c )

private

Definition at line 150 of file L1GctPrintLuts.cc.

                                                       {
  int success = 0;
 
  if (success == 0) {
    // get data from EventSetup
    edm::ESHandle<L1GctJetFinderParams> jfPars = c.getHandle(m_jfParsToken);
    edm::ESHandle<L1CaloEtScale> hfRingEtScale = c.getHandle(m_hfRingEtScaleToken);
    edm::ESHandle<L1CaloEtScale> htMissScale = c.getHandle(m_htMissScaleToken);
    edm::ESHandle<L1CaloEtScale> etScale = c.getHandle(m_etScaleToken);
 
    if (jfPars.product() == nullptr) {
      success = -1;
      edm::LogWarning("L1GctConfigFailure")
          << "Failed to find a L1GctJetFinderParamsRcd:L1GctJetFinderParams in EventSetup!" << std::endl;
    }
 
    if (hfRingEtScale.product() == nullptr) {
      success = -1;
      edm::LogWarning("L1GctConfigFailure")
          << "Failed to find a L1HfRingEtScaleRcd:L1CaloEtScale in EventSetup!" << std::endl;
    }
 
    if (htMissScale.product() == nullptr) {
      success = -1;
      edm::LogWarning("L1GctConfigFailure")
          << "Failed to find a L1HtMissScaleRcd:L1CaloEtScale in EventSetup!" << std::endl;
    }
 
    //     if (chanMask.product() == 0) {
    //       success = -1;
    //       edm::LogWarning("L1GctConfigFailure")
    //  << "Failed to find a L1GctChannelMaskRcd:L1GctChannelMask in EventSetup!" << std::endl;
    //     }
 
    if (success == 0) {
      // tell the jet Et Luts about the scales
      for (unsigned ieta = 0; ieta < m_jetEtCalibLuts.size(); ieta++) {
        m_jetEtCalibLuts.at(ieta)->setFunction(jfPars.product());
        m_jetEtCalibLuts.at(ieta)->setOutputEtScale(etScale.product());
      }
 
      // pass all the setup info to the gct
      m_gct->setJetEtCalibrationLuts(m_jetEtCalibLuts);
      m_gct->setJetFinderParams(jfPars.product());
      m_gct->setHtMissScale(htMissScale.product());
      m_gct->setupHfSumLuts(hfRingEtScale.product());
      //      m_gct->setChannelMask(chanMask.product());
    }
  }
 
  if (success != 0) {
    edm::LogError("L1GctConfigError") << "Configuration failed - GCT emulator will not be run" << std::endl;
  }
  return success;
}

References c, photonValidator_cfi::etScale, LEDCalibrationChannels::ieta, m_etScaleToken, m_gct, m_hfRingEtScaleToken, m_htMissScaleToken, m_jetEtCalibLuts, m_jfParsToken, edm::ESHandle< T >::product(), L1GlobalCaloTrigger::setHtMissScale(), L1GlobalCaloTrigger::setJetEtCalibrationLuts(), L1GlobalCaloTrigger::setJetFinderParams(), L1GlobalCaloTrigger::setupHfSumLuts(), and summarizeEdmComparisonLogfiles::success.

Referenced by analyze().

endJob()

void L1GctPrintLuts::endJob ( void  )

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 207 of file L1GctPrintLuts.cc.

{}

Member Data Documentation

m_etScaleToken

edm::ESGetToken<L1CaloEtScale, L1JetEtScaleRcd> L1GctPrintLuts::m_etScaleToken

private

Definition at line 76 of file L1GctPrintLuts.h.

Referenced by configureGct(), and L1GctPrintLuts().

m_gct

L1GlobalCaloTrigger* L1GctPrintLuts::m_gct

private

Definition at line 69 of file L1GctPrintLuts.h.

Referenced by analyze(), and configureGct().

m_hfRingEtScaleToken

edm::ESGetToken<L1CaloEtScale, L1HfRingEtScaleRcd> L1GctPrintLuts::m_hfRingEtScaleToken

private

Definition at line 78 of file L1GctPrintLuts.h.

Referenced by configureGct(), and L1GctPrintLuts().

m_hfSumLutOutFileName

std::string L1GctPrintLuts::m_hfSumLutOutFileName

private

Definition at line 65 of file L1GctPrintLuts.h.

Referenced by analyze().

m_htMissLutOutFileName

std::string L1GctPrintLuts::m_htMissLutOutFileName

private

Definition at line 66 of file L1GctPrintLuts.h.

Referenced by analyze().

m_htMissScaleToken

edm::ESGetToken<L1CaloEtScale, L1HtMissScaleRcd> L1GctPrintLuts::m_htMissScaleToken

private

Definition at line 77 of file L1GctPrintLuts.h.

Referenced by configureGct(), and L1GctPrintLuts().

m_jetEtCalibLuts

lutPtrVector L1GctPrintLuts::m_jetEtCalibLuts

private

Definition at line 72 of file L1GctPrintLuts.h.

Referenced by analyze(), configureGct(), and L1GctPrintLuts().

m_jetRanksOutFileName

std::string L1GctPrintLuts::m_jetRanksOutFileName

private

Definition at line 64 of file L1GctPrintLuts.h.

Referenced by analyze().

m_jfParsToken

edm::ESGetToken<L1GctJetFinderParams, L1GctJetFinderParamsRcd> L1GctPrintLuts::m_jfParsToken

private

Definition at line 75 of file L1GctPrintLuts.h.

Referenced by configureGct(), and L1GctPrintLuts().