recob::DumpTracks Class Reference

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 >
Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
	DumpTracks (Parameters const &config)
	Default constructor. More...
void	analyze (const art::Event &evt)
	Does the printing. More...
Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDAnalyzer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept
	Analyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	Analyzer (Table< Config > const &config)
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::Observer
	~Observer () noexcept
	Observer (Observer const &)=delete
	Observer (Observer &&)=delete
Observer &	operator= (Observer const &)=delete
Observer &	operator= (Observer &&)=delete
void	registerProducts (ProductDescriptions &, ModuleDescription const &)
void	fillDescriptions (ModuleDescription const &)
fhicl::ParameterSetID	selectorConfig () const
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 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...

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const
bool	wantAllEvents () const noexcept
bool	wantEvent (ScheduleID id, Event const &e) const
Handle< TriggerResults >	getTriggerResults (Event const &e) const
	Observer (fhicl::ParameterSet const &config)
	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
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

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 228 of file DumpTracks_module.cc.

Member Typedef Documentation

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

Definition at line 278 of file DumpTracks_module.cc.

Constructor & Destructor Documentation

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

explicit

Default constructor.

Definition at line 312 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 326 of file DumpTracks_module.cc.

                                              {

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

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

private

Dumps information about the specified track.

Definition at line 412 of file DumpTracks_module.cc.

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

Member Data Documentation

std::string recob::DumpTracks::fOutputCategory

private

category for LogInfo output

Definition at line 289 of file DumpTracks_module.cc.

bool recob::DumpTracks::fPrintHits

private

prints the index of associated hits

Definition at line 295 of file DumpTracks_module.cc.

bool recob::DumpTracks::fPrintNHits

private

prints the number of associated hits

Definition at line 292 of file DumpTracks_module.cc.

bool recob::DumpTracks::fPrintNParticles

private

prints the number of associated PFParticles

Definition at line 294 of file DumpTracks_module.cc.

bool recob::DumpTracks::fPrintNSpacePoints

private

prints the number of associated space points

Definition at line 293 of file DumpTracks_module.cc.

bool recob::DumpTracks::fPrintParticles

private

prints the index of associated PFParticles

Definition at line 297 of file DumpTracks_module.cc.

bool recob::DumpTracks::fPrintSpacePoints

private

prints the index of associated space points

Definition at line 296 of file DumpTracks_module.cc.

unsigned int recob::DumpTracks::fPrintWayPoints

private

number of printed way points

Definition at line 290 of file DumpTracks_module.cc.

art::InputTag recob::DumpTracks::fTrackModuleLabel

private

name of module that produced the tracks

Definition at line 288 of file DumpTracks_module.cc.

---

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

• lardata/lardata/ArtDataHelper/Dumpers/DumpTracks_module.cc