#include <src/L1Trigger/GlobalCaloTrigger/src/L1GctEmulator.h>

Inheritance diagram for L1GctEmulator:

Public Types
typedef L1GlobalCaloTrigger::lutPtr	lutPtr
	typedefs More...

typedef L1GlobalCaloTrigger::lutPtrVector	lutPtrVector

Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >

using	GlobalCache = typename CacheTypes::GlobalCache

using	HasAbility = AbilityChecker< T... >

using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache

using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache

using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >

using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache

using	RunCache = typename CacheTypes::RunCache

using	RunContext = RunContextT< RunCache, GlobalCache >

using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Public Member Functions
	L1GctEmulator (const edm::ParameterSet &ps)
	constructor More...

Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default

	EDProducer (const EDProducer &)=delete

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

const EDProducer &	operator= (const EDProducer &)=delete

Private Member Functions
int	configureGct (const edm::EventSetup &c)

void	produce (edm::Event &e, const edm::EventSetup &c) override

Private Attributes
edm::ESGetToken< L1GctChannelMask, L1GctChannelMaskRcd >	m_chanMaskToken

const std::string	m_conditionsLabel

edm::EDGetTokenT< L1CaloEmCollection >	m_emToken

edm::ESGetToken< L1CaloEtScale, L1JetEtScaleRcd >	m_etScaleToken

std::unique_ptr< L1GlobalCaloTrigger >	m_gct

edm::ESGetToken< L1CaloEtScale, L1HfRingEtScaleRcd >	m_hfRingEtScaleToken

edm::ESGetToken< L1CaloEtScale, L1HtMissScaleRcd >	m_htMissScaleToken

std::string	m_inputLabel

lutPtrVector	m_jetEtCalibLuts

edm::ESGetToken< L1GctJetFinderParams, L1GctJetFinderParamsRcd >	m_jfParsToken

edm::EDGetTokenT< L1CaloRegionCollection >	m_regionToken

const bool	m_verbose

const bool	m_writeInternalData

Detailed Description

Description: Framework module that runs the GCT bit-level emulator

Implementation: An EDProducer that contains an instance of L1GlobalCaloTrigger.

Definition at line 40 of file L1GctEmulator.h.

Member Typedef Documentation

◆ lutPtr

typedef L1GlobalCaloTrigger::lutPtr L1GctEmulator::lutPtr

typedefs

Definition at line 43 of file L1GctEmulator.h.

◆ lutPtrVector

typedef L1GlobalCaloTrigger::lutPtrVector L1GctEmulator::lutPtrVector

Definition at line 44 of file L1GctEmulator.h.

Constructor & Destructor Documentation

◆ L1GctEmulator()

L1GctEmulator::L1GctEmulator ( const edm::ParameterSet & ps )

explicit

constructor

Definition at line 29 of file L1GctEmulator.cc.

     : m_jetEtCalibLuts(),
       m_writeInternalData(ps.getParameter<bool>("writeInternalData")),
       m_verbose(ps.getUntrackedParameter<bool>("verbose", false)),
       m_conditionsLabel(ps.getParameter<std::string>("conditionsLabel")) {
   // list of products
   produces<L1GctEmCandCollection>("isoEm");
   produces<L1GctEmCandCollection>("nonIsoEm");
   produces<L1GctJetCandCollection>("cenJets");
   produces<L1GctJetCandCollection>("forJets");
   produces<L1GctJetCandCollection>("tauJets");
   produces<L1GctInternJetDataCollection>();
   produces<L1GctEtTotalCollection>();
   produces<L1GctEtHadCollection>();
   produces<L1GctEtMissCollection>();
   produces<L1GctHtMissCollection>();
   produces<L1GctInternEtSumCollection>();
   produces<L1GctInternHtMissCollection>();
   produces<L1GctHFBitCountsCollection>();
   produces<L1GctHFRingEtSumsCollection>();
  
   // get the input label
   edm::InputTag inputTag = ps.getParameter<edm::InputTag>("inputLabel");
   m_inputLabel = inputTag.label();
  
   // Get the number of bunch crossings to be processed
   int firstBx = -ps.getParameter<unsigned>("preSamples");
   int lastBx = ps.getParameter<unsigned>("postSamples");
  
   // instantiate the GCT. Argument selects the type of jetFinder to be used.
   L1GctJetLeafCard::jetFinderType jfType = L1GctJetLeafCard::hardwareJetFinder;
   std::string jfTypeStr = ps.getParameter<std::string>("jetFinderType");
   if (jfTypeStr == "tdrJetFinder") {
     jfType = L1GctJetLeafCard::tdrJetFinder;
   } else if (jfTypeStr != "hardwareJetFinder") {
     edm::LogWarning("L1GctEmulatorSetup")
         << "Unrecognised jetFinder option " << jfTypeStr << "\nHardware jetFinder will be used";
   }
   bool hwTest = ps.getParameter<bool>("hardwareTest");
   if (hwTest) {
     unsigned mask = ps.getUntrackedParameter<unsigned>("jetLeafMask", 0);
     m_gct = std::make_unique<L1GlobalCaloTrigger>(jfType, mask);
     edm::LogWarning("L1GctEmulatorSetup") << "Emulator has been configured in hardware test mode with mask " << mask
                                           << "\nThis mode should NOT be used for Physics studies!";
   } else {
     m_gct = std::make_unique<L1GlobalCaloTrigger>(jfType);
   }
   m_gct->setBxRange(firstBx, lastBx);
  
   // Fill the jetEtCalibLuts vector
   lutPtr nextLut(new L1GctJetEtCalibrationLut());
  
   for (unsigned ieta = 0; ieta < L1GctJetFinderParams::NUMBER_ETA_VALUES; ieta++) {
     nextLut->setEtaBin(ieta);
     m_jetEtCalibLuts.push_back(nextLut);
     nextLut.reset(new L1GctJetEtCalibrationLut());
   }
  
   // Setup the tau algorithm parameters
   bool useImprovedTauAlgo = ps.getParameter<bool>("useImprovedTauAlgorithm");
   bool ignoreTauVetoBitsForIsolation = ps.getParameter<bool>("ignoreRCTTauVetoBitsForIsolation");
   m_gct->setupTauAlgo(useImprovedTauAlgo, ignoreTauVetoBitsForIsolation);
  
   // set verbosity (not implemented yet!)
   //  m_gct->setVerbose(m_verbose);
  
   // print debug info?
   if (m_verbose) {
     m_gct->print();
   }
   m_emToken = consumes<L1CaloEmCollection>(inputTag);
   m_regionToken = consumes<L1CaloRegionCollection>(inputTag);
   m_jfParsToken = esConsumes<L1GctJetFinderParams, L1GctJetFinderParamsRcd>(edm::ESInputTag("", m_conditionsLabel));
   m_chanMaskToken = esConsumes<L1GctChannelMask, L1GctChannelMaskRcd>(edm::ESInputTag("", m_conditionsLabel));
   m_etScaleToken = esConsumes<L1CaloEtScale, L1JetEtScaleRcd>(edm::ESInputTag("", m_conditionsLabel));
   m_htMissScaleToken = esConsumes<L1CaloEtScale, L1HtMissScaleRcd>(edm::ESInputTag("", m_conditionsLabel));
   m_hfRingEtScaleToken = esConsumes<L1CaloEtScale, L1HfRingEtScaleRcd>(edm::ESInputTag("", m_conditionsLabel));
 }

References edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), L1GctJetLeafCard::hardwareJetFinder, LEDCalibrationChannels::ieta, SimL1EmulatorRepack_Full_cff::inputTag, m_chanMaskToken, m_conditionsLabel, m_emToken, m_etScaleToken, m_gct, m_hfRingEtScaleToken, m_htMissScaleToken, m_inputLabel, m_jetEtCalibLuts, m_jfParsToken, m_regionToken, m_verbose, L1GctJetFinderParams::NUMBER_ETA_VALUES, AlCaHLTBitMon_QueryRunRegistry::string, and L1GctJetLeafCard::tdrJetFinder.

Member Function Documentation

◆ configureGct()

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

private

Definition at line 108 of file L1GctEmulator.cc.

                                                       {
   int success = 0;
  
   if (success == 0) {
     // get data from EventSetup
     edm::ESHandle<L1GctJetFinderParams> jfPars = c.getHandle(m_jfParsToken);
     edm::ESHandle<L1GctChannelMask> chanMask = c.getHandle(m_chanMaskToken);
     edm::ESHandle<L1CaloEtScale> etScale = c.getHandle(m_etScaleToken);
     edm::ESHandle<L1CaloEtScale> htMissScale = c.getHandle(m_htMissScaleToken);
     edm::ESHandle<L1CaloEtScale> hfRingEtScale = c.getHandle(m_hfRingEtScaleToken);
  
     if (jfPars.product() == nullptr) {
       success = -1;
       if (m_verbose) {
         edm::LogWarning("L1GctConfigFailure")
             << "Failed to find a L1GctJetFinderParamsRcd:L1GctJetFinderParams in EventSetup!" << std::endl;
       }
     }
  
     if (chanMask.product() == nullptr) {
       success = -1;
       if (m_verbose) {
         edm::LogWarning("L1GctConfigFailure")
             << "Failed to find a L1GctChannelMaskRcd:L1GctChannelMask in EventSetup!" << std::endl;
       }
     }
  
     if (hfRingEtScale.product() == nullptr) {
       success = -1;
       if (m_verbose) {
         edm::LogWarning("L1GctConfigFailure")
             << "Failed to find a L1HfRingEtScaleRcd:L1HfRingEtScaleRcd 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 && m_verbose) {
     edm::LogError("L1GctConfigError") << "Configuration failed - GCT emulator will not be run" << std::endl;
   }
   return success;
 }

References c, photonValidator_cfi::etScale, LEDCalibrationChannels::ieta, m_chanMaskToken, m_etScaleToken, m_gct, m_hfRingEtScaleToken, m_htMissScaleToken, m_jetEtCalibLuts, m_jfParsToken, m_verbose, edm::ESHandle< T >::product(), and summarizeEdmComparisonLogfiles::success.

Referenced by produce().

◆ produce()

void L1GctEmulator::produce	(	edm::Event &	e,
		const edm::EventSetup &	c
	)

overrideprivate

Definition at line 165 of file L1GctEmulator.cc.

                                                                {
   // The emulator will always produce output collections, which get filled as long as
   // the setup and input data are present. Start by making empty output collections.
  
   // create the em and jet collections
   std::unique_ptr<L1GctEmCandCollection> isoEmResult(new L1GctEmCandCollection());
   std::unique_ptr<L1GctEmCandCollection> nonIsoEmResult(new L1GctEmCandCollection());
   std::unique_ptr<L1GctJetCandCollection> cenJetResult(new L1GctJetCandCollection());
   std::unique_ptr<L1GctJetCandCollection> forJetResult(new L1GctJetCandCollection());
   std::unique_ptr<L1GctJetCandCollection> tauJetResult(new L1GctJetCandCollection());
  
   // create the energy sum digis
   std::unique_ptr<L1GctEtTotalCollection> etTotResult(new L1GctEtTotalCollection());
   std::unique_ptr<L1GctEtHadCollection> etHadResult(new L1GctEtHadCollection());
   std::unique_ptr<L1GctEtMissCollection> etMissResult(new L1GctEtMissCollection());
   std::unique_ptr<L1GctHtMissCollection> htMissResult(new L1GctHtMissCollection());
  
   // create the Hf sums digis
   std::unique_ptr<L1GctHFBitCountsCollection> hfBitCountResult(new L1GctHFBitCountsCollection());
   std::unique_ptr<L1GctHFRingEtSumsCollection> hfRingEtSumResult(new L1GctHFRingEtSumsCollection());
  
   // create internal data collections
   std::unique_ptr<L1GctInternJetDataCollection> internalJetResult(new L1GctInternJetDataCollection());
   std::unique_ptr<L1GctInternEtSumCollection> internalEtSumResult(new L1GctInternEtSumCollection());
   std::unique_ptr<L1GctInternHtMissCollection> internalHtMissResult(new L1GctInternHtMissCollection());
  
   // get config data from EventSetup.
   // check this has been done successfully before proceeding
   if (configureGct(c) == 0) {
     // get the RCT data
     edm::Handle<L1CaloEmCollection> em;
     edm::Handle<L1CaloRegionCollection> rgn;
     bool gotEm = e.getByToken(m_emToken, em);
     bool gotRgn = e.getByToken(m_regionToken, rgn);
  
     // check the data
     if (!gotEm && m_verbose) {
       edm::LogError("L1GctInputFailedError") << "Failed to get em candidates with label " << m_inputLabel
                                              << " - GCT emulator will not be run" << std::endl;
     }
  
     if (!gotRgn && m_verbose) {
       edm::LogError("L1GctInputFailedError")
           << "Failed to get calo regions with label " << m_inputLabel << " - GCT emulator will not be run" << std::endl;
     }
  
     if (gotEm && !em.isValid()) {
       gotEm = false;
       if (m_verbose) {
         edm::LogError("L1GctInputFailedError") << "isValid() flag set to false for em candidates with label "
                                                << m_inputLabel << " - GCT emulator will not be run" << std::endl;
       }
     }
  
     if (gotRgn && !rgn.isValid()) {
       gotRgn = false;
       if (m_verbose) {
         edm::LogError("L1GctInputFailedError") << "isValid() flag set to false for calo regions with label "
                                                << m_inputLabel << " - GCT emulator will not be run" << std::endl;
       }
     }
  
     // if all is ok, proceed with GCT processing
     if (gotEm && gotRgn) {
       // reset the GCT internal buffers
       m_gct->reset();
  
       // fill the GCT source cards
       m_gct->fillEmCands(*em);
       m_gct->fillRegions(*rgn);
  
       // process the event
       m_gct->process();
  
       // fill the em and jet collections
       *isoEmResult = m_gct->getIsoElectrons();
       *nonIsoEmResult = m_gct->getNonIsoElectrons();
       *cenJetResult = m_gct->getCentralJets();
       *forJetResult = m_gct->getForwardJets();
       *tauJetResult = m_gct->getTauJets();
  
       // fill the energy sum digis
       *etTotResult = m_gct->getEtSumCollection();
       *etHadResult = m_gct->getEtHadCollection();
       *etMissResult = m_gct->getEtMissCollection();
       *htMissResult = m_gct->getHtMissCollection();
  
       // fill the Hf sums digis
       *hfBitCountResult = m_gct->getHFBitCountsCollection();
       *hfRingEtSumResult = m_gct->getHFRingEtSumsCollection();
  
       // fill internal data collections if required
       if (m_writeInternalData) {
         *internalJetResult = m_gct->getInternalJets();
         *internalEtSumResult = m_gct->getInternalEtSums();
         *internalHtMissResult = m_gct->getInternalHtMiss();
       }
     }
   }
  
   // put the collections into the event
   e.put(std::move(isoEmResult), "isoEm");
   e.put(std::move(nonIsoEmResult), "nonIsoEm");
   e.put(std::move(cenJetResult), "cenJets");
   e.put(std::move(forJetResult), "forJets");
   e.put(std::move(tauJetResult), "tauJets");
   e.put(std::move(etTotResult));
   e.put(std::move(etHadResult));
   e.put(std::move(etMissResult));
   e.put(std::move(htMissResult));
   e.put(std::move(hfBitCountResult));
   e.put(std::move(hfRingEtSumResult));
  
   e.put(std::move(internalJetResult));
   e.put(std::move(internalEtSumResult));
   e.put(std::move(internalHtMissResult));
 }