Helper class for slice id tools. More...

#include "LArPandoraSliceIdHelper.h"

Classes
class	SliceMetadata
	Class to hold MC metdata about slices. More...

Public Types
typedef std::vector< SliceMetadata >	SliceMetadataVector

Static Public Member Functions
static void	GetSliceMetadata (const SliceVector &slices, const art::Event &evt, const std::string &truthLabel, const std::string &mcParticleLabel, const std::string &hitLabel, const std::string &backtrackLabel, const std::string &pandoraLabel, SliceMetadataVector &sliceMetadata, simb::MCNeutrino &mcNeutrino)
	Get MC metadata about each slice. More...

Private Types
typedef std::unordered_map< art::Ptr< recob::Hit >, bool >	HitToBoolMap

Static Private Member Functions
static art::Ptr< simb::MCTruth >	GetBeamNeutrinoMCTruth (const art::Event &evt, const std::string &truthLabel)
	Get the MCTruth block for the simulated beam neutrino. More...

static void	CollectNeutrinoMCParticles (const art::Event &evt, const std::string &truthLabel, const std::string &mcParticleLabel, const art::Ptr< simb::MCTruth > &beamNuMCTruth, MCParticleVector &mcParticles)
	Collect all MCParticles that come from the beam neutrino interaction. More...

static void	GetHitOrigins (const art::Event &evt, const std::string &hitLabel, const std::string &backtrackLabel, const MCParticleVector &mcParticles, HitVector &hits, HitToBoolMap &hitToIsNuInducedMap)
	For each hit in the event, determine if any of it's charge was deposited by a neutrino induced particle. More...

static unsigned int	CountNeutrinoHits (const HitVector &hits, const HitToBoolMap &hitToIsNuInducedMap)
	Count the number of hits in an input vector that are neutrino induced. More...

static void	GetPFParticleToHitsMap (const art::Event &evt, const std::string &pandoraLabel, PFParticlesToHits &pfParticleToHitsMap)
	Get the mapping from PFParticles to associated hits (via clusters) More...

static void	GetReconstructedHitsInSlice (const Slice &slice, const PFParticlesToHits &pfParticleToHitsMap, HitVector &hits)
	Collect the hits in the slice that have been added to a PFParticle (under either reconstruction hypothesis) More...

static void	CollectHits (const PFParticleVector &pfParticles, const PFParticlesToHits &pfParticleToHitsMap, HitVector &hits)
	Collect the hits in a given vector of PFParticles. More...

static void	GetSliceMetadata (const SliceVector &slices, const PFParticlesToHits &pfParticleToHitsMap, const HitToBoolMap &hitToIsNuInducedMap, const unsigned int nNuHits, SliceMetadataVector &sliceMetadata)
	Calculate the MC slice metadata. More...

Detailed Description

Helper class for slice id tools.

Definition at line 37 of file LArPandoraSliceIdHelper.h.

Member Typedef Documentation

typedef std::unordered_map<art::Ptr<recob::Hit>, bool> lar_pandora::LArPandoraSliceIdHelper::HitToBoolMap

private

Definition at line 83 of file LArPandoraSliceIdHelper.h.

typedef std::vector<SliceMetadata> lar_pandora::LArPandoraSliceIdHelper::SliceMetadataVector

Definition at line 55 of file LArPandoraSliceIdHelper.h.

Member Function Documentation

void lar_pandora::LArPandoraSliceIdHelper::CollectHits	(	const PFParticleVector &	pfParticles,
		const PFParticlesToHits &	pfParticleToHitsMap,
		HitVector &	hits
	)

staticprivate

Collect the hits in a given vector of PFParticles.

Parameters

pfParticles	the input vector of PFParticles
pfParticleToHitsMap	the input mapping from PFParticles to hits
hits	the output vector of hits

Definition at line 248 of file LArPandoraSliceIdHelper.cxx.

References part.

Referenced by GetReconstructedHitsInSlice().

   {
     for (const auto& part : pfParticles) {
       const auto it(pfParticleToHitsMap.find(part));
       if (it == pfParticleToHitsMap.end())
         throw cet::exception("LArPandora") << " LArPandoraSliceIdHelper::CollectHits - can't find "
                                               "any hits associated to input PFParticle"
                                            << std::endl;
 
       for (const auto& hit : it->second) {
         // ATTN here we ensure that we don't double count hits, even if the input PFParticles are from different Pandora instances
         if (std::find(hits.begin(), hits.end(), hit) == hits.end()) hits.push_back(hit);
       }
     }
   }

void lar_pandora::LArPandoraSliceIdHelper::CollectNeutrinoMCParticles	(	const art::Event &	evt,
		const std::string &	truthLabel,
		const std::string &	mcParticleLabel,
		const art::Ptr< simb::MCTruth > &	beamNuMCTruth,
		MCParticleVector &	mcParticles
	)

staticprivate

Collect all MCParticles that come from the beam neutrino interaction.

Parameters

evt	the art event
truthLabel	the label of the MCTruth producer
mcParticleLabel	the label of the MCParticle producer
beamNuMCTruth	the MCTruth block for the beam neutrino
mcParticles	the output vector of neutrino induced MCParticles

Definition at line 99 of file LArPandoraSliceIdHelper.cxx.

References art::ProductRetriever::getByLabel(), and art::Handle< T >::isValid().

Referenced by GetSliceMetadata().

   {
     // Get the MCTruth handle
     art::Handle<std::vector<simb::MCTruth>> mcTruthHandle;
     evt.getByLabel(truthLabel, mcTruthHandle);
 
     if (!mcTruthHandle.isValid())
       throw cet::exception("LArPandora")
         << " LArPandoraSliceIdHelper::CollectNeutrinoMCParticles - invalid MCTruth handle"
         << std::endl;
 
     // Find MCParticles that are associated to the beam neutrino MCTruth block
     art::FindManyP<simb::MCParticle> truthToMCParticleAssns(mcTruthHandle, evt, mcParticleLabel);
     mcParticles = truthToMCParticleAssns.at(
       beamNuMCTruth
         .key()); // ATTN will throw if association from beamNuMCTruth doesn't exist. We want this!
   }

unsigned int lar_pandora::LArPandoraSliceIdHelper::CountNeutrinoHits	(	const HitVector &	hits,
		const HitToBoolMap &	hitToIsNuInducedMap
	)

staticprivate

Count the number of hits in an input vector that are neutrino induced.

Parameters

hits	the input vector of hits
hitToIsNuInducedMap	the mapping from hits to isNuInduced boolean

Returns: the number of hits that are neutrino induced

Definition at line 166 of file LArPandoraSliceIdHelper.cxx.

Referenced by GetSliceMetadata().

   {
     unsigned int nNuHits(0);
     for (const auto& hit : hits) {
       const auto it(hitToIsNuInducedMap.find(hit));
 
       if (it == hitToIsNuInducedMap.end())
         throw cet::exception("LArPandora")
           << " LArPandoraSliceIdHelper::CountNeutrinoHits - can't find hit in hitToIsNuInducedMap"
           << std::endl;
 
       nNuHits += it->second ? 1 : 0;
     }
 
     return nNuHits;
   }

art::Ptr< simb::MCTruth > lar_pandora::LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth	(	const art::Event &	evt,
		const std::string &	truthLabel
	)

staticprivate

Get the MCTruth block for the simulated beam neutrino.

Parameters

evt	the art event
truthLabel	the label of the MCTruth producer

Returns: the MCTruth block for the simulated beam neutrino

Definition at line 59 of file LArPandoraSliceIdHelper.cxx.

References simb::MCParticle::E(), art::ProductRetriever::getByLabel(), simb::MCTruth::GetNeutrino(), art::Handle< T >::isValid(), simb::kBeamNeutrino, simb::MCNeutrino::Nu(), and simb::MCTruth::Origin().

Referenced by GetSliceMetadata().

   {
     // Get the MCTruth handle
     art::Handle<std::vector<simb::MCTruth>> mcTruthHandle;
     evt.getByLabel(truthLabel, mcTruthHandle);
 
     if (!mcTruthHandle.isValid())
       throw cet::exception("LArPandora")
         << " LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth - invalid MCTruth handle" << std::endl;
 
     // Look for the truth block that is from the beam neutrino, and ensure we choose the one with the highest energy if there are multiple
     bool foundNeutrino(false);
     float maxNeutrinoEnergy(-std::numeric_limits<float>::max());
     art::Ptr<simb::MCTruth> beamNuMCTruth;
     for (unsigned int i = 0; i < mcTruthHandle->size(); ++i) {
       const art::Ptr<simb::MCTruth> mcTruth(mcTruthHandle, i);
 
       if (mcTruth->Origin() != simb::kBeamNeutrino) continue;
 
       const float nuEnergy(mcTruth->GetNeutrino().Nu().E());
       if (nuEnergy < maxNeutrinoEnergy) continue;
 
       // Select this as the beam neutrino
       maxNeutrinoEnergy = nuEnergy;
       beamNuMCTruth = mcTruth;
       foundNeutrino = true;
     }
 
     if (!foundNeutrino)
       throw cet::exception("LArPandora") << " LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth - "
                                             "found no beam neutrino MCTruth blocks"
                                          << std::endl;
 
     return beamNuMCTruth;
   }

void lar_pandora::LArPandoraSliceIdHelper::GetHitOrigins	(	const art::Event &	evt,
		const std::string &	hitLabel,
		const std::string &	backtrackLabel,
		const MCParticleVector &	mcParticles,
		HitVector &	hits,
		HitToBoolMap &	hitToIsNuInducedMap
	)

staticprivate

For each hit in the event, determine if any of it's charge was deposited by a neutrino induced particle.

Parameters

evt	the art event
hitLabel	the label of the Hit producer
backtrackLabel	the label of the Hit->MCParticle association producer - backtracker
mcParticles	the input vector of neutrino induced MCParticles
hits	the output vector of all hits
hitToIsNuInducedMap	the output mapping from hits to a bool = true if hit is neutrino induced

Definition at line 124 of file LArPandoraSliceIdHelper.cxx.

References art::ProductRetriever::getByLabel(), art::Handle< T >::isValid(), art::Ptr< T >::key(), and part.

Referenced by GetSliceMetadata().

   {
     // Collect the hits from the event
     art::Handle<std::vector<recob::Hit>> hitHandle;
     evt.getByLabel(hitLabel, hitHandle);
 
     if (!hitHandle.isValid())
       throw cet::exception("LArPandora")
         << " LArPandoraSliceIdHelper::GetHitOrigins - invalid hit handle" << std::endl;
 
     art::FindManyP<simb::MCParticle> hitToMCParticleAssns(hitHandle, evt, backtrackLabel);
 
     // Find the hits that are associated to a neutrino induced MCParticle using the Hit->MCParticle associations form the backtracker
     for (unsigned int i = 0; i < hitHandle->size(); ++i) {
       const art::Ptr<recob::Hit> hit(hitHandle, i);
       hits.push_back(hit);
 
       const auto& particles(hitToMCParticleAssns.at(hit.key()));
 
       bool foundNuParticle(false);
       for (const auto& part : particles) {
         // If the MCParticles isn't in the list of neutrino particles
         if (std::find(mcParticles.begin(), mcParticles.end(), part) == mcParticles.end()) continue;
 
         foundNuParticle = true;
         break;
       }
 
       if (!hitToIsNuInducedMap.emplace(hit, foundNuParticle).second)
         throw cet::exception("LArPandora")
           << " LArPandoraSliceIdHelper::GetHitOrigins - repeated hits in input collection"
           << std::endl;
     }
   }

void lar_pandora::LArPandoraSliceIdHelper::GetPFParticleToHitsMap	(	const art::Event &	evt,
		const std::string &	pandoraLabel,
		PFParticlesToHits &	pfParticleToHitsMap
	)

staticprivate

Get the mapping from PFParticles to associated hits (via clusters)

Parameters

evt	the art event
pandoraLabel	the label of the PFParticle <-> Cluster and Cluster <-> Hit associations - Pandora pattern recognition
pfParticleToHitsMap	the output mapping from PFParticles to associated hits

Definition at line 186 of file LArPandoraSliceIdHelper.cxx.

References art::ProductRetriever::getByLabel(), hits(), art::Handle< T >::isValid(), art::Ptr< T >::key(), and part.

Referenced by GetSliceMetadata().

   {
     // Get the PFParticles
     art::Handle<std::vector<recob::PFParticle>> pfParticleHandle;
     evt.getByLabel(pandoraLabel, pfParticleHandle);
 
     if (!pfParticleHandle.isValid())
       throw cet::exception("LArPandora")
         << " LArPandoraSliceIdHelper::GetPFParticleToHitsMap - invalid PFParticle handle"
         << std::endl;
 
     // Get the Clusters
     art::Handle<std::vector<recob::Cluster>> clusterHandle;
     evt.getByLabel(pandoraLabel, clusterHandle);
 
     if (!clusterHandle.isValid())
       throw cet::exception("LArPandora")
         << " LArPandoraSliceIdHelper::GetPFParticleToHitsMap - invalid cluster handle" << std::endl;
 
     // Get the associations between PFParticles -> Clusters -> Hits
     art::FindManyP<recob::Cluster> pfParticleToClusterAssns(pfParticleHandle, evt, pandoraLabel);
     art::FindManyP<recob::Hit> clusterToHitAssns(clusterHandle, evt, pandoraLabel);
 
     // Get the hits associated to each PFParticles
     for (unsigned int iPart = 0; iPart < pfParticleHandle->size(); ++iPart) {
       const art::Ptr<recob::PFParticle> part(pfParticleHandle, iPart);
       HitVector hits;
 
       for (const auto& cluster : pfParticleToClusterAssns.at(part.key())) {
         for (const auto& hit : clusterToHitAssns.at(cluster.key())) {
           if (std::find(hits.begin(), hits.end(), hit) != hits.end())
             throw cet::exception("LArPandora")
               << " LArPandoraSliceIdHelper::GetPFParticleToHitsMap - double counted hits!"
               << std::endl;
 
           hits.push_back(hit);
         }
       }
 
       if (!pfParticleToHitsMap.emplace(part, hits).second)
         throw cet::exception("LArPandora")
           << " LArPandoraSliceIdHelper::GetPFParticleToHitsMap - repeated input PFParticles"
           << std::endl;
     }
   }

void lar_pandora::LArPandoraSliceIdHelper::GetReconstructedHitsInSlice	(	const Slice &	slice,
		const PFParticlesToHits &	pfParticleToHitsMap,
		HitVector &	hits
	)

staticprivate

Collect the hits in the slice that have been added to a PFParticle (under either reconstruction hypothesis)

Parameters

slice	the input slice
pfParticleToHitsMap	the input mapping from PFParticles to hits
hits	the output vector of reconstructed hits in the slice

Definition at line 236 of file LArPandoraSliceIdHelper.cxx.

References CollectHits(), lar_pandora::Slice::GetCosmicRayHypothesis(), lar_pandora::Slice::GetTargetHypothesis(), and hits().

Referenced by GetSliceMetadata().

   {
     // ATTN here we use the PFParticles from both hypotheses to collect the hits. Hits will not be double counted
     LArPandoraSliceIdHelper::CollectHits(slice.GetTargetHypothesis(), pfParticleToHitsMap, hits);
     LArPandoraSliceIdHelper::CollectHits(slice.GetCosmicRayHypothesis(), pfParticleToHitsMap, hits);
   }

void lar_pandora::LArPandoraSliceIdHelper::GetSliceMetadata	(	const SliceVector &	slices,
		const art::Event &	evt,
		const std::string &	truthLabel,
		const std::string &	mcParticleLabel,
		const std::string &	hitLabel,
		const std::string &	backtrackLabel,
		const std::string &	pandoraLabel,
		SliceMetadataVector &	sliceMetadata,
		simb::MCNeutrino &	mcNeutrino
	)

static

Get MC metadata about each slice.

Parameters

slices	the input vector of slices
evt	the art event
truthLabel	the label of the MCTruth producer
mcParticleLabel	the label of the MCParticle producer
hitLabel	the label of the Hit producer
backtrackLabel	the label of the Hit -> MCParticle association producer
pandoraLabel	the label of the Pandora all outcomes producer
sliceMetadata	the output vector of slice metadata (mapping 1:1 to the slices)
interactionType	the output true interaction type code of the MCNeutrino
nuEnergy	the output true energy of the neutrino
nuNeutrino	the mc neutrino from the beam neutrino MCTruth block

Definition at line 21 of file LArPandoraSliceIdHelper.cxx.

References CollectNeutrinoMCParticles(), CountNeutrinoHits(), GetBeamNeutrinoMCTruth(), GetHitOrigins(), GetPFParticleToHitsMap(), and hits().

   {
     // Find the beam neutrino in MC
     const auto beamNuMCTruth(LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth(evt, truthLabel));
     mcNeutrino = beamNuMCTruth->GetNeutrino();
 
     // Collect all MC particles resulting from the beam neutrino
     MCParticleVector mcParticles;
     LArPandoraSliceIdHelper::CollectNeutrinoMCParticles(
       evt, truthLabel, mcParticleLabel, beamNuMCTruth, mcParticles);
 
     // Get the hits and determine which are neutrino induced
     HitVector hits;
     HitToBoolMap hitToIsNuInducedMap;
     LArPandoraSliceIdHelper::GetHitOrigins(
       evt, hitLabel, backtrackLabel, mcParticles, hits, hitToIsNuInducedMap);
     const unsigned int nNuHits(
       LArPandoraSliceIdHelper::CountNeutrinoHits(hits, hitToIsNuInducedMap));
 
     // Get the mapping from PFParticle to hits through clusters
     PFParticlesToHits pfParticleToHitsMap;
     LArPandoraSliceIdHelper::GetPFParticleToHitsMap(evt, pandoraLabel, pfParticleToHitsMap);
 
     // Calculate the metadata for each slice
     LArPandoraSliceIdHelper::GetSliceMetadata(
       slices, pfParticleToHitsMap, hitToIsNuInducedMap, nNuHits, sliceMetadata);
   }

void lar_pandora::LArPandoraSliceIdHelper::GetSliceMetadata	(	const SliceVector &	slices,
		const PFParticlesToHits &	pfParticleToHitsMap,
		const HitToBoolMap &	hitToIsNuInducedMap,
		const unsigned int	nNuHits,
		SliceMetadataVector &	sliceMetadata
	)

staticprivate

Calculate the MC slice metadata.

Parameters

slices	the input vector of slices
pfParticleToHitsMap	the input mapping from PFParticles to hits
hitToIsNuInducedMap	the input mapping from hits to isNuInduced boolean
nNuHits	the total number of neutrino induced hits in the event
sliceMetadata	the output vector of metadata objects correspoinding 1:1 to the input slices

Definition at line 268 of file LArPandoraSliceIdHelper.cxx.

References CountNeutrinoHits(), f, GetReconstructedHitsInSlice(), hits(), lar_pandora::LArPandoraSliceIdHelper::SliceMetadata::m_completeness, lar_pandora::LArPandoraSliceIdHelper::SliceMetadata::m_isMostComplete, lar_pandora::LArPandoraSliceIdHelper::SliceMetadata::m_nHits, and lar_pandora::LArPandoraSliceIdHelper::SliceMetadata::m_purity.

   {
     if (!sliceMetadata.empty())
       throw cet::exception("LArPandora")
         << " LArPandoraSliceIdHelper::GetSliceMetadata - non empty input metadata vector"
         << std::endl;
 
     if (slices.empty()) return;
 
     unsigned int mostCompleteSliceIndex(0);
     unsigned int maxNuHits(0);
 
     for (unsigned int sliceIndex = 0; sliceIndex < slices.size(); ++sliceIndex) {
       const Slice& slice(slices.at(sliceIndex));
       HitVector hits;
       LArPandoraSliceIdHelper::GetReconstructedHitsInSlice(slice, pfParticleToHitsMap, hits);
 
       const unsigned int nHitsInSlice(hits.size());
       const unsigned int nNuHitsInSlice(
         LArPandoraSliceIdHelper::CountNeutrinoHits(hits, hitToIsNuInducedMap));
 
       if (nNuHitsInSlice > maxNuHits) {
         mostCompleteSliceIndex = sliceIndex;
         maxNuHits = nNuHitsInSlice;
       }
 
       SliceMetadata metadata;
       metadata.m_nHits = nHitsInSlice;
       metadata.m_purity = ((nHitsInSlice == 0) ?
                              -1.f :
                              static_cast<float>(nNuHitsInSlice) / static_cast<float>(nHitsInSlice));
       metadata.m_completeness =
         ((nNuHits == 0) ? -1.f : static_cast<float>(nNuHitsInSlice) / static_cast<float>(nNuHits));
       metadata.m_isMostComplete = false;
 
       sliceMetadata.push_back(metadata);
     }
 
     sliceMetadata.at(mostCompleteSliceIndex).m_isMostComplete = true;
   }

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

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

Classes

Public Types

Static Public Member Functions

Private Types

Static Private Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation