Inheritance diagram for vertex::VertexCheater:

Public Types
using	ModuleType = EDProducer

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

Public Member Functions
	VertexCheater (fhicl::ParameterSet const &pset)

void	produce (art::Event &evt)

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
std::string	fCheatedTrackLabel
	label for module creating recob::Track objects More...

std::string	fCheatedShowerLabel
	label for module creating recob::Shower objects More...

std::string	fG4ModuleLabel
	label for module running G4 and making particles, etc More...

Detailed Description

Definition at line 32 of file VertexCheater_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

vertex::VertexCheater::VertexCheater ( fhicl::ParameterSet const & pset )

explicit

Definition at line 48 of file VertexCheater_module.cc.

References fCheatedShowerLabel, fCheatedTrackLabel, and fG4ModuleLabel.

                                                             : EDProducer{pset}
   {
     fCheatedTrackLabel = pset.get<std::string>("CheatedTrackLabel", "track");
     fCheatedShowerLabel = pset.get<std::string>("CheatedShowerLabel", "shower");
     fG4ModuleLabel = pset.get<std::string>("G4ModuleLabel", "largeant");
 
     produces<std::vector<recob::Vertex>>();
     produces<art::Assns<recob::Vertex, recob::Shower>>();
     produces<art::Assns<recob::Vertex, recob::Track>>();
     produces<art::Assns<recob::Vertex, recob::Hit>>();
   }

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

void vertex::VertexCheater::produce ( art::Event & evt )

virtual

Implements art::EDProducer.

Definition at line 61 of file VertexCheater_module.cc.

References util::CreateAssn(), DEFINE_ART_MODULE, e, fCheatedShowerLabel, fCheatedTrackLabel, art::fill_ptr_vector(), art::ProductRetriever::getByLabel(), hits(), cheat::ParticleInventoryService::ParticleList(), art::PtrVector< T >::push_back(), art::Event::put(), and art::PtrVector< T >::size().

   {
     art::ServiceHandle<cheat::ParticleInventoryService const> pi_serv;
 
     // grab the sim::ParticleList
     const sim::ParticleList& plist = pi_serv->ParticleList();
 
     // grab the showers that have been reconstructed
     art::Handle<std::vector<recob::Shower>> showercol;
     evt.getByLabel(fCheatedShowerLabel, showercol);
 
     // make a vector of them - we aren't writing anything out to a file
     // so no need for a art::PtrVector here
     std::vector<art::Ptr<recob::Shower>> showers;
     try {
       art::fill_ptr_vector(showers, showercol);
     }
     catch (cet::exception& e) {
       mf::LogWarning("VertexCheater") << "showers: " << e;
     }
 
     // grab the tracks that have been reconstructed
     art::Handle<std::vector<recob::Track>> trackcol;
     evt.getByLabel(fCheatedTrackLabel, trackcol);
 
     // make a vector of them - we aren't writing anything out to a file
     // so no need for a art::PtrVector here
     std::vector<art::Ptr<recob::Track>> tracks;
     try {
       art::fill_ptr_vector(tracks, trackcol);
     }
     catch (cet::exception& e) {
       mf::LogWarning("VertexCheater") << "tracks: " << e;
     }
 
     art::FindManyP<recob::Hit> fmhs(showers, evt, fCheatedShowerLabel);
     art::FindManyP<recob::Hit> fmht(tracks, evt, fCheatedTrackLabel);
 
     // loop over the prongs and figure out which primaries they are associated with
     std::vector<art::Ptr<recob::Shower>>::iterator shwitr = showers.begin();
     std::vector<art::Ptr<recob::Track>>::iterator trkitr = tracks.begin();
 
     // protect against events where there are either no tracks or no showers
     if (tracks.size() < 1) trkitr = tracks.end();
     if (showers.size() < 1) shwitr = showers.end();
 
     // make a map of eve id's to collections of prongs
     std::map<int, std::vector<std::pair<size_t, art::Ptr<recob::Shower>>>> eveShowerMap;
     std::map<int, std::vector<std::pair<size_t, art::Ptr<recob::Track>>>> eveTrackMap;
 
     // make a map of eve id's to the number of prongs corresponding to that id
     std::vector<int> eveIDs;
 
     // loop over all showers
     for (size_t s = 0; s < showers.size(); ++s) {
 
       std::pair<size_t, art::Ptr<recob::Shower>> idxShw(s, showers[s]);
 
       // in the ProngCheater module we set the prong ID to be
       // the particle track ID creating the energy depositions
       // of the prong
       int prongID = showers[s]->ID();
 
       // now get the mother particle of this prong if it exists
       // set the eveID to the mother particle track ID, or to the
       // ID of this prong if it is primary and mother ID = 0
       int eveID = plist[prongID]->Mother();
       if (eveID < 1) eveID = prongID;
 
       if (std::find(eveIDs.begin(), eveIDs.end(), eveID) == eveIDs.end()) eveIDs.push_back(eveID);
 
       // now we want to associate all prongs having the same
       // eve ID, so look to see if there are other prongs with that
       // ID
       eveShowerMap[eveID].push_back(idxShw);
 
       mf::LogInfo("VertexCheater") << "shower: " << prongID << " has mother " << eveID;
 
     } // end loop over showers
 
     // loop over all tracks
     for (size_t t = 0; t < tracks.size(); ++t) {
 
       std::pair<size_t, art::Ptr<recob::Track>> idxTrk(t, tracks[t]);
 
       // in the ProngCheater module we set the prong ID to be
       // the particle track ID creating the energy depositions
       // of the prong
       int prongID = tracks[t]->ID();
 
       // now get the mother particle of this prong if it exists
       // set the eveID to the mother particle track ID, or to the
       // ID of this prong if it is primary and mother ID = 0
       int eveID = plist[prongID]->Mother();
       if (eveID < 1) eveID = prongID;
 
       if (std::find(eveIDs.begin(), eveIDs.end(), eveID) == eveIDs.end()) eveIDs.push_back(eveID);
 
       // now we want to associate all prongs having the same
       // eve ID, so look to see if there are other prongs with that
       // ID
       eveTrackMap[eveID].push_back(idxTrk);
 
       mf::LogInfo("VertexCheater") << "track: " << prongID << " has mother " << eveID;
 
     } // end loop over tracks
 
     std::unique_ptr<std::vector<recob::Vertex>> vertexcol(new std::vector<recob::Vertex>);
     std::unique_ptr<art::Assns<recob::Vertex, recob::Shower>> vsassn(
       new art::Assns<recob::Vertex, recob::Shower>);
     std::unique_ptr<art::Assns<recob::Vertex, recob::Track>> vtassn(
       new art::Assns<recob::Vertex, recob::Track>);
     std::unique_ptr<art::Assns<recob::Vertex, recob::Hit>> vhassn(
       new art::Assns<recob::Vertex, recob::Hit>);
 
     // loop over the eve ID values and make Vertexs
     for (auto const& eveID : eveIDs) {
 
       // Vertex objects require PtrVectors of showers and tracks as well
       // as a vertex position for their constructor
       art::PtrVector<recob::Shower> ptrvshw;
       art::PtrVector<recob::Track> ptrvtrk;
       std::vector<size_t> idxShw;
       std::vector<size_t> idxTrk;
 
       // first get the showers
       if (eveShowerMap.find(eveID) != eveShowerMap.end()) {
         auto const& eveShowers = eveShowerMap[eveID];
         for (auto const& is : eveShowers) {
           ptrvshw.push_back(is.second);
           idxShw.push_back(is.first);
         } // end loop over showers for this particle
       }   // end find showers for this particle
 
       // now the tracks
       if (eveTrackMap.find(eveID) != eveTrackMap.end()) {
         auto const& eveTracks = eveTrackMap[eveID];
         for (auto const& it : eveTracks) {
           ptrvtrk.push_back(it.second);
           idxTrk.push_back(it.first);
         } // end loop over tracks for this particle
       }   // end find tracks for this particle
 
       double xyz[3] = {plist[eveID]->Vx(), plist[eveID]->Vy(), plist[eveID]->Vz()};
 
       // add a vector to the collection.
       vertexcol->push_back(recob::Vertex(xyz, eveID));
 
       // associate the vertex with its showers and tracks
 
       if (ptrvtrk.size() > 0) {
         util::CreateAssn(evt, *vertexcol, ptrvtrk, *vtassn);
 
         // get the hits associated with each track and associate those with the vertex
         for (auto const& i : idxTrk) {
           std::vector<art::Ptr<recob::Hit>> hits = fmht.at(i);
           util::CreateAssn(evt, *vertexcol, hits, *vhassn);
         }
       }
 
       if (ptrvshw.size() > 0) {
         util::CreateAssn(evt, *vertexcol, ptrvshw, *vsassn);
         // get the hits associated with each shower and associate those with the vertex
         for (auto const& i : idxShw) {
           std::vector<art::Ptr<recob::Hit>> hits = fmhs.at(i);
           util::CreateAssn(evt, *vertexcol, hits, *vhassn);
         }
       }
 
       mf::LogInfo("VertexCheater") << "adding vertex: \n"
                                    << vertexcol->back() << "\nto collection.";
 
     } // end loop over the eve ID values
 
     evt.put(std::move(vertexcol));
     evt.put(std::move(vsassn));
     evt.put(std::move(vtassn));
     evt.put(std::move(vhassn));
 
     return;
 
   } // end produce

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

Member Data Documentation

std::string vertex::VertexCheater::fCheatedShowerLabel

private

label for module creating recob::Shower objects

Definition at line 40 of file VertexCheater_module.cc.

Referenced by produce(), and VertexCheater().

std::string vertex::VertexCheater::fCheatedTrackLabel

private

label for module creating recob::Track objects

Definition at line 39 of file VertexCheater_module.cc.

Referenced by produce(), and VertexCheater().

std::string vertex::VertexCheater::fG4ModuleLabel

private

label for module running G4 and making particles, etc

Definition at line 41 of file VertexCheater_module.cc.

Referenced by VertexCheater().

The documentation for this class was generated from the following file:

larreco/v09_25_00/source/larreco/VertexFinder/VertexCheater_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation