Inheritance diagram for trkf::TrackCheater:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

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

virtual	~TrackCheater ()

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

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

Detailed Description

Definition at line 46 of file TrackCheater_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

trkf::TrackCheater::TrackCheater ( fhicl::ParameterSet const & pset )

explicit

Definition at line 66 of file TrackCheater_module.cc.

References reconfigure().

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

trkf::TrackCheater::~TrackCheater ( )

virtual

Definition at line 78 of file TrackCheater_module.cc.

79 {

80 }

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

virtual

Implements art::EDProducer.

Definition at line 92 of file TrackCheater_module.cc.

References recob::tracking::convertCollToPoint(), recob::tracking::convertCollToVector(), util::CreateAssn(), DEFINE_ART_MODULE, fCheatedClusterLabel, art::fill_ptr_vector(), art::DataViewImpl::getByLabel(), hits(), cheat::BackTrackerService::HitToXYZ(), geo::kCollection, max, simb::MCParticle::NumberTrajectoryPoints(), simb::MCParticle::P(), part, cheat::ParticleInventoryService::ParticleList(), simb::MCParticle::PdgCode(), art::PtrVector< T >::push_back(), art::Event::put(), pmtana::sign(), art::PtrVector< T >::size(), simb::MCParticle::Vx(), simb::MCParticle::Vy(), and simb::MCParticle::Vz().

   {
     art::ServiceHandle<cheat::ParticleInventoryService> pi_serv;
     art::ServiceHandle<cheat::BackTrackerService> bt_serv;
     art::ServiceHandle<geo::Geometry>            geo;
 
     // grab the clusters that have been reconstructed
     art::Handle< std::vector<recob::Cluster> > clustercol;
     evt.getByLabel(fCheatedClusterLabel, clustercol);
 
     art::FindManyP<recob::Hit> fmh(clustercol, evt, fCheatedClusterLabel);
 
     // 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::Cluster> > clusters;
     art::fill_ptr_vector(clusters, clustercol);
     
     // loop over the clusters and figure out which particle contributed to each one
     std::vector< art::Ptr<recob::Cluster> >::iterator itr = clusters.begin();
 
     // make a map of vectors of art::Ptrs keyed by eveID values
     std::map< int, std::vector< std::pair<size_t, art::Ptr<recob::Cluster> > > > eveClusterMap;
 
     // loop over all clusters and fill in the map
     for(size_t c = 0; c < clusters.size(); ++c){
 
       std::pair<size_t, art::Ptr<recob::Cluster> > idxPtr(c, clusters[c]);
 
       // in the ClusterCheater module we set the cluster ID to be 
       // the eve particle track ID*1000 + plane*100 + tpc*10 + cryostat number.  The
       // floor function on the cluster ID / 1000 will give us
       // the eve track ID
       int eveID = floor((*itr)->ID()/1000.);
 
       eveClusterMap[eveID].push_back(idxPtr);
       ++itr;
     }// end loop over clusters
 
     // loop over the map and make prongs
     std::unique_ptr< std::vector<recob::Track> >                   trackcol(new std::vector<recob::Track>);
     std::unique_ptr< std::vector<recob::SpacePoint> >              spcol  (new std::vector<recob::SpacePoint>);
     std::unique_ptr< art::Assns<recob::Track, recob::SpacePoint> > tspassn(new art::Assns<recob::Track, recob::SpacePoint>);
     std::unique_ptr< art::Assns<recob::Track, recob::Cluster> >    tcassn (new art::Assns<recob::Track, recob::Cluster>);
     std::unique_ptr< art::Assns<recob::Track, recob::Hit> >        thassn (new art::Assns<recob::Track, recob::Hit>);
 
     for(auto const& clusterMapItr : eveClusterMap){
 
       // separate out the hits for each particle into the different views
       std::vector< std::pair<size_t, art::Ptr<recob::Cluster> > > const& eveClusters = clusterMapItr.second;
 
       simb::MCParticle *part = pi_serv->ParticleList()[clusterMapItr.first];
 
       // is this prong electro-magnetic in nature or 
       // hadronic/muonic?  EM --> shower, everything else is a track
       if( abs(part->PdgCode()) != 11  &&
           abs(part->PdgCode()) != 22  &&
           abs(part->PdgCode()) != 111 ){
 
         // vectors to hold the positions and directions of the track
         std::vector<TVector3> points;
         std::vector<TVector3> moms;
 
         // size_t nviews = geo->Nviews();
         // std::vector< std::vector<double> > dQdx(nviews);
 
         mf::LogInfo("TrackCheater") << "G4 id " << clusterMapItr.first 
                                     << " is a track with pdg code "
                                     << part->PdgCode();
 
         art::PtrVector<recob::Cluster> ptrvs;
         std::vector<size_t> idxs;
         for(auto const& idxPtr : eveClusters){
           ptrvs.push_back(idxPtr.second);
           idxs.push_back(idxPtr.first);
         }
 
         // grab the hits associated with the collection plane
         std::vector< art::Ptr<recob::Hit> > hits;
         for(size_t p = 0; p < ptrvs.size(); ++p){
           std::vector< art::Ptr<recob::Hit> > chits = fmh.at(idxs[p]);
           if (!chits.size()) continue;
           if (chits[0]->SignalType() != geo::kCollection) continue;
           hits.insert(hits.end(), chits.begin(), chits.end());
         }
 
         // need at least 2 hits to make a track
         if(hits.size() < 2) continue;
 
         // loop over the hits to get the positions and directions
         size_t spStart = spcol->size();
         for(size_t t = 0; t < hits.size(); ++t){
           std::vector<double> xyz = bt_serv->HitToXYZ(hits[t]);
           TVector3 point(xyz[0], xyz[1], xyz[2]);
           points.push_back(point);
 
           std::vector<double> xyz1;
           //double charge = hits[t]->Integral();
           double dx     = 0.;
           double sign   = 1.;
 
           if(t < hits.size()-1){
             xyz1 = bt_serv->HitToXYZ(hits[t+1]);
           }
           else{
             xyz1 = bt_serv->HitToXYZ(hits[t-1]);
             sign = -1.;
           }
 
           // dx is always positive
           dx = std::sqrt(std::pow(xyz1[0] - xyz[0], 2) + 
                          std::pow(xyz1[1] - xyz[1], 2) + 
                          std::pow(xyz1[2] - xyz[2], 2));
 
           // figure out momentum
           double mom = 0;
           double drmin = std::numeric_limits<double>::max();
           for (unsigned int itp = 0; itp<part->NumberTrajectoryPoints(); itp++) {
             TVector3 p(part->Vx(itp), part->Vy(itp), part->Vz(itp));
             double dr = (p-point).Mag();
             if ( dr<drmin ) {
               mom = part->P(itp);
               drmin = dr;
             }
           }
           
           // direction is always from the previous point along track to
           // the next point, that is why sign is there
           moms.push_back(TVector3(mom*sign*(xyz1[0] - xyz[0])/dx,
                                   mom*sign*(xyz1[1] - xyz[1])/dx,
                                   mom*sign*(xyz1[2] - xyz[2])/dx));
 
           /*************************************************************/
           /*                          WARNING                          */
           /*************************************************************/
           /* The dQdx information in recob::Track has been deprecated  */
           /* since 2016 and in 11/2018 the recob::Track interface was  */
           /* changed and DQdxAtPoint and NumberdQdx were removed.      */
           /* Therefore the code below is now commented out             */
           /* (note that it was most likely not functional anyways).    */
           /* For any issue please contact: larsoft-team@fnal.gov       */
           /*************************************************************/
           /*
             dQdx[0].push_back(charge/dx);
             dQdx[1].push_back(charge/dx);
             dQdx[2].push_back(charge/dx);
           */
           /*************************************************************/
 
           // make the space point and set its ID and XYZ
           double xyzerr[6] = {1.e-3};
           double chisqr    = 0.9;
           recob::SpacePoint sp(&xyz[0], xyzerr, chisqr, clusterMapItr.first*10000 + t);
           spcol->push_back(sp);
         }
         
         size_t spEnd = spcol->size();
         
         // add a track to the collection.  Make the track
         // ID be the same as the track ID for the eve particle
         trackcol->push_back(recob::Track(recob::TrackTrajectory(recob::tracking::convertCollToPoint(points),
                                                                 recob::tracking::convertCollToVector(moms),
                                                                 recob::Track::Flags_t(points.size()), true),
                                          0, -1., 0, recob::tracking::SMatrixSym55(), recob::tracking::SMatrixSym55(), clusterMapItr.first));
 
         // associate the track with its clusters
         util::CreateAssn(*this, evt, *trackcol, ptrvs, *tcassn);
 
         // assume the input tracks were previously associated with hits
         hits.clear();
         for(size_t p = 0; p < ptrvs.size(); ++p){
           hits  = fmh.at(idxs[p]);
           util::CreateAssn(*this, evt, *trackcol, hits, *thassn);
         }
 
         // associate the track to the space points
         util::CreateAssn(*this, evt, *trackcol, *spcol, *tspassn, spStart, spEnd);
 
         mf::LogInfo("TrackCheater") << "adding track: \n" 
                                      << trackcol->back()
                                      << "\nto collection.";
 
       }//end if this is a track
 
     } // end loop over the map
 
     evt.put(std::move(trackcol));
     evt.put(std::move(spcol));
     evt.put(std::move(tcassn));
     evt.put(std::move(thassn));
     evt.put(std::move(tspassn));
 
     return;
 
   } // end produce

void trkf::TrackCheater::reconfigure ( fhicl::ParameterSet const & pset )

Definition at line 83 of file TrackCheater_module.cc.

References fCheatedClusterLabel, fG4ModuleLabel, and fhicl::ParameterSet::get().

Referenced by TrackCheater().

   {
     fCheatedClusterLabel = pset.get< std::string >("CheatedClusterLabel", "cluster" );
     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 trkf::TrackCheater::fCheatedClusterLabel

private

label for module creating recob::Cluster objects

Definition at line 57 of file TrackCheater_module.cc.

Referenced by produce(), and reconfigure().

std::string trkf::TrackCheater::fG4ModuleLabel

private

label for module running G4 and making particles, etc

Definition at line 58 of file TrackCheater_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/TrackFinder/TrackCheater_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