Inheritance diagram for lar_pandora::LArPandoraEventDump:

Classes
class	PandoraData
	Class holding the handle for all of the data types from Pandora. More...

Public Types
using	ModuleType = EDAnalyzer

Public Member Functions
	LArPandoraEventDump (fhicl::ParameterSet const &pset)

	LArPandoraEventDump (LArPandoraEventDump const &)=delete

	LArPandoraEventDump (LArPandoraEventDump &&)=delete

LArPandoraEventDump &	operator= (LArPandoraEventDump const &)=delete

LArPandoraEventDump &	operator= (LArPandoraEventDump &&)=delete

void	analyze (art::Event const &evt) override

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 Types
template<class T >
using	Collection = art::Handle< std::vector< T >>

template<class T >
using	Association = art::FindManyP< T >

Private Member Functions
void	PrintEventMetadata (const art::Event &evt) const
	Print the metadata about the event. More...

void	PrintEventSummary (const PandoraData &data) const
	Print a summary of the event similar to the standard event dump. More...

void	PrintPFParticleHierarchy (const PandoraData &data) const
	Print the full PFParticle Hierarchy. More...

void	BuildPFParticleMap (const PandoraData &data, PFParticleMap &pfParticleMap) const
	Build the map from PFParticle ID to PFParticle from the input data. More...

void	PrintParticle (const art::Ptr< recob::PFParticle > &particle, const PFParticleMap &pfParticleMap, const PandoraData &data, const unsigned int depth) const
	Print a given PFParticle. More...

void	PrintHit (const art::Ptr< recob::Hit > &hit, const unsigned int depth) const
	Print a given Hit. More...

void	PrintSlice (const art::Ptr< recob::Slice > &slice, const PandoraData &data, const unsigned int depth) const
	Print a given Slice. More...

void	PrintCluster (const art::Ptr< recob::Cluster > &cluster, const PandoraData &data, const unsigned int depth) const
	Print a given Cluster. More...

void	PrintVertex (const art::Ptr< recob::Vertex > &vertex, const unsigned int depth) const
	Print a given Vertex. More...

void	PrintSpacePoint (const art::Ptr< recob::SpacePoint > &spacePoint, const PandoraData &data, const unsigned int depth) const
	Print a given SpacePoint. More...

void	PrintTrack (const art::Ptr< recob::Track > &track, const PandoraData &data, const unsigned int depth) const
	Print a given Track. More...

void	PrintShower (const art::Ptr< recob::Shower > &shower, const PandoraData &data, const unsigned int depth) const
	Print a given Shower. More...

void	PrintRule (const unsigned int depth) const
	Print a horizontal line. More...

void	PrintTitle (const std::string &name, const unsigned int depth) const
	Print a title line. More...

template<class T >
void	PrintProperty (const std::string &name, const T &value, const unsigned int depth) const
	Print a given property with the correct amount of whitespace. More...

Private Attributes
std::string	m_verbosityLevel
	The level of verbosity to use. More...

std::string	m_pandoraLabel
	The label of the Pandora pattern recognition producer. More...

std::string	m_trackLabel
	The track producer label. More...

std::string	m_showerLabel
	The shower producer label. More...

Detailed Description

Definition at line 31 of file LArPandoraEventDump_module.cc.

Member Typedef Documentation

template<class T >

using lar_pandora::LArPandoraEventDump::Association = art::FindManyP<T>

private

Definition at line 47 of file LArPandoraEventDump_module.cc.

template<class T >

using lar_pandora::LArPandoraEventDump::Collection = art::Handle<std::vector<T>>

private

Definition at line 44 of file LArPandoraEventDump_module.cc.

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

Constructor & Destructor Documentation

lar_pandora::LArPandoraEventDump::LArPandoraEventDump ( fhicl::ParameterSet const & pset )

explicit

Definition at line 292 of file LArPandoraEventDump_module.cc.

References fhicl::ParameterSet::get(), and m_verbosityLevel.

     : EDAnalyzer(pset)
     , m_pandoraLabel(pset.get<std::string>("PandoraLabel"))
     , m_trackLabel(pset.get<std::string>("TrackLabel", ""))
     , m_showerLabel(pset.get<std::string>("ShowerLabel", ""))
   {
     m_verbosityLevel = pset.get<std::string>("VerbosityLevel");
     std::transform(
       m_verbosityLevel.begin(), m_verbosityLevel.end(), m_verbosityLevel.begin(), ::tolower);
 
     if (m_verbosityLevel != "brief" && m_verbosityLevel != "summary" &&
         m_verbosityLevel != "detailed" && m_verbosityLevel != "extreme") {
       throw cet::exception("LArPandoraEventDump")
         << "Unknown verbosity level: " << m_verbosityLevel << std::endl;
     }
   }

lar_pandora::LArPandoraEventDump::LArPandoraEventDump ( LArPandoraEventDump const & )

delete

lar_pandora::LArPandoraEventDump::LArPandoraEventDump ( LArPandoraEventDump && )

delete

Member Function Documentation

void lar_pandora::LArPandoraEventDump::analyze ( art::Event const & evt )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 311 of file LArPandoraEventDump_module.cc.

References m_pandoraLabel, m_showerLabel, m_trackLabel, m_verbosityLevel, PrintEventMetadata(), PrintEventSummary(), and PrintPFParticleHierarchy().

   {
     // Load the Pandora owned collections from the event
     PandoraData data(evt, m_pandoraLabel, m_trackLabel, m_showerLabel);
 
     this->PrintEventMetadata(evt);
     this->PrintEventSummary(data);
 
     if (m_verbosityLevel != "brief") this->PrintPFParticleHierarchy(data);
   }

void lar_pandora::LArPandoraEventDump::BuildPFParticleMap	(	const PandoraData &	data,
		PFParticleMap &	pfParticleMap
	)		const

private

Build the map from PFParticle ID to PFParticle from the input data.

Parameters

data	the pandora collections and associations
pfParticleMap	the output PFParticle map

Definition at line 432 of file LArPandoraEventDump_module.cc.

References lar_pandora::LArPandoraEventDump::PandoraData::m_pfParticleCollection, and recob::PFParticle::Self().

Referenced by PrintPFParticleHierarchy().

   {
     for (unsigned int i = 0; i < data.m_pfParticleCollection->size(); ++i) {
       const art::Ptr<recob::PFParticle> particle(data.m_pfParticleCollection, i);
       pfParticleMap[particle->Self()] = particle;
     }
   }

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);
   }

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";
   }

LArPandoraEventDump& lar_pandora::LArPandoraEventDump::operator= ( LArPandoraEventDump const & )

delete

LArPandoraEventDump& lar_pandora::LArPandoraEventDump::operator= ( LArPandoraEventDump && )

delete

void lar_pandora::LArPandoraEventDump::PrintCluster	(	const art::Ptr< recob::Cluster > &	cluster,
		const PandoraData &	data,
		const unsigned int	depth
	)		const

private

Print a given Cluster.

Parameters

cluster	the cluster to print
data	the pandora collections and associations
depth	the number of characters to indent

Definition at line 593 of file LArPandoraEventDump_module.cc.

References hits(), recob::Cluster::ID(), art::Ptr< T >::key(), lar_pandora::LArPandoraEventDump::PandoraData::m_pClusterToHitAssociation, m_verbosityLevel, PrintHit(), PrintProperty(), PrintTitle(), and recob::Cluster::View().

Referenced by PrintParticle().

   {
     this->PrintTitle("Cluster", depth);
     this->PrintProperty("Key", cluster.key(), depth + 2);
     this->PrintProperty("ID", cluster->ID(), depth + 2);
     this->PrintProperty("View", cluster->View(), depth + 2);
 
     if (!data.m_pClusterToHitAssociation) return;
 
     const auto& hits(data.m_pClusterToHitAssociation->at(cluster.key()));
     this->PrintProperty("# Hits", hits.size(), depth + 2);
 
     if (m_verbosityLevel == "detailed") return;
 
     // Print each associated hit
     for (const auto& hit : hits)
       this->PrintHit(hit, depth + 4);
   }

void lar_pandora::LArPandoraEventDump::PrintEventMetadata ( const art::Event & evt ) const

private

Print the metadata about the event.

Parameters

evt	the art event

Definition at line 324 of file LArPandoraEventDump_module.cc.

References art::Event::event(), art::Event::run(), and art::Event::subRun().

Referenced by analyze().

   {
     std::cout << std::string(80, '=') << std::endl;
     std::cout << "run    : " << evt.run() << std::endl;
     std::cout << "subRun : " << evt.subRun() << std::endl;
     std::cout << "event  : " << evt.event() << std::endl;
     std::cout << std::endl;
   }

void lar_pandora::LArPandoraEventDump::PrintEventSummary ( const PandoraData & data ) const

private

Print a summary of the event similar to the standard event dump.

Parameters

data	the pandora collections and associations

Definition at line 335 of file LArPandoraEventDump_module.cc.

Referenced by analyze().

   {
     std::cout << std::string(80, '-') << std::endl;
     std::cout << "Collection sizes" << std::endl;
     std::cout << std::string(80, '-') << std::endl;
 
     std::cout << "PFParticle         : " << data.m_pfParticleCollection->size() << std::endl;
     std::cout << "PFParticleMetadata : " << data.m_pfParticleMetadataCollection->size()
               << std::endl;
     std::cout << "Cluster            : " << data.m_clusterCollection->size() << std::endl;
     std::cout << "SpacePoint         : " << data.m_spacePointCollection->size() << std::endl;
     std::cout << "Vertex             : " << data.m_vertexCollection->size() << std::endl;
     std::cout << "Track              : " << data.m_trackCollection->size() << std::endl;
     std::cout << "Shower             : " << data.m_showerCollection->size() << std::endl;
     std::cout << "PCAxis             : " << data.m_pcAxisCollection->size() << std::endl;
     std::cout << "Slice              : " << data.m_sliceCollection->size() << std::endl;
     std::cout << std::endl;
 
     std::cout << std::string(80, '-') << std::endl;
     std::cout << "Association sizes" << std::endl;
     std::cout << std::string(80, '-') << std::endl;
 
     if (data.m_pPFParticleToMetadataAssociation)
       std::cout << "PFParticle -> Metadata   : " << data.m_pPFParticleToMetadataAssociation->size()
                 << std::endl;
 
     if (data.m_pPFParticleToClusterAssociation)
       std::cout << "PFParticle -> Cluster    : " << data.m_pPFParticleToClusterAssociation->size()
                 << std::endl;
 
     if (data.m_pPFParticleToSpacePointAssociation)
       std::cout << "PFParticle -> SpacePoint : "
                 << data.m_pPFParticleToSpacePointAssociation->size() << std::endl;
 
     if (data.m_pPFParticleToVertexAssociation)
       std::cout << "PFParticle -> Vertex     : " << data.m_pPFParticleToVertexAssociation->size()
                 << std::endl;
 
     if (data.m_pPFParticleToTrackAssociation)
       std::cout << "PFParticle -> Track      : " << data.m_pPFParticleToTrackAssociation->size()
                 << std::endl;
 
     if (data.m_pPFParticleToShowerAssociation)
       std::cout << "PFParticle -> Shower     : " << data.m_pPFParticleToShowerAssociation->size()
                 << std::endl;
 
     if (data.m_pPFParticleToSliceAssociation)
       std::cout << "PFParticle -> Slice      : " << data.m_pPFParticleToSliceAssociation->size()
                 << std::endl;
 
     if (data.m_pClusterToHitAssociation)
       std::cout << "Cluster    -> Hit        : " << data.m_pClusterToHitAssociation->size()
                 << std::endl;
 
     if (data.m_pSpacePointToHitAssociation)
       std::cout << "SpacePoint -> Hit        : " << data.m_pSpacePointToHitAssociation->size()
                 << std::endl;
 
     if (data.m_pTrackToHitAssociation)
       std::cout << "Track      -> Hit        : " << data.m_pTrackToHitAssociation->size()
                 << std::endl;
 
     if (data.m_pShowerToHitAssociation)
       std::cout << "Shower     -> Hit        : " << data.m_pShowerToHitAssociation->size()
                 << std::endl;
 
     if (data.m_pShowerToPCAxisAssociation)
       std::cout << "Shower     -> PCAxis     : " << data.m_pShowerToPCAxisAssociation->size()
                 << std::endl;
 
     if (data.m_pSliceToHitAssociation)
       std::cout << "Slice      -> Hit        : " << data.m_pSliceToHitAssociation->size()
                 << std::endl;
 
     std::cout << std::endl;
   }

void lar_pandora::LArPandoraEventDump::PrintHit	(	const art::Ptr< recob::Hit > &	hit,
		const unsigned int	depth
	)		const

private

Print a given Hit.

Parameters

hit	the hit to print
depth	the number of characters to indent

Definition at line 558 of file LArPandoraEventDump_module.cc.

References recob::Hit::Channel(), art::Ptr< T >::key(), recob::Hit::PeakTime(), PrintProperty(), PrintTitle(), recob::Hit::RMS(), and recob::Hit::View().

Referenced by PrintCluster(), PrintShower(), PrintSlice(), PrintSpacePoint(), and PrintTrack().

   {
     this->PrintTitle("Hit", depth);
     this->PrintProperty("Key", hit.key(), depth + 2);
     this->PrintProperty("Channel", hit->Channel(), depth + 2);
     this->PrintProperty("View", hit->View(), depth + 2);
     this->PrintProperty("Peak time", hit->PeakTime(), depth + 2);
     this->PrintProperty("RMS", hit->RMS(), depth + 2);
   }

void lar_pandora::LArPandoraEventDump::PrintParticle	(	const art::Ptr< recob::PFParticle > &	particle,
		const PFParticleMap &	pfParticleMap,
		const PandoraData &	data,
		const unsigned int	depth
	)		const

private

Print a given PFParticle.

Parameters

particle	the particle to print
pfParticleMap	the input mapping from PFParticle ID to PFParticle
data	the pandora collections and associations
depth	the number of characters to indent

Definition at line 443 of file LArPandoraEventDump_module.cc.

References recob::PFParticle::Daughters(), recob::PFParticle::IsPrimary(), art::Ptr< T >::key(), lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToClusterAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToMetadataAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToShowerAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToSliceAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToSpacePointAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToTrackAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pPFParticleToVertexAssociation, m_verbosityLevel, recob::PFParticle::NumDaughters(), recob::PFParticle::Parent(), recob::PFParticle::PdgCode(), PrintCluster(), PrintProperty(), PrintRule(), PrintShower(), PrintSlice(), PrintSpacePoint(), PrintTitle(), PrintTrack(), PrintVertex(), recob::PFParticle::Self(), tca::slices, and track.

Referenced by PrintPFParticleHierarchy().

   {
     this->PrintRule(depth);
     this->PrintTitle("PFParticle", depth);
     this->PrintRule(depth);
 
     // Print the PFParticle details
     this->PrintProperty("Key", particle.key(), depth);
     this->PrintProperty("Id", particle->Self(), depth);
     this->PrintProperty("PDG", particle->PdgCode(), depth);
     this->PrintProperty("IsPrimary", particle->IsPrimary(), depth);
 
     if (!particle->IsPrimary()) this->PrintProperty("Parent", particle->Parent(), depth);
 
     // Print the metadata
     if (data.m_pPFParticleToMetadataAssociation) {
       const auto& metadata(data.m_pPFParticleToMetadataAssociation->at(particle.key()));
       this->PrintProperty("# Metadata", metadata.size(), depth);
 
       for (const auto& metadatum : metadata) {
         const auto& propertiesMap(metadatum->GetPropertiesMap());
         this->PrintProperty("# Properties", propertiesMap.size(), depth + 2);
 
         for (const auto& propertiesMapEntry : propertiesMap)
           this->PrintProperty(propertiesMapEntry.first, propertiesMapEntry.second, depth + 4);
       }
     }
 
     // Print the slices
     if (data.m_pPFParticleToSliceAssociation) {
       const auto& slices(data.m_pPFParticleToSliceAssociation->at(particle.key()));
       this->PrintProperty("# Slices", slices.size(), depth);
 
       if (m_verbosityLevel != "summary") {
         for (const auto& slice : slices)
           this->PrintSlice(slice, data, depth + 2);
       }
     }
 
     // Print the clusters
     if (data.m_pPFParticleToClusterAssociation) {
       const auto& clusters(data.m_pPFParticleToClusterAssociation->at(particle.key()));
       this->PrintProperty("# Clusters", clusters.size(), depth);
 
       if (m_verbosityLevel != "summary") {
         for (const auto& cluster : clusters)
           this->PrintCluster(cluster, data, depth + 2);
       }
     }
 
     // Print the space points
     if (data.m_pPFParticleToSpacePointAssociation) {
       const auto& spacePoints(data.m_pPFParticleToSpacePointAssociation->at(particle.key()));
       this->PrintProperty("# SpacePoints", spacePoints.size(), depth);
 
       if (m_verbosityLevel != "summary") {
         for (const auto& spacePoint : spacePoints)
           this->PrintSpacePoint(spacePoint, data, depth + 2);
       }
     }
 
     // Print the vertices
     if (data.m_pPFParticleToVertexAssociation) {
       const auto& vertices(data.m_pPFParticleToVertexAssociation->at(particle.key()));
       this->PrintProperty("# Vertices", vertices.size(), depth);
 
       if (m_verbosityLevel != "summary") {
         for (const auto& vertex : vertices)
           this->PrintVertex(vertex, depth + 2);
       }
     }
 
     // Print the tracks
     if (data.m_pPFParticleToTrackAssociation) {
       const auto& tracks(data.m_pPFParticleToTrackAssociation->at(particle.key()));
       this->PrintProperty("# Tracks", tracks.size(), depth);
 
       if (m_verbosityLevel != "summary") {
         for (const auto& track : tracks)
           this->PrintTrack(track, data, depth + 2);
       }
     }
 
     // Print the showers
     if (data.m_pPFParticleToShowerAssociation) {
       const auto& showers(data.m_pPFParticleToShowerAssociation->at(particle.key()));
       this->PrintProperty("# Showers", showers.size(), depth);
 
       if (m_verbosityLevel != "summary") {
         for (const auto& shower : showers)
           this->PrintShower(shower, data, depth + 2);
       }
     }
 
     // Print the daughters
     this->PrintProperty("# Daughters", particle->NumDaughters(), depth);
     this->PrintRule(depth);
 
     for (auto& daughterId : particle->Daughters()) {
       const auto daughterIter(pfParticleMap.find(daughterId));
 
       if (daughterIter == pfParticleMap.end())
         throw cet::exception("LArPandoraEventDump")
           << "Couldn't find daughter of PFParticle in the PFParticle map";
 
       const auto& daughter(daughterIter->second);
       this->PrintParticle(daughter, pfParticleMap, data, depth + 4);
     }
   }

void lar_pandora::LArPandoraEventDump::PrintPFParticleHierarchy ( const PandoraData & data ) const

private

Print the full PFParticle Hierarchy.

Parameters

data	the pandora collections and associations

Definition at line 414 of file LArPandoraEventDump_module.cc.

References BuildPFParticleMap(), recob::PFParticle::IsPrimary(), lar_pandora::LArPandoraEventDump::PandoraData::m_pfParticleCollection, and PrintParticle().

Referenced by analyze().

   {
     // Get the mapping from PFParticle ID to PFParticle
     PFParticleMap pfParticleMap;
     this->BuildPFParticleMap(data, pfParticleMap);
 
     // Print all primary PFParticles
     for (unsigned int i = 0; i < data.m_pfParticleCollection->size(); ++i) {
       const art::Ptr<recob::PFParticle> particle(data.m_pfParticleCollection, i);
 
       if (!particle->IsPrimary()) continue;
 
       this->PrintParticle(particle, pfParticleMap, data, 0);
     }
   }

template<class T >

void lar_pandora::LArPandoraEventDump::PrintProperty	(	const std::string &	name,
		const T &	value,
		const unsigned int	depth
	)		const

private

Print a given property with the correct amount of whitespace.

Parameters

name	the property name
value	the property value
depth	the number of characters to indent

Definition at line 735 of file LArPandoraEventDump_module.cc.

References art::left().

Referenced by PrintCluster(), PrintHit(), PrintParticle(), PrintShower(), PrintSlice(), PrintSpacePoint(), PrintTrack(), and PrintVertex().

   {
     // The separation between the property name and property value
     const unsigned int separation(std::max(0, 32 - static_cast<int>(depth)));
 
     std::cout << std::string(depth, ' ') << std::setw(separation) << std::left << ("- " + name)
               << value << std::endl;
   }

void lar_pandora::LArPandoraEventDump::PrintRule ( const unsigned int depth ) const

private

Print a horizontal line.

Parameters

depth the number of characters to indent

Definition at line 718 of file LArPandoraEventDump_module.cc.

Referenced by PrintParticle().

   {
     const unsigned int nDashes(std::max(0, 120 - static_cast<int>(depth)));
 
     std::cout << std::string(depth, ' ') << std::string(nDashes, '-') << std::endl;
   }

void lar_pandora::LArPandoraEventDump::PrintShower	(	const art::Ptr< recob::Shower > &	shower,
		const PandoraData &	data,
		const unsigned int	depth
	)		const

private

Print a given Shower.

Parameters

shower	the shower to print
data	the pandora collections and associations
depth	the number of characters to indent

Definition at line 679 of file LArPandoraEventDump_module.cc.

References hits(), recob::Shower::ID(), art::Ptr< T >::key(), recob::Shower::Length(), lar_pandora::LArPandoraEventDump::PandoraData::m_pShowerToHitAssociation, lar_pandora::LArPandoraEventDump::PandoraData::m_pShowerToPCAxisAssociation, m_verbosityLevel, recob::Shower::OpenAngle(), PrintHit(), PrintProperty(), PrintTitle(), and recob::Shower::ShowerStart().

Referenced by PrintParticle().

   {
     this->PrintTitle("Shower", depth);
     this->PrintProperty("Key", shower.key(), depth + 2);
     this->PrintProperty("ID", shower->ID(), depth + 2);
     this->PrintProperty("StartX", shower->ShowerStart().X(), depth + 2);
     this->PrintProperty("StartY", shower->ShowerStart().Y(), depth + 2);
     this->PrintProperty("StartZ", shower->ShowerStart().Z(), depth + 2);
     this->PrintProperty("Length", shower->Length(), depth + 2);
     this->PrintProperty("OpenAngle", shower->OpenAngle(), depth + 2);
 
     if (data.m_pShowerToPCAxisAssociation) {
       const auto& pcAxes(data.m_pShowerToPCAxisAssociation->at(shower.key()));
       this->PrintProperty("# PCAxes", pcAxes.size(), depth + 2);
 
       for (const auto& pcAxis : pcAxes) {
         this->PrintTitle("PCAxis", depth + 4);
         this->PrintProperty("Key", pcAxis.key(), depth + 6);
         this->PrintProperty("ID", pcAxis->getID(), depth + 6);
         this->PrintProperty("# Hits used", pcAxis->getNumHitsUsed(), depth + 6);
       }
     }
 
     if (!data.m_pShowerToHitAssociation) return;
 
     const auto& hits(data.m_pShowerToHitAssociation->at(shower.key()));
     this->PrintProperty("# Hits", hits.size(), depth + 2);
 
     if (m_verbosityLevel == "detailed") return;
 
     // Print each associated hit
     for (const auto& hit : hits)
       this->PrintHit(hit, depth + 4);
   }

void lar_pandora::LArPandoraEventDump::PrintSlice	(	const art::Ptr< recob::Slice > &	slice,
		const PandoraData &	data,
		const unsigned int	depth
	)		const

private

Print a given Slice.

Parameters

slice	the slice to print
data	the pandora collections and associations
depth	the number of characters to indent

Definition at line 571 of file LArPandoraEventDump_module.cc.

References hits(), recob::Slice::ID(), art::Ptr< T >::key(), lar_pandora::LArPandoraEventDump::PandoraData::m_pSliceToHitAssociation, m_verbosityLevel, PrintHit(), PrintProperty(), and PrintTitle().

Referenced by PrintParticle().

   {
     this->PrintTitle("Slice", depth);
     this->PrintProperty("Key", slice.key(), depth + 2);
     this->PrintProperty("ID", slice->ID(), depth + 2);
 
     if (!data.m_pSliceToHitAssociation) return;
 
     const auto& hits(data.m_pSliceToHitAssociation->at(slice.key()));
     this->PrintProperty("# Hits", hits.size(), depth + 2);
 
     if (m_verbosityLevel != "extreme") return;
 
     // Print each associated hit
     for (const auto& hit : hits)
       this->PrintHit(hit, depth + 4);
   }

void lar_pandora::LArPandoraEventDump::PrintSpacePoint	(	const art::Ptr< recob::SpacePoint > &	spacePoint,
		const PandoraData &	data,
		const unsigned int	depth
	)		const

private

Print a given SpacePoint.

Parameters

spacePoint	the spacePoint to print
data	the pandora collections and associations
depth	the number of characters to indent

Definition at line 616 of file LArPandoraEventDump_module.cc.

References hits(), recob::SpacePoint::ID(), art::Ptr< T >::key(), lar_pandora::LArPandoraEventDump::PandoraData::m_pSpacePointToHitAssociation, m_verbosityLevel, PrintHit(), PrintProperty(), PrintTitle(), and recob::SpacePoint::XYZ().

Referenced by PrintParticle().

   {
     this->PrintTitle("SpacePoint", depth);
     this->PrintProperty("Key", spacePoint.key(), depth + 2);
     this->PrintProperty("ID", spacePoint->ID(), depth + 2);
     const auto& position(spacePoint->XYZ());
     this->PrintProperty("X", position[0], depth + 2);
     this->PrintProperty("Y", position[1], depth + 2);
     this->PrintProperty("Z", position[2], depth + 2);
 
     if (!data.m_pSpacePointToHitAssociation) return;
 
     const auto& hits(data.m_pSpacePointToHitAssociation->at(spacePoint.key()));
     this->PrintProperty("# Hits", hits.size(), depth + 2);
 
     if (m_verbosityLevel == "detailed") return;
 
     // Print each associated hit
     for (const auto& hit : hits)
       this->PrintHit(hit, depth + 4);
   }

void lar_pandora::LArPandoraEventDump::PrintTitle	(	const std::string &	name,
		const unsigned int	depth
	)		const

private

Print a title line.

Parameters

name	the title name
depth	the number of characters to indent

Definition at line 727 of file LArPandoraEventDump_module.cc.

Referenced by PrintCluster(), PrintHit(), PrintParticle(), PrintShower(), PrintSlice(), PrintSpacePoint(), PrintTrack(), and PrintVertex().

   {
     std::cout << std::string(depth, ' ') << name << std::endl;
   }

void lar_pandora::LArPandoraEventDump::PrintTrack	(	const art::Ptr< recob::Track > &	track,
		const PandoraData &	data,
		const unsigned int	depth
	)		const

private

Print a given Track.

Parameters

track	the track to print
data	the pandora collections and associations
depth	the number of characters to indent

Definition at line 656 of file LArPandoraEventDump_module.cc.

References hits(), art::Ptr< T >::key(), recob::Track::Length(), lar_pandora::LArPandoraEventDump::PandoraData::m_pTrackToHitAssociation, m_verbosityLevel, recob::Track::NumberTrajectoryPoints(), PrintHit(), PrintProperty(), and PrintTitle().

Referenced by PrintParticle().

   {
     this->PrintTitle("Track", depth);
     this->PrintProperty("Key", track.key(), depth + 2);
     this->PrintProperty("# Trajectory points", track->NumberTrajectoryPoints(), depth + 2);
     this->PrintProperty("Length", track->Length(), depth + 2);
 
     if (!data.m_pTrackToHitAssociation) return;
 
     const auto& hits(data.m_pTrackToHitAssociation->at(track.key()));
     this->PrintProperty("# Hits", hits.size(), depth + 2);
 
     if (m_verbosityLevel == "detailed") return;
 
     // Print each associated hit
     for (const auto& hit : hits)
       this->PrintHit(hit, depth + 4);
   }

void lar_pandora::LArPandoraEventDump::PrintVertex	(	const art::Ptr< recob::Vertex > &	vertex,
		const unsigned int	depth
	)		const

private

Print a given Vertex.

Parameters

vertex	the vertex to print
depth	the number of characters to indent

Definition at line 642 of file LArPandoraEventDump_module.cc.

References recob::Vertex::ID(), art::Ptr< T >::key(), recob::Vertex::position(), PrintProperty(), and PrintTitle().

Referenced by PrintParticle().

   {
     this->PrintTitle("Vertex", depth);
     this->PrintProperty("Key", vertex.key(), depth + 2);
     this->PrintProperty("ID", vertex->ID(), depth + 2);
     const auto& position(vertex->position());
     this->PrintProperty("X", position.X(), depth + 2);
     this->PrintProperty("Y", position.Y(), depth + 2);
     this->PrintProperty("Z", position.Z(), depth + 2);
   }

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 lar_pandora::LArPandoraEventDump::m_pandoraLabel

private

The label of the Pandora pattern recognition producer.

Definition at line 278 of file LArPandoraEventDump_module.cc.

Referenced by analyze().

std::string lar_pandora::LArPandoraEventDump::m_showerLabel

private

The shower producer label.

Definition at line 280 of file LArPandoraEventDump_module.cc.

Referenced by analyze().

std::string lar_pandora::LArPandoraEventDump::m_trackLabel

private

The track producer label.

Definition at line 279 of file LArPandoraEventDump_module.cc.

Referenced by analyze().

std::string lar_pandora::LArPandoraEventDump::m_verbosityLevel

private

The level of verbosity to use.

Definition at line 277 of file LArPandoraEventDump_module.cc.

Referenced by analyze(), LArPandoraEventDump(), PrintCluster(), PrintParticle(), PrintShower(), PrintSlice(), PrintSpacePoint(), and PrintTrack().

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

larpandora/v09_22_05/source/larpandora/LArPandoraEventBuilding/LArPandoraEventDump_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation