Module: creates tracks from simulated particles. More...

Inheritance diagram for lar::example::TotallyCheatTracker:

Classes
struct	Config
	Module configuration data. More...

Public Types
using	Parameters = art::EDProducer::Table< Config >
	Standard art alias for module configuration table. More...

Public Member Functions
	TotallyCheatTracker (Parameters const &config)
	Constructor; see the class documentation for the configuration. More...

virtual void	produce (art::Event &event) override

bool	acceptParticle (simb::MCParticle const &particle) const
	Returns whether the `particle` satisfies the selection criteria. More...

Private Attributes
art::InputTag	particleTag
	Label of the input data product. More...

double	minLength
	Minimum particle length [cm]. More...

double	minEnergy
	Minimum energy [GeV]. More...

lar::example::TotallyCheatTrackingAlg	trackMaker
	Reconstruction algorithm. More...

Detailed Description

Module: creates tracks from simulated particles.

See Also: TotallyCheatTracks example overview

This module creates one LArSoft reconstructed track (lar::example::CheatTrack) for each input simulated particle (simb::MCParticle) passing the selection criteria.

Input

A collection of simb::MCParticle is required.

Output

A collection of lar::example::CheatTrack is produced, a one-to-one association of each of them to its original simb::MCParticle. Associations are inserted in the same order as the trajectories.

Configuration parameters

particles (input tag, default: largeant): label of the data product with input simulated particles
minLength (parameter set, default: 1.0): minimum length of the particle trajectory, in centimeters
minEnergy (parameter set, default: 1.0): minimum energy of the particle, in GeV

Definition at line 73 of file TotallyCheatTracker_module.cc.

Member Typedef Documentation

using lar::example::TotallyCheatTracker::Parameters = art::EDProducer::Table<Config>

Standard art alias for module configuration table.

Definition at line 110 of file TotallyCheatTracker_module.cc.

Constructor & Destructor Documentation

lar::example::TotallyCheatTracker::TotallyCheatTracker ( Parameters const & config )

explicit

Constructor; see the class documentation for the configuration.

Definition at line 144 of file TotallyCheatTracker_module.cc.

   : EDProducer{config}
   , particleTag(config().particles())
   , minLength(config().minLength())
   , minEnergy(config().minEnergy())
   , trackMaker(config().algoConfig())
 {
 
   consumes<std::vector<simb::MCParticle>>(particleTag);
 
   produces<std::vector<lar::example::CheatTrack>>();
   produces<art::Assns<lar::example::CheatTrack, simb::MCParticle>>();
 
 } // lar::example::TotallyCheatTracker::TotallyCheatTracker()

Member Function Documentation

bool lar::example::TotallyCheatTracker::acceptParticle ( simb::MCParticle const & particle ) const

Returns whether the particle satisfies the selection criteria.

Definition at line 228 of file TotallyCheatTracker_module.cc.

 {
   // skip empty particle
   if (particle.NumberTrajectoryPoints() == 0) return false;
 
   // energy at the first point
   if (particle.E() < minEnergy) return false;
 
   // path length
   if (particle.Trajectory().TotalLength() < minLength) return false;
 
   // good enough!
   return true;
 
 } // lar::example::TotallyCheatTracker::acceptParticle()

void lar::example::TotallyCheatTracker::produce ( art::Event & event )

overridevirtual

Definition at line 161 of file TotallyCheatTracker_module.cc.

                                                            {
 
   //
   // read the input
   //
   auto particleHandle
     = event.getValidHandle<std::vector<simb::MCParticle>>(particleTag);
   auto const& particles = *particleHandle;
 
   //
   // prepare the output structures
   //
   auto tracks = std::make_unique<std::vector<lar::example::CheatTrack>>();
   auto trackToPart =
     std::make_unique<art::Assns<lar::example::CheatTrack, simb::MCParticle>>();
 
   art::PtrMaker<simb::MCParticle> makePartPtr(event, particleHandle.id());
   art::PtrMaker<lar::example::CheatTrack> makeTrackPtr(event);
 
 
   //
   // set up the algorithm
   //
   trackMaker.setup();
 
   //
   // run the algorithm
   //
   for (std::size_t iParticle = 0U; iParticle < particles.size(); ++iParticle) {
     simb::MCParticle const& particle = particles[iParticle];
 
     //
     // apply filters
     //
     if (!acceptParticle(particle)) continue;
 
     //
     // run the algorithm
     //
     tracks->push_back(trackMaker.makeTrack(particle));
 
     //
     // create the association
     //
     auto const iTrack = tracks->size() - 1;
     art::Ptr<lar::example::CheatTrack> const trackPtr = makeTrackPtr(iTrack);
     art::Ptr<simb::MCParticle> const partPtr = makePartPtr(iParticle);
     trackToPart->addSingle(trackPtr, partPtr);
 
   } // for
 
   //
   // store the data products into the event (and print a short summary)
   //
   mf::LogInfo("TotallyCheatTracker")
     << "Reconstructed " << tracks->size() << " tracks out of "
     << particleHandle->size() << " particles from '"
     << particleTag.encode() << "'";
 
   event.put(std::move(tracks));
   event.put(std::move(trackToPart));
 
 } // lar::example::TotallyCheatTracker::produce()