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	WorkerType = WorkerT< EDAnalyzer >

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

std::string	workerType () const

bool	modifiesEvent () const

void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)

std::string const &	processName () const

bool	wantAllEvents () const

bool	wantEvent (Event const &e)

fhicl::ParameterSetID	selectorConfig () const

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

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

detail::CachedProducts &	cachedProducts ()

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

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 32 of file LArPandoraEventDump_module.cc.

Member Typedef Documentation

template<class T >

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

private

Definition at line 49 of file LArPandoraEventDump_module.cc.

template<class T >

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

private

Definition at line 46 of file LArPandoraEventDump_module.cc.

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 39 of file EDAnalyzer.h.

using art::EDAnalyzer::WorkerType = WorkerT<EDAnalyzer>

inherited

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 266 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 286 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 396 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;
     }
 }

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

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

   {
     return selectors_;
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDAnalyzer::currentContext ( ) const

protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

   {
     return current_context_.get();
   }

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

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

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

   {
     return selectors_.getOneTriggerResults(e);
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

   {
     return false;
   }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

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

delete

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

delete

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

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 570 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 300 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 311 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 536 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 407 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 376 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 714 of file LArPandoraEventDump_module.cc.

References art::left(), and max.

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 696 of file LArPandoraEventDump_module.cc.

References max.

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 655 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 548 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 593 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 705 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 632 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 619 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);
 }

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

   {
     return process_name_;
   }

void art::EventObserverBase::registerProducts	(	MasterProductRegistry &	,
		ProductDescriptions &	,
		ModuleDescription const &
	)

inlineinherited

Definition at line 33 of file EventObserverBase.h.

36 {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

   {
     return selector_config_id_;
   }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

   {
     return wantAllEvents_;
   }

bool art::EventObserverBase::wantEvent ( Event const & e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

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

   {
     return selectors_.wantEvent(e);
   }

std::string art::EDAnalyzer::workerType ( ) const

inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

     {
       return "WorkerT<EDAnalyzer>";
     }

Member Data Documentation

std::string lar_pandora::LArPandoraEventDump::m_pandoraLabel

private

The label of the Pandora pattern recognition producer.

Definition at line 251 of file LArPandoraEventDump_module.cc.

Referenced by analyze().

std::string lar_pandora::LArPandoraEventDump::m_showerLabel

private

The shower producer label.

Definition at line 253 of file LArPandoraEventDump_module.cc.

Referenced by analyze().

std::string lar_pandora::LArPandoraEventDump::m_trackLabel

private

The track producer label.

Definition at line 252 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 250 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:

/cvmfs/larsoft.opensciencegrid.org/products/larpandora/v07_06_01/source/larpandora/LArPandoraEventBuilding/LArPandoraEventDump_module.cc

Classes

Public Types

Public Member Functions

Static 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