Inheritance diagram for simfilter::FilterSimPhotonLiteTime:

Public Types
using	ModuleType = SharedFilter

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

Public Member Functions
	FilterSimPhotonLiteTime (fhicl::ParameterSet const &p, art::ProcessingFrame const &)

	FilterSimPhotonLiteTime (FilterSimPhotonLiteTime const &)=delete

	FilterSimPhotonLiteTime (FilterSimPhotonLiteTime &&)=delete

FilterSimPhotonLiteTime &	operator= (FilterSimPhotonLiteTime const &)=delete

FilterSimPhotonLiteTime &	operator= (FilterSimPhotonLiteTime &&)=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)

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)

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)

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 ()

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 ()

Private Member Functions
bool	filter (art::Event &e, art::ProcessingFrame const &) override

void	CheckTimeWindows () const

Private Attributes
std::string const	fSimPhotonsLiteCollectionLabel
	Label for the sim::SimPhotonsLite data product. More...

std::vector< std::pair< int, int > > const	fTimeWindows
	Time windows used for filtering. Units are the same as in the sim::SimPhotonsLite. More...

int const	fMinTotalPhotons
	Minimum number of photons inside a window to pass the filter. More...

bool const	fDebug
	Set to true to print (a lot of) debug information. More...

std::size_t const	fN
	Number of time winows. More...

bool const	fUseReflectedPhotons
	Whether to include reflected photons in the filter. More...

std::string const	fReflectedLabel
	Label for the reflected photons – "Reflected" by default. More...

Detailed Description

Definition at line 32 of file FilterSimPhotonLiteTime_module.cc.

Member Typedef Documentation

using art::SharedFilter::ModuleType = SharedFilter

inherited

Definition at line 19 of file SharedFilter.h.

template<typename UserConfig >

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

inherited

Definition at line 32 of file Filter.h.

Constructor & Destructor Documentation

simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime	(	fhicl::ParameterSet const &	p,
		art::ProcessingFrame const &
	)

explicit

Definition at line 58 of file FilterSimPhotonLiteTime_module.cc.

References CheckTimeWindows(), fDebug, fMinTotalPhotons, fN, fReflectedLabel, fSimPhotonsLiteCollectionLabel, fTimeWindows, fUseReflectedPhotons, art::detail::SharedModule::serialize(), and lar::dump::vector().

   : SharedFilter{p}
   , fSimPhotonsLiteCollectionLabel(p.get<std::string>("SimPhotonsLiteCollectionLabel"))
   , fTimeWindows(p.get<std::vector<std::pair<int, int>>>("TimeWindows"))
   , fMinTotalPhotons(p.get<int>("MinTotalPhotons"))
   , fDebug(p.get<bool>("Debug", false))
   , fN(fTimeWindows.size())
   , fUseReflectedPhotons(p.get<bool>("UseReflectedPhotons", false))
   , fReflectedLabel(p.get<std::string>("ReflectedLabel", "Reflected"))
 {
   CheckTimeWindows();
 
   // For printing out debug messages, we want to serialize the
   // event-level calls so that the messages are not garbled.
   // Otherwise, this module works well for asynchronous event-level
   // calls.
   if (fDebug) { serialize(); }
   else {
     async<art::InEvent>();
   }
 }

simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime ( FilterSimPhotonLiteTime const & )

delete

simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime ( FilterSimPhotonLiteTime && )

delete

Member Function Documentation

template<BranchType BT = InEvent>

void art::detail::SharedModule::async ( )

inlineprotectedinherited

Definition at line 38 of file SharedModule.h.

References art::detail::SharedModule::asyncDeclared_, art::detail::SharedModule::implicit_serialize(), art::InEvent, and art::detail::SharedModule::serialize_for().

     {
       static_assert(
         BT == InEvent,
         "async is currently supported only for the 'InEvent' level.");
       asyncDeclared_ = true;
     }

void simfilter::FilterSimPhotonLiteTime::CheckTimeWindows ( ) const

private

Definition at line 81 of file FilterSimPhotonLiteTime_module.cc.

References fDebug, and fTimeWindows.

Referenced by FilterSimPhotonLiteTime().

 {
 
   if (fDebug)
     std::cout << "\tFilterSimPhotonLiteTime: TimeWindows size is " << fTimeWindows.size()
               << std::endl;
 
   for (auto const& tw : fTimeWindows) {
     if (fDebug)
       std::cout << "\t\tTimeWindow "
                 << "[" << tw.first << "," << tw.second << "]" << std::endl;
 
     if (tw.first > tw.second)
       throw cet::exception("FilterSimPhotonLiteTime::CheckTimeWindows")
         << "Bad time window initialization: tw.first>tw.second. Reverse the order!" << std::endl;
   }
 }

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::SharedModule::createQueues ( SharedResources const & resources )

inherited

Definition at line 34 of file SharedModule.cc.

References art::detail::SharedModule::asyncDeclared_, util::cbegin(), util::cend(), art::detail::SharedModule::chain_, art::detail::SharedResources::createQueues(), e, util::empty(), art::errors::LogicError, and art::detail::SharedModule::resourceNames_.

Referenced by art::OutputModule::doBeginJob(), art::SharedFilter::setupQueues(), art::SharedProducer::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDFilter::setupQueues(), art::EDProducer::setupQueues(), and art::EDAnalyzer::setupQueues().

   {
     Exception e{errors::LogicError,
                 "An error occurred while processing scheduling options for a "
                 "module.\n"};
     if (asyncDeclared_) {
       if (empty(resourceNames_)) {
         return;
       }
       throw e
         << "async<art::InEvent>() cannot be called in combination with any "
            "serialize<art::InEvent>(...) calls.\n";
     }
 
     if (empty(resourceNames_)) {
       throw e << "Either 'async<art::InEvent>()' or "
                  "'serialize<art::InEvent>(...)'\n"
                  "must be called in a shared module's constructor.\n";
     }
     std::vector<std::string> const names(cbegin(resourceNames_),
                                          cend(resourceNames_));
     auto queues = resources.createQueues(names);
     chain_ = std::make_unique<SerialTaskQueueChain>(queues);
   }

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 simfilter::FilterSimPhotonLiteTime::filter	(	art::Event &	e,
		art::ProcessingFrame const &
	)

overrideprivatevirtual

Implements art::SharedFilter.

Definition at line 99 of file FilterSimPhotonLiteTime_module.cc.

References DEFINE_ART_MODULE, sim::SimPhotonsLite::DetectedPhotons, fDebug, fMinTotalPhotons, fN, fReflectedLabel, fSimPhotonsLiteCollectionLabel, fTimeWindows, fUseReflectedPhotons, art::ProductRetriever::getValidHandle(), and sim::SimPhotonsLite::OpChannel.

 {
   auto const& simPhotonsLiteCollection =
     *e.getValidHandle<std::vector<sim::SimPhotonsLite>>(fSimPhotonsLiteCollectionLabel);
 
   std::vector<int> sumNPhotonArray(fN, 0);
 
   const std::vector<sim::SimPhotonsLite>& simPhotonsLiteCollectionReflected =
     fUseReflectedPhotons ? *e.getValidHandle<std::vector<sim::SimPhotonsLite>>(
                              {fSimPhotonsLiteCollectionLabel, fReflectedLabel}) :
                            std::vector<sim::SimPhotonsLite>();
 
   size_t n_sim_photons = simPhotonsLiteCollection.size() + simPhotonsLiteCollectionReflected.size();
 
   if (fDebug) {
     std::cout << "New event to filter with total # sim photons: " << n_sim_photons << std::endl;
   }
 
   for (size_t i_pc = 0; i_pc < n_sim_photons; i_pc++) {
     const sim::SimPhotonsLite& simphotonslite =
       (i_pc < simPhotonsLiteCollection.size()) ?
         simPhotonsLiteCollection[i_pc] :
         simPhotonsLiteCollectionReflected[i_pc - simPhotonsLiteCollection.size()];
 
     if (fDebug)
       std::cout << "\tFilterSimPhotonLiteTime: Processing simphotonslite channel "
                 << simphotonslite.OpChannel << std::endl;
 
     for (auto const& photon_pair : simphotonslite.DetectedPhotons) {
       for (size_t i_tw = 0; i_tw < fN; i_tw++) {
         auto const& tw(fTimeWindows[i_tw]);
         if (photon_pair.first >= tw.first && photon_pair.first <= tw.second) {
 
           if (fDebug) {
             std::string photon_string =
               (i_pc < simPhotonsLiteCollection.size()) ? "Photon" : "Reflected Photon";
             std::cout << "\t\t" << photon_string << " with number " << photon_pair.second
                       << " at time " << photon_pair.first << " detected." << std::endl;
           }
 
           sumNPhotonArray[i_tw] += photon_pair.second;
 
           if (fDebug)
             std::cout << "\t\tTotal number of photons in this window (" << i_tw << ") is now "
                       << sumNPhotonArray[i_tw] << std::endl;
 
           if (sumNPhotonArray[i_tw] >= fMinTotalPhotons) return true;
         }
       }
     }
   }
 
   if (fDebug) {
     std::cout << "\tFilterSimPhotonLiteTime: Final total numbers are below min of "
               << fMinTotalPhotons << ":" << std::endl;
     for (size_t i_tw = 0; i_tw < fN; ++i_tw) {
       std::cout << "\t\tTimeWindow "
                 << "[" << fTimeWindows[i_tw].first << "," << fTimeWindows[i_tw].second
                 << "]: " << sumNPhotonArray[i_tw] << std::endl;
     }
   }
 
   return false;
 }

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();
   }

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";
   }

FilterSimPhotonLiteTime& simfilter::FilterSimPhotonLiteTime::operator= ( FilterSimPhotonLiteTime const & )

delete

FilterSimPhotonLiteTime& simfilter::FilterSimPhotonLiteTime::operator= ( FilterSimPhotonLiteTime && )

delete

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());
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serialize ( T const & ... )

protectedinherited

Referenced by FilterSimPhotonLiteTime(), simfilter::FilterSimPhotonTime::FilterSimPhotonTime(), art::detail::LegacyModule::LegacyModule(), and art::OutputModule::OutputModule().

template<BranchType , typename... T>

void art::detail::SharedModule::serialize ( T const &... resources )

inherited

Definition at line 83 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_resource().

   {
     serialize_for_resource(resources...);
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serializeExternal ( T const & ... )

protectedinherited

Referenced by wcls::WireCellToolkit::WireCellToolkit().

template<BranchType , typename... T>

void art::detail::SharedModule::serializeExternal ( T const &... resources )

inherited

Definition at line 90 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_external_resource().

   {
     serialize_for_external_resource(resources...);
   }

SerialTaskQueueChain * art::detail::SharedModule::serialTaskQueueChain ( ) const

inherited

Definition at line 22 of file SharedModule.cc.

References art::detail::SharedModule::chain_.

   {
     return chain_.get();
   }

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

std::set< std::string > const & art::detail::SharedModule::sharedResources ( ) const

inherited

Definition at line 28 of file SharedModule.cc.

References art::detail::SharedModule::resourceNames_.

   {
     return resourceNames_;
   }

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);
   }