Inheritance diagram for cosmic::BeamFlashTrackMatchTagger:

Public Types
using	ModuleType = EDProducer

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Member Functions
	BeamFlashTrackMatchTagger (fhicl::ParameterSet const &p)

	BeamFlashTrackMatchTagger (BeamFlashTrackMatchTagger const &)=delete

	BeamFlashTrackMatchTagger (BeamFlashTrackMatchTagger &&)=delete

BeamFlashTrackMatchTagger &	operator= (BeamFlashTrackMatchTagger const &)=delete

BeamFlashTrackMatchTagger &	operator= (BeamFlashTrackMatchTagger &&)=delete

void	produce (art::Event &e) override

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 &mc)

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)

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 Attributes
BeamFlashTrackMatchTaggerAlg	fAlg

std::string	fTrackModuleLabel

std::string	fFlashModuleLabel

HitTagAssociatorAlg	fHitTagAssnsAlg

bool	fMakeHitTagAssns

std::string	fHitModuleLabel

Detailed Description

Definition at line 39 of file BeamFlashTrackMatchTagger_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

cosmic::BeamFlashTrackMatchTagger::BeamFlashTrackMatchTagger ( fhicl::ParameterSet const & p )

explicit

Definition at line 63 of file BeamFlashTrackMatchTagger_module.cc.

References fAlg, fFlashModuleLabel, fHitModuleLabel, fHitTagAssnsAlg, fMakeHitTagAssns, and fTrackModuleLabel.

   : EDProducer{p}
   , fAlg(p.get<fhicl::ParameterSet>("BeamFlashTrackMatchAlgParams"))
   , fTrackModuleLabel(p.get<std::string>("TrackModuleLabel"))
   , fFlashModuleLabel(p.get<std::string>("FlashModuleLabel"))
   , fHitTagAssnsAlg(p.get<fhicl::ParameterSet>("HitTagAssociatorAlgParams"))
   , fMakeHitTagAssns(p.get<bool>("MakeHitTagAssns", false))
   , fHitModuleLabel(p.get<std::string>("HitModuleLabel", "dummy_hit"))
 {
   produces<std::vector<anab::CosmicTag>>();
   produces<art::Assns<recob::Track, anab::CosmicTag>>();
   if (fMakeHitTagAssns) produces<art::Assns<recob::Hit, anab::CosmicTag>>();
 }

cosmic::BeamFlashTrackMatchTagger::BeamFlashTrackMatchTagger ( BeamFlashTrackMatchTagger const & )

delete

cosmic::BeamFlashTrackMatchTagger::BeamFlashTrackMatchTagger ( BeamFlashTrackMatchTagger && )

delete

Member Function Documentation

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::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

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

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

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), 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()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

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

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

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

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

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

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

inherited

Definition at line 75 of file Producer.cc.

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

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

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

inherited

Definition at line 95 of file Producer.cc.

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

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

bool art::detail::Producer::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 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

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

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

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

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

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

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

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

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

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

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

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

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

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

BeamFlashTrackMatchTagger& cosmic::BeamFlashTrackMatchTagger::operator= ( BeamFlashTrackMatchTagger const & )

delete

BeamFlashTrackMatchTagger& cosmic::BeamFlashTrackMatchTagger::operator= ( BeamFlashTrackMatchTagger && )

delete

void cosmic::BeamFlashTrackMatchTagger::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 77 of file BeamFlashTrackMatchTagger_module.cc.

References util::CreateAssn(), DEFINE_ART_MODULE, fAlg, fFlashModuleLabel, fHitModuleLabel, fHitTagAssnsAlg, fMakeHitTagAssns, fTrackModuleLabel, util::GetAssociatedVectorManyI(), art::ProductRetriever::getByLabel(), cosmic::HitTagAssociatorAlg::MakeHitTagAssociations(), art::Event::put(), and cosmic::BeamFlashTrackMatchTaggerAlg::RunCompatibilityCheck().

 {
   // services and providers we'll be using
   auto providers = lar::extractProviders<geo::Geometry, detinfo::LArPropertiesService>();
 
   art::ServiceHandle<phot::PhotonVisibilityService const> pvsHandle;
   phot::PhotonVisibilityService const& pvs(*pvsHandle);
   art::ServiceHandle<opdet::OpDigiProperties const> opdigipHandle;
   opdet::OpDigiProperties const& opdigip(*opdigipHandle);
 
   //Get Flashes from event.
   art::Handle<std::vector<recob::OpFlash>> flashHandle;
   evt.getByLabel(fFlashModuleLabel, flashHandle);
   std::vector<recob::OpFlash> const& flashVector(*flashHandle);
 
   //Get Tracks from event.
   art::Handle<std::vector<recob::Track>> trackHandle;
   evt.getByLabel(fTrackModuleLabel, trackHandle);
   std::vector<recob::Track> const& trackVector(*trackHandle);
 
   //Make the containger for the tag product to put onto the event.
   std::unique_ptr<std::vector<anab::CosmicTag>> cosmicTagPtr(new std::vector<anab::CosmicTag>);
   std::vector<anab::CosmicTag>& cosmicTagVector(*cosmicTagPtr);
 
   //Make a container for the track<-->tag associations.
   //One entry per track, with entry equal to index in cosmic tag collection of associated tag.
   std::vector<size_t> assnTrackTagVector;
   std::unique_ptr<art::Assns<recob::Track, anab::CosmicTag>> assnTrackTag(
     new art::Assns<recob::Track, anab::CosmicTag>);
 
   //run the alg!
   fAlg.RunCompatibilityCheck(
     flashVector, trackVector, cosmicTagVector, assnTrackTagVector, providers, pvs, opdigip);
 
   //Make the associations for ART
   for (size_t track_iter = 0; track_iter < assnTrackTagVector.size(); track_iter++) {
     if (assnTrackTagVector[track_iter] == std::numeric_limits<size_t>::max()) continue;
     art::Ptr<recob::Track> trk_ptr(trackHandle, track_iter);
     util::CreateAssn(evt, cosmicTagVector, trk_ptr, *assnTrackTag, assnTrackTagVector[track_iter]);
   }
 
   //make hit<--> tag associations, if requested
   if (fMakeHitTagAssns) {
 
     //Get Hits from event.
     art::Handle<std::vector<recob::Hit>> hitHandle;
     evt.getByLabel(fHitModuleLabel, hitHandle);
 
     //Get track<-->hit associations
     art::Handle<art::Assns<recob::Hit, recob::Track>> assnHitTrackHandle;
     evt.getByLabel(fTrackModuleLabel, assnHitTrackHandle);
     std::vector<std::vector<size_t>> track_indices_per_hit =
       util::GetAssociatedVectorManyI(assnHitTrackHandle, hitHandle);
 
     std::vector<std::vector<size_t>> assnHitTagVector;
     std::unique_ptr<art::Assns<recob::Hit, anab::CosmicTag>> assnHitTag(
       new art::Assns<recob::Hit, anab::CosmicTag>);
 
     fHitTagAssnsAlg.MakeHitTagAssociations(
       track_indices_per_hit, assnTrackTagVector, assnHitTagVector);
 
     //Make the associations for ART
     for (size_t hit_iter = 0; hit_iter < assnHitTagVector.size(); hit_iter++) {
       art::Ptr<recob::Hit> hit_ptr(hitHandle, hit_iter);
       for (size_t tag_iter = 0; tag_iter < assnHitTagVector[hit_iter].size(); tag_iter++)
         util::CreateAssn(
           evt, cosmicTagVector, hit_ptr, *assnHitTag, assnHitTagVector[hit_iter][tag_iter]);
     }
 
     evt.put(std::move(assnHitTag));
   } //end if makes hit<-->tag associations
 
   //put the data on the event
   evt.put(std::move(cosmicTagPtr));
   evt.put(std::move(assnTrackTag));
 }

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