Inheritance diagram for cluster::BlurredClustering:

Public Types
using	ModuleType = EDProducer

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

Public Member Functions
	BlurredClustering (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

Private Attributes
std::string const	fHitsModuleLabel

std::string const	fTrackModuleLabel

std::string const	fVertexModuleLabel

std::string const	fPFParticleModuleLabel

bool const	fCreateDebugPDF

bool const	fMergeClusters

bool const	fGlobalTPCRecon

bool const	fShowerReconOnly

cluster::BlurredClusteringAlg	fBlurredClusteringAlg

cluster::MergeClusterAlg	fMergeClusterAlg

shower::TrackShowerSeparationAlg	fTrackShowerSeparationAlg

Detailed Description

Definition at line 52 of file BlurredClustering_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::BlurredClustering::BlurredClustering ( fhicl::ParameterSet const & pset )

explicit

Definition at line 68 of file BlurredClustering_module.cc.

References fBlurredClusteringAlg, fCreateDebugPDF, fGlobalTPCRecon, fHitsModuleLabel, fMergeClusterAlg, fMergeClusters, fPFParticleModuleLabel, fShowerReconOnly, fTrackModuleLabel, fTrackShowerSeparationAlg, and fVertexModuleLabel.

   : EDProducer{pset}
   , fHitsModuleLabel{pset.get<std::string>("HitsModuleLabel")}
   , fTrackModuleLabel{pset.get<std::string>("TrackModuleLabel")}
   , fVertexModuleLabel{pset.get<std::string>("VertexModuleLabel")}
   , fPFParticleModuleLabel{pset.get<std::string>("PFParticleModuleLabel")}
   , fCreateDebugPDF{pset.get<bool>("CreateDebugPDF")}
   , fMergeClusters{pset.get<bool>("MergeClusters")}
   , fGlobalTPCRecon{pset.get<bool>("GlobalTPCRecon")}
   , fShowerReconOnly{pset.get<bool>("ShowerReconOnly")}
   , fBlurredClusteringAlg{pset.get<fhicl::ParameterSet>("BlurredClusterAlg")}
   , fMergeClusterAlg{pset.get<fhicl::ParameterSet>("MergeClusterAlg")}
   , fTrackShowerSeparationAlg{pset.get<fhicl::ParameterSet>("TrackShowerSeparationAlg")}
 {
   produces<std::vector<recob::Cluster>>();
   produces<art::Assns<recob::Cluster, 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 cluster::BlurredClustering::produce ( art::Event & evt )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 86 of file BlurredClustering_module.cc.

 {
   // Create debug pdf to illustrate the blurring process
   if (fCreateDebugPDF) fBlurredClusteringAlg.CreateDebugPDF(evt.run(), evt.subRun(), evt.event());
 
   // Output containers -- collection of clusters and associations
   auto clusters = std::make_unique<std::vector<recob::Cluster>>();
   auto associations = std::make_unique<art::Assns<recob::Cluster, recob::Hit>>();
 
   // Compute the cluster characteristics
   // Just use default for now, but configuration will go here
   ClusterParamsImportWrapper<StandardClusterParamsAlg> ClusterParamAlgo;
 
   // Services
   art::ServiceHandle<geo::Geometry const> geom;
   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};
   int const readoutWindowSize = detProp.ReadOutWindowSize();
 
   // Get the hits from the event
   art::Handle<std::vector<recob::Hit>> hitCollection;
   std::vector<art::Ptr<recob::Hit>> hits;
   std::vector<art::Ptr<recob::Hit>> hitsToCluster;
   if (evt.getByLabel(fHitsModuleLabel, hitCollection)) art::fill_ptr_vector(hits, hitCollection);
 
   if (fShowerReconOnly) {
 
     // Get the tracks from the event
     art::Handle<std::vector<recob::Track>> trackCollection;
     std::vector<art::Ptr<recob::Track>> tracks;
     if (evt.getByLabel(fTrackModuleLabel, trackCollection))
       art::fill_ptr_vector(tracks, trackCollection);
 
     // Get the space points from the event
     art::Handle<std::vector<recob::SpacePoint>> spacePointCollection;
     std::vector<art::Ptr<recob::SpacePoint>> spacePoints;
     if (evt.getByLabel(fTrackModuleLabel, spacePointCollection))
       art::fill_ptr_vector(spacePoints, spacePointCollection);
 
     // Get vertices from the event
     art::Handle<std::vector<recob::Vertex>> vertexCollection;
     std::vector<art::Ptr<recob::Vertex>> vertices;
     if (evt.getByLabel(fVertexModuleLabel, vertexCollection))
       art::fill_ptr_vector(vertices, vertexCollection);
 
     // Get pandora pfparticles and clusters from the event
     art::Handle<std::vector<recob::PFParticle>> pfParticleCollection;
     std::vector<art::Ptr<recob::PFParticle>> pfParticles;
     if (evt.getByLabel(fPFParticleModuleLabel, pfParticleCollection))
       art::fill_ptr_vector(pfParticles, pfParticleCollection);
     art::Handle<std::vector<recob::Cluster>> clusterCollection;
     evt.getByLabel(fPFParticleModuleLabel, clusterCollection);
 
     if (trackCollection.isValid()) {
       art::FindManyP<recob::Hit> fmht(trackCollection, evt, fTrackModuleLabel);
       art::FindManyP<recob::Track> fmth(hitCollection, evt, fTrackModuleLabel);
       art::FindManyP<recob::SpacePoint> fmspt(trackCollection, evt, fTrackModuleLabel);
       art::FindManyP<recob::Track> fmtsp(spacePointCollection, evt, fTrackModuleLabel);
       hitsToCluster = fTrackShowerSeparationAlg.SelectShowerHits(
         evt.event(), hits, tracks, spacePoints, fmht, fmth, fmspt, fmtsp);
     }
   }
   else
     hitsToCluster = hits;
 
   // Make a map between the planes and the hits on each
   std::map<std::pair<int, int>, std::vector<art::Ptr<recob::Hit>>> planeToHits;
   for (auto const& hitToCluster : hitsToCluster) {
     auto const& wireID = hitToCluster->WireID();
     auto const planeNo = wireID.Plane;
     auto const tpc = fGlobalTPCRecon ? wireID.TPC % 2 : wireID.TPC;
     planeToHits[std::make_pair(planeNo, tpc)].push_back(hitToCluster);
   }
 
   // Loop over views
   for (auto const& [plane, hits] : planeToHits) {
     std::vector<art::PtrVector<recob::Hit>> finalClusters;
 
     // Implement the algorithm
     if (hits.size() >= fBlurredClusteringAlg.GetMinSize()) {
 
       // Convert hit map to TH2 histogram and blur it
       auto const image = fBlurredClusteringAlg.ConvertRecobHitsToVector(hits, readoutWindowSize);
       auto const blurred = fBlurredClusteringAlg.GaussianBlur(image);
 
       // Find clusters in histogram
       std::vector<std::vector<int>>
         allClusterBins; // Vector of clusters (clusters are vectors of hits)
       int numClusters = fBlurredClusteringAlg.FindClusters(blurred, allClusterBins);
       mf::LogVerbatim("Blurred Clustering") << "Found " << numClusters << " clusters" << std::endl;
 
       // Create output clusters from the vector of clusters made in FindClusters
       std::vector<art::PtrVector<recob::Hit>> planeClusters;
       fBlurredClusteringAlg.ConvertBinsToClusters(image, allClusterBins, planeClusters);
 
       // Use the cluster merging algorithm
       if (fMergeClusters) {
         int numMergedClusters = fMergeClusterAlg.MergeClusters(planeClusters, finalClusters);
         mf::LogVerbatim("Blurred Clustering")
           << "After merging, there are " << numMergedClusters << " clusters" << std::endl;
       }
       else
         finalClusters = planeClusters;
 
       // Make the debug PDF
       if (fCreateDebugPDF) {
         std::stringstream name;
         name << "blurred_image";
         TH2F* imageHist = fBlurredClusteringAlg.MakeHistogram(image, TString{name.str()});
         name << "_convolved";
         TH2F* blurredHist = fBlurredClusteringAlg.MakeHistogram(blurred, TString{name.str()});
         auto const [planeNo, tpc] = plane;
         fBlurredClusteringAlg.SaveImage(imageHist, 1, tpc, planeNo);
         fBlurredClusteringAlg.SaveImage(blurredHist, 2, tpc, planeNo);
         fBlurredClusteringAlg.SaveImage(blurredHist, allClusterBins, 3, tpc, planeNo);
         fBlurredClusteringAlg.SaveImage(imageHist, finalClusters, 4, tpc, planeNo);
         imageHist->Delete();
         blurredHist->Delete();
       }
 
     } // End min hits check
 
     // Make the output cluster objects
     for (auto const& clusterHits : finalClusters) {
       if (clusterHits.empty()) continue;
 
       // Get the start and end wires of the cluster
       unsigned int const startWire =
         fBlurredClusteringAlg.GlobalWire(clusterHits.front()->WireID());
       unsigned int const endWire = fBlurredClusteringAlg.GlobalWire(clusterHits.back()->WireID());
 
       // Put cluster hits in the algorithm
       ClusterParamAlgo.ImportHits(gser, clusterHits);
 
       // Create the recob::Cluster and place in the vector of clusters
       ClusterCreator cluster(gser,
                              ClusterParamAlgo,                        // algo
                              float(startWire),                        // start_wire
                              0.,                                      // sigma_start_wire
                              clusterHits.front()->PeakTime(),         // start_tick
                              clusterHits.front()->SigmaPeakTime(),    // sigma_start_tick
                              float(endWire),                          // end_wire
                              0.,                                      // sigma_end_wire,
                              clusterHits.back()->PeakTime(),          // end_tick
                              clusterHits.back()->SigmaPeakTime(),     // sigma_end_tick
                              clusters->size(),                        // ID
                              clusterHits.front()->View(),             // view
                              clusterHits.front()->WireID().planeID(), // plane
                              recob::Cluster::Sentry                   // sentry
       );
       clusters->emplace_back(cluster.move());
 
       // Associate the hits to this cluster
       util::CreateAssn(evt, *clusters, clusterHits, *associations);
     } // End loop over all clusters
   }
 
   evt.put(std::move(clusters));
   evt.put(std::move(associations));
 }

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