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 Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

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...

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

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)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

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)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

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...

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
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 ()

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

Implements art::EDProducer.

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()