HLTPrescaler Class Reference

#include <HLTPrescaler.h>

Inheritance diagram for HLTPrescaler:

Public Member Functions
virtual void	beginLuminosityBlock (edm::LuminosityBlock const &lb, edm::EventSetup const &iSetup) override
virtual void	endStream () override
virtual bool	filter (edm::Event &iEvent, edm::EventSetup const &iSetup) override
	HLTPrescaler (edm::ParameterSet const &iConfig, const trigger::Efficiency *efficiency)
virtual	~HLTPrescaler ()
Public Member Functions inherited from edm::stream::EDFilter< edm::GlobalCache< trigger::Efficiency > >
	EDFilter ()=default
Public Member Functions inherited from edm::stream::EDFilterBase
	EDFilterBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDFilterBase ()
Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
virtual	~ProducerBase ()
Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

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::InputTag	gtDigiTag_
	GT payload, to extract the prescale column index. More...
edm::EDGetTokenT < L1GlobalTriggerReadoutRecord >	gtDigiToken_
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
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Protected Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
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 ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
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)

Detailed Description

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

Author

Martin Grunewald

Philipp Schieferdecker

Definition at line 34 of file HLTPrescaler.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 32 of file HLTPrescaler.cc.

References LogDebug, cppFunctionSkipper::operator, and prescaleService_.

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

HLTPrescaler::~HLTPrescaler ( )

virtual

Definition at line 51 of file HLTPrescaler.cc.

{
  
}

Member Function Documentation

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

overridevirtual

Reimplemented from edm::stream::EDFilterBase.

Definition at line 68 of file HLTPrescaler.cc.

References newLumi_.

{
  newLumi_ = true;
}

void HLTPrescaler::endStream ( )

overridevirtual

Reimplemented from edm::stream::EDFilterBase.

Definition at line 129 of file HLTPrescaler.cc.

References acceptCount_, and eventCount_.

{
  //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;
}

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

static

Definition at line 60 of file HLTPrescaler.cc.

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

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

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

overridevirtual

Implements edm::stream::EDFilterBase.

Definition at line 76 of file HLTPrescaler.cc.

References acceptCount_, edm::EventID::event(), eventCount_, edm::Event::getByToken(), edm::Event::getLuminosityBlock(), edm::service::PrescaleService::getPrescale(), gtDigiToken_, patZpeak::handle, edm::LuminosityBlockBase::id(), edm::EventBase::id(), edm::HandleBase::isValid(), edm::LuminosityBlockID::luminosityBlock(), edm::Event::moduleCallingContext(), newLumi_, offsetCount_, offsetPhase_, edm::PlaceInPathContext::pathContext(), edm::PathContext::pathName(), EgammaValidation_cff::pathName, edm::ModuleCallingContext::placeInPathContext(), prescaleFactor_, prescaleSeed_, prescaleService_, prescaleSet_, query::result, and AlCaHLTBitMon_QueryRunRegistry::string.

{
  // 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<L1GlobalTriggerReadoutRecord> handle;
      iEvent.getByToken(gtDigiToken_,handle);
      if (handle.isValid()) {
        prescaleSet_ = handle->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 GT 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;
}

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

static

Definition at line 139 of file HLTPrescaler.cc.

References accept(), trigger::Efficiency::acceptCount_, event(), trigger::Efficiency::eventCount_, and max().

{
  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;
}

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

inlinestatic

Definition at line 43 of file HLTPrescaler.h.

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

Member Data Documentation

unsigned int HLTPrescaler::acceptCount_

private

accept counter

Definition at line 75 of file HLTPrescaler.h.

Referenced by endStream(), and filter().

unsigned int HLTPrescaler::eventCount_

private

event counter

Definition at line 72 of file HLTPrescaler.h.

Referenced by endStream(), and filter().

edm::InputTag HLTPrescaler::gtDigiTag_

private

GT payload, to extract the prescale column index.

Definition at line 88 of file HLTPrescaler.h.

edm::EDGetTokenT<L1GlobalTriggerReadoutRecord> HLTPrescaler::gtDigiToken_

private

Definition at line 89 of file HLTPrescaler.h.

Referenced by filter().

bool HLTPrescaler::newLumi_

private

check for (re)initialization of the prescale

Definition at line 85 of file HLTPrescaler.h.

Referenced by beginLuminosityBlock(), and filter().

unsigned int HLTPrescaler::offsetCount_

private

initial offset

Definition at line 78 of file HLTPrescaler.h.

Referenced by filter().

unsigned int HLTPrescaler::offsetPhase_

private

Definition at line 79 of file HLTPrescaler.h.

Referenced by filter().

unsigned int HLTPrescaler::prescaleFactor_

private

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

Definition at line 69 of file HLTPrescaler.h.

Referenced by filter().

const unsigned int HLTPrescaler::prescaleSeed_ = 65537

staticprivate

"seed" used to initialize the prescale counter

Definition at line 93 of file HLTPrescaler.h.

Referenced by filter().

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

private

prescale service

Definition at line 82 of file HLTPrescaler.h.

Referenced by filter(), and HLTPrescaler().

unsigned int HLTPrescaler::prescaleSet_

private

l1 prescale set index

Definition at line 66 of file HLTPrescaler.h.

Referenced by filter().