Inheritance diagram for cluster::LineMerger:

Public Types
using	ModuleType = EDProducer

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

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

bool	SlopeCompatibility (double slope1, double slope2)

int	EndpointCompatibility (float sclstartwire, float sclstarttime, float sclendwire, float sclendtime, float cl2startwire, float cl2starttime, float cl2endwire, float cl2endtime)

Private Attributes
std::string	fClusterModuleLabel

double	fSlope

double	fEndpointWindow

Detailed Description

Definition at line 47 of file LineMerger_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::LineMerger::LineMerger ( fhicl::ParameterSet const & pset )

explicit

Definition at line 353 of file LineMerger_module.cc.

References fClusterModuleLabel, fEndpointWindow, and fSlope.

     : EDProducer{pset}
     , fClusterModuleLabel(pset.get<std::string>("ClusterModuleLabel"))
     , fSlope(pset.get<double>("Slope"))
     , fEndpointWindow(pset.get<double>("EndpointWindow"))
   {
     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);
   }

int cluster::LineMerger::EndpointCompatibility	(	float	sclstartwire,
		float	sclstarttime,
		float	sclendwire,
		float	sclendtime,
		float	cl2startwire,
		float	cl2starttime,
		float	cl2endwire,
		float	cl2endtime
	)

private

Todo:: 13.5 ticks/wire. need to make this detector agnostic–spitz

Definition at line 533 of file LineMerger_module.cc.

References DEFINE_ART_MODULE, and fEndpointWindow.

Referenced by produce().

   {
 
     float distance =
       std::sqrt((pow(sclendwire - cl2startwire, 2) * 13.5) + pow(sclendtime - cl2starttime, 2));
 
     //not sure if this line is necessary--spitz
     float distance2 =
       std::sqrt((pow(sclstartwire - cl2endwire, 2) * 13.5) + pow(sclstarttime - cl2endtime, 2));
 
     //determine which way the two clusters should be merged. TY
     int comp = 0;
     if (distance < fEndpointWindow)
       comp = 1;
     else if (distance2 < fEndpointWindow)
       comp = -1;
     return comp;
   }

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

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 364 of file LineMerger_module.cc.

References c2, util::CreateAssn(), EndpointCompatibility(), fClusterModuleLabel, art::ProductRetriever::getByLabel(), recob::Cluster::ID(), geo::kU, geo::kV, geo::kZ, art::Event::put(), recob::Cluster::Sentry, SlopeCompatibility(), and recob::Cluster::View().

   {
     // Get a Handle for the input Cluster object(s).
     art::Handle<std::vector<recob::Cluster>> clusterVecHandle;
     evt.getByLabel(fClusterModuleLabel, clusterVecHandle);
 
     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{*lar::providerFrom<geo::Geometry>(), clockData, detProp};
 
     constexpr size_t nViews = 3; // number of views we map
 
     //one vector for each view in the geometry (holds the index of the cluster)
     std::array<std::vector<size_t>, nViews> ClsIndices;
 
     //vector with indicators for whether a cluster has been merged already
     std::array<std::vector<int>, nViews> Cls_matches;
 
     // loop over the input Clusters
     for (size_t i = 0; i < clusterVecHandle->size(); ++i) {
 
       //get a art::Ptr to each Cluster
       art::Ptr<recob::Cluster> cl(clusterVecHandle, i);
 
       size_t view = 0;
       switch (cl->View()) {
       case geo::kU: view = 0; break;
       case geo::kV: view = 1; break;
       case geo::kZ: view = 2; break;
       default: continue; // ignore this cluster and process the next one
       }                  // end switch on view
 
       Cls_matches[view].push_back(0);
       ClsIndices[view].push_back(i);
     } // end loop over input clusters
 
     auto SuperClusters = 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;
 
     art::FindManyP<recob::Hit> fmh(clusterVecHandle, evt, fClusterModuleLabel);
 
     for (size_t i = 0; i < nViews; ++i) {
 
       int clustersfound = 0; // how many merged clusters found in each plane
       int clsnum1 = 0;
 
       for (size_t c = 0; c < ClsIndices[i].size(); ++c) {
         if (Cls_matches[i][clsnum1] == 1) {
           ++clsnum1;
           continue;
         }
 
         // make a new cluster to put into the SuperClusters collection
         // because we want to be able to adjust it later;
         // use the hits associated with the current cluster
         recob::Cluster const& StartingCluster = clusterVecHandle->at(ClsIndices[i][c]);
         ClusterAndHitMerger cl1(StartingCluster, fmh.at(ClsIndices[i][c]));
         const recob::Cluster::ID_t clusterID = StartingCluster.ID();
 
         Cls_matches[i][clsnum1] = 1;
         ++clustersfound;
 
         int clsnum2 = 0;
         for (size_t c2 = 0; c2 < ClsIndices[i].size(); ++c2) {
 
           if (Cls_matches[i][clsnum2] == 1) {
             ++clsnum2;
             continue;
           }
 
           const recob::Cluster& cl2(clusterVecHandle->at(ClsIndices[i][c2]));
 
           // check that the slopes are the same
           // added 13.5 ticks/wirelength in ArgoNeuT.
           // \todo need to make this detector agnostic
           // would be nice to have a LArProperties function that returns ticks/wire.
           bool sameSlope = SlopeCompatibility(cl1.StartAngle(), cl2.EndAngle()) ||
                            SlopeCompatibility(cl1.EndAngle(), cl2.StartAngle());
 
           // check that the endpoints fall within a circular window of each other
           // done in place of intercept matching
           int sameEndpoint = EndpointCompatibility(cl1.StartWire(),
                                                    cl1.StartTick(),
                                                    cl1.EndWire(),
                                                    cl1.EndTick(),
                                                    cl2.StartWire(),
                                                    cl2.StartTick(),
                                                    cl2.EndWire(),
                                                    cl2.EndTick());
 
           // if the slopes and end points are the same, combine the clusters
           // note that after 1 combination cl1 is no longer what we started
           // with
           if (sameSlope && (sameEndpoint != 0)) {
             // combine the hit collections too
             // (find the hits associated with this second cluster);
             // take into account order when merging hits from two clusters: doc-1776
             // if sameEndpoint is 1, the new hits come first
             cl1.Add(cl2, fmh.at(ClsIndices[i][c2]), sameEndpoint == 1);
             Cls_matches[i][clsnum2] = 1;
           }
 
           ++clsnum2;
         } // end loop over second cluster iterator
 
         // now add the final version of cl1 to the collection of SuperClusters
         // and create the association between the super cluster and the hits
         ClusterParamAlgo.ImportHits(gser, cl1.Hits());
 
         // create the recob::Cluster directly in the vector
         SuperClusters->emplace_back(cl1.StartWire(),                            // start_wire
                                     cl1.SigmaStartWire(),                       // sigma_start_wire
                                     cl1.StartTick(),                            // start_tick
                                     cl1.SigmaStartTick(),                       // sigma_start_tick
                                     cl1.StartCharge(),                          // start_charge
                                     cl1.StartAngle(),                           // start_angle
                                     cl1.StartOpeningAngle(),                    // start_opening
                                     cl1.EndWire(),                              // end_wire
                                     cl1.SigmaEndWire(),                         // sigma_end_wire
                                     cl1.EndTick(),                              // end_time
                                     cl1.SigmaEndTick(),                         // sigma_end_tick
                                     cl1.EndCharge(),                            // end_charge
                                     cl1.EndAngle(),                             // end_angle
                                     cl1.EndOpeningAngle(),                      // end_opening
                                     ClusterParamAlgo.Integral().value(),        // integral
                                     ClusterParamAlgo.IntegralStdDev().value(),  // integral_stddev
                                     ClusterParamAlgo.SummedADC().value(),       // summedADC
                                     ClusterParamAlgo.SummedADCStdDev().value(), // summedADC_stddev
                                     ClusterParamAlgo.NHits(),                   // n_hits
                                     ClusterParamAlgo.MultipleHitDensity(), // multiple_hit_density
                                     cl1.Width(),                           // width
                                     clusterID,                             // ID
                                     cl1.View(),                            // view
                                     cl1.Plane(),                           // planeID
                                     recob::Cluster::Sentry                 // sentry
         );
 
         util::CreateAssn(evt, *SuperClusters, cl1.Hits(), *assn);
         ++clsnum1;
 
       } // end loop over first cluster iterator
     }   // end loop over planes
 
     mf::LogVerbatim("Summary") << std::setfill('-') << std::setw(175) << "-" << std::setfill(' ');
     mf::LogVerbatim("Summary") << "LineMerger Summary:";
     for (size_t i = 0; i < SuperClusters->size(); ++i)
       mf::LogVerbatim("Summary") << SuperClusters->at(i);
 
     evt.put(std::move(SuperClusters));
     evt.put(std::move(assn));
   }

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

bool cluster::LineMerger::SlopeCompatibility	(	double	slope1,
		double	slope2
	)

private

Definition at line 524 of file LineMerger_module.cc.

References util::abs(), and fSlope.

Referenced by produce().

   {
     double sl1 = atan(slope1);
     double sl2 = atan(slope2);
 
     //the units of fSlope are radians
     return std::abs(sl1 - sl2) < fSlope;
   }

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 cluster::LineMerger::fClusterModuleLabel

private

Definition at line 54 of file LineMerger_module.cc.

Referenced by LineMerger(), and produce().

double cluster::LineMerger::fEndpointWindow

private

Definition at line 56 of file LineMerger_module.cc.

Referenced by EndpointCompatibility(), and LineMerger().

double cluster::LineMerger::fSlope

private

Definition at line 55 of file LineMerger_module.cc.

Referenced by LineMerger(), and SlopeCompatibility().

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

larreco/v09_25_00/source/larreco/ClusterFinder/LineMerger_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation