Inheritance diagram for cluster::SmallClusterFinder:

Public Types
using	ModuleType = EDProducer

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

Public Member Functions
	SmallClusterFinder (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	beginJob () override

void	produce (art::Event &evt) override

int	GetPlaneAndTPC (art::Ptr< recob::Hit > a, unsigned int &p, unsigned int &cs, unsigned int &t, unsigned int &w)

Private Attributes
art::ServiceHandle< geo::Geometry const >	geom

std::string	fHitFinderModuleLabel

bool	verbose

SmallClusterFinderAlg	fSmallClusterFinderAlg

unsigned int	fNPlanes

Detailed Description

Definition at line 63 of file SmallClusterFinder_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

cluster::SmallClusterFinder::SmallClusterFinder ( fhicl::ParameterSet const & pset )

explicit

Definition at line 95 of file SmallClusterFinder_module.cc.

References fHitFinderModuleLabel, fSmallClusterFinderAlg, and verbose.

     : EDProducer{pset}, fSmallClusterFinderAlg(pset.get<fhicl::ParameterSet>("smallClustAlg"))
   {
     fHitFinderModuleLabel = pset.get<std::string>("HitFinderModuleLabel");
     verbose = pset.get<bool>("Verbose");
 
     produces<std::vector<recob::Cluster>>();            //This code makes clusters
     produces<art::Assns<recob::Cluster, recob::Hit>>(); //Matches clusters with hits
   }

Member Function Documentation

void cluster::SmallClusterFinder::beginJob ( )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 106 of file SmallClusterFinder_module.cc.

References fNPlanes, geom, and geo::GeometryCore::Nplanes().

   {
     // this will not change on a run per run basis.
     fNPlanes = geom->Nplanes(); //get the number of planes in the TPC
   }

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

int cluster::SmallClusterFinder::GetPlaneAndTPC	(	art::Ptr< recob::Hit >	a,
		unsigned int &	p,
		unsigned int &	cs,
		unsigned int &	t,
		unsigned int &	w
	)

private

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

overrideprivatevirtual

Get Clusters

Implements art::EDProducer.

Definition at line 114 of file SmallClusterFinder_module.cc.

References util::CreateAssn(), DEFINE_ART_MODULE, fHitFinderModuleLabel, cluster::SmallClusterFinderAlg::FindSmallClusters(), fNPlanes, fSmallClusterFinderAlg, geom, art::ProductRetriever::getByLabel(), cluster::SmallClusterFinderAlg::GetLeftoversByPlane(), cluster::SmallClusterFinderAlg::GetSmallClustersByPlane(), geo::GeometryCore::Plane(), art::Event::put(), recob::Cluster::Sentry, verbose, and geo::PlaneGeo::View().

   {
     //Get the hits for this event:
     art::Handle<std::vector<recob::Hit>> HitListHandle;
     evt.getByLabel(fHitFinderModuleLabel, HitListHandle);
 
     //A vector to hold hits, not yet filled:
     std::vector<art::Ptr<recob::Hit>> hitlist;
 
     //How many hits in this event?  Tell user:
     if (verbose)
       std::cout << " ++++ Hitsreceived received " << HitListHandle->size() << " +++++ "
                 << std::endl;
     //Catch the case were there are no hits in the event:
     if (HitListHandle->size() == 0) {
       if (verbose) std::cout << "No hits received! Exiting." << std::endl;
       return;
     }
     hitlist.resize(HitListHandle->size());
 
     //wrap the hits in art::Ptrs to pass to the Alg
     for (unsigned int iHit = 0; iHit < hitlist.size(); iHit++) {
       hitlist[iHit] = art::Ptr<recob::Hit>(HitListHandle, iHit);
     }
 
     //std::cout << "Passing " << hitlist.size() << " hits to the alg." << std::endl;
 
     // Now run the alg to find the gammas:
     auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
     auto const detProp =
       art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(evt, clockData);
     util::GeometryUtilities const gser{*geom, clockData, detProp};
     fSmallClusterFinderAlg.FindSmallClusters(gser, clockData, detProp, hitlist);
 
     // make an art::PtrVector of the clusters
     auto SmallClusterFinder = std::make_unique<std::vector<recob::Cluster>>();
     auto assn = std::make_unique<art::Assns<recob::Cluster, recob::Hit>>();
 
     // prepare the algorithm to compute the cluster characteristics;
     // we use the "standard" one here; configuration would happen here,
     // but we are using the default configuration for that algorithm
     ClusterParamsImportWrapper<StandardClusterParamsAlg> ClusterParamAlgo;
 
     for (unsigned int iplane = 0; iplane < fNPlanes; iplane++) {
 
       auto const leftoverHits = fSmallClusterFinderAlg.GetLeftoversByPlane(iplane);
 
       //write the leftover hits as a cluster:
       if (leftoverHits.size() != 0) {
         // pick some information from the first hit
         geo::PlaneID planeID = leftoverHits.front()->WireID().planeID();
         if (verbose)
           std::cout << "Writing leftover hits to cluster ID: " << iplane * 100 << std::endl;
 
         ClusterParamAlgo.ImportHits(gser, leftoverHits);
 
         // create the recob::Cluster directly in the vector
         ClusterCreator leftover(gser,
                                 ClusterParamAlgo, // algo
                                 0.,               // start_wire
                                 0.,               // sigma_start_wire
                                 0.,               // start_tick
                                 0.,               // sigma_start_tick
                                 0.,               // end_wire
                                 0.,               // sigma_end_wire,
                                 0.,               // end_tick
                                 0.,               // sigma_end_tick
                                 iplane * 100,     // ID
                                 geom->Plane(geo::PlaneID{planeID.asTPCID(), iplane}).View(),
                                 planeID,               // plane
                                 recob::Cluster::Sentry // sentry
         );
 
         SmallClusterFinder->emplace_back(leftover.move());
 
         util::CreateAssn(evt, *SmallClusterFinder, leftoverHits, *assn);
       } //leftovers are written for this plane, if they exist.
 
       auto const smallClusters = fSmallClusterFinderAlg.GetSmallClustersByPlane(iplane);
       for (unsigned int i = 0; i < smallClusters.size(); i++) {
         // pick some information from the first hit
         geo::PlaneID planeID; // invalid by default
         if (!smallClusters.empty()) planeID = smallClusters[i].front()->WireID().planeID();
 
         ClusterParamAlgo.ImportHits(gser, smallClusters[i]);
 
         // create the recob::Cluster directly in the vector
         ClusterCreator clust(gser,
                              ClusterParamAlgo,     // algo
                              0.,                   // start_wire
                              0.,                   // sigma_start_wire
                              0.,                   // start_tick
                              0.,                   // sigma_start_tick
                              0.,                   // end_wire
                              0.,                   // sigma_end_wire,
                              0.,                   // end_tick
                              0.,                   // sigma_end_tick
                              iplane * 100 + i + 1, // ID
                              geom->Plane(geo::PlaneID{planeID.asTPCID(), iplane}).View(),
                              planeID,               // plane
                              recob::Cluster::Sentry // sentry
         );
 
         SmallClusterFinder->emplace_back(clust.move());
         // associate the hits to this cluster
         util::CreateAssn(evt, *SmallClusterFinder, smallClusters[i], *assn);
       }
     }
 
     evt.put(std::move(SmallClusterFinder));
     evt.put(std::move(assn));
   } //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);
   }