Selects tracks with time information. More...

Inheritance diagram for sbn::TimedTrackSelector:

Classes
struct	Config
	Module configuration parameters. More...

Public Types
using	Parameters = art::SharedFilter::Table< Config >

Public Member Functions
	TimedTrackSelector (Parameters const &params, art::ProcessingFrame const &)

bool	filter (art::Event &event, art::ProcessingFrame const &) override

void	endJob (art::ProcessingFrame const &) override
	Prints end-job summary. More...

Static Public Attributes
static constexpr double	NoMinTime { std::numeric_limits<double>::lowest() }

static constexpr double	NoMaxTime { std::numeric_limits<double>::max() }

static constexpr unsigned int	NoMinTracks { 0U }

static constexpr unsigned int	NoMaxTracks { std::numeric_limits<unsigned int>::max() }

Private Member Functions
unsigned int	selectTracks (art::Assns< anab::T0, recob::PFParticle > const &timeTracks, std::vector< art::Ptr< recob::PFParticle >> &selectedTracks) const
	Adds to `selectedTracks` qualifying tracks from `timeTracks`. More...

bool	isTrackSelected (recob::PFParticle const &track, anab::T0 const &time) const
	Returns whether the specified track (with specified time) qualifies. More...

bool	selectedTracksRequirement (unsigned int nTracks) const
	Returns if the number of tracks `nTracks` satisfies filter requirements. More...

Static Private Member Functions
static bool	isTrack (recob::PFParticle const &particle)
	Returns whether the specified `particle` flow object is a track. More...

Private Attributes
std::vector< art::InputTag > const	fTrackTimeTags
	List of track-time association input tags. More...

double const	fMinT0
	Minimum track time for track selection. More...

double const	fMaxT0
	Maximum track time for track selection. More...

unsigned int const	fMinTracks
	Minimum selected tracks for event selection. More...

unsigned int const	fMaxTracks
	Maximum selected tracks for event selection. More...

bool const	fOnlyPandoraTracks
	Save only tracks identified as such. More...

bool const	fSaveTracks
	Whether to save selected tracks into the event. More...

std::string const	fLogCategory
	Message facility stream name. More...

icarus::ns::util::PassCounter	fPassRate
	Counter of passed events (not thread-safe). More...

Detailed Description

Selects tracks with time information.

This module produces a list of "tracks" that are associated to a time. Optionally, it can select only the tracks with that time in a specified range.

This module is a filter that will return true for an event if at least one of its tracks is selected. This threshold can be adjusted by configuration.

Input

The input file is expected to contain the time information and association to "tracks", which are actually represented by recob::PFParticle rather than recob::Track. Note that the track data products are not explicitly required.

Output

The filter produces a list of pointers to the selected tracks; the list will mix tracks from different data products if multiple input collections are specified. A track is selected if all the following apply:

the track is associated to a time;
only if a time range is specified, that track time must fall within.

The filter passes the event if:

the number of selected tracks is within the configured range of requested tracks per event.

Configuration options

TrackTimeTags (list of data product tags, required): data product of the times and their associations tracks.
MinT0 (real, optional): if specified, tracks are selected only if their associated time is not earlier than this value. Time is in the same time scale as the associated track time, which is expected to be the trigger time scale but in nanoseconds.
MaxT0 (real, optional): if specified, tracks are selected only if their associated time is earlier than this value. This time is in the same time scale as MinT0.
MinTracks (integer, default: 1): the filter "passes" the event only if at least these many tracks are selected; disable this by setting it to 0.
MaxTracks (integer, default: a large number): if specified, filter "passes" the event only if at most these many tracks are selected.
OnlyPandoraTracks (flag, default: true): saves only the particles which have been recognised as track-like. The definition was taken from Pandora (larpandoracontent v03_26_01) and includes charged pions and kaons, protons and muons. Note that Pandora itself does not do a full particle type identification and it uses only the codes for muons and electrons, to distinguish track-like and shower-like topologies, plus neutrino codes.
SaveTracks (flag, default: true): produces a list of art pointers to the selected particles. This is the default behaviour of the module. On the other end, the module can be used solely for its filtering capability, in which case saving the list is not necessary and this option allows omitting it.

Definition at line 111 of file TimedTrackSelector_module.cc.

Member Typedef Documentation

using sbn::TimedTrackSelector::Parameters = art::SharedFilter::Table<Config>

Definition at line 182 of file TimedTrackSelector_module.cc.

Constructor & Destructor Documentation

sbn::TimedTrackSelector::TimedTrackSelector	(	Parameters const &	params,
		art::ProcessingFrame const &
	)

explicit

Definition at line 255 of file TimedTrackSelector_module.cc.

   : art::SharedFilter{ params }
   , fTrackTimeTags{ params().TrackTimeTags() }
   , fMinT0{ params().MinT0() }
   , fMaxT0{ params().MaxT0() }
   , fMinTracks{ params().MinTracks() }
   , fMaxTracks{ params().MaxTracks() }
   , fOnlyPandoraTracks{ params().OnlyPandoraTracks() }
   , fSaveTracks{ params().SaveTracks() }
   , fLogCategory{ params().LogCategory() }
 {
   async<art::InEvent>();
   
   if (fSaveTracks)
     produces<std::vector<art::Ptr<recob::PFParticle>>>();
   
   //
   // configuration dump
   //
   {
     mf::LogInfo log{ fLogCategory };
     log << "Configuration:"
       << "\n  * tracks required to be associated to a time (cathode-crossers)"
       ;
     log << "\n  * track time:";
     if (fMinT0 == NoMinTime) {
       if (fMaxT0 == NoMaxTime) log << " any";
       else                     log << " before " << fMaxT0;
     }
     else {
       log << " from " << fMinT0;
       if (fMaxT0 == NoMaxTime) log << " on";
       else                     log << " to " << fMaxT0;
     }
     
     log << "\n  * selected tracks per event: ";
     if (fMinTracks == NoMinTracks) {
       if (fMaxTracks == NoMaxTracks) log << "any";
       else log << fMaxTracks << " or less";
     }
     else {
       if (fMaxTracks == NoMaxTracks) log << fMinTracks << " or more";
       else log << "between " << fMinTracks << " and " << fMaxTracks;
     }
     log << "\n  * selected tracks will" << (fSaveTracks? "": " not")
       << " be saved";
   } // end local scope
   
 } // sbn::TimedTrackSelector::TimedTrackSelector()

Member Function Documentation

void sbn::TimedTrackSelector::endJob ( art::ProcessingFrame const & )

override

Prints end-job summary.

Definition at line 371 of file TimedTrackSelector_module.cc.

                                                             {
   
   mf::LogInfo(fLogCategory) << "Selected " << fPassRate.passed()
     << '/' << fPassRate.total() << " events with qualifying tracks.";
   
 } // sbn::TimedTrackSelector::endJob()

bool sbn::TimedTrackSelector::filter	(	art::Event &	event,
		art::ProcessingFrame const &
	)

override

Definition at line 308 of file TimedTrackSelector_module.cc.

 {
   
   mf::LogDebug(fLogCategory) << "Processing " << event.id();
   
   //
   // select tracks from each of the input tags
   //
   std::vector<art::Ptr<recob::PFParticle>> selectedTracks;
   for (art::InputTag const& inputTag: fTrackTimeTags) {
     auto const& T0toTrack
       = event.getProduct<art::Assns<anab::T0, recob::PFParticle>>(inputTag);
     unsigned int const newTracks = selectTracks(T0toTrack, selectedTracks);
     
     mf::LogTrace(fLogCategory)
       << "From '" << inputTag.encode() << "': "
       << newTracks << " tracks selected"
       ;
     
   } // for
 
   unsigned int const nSelectedTracks = selectedTracks.size();
   
   
   //
   // save track list in the event
   //
   
   // after this, selectedTracks may be empty. JCZ: Not quite, I think the access to selectedTracks[0] in the log statement throws a segfault it it's empty, now fixed
   if (fSaveTracks) {
     event.put(
       std::make_unique<std::vector<art::Ptr<recob::PFParticle>>>(selectedTracks)
       );
     if(selectedTracks.size() > 0)
     {
       mf::LogTrace(fLogCategory)
         << "InputTag for this product is: "
         << event.getProductDescription(selectedTracks[0].id())->inputTag();
     }
   }
   
   
   //
   // filter logic
   //
   
   bool const passed = selectedTracksRequirement(nSelectedTracks);
   fPassRate.add(passed);
   mf::LogTrace(fLogCategory) << event.id()
     << ' ' << (passed? "passed": "rejected") << " (" << nSelectedTracks
     << " selected tracks)."; // funny fact: we don't know the total track count, JCZ: I think I fixed that fact although I could be completely wrong
   
   
   mf::LogDebug(fLogCategory) << "Completed " << event.id();
 
   mf::LogDebug(fLogCategory) << "There are now " << fTotalTracks << " total tracks selected.";
 
   return passed;
   
 } // sbn::TimedTrackSelector::filter()

bool sbn::TimedTrackSelector::isTrack ( recob::PFParticle const & particle )

staticprivate

Returns whether the specified particle flow object is a track.

Definition at line 431 of file TimedTrackSelector_module.cc.

                                                                    {
   
   switch (std::abs(particle.PdgCode())) {
     case 13:   // muon
     case 211:  // charged pion
     case 321:  // charged kaon
     case 2212: // proton
       return true;
     default:
       return false;
   } // switch
   
 } // sbn::TimedTrackSelector::isTrack()

bool sbn::TimedTrackSelector::isTrackSelected	(	recob::PFParticle const &	track,
		anab::T0 const &	time
	)		const

private

Returns whether the specified track (with specified time) qualifies.

Definition at line 408 of file TimedTrackSelector_module.cc.

 {
   
   double const T0 = time.Time();
   MF_LOG_TRACE(fLogCategory) << "Track time: " << T0;
   
   if (fOnlyPandoraTracks && !isTrack(track)) {
     MF_LOG_TRACE(fLogCategory) << "Not a track (ID=" << track.PdgCode()
       << ") => discarded!";
     return false;
   }
   
   if ((T0 < fMinT0) || (T0 >= fMaxT0)) {
     MF_LOG_TRACE(fLogCategory) << "Time out of range [ " << fMinT0 << "; "
       << fMaxT0 << " ] => discarded!";
     return false;
   }
   
   return true;
 } // sbn::TimedTrackSelector::isTrackSelected()

bool sbn::TimedTrackSelector::selectedTracksRequirement ( unsigned int nTracks ) const

private

Returns if the number of tracks nTracks satisfies filter requirements.

Definition at line 448 of file TimedTrackSelector_module.cc.

 {
   return (nTracks >= fMinTracks) && (nTracks <= fMaxTracks);
 } // sbn::TimedTrackSelector::selectedTracks()

unsigned int sbn::TimedTrackSelector::selectTracks	(	art::Assns< anab::T0, recob::PFParticle > const &	timeTracks,
		std::vector< art::Ptr< recob::PFParticle >> &	selectedTracks
	)		const

private

Adds to selectedTracks qualifying tracks from timeTracks.

Parameters

	timeTracks	time/track associations
[out]	selectedTracks	collection to expand with the qualifying tracks

Returns: the number of qualifying tracks found in timeTracks and added

Definition at line 380 of file TimedTrackSelector_module.cc.

         {
   
   unsigned int nSelectedTracks { 0U };
   for (auto const& [ t0Ptr, trackPtr ]: timeTracks) {
     
     // if fOnlyPandoraTracks is false, we don't need the track, so we avoid
     // dereferencing the pointer: a reference from a null pointer will be
     // passed around and will cause a segmentation violation at the first access
     recob::PFParticle const* track = fOnlyPandoraTracks? &*trackPtr: nullptr;
     
     if (!isTrackSelected(*track, *t0Ptr)) continue;
     
     MF_LOG_TRACE(fLogCategory) << "Track #" << trackPtr.key() << " selected.";
     
     selectedTracks.push_back(trackPtr);
     ++nSelectedTracks;
     ++fTotalTracks;
   } // for
   
   return nSelectedTracks;
   
 } // sbn::TimedTrackSelector::selectTracks()