Inheritance diagram for cluster::ClusterCheater:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

Public Member Functions
	ClusterCheater (fhicl::ParameterSet const &pset)

virtual	~ClusterCheater ()

void	produce (art::Event &evt)

void	reconfigure (fhicl::ParameterSet const &pset)

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

bool	modifiesEvent () const

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

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 47 of file ClusterCheater_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 93 of file ClusterCheater_module.cc.

References reconfigure().

   {
     this->reconfigure(pset);
 
     produces< std::vector<recob::Cluster> >();
     produces< art::Assns<recob::Cluster, recob::Hit> >();
   }

cluster::ClusterCheater::~ClusterCheater ( )

virtual

Definition at line 102 of file ClusterCheater_module.cc.

103 {

104 }

Member Function Documentation

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

   {
     return current_context_.get();
   }

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

void cluster::ClusterCheater::produce ( art::Event & evt )

virtual

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

Implements art::EDProducer.

Definition at line 118 of file ClusterCheater_module.cc.

References util::CreateAssn(), geo::CryostatID::Cryostat, geo::GeometryCore::Cryostat(), DEFINE_ART_MODULE, e, fHitModuleLabel, art::fill_ptr_vector(), fMinHits, art::DataViewImpl::getByLabel(), hits(), cheat::BackTrackerService::HitToEveTrackIDEs(), cluster::ClusterParamsImportWrapper< Algo >::ImportHits(), geo::PlaneGeo::LocalToWorld(), LOG_DEBUG, geo::GeometryCore::NearestWire(), simb::MCParticle::P(), part, cheat::ParticleInventoryService::ParticleList(), geo::TPCGeo::Plane(), geo::PlaneID::Plane, art::Event::put(), simb::MCParticle::Py(), simb::MCParticle::Pz(), recob::Cluster::Sentry, cheat::ParticleInventoryService::SetEveIdCalculator(), cluster::sortHitsByWire(), geo::CryostatGeo::TPC(), geo::TPCID::TPC, cheat::ParticleInventoryService::TrackIdToParticle_P(), simb::MCParticle::Vy(), and simb::MCParticle::Vz().

   {
     art::ServiceHandle<geo::Geometry>      geo;
     art::ServiceHandle<cheat::BackTrackerService> 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);
 
     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;
 
     // loop over all hits and fill in the map
     for( auto const& itr : hits ){ 
 
       std::vector<sim::TrackIDE> eveides = bt_serv->HitToEveTrackIDEs(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>);
 
     // 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
       double xyz[3]   = {0.};
       double xyz2[3]  = {0.};
       double local[3] = {0.};
       unsigned int cryostat = hitMapItr.first.planeID.Cryostat;
       unsigned int tpc      = hitMapItr.first.planeID.TPC;
       unsigned int plane    = hitMapItr.first.planeID.Plane;
       geo->Cryostat(cryostat).TPC(tpc).Plane(plane).LocalToWorld(local, xyz);
 
       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[1]  = part->Vy();
       xyz[2]  = part->Vz();
       xyz2[0] = xyz[0];
       xyz2[1] = xyz[1] + 10.*part->Py()/part->P();
       xyz2[2] = xyz[2] + 10.*part->Pz()/part->P();
 
       // convert positions to wire and time
       unsigned int w1 = 0;
       unsigned int w2 = 0;
                         
       try{
         w1 = geo->NearestWire(xyz, plane, tpc, cryostat); 
       }
       catch(cet::exception& e){
         w1 = atoi(e.explain_self().substr(e.explain_self().find("#")+1,5).c_str());
       }
       try{
         w2 = geo->NearestWire(xyz2, plane, tpc, cryostat); 
       }
       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
       const geo::PlaneID& planeID = hitMapItr.first.planeID;
       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(hitMapItr.second);
       
       // create the recob::Cluster directly in the vector
       ClusterCreator cluster(
         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(*this, 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));
 
     return;
 
   } // end produce

void cluster::ClusterCheater::reconfigure ( fhicl::ParameterSet const & pset )

Definition at line 107 of file ClusterCheater_module.cc.

References fG4ModuleLabel, fHitModuleLabel, fMCGeneratorLabel, fMinHits, and fhicl::ParameterSet::get().

Referenced by ClusterCheater().

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

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

Member Data Documentation

std::string cluster::ClusterCheater::fG4ModuleLabel

private

label for module running G4 and making particles, etc

Definition at line 60 of file ClusterCheater_module.cc.

Referenced by reconfigure().

std::string cluster::ClusterCheater::fHitModuleLabel

private

label for module creating recob::Hit objects

Definition at line 59 of file ClusterCheater_module.cc.

Referenced by produce(), and reconfigure().

std::string cluster::ClusterCheater::fMCGeneratorLabel

private

label for module to get MC truth information

Definition at line 58 of file ClusterCheater_module.cc.

Referenced by reconfigure().

unsigned int cluster::ClusterCheater::fMinHits

private

minimum number of hits to make a cluster

Definition at line 61 of file ClusterCheater_module.cc.

Referenced by produce(), and reconfigure().

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

/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/ClusterFinder/ClusterCheater_module.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation