Inheritance diagram for cluster::ClusterCheater:

Public Types
using	ModuleType = EDProducer

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

Public Member Functions
	ClusterCheater (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	fMCGeneratorLabel
	label for module to get MC truth information More...

std::string	fHitModuleLabel
	label for module creating recob::Hit objects More...

std::string	fG4ModuleLabel
	label for module running G4 and making particles, etc More...

unsigned int	fMinHits
	minimum number of hits to make a cluster More...

Detailed Description

Definition at line 40 of file ClusterCheater_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::ClusterCheater::ClusterCheater ( fhicl::ParameterSet const & pset )

explicit

Definition at line 76 of file ClusterCheater_module.cc.

References fG4ModuleLabel, fHitModuleLabel, fMCGeneratorLabel, and fMinHits.

                                                               : EDProducer{pset}
   {
     fMCGeneratorLabel = pset.get<std::string>("MCGeneratorLabel", "generator");
     fHitModuleLabel = pset.get<std::string>("HitModuleLabel", "hit");
     fG4ModuleLabel = pset.get<std::string>("G4ModuleLabel", "largeant");
     fMinHits = pset.get<unsigned int>("MinHits", 1);
 
     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::ClusterCheater::produce ( art::Event & evt )

overrideprivatevirtual

Todo:: : The above encoding of the ID probably won't work for DUNE and should be revisited

Implements art::EDProducer.

Definition at line 88 of file ClusterCheater_module.cc.

References util::CreateAssn(), DEFINE_ART_MODULE, e, fHitModuleLabel, art::fill_ptr_vector(), fMinHits, geo::PlaneGeo::GetBoxCenter(), art::ProductRetriever::getByLabel(), hits(), cheat::BackTrackerService::HitToEveTrackIDEs(), cluster::ClusterParamsImportWrapper< Algo >::ImportHits(), MF_LOG_DEBUG, geo::GeometryCore::NearestWireID(), simb::MCParticle::P(), part, cheat::ParticleInventoryService::ParticleList(), geo::GeometryCore::Plane(), art::Event::put(), simb::MCParticle::Py(), simb::MCParticle::Pz(), recob::Cluster::Sentry, cheat::ParticleInventoryService::SetEveIdCalculator(), cluster::sortHitsByWire(), cheat::ParticleInventoryService::TrackIdToParticle_P(), simb::MCParticle::Vy(), simb::MCParticle::Vz(), and geo::WireID::Wire.

   {
     art::ServiceHandle<geo::Geometry const> geo;
     art::ServiceHandle<cheat::BackTrackerService const> bt_serv;
     art::ServiceHandle<cheat::ParticleInventoryService> pi_serv;
 
     // grab the hits that have been reconstructed
     art::Handle<std::vector<recob::Hit>> hitcol;
     evt.getByLabel(fHitModuleLabel, hitcol);
 
     // make a vector of them - we aren't writing anything out to a file
     // so no need for a art::PtrVector here
     std::vector<art::Ptr<recob::Hit>> hits;
     art::fill_ptr_vector(hits, hitcol);
 
     // adopt an EmEveIdCalculator to find the eve ID.
     // will return a primary particle if it doesn't find
     // a responsible particle for an EM process
     pi_serv->SetEveIdCalculator(new sim::EmEveIdCalculator);
 
     MF_LOG_DEBUG("ClusterCheater") << pi_serv->ParticleList();
 
     // make a map of vectors of art::Ptrs keyed by eveID values and
     // location in cryostat, TPC, plane coordinates of where the hit originated
     std::map<eveLoc, std::vector<art::Ptr<recob::Hit>>> eveHitMap;
 
     auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
 
     // loop over all hits and fill in the map
     for (auto const& itr : hits) {
 
       std::vector<sim::TrackIDE> eveides = bt_serv->HitToEveTrackIDEs(clockData, itr);
 
       // loop over all eveides for this hit
       for (size_t e = 0; e < eveides.size(); ++e) {
 
         // don't worry about eve particles that contribute less than 10% of the
         // energy in the current hit
         if (eveides[e].energyFrac < 0.1) continue;
 
         eveLoc el(eveides[e].trackID, itr->WireID().planeID());
 
         eveHitMap[el].push_back(itr);
 
       } // end loop over eve IDs for this hit
 
     } // end loop over hits
 
     // loop over the map and make clusters
     std::unique_ptr<std::vector<recob::Cluster>> clustercol(new std::vector<recob::Cluster>);
     std::unique_ptr<art::Assns<recob::Cluster, recob::Hit>> assn(
       new art::Assns<recob::Cluster, recob::Hit>);
 
     auto const detProp =
       art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(evt, clockData);
     util::GeometryUtilities const gser{*geo, clockData, detProp};
 
     // 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 (auto hitMapItr : eveHitMap) {
 
       // ================================================================================
       // === Only keeping clusters with fMinHits
       // ================================================================================
       if (hitMapItr.second.size() < fMinHits) continue;
 
       // get the center of this plane in world coordinates
       auto const& planeID = hitMapItr.first.planeID;
       unsigned int cryostat = planeID.Cryostat;
       unsigned int tpc = planeID.TPC;
       unsigned int plane = planeID.Plane;
       auto xyz = geo->Plane(planeID).GetBoxCenter();
 
       MF_LOG_DEBUG("ClusterCheater")
         << "make cluster for eveID: " << hitMapItr.first.eveID << " in cryostat: " << cryostat
         << " tpc: " << tpc << " plane: " << plane << " view: " << hitMapItr.second.at(0)->View();
 
       // get the direction of this particle in the current cryostat, tpc and plane
       const simb::MCParticle* part = pi_serv->TrackIdToParticle_P(hitMapItr.first.eveID);
       if (!part) continue;
 
       // now set the y and z coordinates of xyz to be the first point on the particle
       // trajectory and use the initial directions to determine the dT/dW
       // multiply the direction cosine by 10 to give a decent lever arm for determining
       // dW
       xyz.SetY(part->Vy());
       xyz.SetZ(part->Vz());
       auto xyz2 = xyz;
       xyz2.SetY(xyz.Y() + 10. * part->Py() / part->P());
       xyz2.SetZ(xyz.Z() + 10. * part->Pz() / part->P());
 
       // convert positions to wire and time
       unsigned int w1 = 0;
       unsigned int w2 = 0;
 
       try {
         w1 = geo->NearestWireID(xyz, planeID).Wire;
       }
       catch (cet::exception& e) {
         w1 = atoi(e.explain_self().substr(e.explain_self().find("#") + 1, 5).c_str());
       }
       try {
         w2 = geo->NearestWireID(xyz2, planeID).Wire;
       }
       catch (cet::exception& e) {
         w2 = atoi(e.explain_self().substr(e.explain_self().find("#") + 1, 5).c_str());
       }
 
       // sort the vector of hits with respect to the directionality of the wires determined by
       if (w2 < w1)
         std::sort(hitMapItr.second.rbegin(), hitMapItr.second.rend(), sortHitsByWire);
       else
         std::sort(hitMapItr.second.begin(), hitMapItr.second.end(), sortHitsByWire);
 
       // set the start and end wires and times
       double startWire = hitMapItr.second.front()->WireID().Wire;
       double startTime = hitMapItr.second.front()->PeakTimeMinusRMS();
       double endWire = hitMapItr.second.back()->WireID().Wire;
       double endTime = hitMapItr.second.back()->PeakTimePlusRMS();
 
       // add a cluster to the collection.  Make the ID be the eve particle
       // trackID*1000 + plane number*100 + tpc*10 + cryostat that the current hits are from
       recob::Cluster::ID_t clusterID =
         (((hitMapItr.first.eveID) * 10 + planeID.Plane) * 10 +
          planeID.TPC // 10 is weird choice for DUNE FD... should be 1000! FIXME
          ) *
           10 +
         planeID.Cryostat;
 
       // feed the algorithm with all the cluster hits
       ClusterParamAlgo.ImportHits(gser, hitMapItr.second);
 
       // create the recob::Cluster directly in the vector
       ClusterCreator cluster(gser,
                              ClusterParamAlgo,               // algo
                              startWire,                      // start_wire
                              0.,                             // sigma_start_wire
                              startTime,                      // start_tick
                              0.,                             // sigma_start_tick
                              endWire,                        // end_wire
                              0.,                             // sigma_end_wire
                              endTime,                        // end_tick
                              0.,                             // sigma_end_tick
                              clusterID,                      // ID
                              hitMapItr.second.at(0)->View(), // view
                              planeID,                        // plane
                              recob::Cluster::Sentry          // sentry
       );
 
       clustercol->emplace_back(cluster.move());
 
       // association the hits to this cluster
       util::CreateAssn(evt, *clustercol, hitMapItr.second, *assn);
 
       mf::LogInfo("ClusterCheater") << "adding cluster: \n"
                                     << clustercol->back() << "\nto collection.";
 
     } // end loop over the map
 
     evt.put(std::move(clustercol));
     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);
   }

Member Data Documentation

std::string cluster::ClusterCheater::fG4ModuleLabel

private

label for module running G4 and making particles, etc

Definition at line 49 of file ClusterCheater_module.cc.

Referenced by ClusterCheater().

std::string cluster::ClusterCheater::fHitModuleLabel

private

label for module creating recob::Hit objects

Definition at line 48 of file ClusterCheater_module.cc.

Referenced by ClusterCheater(), and produce().

std::string cluster::ClusterCheater::fMCGeneratorLabel

private

label for module to get MC truth information

Definition at line 47 of file ClusterCheater_module.cc.

Referenced by ClusterCheater().

unsigned int cluster::ClusterCheater::fMinHits

private

minimum number of hits to make a cluster

Definition at line 50 of file ClusterCheater_module.cc.

Referenced by ClusterCheater(), and produce().

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

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