Prints the content of all the tracks on screen. More...

Inheritance diagram for recob::DumpTracks:

Classes
struct	Config
	Configuration object. More...

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

using	ModuleType = EDAnalyzer

Public Member Functions
	DumpTracks (Parameters const &config)
	Default constructor. More...

void	analyze (const art::Event &evt)
	Does the printing. More...

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)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

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

Private Member Functions
void	DumpTrack (unsigned int iTrack, recob::Track const &track) const
	Dumps information about the specified track. More...

Private Attributes
art::InputTag	fTrackModuleLabel
	name of module that produced the tracks More...

std::string	fOutputCategory
	category for LogInfo output More...

unsigned int	fPrintWayPoints
	number of printed way points More...

bool	fPrintNHits
	prints the number of associated hits More...

bool	fPrintNSpacePoints
	prints the number of associated space points More...

bool	fPrintNParticles
	prints the number of associated PFParticles More...

bool	fPrintHits
	prints the index of associated hits More...

bool	fPrintSpacePoints
	prints the index of associated space points More...

bool	fPrintParticles
	prints the index of associated PFParticles More...

Detailed Description

Prints the content of all the tracks on screen.

This analyser prints the content of all the tracks into the LogInfo/LogVerbatim stream. The associated objects are printed only if they were produced with the same input tag as the tracks.

Configuration parameters

TrackModuleLabel (string, required): label of the producer used to create the recob::Track collection to be dumped
OutputCategory (string, default: "DumpTracks"): the category used for the output (useful for filtering)
WayPoints (unsigned integer, default: 10): approximate number of way points printed in the output
SpacePointAssociations (boolean, default: true): prints the number of space points associated with the tracks
PrintSpacePoints (boolean, default: false): print the index of all hits associated with the tracks
HitAssociations (boolean, default: true): prints the number of hits associated with the tracks
PrintHits (boolean, default: false): print the index of all hits associated with the tracks
ParticleAssociations (boolean, default: true): prints the number of particle-flow particles associated with the tracks

Definition at line 215 of file DumpTracks_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

using recob::DumpTracks::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 253 of file DumpTracks_module.cc.

Constructor & Destructor Documentation

recob::DumpTracks::DumpTracks ( Parameters const & config )

explicit

Default constructor.

Definition at line 285 of file DumpTracks_module.cc.

     : EDAnalyzer(config)
     , fTrackModuleLabel(config().TrackModuleLabel())
     , fOutputCategory(config().OutputCategory())
     , fPrintWayPoints(config().WayPoints())
     , fPrintNHits(config().HitAssociations())
     , fPrintNSpacePoints(config().SpacePointAssociations())
     , fPrintNParticles(config().ParticleAssociations())
     , fPrintHits(config().PrintHits())
     , fPrintSpacePoints(config().PrintSpacePoints())
     , fPrintParticles(config().ParticleAssociations())
   {}

Member Function Documentation

void recob::DumpTracks::analyze ( const art::Event & evt )

Does the printing.

Definition at line 299 of file DumpTracks_module.cc.

References DumpTrack(), art::InputTag::encode(), fOutputCategory, fPrintHits, fPrintNHits, fPrintNParticles, fPrintNSpacePoints, fPrintParticles, fPrintSpacePoints, fTrackModuleLabel, art::ProductRetriever::getValidHandle(), art::errors::ProductNotFound, art::PtrVector< T >::size(), and track.

   {
 
     // fetch the data to be dumped on screen
     auto Tracks = evt.getValidHandle<std::vector<recob::Track>>(fTrackModuleLabel);
 
     mf::LogInfo(fOutputCategory) << "The event contains " << Tracks->size() << " '"
                                  << fTrackModuleLabel.encode() << "'tracks";
 
     std::unique_ptr<art::FindManyP<recob::Hit>> pHits(
       fPrintNHits ? new art::FindManyP<recob::Hit>(Tracks, evt, fTrackModuleLabel) : nullptr);
     if (pHits && !pHits->isValid()) {
       throw art::Exception(art::errors::ProductNotFound)
         << "No hit associated with '" << fTrackModuleLabel.encode() << "' tracks.\n";
     }
 
     std::unique_ptr<art::FindManyP<recob::SpacePoint>> pSpacePoints(
       fPrintNSpacePoints ? new art::FindManyP<recob::SpacePoint>(Tracks, evt, fTrackModuleLabel) :
                            nullptr);
     if (pSpacePoints && !pSpacePoints->isValid()) {
       throw art::Exception(art::errors::ProductNotFound)
         << "No space point associated with '" << fTrackModuleLabel.encode() << "' tracks.\n";
     }
 
     std::unique_ptr<art::FindManyP<recob::PFParticle>> pPFParticles(
       fPrintNParticles ? new art::FindManyP<recob::PFParticle>(Tracks, evt, fTrackModuleLabel) :
                          nullptr);
     if (pPFParticles && !pPFParticles->isValid()) {
       throw art::Exception(art::errors::ProductNotFound)
         << "No particle-flow particle associated with '" << fTrackModuleLabel.encode()
         << "' tracks.\n";
     }
 
     for (unsigned int iTrack = 0; iTrack < Tracks->size(); ++iTrack) {
       const recob::Track& track = Tracks->at(iTrack);
 
       // print track information
       DumpTrack(iTrack, track);
 
       mf::LogVerbatim log(fOutputCategory);
       if (pHits || pSpacePoints || pPFParticles) {
         log << "\n  associated with:";
         if (pHits) log << " " << pHits->at(iTrack).size() << " hits;";
         if (pSpacePoints) log << " " << pSpacePoints->at(iTrack).size() << " space points;";
         if (pPFParticles) log << " " << pPFParticles->at(iTrack).size() << " PF particles;";
       } // if we have any association
 
       if (pHits && fPrintHits) {
         const auto& Hits = pHits->at(iTrack);
         log << "\n  hit indices (" << Hits.size() << "):\n";
         PrintAssociatedIndexTable(log, Hits, 10 /* 10 hits per line */, "    ");
       } // if print individual hits
 
       if (pSpacePoints && fPrintSpacePoints) {
         const auto& SpacePoints = pSpacePoints->at(iTrack);
         log << "\n  space point IDs (" << SpacePoints.size() << "):\n";
         PrintAssociatedIDTable(log, SpacePoints, 10 /* 10 hits per line */, "    ");
       } // if print individual space points
 
       if (pPFParticles && fPrintParticles) {
         const auto& PFParticles = pPFParticles->at(iTrack);
         log << "\n  particle indices (" << PFParticles.size() << "):\n";
         // currently a particle has no ID
         PrintAssociatedIndexTable(log, PFParticles, 10 /* 10 hits per line */, "    ");
       } // if print individual particles
     }   // for tracks
   }     // DumpTracks::analyze()

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::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
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void recob::DumpTracks::DumpTrack	(	unsigned int	iTrack,
		recob::Track const &	track
	)		const

private

Dumps information about the specified track.

Definition at line 368 of file DumpTracks_module.cc.

References DEFINE_ART_MODULE, recob::Track::End(), recob::Track::EndDirection(), fOutputCategory, fPrintWayPoints, recob::Track::ID(), recob::Track::Length(), recob::Track::LocationAtPoint(), recob::Track::NumberTrajectoryPoints(), recob::Track::Phi(), recob::Track::Theta(), recob::Track::Vertex(), and recob::Track::VertexDirection().

Referenced by analyze().

   {
     // print a header for the track
     const unsigned int nPoints = track.NumberTrajectoryPoints();
     mf::LogVerbatim log(fOutputCategory);
     log << "Track #" << iTrack << " ID: " << track.ID() << std::fixed << std::setprecision(3)
         << " theta: " << track.Theta() << " rad, phi: " << track.Phi()
         << " rad, length: " << track.Length() << " cm"
         << "\n  start at: ( " << track.Vertex().X() << " ; " << track.Vertex().Y() << " ; "
         << track.Vertex().Z() << " ), direction: ( " << track.VertexDirection().X() << " ; "
         << track.VertexDirection().Y() << " ; " << track.VertexDirection().Z() << " )"
         << "\n  end at:   ( " << track.End().X() << " ; " << track.End().Y() << " ; "
         << track.End().Z() << " ), direction: ( " << track.EndDirection().X() << " ; "
         << track.EndDirection().Y() << " ; " << track.EndDirection().Z() << " )"
         << "\n  with " << nPoints << " trajectory points";
 
     if (fPrintWayPoints > 0) {
       // print up to 10 (actually, 8 or 9) way points
       log << "\n  passes through:";
       unsigned int skip = std::max(nPoints / fPrintWayPoints, 1U);
       unsigned int iPoint = 0;
       while ((iPoint += skip) < nPoints) {
         const auto& point = track.LocationAtPoint(iPoint);
         log << "\n    [#" << iPoint << "] (" << point.X() << ", " << point.Y() << ", " << point.Z()
             << ")";
       } // while (iPoint)
     }   // if print way points
   }     // DumpTracks::DumpTrack()

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

std::string recob::DumpTracks::fOutputCategory

private

category for LogInfo output

Definition at line 263 of file DumpTracks_module.cc.

Referenced by analyze(), and DumpTrack().

bool recob::DumpTracks::fPrintHits

private

prints the index of associated hits

Definition at line 269 of file DumpTracks_module.cc.

Referenced by analyze().

bool recob::DumpTracks::fPrintNHits

private

prints the number of associated hits

Definition at line 266 of file DumpTracks_module.cc.

Referenced by analyze().

bool recob::DumpTracks::fPrintNParticles

private

prints the number of associated PFParticles

Definition at line 268 of file DumpTracks_module.cc.

Referenced by analyze().

bool recob::DumpTracks::fPrintNSpacePoints

private

prints the number of associated space points

Definition at line 267 of file DumpTracks_module.cc.

Referenced by analyze().

bool recob::DumpTracks::fPrintParticles

private

prints the index of associated PFParticles

Definition at line 271 of file DumpTracks_module.cc.

Referenced by analyze().

bool recob::DumpTracks::fPrintSpacePoints

private

prints the index of associated space points

Definition at line 270 of file DumpTracks_module.cc.

Referenced by analyze().

unsigned int recob::DumpTracks::fPrintWayPoints

private

number of printed way points

Definition at line 264 of file DumpTracks_module.cc.

Referenced by DumpTrack().

art::InputTag recob::DumpTracks::fTrackModuleLabel

private

name of module that produced the tracks

Definition at line 262 of file DumpTracks_module.cc.

Referenced by analyze().

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

lardata/v10_00_08/source/lardata/ArtDataHelper/Dumpers/DumpTracks_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation