Inheritance diagram for trkf::SpacePointCheater:

Public Types
using	ModuleType = EDProducer

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

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

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 Member Functions
void	produce (art::Event &evt) override

void	endJob () override

Private Attributes
SpacePointAlg	fSptalg

std::string	fClusterModuleLabel

unsigned int	fMinHits

bool	fClusterAssns

int	fNumEvent

int	fNumSpt2

int	fNumSpt3

Detailed Description

Definition at line 36 of file SpacePointCheater_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

trkf::SpacePointCheater::SpacePointCheater ( fhicl::ParameterSet const & pset )

explicit

Definition at line 61 of file SpacePointCheater_module.cc.

References fClusterAssns, fClusterModuleLabel, fMinHits, fNumEvent, fNumSpt2, fNumSpt3, and fSptalg.

     : EDProducer{pset}
     , fSptalg(pset.get<fhicl::ParameterSet>("SpacePointAlg"))
     , fMinHits(0)
     , fClusterAssns(false)
     , fNumEvent(0)
     , fNumSpt2(0)
     , fNumSpt3(0)
   {
     fClusterModuleLabel = pset.get<std::string>("ClusterModuleLabel");
     fMinHits = pset.get<unsigned int>("MinHits");
     fClusterAssns = pset.get<bool>("ClusterAssns");
 
     produces<std::vector<art::PtrVector<recob::SpacePoint>>>();
     produces<std::vector<recob::SpacePoint>>();
     produces<art::Assns<recob::SpacePoint, recob::Hit>>();
     if (fClusterAssns) produces<art::Assns<recob::SpacePoint, recob::Cluster>>();
 
     mf::LogInfo("SpacePointCheater")
       << "SpacePointCheater configured with the following parameters:\n"
       << "  ClusterModuleLabel = " << fClusterModuleLabel << "\n"
       << "  Minimum Hits per Cluster = " << fMinHits << "\n"
       << "  Cluster associations = " << fClusterAssns;
   }

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 trkf::SpacePointCheater::endJob ( )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 313 of file SpacePointCheater_module.cc.

References fNumEvent, fNumSpt2, and fNumSpt3.

   {
     mf::LogInfo("SpacePointCheater")
       << "SpacePointCheater statistics:\n"
       << "  Number of events = " << fNumEvent << "\n"
       << "  Number of 2-view space points created = " << fNumSpt2 << "\n"
       << "  Number of 3-view space points created = " << fNumSpt3;
   }

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 trkf::SpacePointCheater::produce ( art::Event & evt )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 92 of file SpacePointCheater_module.cc.

References util::CreateAssn(), trkf::SpacePointAlg::enableU(), trkf::SpacePointAlg::enableV(), trkf::SpacePointAlg::enableW(), fClusterAssns, fClusterModuleLabel, fMinHits, fNumEvent, fNumSpt2, fNumSpt3, fSptalg, trkf::SpacePointAlg::getAssociatedHits(), art::ProductRetriever::getByLabel(), art::ProductRetriever::getProductID(), hits(), art::Handle< T >::isValid(), geo::kU, geo::kV, geo::kZ, trkf::SpacePointAlg::makeMCTruthSpacePoints(), trkf::SpacePointAlg::minViews(), art::ProductRetriever::productGetter(), art::PtrVector< T >::push_back(), art::Event::put(), art::PtrVector< T >::reserve(), lar::dump::vector(), and recob::Cluster::View().

   {
     ++fNumEvent;
 
     // Get Services.
 
     art::ServiceHandle<geo::Geometry const> geom;
 
     // Get clusters.
 
     art::Handle<std::vector<recob::Cluster>> clusterh;
     evt.getByLabel(fClusterModuleLabel, clusterh);
 
     // Make a double or triple loop over clusters in distinct views
     // (depending on minimum number of views configured in SpacePointAlg).
 
     if (clusterh.isValid()) {
 
       // Make a collection of space points that will be inserted into the event.
 
       auto sptvecs = std::make_unique<std::vector<art::PtrVector<recob::SpacePoint>>>();
       auto spts = std::make_unique<std::vector<recob::SpacePoint>>();
       auto sphitassn = std::make_unique<art::Assns<recob::SpacePoint, recob::Hit>>();
       auto spclassn = std::make_unique<art::Assns<recob::SpacePoint, recob::Cluster>>();
 
       // Make a hit vector which will be used to store hits to be passed
       // to SpacePointAlg.
 
       art::PtrVector<recob::Hit> hits;
       art::FindManyP<recob::Hit> fm(clusterh, evt, fClusterModuleLabel);
 
       // Loop over first cluster.
 
       auto const clockData =
         art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
       auto const detProp =
         art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(evt, clockData);
 
       int nclus = clusterh->size();
       for (int iclus = 0; iclus < nclus; ++iclus) {
         art::Ptr<recob::Cluster> piclus(clusterh, iclus);
         geo::View_t iview = piclus->View();
 
         std::vector<art::Ptr<recob::Hit>> ihits = fm.at(iclus);
 
         // Test first view.
 
         if (ihits.size() >= fMinHits &&
             ((iview == geo::kU && fSptalg.enableU()) || (iview == geo::kV && fSptalg.enableV()) ||
              (iview == geo::kZ && fSptalg.enableW()))) {
 
           // Store hits from first view into hit vector.
 
           unsigned int nihits = ihits.size();
           hits.clear();
           hits.reserve(nihits);
           for (std::vector<art::Ptr<recob::Hit>>::const_iterator i = ihits.begin();
                i != ihits.end();
                ++i)
             hits.push_back(*i);
 
           // Loop over second cluster.
 
           for (int jclus = 0; jclus < iclus; ++jclus) {
             art::Ptr<recob::Cluster> pjclus(clusterh, jclus);
             geo::View_t jview = pjclus->View();
 
             std::vector<art::Ptr<recob::Hit>> jhits = fm.at(jclus);
 
             // Test second view.
 
             if (jhits.size() >= fMinHits &&
                 ((jview == geo::kU && fSptalg.enableU()) ||
                  (jview == geo::kV && fSptalg.enableV()) ||
                  (jview == geo::kZ && fSptalg.enableW())) &&
                 jview != iview) {
 
               // Store hits from second view into hit vector.
 
               unsigned int njhits = jhits.size();
               assert(hits.size() >= nihits);
               //hits.resize(nihits);
               while (hits.size() > nihits)
                 hits.pop_back();
               assert(hits.size() == nihits);
               hits.reserve(nihits + njhits);
               for (std::vector<art::Ptr<recob::Hit>>::const_iterator j = jhits.begin();
                    j != jhits.end();
                    ++j)
                 hits.push_back(*j);
 
               // If two-view space points are allowed, make them here.
 
               if (fSptalg.minViews() <= 2) {
                 std::vector<recob::SpacePoint> new_spts;
                 fSptalg.makeMCTruthSpacePoints(clockData, detProp, hits, new_spts);
 
                 // If we found some space points, insert them into the event.
 
                 if (new_spts.size() > 0) {
                   fNumSpt2 += new_spts.size();
                   art::PtrVector<recob::Cluster> clusters;
                   clusters.reserve(2);
                   clusters.push_back(piclus);
                   clusters.push_back(pjclus);
 
                   // Insert newly found space points into event collection.
 
                   int nspt = spts->size();
                   spts->insert(spts->end(), new_spts.begin(), new_spts.end());
 
                   // Associate space points with hits and clusters.
 
                   art::PtrVector<recob::SpacePoint> sptvec;
                   for (unsigned int ispt = nspt; ispt < spts->size(); ++ispt) {
                     const recob::SpacePoint& spt = (*spts)[ispt];
                     const art::PtrVector<recob::Hit>& hits = fSptalg.getAssociatedHits(spt);
                     util::CreateAssn(evt, *spts, hits, *sphitassn, ispt);
                     if (fClusterAssns) util::CreateAssn(evt, *spts, clusters, *spclassn, ispt);
 
                     // make the PtrVector for this collection of space points
                     // Do not reproduce the following lines
                     // Contact brebel@fnal.gov if you think you need to reproduce these lines.
                     art::ProductID spid = evt.getProductID<std::vector<recob::SpacePoint>>();
                     art::Ptr<recob::SpacePoint> spptr(spid, ispt, evt.productGetter(spid));
                     sptvec.push_back(spptr);
                   }
                   sptvecs->push_back(sptvec);
                 }
               }
 
               // Loop over third cluster.
 
               for (int kclus = 0; kclus < jclus; ++kclus) {
                 art::Ptr<recob::Cluster> pkclus(clusterh, kclus);
                 geo::View_t kview = pkclus->View();
 
                 std::vector<art::Ptr<recob::Hit>> khits = fm.at(kclus);
 
                 // Test third view.
 
                 if (khits.size() >= fMinHits &&
                     ((kview == geo::kU && fSptalg.enableU()) ||
                      (kview == geo::kV && fSptalg.enableV()) ||
                      (kview == geo::kZ && fSptalg.enableW())) &&
                     kview != iview && kview != jview) {
 
                   // Store hits from third view into hit vector.
 
                   unsigned int nkhits = khits.size();
                   assert(hits.size() >= nihits + njhits);
                   //hits.resize(nihits + njhits);
                   while (hits.size() > nihits + njhits)
                     hits.pop_back();
                   assert(hits.size() == nihits + njhits);
                   hits.reserve(nihits + njhits + nkhits);
                   for (std::vector<art::Ptr<recob::Hit>>::const_iterator k = khits.begin();
                        k != khits.end();
                        ++k)
                     hits.push_back(*k);
 
                   // Make three-view space points.
 
                   std::vector<recob::SpacePoint> new_spts;
                   fSptalg.makeMCTruthSpacePoints(clockData, detProp, hits, new_spts);
 
                   // If we found some space points, insert them into the event.
 
                   if (new_spts.size() > 0) {
                     fNumSpt3 += new_spts.size();
                     art::PtrVector<recob::Cluster> clusters;
                     clusters.reserve(3);
                     clusters.push_back(piclus);
                     clusters.push_back(pjclus);
                     clusters.push_back(pkclus);
 
                     // Insert newly found space points into event collection.
 
                     int nspt = spts->size();
                     spts->insert(spts->end(), new_spts.begin(), new_spts.end());
 
                     // Associate space points with hits and clusters.
 
                     art::PtrVector<recob::SpacePoint> sptvec;
                     for (unsigned int ispt = nspt; ispt < spts->size(); ++ispt) {
                       const recob::SpacePoint& spt = (*spts)[ispt];
                       const art::PtrVector<recob::Hit>& hits = fSptalg.getAssociatedHits(spt);
                       util::CreateAssn(evt, *spts, hits, *sphitassn, ispt);
                       if (fClusterAssns) util::CreateAssn(evt, *spts, clusters, *spclassn, ispt);
 
                       // make the PtrVector for this collection of space points
                       // Do not reproduce the following lines
                       // Contact brebel@fnal.gov if you think you need to reproduce these lines.
                       art::ProductID spid = evt.getProductID<std::vector<recob::SpacePoint>>();
                       art::Ptr<recob::SpacePoint> spptr(spid, ispt, evt.productGetter(spid));
                       sptvec.push_back(spptr);
                     }
                     sptvecs->push_back(sptvec);
                   }
                 }
               }
             }
           }
         }
       }
 
       // Add space points and associations to event.
 
       evt.put(std::move(spts));
       evt.put(std::move(sptvecs));
       evt.put(std::move(sphitassn));
       if (fClusterAssns) evt.put(std::move(spclassn));
     }
   }

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