Inheritance diagram for vertex::VertexCheater:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

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

virtual	~VertexCheater ()

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	fCheatedTrackLabel
	label for module creating recob::Track objects More...

std::string	fCheatedShowerLabel
	label for module creating recob::Shower objects More...

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

Detailed Description

Definition at line 38 of file VertexCheater_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

vertex::VertexCheater::VertexCheater ( fhicl::ParameterSet const & pset )

explicit

Definition at line 59 of file VertexCheater_module.cc.

References reconfigure().

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

vertex::VertexCheater::~VertexCheater ( )

virtual

Definition at line 71 of file VertexCheater_module.cc.

72 {

73 }

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

virtual

Implements art::EDProducer.

Definition at line 86 of file VertexCheater_module.cc.

References util::CreateAssn(), DEFINE_ART_MODULE, e, fCheatedShowerLabel, fCheatedTrackLabel, art::fill_ptr_vector(), art::DataViewImpl::getByLabel(), hits(), cheat::ParticleInventoryService::ParticleList(), art::PtrVector< T >::push_back(), art::Event::put(), s, and art::PtrVector< T >::size().

   {
     art::ServiceHandle<cheat::ParticleInventoryService> pi_serv;
 
     // grab the sim::ParticleList
     const sim::ParticleList& plist = pi_serv->ParticleList();
 
     // grab the showers that have been reconstructed
     art::Handle< std::vector<recob::Shower> > showercol;
     evt.getByLabel(fCheatedShowerLabel, showercol);
 
     // 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::Shower> > showers;
     try{
       art::fill_ptr_vector(showers, showercol);
     }
     catch(cet::exception &e){
       mf::LogWarning("VertexCheater") << "showers: " << e;
     }
 
     // grab the tracks that have been reconstructed
     art::Handle< std::vector<recob::Track> > trackcol;
     evt.getByLabel(fCheatedTrackLabel, trackcol);
 
     // 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::Track> > tracks;
     try{
       art::fill_ptr_vector(tracks, trackcol);
     }
     catch(cet::exception &e){
       mf::LogWarning("VertexCheater") << "tracks: " << e;
     }
 
     art::FindManyP<recob::Hit> fmhs(showers, evt, fCheatedShowerLabel);
     art::FindManyP<recob::Hit> fmht(tracks, evt, fCheatedTrackLabel);
 
     // loop over the prongs and figure out which primaries they are associated with
     std::vector< art::Ptr<recob::Shower> >::iterator shwitr = showers.begin();
     std::vector< art::Ptr<recob::Track>  >::iterator trkitr = tracks.begin();
 
     // protect against events where there are either no tracks or no showers
     if(tracks.size()  < 1) trkitr = tracks.end();
     if(showers.size() < 1) shwitr = showers.end();
 
     // make a map of eve id's to collections of prongs
     std::map<int, std::vector< std::pair<size_t, art::Ptr<recob::Shower> > > > eveShowerMap;
     std::map<int, std::vector< std::pair<size_t, art::Ptr<recob::Track>  > > > eveTrackMap;
     
     // make a map of eve id's to the number of prongs corresponding to that id
     std::vector<int> eveIDs;
 
     // loop over all showers
     for(size_t s = 0; s < showers.size(); ++s){
 
       std::pair<size_t, art::Ptr<recob::Shower> > idxShw(s, showers[s]);
 
       // in the ProngCheater module we set the prong ID to be 
       // the particle track ID creating the energy depositions
       // of the prong
       int prongID = showers[s]->ID();
 
       // now get the mother particle of this prong if it exists
       // set the eveID to the mother particle track ID, or to the
       // ID of this prong if it is primary and mother ID = 0
       int eveID = plist[prongID]->Mother();
       if( eveID < 1 ) eveID = prongID;
 
       if(std::find(eveIDs.begin(), eveIDs.end(), eveID) == eveIDs.end())
         eveIDs.push_back(eveID);
 
       // now we want to associate all prongs having the same 
       // eve ID, so look to see if there are other prongs with that
       // ID
       eveShowerMap[eveID].push_back(idxShw);
 
       mf::LogInfo("VertexCheater") << "shower: " << prongID << " has mother " << eveID;
         
     }// end loop over showers
 
     // loop over all tracks
     for(size_t t = 0; t < tracks.size(); ++t){
 
       std::pair<size_t, art::Ptr<recob::Track> > idxTrk(t, tracks[t]);
 
       // in the ProngCheater module we set the prong ID to be 
       // the particle track ID creating the energy depositions
       // of the prong
       int prongID = tracks[t]->ID();
 
       // now get the mother particle of this prong if it exists
       // set the eveID to the mother particle track ID, or to the
       // ID of this prong if it is primary and mother ID = 0
       int eveID = plist[prongID]->Mother();
       if( eveID < 1 ) eveID = prongID;
 
       if(std::find(eveIDs.begin(), eveIDs.end(), eveID) == eveIDs.end())
         eveIDs.push_back(eveID);
 
       // now we want to associate all prongs having the same 
       // eve ID, so look to see if there are other prongs with that
       // ID
       eveTrackMap[eveID].push_back(idxTrk);
 
       mf::LogInfo("VertexCheater") << "track: " << prongID << " has mother " << eveID;
         
     }// end loop over tracks
 
     std::unique_ptr< std::vector<recob::Vertex> > vertexcol(new std::vector<recob::Vertex>);
     std::unique_ptr< art::Assns<recob::Vertex, recob::Shower> > vsassn(new art::Assns<recob::Vertex, recob::Shower>);
     std::unique_ptr< art::Assns<recob::Vertex, recob::Track>  > vtassn(new art::Assns<recob::Vertex, recob::Track>);
     std::unique_ptr< art::Assns<recob::Vertex, recob::Hit>    > vhassn(new art::Assns<recob::Vertex, recob::Hit>);
 
     // loop over the eve ID values and make Vertexs
     for(auto const& eveID : eveIDs){
 
       // Vertex objects require PtrVectors of showers and tracks as well
       // as a vertex position for their constructor
       art::PtrVector<recob::Shower> ptrvshw;
       art::PtrVector<recob::Track>  ptrvtrk;
       std::vector<size_t> idxShw;
       std::vector<size_t> idxTrk;
 
       // first get the showers
       if(eveShowerMap.find(eveID) != eveShowerMap.end()){
         auto const& eveShowers = eveShowerMap[eveID];
         for(auto const& is : eveShowers){
           ptrvshw.push_back(is.second);
           idxShw.push_back(is.first);
         } // end loop over showers for this particle
       } // end find showers for this particle
 
       // now the tracks
       if(eveTrackMap.find(eveID) != eveTrackMap.end()){
         auto const& eveTracks = eveTrackMap[eveID];
         for(auto const& it : eveTracks){
           ptrvtrk.push_back(it.second);
           idxTrk.push_back(it.first);
         } // end loop over tracks for this particle
       } // end find tracks for this particle
  
       double xyz[3] = { plist[eveID]->Vx(),
                         plist[eveID]->Vy(),
                         plist[eveID]->Vz() };
 
       // add a vector to the collection.  
       vertexcol->push_back(recob::Vertex(xyz, eveID));
 
       // associate the vertex with its showers and tracks
 
       if( ptrvtrk.size() > 0 ){
         util::CreateAssn(*this, evt, *vertexcol, ptrvtrk, *vtassn);
 
         // get the hits associated with each track and associate those with the vertex
         for(auto const& i : idxTrk){
           std::vector< art::Ptr<recob::Hit> > hits = fmht.at(i);
           util::CreateAssn(*this, evt, *vertexcol, hits, *vhassn);
         }
       }
       
       if( ptrvshw.size() > 0 ){
         util::CreateAssn(*this, evt, *vertexcol, ptrvshw, *vsassn);
         // get the hits associated with each shower and associate those with the vertex
         for(auto const& i : idxShw){
           std::vector< art::Ptr<recob::Hit> > hits = fmhs.at(i);
           util::CreateAssn(*this, evt, *vertexcol, hits, *vhassn);
         }
       }
 
       mf::LogInfo("VertexCheater") << "adding vertex: \n" 
                                    << vertexcol->back()
                                    << "\nto collection.";
 
     } // end loop over the eve ID values
 
     evt.put(std::move(vertexcol));
     evt.put(std::move(vsassn));
     evt.put(std::move(vtassn));
     evt.put(std::move(vhassn));
 
     return;
 
   } // end produce

void vertex::VertexCheater::reconfigure ( fhicl::ParameterSet const & pset )

Definition at line 76 of file VertexCheater_module.cc.

References fCheatedShowerLabel, fCheatedTrackLabel, fG4ModuleLabel, and fhicl::ParameterSet::get().

Referenced by VertexCheater().

   {
     fCheatedTrackLabel  = pset.get< std::string >("CheatedTrackLabel",  "track"   );
     fCheatedShowerLabel = pset.get< std::string >("CheatedShowerLabel", "shower"  );
     fG4ModuleLabel      = pset.get< std::string >("G4ModuleLabel",      "largeant");
 
     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 vertex::VertexCheater::fCheatedShowerLabel

private

label for module creating recob::Shower objects

Definition at line 50 of file VertexCheater_module.cc.

Referenced by produce(), and reconfigure().

std::string vertex::VertexCheater::fCheatedTrackLabel

private

label for module creating recob::Track objects

Definition at line 49 of file VertexCheater_module.cc.

Referenced by produce(), and reconfigure().

std::string vertex::VertexCheater::fG4ModuleLabel

private

label for module running G4 and making particles, etc

Definition at line 51 of file VertexCheater_module.cc.

Referenced by reconfigure().

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

/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/VertexFinder/VertexCheater_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