#include <HLTPrescaler.h>

Inheritance diagram for HLTPrescaler:

Public Member Functions
void	beginLuminosityBlock (edm::LuminosityBlock const &lb, edm::EventSetup const &iSetup) override

void	endStream () override

bool	filter (edm::Event &iEvent, edm::EventSetup const &iSetup) override

	HLTPrescaler (edm::ParameterSet const &iConfig, const trigger::Efficiency *efficiency)

	~HLTPrescaler () override

Public Member Functions inherited from edm::stream::EDFilter< edm::GlobalCache< trigger::Efficiency > >
	EDFilter ()=default

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndRuns () const final

Public Member Functions inherited from edm::stream::EDFilterBase
	EDFilterBase ()

ModuleDescription const &	moduleDescription () const

	~EDFilterBase () override

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

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

std::vector< bool > const &	recordProvenanceList () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~ProducerBase () noexcept(false) 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

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::vector< ModuleDescription const * > &modules, 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)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

static void	globalEndJob (const trigger::Efficiency *efficiency)

static std::unique_ptr< trigger::Efficiency >	initializeGlobalCache (edm::ParameterSet const &)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Attributes
unsigned int	acceptCount_
	accept counter More...

unsigned int	eventCount_
	event counter More...

edm::EDGetTokenT< L1GlobalTriggerReadoutRecord >	gtDigi1Token_

edm::EDGetTokenT< GlobalAlgBlkBxCollection >	gtDigi2Token_

edm::InputTag	gtDigiTag_
	GT payload, to extract the prescale column index. More...

bool	newLumi_
	check for (re)initialization of the prescale More...

unsigned int	offsetCount_
	initial offset More...

unsigned int	offsetPhase_

unsigned int	prescaleFactor_
	accept one in prescaleFactor_; 0 means never to accept an event More...

edm::service::PrescaleService *	prescaleService_
	prescale service More...

unsigned int	prescaleSet_
	l1 prescale set index More...

Static Private Attributes
static const unsigned int	prescaleSeed_ = 65537
	"seed" used to initialize the prescale counter More...

Additional Inherited Members
Public Types inherited from edm::stream::EDFilter< edm::GlobalCache< trigger::Efficiency > >
typedef CacheContexts< T... >	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T... >	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDFilterBase
typedef EDFilterAdaptorBase	ModuleType

Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex > >

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

ProducesCollector	producesCollector ()

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

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

This class is an EDFilter implementing an HLT Prescaler module with associated book keeping.

Author: Martin Grunewald; Philipp Schieferdecker

Definition at line 40 of file HLTPrescaler.h.

Constructor & Destructor Documentation

◆ HLTPrescaler()

HLTPrescaler::HLTPrescaler	(	edm::ParameterSet const &	iConfig,
		const trigger::Efficiency *	efficiency
	)

explicit

Definition at line 30 of file HLTPrescaler.cc.

     : prescaleSet_(0),
       prescaleFactor_(1),
       eventCount_(0),
       acceptCount_(0),
       offsetCount_(0),
       offsetPhase_(iConfig.getParameter<unsigned int>("offset")),
       prescaleService_(nullptr),
       newLumi_(true),
       gtDigiTag_(iConfig.getParameter<edm::InputTag>("L1GtReadoutRecordTag")),
       gtDigi1Token_(consumes<L1GlobalTriggerReadoutRecord>(gtDigiTag_)),
       gtDigi2Token_(consumes<GlobalAlgBlkBxCollection>(gtDigiTag_)) {
   if (edm::Service<edm::service::PrescaleService>().isAvailable())
     prescaleService_ = edm::Service<edm::service::PrescaleService>().operator->();
   else
     LogDebug("NoPrescaleService") << "PrescaleService unavailable, prescaleFactor=1!";
 }

References LogDebug, and prescaleService_.

◆ ~HLTPrescaler()

HLTPrescaler::~HLTPrescaler ( )

overridedefault

Member Function Documentation

◆ beginLuminosityBlock()

void HLTPrescaler::beginLuminosityBlock	(	edm::LuminosityBlock const &	lb,
		edm::EventSetup const &	iSetup
	)

overridevirtual

Reimplemented from edm::stream::EDFilterBase.

Definition at line 63 of file HLTPrescaler.cc.

                                                                                                  {
   newLumi_ = true;
 }

References newLumi_.

◆ endStream()

void HLTPrescaler::endStream ( )

overridevirtual

Reimplemented from edm::stream::EDFilterBase.

Definition at line 132 of file HLTPrescaler.cc.

                              {
   //since these are std::atomic, it is safe to increment them
   // even if multiple endStreams are being called.
   globalCache()->eventCount_ += eventCount_;
   globalCache()->acceptCount_ += acceptCount_;
   return;
 }

References acceptCount_, and eventCount_.

◆ fillDescriptions()

void HLTPrescaler::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 55 of file HLTPrescaler.cc.

                                                                               {
   edm::ParameterSetDescription desc;
   desc.add<unsigned int>("offset", 0);
   desc.add<edm::InputTag>("L1GtReadoutRecordTag", edm::InputTag("hltGtStage2Digis"));
   descriptions.add("hltPrescaler", desc);
 }

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), and HLT_2018_cff::InputTag.

◆ filter()

bool HLTPrescaler::filter	(	edm::Event &	iEvent,
		edm::EventSetup const &	iSetup
	)

overridevirtual

Implements edm::stream::EDFilterBase.

Definition at line 68 of file HLTPrescaler.cc.

                                                                 {
   // during the first event of a LumiSection, read from the GT the prescale index for this
   // LumiSection and get the corresponding prescale factor from the PrescaleService
   if (newLumi_) {
     newLumi_ = false;
  
     bool needsInit(eventCount_ == 0);
  
     if (prescaleService_) {
       std::string const& pathName = iEvent.moduleCallingContext()->placeInPathContext()->pathContext()->pathName();
       const unsigned int oldSet(prescaleSet_);
       const unsigned int oldPrescale(prescaleFactor_);
  
       edm::Handle<GlobalAlgBlkBxCollection> handle2;
       iEvent.getByToken(gtDigi2Token_, handle2);
       if (handle2.isValid()) {
         if (handle2->begin(0) != handle2->end(0)) {
           prescaleSet_ = static_cast<unsigned int>(handle2->begin(0)->getPreScColumn());
           prescaleFactor_ = prescaleService_->getPrescale(prescaleSet_, pathName);
         } else {
           edm::LogWarning("HLT")
               << "Cannot read prescale column index from GT2 data: using default as defined by configuration or DAQ";
           prescaleFactor_ = prescaleService_->getPrescale(pathName);
         }
       } else {
         edm::Handle<L1GlobalTriggerReadoutRecord> handle1;
         iEvent.getByToken(gtDigi1Token_, handle1);
         if (handle1.isValid()) {
           prescaleSet_ = handle1->gtFdlWord().gtPrescaleFactorIndexAlgo();
           // gtPrescaleFactorIndexTech() is also available
           // by construction, they should always return the same index
           prescaleFactor_ = prescaleService_->getPrescale(prescaleSet_, pathName);
         } else {
           edm::LogWarning("HLT")
               << "Cannot read prescale column index from GT1 data: using default as defined by configuration or DAQ";
           prescaleFactor_ = prescaleService_->getPrescale(pathName);
         }
       }
  
       if (prescaleSet_ != oldSet) {
         edm::LogInfo("ChangedPrescale") << "lumiBlockNb = " << iEvent.getLuminosityBlock().id().luminosityBlock()
                                         << ", set = " << prescaleSet_ << " [" << oldSet << "]"
                                         << ", path = " << pathName << ": " << prescaleFactor_ << " [" << oldPrescale
                                         << "]";
         // reset the prescale counter
         needsInit = true;
       }
     }
  
     if (needsInit && (prescaleFactor_ != 0)) {
       // initialize the prescale counter to the first event number multiplied by a big "seed"
       offsetCount_ = ((uint64_t)(iEvent.id().event() + offsetPhase_) * prescaleSeed_) % prescaleFactor_;
     }
   }
  
   const bool result((prescaleFactor_ == 0) ? false : ((eventCount_ + offsetCount_) % prescaleFactor_ == 0));
  
   ++eventCount_;
   if (result)
     ++acceptCount_;
   return result;
 }

References acceptCount_, BXVector< T >::begin(), BXVector< T >::end(), eventCount_, edm::service::PrescaleService::getPrescale(), gtDigi1Token_, gtDigi2Token_, L1GlobalTriggerReadoutRecord::gtFdlWord(), L1GtFdlWord::gtPrescaleFactorIndexAlgo(), iEvent, edm::HandleBase::isValid(), newLumi_, offsetCount_, offsetPhase_, hltMonBTagIPClient_cfi::pathName, prescaleFactor_, prescaleSeed_, prescaleService_, prescaleSet_, mps_fire::result, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ globalEndJob()

void HLTPrescaler::globalEndJob ( const trigger::Efficiency * efficiency )

static

Definition at line 141 of file HLTPrescaler.cc.

                                                                    {
   unsigned int accept(efficiency->acceptCount_);
   unsigned int event(efficiency->eventCount_);
   edm::LogInfo("PrescaleSummary") << accept << "/" << event << " ("
                                   << 100. * accept / static_cast<double>(std::max(1u, event))
                                   << "% of events accepted).";
   return;
 }

References accept(), L1TObjectsTimingClient_cff::efficiency, event(), and SiStripPI::max.

◆ initializeGlobalCache()

static std::unique_ptr<trigger::Efficiency> HLTPrescaler::initializeGlobalCache ( edm::ParameterSet const & )

inlinestatic

Definition at line 48 of file HLTPrescaler.h.

                                                                                         {
     return std::unique_ptr<trigger::Efficiency>(new trigger::Efficiency());
   }

Member Data Documentation

◆ acceptCount_

unsigned int HLTPrescaler::acceptCount_

private

accept counter

Definition at line 76 of file HLTPrescaler.h.

Referenced by endStream(), and filter().

◆ eventCount_

unsigned int HLTPrescaler::eventCount_

private

event counter

Definition at line 73 of file HLTPrescaler.h.

Referenced by endStream(), and filter().

◆ gtDigi1Token_

edm::EDGetTokenT<L1GlobalTriggerReadoutRecord> HLTPrescaler::gtDigi1Token_

private

Definition at line 90 of file HLTPrescaler.h.

Referenced by filter().

◆ gtDigi2Token_

edm::EDGetTokenT<GlobalAlgBlkBxCollection> HLTPrescaler::gtDigi2Token_

private

Definition at line 91 of file HLTPrescaler.h.

Referenced by filter().

◆ gtDigiTag_

edm::InputTag HLTPrescaler::gtDigiTag_

private

GT payload, to extract the prescale column index.

Definition at line 89 of file HLTPrescaler.h.

◆ newLumi_

bool HLTPrescaler::newLumi_

private

check for (re)initialization of the prescale

Definition at line 86 of file HLTPrescaler.h.

Referenced by beginLuminosityBlock(), and filter().

◆ offsetCount_

unsigned int HLTPrescaler::offsetCount_

private

initial offset

Definition at line 79 of file HLTPrescaler.h.

Referenced by filter().

◆ offsetPhase_

unsigned int HLTPrescaler::offsetPhase_

private

Definition at line 80 of file HLTPrescaler.h.

Referenced by filter().

◆ prescaleFactor_

unsigned int HLTPrescaler::prescaleFactor_

private

accept one in prescaleFactor_; 0 means never to accept an event

Definition at line 70 of file HLTPrescaler.h.

Referenced by filter().

◆ prescaleSeed_

const unsigned int HLTPrescaler::prescaleSeed_ = 65537

staticprivate

"seed" used to initialize the prescale counter

Definition at line 94 of file HLTPrescaler.h.

Referenced by filter().

◆ prescaleService_

edm::service::PrescaleService* HLTPrescaler::prescaleService_

private

prescale service

Definition at line 83 of file HLTPrescaler.h.

Referenced by filter(), and HLTPrescaler().

◆ prescaleSet_

unsigned int HLTPrescaler::prescaleSet_

private

l1 prescale set index

Definition at line 67 of file HLTPrescaler.h.

Referenced by filter().

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HLTPrescaler()

◆ ~HLTPrescaler()

Member Function Documentation

◆ beginLuminosityBlock()

◆ endStream()

◆ fillDescriptions()

◆ filter()

◆ globalEndJob()

◆ initializeGlobalCache()

Member Data Documentation

◆ acceptCount_

◆ eventCount_

◆ gtDigi1Token_

◆ gtDigi2Token_

◆ gtDigiTag_

◆ newLumi_

◆ offsetCount_

◆ offsetPhase_

◆ prescaleFactor_

◆ prescaleSeed_

◆ prescaleService_

◆ prescaleSet_