#include <L1GtPatternGenerator.h>

Inheritance diagram for L1GtPatternGenerator:

Public Member Functions
	L1GtPatternGenerator (const edm::ParameterSet &)

	~L1GtPatternGenerator () override

Public Member Functions inherited from edm::one::EDAnalyzer<>
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

const EDAnalyzer &	operator= (const EDAnalyzer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

Public Member Functions inherited from edm::one::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDAnalyzerBase () 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 const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > 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 const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Protected Member Functions
void	extractGlobalTriggerData (const edm::Event &iEvent, L1GtPatternMap &patterns)

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

void	resetItemsToGetFrom (BranchType iType)

Private Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override
	analyze each event More...

void	beginJob () override
	analyze More...

void	endJob () override
	end of job More...

void	packHfRecords (const std::string &resultName, L1GtPatternMap &allPatterns)

Static Private Member Functions
static uint32_t	packEtMiss (uint32_t rawValue)

static uint32_t	packRegionalMuons (uint32_t rawValue)

Private Attributes
std::vector< int >	m_bx

std::vector< uint32_t >	m_columnDefaults

std::vector< uint32_t >	m_columnLengths

std::vector< std::string >	m_columnNames

edm::InputTag	m_cscTag

bool	m_debug

std::string	m_destPath
	an algorithm and a condition in that algorithm to test the object maps More...

edm::InputTag	m_dtTag
	input tags for regional muon data More...

std::string	m_fileName
	output file name More...

std::ofstream	m_fileStream

std::string	m_footer

edm::InputTag	m_gctTag
	input tag for GCT data More...

edm::InputTag	m_gmtTag
	input tag for GMT data More...

edm::InputTag	m_gtTag
	input tag for GT data More...

std::string	m_header
	formatting instructions More...

edm::InputTag	m_rpcbTag

edm::InputTag	m_rpcfTag

std::unique_ptr< L1GtPatternWriter >	m_writer

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Static Public Member Functions inherited from edm::one::EDAnalyzerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Detailed Description

Description: A generator of pattern files for L1 GT hardware testing.

Implementation: <TODO: enter implementation details>

Author: : Thomas Themel - HEPHY Vienna

Description: see header file.
Implementation: <TODO: enter implementation details>

Author: : Thomas Themel - HEPHY Vienna

Definition at line 37 of file L1GtPatternGenerator.h.

Constructor & Destructor Documentation

◆ L1GtPatternGenerator()

L1GtPatternGenerator::L1GtPatternGenerator ( const edm::ParameterSet & parSet )

explicit

Definition at line 37 of file L1GtPatternGenerator.cc.

References edm::ParameterSet::getParameter(), LogDebug, m_bx, m_columnDefaults, m_columnLengths, m_columnNames, m_cscTag, m_debug, m_dtTag, m_fileName, m_footer, m_gctTag, m_gmtTag, m_gtTag, m_header, m_rpcbTag, m_rpcfTag, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                         {
   // input tags for trigger records
   m_gctTag = parSet.getParameter<edm::InputTag>("GctInputTag");
   m_gmtTag = parSet.getParameter<edm::InputTag>("GmtInputTag");
   m_gtTag = parSet.getParameter<edm::InputTag>("GtInputTag");
   m_dtTag = parSet.getParameter<edm::InputTag>("DtInputTag");
   m_cscTag = parSet.getParameter<edm::InputTag>("CscInputTag");
   m_rpcbTag = parSet.getParameter<edm::InputTag>("RpcbInputTag");
   m_rpcfTag = parSet.getParameter<edm::InputTag>("RpcfInputTag");
 
   // output formatting stuff
   m_header = parSet.getParameter<std::string>("PatternFileHeader");
   m_footer = parSet.getParameter<std::string>("PatternFileFooter");
   m_columnNames = parSet.getParameter<std::vector<std::string> >("PatternFileColumns");
   m_columnLengths = parSet.getParameter<std::vector<uint32_t> >("PatternFileLengths");
   m_columnDefaults = parSet.getParameter<std::vector<uint32_t> >("PatternFileDefaultValues");
   m_fileName = parSet.getParameter<std::string>("PatternFileName");
   m_bx = parSet.getParameter<std::vector<int> >("bx");
   m_debug = parSet.getParameter<bool>("DebugOutput");
 
   if (m_columnLengths.size() != m_columnNames.size()) {
     edm::LogWarning("L1GtPatternGenerator")
         << "Length of PatternFileColumns does not match length of PatternFileLenghts, " << m_columnNames.size()
         << " vs " << m_columnLengths.size() << std::endl;
   }
 
   LogDebug("L1GtPatternGenerator") << "\nL1 GCT  record:            " << m_gctTag
                                    << "\nL1 GMT record:             " << m_gmtTag
                                    << "\nL1 GT record:              " << m_gtTag << std::endl;
 }

◆ ~L1GtPatternGenerator()

L1GtPatternGenerator::~L1GtPatternGenerator ( )

override

Definition at line 69 of file L1GtPatternGenerator.cc.

69 {}

Member Function Documentation

◆ analyze()

void L1GtPatternGenerator::analyze	(	const edm::Event &	iEvent,
		const edm::EventSetup &	evSetup
	)

overrideprivatevirtual

analyze each event

Analyze each event:

Extract the input records that interest us from the event
Split them into pattern file lines according to their bx number
Format the lines and write them to the file.

Implements edm::one::EDAnalyzerBase.

Definition at line 216 of file L1GtPatternGenerator.cc.

References L1GctEtMiss::et(), extractGlobalTriggerData(), extractRecordData(), L1MuGMTCand::getDataWord(), L1MuRegionalCand::getDataWord(), iEvent, edm::InputTag::instance(), edm::InputTag::label(), LogTrace, m_cscTag, m_dtTag, m_gctTag, m_gmtTag, m_rpcbTag, m_rpcfTag, m_writer, packHfRecords(), packRegionalMuons(), L1GctEtMiss::phi(), L1GctEtTotal::raw(), L1GctEtHad::raw(), L1GctJetCand::raw(), L1GctEmCand::raw(), L1GctHtMiss::raw(), L1GctHFBitCounts::raw(), L1GctHFRingEtSums::raw(), and convertSQLiteXML::runNumber.

                                                                                        {
   // debug information
   const unsigned int runNumber = iEvent.run();
   const unsigned int lsNumber = iEvent.luminosityBlock();
   const unsigned int eventNumber = iEvent.id().event();
 
   LogTrace("L1GtPatternGenerator") << "\n\nL1GtPatternGenerator::analyze: Run: " << runNumber << " LS: " << lsNumber
                                    << " Event: " << eventNumber << "\n\n"
                                    << std::endl;
 
   L1GtPatternMap allPatterns;
 
   // GMT muon candidates
   extractRecordData(iEvent, allPatterns, m_gmtTag.label(), m_gmtTag.instance(), &L1MuGMTCand::getDataWord, "gmtMuon");
 
   // regional muon candidates
   extractRecordData(iEvent,
                     allPatterns,
                     m_cscTag.label(),
                     m_cscTag.instance(),
                     &L1MuRegionalCand::getDataWord,
                     "cscMuon",
                     packRegionalMuons);
   extractRecordData(iEvent,
                     allPatterns,
                     m_dtTag.label(),
                     m_dtTag.instance(),
                     &L1MuRegionalCand::getDataWord,
                     "dtMuon",
                     packRegionalMuons);
   extractRecordData(iEvent,
                     allPatterns,
                     m_rpcfTag.label(),
                     m_rpcfTag.instance(),
                     &L1MuRegionalCand::getDataWord,
                     "fwdMuon",
                     packRegionalMuons);
   extractRecordData(iEvent,
                     allPatterns,
                     m_rpcbTag.label(),
                     m_rpcbTag.instance(),
                     &L1MuRegionalCand::getDataWord,
                     "brlMuon",
                     packRegionalMuons);
 
   // GCT objects
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "nonIsoEm", &L1GctEmCand::raw, "gctEm");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "isoEm", &L1GctEmCand::raw, "gctIsoEm");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctEtMiss::et, "etMiss");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctEtMiss::phi, "etMissPhi");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctHtMiss::raw, "htMiss");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctEtHad::raw, "etHad");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctEtTotal::raw, "etTotal");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "cenJets", &L1GctJetCand::raw, "cenJet");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "forJets", &L1GctJetCand::raw, "forJet");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "tauJets", &L1GctJetCand::raw, "tauJet");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctHFBitCounts::raw, "hfBitCounts");
   extractRecordData(iEvent, allPatterns, m_gctTag.label(), "", &L1GctHFRingEtSums::raw, "hfRingEtSums");
 
   // Post processing:
   // HFBitCounts/HFRingEtSums need to be mangled to PSB values
   packHfRecords("hfPsbValue", allPatterns);
 
   // GT objects
   extractGlobalTriggerData(iEvent, allPatterns);
 
   // Output
   m_writer->writePatterns(allPatterns);
 }

◆ beginJob()

void L1GtPatternGenerator::beginJob ( void )

overrideprivatevirtual

analyze

Method called once each job just before starting event loop.

Initialize the output file and the writer object.

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 289 of file L1GtPatternGenerator.cc.

References m_bx, m_columnDefaults, m_columnLengths, m_columnNames, m_debug, m_fileName, m_fileStream, m_footer, m_header, and m_writer.

                                     {
   m_fileStream.open(m_fileName.c_str());
 
   if (!m_fileStream) {
     edm::LogError("L1GtPatternGenerator") << "Failed to open output file " << m_fileName;
   }
 
   m_writer = std::make_unique<L1GtPatternWriter>(
       m_fileStream, m_header, m_footer, m_columnNames, m_columnLengths, m_columnDefaults, m_bx, m_debug);
 }

◆ endJob()

void L1GtPatternGenerator::endJob ( void )

overrideprivatevirtual

end of job

Method called once each job just after ending the event loop.

Close the output file stream.

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 303 of file L1GtPatternGenerator.cc.

References m_fileStream, and m_writer.

                                   {
   m_writer->close();
   m_fileStream.close();
 }

◆ extractGlobalTriggerData()

void L1GtPatternGenerator::extractGlobalTriggerData	(	const edm::Event &	iEvent,
		L1GtPatternMap &	patterns
	)

protected

Definition at line 158 of file L1GtPatternGenerator.cc.

References nano_mu_digi_cff::bx, Exception, extractGlobalTriggerWord(), L1GtPatternMap::getLine(), patZpeak::handle, iEvent, edm::InputTag::instance(), edm::InputTag::label(), mps_splice::line, and m_gtTag.

Referenced by analyze().

                                                                                                     {
   // extract global trigger readout record
   edm::Handle<L1GlobalTriggerReadoutRecord> handle;
   iEvent.getByLabel(m_gtTag, handle);
 
   // continue if it's present
   if (!handle.isValid()) {
     throw cms::Exception(__func__) << "Failed to extract GT readout record labeled " << m_gtTag.label() << ", instance "
                                    << m_gtTag.instance();
   }
 
   edm::EventNumber_t eventNr = iEvent.id().event();
 
   // for each FDL word...
   const std::vector<L1GtFdlWord>& fdlWords = handle->gtFdlVector();
   for (std::vector<L1GtFdlWord>::const_iterator it = fdlWords.begin(); it != fdlWords.end(); ++it) {
     // extract relevant data
     int bx = it->bxInEvent();
 
     // find matching pattern file line
     L1GtPatternLine& line = patterns.getLine(eventNr, bx);
 
     extractGlobalTriggerWord(it->gtDecisionWord(), line, "gtDecision");
     extractGlobalTriggerWord(it->gtDecisionWordExtended(), line, "gtDecisionExt");
     extractGlobalTriggerWord(it->gtTechnicalTriggerWord(), line, "gtTechTrigger");
 
     line.push("gtFinalOr", it->finalOR());
   }
 }

◆ packEtMiss()

static uint32_t L1GtPatternGenerator::packEtMiss ( uint32_t rawValue )

staticprivate

Post-processing for etMissing

◆ packHfRecords()

void L1GtPatternGenerator::packHfRecords	(	const std::string &	resultName,
		L1GtPatternMap &	allPatterns
	)

private

Post-processing for complex mapping of HF records to PSB values

The mapping from hfBitCounts/hfRingEtSums raw data to the PSBs is non-trivial, see http://wwwhephy.oeaw.ac.at/p3w/electronic1/GlobalTrigger/doc/InterfaceDesc/update_CMS_NOTE_2002_069.pdf

Definition at line 191 of file L1GtPatternGenerator.cc.

References L1GtPatternMap::begin(), dqmiodumpmetadata::counts, and L1GtPatternMap::end().

Referenced by analyze().

                                                                                                  {
   // iterate over each pattern line
   for (L1GtPatternMap::LineMap::iterator it = allPatterns.begin(); it != allPatterns.end(); ++it) {
     // Get the HF bit counts and ring sums
     uint32_t counts = it->second.get("hfBitCounts1");
     uint32_t sums = it->second.get("hfRingEtSums1");
 
     // Bits 0..11 -> 4 bit counts
     uint32_t hfPsbValue = (counts & 0xFFF) |
                           // Bit 12..14 ring 1 pos. rap. HF Et sum
                           (sums & 0x7) << 12 |
                           // Bits 16.. rest of the ET sums
                           (sums >> 3) << 16;
     // TODO: Spec states non-data values for Bits 15, 31, 47 and 63.
 
     // Export computed value to pattern writer. */
     it->second.push(resultName, hfPsbValue);
   }
 }

◆ packRegionalMuons()

uint32_t L1GtPatternGenerator::packRegionalMuons ( uint32_t rawData )

staticprivate

Post-processing for regional muon trigger inputs

Bits 8..15 (5 bits Pt, 3 bits quality) need to be inverted on the GMT inputs. See http://wwwhephy.oeaw.ac.at/p3w/cms/trigger/globalMuonTrigger/notes/in04_022.pdf

Definition at line 151 of file L1GtPatternGenerator.cc.

References l1tstage2_dqm_sourceclient-live_cfg::rawData.

Referenced by analyze().

                                                                  {
   uint32_t invertMask = 0x0000FF00;
   uint32_t toKeep = rawData & (~invertMask);
   return toKeep | (~rawData & invertMask);
 }

Member Data Documentation

◆ m_bx

std::vector<int> L1GtPatternGenerator::m_bx

private

Definition at line 93 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_columnDefaults

std::vector<uint32_t> L1GtPatternGenerator::m_columnDefaults

private

Definition at line 94 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_columnLengths

std::vector<uint32_t> L1GtPatternGenerator::m_columnLengths

private

Definition at line 92 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_columnNames

std::vector<std::string> L1GtPatternGenerator::m_columnNames

private

Definition at line 91 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_cscTag

edm::InputTag L1GtPatternGenerator::m_cscTag

private

Definition at line 76 of file L1GtPatternGenerator.h.

Referenced by analyze(), and L1GtPatternGenerator().

◆ m_debug

bool L1GtPatternGenerator::m_debug

private

Definition at line 95 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_destPath

std::string L1GtPatternGenerator::m_destPath

private

an algorithm and a condition in that algorithm to test the object maps

Definition at line 81 of file L1GtPatternGenerator.h.

◆ m_dtTag

edm::InputTag L1GtPatternGenerator::m_dtTag

private

input tags for regional muon data

Definition at line 75 of file L1GtPatternGenerator.h.

Referenced by analyze(), and L1GtPatternGenerator().

◆ m_fileName

std::string L1GtPatternGenerator::m_fileName

private

output file name

Definition at line 84 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_fileStream

std::ofstream L1GtPatternGenerator::m_fileStream

private

Definition at line 85 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and endJob().

◆ m_footer

std::string L1GtPatternGenerator::m_footer

private

Definition at line 90 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_gctTag

edm::InputTag L1GtPatternGenerator::m_gctTag

private

input tag for GCT data

Definition at line 66 of file L1GtPatternGenerator.h.

Referenced by analyze(), and L1GtPatternGenerator().

◆ m_gmtTag

edm::InputTag L1GtPatternGenerator::m_gmtTag

private

input tag for GMT data

Definition at line 69 of file L1GtPatternGenerator.h.

Referenced by analyze(), and L1GtPatternGenerator().

◆ m_gtTag

edm::InputTag L1GtPatternGenerator::m_gtTag

private

input tag for GT data

Definition at line 72 of file L1GtPatternGenerator.h.

Referenced by extractGlobalTriggerData(), and L1GtPatternGenerator().

◆ m_header

std::string L1GtPatternGenerator::m_header

private

formatting instructions

Definition at line 89 of file L1GtPatternGenerator.h.

Referenced by beginJob(), and L1GtPatternGenerator().

◆ m_rpcbTag

edm::InputTag L1GtPatternGenerator::m_rpcbTag

private

Definition at line 77 of file L1GtPatternGenerator.h.

Referenced by analyze(), and L1GtPatternGenerator().

◆ m_rpcfTag

edm::InputTag L1GtPatternGenerator::m_rpcfTag

private

Definition at line 78 of file L1GtPatternGenerator.h.

Referenced by analyze(), and L1GtPatternGenerator().

◆ m_writer

std::unique_ptr<L1GtPatternWriter> L1GtPatternGenerator::m_writer

private

Definition at line 97 of file L1GtPatternGenerator.h.

Referenced by analyze(), beginJob(), and endJob().

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ L1GtPatternGenerator()

◆ ~L1GtPatternGenerator()

Member Function Documentation

◆ analyze()

◆ beginJob()

◆ endJob()

◆ extractGlobalTriggerData()

◆ packEtMiss()

◆ packHfRecords()

◆ packRegionalMuons()

Member Data Documentation

◆ m_bx

◆ m_columnDefaults

◆ m_columnLengths

◆ m_columnNames

◆ m_cscTag

◆ m_debug

◆ m_destPath

◆ m_dtTag

◆ m_fileName

◆ m_fileStream

◆ m_footer

◆ m_gctTag

◆ m_gmtTag

◆ m_gtTag

◆ m_header

◆ m_rpcbTag

◆ m_rpcfTag

◆ m_writer