LArPandoraEvent class. More...

#include "LArPandoraEvent.h"

Classes
class	Labels
	Class to handle the required producer labels. More...

Public Types
template<typename T >
using	Collection = std::vector< art::Ptr< T >>
	Shorthand for a collection of objects of type T. More...

template<typename R , typename D >
using	PairVector = std::vector< std::pair< art::Ptr< R >, D >>

template<typename L , typename R , typename D >
using	Association = std::map< art::Ptr< L >, PairVector< R, D >>
	General purpose short-hand with optional D parameter. More...

typedef Collection< recob::Hit >	HitCollection

typedef Collection< recob::PFParticle >	PFParticleCollection

typedef Collection< recob::Cluster >	ClusterCollection

typedef Collection< recob::SpacePoint >	SpacePointCollection

typedef Collection< recob::Vertex >	VertexCollection

typedef Collection< recob::Slice >	SliceCollection

typedef Collection< recob::Track >	TrackCollection

typedef Collection< recob::Shower >	ShowerCollection

typedef Collection< recob::PCAxis >	PCAxisCollection

typedef Collection< larpandoraobj::PFParticleMetadata >	PFParticleMetadataCollection

typedef Collection< anab::T0 >	T0Collection

typedef Association< recob::PFParticle, recob::Cluster, void * >	PFParticleToClusterAssoc

typedef Association< recob::PFParticle, recob::SpacePoint, void * >	PFParticleToSpacePointAssoc

typedef Association< recob::PFParticle, recob::Vertex, void * >	PFParticleToVertexAssoc

typedef Association< recob::PFParticle, recob::Slice, void * >	PFParticleToSliceAssoc

typedef Association< recob::PFParticle, recob::Track, void * >	PFParticleToTrackAssoc

typedef Association< recob::PFParticle, recob::Shower, void * >	PFParticleToShowerAssoc

typedef Association< recob::PFParticle, recob::PCAxis, void * >	PFParticleToPCAxisAssoc

typedef Association< recob::PFParticle, larpandoraobj::PFParticleMetadata, void * >	PFParticleToPFParticleMetadataAssoc

typedef Association< recob::PFParticle, anab::T0, void * >	PFParticleToT0Assoc

typedef Association< recob::Cluster, recob::Hit, void * >	ClusterToHitAssoc

typedef Association< recob::SpacePoint, recob::Hit, void * >	SpacePointToHitAssoc

typedef Association< recob::Slice, recob::Hit, void * >	SliceToHitAssoc

typedef Association< recob::Track, recob::Hit, recob::TrackHitMeta >	TrackToHitAssoc

typedef Association< recob::Shower, recob::Hit, void * >	ShowerToHitAssoc

typedef Association< recob::Shower, recob::PCAxis, void * >	ShowerToPCAxisAssoc

Public Member Functions
	LArPandoraEvent (art::EDProducer pProducer, art::Event pEvent, const Labels &inputLabels, const bool shouldProduceT0s=false)
	Constructor from an art::Event. More...

	LArPandoraEvent (const LArPandoraEvent &event, const PFParticleVector &selectedPFParticles)
	Construct by copying an existing LArPandoraEvent, replacing the collections and associations by any objects associated with a PFParticle in the selection supplied. More...

void	WriteToEvent () const
	Write (put) the collections in this LArPandoraEvent to the art::Event. More...

Private Member Functions
void	GetCollections ()
	Get the collections and associations from m_pEvent with the required labels. More...

template<typename T >
void	GetCollection (const Labels::LabelType &inputLabel, Collection< T > &outputCollection) const
	Gets a given collection from m_pEvent with the label supplied. More...

template<typename L , typename R , typename D >
void	GetAssociationMap (const Collection< L > &collectionL, const Labels::LabelType &inputLabel, Association< L, R, D > &outputAssociationMap) const
	Get the mapping between two collections with metadata using the specified label. More...

template<typename L , typename R >
void	GetAssociationMap (const Collection< L > &collectionL, const Labels::LabelType &inputLabel, Association< L, R, void * > &outputAssociationMap) const
	Get the mapping between two collections with metadata using the specified label. More...

template<typename L , typename R , typename D >
void	CollectAssociated (const art::Ptr< L > &anObject, const Association< L, R, D > &associationLtoR, Collection< R > &associatedR) const
	Collects all objects of type R with metadata D associated to a given object of type L. More...

template<typename L , typename R , typename D >
void	GetFilteredAssociationMap (const Collection< L > &collectionL, const Collection< R > &collectionR, const Association< L, R, D > &inputAssociationLtoR, Association< L, R, D > &outputAssociationLtoR) const
	Gets the filtered mapping from objects in collectionL to objects that also exist in collectionR using a "superset" input association. More...

template<typename T >
void	WriteCollection (const Collection< T > &collection) const
	Write a given collection to the event. More...

template<typename L , typename R , typename D >
void	WriteAssociation (const Association< L, R, D > &associationMap, const Collection< L > &collectionL, const Collection< R > &collectionR, const bool thisProducesR=true) const
	Write a given association to the event. More...

template<typename L , typename R >
void	WriteAssociation (const Association< L, R, void * > &associationMap, const Collection< L > &collectionL, const Collection< R > &collectionR, const bool thisProducesR=true) const
	Write a given association to the event. More...

template<typename T >
size_t	GetIndex (const art::Ptr< T > object, const Collection< T > &collection) const
	Get the index of an objet in a given collection. More...

Private Attributes
art::EDProducer *	m_pProducer
	The producer which should write the output collections and associations. More...

art::Event *	m_pEvent
	The event to consider. More...

Labels	m_labels
	A set of labels describing the producers for each input collection. More...

bool	m_shouldProduceT0s
	If T0s should be produced (usually only true for use cases with multiple drift volumes) More...

PFParticleCollection	m_pfParticles
	The input collection of PFParticles. More...

SpacePointCollection	m_spacePoints
	The input collection of SpacePoints. More...

ClusterCollection	m_clusters
	The input collection of Clusters. More...

VertexCollection	m_vertices
	The input collection of Vertices. More...

SliceCollection	m_slices
	The input collection of Slices. More...

TrackCollection	m_tracks
	The input collection of Tracks. More...

ShowerCollection	m_showers
	The input collection of Showers. More...

T0Collection	m_t0s
	The input collection of T0s. More...

PFParticleMetadataCollection	m_metadata
	The input collection of PFParticle metadata. More...

PCAxisCollection	m_pcAxes
	The input collection of PCAxes. More...

HitCollection	m_hits
	The input collection of Hits. More...

PFParticleToSpacePointAssoc	m_pfParticleSpacePointMap
	The input associations: PFParticle -> SpacePoint. More...

PFParticleToClusterAssoc	m_pfParticleClusterMap
	The input associations: PFParticle -> Cluster. More...

PFParticleToVertexAssoc	m_pfParticleVertexMap
	The input associations: PFParticle -> Vertex. More...

PFParticleToSliceAssoc	m_pfParticleSliceMap
	The input associations: PFParticle -> Slice. More...

PFParticleToTrackAssoc	m_pfParticleTrackMap
	The input associations: PFParticle -> Track. More...

PFParticleToShowerAssoc	m_pfParticleShowerMap
	The input associations: PFParticle -> Shower. More...

PFParticleToT0Assoc	m_pfParticleT0Map
	The input associations: PFParticle -> T0. More...

PFParticleToPFParticleMetadataAssoc	m_pfParticleMetadataMap
	The input associations: PFParticle -> Metadata. More...

PFParticleToPCAxisAssoc	m_pfParticlePCAxisMap
	The input associations: PFParticle -> PCAxis. More...

SpacePointToHitAssoc	m_spacePointHitMap
	The input associations: SpacePoint -> Hit. More...

ClusterToHitAssoc	m_clusterHitMap
	The input associations: Cluster -> Hit. More...

SliceToHitAssoc	m_sliceHitMap
	The input associations: Slice -> Hit. More...

TrackToHitAssoc	m_trackHitMap
	The input associations: Track -> Hit. More...

ShowerToHitAssoc	m_showerHitMap
	The input associations: Shower -> Hit. More...

ShowerToPCAxisAssoc	m_showerPCAxisMap
	The input associations: PCAxis -> Shower. More...

Detailed Description

LArPandoraEvent class.

Definition at line 45 of file LArPandoraEvent.h.

Member Typedef Documentation

template<typename L , typename R , typename D >

using lar_pandora::LArPandoraEvent::Association = std::map<art::Ptr<L>, PairVector<R, D>>

General purpose short-hand with optional D parameter.

Definition at line 60 of file LArPandoraEvent.h.

typedef Collection<recob::Cluster> lar_pandora::LArPandoraEvent::ClusterCollection

Definition at line 65 of file LArPandoraEvent.h.

typedef Association<recob::Cluster, recob::Hit, void*> lar_pandora::LArPandoraEvent::ClusterToHitAssoc

Definition at line 87 of file LArPandoraEvent.h.

template<typename T >

using lar_pandora::LArPandoraEvent::Collection = std::vector<art::Ptr<T>>

Shorthand for a collection of objects of type T.

Definition at line 51 of file LArPandoraEvent.h.

typedef Collection<recob::Hit> lar_pandora::LArPandoraEvent::HitCollection

Definition at line 63 of file LArPandoraEvent.h.

template<typename R , typename D >

using lar_pandora::LArPandoraEvent::PairVector = std::vector<std::pair<art::Ptr<R>, D>>

Definition at line 54 of file LArPandoraEvent.h.

typedef Collection<recob::PCAxis> lar_pandora::LArPandoraEvent::PCAxisCollection

Definition at line 71 of file LArPandoraEvent.h.

typedef Collection<recob::PFParticle> lar_pandora::LArPandoraEvent::PFParticleCollection

Definition at line 64 of file LArPandoraEvent.h.

typedef Collection<larpandoraobj::PFParticleMetadata> lar_pandora::LArPandoraEvent::PFParticleMetadataCollection

Definition at line 72 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::Cluster, void*> lar_pandora::LArPandoraEvent::PFParticleToClusterAssoc

Definition at line 76 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::PCAxis, void*> lar_pandora::LArPandoraEvent::PFParticleToPCAxisAssoc

Definition at line 82 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, larpandoraobj::PFParticleMetadata, void*> lar_pandora::LArPandoraEvent::PFParticleToPFParticleMetadataAssoc

Definition at line 84 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::Shower, void*> lar_pandora::LArPandoraEvent::PFParticleToShowerAssoc

Definition at line 81 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::Slice, void*> lar_pandora::LArPandoraEvent::PFParticleToSliceAssoc

Definition at line 79 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::SpacePoint, void*> lar_pandora::LArPandoraEvent::PFParticleToSpacePointAssoc

Definition at line 77 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, anab::T0, void*> lar_pandora::LArPandoraEvent::PFParticleToT0Assoc

Definition at line 85 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::Track, void*> lar_pandora::LArPandoraEvent::PFParticleToTrackAssoc

Definition at line 80 of file LArPandoraEvent.h.

typedef Association<recob::PFParticle, recob::Vertex, void*> lar_pandora::LArPandoraEvent::PFParticleToVertexAssoc

Definition at line 78 of file LArPandoraEvent.h.

typedef Collection<recob::Shower> lar_pandora::LArPandoraEvent::ShowerCollection

Definition at line 70 of file LArPandoraEvent.h.

typedef Association<recob::Shower, recob::Hit, void*> lar_pandora::LArPandoraEvent::ShowerToHitAssoc

Definition at line 91 of file LArPandoraEvent.h.

typedef Association<recob::Shower, recob::PCAxis, void*> lar_pandora::LArPandoraEvent::ShowerToPCAxisAssoc

Definition at line 92 of file LArPandoraEvent.h.

typedef Collection<recob::Slice> lar_pandora::LArPandoraEvent::SliceCollection

Definition at line 68 of file LArPandoraEvent.h.

typedef Association<recob::Slice, recob::Hit, void*> lar_pandora::LArPandoraEvent::SliceToHitAssoc

Definition at line 89 of file LArPandoraEvent.h.

typedef Collection<recob::SpacePoint> lar_pandora::LArPandoraEvent::SpacePointCollection

Definition at line 66 of file LArPandoraEvent.h.

typedef Association<recob::SpacePoint, recob::Hit, void*> lar_pandora::LArPandoraEvent::SpacePointToHitAssoc

Definition at line 88 of file LArPandoraEvent.h.

typedef Collection<anab::T0> lar_pandora::LArPandoraEvent::T0Collection

Definition at line 73 of file LArPandoraEvent.h.

typedef Collection<recob::Track> lar_pandora::LArPandoraEvent::TrackCollection

Definition at line 69 of file LArPandoraEvent.h.

typedef Association<recob::Track, recob::Hit, recob::TrackHitMeta> lar_pandora::LArPandoraEvent::TrackToHitAssoc

Definition at line 90 of file LArPandoraEvent.h.

typedef Collection<recob::Vertex> lar_pandora::LArPandoraEvent::VertexCollection

Definition at line 67 of file LArPandoraEvent.h.

Constructor & Destructor Documentation

lar_pandora::LArPandoraEvent::LArPandoraEvent	(	art::EDProducer *	pProducer,
		art::Event *	pEvent,
		const Labels &	inputLabels,
		const bool	shouldProduceT0s = `false`
	)

Constructor from an art::Event.

Parameters

pProducer	pointer to the producer to write the output
pEvent	pointer to the event to process
inputLabel	labels for the producers of the input collections
shouldProduceT0s	if T0s should be produced (usually only for multiple drift volume use cases)

Definition at line 11 of file LArPandoraEvent.cxx.

References GetCollections().

     : m_pProducer(pProducer)
     , m_pEvent(pEvent)
     , m_labels(inputLabels)
     , m_shouldProduceT0s(shouldProduceT0s)
   {
     this->GetCollections();
   }

lar_pandora::LArPandoraEvent::LArPandoraEvent	(	const LArPandoraEvent &	event,
		const PFParticleVector &	selectedPFParticles
	)

Construct by copying an existing LArPandoraEvent, replacing the collections and associations by any objects associated with a PFParticle in the selection supplied.

Parameters

event	input event to copy and filter
pfParticleVector	input vector of selected particles

Definition at line 25 of file LArPandoraEvent.cxx.

References CollectAssociated(), GetFilteredAssociationMap(), m_clusterHitMap, m_clusters, m_hits, m_metadata, m_pcAxes, m_pfParticleClusterMap, m_pfParticleMetadataMap, m_pfParticlePCAxisMap, m_pfParticles, m_pfParticleShowerMap, m_pfParticleSliceMap, m_pfParticleSpacePointMap, m_pfParticleT0Map, m_pfParticleTrackMap, m_pfParticleVertexMap, m_shouldProduceT0s, m_showerHitMap, m_showerPCAxisMap, m_showers, m_sliceHitMap, m_slices, m_spacePointHitMap, m_spacePoints, m_t0s, m_trackHitMap, m_tracks, m_vertices, and part.

     : m_pProducer(event.m_pProducer)
     , m_pEvent(event.m_pEvent)
     , m_labels(event.m_labels)
     , m_shouldProduceT0s(event.m_shouldProduceT0s)
     , m_hits(event.m_hits)
   {
     m_pfParticles = selectedPFParticles;
 
     // Only collect objects associated to a selected particles
     for (const auto& part : selectedPFParticles) {
       this->CollectAssociated(part, event.m_pfParticleSpacePointMap, m_spacePoints);
       this->CollectAssociated(part, event.m_pfParticleClusterMap, m_clusters);
       this->CollectAssociated(part, event.m_pfParticleVertexMap, m_vertices);
       this->CollectAssociated(part, event.m_pfParticleSliceMap, m_slices);
       this->CollectAssociated(part, event.m_pfParticleTrackMap, m_tracks);
       this->CollectAssociated(part, event.m_pfParticleShowerMap, m_showers);
       this->CollectAssociated(part, event.m_pfParticlePCAxisMap, m_pcAxes);
       this->CollectAssociated(part, event.m_pfParticleMetadataMap, m_metadata);
 
       if (m_shouldProduceT0s) this->CollectAssociated(part, event.m_pfParticleT0Map, m_t0s);
     }
 
     // Filter the association maps from the input event to only include objects associated to the selected particles
     this->GetFilteredAssociationMap(
       m_pfParticles, m_spacePoints, event.m_pfParticleSpacePointMap, m_pfParticleSpacePointMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_clusters, event.m_pfParticleClusterMap, m_pfParticleClusterMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_vertices, event.m_pfParticleVertexMap, m_pfParticleVertexMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_slices, event.m_pfParticleSliceMap, m_pfParticleSliceMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_tracks, event.m_pfParticleTrackMap, m_pfParticleTrackMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_showers, event.m_pfParticleShowerMap, m_pfParticleShowerMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_pcAxes, event.m_pfParticlePCAxisMap, m_pfParticlePCAxisMap);
     this->GetFilteredAssociationMap(
       m_pfParticles, m_metadata, event.m_pfParticleMetadataMap, m_pfParticleMetadataMap);
     this->GetFilteredAssociationMap(
       m_spacePoints, event.m_hits, event.m_spacePointHitMap, m_spacePointHitMap);
     this->GetFilteredAssociationMap(
       m_clusters, event.m_hits, event.m_clusterHitMap, m_clusterHitMap);
     this->GetFilteredAssociationMap(m_slices, event.m_hits, event.m_sliceHitMap, m_sliceHitMap);
     this->GetFilteredAssociationMap(m_tracks, event.m_hits, event.m_trackHitMap, m_trackHitMap);
     this->GetFilteredAssociationMap(m_showers, event.m_hits, event.m_showerHitMap, m_showerHitMap);
     this->GetFilteredAssociationMap(
       m_showers, m_pcAxes, event.m_showerPCAxisMap, m_showerPCAxisMap);
 
     if (m_shouldProduceT0s)
       this->GetFilteredAssociationMap(
         m_pfParticles, m_t0s, event.m_pfParticleT0Map, m_pfParticleT0Map);
   }

Member Function Documentation

template<typename L , typename R , typename D >

void lar_pandora::LArPandoraEvent::CollectAssociated	(	const art::Ptr< L > &	anObject,
		const Association< L, R, D > &	associationLtoR,
		Collection< R > &	associatedR
	)		const

inlineprivate

Collects all objects of type R with metadata D associated to a given object of type L.

Parameters

anObject	an input object of type L with which we want to collect associated objects of type R with metadata D
associationLtoR	the general input association between objects of type L and R
associatedR	output vector of objects of type R associated with anObject

Definition at line 425 of file LArPandoraEvent.h.

Referenced by LArPandoraEvent().

   {
     if (associationLtoR.find(anObject) == associationLtoR.end())
       throw cet::exception("LArPandora")
         << " LArPandoraEvent::CollectAssociated -- Can not find association for object supplied."
         << std::endl;
 
     for (const auto& entry : associationLtoR.at(anObject)) {
       // Ensure we don't repeat objects in the output collection
       if (std::find(associatedR.begin(), associatedR.end(), entry.first) == associatedR.end())
         associatedR.push_back(entry.first);
     }
   }

template<typename L , typename R , typename D >

void lar_pandora::LArPandoraEvent::GetAssociationMap	(	const Collection< L > &	collectionL,
		const Labels::LabelType &	inputLabel,
		Association< L, R, D > &	outputAssociationMap
	)		const

inlineprivate

Get the mapping between two collections with metadata using the specified label.

Parameters

collectionL	the collection from which the associations should be retrieved
inputLabel	a label for the producer of the association required
outputAssociationMap	output mapping between the two data types supplied (L -> R + D)

Definition at line 368 of file LArPandoraEvent.h.

Referenced by GetCollections().

   {
     const auto& assocHandle(
       m_pEvent->getValidHandle<art::Assns<L, R, D>>(m_labels.GetLabel(inputLabel)));
 
     // Check that there are no associaions from objects not in collectionL
     for (const auto& entry : *assocHandle) {
       auto it(std::find(collectionL.begin(), collectionL.end(), entry.first));
       if (it == collectionL.end())
         throw cet::exception("LArPandora") << " LArPandoraEvent::GetAssociationMap -- Found object "
                                               "in association that isn't in the supplied collection"
                                            << std::endl;
     }
 
     // Ensure there is an entry for every object of type L
     for (const auto& objectL : collectionL)
       outputAssociationMap[objectL];
 
     // Fill the association map
     for (const auto& entry : *assocHandle)
       outputAssociationMap.at(entry.first).emplace_back(entry.second, *entry.data);
   }

template<typename L , typename R >

void lar_pandora::LArPandoraEvent::GetAssociationMap	(	const Collection< L > &	collectionL,
		const Labels::LabelType &	inputLabel,
		Association< L, R, void * > &	outputAssociationMap
	)		const

inlineprivate

Get the mapping between two collections with metadata using the specified label.

Parameters

collectionL	the collection from which the associations should be retrieved
inputLabel	a label for the producer of the association required
outputAssociationMap	output mapping between the two data types supplied (L -> R no metadata)

Definition at line 396 of file LArPandoraEvent.h.

   {
     const auto& assocHandle(
       m_pEvent->getValidHandle<art::Assns<L, R>>(m_labels.GetLabel(inputLabel)));
 
     // Check that there are no associaions from objects not in collectionL
     for (const auto& entry : *assocHandle) {
       auto it(std::find(collectionL.begin(), collectionL.end(), entry.first));
       if (it == collectionL.end())
         throw cet::exception("LArPandora") << " LArPandoraEvent::GetAssociationMap -- Found object "
                                               "in association that isn't in the supplied collection"
                                            << std::endl;
     }
 
     // Ensure there is an entry for every object of type L
     for (const auto& objectL : collectionL)
       outputAssociationMap[objectL];
 
     // Fill the association map
     for (const auto& entry : *assocHandle)
       outputAssociationMap.at(entry.first).emplace_back(entry.second, nullptr);
   }

template<typename T >

void lar_pandora::LArPandoraEvent::GetCollection	(	const Labels::LabelType &	inputLabel,
		Collection< T > &	outputCollection
	)		const

inlineprivate

Gets a given collection from m_pEvent with the label supplied.

Parameters

inputLabel	a label for the producer of the collection required
outputCollection	the required collection

Definition at line 356 of file LArPandoraEvent.h.

Referenced by GetCollections().

   {
     const auto& handle(m_pEvent->getValidHandle<std::vector<T>>(m_labels.GetLabel(inputLabel)));
 
     for (unsigned int i = 0; i != handle->size(); i++)
       outputCollection.emplace_back(handle, i);
   }

void lar_pandora::LArPandoraEvent::GetCollections ( )

private

Get the collections and associations from m_pEvent with the required labels.

Definition at line 118 of file LArPandoraEvent.cxx.

Referenced by LArPandoraEvent().

   {
     this->GetCollection(Labels::PFParticleLabel, m_pfParticles);
     this->GetCollection(Labels::SpacePointLabel, m_spacePoints);
     this->GetCollection(Labels::ClusterLabel, m_clusters);
     this->GetCollection(Labels::VertexLabel, m_vertices);
     this->GetCollection(Labels::SliceLabel, m_slices);
     this->GetCollection(Labels::TrackLabel, m_tracks);
     this->GetCollection(Labels::ShowerLabel, m_showers);
     this->GetCollection(Labels::PCAxisLabel, m_pcAxes);
     this->GetCollection(Labels::PFParticleMetadataLabel, m_metadata);
     this->GetCollection(Labels::HitLabel, m_hits);
 
     this->GetAssociationMap(
       m_pfParticles, Labels::PFParticleToSpacePointLabel, m_pfParticleSpacePointMap);
     this->GetAssociationMap(
       m_pfParticles, Labels::PFParticleToClusterLabel, m_pfParticleClusterMap);
     this->GetAssociationMap(m_pfParticles, Labels::PFParticleToVertexLabel, m_pfParticleVertexMap);
     this->GetAssociationMap(m_pfParticles, Labels::PFParticleToSliceLabel, m_pfParticleSliceMap);
     this->GetAssociationMap(m_pfParticles, Labels::PFParticleToTrackLabel, m_pfParticleTrackMap);
     this->GetAssociationMap(m_pfParticles, Labels::PFParticleToShowerLabel, m_pfParticleShowerMap);
     this->GetAssociationMap(m_pfParticles, Labels::PFParticleToPCAxisLabel, m_pfParticlePCAxisMap);
     this->GetAssociationMap(
       m_pfParticles, Labels::PFParticleToMetadataLabel, m_pfParticleMetadataMap);
     this->GetAssociationMap(m_spacePoints, Labels::SpacePointToHitLabel, m_spacePointHitMap);
     this->GetAssociationMap(m_clusters, Labels::ClusterToHitLabel, m_clusterHitMap);
     this->GetAssociationMap(m_slices, Labels::SliceToHitLabel, m_sliceHitMap);
     this->GetAssociationMap(m_tracks, Labels::TrackToHitLabel, m_trackHitMap);
     this->GetAssociationMap(m_showers, Labels::ShowerToHitLabel, m_showerHitMap);
     this->GetAssociationMap(m_showers, Labels::ShowerToPCAxisLabel, m_showerPCAxisMap);
 
     if (m_shouldProduceT0s) {
       this->GetCollection(Labels::T0Label, m_t0s);
       this->GetAssociationMap(m_pfParticles, Labels::PFParticleToT0Label, m_pfParticleT0Map);
     }
   }

template<typename L , typename R , typename D >

void lar_pandora::LArPandoraEvent::GetFilteredAssociationMap	(	const Collection< L > &	collectionL,
		const Collection< R > &	collectionR,
		const Association< L, R, D > &	inputAssociationLtoR,
		Association< L, R, D > &	outputAssociationLtoR
	)		const

inlineprivate

Gets the filtered mapping from objects in collectionL to objects that also exist in collectionR using a "superset" input association.

Parameters

collectionL	a first filtered collection
collectionR	a second filtered collection
inputAssociationLtoR	mapping between the two unfiltered collections
outputAssociationLtoR	mapping between the two filtered collections

Returns: mapping between the filtered collections

Definition at line 444 of file LArPandoraEvent.h.

Referenced by LArPandoraEvent().

   {
     for (const auto& objectL : collectionL) {
       if (inputAssociationLtoR.find(objectL) == inputAssociationLtoR.end())
         throw cet::exception("LArPandora")
           << " LArPandoraEvent::GetFilteredAssociationMap -- Can not find association for object "
              "in supplied collection."
           << std::endl;
 
       if (outputAssociationLtoR.find(objectL) != outputAssociationLtoR.end())
         throw cet::exception("LArPandora")
           << " LArPandoraEvent::GetFilteredAssociationMap -- Repeated objects in input collectionL"
           << std::endl;
 
       for (const auto& entry : inputAssociationLtoR.at(objectL)) {
         if (std::find(collectionR.begin(), collectionR.end(), entry.first) == collectionR.end())
           continue;
 
         outputAssociationLtoR[objectL].push_back(entry);
       }
     }
   }

template<typename T >

size_t lar_pandora::LArPandoraEvent::GetIndex	(	const art::Ptr< T >	object,
		const Collection< T > &	collection
	)		const

inlineprivate

Get the index of an objet in a given collection.

Parameters

object	the object to search for
collection	the collection to search through

Returns: the index of the object in the collection

Definition at line 562 of file LArPandoraEvent.h.

   {
     const auto it(std::find(collection.begin(), collection.end(), object));
     if (it == collection.end())
       throw cet::exception("LArPandora")
         << " LArPandoraEvent::GetIndex -- Can't find input object in the supplied collection."
         << std::endl;
 
     return static_cast<size_t>(std::distance(collection.begin(), it));
   }

template<typename L , typename R , typename D >

void lar_pandora::LArPandoraEvent::WriteAssociation	(	const Association< L, R, D > &	associationMap,
		const Collection< L > &	collectionL,
		const Collection< R > &	collectionR,
		const bool	thisProducesR = `true`
	)		const

inlineprivate

Write a given association to the event.

Parameters

associationMap	the association to write from objects of type L -> R + D
collectionL	the collection of type L that has been written
collectionR	the collection of type R that has been written
thisProducesR	will this producer produce collectionR of was it produced by a different module?

Definition at line 487 of file LArPandoraEvent.h.

Referenced by WriteToEvent().

   {
     // The output assocation to populate
     std::unique_ptr<art::Assns<L, R, D>> outputAssn(new art::Assns<L, R, D>);
 
     // NB. The art::Ptrs in the stored collections refer to the producer that originally created the objects (e.g. Pandora pat-rec). To make
     // correct associations, we need to make new art::Ptrs to refer to the *copies* of the objects made by this producer. This is done using
     // the PtrMaker utility.
     const art::PtrMaker<L> makePtrL(*m_pEvent);
 
     for (auto it = associationMap.begin(); it != associationMap.end(); ++it) {
       const auto indexL(this->GetIndex(it->first, collectionL));
       const auto outputPtrL(makePtrL(indexL));
 
       for (const auto& entry : it->second) {
         const auto& objectR(entry.first);
         const auto& objectD(entry.second);
 
         if (thisProducesR) {
           const art::PtrMaker<R> makePtrR(*m_pEvent);
           const auto indexR(this->GetIndex(objectR, collectionR));
           outputAssn->addSingle(outputPtrL, makePtrR(indexR), objectD);
         }
         else {
           outputAssn->addSingle(outputPtrL, objectR, objectD);
         }
       }
     }
 
     m_pEvent->put(std::move(outputAssn));
   }

template<typename L , typename R >

void lar_pandora::LArPandoraEvent::WriteAssociation	(	const Association< L, R, void * > &	associationMap,
		const Collection< L > &	collectionL,
		const Collection< R > &	collectionR,
		const bool	thisProducesR = `true`
	)		const

inlineprivate

Write a given association to the event.

Parameters

associationMap	the association to write from objects of type L -> R (no metadata)
collectionL	the collection of type L that has been written
collectionR	the collection of type R that has been written
thisProducesR	will this producer produce collectionR of was it produced by a different module?

Definition at line 525 of file LArPandoraEvent.h.

   {
     // The output assocation to populate
     std::unique_ptr<art::Assns<L, R>> outputAssn(new art::Assns<L, R>);
 
     // NB. The art::Ptrs in the stored collections refer to the producer that originally created the objects (e.g. Pandora pat-rec). To make
     // correct associations, we need to make new art::Ptrs to refer to the *copies* of the objects made by this producer. This is done using
     // the PtrMaker utility.
     const art::PtrMaker<L> makePtrL(*m_pEvent);
 
     for (auto it = associationMap.begin(); it != associationMap.end(); ++it) {
       const auto indexL(this->GetIndex(it->first, collectionL));
       const auto outputPtrL(makePtrL(indexL));
 
       for (const auto& entry : it->second) {
         const auto& objectR(entry.first);
 
         if (thisProducesR) {
           const art::PtrMaker<R> makePtrR(*m_pEvent);
           const auto indexR(this->GetIndex(objectR, collectionR));
           outputAssn->addSingle(outputPtrL, makePtrR(indexR));
         }
         else {
           outputAssn->addSingle(outputPtrL, objectR);
         }
       }
     }
 
     m_pEvent->put(std::move(outputAssn));
   }

template<typename T >

void lar_pandora::LArPandoraEvent::WriteCollection ( const Collection< T > & collection ) const

inlineprivate

Write a given collection to the event.

Parameters

collection the collection to write

Definition at line 474 of file LArPandoraEvent.h.

Referenced by WriteToEvent().

   {
     std::unique_ptr<std::vector<T>> output(new std::vector<T>);
 
     for (const auto& object : collection)
       output->push_back(*object);
 
     m_pEvent->put(std::move(output));
   }

void lar_pandora::LArPandoraEvent::WriteToEvent ( ) const

Write (put) the collections in this LArPandoraEvent to the art::Event.

Definition at line 83 of file LArPandoraEvent.cxx.

References m_clusterHitMap, m_clusters, m_hits, m_metadata, m_pcAxes, m_pfParticleClusterMap, m_pfParticleMetadataMap, m_pfParticlePCAxisMap, m_pfParticles, m_pfParticleShowerMap, m_pfParticleSliceMap, m_pfParticleSpacePointMap, m_pfParticleT0Map, m_pfParticleTrackMap, m_pfParticleVertexMap, m_shouldProduceT0s, m_showerHitMap, m_showerPCAxisMap, m_showers, m_sliceHitMap, m_slices, m_spacePointHitMap, m_spacePoints, m_t0s, m_trackHitMap, m_tracks, m_vertices, WriteAssociation(), and WriteCollection().

Referenced by lar_pandora::CollectionSplitting::produce(), and lar_pandora::LArPandoraExternalEventBuilding::produce().

   {
     this->WriteCollection(m_pfParticles);
     this->WriteCollection(m_spacePoints);
     this->WriteCollection(m_clusters);
     this->WriteCollection(m_vertices);
     this->WriteCollection(m_slices);
     this->WriteCollection(m_tracks);
     this->WriteCollection(m_showers);
     this->WriteCollection(m_pcAxes);
     this->WriteCollection(m_metadata);
 
     this->WriteAssociation(m_pfParticleSpacePointMap, m_pfParticles, m_spacePoints);
     this->WriteAssociation(m_pfParticleClusterMap, m_pfParticles, m_clusters);
     this->WriteAssociation(m_pfParticleVertexMap, m_pfParticles, m_vertices);
     this->WriteAssociation(m_pfParticleSliceMap, m_pfParticles, m_slices);
     this->WriteAssociation(m_pfParticleTrackMap, m_pfParticles, m_tracks);
     this->WriteAssociation(m_pfParticleShowerMap, m_pfParticles, m_showers);
     this->WriteAssociation(m_pfParticlePCAxisMap, m_pfParticles, m_pcAxes);
     this->WriteAssociation(m_pfParticleMetadataMap, m_pfParticles, m_metadata);
     this->WriteAssociation(m_spacePointHitMap, m_spacePoints, m_hits, false);
     this->WriteAssociation(m_clusterHitMap, m_clusters, m_hits, false);
     this->WriteAssociation(m_sliceHitMap, m_slices, m_hits, false);
     this->WriteAssociation(m_trackHitMap, m_tracks, m_hits, false);
     this->WriteAssociation(m_showerHitMap, m_showers, m_hits, false);
     this->WriteAssociation(m_showerPCAxisMap, m_showers, m_pcAxes);
 
     if (m_shouldProduceT0s) {
       this->WriteCollection(m_t0s);
       this->WriteAssociation(m_pfParticleT0Map, m_pfParticles, m_t0s);
     }
   }

Member Data Documentation

ClusterToHitAssoc lar_pandora::LArPandoraEvent::m_clusterHitMap

private

The input associations: Cluster -> Hit.

Definition at line 346 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

ClusterCollection lar_pandora::LArPandoraEvent::m_clusters

private

The input collection of Clusters.

Definition at line 319 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

HitCollection lar_pandora::LArPandoraEvent::m_hits

private

The input collection of Hits.

Definition at line 327 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

Labels lar_pandora::LArPandoraEvent::m_labels

private

A set of labels describing the producers for each input collection.

Definition at line 312 of file LArPandoraEvent.h.

Referenced by lar_pandora::LArPandoraEvent::Labels::GetLabel(), lar_pandora::LArPandoraEvent::Labels::Labels(), and lar_pandora::LArPandoraEvent::Labels::SetLabel().

PFParticleMetadataCollection lar_pandora::LArPandoraEvent::m_metadata

private

The input collection of PFParticle metadata.

Definition at line 325 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PCAxisCollection lar_pandora::LArPandoraEvent::m_pcAxes

private

The input collection of PCAxes.

Definition at line 326 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

art::Event* lar_pandora::LArPandoraEvent::m_pEvent

private

The event to consider.

Definition at line 311 of file LArPandoraEvent.h.

PFParticleToClusterAssoc lar_pandora::LArPandoraEvent::m_pfParticleClusterMap

private

The input associations: PFParticle -> Cluster.

Definition at line 333 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToPFParticleMetadataAssoc lar_pandora::LArPandoraEvent::m_pfParticleMetadataMap

private

The input associations: PFParticle -> Metadata.

Definition at line 342 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToPCAxisAssoc lar_pandora::LArPandoraEvent::m_pfParticlePCAxisMap

private

The input associations: PFParticle -> PCAxis.

Definition at line 344 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleCollection lar_pandora::LArPandoraEvent::m_pfParticles

private

The input collection of PFParticles.

Definition at line 317 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToShowerAssoc lar_pandora::LArPandoraEvent::m_pfParticleShowerMap

private

The input associations: PFParticle -> Shower.

Definition at line 339 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToSliceAssoc lar_pandora::LArPandoraEvent::m_pfParticleSliceMap

private

The input associations: PFParticle -> Slice.

Definition at line 336 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToSpacePointAssoc lar_pandora::LArPandoraEvent::m_pfParticleSpacePointMap

private

The input associations: PFParticle -> SpacePoint.

Definition at line 331 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToT0Assoc lar_pandora::LArPandoraEvent::m_pfParticleT0Map

private

The input associations: PFParticle -> T0.

Definition at line 340 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToTrackAssoc lar_pandora::LArPandoraEvent::m_pfParticleTrackMap

private

The input associations: PFParticle -> Track.

Definition at line 337 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

PFParticleToVertexAssoc lar_pandora::LArPandoraEvent::m_pfParticleVertexMap

private

The input associations: PFParticle -> Vertex.

Definition at line 335 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

art::EDProducer* lar_pandora::LArPandoraEvent::m_pProducer

private

The producer which should write the output collections and associations.

Definition at line 310 of file LArPandoraEvent.h.

bool lar_pandora::LArPandoraEvent::m_shouldProduceT0s

private

If T0s should be produced (usually only true for use cases with multiple drift volumes)

Definition at line 314 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

ShowerToHitAssoc lar_pandora::LArPandoraEvent::m_showerHitMap

private

The input associations: Shower -> Hit.

Definition at line 349 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

ShowerToPCAxisAssoc lar_pandora::LArPandoraEvent::m_showerPCAxisMap

private

The input associations: PCAxis -> Shower.

Definition at line 350 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

ShowerCollection lar_pandora::LArPandoraEvent::m_showers

private

The input collection of Showers.

Definition at line 323 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

SliceToHitAssoc lar_pandora::LArPandoraEvent::m_sliceHitMap

private

The input associations: Slice -> Hit.

Definition at line 347 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

SliceCollection lar_pandora::LArPandoraEvent::m_slices

private

The input collection of Slices.

Definition at line 321 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

SpacePointToHitAssoc lar_pandora::LArPandoraEvent::m_spacePointHitMap

private

The input associations: SpacePoint -> Hit.

Definition at line 345 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

SpacePointCollection lar_pandora::LArPandoraEvent::m_spacePoints

private

The input collection of SpacePoints.

Definition at line 318 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

T0Collection lar_pandora::LArPandoraEvent::m_t0s

private

The input collection of T0s.

Definition at line 324 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

TrackToHitAssoc lar_pandora::LArPandoraEvent::m_trackHitMap

private

The input associations: Track -> Hit.

Definition at line 348 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

TrackCollection lar_pandora::LArPandoraEvent::m_tracks

private

The input collection of Tracks.

Definition at line 322 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

VertexCollection lar_pandora::LArPandoraEvent::m_vertices

private

The input collection of Vertices.

Definition at line 320 of file LArPandoraEvent.h.

Referenced by GetCollections(), LArPandoraEvent(), and WriteToEvent().

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

larpandora/v09_22_05/source/larpandora/LArPandoraEventBuilding/LArPandoraEvent.h
larpandora/v09_22_05/source/larpandora/LArPandoraEventBuilding/LArPandoraEvent.cxx

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation