ConsolidatedPFParticleAnalysisTemplate class. More...

Inheritance diagram for lar_pandora::ConsolidatedPFParticleAnalysisTemplate:

Public Types
typedef art::Handle< std::vector< recob::PFParticle > >	PFParticleHandle

typedef std::map< size_t, art::Ptr< recob::PFParticle > >	PFParticleIdMap

typedef std::vector< art::Ptr< recob::PFParticle > >	PFParticleVector

typedef std::vector< art::Ptr< recob::Track > >	TrackVector

typedef std::vector< art::Ptr< recob::Shower > >	ShowerVector

Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	ConsolidatedPFParticleAnalysisTemplate (fhicl::ParameterSet const &pset)
	Constructor. More...

void	reconfigure (fhicl::ParameterSet const &pset)
	Configure memeber variables using FHiCL parameters. More...

void	analyze (const art::Event &evt)
	Analyze an event! More...

Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDAnalyzer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept

	Analyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	Analyzer (Table< Config > const &config)

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Observer
	~Observer () noexcept

	Observer (Observer const &)=delete

	Observer (Observer &&)=delete

Observer &	operator= (Observer const &)=delete

Observer &	operator= (Observer &&)=delete

void	registerProducts (ProductDescriptions &, ModuleDescription const &)

void	fillDescriptions (ModuleDescription const &)

fhicl::ParameterSetID	selectorConfig () const

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
void	GetPFParticleIdMap (const PFParticleHandle &pfParticleHandle, PFParticleIdMap &pfParticleMap)
	Produce a mapping from PFParticle ID to the art ptr to the PFParticle itself for fast navigation. More...

void	PrintOutScores (const art::Event &evt, const PFParticleHandle &pfParticleHandle) const
	Print out scores in PFParticleMetadata. More...

void	GetFinalStatePFParticleVectors (const PFParticleIdMap &pfParticleMap, PFParticleVector &crParticles, PFParticleVector &nuParticles)
	Produce a mapping from PFParticle ID to the art ptr to the PFParticle itself for fast navigation. More...

void	CollectTracksAndShowers (const PFParticleVector &particles, const PFParticleHandle &pfParticleHandle, const art::Event &evt, TrackVector &tracks, ShowerVector &showers)
	Collect associated tracks and showers to particles in an input particle vector. More...

Private Attributes
std::string	m_pandoraLabel
	The label for the pandora producer. More...

std::string	m_trackLabel
	The label for the track producer from PFParticles. More...

std::string	m_showerLabel
	The label for the shower producer from PFParticles. More...

bool	m_printOutScores
	Option to investigate the associations to scores for PFParticles. More...

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

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

	Observer (fhicl::ParameterSet const &config)

	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

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

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

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

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

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

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

Detailed Description

ConsolidatedPFParticleAnalysisTemplate class.

Definition at line 24 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

Member Typedef Documentation

typedef art::Handle< std::vector<recob::PFParticle> > lar_pandora::ConsolidatedPFParticleAnalysisTemplate::PFParticleHandle

Definition at line 27 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

typedef std::map< size_t, art::Ptr<recob::PFParticle> > lar_pandora::ConsolidatedPFParticleAnalysisTemplate::PFParticleIdMap

Definition at line 28 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

typedef std::vector< art::Ptr<recob::PFParticle> > lar_pandora::ConsolidatedPFParticleAnalysisTemplate::PFParticleVector

Definition at line 29 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

typedef std::vector< art::Ptr<recob::Shower> > lar_pandora::ConsolidatedPFParticleAnalysisTemplate::ShowerVector

Definition at line 31 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

typedef std::vector< art::Ptr<recob::Track> > lar_pandora::ConsolidatedPFParticleAnalysisTemplate::TrackVector

Definition at line 30 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

Constructor & Destructor Documentation

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

Constructor.

Parameters

pset	the set of input fhicl parameters

Definition at line 122 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

                                                                                                             : art::EDAnalyzer(pset)
 {
     this->reconfigure(pset);
 }

Member Function Documentation

void lar_pandora::ConsolidatedPFParticleAnalysisTemplate::analyze ( const art::Event & evt )

Analyze an event!

Parameters

evt	the art event to analyze

Investigate scores associated as larpandoraobject::metadata for the PFParticles

Definition at line 139 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

 {
     // Collect the PFParticles from the event
     PFParticleHandle pfParticleHandle;
     evt.getByLabel(m_pandoraLabel, pfParticleHandle);
 
     if (!pfParticleHandle.isValid())
     {
         mf::LogDebug("ConsolidatedPFParticleAnalysisTemplate") << "  Failed to find the PFParticles." << std::endl;
         return;
     }
 
     // Produce a map of the PFParticle IDs for fast navigation through the hierarchy
     PFParticleIdMap pfParticleMap;
     this->GetPFParticleIdMap(pfParticleHandle, pfParticleMap);
 
     /// Investigate scores associated as larpandoraobject::metadata for the PFParticles
     if (m_printOutScores)
         this->PrintOutScores(evt, pfParticleHandle);
 
     // Produce two PFParticle vectors containing final-state particles:
     // 1. Particles identified as cosmic-rays - recontructed under cosmic-hypothesis
     // 2. Daughters of the neutrino PFParticle - reconstructed under the neutrino hypothesis
     std::vector< art::Ptr<recob::PFParticle> > crParticles;
     std::vector< art::Ptr<recob::PFParticle> > nuParticles;
     this->GetFinalStatePFParticleVectors(pfParticleMap, crParticles, nuParticles);
 
     // Use as required!
     // -----------------------------
     //   What follows is an example showing how one might access the reconstructed neutrino final-state tracks and showers
 
     // These are the vectors to hold the tracks and showers for the final-states of the reconstructed neutrino
     std::vector< art::Ptr<recob::Track> > tracks;
     std::vector< art::Ptr<recob::Shower> > showers;
     this->CollectTracksAndShowers(nuParticles, pfParticleHandle, evt, tracks, showers);
 
     // Print a summary of the consolidated event
     std::cout << "Consolidated event summary:" << std::endl;
     std::cout << "  - Number of primary cosmic-ray PFParticles   : " << crParticles.size() << std::endl;
     std::cout << "  - Number of neutrino final-state PFParticles : " << nuParticles.size() << std::endl;
     std::cout << "    ... of which are track-like   : " << tracks.size() << std::endl;
     std::cout << "    ... of which are showers-like : " << showers.size() << std::endl;
 }

void lar_pandora::ConsolidatedPFParticleAnalysisTemplate::CollectTracksAndShowers	(	const PFParticleVector &	particles,
		const PFParticleHandle &	pfParticleHandle,
		const art::Event &	evt,
		TrackVector &	tracks,
		ShowerVector &	showers
	)

private

Collect associated tracks and showers to particles in an input particle vector.

Parameters

particles	a vector holding PFParticles from which to find the associated tracks and showers
pfParticleHandle	the handle for the PFParticle collection
evt	the art event to analyze
tracks	a vector to hold the associated tracks
showers	a vector to hold the associated showers

Definition at line 265 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

 {
     // Get the associations between PFParticles and tracks/showers from the event
     art::FindManyP< recob::Track > pfPartToTrackAssoc(pfParticleHandle, evt, m_trackLabel);
     art::FindManyP< recob::Shower > pfPartToShowerAssoc(pfParticleHandle, evt, m_showerLabel);
 
     for (const art::Ptr<recob::PFParticle> &pParticle : particles)
     {
         const std::vector< art::Ptr<recob::Track> > associatedTracks(pfPartToTrackAssoc.at(pParticle.key()));
         const std::vector< art::Ptr<recob::Shower> > associatedShowers(pfPartToShowerAssoc.at(pParticle.key()));
         const unsigned int nTracks(associatedTracks.size());
         const unsigned int nShowers(associatedShowers.size());
 
         // Check if the PFParticle has no associated tracks or showers
         if (nTracks == 0 && nShowers == 0)
         {
             mf::LogDebug("ConsolidatedPFParticleAnalysisTemplate") << "  No tracks or showers were associated to PFParticle " << pParticle->Self() << std::endl;
             continue;
         }
 
         // Check if there is an associated track
         if (nTracks == 1 && nShowers == 0)
         {
             tracks.push_back(associatedTracks.front());
             continue;
         }
 
         // Check if there is an associated shower
         if (nTracks == 0 && nShowers == 1)
         {
             showers.push_back(associatedShowers.front());
             continue;
         }
 
         throw cet::exception("ConsolidatedPFParticleAnalysisTemplate") << "  There were " << nTracks << " tracks and " << nShowers << " showers associated with PFParticle " << pParticle->Self();
     }
 }

void lar_pandora::ConsolidatedPFParticleAnalysisTemplate::GetFinalStatePFParticleVectors	(	const PFParticleIdMap &	pfParticleMap,
		PFParticleVector &	crParticles,
		PFParticleVector &	nuParticles
	)

private

Produce a mapping from PFParticle ID to the art ptr to the PFParticle itself for fast navigation.

Parameters

pfParticleMap	the mapping from ID to PFParticle
crParticles	a vector to hold the top-level PFParticles reconstructed under the cosmic hypothesis
nuParticles	a vector to hold the final-states of the reconstruced neutrino

Definition at line 225 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

 {
     for (PFParticleIdMap::const_iterator it = pfParticleMap.begin(); it != pfParticleMap.end(); ++it)
     {
         const art::Ptr<recob::PFParticle> pParticle(it->second);
 
         // Only look for primary particles
         if (!pParticle->IsPrimary()) continue;
 
         // Check if this particle is identified as the neutrino
         const int pdg(pParticle->PdgCode());
         const bool isNeutrino(std::abs(pdg) == pandora::NU_E || std::abs(pdg) == pandora::NU_MU || std::abs(pdg) == pandora::NU_TAU);
 
         // All non-neutrino primary particles are reconstructed under the cosmic hypothesis
         if (!isNeutrino)
         {
             crParticles.push_back(pParticle);
             continue;
         }
 
         // ATTN. We are filling nuParticles under the assumption that there is only one reconstructed neutrino identified per event.
         //       If this is not the case please handle accordingly
         if (!nuParticles.empty())
         {
             throw cet::exception("ConsolidatedPFParticleAnalysisTemplate") << "  This event contains multiple reconstructed neutrinos!";
         }
 
         // Add the daughters of the neutrino PFParticle to the nuPFParticles vector
         for (const size_t daughterId : pParticle->Daughters())
         {
             if (pfParticleMap.find(daughterId) == pfParticleMap.end())
                 throw cet::exception("ConsolidatedPFParticleAnalysisTemplate") << "  Invalid PFParticle collection!";
 
             nuParticles.push_back(pfParticleMap.at(daughterId));
         }
     }
 }

void lar_pandora::ConsolidatedPFParticleAnalysisTemplate::GetPFParticleIdMap	(	const PFParticleHandle &	pfParticleHandle,
		PFParticleIdMap &	pfParticleMap
	)

private

Produce a mapping from PFParticle ID to the art ptr to the PFParticle itself for fast navigation.

Parameters

pfParticleHandle	the handle for the PFParticle collection
pfParticleMap	the mapping from ID to PFParticle

Definition at line 185 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

 {
     for (unsigned int i = 0; i < pfParticleHandle->size(); ++i)
     {
         const art::Ptr<recob::PFParticle> pParticle(pfParticleHandle, i);
         if (!pfParticleMap.insert(PFParticleIdMap::value_type(pParticle->Self(), pParticle)).second)
         {
             throw cet::exception("ConsolidatedPFParticleAnalysisTemplate") << "  Unable to get PFParticle ID map, the input PFParticle collection has repeat IDs!";
         }
     }
 }

void lar_pandora::ConsolidatedPFParticleAnalysisTemplate::PrintOutScores	(	const art::Event &	evt,
		const PFParticleHandle &	pfParticleHandle
	)		const

private

Print out scores in PFParticleMetadata.

Parameters

evt	the art event to analyze
pfParticleHandle	the handle for the PFParticle collection

Definition at line 199 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

 {
     // Get the associations between PFParticles and larpandoraobj::PFParticleMetadata
     art::FindManyP< larpandoraobj::PFParticleMetadata > pfPartToMetadataAssoc(pfParticleHandle, evt, m_pandoraLabel);
 
     for (unsigned int i = 0; i < pfParticleHandle->size(); ++i)
     {
         const std::vector< art::Ptr<larpandoraobj::PFParticleMetadata> > &pfParticleMetadataList(pfPartToMetadataAssoc.at(i));
         if (!pfParticleMetadataList.empty())
         {
             const art::Ptr<recob::PFParticle> pParticle(pfParticleHandle, i);
             for (unsigned int j=0; j<pfParticleMetadataList.size(); ++j)
             {
                 const art::Ptr<larpandoraobj::PFParticleMetadata> &pfParticleMetadata(pfParticleMetadataList.at(j));
                 const larpandoraobj::PFParticleMetadata::PropertiesMap &pfParticlePropertiesMap(pfParticleMetadata->GetPropertiesMap());
                 if (!pfParticlePropertiesMap.empty())
                     std::cout << " Found PFParticle " << pParticle->Self() << " with: " << std::endl;
                 for (larpandoraobj::PFParticleMetadata::PropertiesMap::const_iterator it = pfParticlePropertiesMap.begin(); it != pfParticlePropertiesMap.end(); ++it)
                     std::cout << "  - " << it->first << " = " << it->second << std::endl;
             }
         }
     }
 }

void lar_pandora::ConsolidatedPFParticleAnalysisTemplate::reconfigure ( fhicl::ParameterSet const & pset )

Configure memeber variables using FHiCL parameters.

Parameters

pset	the set of input fhicl parameters

Definition at line 129 of file ConsolidatedPFParticleAnalysisTemplate_module.cc.

 {
     m_pandoraLabel = pset.get<std::string>("PandoraLabel");
     m_trackLabel = pset.get<std::string>("TrackLabel");
     m_showerLabel = pset.get<std::string>("ShowerLabel");
     m_printOutScores = pset.get<bool>("PrintOutScores",true);
 }