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	endJob () override
virtual bool	filter (edm::Event &iEvent, edm::EventSetup const &iSetup) override
	HLTPrescaler (edm::ParameterSet const &iConfig)
virtual	~HLTPrescaler ()
Public Member Functions inherited from edm::EDFilter
	EDFilter ()
virtual	~EDFilter ()
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 ()
ProductHolderIndex	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndex > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndex > &) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Private Attributes
unsigned int	acceptCount_
	accept counter More...
unsigned int	eventCount_
	event counter More...
edm::InputTag	gtDigi_
	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::EDFilter
typedef EDFilter	ModuleType
typedef WorkerT< EDFilter >	WorkerType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Static Public Member Functions inherited from edm::EDFilter
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
Protected Member Functions inherited from edm::EDFilter
CurrentProcessingContext const *	currentContext () const
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.

Date:

2013/05/25 14:46:43

Revision:

1.24

Author

Martin Grunewald

Philipp Schieferdecker

Definition at line 24 of file HLTPrescaler.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 29 of file HLTPrescaler.cc.

References LogDebug, cppFunctionSkipper::operator, and prescaleService_.

                                                         :
  prescaleSet_(0)
  , prescaleFactor_(1)
  , eventCount_(0)
  , acceptCount_(0)
  , offsetCount_(0)
  , offsetPhase_(iConfig.existsAs<unsigned int>("offset") ? iConfig.getParameter<unsigned int>("offset") : 0)
  , prescaleService_(0)
  , newLumi_(true)
  , gtDigi_ (iConfig.getParameter<edm::InputTag>("L1GtReadoutRecordTag"))
{
  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 47 of file HLTPrescaler.cc.

{
  
}

Member Function Documentation

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

overridevirtual

Reimplemented from edm::EDFilter.

Definition at line 58 of file HLTPrescaler.cc.

References newLumi_.

{
  newLumi_ = true;
}

void HLTPrescaler::endJob ( void  )

overridevirtual

Reimplemented from edm::EDFilter.

Definition at line 119 of file HLTPrescaler.cc.

References acceptCount_, eventCount_, and max().

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

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

overridevirtual

Implements edm::EDFilter.

Definition at line 66 of file HLTPrescaler.cc.

References acceptCount_, edm::EDFilter::currentContext(), edm::EventID::event(), eventCount_, edm::Event::getByLabel(), edm::Event::getLuminosityBlock(), edm::service::PrescaleService::getPrescale(), gtDigi_, patZpeak::handle, edm::LuminosityBlockBase::id(), edm::EventBase::id(), edm::HandleBase::isValid(), edm::LuminosityBlockID::luminosityBlock(), newLumi_, offsetCount_, offsetPhase_, edm::CurrentProcessingContext::pathName(), EgammaValidation_cff::pathName, 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 = * currentContext()->pathName();
      const unsigned int oldSet(prescaleSet_);
      const unsigned int oldPrescale(prescaleFactor_);

      edm::Handle<L1GlobalTriggerReadoutRecord> handle;
      iEvent.getByLabel(gtDigi_ , 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;
}

Member Data Documentation

unsigned int HLTPrescaler::acceptCount_

private

accept counter

Definition at line 58 of file HLTPrescaler.h.

Referenced by endJob(), and filter().

unsigned int HLTPrescaler::eventCount_

private

event counter

Definition at line 55 of file HLTPrescaler.h.

Referenced by endJob(), and filter().

edm::InputTag HLTPrescaler::gtDigi_

private

GT payload, to extract the prescale column index.

Definition at line 71 of file HLTPrescaler.h.

Referenced by filter().

bool HLTPrescaler::newLumi_

private

check for (re)initialization of the prescale

Definition at line 68 of file HLTPrescaler.h.

Referenced by beginLuminosityBlock(), and filter().

unsigned int HLTPrescaler::offsetCount_

private

initial offset

Definition at line 61 of file HLTPrescaler.h.

Referenced by filter().

unsigned int HLTPrescaler::offsetPhase_

private

Definition at line 62 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 52 of file HLTPrescaler.h.

Referenced by filter().

const unsigned int HLTPrescaler::prescaleSeed_ = 65537

staticprivate

"seed" used to initialize the prescale counter

Definition at line 75 of file HLTPrescaler.h.

Referenced by filter().

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

private

prescale service

Definition at line 65 of file HLTPrescaler.h.

Referenced by filter(), and HLTPrescaler().

unsigned int HLTPrescaler::prescaleSet_

private

l1 prescale set index

Definition at line 49 of file HLTPrescaler.h.

Referenced by filter().