edm::RandomFilter Class Reference

#include <RandomFilter.h>

Inheritance diagram for edm::RandomFilter:

Public Member Functions
virtual bool	filter (edm::Event &e, edm::EventSetup const &c) override
	RandomFilter (edm::ParameterSet const &ps)
virtual	~RandomFilter ()
Public Member Functions inherited from edm::EDFilter
	EDFilter ()
ModuleDescription const &	moduleDescription () const
virtual	~EDFilter ()
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	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
std::vector< ConsumesInfo >	consumesInfo () const
	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
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Private Attributes
double	acceptRate_

Additional Inherited Members
Public Types inherited from edm::EDFilter
typedef EDFilter	ModuleType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
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::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

Definition at line 28 of file RandomFilter.h.

Constructor & Destructor Documentation

RandomFilter::RandomFilter ( edm::ParameterSet const &  ps )

explicit

Definition at line 14 of file RandomFilter.cc.

References Exception, and edm::Service< T >::isAvailable().

                                                    :
  acceptRate_(ps.getUntrackedParameter<double>("acceptRate")) {
  Service<RandomNumberGenerator> rng;
  if(!rng.isAvailable()) {
    throw cms::Exception("Configuration")
      << "RandomFilter requires the RandomNumberGeneratorService,\n"
         "which is not present in the configuration file.  You must add\n"
         "the service in the configuration file or remove the modules that\n"
         "require it.\n";
  }
}

RandomFilter::~RandomFilter ( )

virtual

Definition at line 26 of file RandomFilter.cc.

                            {
}

Member Function Documentation

bool RandomFilter::filter ( edm::Event &  e, edm::EventSetup const &  c  )

overridevirtual

Implements edm::EDFilter.

Definition at line 29 of file RandomFilter.cc.

References acceptRate_, edm::RandomNumberGenerator::getEngine(), and edm::Event::streamID().

                                                               {
  Service<RandomNumberGenerator> rng;
  CLHEP::HepRandomEngine& engine = rng->getEngine(event.streamID());
  if (engine.flat() < acceptRate_) return true;
  return false;
}

Member Data Documentation

double edm::RandomFilter::acceptRate_

private

Definition at line 38 of file RandomFilter.h.

Referenced by filter().