Inheritance diagram for lar_pandora::LArPandoraEventDump:

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

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

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.

Constructor & Destructor Documentation

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

explicit

Definition at line 266 of file LArPandoraEventDump_module.cc.

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

override

Definition at line 286 of file LArPandoraEventDump_module.cc.

 {
     // 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.

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

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

 {
     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.

 {
     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.

 {
     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.

 {
     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.

 {
     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.

 {
     // 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.

 {
     // 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.

 {
     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.

 {
     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.

 {
     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.

 {
     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.

 {
     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.

 {
     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.

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