HLTEventNumberFilter Class Reference

#include <filter/HLTEventNumberFilter/src/HLTEventNumberFilter.cc>

Inheritance diagram for HLTEventNumberFilter:

Public Member Functions
	HLTEventNumberFilter (const edm::ParameterSet &)
	~HLTEventNumberFilter () override
Public Member Functions inherited from edm::EDFilter
	EDFilter ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
ModuleDescription const &	moduleDescription () const
	~EDFilter () 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
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)
	~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 const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
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 const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
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 Public Member Functions inherited from edm::EDFilter
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
static bool	wantsGlobalLuminosityBlocks ()
static bool	wantsGlobalRuns ()
static bool	wantsStreamLuminosityBlocks ()
static bool	wantsStreamRuns ()

Private Member Functions
bool	filter (edm::Event &, const edm::EventSetup &) override

Private Attributes
bool	invert_
	if invert_=true, invert that event accept decision More...
unsigned int	period_
	accept the event if its event number is a multiple of period_ More...

Additional Inherited Members
Public Types inherited from edm::EDFilter
typedef EDFilter	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::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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
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

Description:

Implementation: <Notes on="" implementation>="">

Description: Filter to select HCAL abort gap events

Implementation: <Notes on="" implementation>="">

Definition at line 38 of file HLTEventNumberFilter.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 33 of file HLTEventNumberFilter.cc.

References edm::ParameterSet::getParameter(), invert_, and period_.

{
  //now do what ever initialization is needed

  period_ = iConfig.getParameter<unsigned int>("period") ;
  invert_ = iConfig.getParameter<bool>("invert") ;
}

HLTEventNumberFilter::~HLTEventNumberFilter ( )

override

Definition at line 42 of file HLTEventNumberFilter.cc.

{
 
  // do anything here that needs to be done at desctruction time
  // (e.g. close files, deallocate resources etc.)

}

Member Function Documentation

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

static

Definition at line 51 of file HLTEventNumberFilter.cc.

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

                                                                                 {
  edm::ParameterSetDescription desc;
  desc.add<int>("period",4096);
  desc.add<bool>("invert",true);
  descriptions.add("hltEventNumberFilter",desc);
}

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

overrideprivate

Definition at line 64 of file HLTEventNumberFilter.cc.

References accept(), DEFINE_FWK_MODULE, edm::EventID::event(), edm::EventBase::id(), invert_, edm::EventBase::isRealData(), and period_.

{
  using namespace edm;

  if (iEvent.isRealData()) {
    bool accept(false);
    if (period_!=0) accept = ( ( (iEvent.id().event())%period_ ) == 0 );
    if (invert_) accept = !accept;
    return accept;
  } else {
    return true;
  }

}

Member Data Documentation

bool HLTEventNumberFilter::invert_

private

if invert_=true, invert that event accept decision

Definition at line 52 of file HLTEventNumberFilter.h.

Referenced by filter(), and HLTEventNumberFilter().

unsigned int HLTEventNumberFilter::period_

private

accept the event if its event number is a multiple of period_

Definition at line 50 of file HLTEventNumberFilter.h.

Referenced by filter(), and HLTEventNumberFilter().