artdaq_demo  v3_04_00
NthEvent Class Reference

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

Inheritance diagram for NthEvent:

Public Member Functions

 NthEvent (fhicl::ParameterSet const &p)
 Construct the NthEvent Filter. More...
 
 NthEvent (NthEvent const &)=delete
 Plugins should not be copied or assigned.
 
 NthEvent (NthEvent &&)=delete
 Plugins should not be copied or assigned.
 
NthEventoperator= (NthEvent const &)=delete
 Plugins should not be copied or assigned.
 
NthEventoperator= (NthEvent &&)=delete
 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. More...
 

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
pfhicl::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)
inlineoverride

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

Parameters
eEvent 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: