NthEvent Class Reference

An art::EDFilter module that passes one out of N events. More...

List of all members.

Public Member Functions

 NthEvent (fhicl::ParameterSet const &p)
 Construct the NthEvent Filter.
 NthEvent (NthEvent const &)
 Plugins should not be copied or assigned.
 NthEvent (NthEvent &&)
 Plugins should not be copied or assigned.
NthEventoperator= (NthEvent const &)
 Plugins should not be copied or assigned.
NthEventoperator= (NthEvent &&)
 Plugins should not be copied or assigned.
bool filter (art::Event &e) override
 Perform the filtering. NthEvent module passes events where event number % nth == 0.

Detailed Description

An art::EDFilter module that passes one out of N events.

Definition at line 28 of file NthEvent_module.cc.


Constructor & Destructor Documentation

NthEvent::NthEvent ( fhicl::ParameterSet const &  p  )  [explicit]

Construct the NthEvent Filter.

Parameters:
p fhicl::ParameterSet for configuring the filter. Parameter "nth", mod of events to pass

Definition at line 66 of file NthEvent_module.cc.


Member Function Documentation

bool NthEvent::filter ( art::Event &  e  )  [inline, override]

Perform the filtering. NthEvent module passes events where event number % nth == 0.

Parameters:
e Event to filter
Returns:
Whether the event passes the filter

Definition at line 70 of file NthEvent_module.cc.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator

Generated on 1 Jun 2017 for artdaq_demo by  doxygen 1.6.1