Public Types | Public Member Functions | Private Member Functions | List of all members
art::EDFilter Class Referenceabstract

#include <EDFilter.h>

Inheritance diagram for art::EDFilter:
art::detail::Filter art::detail::LegacyModule art::Modifier art::ModuleBase art::ProductRegistryHelper art::MixFilter< T, IOPolicy > art::test::DummyFilter arttest::PMTestFilter cluster::SmallClusterFilter CosmicFilter dune::CounterFilter DuneEventFilter filt::FinalStateParticleFilter filt::GenFilter filt::LArG4ExtCounterFilter filt::LArG4ParticleFilter filt::NucleonDecayFilter filt::ProtoDUNEFembFilter filt::ProtoDUNETriggerFilter filter::ADCFilter filter::EventFilter filter::EventTimeFilter filter::MuonFilter filter::ProtoDUNEUnstableHVFilter gar::filt::FSPEventFilter hit::NumberOfHitsFilter mpf::MissingProductFilter PionAbsCexSelection PrimaryPionSelection protoana::ProtoDUNEBeamlineFilter protoana::ProtoDUNETruthBeamFilter simfilter::FilterCryostatNus simfilter::FilterGenInTime simfilter::FilterNoDirtNeutrinos simfilter::FilterPrimaryPDG

Public Types

using ModuleType = EDFilter
 
using WorkerType = WorkerT< EDFilter >
 
- Public Types inherited from art::detail::Filter
template<typename UserConfig >
using Table = Modifier::Table< UserConfig >
 
- Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >
 

Public Member Functions

 EDFilter (fhicl::ParameterSet const &pset)
 
template<typename Config >
 EDFilter (Table< Config > const &config)
 
std::string workerType () const
 
- Public Member Functions inherited from art::detail::Filter
virtual ~Filter () noexcept
 
 Filter (fhicl::ParameterSet const &)
 
 Filter (Filter const &)=delete
 
 Filter (Filter &&)=delete
 
Filter & operator= (Filter const &)=delete
 
Filter & operator= (Filter &&)=delete
 
void doBeginJob (SharedResources const &resources)
 
void doEndJob ()
 
void doRespondToOpenInputFile (FileBlock const &fb)
 
void doRespondToCloseInputFile (FileBlock const &fb)
 
void doRespondToOpenOutputFiles (FileBlock const &fb)
 
void doRespondToCloseOutputFiles (FileBlock const &fb)
 
bool doBeginRun (RunPrincipal &rp, ModuleContext const &)
 
bool doEndRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
 
- Public Member Functions inherited from art::Modifier
 ~Modifier () noexcept
 
 Modifier ()
 
 Modifier (Modifier const &)=delete
 
 Modifier (Modifier &&)=delete
 
Modifier & operator= (Modifier const &)=delete
 
Modifier & operator= (Modifier &&)=delete
 
- Public Member Functions inherited from art::ModuleBase
virtual ~ModuleBase () noexcept
 
 ModuleBase ()
 
ModuleDescription const & moduleDescription () const
 
void setModuleDescription (ModuleDescription const &)
 
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables () const
 
void sortConsumables (std::string const &current_process_name)
 
template<typename T , BranchType BT>
ViewToken< T > consumesView (InputTag const &tag)
 
template<typename T , BranchType BT>
ViewToken< T > mayConsumeView (InputTag const &tag)
 

Private Member Functions

void setupQueues (detail::SharedResources const &resources) override final
 
void beginJobWithFrame (ProcessingFrame const &) override final
 
void endJobWithFrame (ProcessingFrame const &) override final
 
void respondToOpenInputFileWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void respondToCloseInputFileWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void respondToOpenOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void respondToCloseOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
bool beginRunWithFrame (Run &, ProcessingFrame const &) override final
 
bool endRunWithFrame (Run &, ProcessingFrame const &) override final
 
bool beginSubRunWithFrame (SubRun &, ProcessingFrame const &) override final
 
bool endSubRunWithFrame (SubRun &, ProcessingFrame const &) override final
 
bool filterWithFrame (Event &, ProcessingFrame const &) override final
 
virtual void beginJob ()
 
virtual void endJob ()
 
virtual void respondToOpenInputFile (FileBlock const &)
 
virtual void respondToCloseInputFile (FileBlock const &)
 
virtual void respondToOpenOutputFiles (FileBlock const &)
 
virtual void respondToCloseOutputFiles (FileBlock const &)
 
virtual bool beginRun (Run &)
 
virtual bool endRun (Run &)
 
virtual bool beginSubRun (SubRun &)
 
virtual bool endSubRun (SubRun &)
 
virtual bool filter (Event &)=0
 
- Private Member Functions inherited from art::detail::LegacyModule
 LegacyModule (std::string const &module_label)
 
ScheduleID scheduleID () const noexcept
 
- Private Member Functions inherited from art::detail::SharedModule
 SharedModule ()
 
 SharedModule (std::string const &moduleLabel)
 
hep::concurrency::SerialTaskQueueChain * serialTaskQueueChain () const
 
std::set< std::string > const & sharedResources () const
 
void createQueues (SharedResources const &resources)
 
template<BranchType , typename... T>
void serialize (T const &...resources)
 
template<BranchType , typename... T>
void serializeExternal (T const &...resources)
 
template<BranchType BT = InEvent, typename... T>
void serialize (T const &...)
 
template<BranchType BT = InEvent, typename... T>
void serializeExternal (T const &...)
 
template<BranchType BT = InEvent>
void async ()
 

Additional Inherited Members

- Static Public Attributes inherited from art::detail::Filter
static constexpr bool Pass {true}
 
static constexpr bool Fail {false}
 
- Protected Member Functions inherited from art::ModuleBase
ConsumesCollector & consumesCollector ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
- Private Types inherited from art::detail::LegacyModule
using base_engine_t = EngineCreator::base_engine_t
 
using seed_t = EngineCreator::seed_t
 
using label_t = EngineCreator::label_t
 

Detailed Description

Definition at line 16 of file EDFilter.h.

Member Typedef Documentation

using art::EDFilter::ModuleType = EDFilter

Definition at line 18 of file EDFilter.h.

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

Definition at line 19 of file EDFilter.h.

Constructor & Destructor Documentation

art::EDFilter::EDFilter ( fhicl::ParameterSet const &  pset)
inlineexplicit

Definition at line 21 of file EDFilter.h.

22  : detail::Filter{pset}
23  , detail::LegacyModule{pset.get<std::string>("module_label")}
24  {}
string
std::string string
Definition: nybbler.cc:12
template<typename Config >
art::EDFilter::EDFilter ( Table< Config > const &  config)
inlineexplicit

Definition at line 27 of file EDFilter.h.

27  : EDFilter{config.get_PSet()}
28  {}
config
static Config * config
Definition: config.cpp:1054
art::EDFilter::EDFilter
EDFilter(fhicl::ParameterSet const &pset)
Definition: EDFilter.h:21

Member Function Documentation

void art::EDFilter::beginJob ( )
privatevirtual

Reimplemented in filt::NucleonDecayFilter, filter::ProtoDUNEUnstableHVFilter, protoana::ProtoDUNETruthBeamFilter, gar::filt::FSPEventFilter, simfilter::FilterGenInTime, mpf::MissingProductFilter, protoana::ProtoDUNEBeamlineFilter, filt::FinalStateParticleFilter, hit::NumberOfHitsFilter, filt::ProtoDUNEFembFilter, filt::GenFilter, and filt::LArG4ExtCounterFilter.

Definition at line 91 of file EDFilter.cc.

92  {}
void art::EDFilter::beginJobWithFrame ( ProcessingFrame const &  )
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 47 of file EDFilter.cc.

48  {
49  beginJob();
50  }
art::EDFilter::beginJob
virtual void beginJob()
Definition: EDFilter.cc:91
bool art::EDFilter::beginRun ( Run &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >, and hit::NumberOfHitsFilter.

Definition at line 115 of file EDFilter.cc.

116  {
117  return true;
118  }
bool art::EDFilter::beginRunWithFrame ( Run &  r,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 59 of file EDFilter.cc.

60  {
61  return beginRun(r);
62  }
art::EDFilter::beginRun
virtual bool beginRun(Run &)
Definition: EDFilter.cc:115
plot_model.r
r
Definition: plot_model.py:57
bool art::EDFilter::beginSubRun ( SubRun &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 127 of file EDFilter.cc.

128  {
129  return true;
130  }
bool art::EDFilter::beginSubRunWithFrame ( SubRun &  sr,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 71 of file EDFilter.cc.

72  {
73  return beginSubRun(sr);
74  }
art::EDFilter::beginSubRun
virtual bool beginSubRun(SubRun &)
Definition: EDFilter.cc:127
genie::units::sr
static constexpr double sr
Definition: Units.h:166
void art::EDFilter::endJob ( )
privatevirtual

Reimplemented in protoana::ProtoDUNETruthBeamFilter, filter::ProtoDUNEUnstableHVFilter, protoana::ProtoDUNEBeamlineFilter, mpf::MissingProductFilter, and hit::NumberOfHitsFilter.

Definition at line 95 of file EDFilter.cc.

96  {}
void art::EDFilter::endJobWithFrame ( ProcessingFrame const &  )
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 53 of file EDFilter.cc.

54  {
55  endJob();
56  }
art::EDFilter::endJob
virtual void endJob()
Definition: EDFilter.cc:95
bool art::EDFilter::endRun ( Run &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 121 of file EDFilter.cc.

122  {
123  return true;
124  }
bool art::EDFilter::endRunWithFrame ( Run &  r,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 65 of file EDFilter.cc.

66  {
67  return endRun(r);
68  }
art::EDFilter::endRun
virtual bool endRun(Run &)
Definition: EDFilter.cc:121
plot_model.r
r
Definition: plot_model.py:57
bool art::EDFilter::endSubRun ( SubRun &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 133 of file EDFilter.cc.

134  {
135  return true;
136  }
bool art::EDFilter::endSubRunWithFrame ( SubRun &  sr,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 77 of file EDFilter.cc.

78  {
79  return endSubRun(sr);
80  }
art::EDFilter::endSubRun
virtual bool endSubRun(SubRun &)
Definition: EDFilter.cc:133
genie::units::sr
static constexpr double sr
Definition: Units.h:166
virtual bool art::EDFilter::filter ( Event &  )
privatepure virtual

Implemented in art::MixFilter< T, IOPolicy >, PrimaryPionSelection, filt::NucleonDecayFilter, PionAbsCexSelection, protoana::ProtoDUNETruthBeamFilter, filter::ProtoDUNEUnstableHVFilter, CosmicFilter, gar::filt::FSPEventFilter, filter::MuonFilter, DuneEventFilter, simfilter::FilterGenInTime, dune::CounterFilter, cluster::SmallClusterFilter, mpf::MissingProductFilter, simfilter::FilterNoDirtNeutrinos, protoana::ProtoDUNEBeamlineFilter, filter::EventTimeFilter, filter::ADCFilter, hit::NumberOfHitsFilter, filt::FinalStateParticleFilter, simfilter::FilterCryostatNus, simfilter::FilterPrimaryPDG, filt::ProtoDUNEFembFilter, art::test::DummyFilter, filt::LArG4ParticleFilter, arttest::PMTestFilter, filter::EventFilter, filt::GenFilter, filt::LArG4ExtCounterFilter, and filt::ProtoDUNETriggerFilter.

bool art::EDFilter::filterWithFrame ( Event &  e,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 83 of file EDFilter.cc.

84  {
85  ScheduleIDSentry sentry{*this, frame.scheduleID()};
86  return filter(e);
87  }
art::EDFilter::filter
virtual bool filter(Event &)=0
e
const double e
Definition: gUpMuFluxGen.cxx:165
void art::EDFilter::respondToCloseInputFile ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 103 of file EDFilter.cc.

104  {}
void art::EDFilter::respondToCloseInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 26 of file EDFilter.cc.

28  {
29  respondToCloseInputFile(fb);
30  }
art::EDFilter::respondToCloseInputFile
virtual void respondToCloseInputFile(FileBlock const &)
Definition: EDFilter.cc:103
void art::EDFilter::respondToCloseOutputFiles ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 111 of file EDFilter.cc.

112  {}
void art::EDFilter::respondToCloseOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 40 of file EDFilter.cc.

42  {
43  respondToCloseOutputFiles(fb);
44  }
art::EDFilter::respondToCloseOutputFiles
virtual void respondToCloseOutputFiles(FileBlock const &)
Definition: EDFilter.cc:111
void art::EDFilter::respondToOpenInputFile ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 99 of file EDFilter.cc.

100  {}
void art::EDFilter::respondToOpenInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 19 of file EDFilter.cc.

21  {
22  respondToOpenInputFile(fb);
23  }
art::EDFilter::respondToOpenInputFile
virtual void respondToOpenInputFile(FileBlock const &)
Definition: EDFilter.cc:99
void art::EDFilter::respondToOpenOutputFiles ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 107 of file EDFilter.cc.

108  {}
void art::EDFilter::respondToOpenOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 33 of file EDFilter.cc.

35  {
36  respondToOpenOutputFiles(fb);
37  }
art::EDFilter::respondToOpenOutputFiles
virtual void respondToOpenOutputFiles(FileBlock const &)
Definition: EDFilter.cc:107
void art::EDFilter::setupQueues ( detail::SharedResources const &  resources)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 13 of file EDFilter.cc.

14  {
15  createQueues(resources);
16  }
art::detail::SharedModule::createQueues
void createQueues(SharedResources const &resources)
Definition: SharedModule.cc:34
std::string art::EDFilter::workerType ( ) const

Definition at line 7 of file EDFilter.cc.

8  {
9  return "WorkerT<EDFilter>";
10  }
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11