Inheritance diagram for filt::FinalStateParticleFilter:

Public Types
using	ModuleType = EDFilter

template<typename UserConfig >
using	Table = Modifier::Table< UserConfig >

Public Member Functions
	FinalStateParticleFilter (fhicl::ParameterSet const &)

bool	filter (art::Event &evt)

void	beginJob ()

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Static Public Attributes
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions
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 Member Functions
bool	isSubset (std::vector< int > const &a, std::vector< int > const &b) const

Private Attributes
std::string	fGenieModuleLabel

std::vector< int >	fPDG

std::vector< int >	fStatusCode

TH1D *	fSelectedEvents

TH1D *	fTotalEvents

Detailed Description

Definition at line 30 of file FinalStateParticleFilter_module.cc.

Member Typedef Documentation

using art::EDFilter::ModuleType = EDFilter

inherited

Definition at line 18 of file EDFilter.h.

template<typename UserConfig >

using art::detail::Filter::Table = Modifier::Table<UserConfig>

inherited

Definition at line 32 of file Filter.h.

Constructor & Destructor Documentation

filt::FinalStateParticleFilter::FinalStateParticleFilter ( fhicl::ParameterSet const & pset )

explicit

Definition at line 54 of file FinalStateParticleFilter_module.cc.

References fGenieModuleLabel, and fPDG.

     : EDFilter{pset}
   {
     fGenieModuleLabel = pset.get<std::string>("GenieModuleLabel");
     fPDG = pset.get<std::vector<int>>("PDG");
   }

Member Function Documentation

void filt::FinalStateParticleFilter::beginJob ( )

virtual

Reimplemented from art::EDFilter.

Definition at line 62 of file FinalStateParticleFilter_module.cc.

References fSelectedEvents, and fTotalEvents.

   {
     art::ServiceHandle<art::TFileService const> tfs;
     fSelectedEvents = tfs->make<TH1D>("fSelectedEvents",
                                       "Number of Selected Events",
                                       3,
                                       0,
                                       3); //counts the number of selected events
     fTotalEvents =
       tfs->make<TH1D>("fTotalEvents",
                       "Total Events",
                       3,
                       0,
                       3); //counts the initial number of events in the unfiltered root input file
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Filter::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 29 of file Filter.cc.

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Filter::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 72 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = beginRunWithFrame(r, frame);
     r.commitProducts();
     return rc;
   }

bool art::detail::Filter::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return rc;
   }

void art::detail::Filter::doEndJob ( )

inherited

Definition at line 37 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Filter::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 82 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = endRunWithFrame(r, frame);
     r.commitProducts();
     return rc;
   }

bool art::detail::Filter::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 102 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return rc;
   }

bool art::detail::Filter::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
	)

inherited

Definition at line 112 of file Filter.cc.

References e, art::EventPrincipal::makeEvent(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = filterWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     if (rc) {
       ++counts_passed;
     } else {
       ++counts_failed;
     }
     return rc;
   }

void art::detail::Filter::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 51 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Filter::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 65 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Filter::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Filter::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

bool filt::FinalStateParticleFilter::filter ( art::Event & evt )

virtual

Implements art::EDFilter.

Definition at line 79 of file FinalStateParticleFilter_module.cc.

References fGenieModuleLabel, fPDG, fSelectedEvents, fTotalEvents, art::ProductRetriever::getByLabel(), simb::MCTruth::GetParticle(), isSubset(), simb::MCTruth::NParticles(), and part.

   {
 
     //const TDatabasePDG* databasePDG = TDatabasePDG::Instance();
 
     art::Handle<std::vector<simb::MCTruth>> mclist;
     evt.getByLabel(fGenieModuleLabel, mclist);
     art::Ptr<simb::MCTruth> mc(mclist, 0);
 
     fTotalEvents->Fill(1);
 
     std::vector<int> finalstateparticles;
 
     //get a vector of final state particles
     for (int i = 0; i < mc->NParticles(); ++i) {
       simb::MCParticle part(mc->GetParticle(i));
       if (part.StatusCode() == 1) finalstateparticles.push_back(part.PdgCode());
     }
 
     if (isSubset(fPDG, finalstateparticles)) {
       fSelectedEvents->Fill(1);
       std::cout << "this is a selected event" << std::endl;
     }
 
     return isSubset(
       fPDG,
       finalstateparticles); // returns true if the user-defined fPDG exist(s) in the final state particles
 
   } // bool

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

bool filt::FinalStateParticleFilter::isSubset	(	std::vector< int > const &	a,
		std::vector< int > const &	b
	)		const

private

Definition at line 112 of file FinalStateParticleFilter_module.cc.

References DEFINE_ART_MODULE.

Referenced by filter().

   {
     for (auto const a_int : a) {
       bool found = false;
       for (auto const b_int : b) {
         if (a_int == b_int) {
           found = true;
           break;
         }
       }
 
       if (!found) { return false; }
     }
     return true;
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }