RecoHierarchy class. More...

#include "LArHierarchyHelper.h"

Classes
class	Node
	Node class. More...

Public Types
typedef std::vector< const Node * >	NodeVector

typedef std::list< const Node * >	NodeList

typedef std::map< const pandora::ParticleFlowObject *, NodeVector >	RecoNodeVectorMap

Public Member Functions
	RecoHierarchy ()
	Default constructor. More...

virtual	~RecoHierarchy ()
	Destructor. More...

void	FillHierarchy (const pandora::PfoList &pfoList, const FoldingParameters &foldParameters)
	Creates a reconstructed hierarchy representation. Without folding this will be a mirror image of the standard ParticleFlowObject (PFO) relationships. However, with folding options selected the hierarchy structure will group together PFOs into nodes based on the folding requirements. More...

const NodeVector &	GetInteractions (const pandora::ParticleFlowObject *pRoot) const
	Retrieve the root nodes in the hierarchy for a given interaction. More...

void	GetRootPfos (pandora::PfoList &rootPfos) const
	Retrieve the root particle flow objects of the interaction hierarchies. More...

void	GetFlattenedNodes (const pandora::ParticleFlowObject *const pRoot, NodeVector &nodeVector) const
	Retrieve a flat vector of the nodes in the hierarchy. More...

const pandora::ParticleFlowObject *	GetNeutrino () const
	Retrieve the neutrino at the root of the hierarchy if it exists. More...

const std::string	ToString () const
	Produce a string representation of the hierarchy. More...

Private Attributes
RecoNodeVectorMap	m_interactions
	Map from the root PFO (e.g. neutrino) to primaries. More...

Detailed Description

RecoHierarchy class.

Definition at line 422 of file LArHierarchyHelper.h.

Member Typedef Documentation

typedef std::list<const Node *> lar_content::LArHierarchyHelper::RecoHierarchy::NodeList

Definition at line 427 of file LArHierarchyHelper.h.

typedef std::vector<const Node *> lar_content::LArHierarchyHelper::RecoHierarchy::NodeVector

Definition at line 425 of file LArHierarchyHelper.h.

typedef std::map<const pandora::ParticleFlowObject *, NodeVector> lar_content::LArHierarchyHelper::RecoHierarchy::RecoNodeVectorMap

Definition at line 428 of file LArHierarchyHelper.h.

Constructor & Destructor Documentation

lar_content::LArHierarchyHelper::RecoHierarchy::RecoHierarchy ( )

Default constructor.

Definition at line 811 of file LArHierarchyHelper.cc.

812 {

813 }

lar_content::LArHierarchyHelper::RecoHierarchy::~RecoHierarchy ( )

virtual

Destructor.

Definition at line 817 of file LArHierarchyHelper.cc.

References lar_content::LArHierarchyHelper::MCHierarchy::m_interactions.

 {
     for (const auto &[pRoot, nodeVector] : m_interactions)
     {
         for (const Node *pNode : nodeVector)
             delete pNode;
     }
     m_interactions.clear();
 }

Member Function Documentation

void lar_content::LArHierarchyHelper::RecoHierarchy::FillHierarchy	(	const pandora::PfoList &	pfoList,
		const FoldingParameters &	foldParameters
	)

Creates a reconstructed hierarchy representation. Without folding this will be a mirror image of the standard ParticleFlowObject (PFO) relationships. However, with folding options selected the hierarchy structure will group together PFOs into nodes based on the folding requirements.

If only folding back to primaries, the hierarchy will be relatively flat, with a top-level neutrino or test beam particle, if appropriate, and then a set of leaf nodes, one for each primary particles also containing the PFOs (and corresponding hits) from daughter particles.

If only folding back to leading shower particles, the hierarchy will largely mirror the standard PFO hierarchy, but, when a shower particle is reached (based on the track/shower characterisation), this particle and all daughter particles will be represented by a single leaf node.

If folding back to both primary and leading shower particles the hierarchy will again be rather flat, but in this case, if a primary track-like particle has a downstream shower particle then all downstream particles above the shower-like particle will be folded into the primary node, but a new, daughter leaf node will be created for the shower-like particle and all of its daughters, and a parent-child relationship will be formed between the primary node and shower node.

Parameters

pfoList	The list of PFOs with which to fill the hierarchy
foldParameters	The folding parameters to use for the hierarchy

Definition at line 829 of file LArHierarchyHelper.cc.

References util::abs(), lar_content::LArPfoHelper::GetAllCaloHits(), lar_content::LArPfoHelper::GetAllDownstreamPfos(), lar_content::LArHierarchyHelper::GetRecoPrimaries(), lar_content::LArHierarchyHelper::FoldingParameters::m_foldToLeadingShowers, lar_content::LArHierarchyHelper::FoldingParameters::m_foldToTier, lar_content::LArHierarchyHelper::MCHierarchy::m_interactions, lar_content::LArHierarchyHelper::FoldingParameters::m_tier, and lar_content::LArPfoHelper::SortByNHits().

Referenced by lar_content::LArHierarchyHelper::FillRecoHierarchy().

 {
     PfoList rootNodes;
     for (const ParticleFlowObject *pPfo : pfoList)
     {
         const PfoList &parentList{pPfo->GetParentPfoList()};
         if (parentList.empty())
         {
             rootNodes.emplace_back(pPfo);
         }
     }
 
     for (const ParticleFlowObject *const pRoot : rootNodes)
     {
         PfoSet primarySet;
         LArHierarchyHelper::GetRecoPrimaries(pRoot, primarySet);
         PfoList primaries(primarySet.begin(), primarySet.end());
         primaries.sort(LArPfoHelper::SortByNHits);
         if (foldParameters.m_foldToTier && foldParameters.m_tier == 1)
         {
             for (const ParticleFlowObject *pPrimary : primaries)
             {
                 PfoList allParticles;
                 // ATTN - pPrimary gets added to the list of downstream PFOs, not just the child PFOs
                 LArPfoHelper::GetAllDownstreamPfos(pPrimary, allParticles);
                 CaloHitList allHits;
                 for (const ParticleFlowObject *pPfo : allParticles)
                     LArPfoHelper::GetAllCaloHits(pPfo, allHits);
                 m_interactions[pRoot].emplace_back(new Node(*this, allParticles, allHits));
             }
         }
         else if (foldParameters.m_foldToLeadingShowers)
         {
             for (const ParticleFlowObject *pPrimary : primaries)
             {
                 PfoList allParticles;
                 int pdg{std::abs(pPrimary->GetParticleId())};
                 const bool isShower{pdg == E_MINUS};
                 // ATTN - pPrimary gets added to the list of downstream PFOs, not just the child PFOs
                 if (isShower)
                     LArPfoHelper::GetAllDownstreamPfos(pPrimary, allParticles);
                 else
                     allParticles.emplace_back(pPrimary);
 
                 CaloHitList allHits;
                 for (const ParticleFlowObject *pPfo : allParticles)
                     LArPfoHelper::GetAllCaloHits(pPfo, allHits);
                 Node *pNode{new Node(*this, allParticles, allHits)};
                 m_interactions[pRoot].emplace_back(pNode);
                 if (!isShower)
                 {
                     // Find the children of this particle and recursively add them to the hierarchy
                     const PfoList &children{pPrimary->GetDaughterPfoList()};
                     for (const ParticleFlowObject *pChild : children)
                         pNode->FillHierarchy(pChild, foldParameters);
                 }
             }
         }
         else
         {
             // Dynamic fold, Unfolded and fold to tier > 1 have the same behaviour for primaries
             for (const ParticleFlowObject *pPrimary : primaries)
             {
                 PfoList allParticles{pPrimary};
                 CaloHitList allHits;
                 for (const ParticleFlowObject *pPfo : allParticles)
                     LArPfoHelper::GetAllCaloHits(pPfo, allHits);
                 Node *pNode{new Node(*this, allParticles, allHits)};
                 m_interactions[pRoot].emplace_back(pNode);
                 // Find the children of this particle and recursively add them to the hierarchy
                 const PfoList &children{pPrimary->GetDaughterPfoList()};
                 for (const ParticleFlowObject *pChild : children)
                     pNode->FillHierarchy(pChild, foldParameters.m_foldToLeadingShowers);
             }
         }
     }
 }

void lar_content::LArHierarchyHelper::RecoHierarchy::GetFlattenedNodes	(	const pandora::ParticleFlowObject *const	pRoot,
		NodeVector &	nodeVector
	)		const

Retrieve a flat vector of the nodes in the hierarchy.

Parameters

pRoot	The root particle flow object for an interaction
nodeVector	The output vector for the nodes in the hierarchy in breadth first order

Definition at line 927 of file LArHierarchyHelper.cc.

References lar_content::LArHierarchyHelper::MCHierarchy::m_interactions.

Referenced by lar_content::LArHierarchyHelper::MatchInfo::Match(), and lar_content::HierarchyMonitoringAlgorithm::Run().

 {
     NodeList queue;
     for (const Node *pNode : m_interactions.at(pRoot))
     {
         nodeVector.emplace_back(pNode);
         queue.emplace_back(pNode);
     }
     while (!queue.empty())
     {
         const NodeVector &children{queue.front()->GetChildren()};
         queue.pop_front();
         for (const Node *pChild : children)
         {
             nodeVector.emplace_back(pChild);
             queue.emplace_back(pChild);
         }
     }
 }

const LArHierarchyHelper::RecoHierarchy::NodeVector & lar_content::LArHierarchyHelper::RecoHierarchy::GetInteractions ( const pandora::ParticleFlowObject * pRoot ) const

Retrieve the root nodes in the hierarchy for a given interaction.

Parameters

pRoot The root of the interaction hierarchy

Returns: The root nodes in this hierarchy

Definition at line 909 of file LArHierarchyHelper.cc.

References lar_content::LArHierarchyHelper::MCHierarchy::m_interactions.

 {
     if (m_interactions.find(pRoot) == m_interactions.end())
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     return m_interactions.at(pRoot);
 }

const pandora::ParticleFlowObject* lar_content::LArHierarchyHelper::RecoHierarchy::GetNeutrino ( ) const

Retrieve the neutrino at the root of the hierarchy if it exists.

Returns: The address of the incident neutrino (nullptr if it doesn't exist)

void lar_content::LArHierarchyHelper::RecoHierarchy::GetRootPfos ( pandora::PfoList & rootPfos ) const

Retrieve the root particle flow objects of the interaction hierarchies.

Parameters

rootPfos The output list of root particle flow objects

Definition at line 919 of file LArHierarchyHelper.cc.

References lar_content::LArHierarchyHelper::MCHierarchy::m_interactions.

Referenced by lar_content::LArHierarchyHelper::MatchInfo::Match(), lar_content::HierarchyValidationAlgorithm::Run(), and lar_content::HierarchyMonitoringAlgorithm::Run().

 {
     for (auto iter = m_interactions.begin(); iter != m_interactions.end(); ++iter)
         rootPfos.emplace_back(iter->first);
 }

const std::string lar_content::LArHierarchyHelper::RecoHierarchy::ToString ( ) const

Produce a string representation of the hierarchy.

Returns: The string representation of the hierarchy

Definition at line 949 of file LArHierarchyHelper.cc.

References lar_content::LArHierarchyHelper::MCHierarchy::m_interactions, and util::to_string().

Referenced by lar_content::HierarchyMonitoringAlgorithm::Run().

 {
     std::string str;
     for (const auto &[pRoot, nodeVector] : m_interactions)
     {
         str += "=== Reco Interaction : PDG " + std::to_string(pRoot->GetParticleId()) + "\n";
         for (const Node *pNode : nodeVector)
             str += "   " + pNode->ToString("") + "\n";
     }
 
     return str;
 }

Member Data Documentation

RecoNodeVectorMap lar_content::LArHierarchyHelper::RecoHierarchy::m_interactions

private

Map from the root PFO (e.g. neutrino) to primaries.

Definition at line 598 of file LArHierarchyHelper.h.

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArHierarchyHelper.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArHierarchyHelper.cc

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation