Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
novaddt::EventPrescale Class Reference
Inheritance diagram for novaddt::EventPrescale:
art::EDFilter art::ProducerBase art::Consumer art::EngineCreator art::ProductRegistryHelper

Public Types

using ModuleType = EDFilter
 
using WorkerType = WorkerT< EDFilter >
 
template<typename UserConfig >
using Table = ProducerBase::Table< UserConfig >
 

Public Member Functions

 EventPrescale (fhicl::ParameterSet const &p)
 
virtual ~EventPrescale ()
 
bool filter (art::Event &e) override
 
void endJob () override
 
template<typename PROD , BranchType B = InEvent>
ProductID getProductID (std::string const &instanceName={}) const
 
template<typename PROD , BranchType B>
ProductID getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
 
bool modifiesEvent () const
 
template<typename T , BranchType = InEvent>
ProductToken< Tconsumes (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< Tconsumes (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< TconsumesView (InputTag const &it)
 
template<typename T , BranchType = InEvent>
ProductToken< TmayConsume (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< TmayConsume (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< TmayConsumeView (InputTag const &it)
 
base_engine_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
 
seed_t get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)
 

Static Public Member Functions

static cet::exempt_ptr< Consumernon_module_context ()
 

Static Public Attributes

static constexpr bool Pass {true}
 
static constexpr bool Fail {false}
 

Protected Member Functions

CurrentProcessingContext const * currentContext () const
 
void validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
 
void prepareForJob (fhicl::ParameterSet const &pset)
 
void showMissingConsumes () const
 

Private Attributes

unsigned int _prescale
 prescale factor (1 out of every this many passes are issued as real triggers) More...
 
std::string _mode
 prescale mode, can be either fixed or random More...
 
unsigned int _seed
 random number generator seed More...
 
unsigned int _nEvents = 0
 
unsigned int _nAccepted = 0
 

Detailed Description

Definition at line 29 of file EventPrescale_module.cc.

Member Typedef Documentation

using art::EDFilter::ModuleType = EDFilter
inherited

Definition at line 37 of file EDFilter.h.

template<typename UserConfig >
using art::EDFilter::Table = ProducerBase::Table<UserConfig>
inherited

Definition at line 46 of file EDFilter.h.

using art::EDFilter::WorkerType = WorkerT<EDFilter>
inherited

Definition at line 38 of file EDFilter.h.

Constructor & Destructor Documentation

novaddt::EventPrescale::EventPrescale ( fhicl::ParameterSet const &  p)
explicit

Definition at line 46 of file EventPrescale_module.cc.

References _mode, _prescale, _seed, ana::assert(), om::cout, and allTimeWatchdog::endl.

47 : _prescale (p.get<unsigned int>("prescale" ))
48 , _mode (p.get<std::string >("mode" ))
49 , _seed (p.get<unsigned int>("seed", time(NULL)))
50 {
51  // Call appropriate Produces<>() functions here.
52  std::cout << "--- novaddt::EventPrescale instantiate" << std::endl;
53  std::cout << "\t prescale: " << _prescale << std::endl;
54  std::cout << "\t mode: " << _mode << std::endl;
55  std::cout << "\t seed: " << _seed << std::endl;
56 
57  // assert that the mode requested is configured
58  assert( (_mode == "fixed") || (_mode == "random") );
59 
60  // seed the random number generator, use a random default if not specified
61  // in the configuration file.
62  srand(_seed);
63 }
const char * p
Definition: xmltok.h:285
unsigned int _seed
random number generator seed
OStream cout
Definition: OStream.cxx:6
std::string _mode
prescale mode, can be either fixed or random
assert(nhit_max >=nhit_nbins)
unsigned int _prescale
prescale factor (1 out of every this many passes are issued as real triggers)
enum BeamMode string
novaddt::EventPrescale::~EventPrescale ( )
virtual

Definition at line 65 of file EventPrescale_module.cc.

66 {
67  // Clean up dynamic memory and other resources here.
68 }

Member Function Documentation

template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::consumes ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it)
inherited

Definition at line 146 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

147 {
148  if (!moduleContext_)
149  return ProductToken<T>::invalid();
150 
151  consumables_[BT].emplace_back(ConsumableType::Product,
152  TypeID{typeid(T)},
153  it.label(),
154  it.instance(),
155  it.process());
156  return ProductToken<T>{it};
157 }
set< int >::iterator it
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )
inherited

Definition at line 161 of file Consumer.h.

References T.

162 {
163  if (!moduleContext_)
164  return;
165 
166  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
167 }
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it)
inherited

Definition at line 171 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

172 {
173  if (!moduleContext_)
174  return ViewToken<T>::invalid();
175 
176  consumables_[BT].emplace_back(ConsumableType::ViewElement,
177  TypeID{typeid(T)},
178  it.label(),
179  it.instance(),
180  it.process());
181  return ViewToken<T>{it};
182 }
set< int >::iterator it
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
base_engine_t& art::EngineCreator::createEngine ( seed_t  seed)
inherited
base_engine_t& art::EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make 
)
inherited
base_engine_t& art::EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make,
label_t const &  engine_label 
)
inherited
CurrentProcessingContext const* art::EDFilter::currentContext ( ) const
protectedinherited
void novaddt::EventPrescale::endJob ( )
overridevirtual

Reimplemented from art::EDFilter.

Definition at line 89 of file EventPrescale_module.cc.

References _nAccepted, _nEvents, om::cout, DEFINE_ART_MODULE(), and allTimeWatchdog::endl.

90 {
91  std::cout << "--- novaddt::EventPrescale endJob" << std::endl;
92  std::cout << "\tNumber of events seen: " << _nEvents << std::endl;
93  std::cout << "\tNumber of events accepted: " << _nAccepted << std::endl;
94 }
OStream cout
Definition: OStream.cxx:6
bool novaddt::EventPrescale::filter ( art::Event e)
overridevirtual

Implements art::EDFilter.

Definition at line 70 of file EventPrescale_module.cc.

References _mode, _nAccepted, _nEvents, _prescale, allTimeWatchdog::endl, LOG_DEBUG, and central_limit::rand.

71 {
72  LOG_DEBUG("EventPrescale")<< "--- novaddt::EventPrescale filter. Event: "
73  << event.id().event()
74  << std::endl;
75  _nEvents++;
76 
77  // check prescale
78  if ( ((_mode=="fixed") && ( _nEvents%_prescale == _prescale-1)) ||
79  ((_mode=="random") && (rand()%_prescale == _prescale-1)) ){
80  _nAccepted++;
81  LOG_DEBUG("EventPrescale")<< "\t - not prescaled" << std::endl;
82  return true;
83  } // end of check on prescale
84 
85  // if not accepted by prescale return false
86  return false;
87 }
#define LOG_DEBUG(stream)
Definition: Messenger.h:149
std::string _mode
prescale mode, can be either fixed or random
unsigned int _prescale
prescale factor (1 out of every this many passes are issued as real triggers)
seed_t art::EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset,
char const  key[] = "seed",
seed_t const  implicit_seed = -1 
)
inherited
template<typename PROD , BranchType B>
ProductID art::EDFilter::getProductID ( std::string const &  instanceName = {}) const
inlineinherited

Definition at line 131 of file EDFilter.h.

References art::EDFilter::moduleDescription_.

Referenced by novaddt::HoughTrackMaker::create_associations().

132  {
133  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
134  instanceName);
135  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
template<typename PROD , BranchType B>
ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription,
std::string const &  instanceName 
) const
inherited

Definition at line 56 of file ProducerBase.h.

References art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

58  {
59  auto const& pd =
60  get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
61  return pd.productID();
62  }
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it)
inherited

Definition at line 189 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

190 {
191  if (!moduleContext_)
192  return ProductToken<T>::invalid();
193 
194  consumables_[BT].emplace_back(ConsumableType::Product,
195  TypeID{typeid(T)},
196  it.label(),
197  it.instance(),
198  it.process());
199  return ProductToken<T>{it};
200 }
set< int >::iterator it
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )
inherited

Definition at line 204 of file Consumer.h.

References T.

205 {
206  if (!moduleContext_)
207  return;
208 
209  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
210 }
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it)
inherited

Definition at line 214 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

215 {
216  if (!moduleContext_)
217  return ViewToken<T>::invalid();
218 
219  consumables_[BT].emplace_back(ConsumableType::ViewElement,
220  TypeID{typeid(T)},
221  it.label(),
222  it.instance(),
223  it.process());
224  return ViewToken<T>{it};
225 }
set< int >::iterator it
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
bool art::ProducerBase::modifiesEvent ( ) const
inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID(), and string.

41  {
42  return true;
43  }
static cet::exempt_ptr<Consumer> art::Consumer::non_module_context ( )
staticinherited
void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset)
protectedinherited
void art::Consumer::showMissingConsumes ( ) const
protectedinherited

Referenced by art::RootOutput::endJob().

void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited

Member Data Documentation

std::string novaddt::EventPrescale::_mode
private

prescale mode, can be either fixed or random

Definition at line 39 of file EventPrescale_module.cc.

Referenced by EventPrescale(), and filter().

unsigned int novaddt::EventPrescale::_nAccepted = 0
private

Definition at line 42 of file EventPrescale_module.cc.

Referenced by endJob(), and filter().

unsigned int novaddt::EventPrescale::_nEvents = 0
private

Definition at line 41 of file EventPrescale_module.cc.

Referenced by endJob(), and filter().

unsigned int novaddt::EventPrescale::_prescale
private

prescale factor (1 out of every this many passes are issued as real triggers)

Definition at line 38 of file EventPrescale_module.cc.

Referenced by EventPrescale(), and filter().

unsigned int novaddt::EventPrescale::_seed
private

random number generator seed

Definition at line 40 of file EventPrescale_module.cc.

Referenced by EventPrescale().

constexpr bool art::EDFilter::Fail {false}
staticinherited

Definition at line 33 of file EDFilter.h.

Referenced by evgen::GENIEFilter::filter().

constexpr bool art::EDFilter::Pass {true}
staticinherited

Definition at line 32 of file EDFilter.h.

Referenced by evgen::GENIEFilter::filter().


The documentation for this class was generated from the following file: