LArPandoraHelper class. More...

#include "LArPandoraHelper.h"

Public Types
enum	DaughterMode { kIgnoreDaughters = 0 , kUseDaughters = 1 , kAddDaughters = 2 }
	DaughterMode enumeration. More...

Static Public Member Functions
static void	CollectWires (const art::Event &evt, const std::string &label, WireVector &wireVector)
	Collect the reconstructed wires from the ART event record.

static void	CollectHits (const art::Event &evt, const std::string &label, HitVector &hitVector)
	Collect the reconstructed Hits from the ART event record.

static void	CollectPFParticles (const art::Event &evt, const std::string &label, PFParticleVector &particleVector)
	Collect the reconstructed PFParticles from the ART event record.

static void	CollectSpacePoints (const art::Event &evt, const std::string &label, SpacePointVector &spacePointVector, SpacePointsToHits &spacePointsToHits)
	Collect the reconstructed SpacePoints and associated hits from the ART event record.

static void	CollectSpacePoints (const art::Event &evt, const std::string &label, SpacePointVector &spacePointVector, SpacePointsToHits &spacePointsToHits, HitsToSpacePoints &hitsToSpacePoints)
	Collect the reconstructed SpacePoints and associated hits from the ART event record.

static void	CollectClusters (const art::Event &evt, const std::string &label, ClusterVector &clusterVector, ClustersToHits &clustersToHits)
	Collect the reconstructed Clusters and associated hits from the ART event record.

static void	CollectPFParticles (const art::Event &evt, const std::string &label, PFParticleVector &particleVector, PFParticlesToSpacePoints &particlesToSpacePoints)
	Collect the reconstructed PFParticles and associated SpacePoints from the ART event record.

static void	CollectPFParticles (const art::Event &evt, const std::string &label, PFParticleVector &particleVector, PFParticlesToClusters &particlesToClusters)
	Collect the reconstructed PFParticles and associated Clusters from the ART event record.

static void	CollectPFParticleMetadata (const art::Event &evt, const std::string &label, PFParticleVector &particleVector, PFParticlesToMetadata &particlesToMetadata)
	Collect the reconstructed PFParticle Metadata from the ART event record.

static void	CollectShowers (const art::Event &evt, const std::string &label, ShowerVector &showerVector, PFParticlesToShowers &particlesToShowers)
	Collect the reconstructed PFParticles and associated Showers from the ART event record.

static void	CollectShowers (const art::Event &evt, const std::string &label, ShowerVector &showerVector, ShowersToHits &showersToHits)
	Collect the reconstructed Showers and associated Hits from the ART event record.

static void	CollectTracks (const art::Event &evt, const std::string &label, TrackVector &trackVector, PFParticlesToTracks &particlesToTracks)
	Collect the reconstructed PFParticles and associated Tracks from the ART event record.

static void	CollectTracks (const art::Event &evt, const std::string &label, TrackVector &trackVector, TracksToHits &tracksToHits)
	Collect the reconstructed Tracks and associated Hits from the ART event record.

static void	CollectSeeds (const art::Event &evt, const std::string &label, SeedVector &seedVector, PFParticlesToSeeds &particlesToSeeds)
	Collect the reconstructed PFParticles and associated Seeds from the ART event record.

static void	CollectSeeds (const art::Event &evt, const std::string &label, SeedVector &seedVector, SeedsToHits &seedsToHits)
	Collect the reconstructed Seeds and associated Hits from the ART event record.

static void	CollectVertices (const art::Event &evt, const std::string &label, VertexVector &vertexVector, PFParticlesToVertices &particlesToVertices)
	Collect the reconstructed PFParticles and associated Vertices from the ART event record.

static void	BuildPFParticleHitMaps (const PFParticleVector &particleVector, const PFParticlesToSpacePoints &particlesToSpacePoints, const SpacePointsToHits &spacePointsToHits, PFParticlesToHits &particlesToHits, HitsToPFParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters)
	Build mapping between PFParticles and Hits using PFParticle/SpacePoint/Hit maps.

static void	BuildPFParticleHitMaps (const PFParticleVector &particleVector, const PFParticlesToClusters &particlesToClusters, const ClustersToHits &clustersToHits, PFParticlesToHits &particlesToHits, HitsToPFParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters)
	Build mapping between PFParticles and Hits using PFParticle/Cluster/Hit maps.

static void	BuildPFParticleHitMaps (const art::Event &evt, const std::string &label_pfpart, const std::string &label_mid, PFParticlesToHits &particlesToHits, HitsToPFParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters, const bool useClusters=true)
	Build mapping between PFParticles and Hits starting from ART event record.

static void	BuildPFParticleHitMaps (const art::Event &evt, const std::string &label, PFParticlesToHits &particlesToHits, HitsToPFParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters, const bool useClusters=true)
	Build mapping between PFParticles and Hits starting from ART event record.

static void	CollectCosmicTags (const art::Event &evt, const std::string &label, CosmicTagVector &cosmicTagVector, TracksToCosmicTags &tracksToCosmicTags)
	Collect a vector of cosmic tags from the ART event record.

static void	CollectT0s (const art::Event &evt, const std::string &label, T0Vector &t0Vector, PFParticlesToT0s &particlesToT0s)
	Collect a vector of T0s from the ART event record.

static void	CollectSimChannels (const art::Event &evt, const std::string &label, SimChannelVector &simChannelVector, bool &areSimChannelsValid)
	Collect a vector of SimChannel objects from the ART event record.

static void	CollectMCParticles (const art::Event &evt, const std::string &label, MCParticleVector &particleVector)
	Collect a vector of MCParticle objects from the ART event record.

static void	CollectGeneratorMCParticles (const art::Event &evt, const std::string &label, RawMCParticleVector &particleVector)
	Collect a vector of MCParticle objects from the generator in the ART event record. ATTN: This function is needed as accessing generator (opposed to Geant4) level MCParticles requires use of MCTruth block.

static void	CollectMCParticles (const art::Event &evt, const std::string &label, MCTruthToMCParticles &truthToParticles, MCParticlesToMCTruth &particlesToTruth)
	Collect truth information from the ART event record.

static void	BuildMCParticleHitMaps (const art::Event &evt, const HitVector &hitVector, const SimChannelVector &simChannelVector, HitsToTrackIDEs &hitsToTrackIDEs)
	Collect the links from reconstructed hits to their true energy deposits.

static void	BuildMCParticleHitMaps (const HitsToTrackIDEs &hitsToTrackIDEs, const MCTruthToMCParticles &truthToParticles, MCParticlesToHits &particlesToHits, HitsToMCParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters)
	Build mapping between Hits and MCParticles, starting from Hit/TrackIDE/MCParticle information.

static void	BuildMCParticleHitMaps (const art::Event &evt, const std::string &label, const HitVector &hitVector, MCParticlesToHits &particlesToHits, HitsToMCParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters)
	Build mapping between Hits and MCParticles, starting from ART event record.

static void	BuildMCParticleHitMaps (const art::Event &evt, const std::string &hitLabel, const std::string &backtrackLabel, HitsToTrackIDEs &hitsToTrackIDEs)
	Get mapping between hits and true energy deposits using back-tracker information.

static void	BuildMCParticleHitMaps (const art::Event &evt, const std::string &truthLabel, const std::string &hitLabel, const std::string &backtrackLabel, MCParticlesToHits &particlesToHits, HitsToMCParticles &hitsToParticles, const DaughterMode daughterMode=kUseDaughters)
	Build mapping between Hits and MCParticles, starting from Hit/TrackIDE/MCParticle information.

template<typename T >
static void	GetAssociatedHits (const art::Event &evt, const std::string &label, const std::vector< art::Ptr< T > > &inputVector, HitVector &associatedHits, const pandora::IntVector *const indexVector=nullptr)
	Get all hits associated with input clusters.

static void	SelectNeutrinoPFParticles (const PFParticleVector &inputParticles, PFParticleVector &outputParticles)
	Select reconstructed neutrino particles from a list of all reconstructed particles.

static void	SelectFinalStatePFParticles (const PFParticleVector &inputParticles, PFParticleVector &outputParticles)
	Select final-state reconstructed particles from a list of all reconstructed particles.

static void	BuildMCParticleMap (const MCParticleVector &particleVector, MCParticleMap &particleMap)
	Build particle maps for true particles.

static void	BuildPFParticleMap (const PFParticleVector &particleVector, PFParticleMap &particleMap)
	Build particle maps for reconstructed particles.

static art::Ptr< recob::PFParticle >	GetParentPFParticle (const PFParticleMap &particleMap, const art::Ptr< recob::PFParticle > daughterParticle)
	Return the top-level parent particle by navigating up the chain of parent/daughter associations.

static art::Ptr< recob::PFParticle >	GetFinalStatePFParticle (const PFParticleMap &particleMap, const art::Ptr< recob::PFParticle > daughterParticle)
	Return the final-state parent particle by navigating up the chain of parent/daughter associations.

static art::Ptr< simb::MCParticle >	GetParentMCParticle (const MCParticleMap &particleMap, const art::Ptr< simb::MCParticle > daughterParticle)
	Return the top-level parent particle by navigating up the chain of parent/daughter associations.

static art::Ptr< simb::MCParticle >	GetFinalStateMCParticle (const MCParticleMap &particleMap, const art::Ptr< simb::MCParticle > daughterParticle)
	Return the final-state parent particle by navigating up the chain of parent/daughter associations.

static art::Ptr< recob::Track >	GetPrimaryTrack (const PFParticlesToTracks &particlesToTracks, const art::Ptr< recob::PFParticle > particle)
	Return the primary track associated with a PFParticle.

static int	GetGeneration (const PFParticleMap &particleMap, const art::Ptr< recob::PFParticle > daughterParticle)
	Return the generation of this particle (first generation if primary)

static int	GetParentNeutrino (const PFParticleMap &particleMap, const art::Ptr< recob::PFParticle > daughterParticle)
	Return the parent neutrino PDG code (or zero for cosmics) for a given reconstructed particle.

static bool	IsFinalState (const PFParticleMap &particleMap, const art::Ptr< recob::PFParticle > daughterParticle)
	Determine whether a particle has been reconstructed as a final-state particle.

static bool	IsNeutrino (const art::Ptr< recob::PFParticle > particle)
	Determine whether a particle has been reconstructed as a neutrino.

static bool	IsTrack (const art::Ptr< recob::PFParticle > particle)
	Determine whether a particle has been reconstructed as track-like.

static bool	IsShower (const art::Ptr< recob::PFParticle > particle)
	Determine whether a particle has been reconstructed as shower-like.

static bool	IsVisible (const art::Ptr< simb::MCParticle > particle)
	Determine whether a particle is visible (i.e. long-lived charged particle)

static larpandoraobj::PFParticleMetadata	GetPFParticleMetadata (const pandora::ParticleFlowObject *const pPfo)
	Get metadata associated to a PFO.

Detailed Description

LArPandoraHelper class.

Definition at line 121 of file LArPandoraHelper.h.

Member Enumeration Documentation

◆ DaughterMode

enum lar_pandora::LArPandoraHelper::DaughterMode

DaughterMode enumeration.

Enumerator
kIgnoreDaughters
kUseDaughters
kAddDaughters

Definition at line 126 of file LArPandoraHelper.h.

Member Function Documentation

◆ BuildMCParticleHitMaps() [1/5]

void lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps	(	const art::Event &	evt,
		const HitVector &	hitVector,
		const SimChannelVector &	simChannelVector,
		HitsToTrackIDEs &	hitsToTrackIDEs
	)

static

Collect the links from reconstructed hits to their true energy deposits.

Parameters

evt	the art event containers
hitVector	the input vector of reconstructed hits
simChannelVector	the input vector of SimChannels
hitsToTrackIDEs	the out map from hits to true energy deposits

Definition at line 889 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ BuildMCParticleHitMaps() [2/5]

void lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps	(	const art::Event &	evt,
		const std::string &	hitLabel,
		const std::string &	backtrackLabel,
		HitsToTrackIDEs &	hitsToTrackIDEs
	)

static

Get mapping between hits and true energy deposits using back-tracker information.

Parameters

evt	the event record
hitLabel	the label of the collection of hits
backtrackLabel	the label of the collection of back-tracker information
hitsToTrackIDEs	the output map between hits and true energy deposits

Definition at line 1037 of file LArPandoraHelper.cxx.

◆ BuildMCParticleHitMaps() [3/5]

void lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps	(	const art::Event &	evt,
		const std::string &	label,
		const HitVector &	hitVector,
		MCParticlesToHits &	particlesToHits,
		HitsToMCParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`
	)

static

Build mapping between Hits and MCParticles, starting from ART event record.

Parameters

evt	the ART event record
label	the label for the truth information in the event
hitVector	the input vector of reconstructed hits
particlesToHits	the output mapping between true particles and reconstructed hits
hitsToParticles	the output mapping between reconstructed hits and true particles
daughterMode	treatment of daughter particles in construction of maps

Definition at line 1014 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ BuildMCParticleHitMaps() [4/5]

void lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps	(	const art::Event &	evt,
		const std::string &	truthLabel,
		const std::string &	hitLabel,
		const std::string &	backtrackLabel,
		MCParticlesToHits &	particlesToHits,
		HitsToMCParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`
	)

static

Build mapping between Hits and MCParticles, starting from Hit/TrackIDE/MCParticle information.

Parameters

evt	the event record
truthLabel	the label describing the G4 truth information
hitLabel	the label describing the hit collection
backtrackLabel	the label describing the back-tracker information
particlesToHits	the mapping between true particles and reconstructed hits
hitsToParticles	the mapping between reconstructed hits and true particles
daughterMode	treatment of daughter particles in construction of maps

Definition at line 1096 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ BuildMCParticleHitMaps() [5/5]

void lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps	(	const HitsToTrackIDEs &	hitsToTrackIDEs,
		const MCTruthToMCParticles &	truthToParticles,
		MCParticlesToHits &	particlesToHits,
		HitsToMCParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`
	)

static

Build mapping between Hits and MCParticles, starting from Hit/TrackIDE/MCParticle information.

Parameters

hitsToTrackIDEs	the input map from hits to true energy deposits
truthToParticles	the input map of truth information
particlesToHits	the mapping between true particles and reconstructed hits
hitsToParticles	the mapping between reconstructed hits and true particles
daughterMode	treatment of daughter particles in construction of maps

Definition at line 938 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ BuildMCParticleMap()

void lar_pandora::LArPandoraHelper::BuildMCParticleMap	(	const MCParticleVector &	particleVector,
		MCParticleMap &	particleMap
	)

static

Build particle maps for true particles.

Parameters

particleVector	the input vector of true particles
particleMap	the output mapping between true particle and true track ID

Definition at line 1151 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ BuildPFParticleHitMaps() [1/4]

void lar_pandora::LArPandoraHelper::BuildPFParticleHitMaps	(	const art::Event &	evt,
		const std::string &	label,
		PFParticlesToHits &	particlesToHits,
		HitsToPFParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`,
		const bool	useClusters = `true`
	)

static

Build mapping between PFParticles and Hits starting from ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
particlesToHits	output map from PFParticle to Hit objects
hitsToParticles	output map from Hit to PFParticle objects
daughterMode	treatment of daughter particles in construction of maps
useClusters	choice of intermediate object (true for Clusters, false for SpacePoints)

Definition at line 624 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ BuildPFParticleHitMaps() [2/4]

void lar_pandora::LArPandoraHelper::BuildPFParticleHitMaps	(	const art::Event &	evt,
		const std::string &	label_pfpart,
		const std::string &	label_mid,
		PFParticlesToHits &	particlesToHits,
		HitsToPFParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`,
		const bool	useClusters = `true`
	)

static

Build mapping between PFParticles and Hits starting from ART event record.

Parameters

evt	the ART event record
label_pfpart	the label for the PFParticle list in the event
label_space	the label for the Intermediate list in the event
particlesToHits	output map from PFParticle to Hit objects
hitsToParticles	output map from Hit to PFParticle objects
daughterMode	treatment of daughter particles in construction of maps
useClusters	choice of intermediate object (true for Clusters, false for SpacePoints)

Definition at line 637 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ BuildPFParticleHitMaps() [3/4]

void lar_pandora::LArPandoraHelper::BuildPFParticleHitMaps	(	const PFParticleVector &	particleVector,
		const PFParticlesToClusters &	particlesToClusters,
		const ClustersToHits &	clustersToHits,
		PFParticlesToHits &	particlesToHits,
		HitsToPFParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`
	)

static

Build mapping between PFParticles and Hits using PFParticle/Cluster/Hit maps.

Parameters

particleVector	the input vector of PFParticle objects
particlesToClusters	the input map from PFParticle to Cluster objects
clustersToHits	the input map from Cluster to Hit objects
particlesToHits	the output map from PFParticle to Hit objects
hitsToParticles	the output map from Hit to PFParticle objects
daughterMode	treatment of daughter particles in construction of maps

Definition at line 564 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ BuildPFParticleHitMaps() [4/4]

void lar_pandora::LArPandoraHelper::BuildPFParticleHitMaps	(	const PFParticleVector &	particleVector,
		const PFParticlesToSpacePoints &	particlesToSpacePoints,
		const SpacePointsToHits &	spacePointsToHits,
		PFParticlesToHits &	particlesToHits,
		HitsToPFParticles &	hitsToParticles,
		const DaughterMode	daughterMode = `kUseDaughters`
	)

static

Build mapping between PFParticles and Hits using PFParticle/SpacePoint/Hit maps.

Parameters

particleVector	the input vector of PFParticle objects
particlesToSpacePoints	the input map from PFParticle to SpacePoint objects
spacePointsToHits	the input map from SpacePoint to Hit objects
particlesToHits	the output map from PFParticle to Hit objects
hitsToParticles	the output map from Hit to PFParticle objects
daughterMode	treatment of daughter particles in construction of maps

Definition at line 507 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildPFParticleMap()

void lar_pandora::LArPandoraHelper::BuildPFParticleMap	(	const PFParticleVector &	particleVector,
		PFParticleMap &	particleMap
	)

static

Build particle maps for reconstructed particles.

Parameters

particleVector	the input vector of reconstructed particles
particleMap	the output mapping between reconstructed particles and particle ID

Definition at line 1166 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectClusters()

void lar_pandora::LArPandoraHelper::CollectClusters	(	const art::Event &	evt,
		const std::string &	label,
		ClusterVector &	clusterVector,
		ClustersToHits &	clustersToHits
	)

static

Collect the reconstructed Clusters and associated hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the SpacePoint list in the event
clusterVector	the output vector of Cluster objects
clustersToHits	the output map from Cluster to Hit objects

Definition at line 159 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectCosmicTags()

void lar_pandora::LArPandoraHelper::CollectCosmicTags	(	const art::Event &	evt,
		const std::string &	label,
		CosmicTagVector &	cosmicTagVector,
		TracksToCosmicTags &	tracksToCosmicTags
	)

static

Collect a vector of cosmic tags from the ART event record.

Parameters

evt	the ART event record
label	the label for the cosmic tag information in the event
cosmicTagVector	output vector of CosmicTag objects
tracksToCosmicTags	output map from tracks to cosmic tags

Definition at line 730 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectGeneratorMCParticles()

void lar_pandora::LArPandoraHelper::CollectGeneratorMCParticles	(	const art::Event &	evt,
		const std::string &	label,
		RawMCParticleVector &	particleVector
	)

static

Collect a vector of MCParticle objects from the generator in the ART event record. ATTN: This function is needed as accessing generator (opposed to Geant4) level MCParticles requires use of MCTruth block.

Parameters

evt	the ART event record
label	the label for the truth information in the generator
particleVector	the output vector of MCParticle objects

Definition at line 830 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectHits()

void lar_pandora::LArPandoraHelper::CollectHits	(	const art::Event &	evt,
		const std::string &	label,
		HitVector &	hitVector
	)

static

Collect the reconstructed Hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the Hit list in the event
hitVector	the ouput vector of Hit objects

Definition at line 70 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectMCParticles() [1/2]

void lar_pandora::LArPandoraHelper::CollectMCParticles	(	const art::Event &	evt,
		const std::string &	label,
		MCParticleVector &	particleVector
	)

static

Collect a vector of MCParticle objects from the ART event record.

Parameters

evt	the ART event record
label	the label for the truth information in the event
particleVector	the output vector of MCParticle objects

Definition at line 806 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectMCParticles() [2/2]

void lar_pandora::LArPandoraHelper::CollectMCParticles	(	const art::Event &	evt,
		const std::string &	label,
		MCTruthToMCParticles &	truthToParticles,
		MCParticlesToMCTruth &	particlesToTruth
	)

static

Collect truth information from the ART event record.

Parameters

evt	the ART event record
label	the label for the truth information in the event
truthToParticles	output map from MCTruth to MCParticle objects
particlesToTruth	output map from MCParticle to MCTruth objects

Definition at line 860 of file LArPandoraHelper.cxx.

◆ CollectPFParticleMetadata()

void lar_pandora::LArPandoraHelper::CollectPFParticleMetadata	(	const art::Event &	evt,
		const std::string &	label,
		PFParticleVector &	particleVector,
		PFParticlesToMetadata &	particlesToMetadata
	)

static

Collect the reconstructed PFParticle Metadata from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
particleVector	the output vector of PFParticle objects
particlesToSpacePoints	the output map from PFParticle to PFParticleMetadata objects

Definition at line 254 of file LArPandoraHelper.cxx.

◆ CollectPFParticles() [1/3]

void lar_pandora::LArPandoraHelper::CollectPFParticles	(	const art::Event &	evt,
		const std::string &	label,
		PFParticleVector &	particleVector
	)

static

Collect the reconstructed PFParticles from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
particleVector	the output vector of PFParticle objects

Definition at line 93 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectPFParticles() [2/3]

void lar_pandora::LArPandoraHelper::CollectPFParticles	(	const art::Event &	evt,
		const std::string &	label,
		PFParticleVector &	particleVector,
		PFParticlesToClusters &	particlesToClusters
	)

static

Collect the reconstructed PFParticles and associated Clusters from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
particleVector	the output vector of PFParticle objects
particlesToClusters	the output map from PFParticle to Cluster objects

Definition at line 222 of file LArPandoraHelper.cxx.

◆ CollectPFParticles() [3/3]

void lar_pandora::LArPandoraHelper::CollectPFParticles	(	const art::Event &	evt,
		const std::string &	label,
		PFParticleVector &	particleVector,
		PFParticlesToSpacePoints &	particlesToSpacePoints
	)

static

Collect the reconstructed PFParticles and associated SpacePoints from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
particleVector	the output vector of PFParticle objects
particlesToSpacePoints	the output map from PFParticle to SpacePoint objects

Definition at line 190 of file LArPandoraHelper.cxx.

◆ CollectSeeds() [1/2]

void lar_pandora::LArPandoraHelper::CollectSeeds	(	const art::Event &	evt,
		const std::string &	label,
		SeedVector &	seedVector,
		PFParticlesToSeeds &	particlesToSeeds
	)

static

Collect the reconstructed PFParticles and associated Seeds from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
seedVector	the output vector of Seed objects
particlesToSeeds	the output map from PFParticle to Seed objects

Definition at line 412 of file LArPandoraHelper.cxx.

◆ CollectSeeds() [2/2]

void lar_pandora::LArPandoraHelper::CollectSeeds	(	const art::Event &	evt,
		const std::string &	label,
		SeedVector &	seedVector,
		SeedsToHits &	seedsToHits
	)

static

Collect the reconstructed Seeds and associated Hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
seedVector	the output vector of Seed objects
seedsToHits	the output map from Seed to Hit objects

Definition at line 443 of file LArPandoraHelper.cxx.

◆ CollectShowers() [1/2]

void lar_pandora::LArPandoraHelper::CollectShowers	(	const art::Event &	evt,
		const std::string &	label,
		ShowerVector &	showerVector,
		PFParticlesToShowers &	particlesToShowers
	)

static

Collect the reconstructed PFParticles and associated Showers from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
showerVector	the output vector of Shower objects
particlesToShowers	the output map from PFParticle to Shower objects

Definition at line 288 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectShowers() [2/2]

void lar_pandora::LArPandoraHelper::CollectShowers	(	const art::Event &	evt,
		const std::string &	label,
		ShowerVector &	showerVector,
		ShowersToHits &	showersToHits
	)

static

Collect the reconstructed Showers and associated Hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
showerVector	the output vector of Shower objects
showersToHits	the output map from Shower to Hit objects

Definition at line 381 of file LArPandoraHelper.cxx.

◆ CollectSimChannels()

void lar_pandora::LArPandoraHelper::CollectSimChannels	(	const art::Event &	evt,
		const std::string &	label,
		SimChannelVector &	simChannelVector,
		bool &	areSimChannelsValid
	)

static

Collect a vector of SimChannel objects from the ART event record.

Parameters

evt	the ART event record
label	the label for the truth information in the event
simChannelVector	output vector of SimChannel objects
areSimChannelsValid	boolean parameter indicating if the sim channel collection exists

Definition at line 779 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectSpacePoints() [1/2]

void lar_pandora::LArPandoraHelper::CollectSpacePoints	(	const art::Event &	evt,
		const std::string &	label,
		SpacePointVector &	spacePointVector,
		SpacePointsToHits &	spacePointsToHits
	)

static

Collect the reconstructed SpacePoints and associated hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the SpacePoint list in the event
spacePointVector	the output vector of SpacePoint objects
spacePointsToHits	the output map from SpacePoint to Hit objects

Definition at line 117 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CollectSpacePoints() [2/2]

void lar_pandora::LArPandoraHelper::CollectSpacePoints	(	const art::Event &	evt,
		const std::string &	label,
		SpacePointVector &	spacePointVector,
		SpacePointsToHits &	spacePointsToHits,
		HitsToSpacePoints &	hitsToSpacePoints
	)

static

Collect the reconstructed SpacePoints and associated hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the SpacePoint list in the event
spacePointVector	the output vector of SpacePoint objects
spacePointsToHits	the output map from SpacePoint to Hit objects
hitsToSpacePoints	the output map from Hit to SpacePoint objects

Definition at line 129 of file LArPandoraHelper.cxx.

◆ CollectT0s()

void lar_pandora::LArPandoraHelper::CollectT0s	(	const art::Event &	evt,
		const std::string &	label,
		T0Vector &	t0Vector,
		PFParticlesToT0s &	particlesToT0s
	)

static

Collect a vector of T0s from the ART event record.

Parameters

evt	the ART event record
label	the label for the T0 information in the event
t0Vector	output vector of T0 objects
particlesToT0s	output map from PParticles to T0s

Definition at line 753 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectTracks() [1/2]

void lar_pandora::LArPandoraHelper::CollectTracks	(	const art::Event &	evt,
		const std::string &	label,
		TrackVector &	trackVector,
		PFParticlesToTracks &	particlesToTracks
	)

static

Collect the reconstructed PFParticles and associated Tracks from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
trackVector	the output vector of Track objects
particlesToTracks	the output map from PFParticle to Track objects

Definition at line 319 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectTracks() [2/2]

void lar_pandora::LArPandoraHelper::CollectTracks	(	const art::Event &	evt,
		const std::string &	label,
		TrackVector &	trackVector,
		TracksToHits &	tracksToHits
	)

static

Collect the reconstructed Tracks and associated Hits from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
trackVector	the output vector of Track objects
tracksToHits	the output map from Track to Hit objects

Definition at line 350 of file LArPandoraHelper.cxx.

◆ CollectVertices()

void lar_pandora::LArPandoraHelper::CollectVertices	(	const art::Event &	evt,
		const std::string &	label,
		VertexVector &	vertexVector,
		PFParticlesToVertices &	particlesToVertices
	)

static

Collect the reconstructed PFParticles and associated Vertices from the ART event record.

Parameters

evt	the ART event record
label	the label for the PFParticle list in the event
vertexVector	the output vector of Vertex objects
particlesToVertices	the output map from PFParticle to Vertex objects

Definition at line 476 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ CollectWires()

void lar_pandora::LArPandoraHelper::CollectWires	(	const art::Event &	evt,
		const std::string &	label,
		WireVector &	wireVector
	)

static

Collect the reconstructed wires from the ART event record.

Parameters

evt	the ART event record
label	the label for the Wire list in the event
wireVector	the ouput vector of Wire objects

Definition at line 47 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ GetAssociatedHits()

template<typename T >

template void lar_pandora::LArPandoraHelper::GetAssociatedHits	(	const art::Event &	evt,
		const std::string &	label,
		const std::vector< art::Ptr< T > > &	inputVector,
		HitVector &	associatedHits,
		const pandora::IntVector *const	indexVector = `nullptr`
	)

static

Get all hits associated with input clusters.

Parameters

evt	the event containing the hits
label	the label of the collection producing PFParticles
input	vector input of T (clusters, spacepoints)
associatedHits	output hits associated with T
indexVector	vector of spacepoint indices reflecting trajectory points sorting order

Definition at line 1117 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ GetFinalStateMCParticle()

art::Ptr< simb::MCParticle > lar_pandora::LArPandoraHelper::GetFinalStateMCParticle	(	const MCParticleMap &	particleMap,
		const art::Ptr< simb::MCParticle >	daughterParticle
	)

static

Return the final-state parent particle by navigating up the chain of parent/daughter associations.

Parameters

particleMap	the mapping between true particle and true track ID
daughterParticle	the input MC particle

Returns: the final-state parent particle

Definition at line 1279 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFinalStatePFParticle()

art::Ptr< recob::PFParticle > lar_pandora::LArPandoraHelper::GetFinalStatePFParticle	(	const PFParticleMap &	particleMap,
		const art::Ptr< recob::PFParticle >	daughterParticle
	)

static

Return the final-state parent particle by navigating up the chain of parent/daughter associations.

Parameters

particleMap	the mapping between reconstructed particle and particle ID
daughterParticle	the input PF particle

Returns: the final-state parent particle

Definition at line 1212 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGeneration()

int lar_pandora::LArPandoraHelper::GetGeneration	(	const PFParticleMap &	particleMap,
		const art::Ptr< recob::PFParticle >	daughterParticle
	)

static

Return the generation of this particle (first generation if primary)

Parameters

particleMap	the mapping between reconstructed particle and particle ID
daughterParticle	the input daughter particle

Returns: the nth generation in the particle hierarchy

Definition at line 1333 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ GetParentMCParticle()

art::Ptr< simb::MCParticle > lar_pandora::LArPandoraHelper::GetParentMCParticle	(	const MCParticleMap &	particleMap,
		const art::Ptr< simb::MCParticle >	daughterParticle
	)

static

Return the top-level parent particle by navigating up the chain of parent/daughter associations.

Parameters

particleMap	the mapping between true particle and true track ID
daughterParticle	the input MC particle

Returns: the top-level parent particle

Definition at line 1250 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ GetParentNeutrino()

int lar_pandora::LArPandoraHelper::GetParentNeutrino	(	const PFParticleMap &	particleMap,
		const art::Ptr< recob::PFParticle >	daughterParticle
	)

static

Return the parent neutrino PDG code (or zero for cosmics) for a given reconstructed particle.

Parameters

particleMap	the mapping between reconstructed particle and particle ID
daughterParticle	the input daughter particle

Returns: the PDG code of the parent neutrinos (or zero for cosmics)

Definition at line 1359 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetParentPFParticle()

art::Ptr< recob::PFParticle > lar_pandora::LArPandoraHelper::GetParentPFParticle	(	const PFParticleMap &	particleMap,
		const art::Ptr< recob::PFParticle >	daughterParticle
	)

static

Return the top-level parent particle by navigating up the chain of parent/daughter associations.

Parameters

particleMap	the mapping between reconstructed particle and particle ID
daughterParticle	the input PF particle

Returns: the top-level parent particle

Definition at line 1180 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ GetPFParticleMetadata()

larpandoraobj::PFParticleMetadata lar_pandora::LArPandoraHelper::GetPFParticleMetadata ( const pandora::ParticleFlowObject *const pPfo )

static

Get metadata associated to a PFO.

Parameters

pPfo	input ParticleFlowObject

Returns: larpandoraobj::PFParticleMetadata

Definition at line 1456 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPrimaryTrack()

art::Ptr< recob::Track > lar_pandora::LArPandoraHelper::GetPrimaryTrack	(	const PFParticlesToTracks &	particlesToTracks,
		const art::Ptr< recob::PFParticle >	particle
	)

static

Return the primary track associated with a PFParticle.

Parameters

particlesToTracks	the mapping between particles and tracks
particle	the input particle

Definition at line 1313 of file LArPandoraHelper.cxx.

◆ IsFinalState()

bool lar_pandora::LArPandoraHelper::IsFinalState	(	const PFParticleMap &	particleMap,
		const art::Ptr< recob::PFParticle >	daughterParticle
	)

static

Determine whether a particle has been reconstructed as a final-state particle.

Parameters

particleMap	the mapping between reconstructed particle and particle ID
daughterParticle	the input daughter particle

Returns: true/false

Definition at line 1382 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsNeutrino()

bool lar_pandora::LArPandoraHelper::IsNeutrino ( const art::Ptr< recob::PFParticle > particle )

static

Determine whether a particle has been reconstructed as a neutrino.

Parameters

particle the input particle

Returns: true/false

Definition at line 1405 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ IsShower()

bool lar_pandora::LArPandoraHelper::IsShower ( const art::Ptr< recob::PFParticle > particle )

static

Determine whether a particle has been reconstructed as shower-like.

Parameters

particle the input particle

Returns: true/false

Definition at line 1427 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ IsTrack()

bool lar_pandora::LArPandoraHelper::IsTrack ( const art::Ptr< recob::PFParticle > particle )

static

Determine whether a particle has been reconstructed as track-like.

Parameters

particle the input particle

Returns: true/false

Definition at line 1416 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ IsVisible()

bool lar_pandora::LArPandoraHelper::IsVisible ( const art::Ptr< simb::MCParticle > particle )

static

Determine whether a particle is visible (i.e. long-lived charged particle)

Parameters

particle the input mc particle

Returns: true/false

Definition at line 1437 of file LArPandoraHelper.cxx.

Here is the caller graph for this function:

◆ SelectFinalStatePFParticles()

void lar_pandora::LArPandoraHelper::SelectFinalStatePFParticles	(	const PFParticleVector &	inputParticles,
		PFParticleVector &	outputParticles
	)

static

Select final-state reconstructed particles from a list of all reconstructed particles.

Parameters

inputParticles	the input vector of all particles (it has to be all of them!)
outputParticles	the output vector of final-state particles

Definition at line 702 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

◆ SelectNeutrinoPFParticles()

void lar_pandora::LArPandoraHelper::SelectNeutrinoPFParticles	(	const PFParticleVector &	inputParticles,
		PFParticleVector &	outputParticles
	)

static

Select reconstructed neutrino particles from a list of all reconstructed particles.

Parameters

inputParticles	the input vector of all particles (it has to be all of them!)
outputParticles	the output vector of final-state particles

Definition at line 687 of file LArPandoraHelper.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

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

larpandora/larpandora/LArPandoraInterface/LArPandoraHelper.h
larpandora/larpandora/LArPandoraInterface/LArPandoraHelper.cxx

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ DaughterMode

Member Function Documentation

◆ BuildMCParticleHitMaps() [1/5]

◆ BuildMCParticleHitMaps() [2/5]

◆ BuildMCParticleHitMaps() [3/5]

◆ BuildMCParticleHitMaps() [4/5]

◆ BuildMCParticleHitMaps() [5/5]

◆ BuildMCParticleMap()

◆ BuildPFParticleHitMaps() [1/4]

◆ BuildPFParticleHitMaps() [2/4]

◆ BuildPFParticleHitMaps() [3/4]

◆ BuildPFParticleHitMaps() [4/4]

◆ BuildPFParticleMap()

◆ CollectClusters()

◆ CollectCosmicTags()

◆ CollectGeneratorMCParticles()

◆ CollectHits()

◆ CollectMCParticles() [1/2]

◆ CollectMCParticles() [2/2]

◆ CollectPFParticleMetadata()

◆ CollectPFParticles() [1/3]

◆ CollectPFParticles() [2/3]

◆ CollectPFParticles() [3/3]

◆ CollectSeeds() [1/2]

◆ CollectSeeds() [2/2]

◆ CollectShowers() [1/2]

◆ CollectShowers() [2/2]

◆ CollectSimChannels()

◆ CollectSpacePoints() [1/2]

◆ CollectSpacePoints() [2/2]

◆ CollectT0s()

◆ CollectTracks() [1/2]

◆ CollectTracks() [2/2]

◆ CollectVertices()

◆ CollectWires()

◆ GetAssociatedHits()

◆ GetFinalStateMCParticle()

◆ GetFinalStatePFParticle()

◆ GetGeneration()

◆ GetParentMCParticle()

◆ GetParentNeutrino()

◆ GetParentPFParticle()

◆ GetPFParticleMetadata()

◆ GetPrimaryTrack()

◆ IsFinalState()

◆ IsNeutrino()

◆ IsShower()

◆ IsTrack()

◆ IsVisible()

◆ SelectFinalStatePFParticles()

◆ SelectNeutrinoPFParticles()