Inheritance diagram for cluster::DBcluster:

Public Types
using	ModuleType = EDProducer

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

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

void	beginJob ()

Private Attributes
TH1F *	fhitwidth

TH1F *	fhitwidth_ind_test

TH1F *	fhitwidth_coll_test

std::string	fhitsModuleLabel

DBScanAlg	fDBScan
	object that implements the DB scan algorithm More...

Detailed Description

Definition at line 43 of file DBcluster_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::DBcluster::DBcluster ( fhicl::ParameterSet const & pset )

explicit

Definition at line 65 of file DBcluster_module.cc.

References fDBScan, and fhitsModuleLabel.

     : EDProducer{pset}, fDBScan(pset.get<fhicl::ParameterSet>("DBScanAlg"))
   {
     fhitsModuleLabel = pset.get<std::string>("HitsModuleLabel");
 
     produces<std::vector<recob::Cluster>>();
     produces<art::Assns<recob::Cluster, recob::Hit>>();
   }

Member Function Documentation

void cluster::DBcluster::beginJob ( )

privatevirtual

Reimplemented from art::EDProducer.

Definition at line 75 of file DBcluster_module.cc.

References fhitwidth, fhitwidth_coll_test, and fhitwidth_ind_test.

   {
     // get access to the TFile service
     art::ServiceHandle<art::TFileService const> tfs;
 
     fhitwidth = tfs->make<TH1F>(" fhitwidth", "width of hits in cm", 50000, 0, 5);
     fhitwidth_ind_test = tfs->make<TH1F>("fhitwidth_ind_test", "width of hits in cm", 50000, 0, 5);
     fhitwidth_coll_test =
       tfs->make<TH1F>("fhitwidth_coll_test", "width of hits in cm", 50000, 0, 5);
   }

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

privatevirtual

Todo:: : need to define start and end positions for this cluster and slopes for dTdW, dQdW

Implements art::EDProducer.

Definition at line 87 of file DBcluster_module.cc.

References art::PtrVector< T >::back(), util::CreateAssn(), DEFINE_ART_MODULE, art::PtrVector< T >::empty(), cluster::DBScanAlg::fclusters, fDBScan, fhitsModuleLabel, fhitwidth, fhitwidth_coll_test, fhitwidth_ind_test, cluster::DBScanAlg::fpointId_to_clusterId, cluster::DBScanAlg::fps, art::PtrVector< T >::front(), art::ProductRetriever::getByLabel(), cluster::ClusterParamsImportWrapper< Algo >::ImportHits(), cluster::DBScanAlg::InitScan(), geo::kCollection, geo::kInduction, geo::WireID::planeID(), art::PtrVector< T >::push_back(), art::Event::put(), cluster::DBScanAlg::run_cluster(), recob::Cluster::Sentry, geo::GeometryCore::SignalType(), sw, and geo::WireID::Wire.

   {
 
     //get a collection of clusters
     std::unique_ptr<std::vector<recob::Cluster>> ccol(new std::vector<recob::Cluster>);
     std::unique_ptr<art::Assns<recob::Cluster, recob::Hit>> assn(
       new 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::ServiceHandle<geo::Geometry const> geom;
 
     art::Handle<std::vector<recob::Hit>> hitcol;
     evt.getByLabel(fhitsModuleLabel, hitcol);
 
     // loop over all hits in the event and look for clusters (for each plane)
     std::vector<art::Ptr<recob::Hit>> allhits;
 
     // get channel quality service:
     lariov::ChannelStatusProvider const& channelStatus =
       art::ServiceHandle<lariov::ChannelStatusService const>()->GetProvider();
 
     lariov::ChannelStatusProvider::ChannelSet_t const BadChannels = channelStatus.BadChannels();
 
     // make a map of the geo::PlaneID to vectors of art::Ptr<recob::Hit>
     std::map<geo::PlaneID, std::vector<art::Ptr<recob::Hit>>> planeIDToHits;
     for (size_t i = 0; i < hitcol->size(); ++i)
       planeIDToHits[hitcol->at(i).WireID().planeID()].push_back(art::Ptr<recob::Hit>(hitcol, i));
 
     auto const clock_data =
       art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
     auto const det_prop =
       art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(evt, clock_data);
     util::GeometryUtilities const gser{*geom, clock_data, det_prop};
     for (auto& itr : planeIDToHits) {
 
       geo::SigType_t sigType = geom->SignalType(itr.first);
       allhits.resize(itr.second.size());
       allhits.swap(itr.second);
 
       fDBScan.InitScan(clock_data, det_prop, allhits, BadChannels);
 
       //----------------------------------------------------------------
       for (unsigned int j = 0; j < fDBScan.fps.size(); ++j) {
 
         if (allhits.size() != fDBScan.fps.size()) break;
 
         fhitwidth->Fill(fDBScan.fps[j][2]);
 
         if (sigType == geo::kInduction) fhitwidth_ind_test->Fill(fDBScan.fps[j][2]);
         if (sigType == geo::kCollection) fhitwidth_coll_test->Fill(fDBScan.fps[j][2]);
       }
 
       //*******************************************************************
       fDBScan.run_cluster();
 
       for (size_t i = 0; i < fDBScan.fclusters.size(); ++i) {
         art::PtrVector<recob::Hit> clusterHits;
 
         for (size_t j = 0; j < fDBScan.fpointId_to_clusterId.size(); ++j) {
           if (fDBScan.fpointId_to_clusterId[j] == i) { clusterHits.push_back(allhits[j]); }
         }
 
         if (clusterHits.empty()) continue;
 
         const geo::WireID& wireID = clusterHits.front()->WireID();
         unsigned int sw = wireID.Wire;
         unsigned int ew = clusterHits.back()->WireID().Wire;
 
         // feed the algorithm with all the cluster hits
         ClusterParamAlgo.ImportHits(gser, clusterHits);
 
         // create the recob::Cluster directly in the vector
         ClusterCreator cluster(gser,
                                ClusterParamAlgo,                     // algo
                                float(sw),                            // start_wire
                                0.,                                   // sigma_start_wire
                                clusterHits.front()->PeakTime(),      // start_tick
                                clusterHits.front()->SigmaPeakTime(), // sigma_start_tick
                                float(ew),                            // end_wire
                                0.,                                   // sigma_end_wire,
                                clusterHits.back()->PeakTime(),       // end_tick
                                clusterHits.back()->SigmaPeakTime(),  // sigma_end_tick
                                ccol->size(),                         // ID
                                clusterHits.front()->View(),          // view
                                wireID.planeID(),                     // plane
                                recob::Cluster::Sentry                // sentry
         );
 
         ccol->emplace_back(cluster.move());
 
         // associate the hits to this cluster
         util::CreateAssn(evt, *ccol, clusterHits, *assn);
 
       } //end loop over fclusters
 
       allhits.clear();
     } // end loop over PlaneID map
 
     mf::LogVerbatim("Summary") << std::setfill('-') << std::setw(175) << "-" << std::setfill(' ');
     mf::LogVerbatim("Summary") << "DBcluster Summary:";
     for (unsigned int i = 0; i < ccol->size(); ++i)
       mf::LogVerbatim("Summary") << ccol->at(i);
 
     evt.put(std::move(ccol));
     evt.put(std::move(assn));
 
     return;
   }

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

DBScanAlg cluster::DBcluster::fDBScan

private

object that implements the DB scan algorithm

Definition at line 57 of file DBcluster_module.cc.

Referenced by DBcluster(), and produce().

std::string cluster::DBcluster::fhitsModuleLabel

private

Definition at line 55 of file DBcluster_module.cc.

Referenced by DBcluster(), and produce().

TH1F* cluster::DBcluster::fhitwidth

private

Definition at line 51 of file DBcluster_module.cc.

Referenced by beginJob(), and produce().

TH1F* cluster::DBcluster::fhitwidth_coll_test

private

Definition at line 53 of file DBcluster_module.cc.

Referenced by beginJob(), and produce().

TH1F* cluster::DBcluster::fhitwidth_ind_test

private

Definition at line 52 of file DBcluster_module.cc.

Referenced by beginJob(), and produce().

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

larreco/v09_25_00/source/larreco/ClusterFinder/DBcluster_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