lar_content::LArHierarchyHelper::MCHierarchy::Node Class Reference

Node class. More...

#include <LArHierarchyHelper.h>

Public Member Functions
	Node (MCHierarchy &hierarchy, const pandora::MCParticle *pMCParticle, const int tier=1)
	Create a node with a primary MC particle. More...
	Node (MCHierarchy &hierarchy, const pandora::MCParticleList &mcParticleList, const pandora::CaloHitList &caloHitList, const int tier=1)
	Create a node from a list of MC particles. More...
virtual	~Node ()
	Destructor. More...
bool	IsReconstructable () const
	Return whether or not this node should be considered reconstructable. More...
void	FillHierarchy (const pandora::MCParticle *pRoot, const FoldingParameters &foldParameters)
	Recursively fill the hierarchy based on the criteria established for this MCHierarchy. More...
void	FillFlat (const pandora::MCParticle *pRoot)
	Fill this node by folding all descendent particles to this node. More...
const NodeVector &	GetChildren () const
	Return the vector of children for this node. More...
int	GetId () const
	Retrieve the unique ID of this node. More...
const pandora::MCParticle *	GetLeadingMCParticle () const
	Retrieve the leading MC particle associated with this node. More...
const pandora::MCParticleList &	GetMCParticles () const
	Retrieve the MC particles associated with this node. More...
const pandora::CaloHitList &	GetCaloHits () const
	Retrieve the CaloHits associated with this node. More...
int	GetParticleId () const
	Retrieve the PDG code for the leading particle in this node. More...
int	GetHierarchyTier () const
	Retrieve the hierarchy tier of this node. More...
bool	IsNeutrinoInduced () const
	Check if this is a particle induced by a neutrino interaction. More...
bool	IsTestBeamParticle () const
	Check if this is a test beam particle. More...
bool	IsCosmicRay () const
	Check if this is a cosmic ray particle. More...
bool	IsLeadingLepton () const
	Returns whether or not this particle is the leading lepton in the event. More...
const std::string	ToString (const std::string &prefix) const
	Produce a string representation of the hierarchy. More...

Private Member Functions
void	SetLeadingLepton ()
	Tags the particle as the leading lepton. More...

Private Attributes
MCHierarchy &	m_hierarchy
	The parent MC hierarchy. More...
pandora::MCParticleList	m_mcParticles
	The list of MC particles of which this node is composed. More...
pandora::CaloHitList	m_caloHits
	The list of calo hits of which this node is composed. More...
NodeVector	m_children
	The child nodes of this node. More...
const pandora::MCParticle *	m_mainParticle
	The leading MC particle for this node. More...
int	m_tier
	The hierarchy tier for this node. More...
int	m_pdg
	The PDG code of the leading MC particle for this node. More...
bool	m_isLeadingLepton
	Whether or not this node is the leading lepton. More...

Friends
class	MCHierarchy

Detailed Description

Node class.

Definition at line 131 of file LArHierarchyHelper.h.

Constructor & Destructor Documentation

lar_content::LArHierarchyHelper::MCHierarchy::Node::Node	(	MCHierarchy &	hierarchy,
		const pandora::MCParticle *	pMCParticle,
		const int	tier = 1
	)

Create a node with a primary MC particle.

Parameters

hierarchy	The parent hierarchy of this node
pMCParticle	The primary MC particle with which this node should be created
tier	The tier that should be assigned to this node

lar_content::LArHierarchyHelper::MCHierarchy::Node::Node	(	MCHierarchy &	hierarchy,
		const pandora::MCParticleList &	mcParticleList,
		const pandora::CaloHitList &	caloHitList,
		const int	tier = 1
	)

Create a node from a list of MC particles.

Parameters

hierarchy	The parent hierarchy of this node
mcParticleList	The MC particle list with which this node should be created
caloHitList	The CaloHit list with which this node should be created
tier	The tier that should be assigned to this node

lar_content::LArHierarchyHelper::MCHierarchy::Node::~Node ( )

virtual

Destructor.

Definition at line 537 of file LArHierarchyHelper.cc.

{
    m_mcParticles.clear();
    m_caloHits.clear();
    for (const Node *node : m_children)
        delete node;
    m_children.clear();
}

Member Function Documentation

void lar_content::LArHierarchyHelper::MCHierarchy::Node::FillFlat

(

const pandora::MCParticle *

pRoot

)

Fill this node by folding all descendent particles to this node.

Parameters

pRoot

The MC particle acting as the root of the current branch of the hierarchy

Definition at line 619 of file LArHierarchyHelper.cc.

{
    MCParticleList allParticles{pRoot};
    if (!m_hierarchy.m_recoCriteria.m_removeNeutrons)
    {
        LArMCParticleHelper::GetAllDescendentMCParticles(pRoot, allParticles);
    }
    else
    {
        MCParticleList neutrons;
        LArMCParticleHelper::GetAllDescendentMCParticles(pRoot, allParticles, allParticles, neutrons);
    }
    CaloHitList allHits;
    for (const MCParticle *pMCParticle : allParticles)
    {
        // ATTN - Not all MC particles will have hits
        if (m_hierarchy.m_mcToHitsMap.find(pMCParticle) != m_hierarchy.m_mcToHitsMap.end())
        {
            const CaloHitList &caloHits(m_hierarchy.m_mcToHitsMap.at(pMCParticle));
            allHits.insert(allHits.begin(), caloHits.begin(), caloHits.end());
        }
    }
    if (!allParticles.empty())
    {
        Node *pNode{new Node(m_hierarchy, allParticles, allHits, this->m_tier + 1)};
        m_children.emplace_back(pNode);
    }
}

void lar_content::LArHierarchyHelper::MCHierarchy::Node::FillHierarchy	(	const pandora::MCParticle *	pRoot,
		const FoldingParameters &	foldParameters
	)

Recursively fill the hierarchy based on the criteria established for this MCHierarchy.

Parameters

pRoot	The MC particle acting as the root of the current branch of the hierarchy
foldParameters	The folding parameters

Definition at line 548 of file LArHierarchyHelper.cc.

{
    if (foldParameters.m_foldDynamic)
    {
        MCParticleList leadingParticles, childParticles;
        m_hierarchy.InterpretHierarchy(pRoot, leadingParticles, childParticles, foldParameters.m_cosAngleTolerance);
        CaloHitList allHits;
        for (const MCParticle *pMCParticle : leadingParticles)
        {
            // ATTN - Not all MC particles will have hits
            if (m_hierarchy.m_mcToHitsMap.find(pMCParticle) != m_hierarchy.m_mcToHitsMap.end())
            {
                const CaloHitList &caloHits(m_hierarchy.m_mcToHitsMap.at(pMCParticle));
                allHits.insert(allHits.begin(), caloHits.begin(), caloHits.end());
            }
        }

        Node *pNode{new Node(m_hierarchy, leadingParticles, allHits, this->m_tier + 1)};
        m_children.emplace_back(pNode);
        for (const MCParticle *pChild : childParticles)
            pNode->FillHierarchy(pChild, foldParameters);
    }
    else
    {
        MCParticleList allParticles{pRoot};
        const int pdg{std::abs(pRoot->GetParticleId())};
        const bool isShower{pdg == E_MINUS || pdg == PHOTON};
        const bool isNeutron{pdg == NEUTRON};

        if (foldParameters.m_foldToTier && LArMCParticleHelper::GetHierarchyTier(pRoot) >= foldParameters.m_tier)
            LArMCParticleHelper::GetAllDescendentMCParticles(pRoot, allParticles);
        else if (foldParameters.m_foldToLeadingShowers && (isShower || (isNeutron && !m_hierarchy.m_recoCriteria.m_removeNeutrons)))
            LArMCParticleHelper::GetAllDescendentMCParticles(pRoot, allParticles);
        else if (m_hierarchy.m_recoCriteria.m_removeNeutrons && isNeutron)
            return;

        CaloHitList allHits;
        for (const MCParticle *pMCParticle : allParticles)
        {
            // ATTN - Not all MC particles will have hits
            if (m_hierarchy.m_mcToHitsMap.find(pMCParticle) != m_hierarchy.m_mcToHitsMap.end())
            {
                const CaloHitList &caloHits(m_hierarchy.m_mcToHitsMap.at(pMCParticle));
                allHits.insert(allHits.begin(), caloHits.begin(), caloHits.end());
            }
        }

        if (!allParticles.empty())
        {
            const bool hasChildren{(foldParameters.m_foldToTier && LArMCParticleHelper::GetHierarchyTier(pRoot) < foldParameters.m_tier) ||
                                   (!foldParameters.m_foldToTier && !foldParameters.m_foldToLeadingShowers) ||
                                   (foldParameters.m_foldToLeadingShowers && !(isShower || isNeutron))};
            // Only add the node if it either has children, or is a leaf node with hits
            if (hasChildren || (!hasChildren && !allHits.empty()))
            {
                Node *pNode{new Node(m_hierarchy, allParticles, allHits, this->m_tier + 1)};
                m_children.emplace_back(pNode);
                if (hasChildren)
                {
                    // Find the children of this particle and recursively add them to the hierarchy
                    const MCParticleList &children{pRoot->GetDaughterList()};
                    for (const MCParticle *pChild : children)
                        pNode->FillHierarchy(pChild, foldParameters);
                }
            }
        }
    }
}

const pandora::CaloHitList & lar_content::LArHierarchyHelper::MCHierarchy::Node::GetCaloHits ( ) const

inline

Retrieve the CaloHits associated with this node.

Returns

The list of CaloHits associated with this node

Definition at line 898 of file LArHierarchyHelper.h.

{
    return m_caloHits;
}

const LArHierarchyHelper::MCHierarchy::NodeVector & lar_content::LArHierarchyHelper::MCHierarchy::Node::GetChildren ( ) const

inline

Return the vector of children for this node.

Returns

The vector of children

Definition at line 884 of file LArHierarchyHelper.h.

{
    return m_children;
}

int lar_content::LArHierarchyHelper::MCHierarchy::Node::GetHierarchyTier ( ) const

inline

Retrieve the hierarchy tier of this node.

Returns

The hierarchy tier of this node

Definition at line 919 of file LArHierarchyHelper.h.

{
    return m_tier;
}

int lar_content::LArHierarchyHelper::MCHierarchy::Node::GetId

(

)

const

Retrieve the unique ID of this node.

Returns

The unique ID of this node

Definition at line 650 of file LArHierarchyHelper.cc.

{
    return m_hierarchy.m_nodeToIdMap.at(this);
}

const pandora::MCParticle * lar_content::LArHierarchyHelper::MCHierarchy::Node::GetLeadingMCParticle ( ) const

inline

Retrieve the leading MC particle associated with this node.

Returns

The main MC particle associated with this node

Definition at line 905 of file LArHierarchyHelper.h.

{
    return m_mainParticle;
}

const pandora::MCParticleList & lar_content::LArHierarchyHelper::MCHierarchy::Node::GetMCParticles ( ) const

inline

Retrieve the MC particles associated with this node.

Returns

The MC particles associated with this node

Definition at line 891 of file LArHierarchyHelper.h.

{
    return m_mcParticles;
}

int lar_content::LArHierarchyHelper::MCHierarchy::Node::GetParticleId ( ) const

inline

Retrieve the PDG code for the leading particle in this node.

Returns

The PDG code for the leading particle in this node

Definition at line 912 of file LArHierarchyHelper.h.

{
    return m_pdg;
}

bool lar_content::LArHierarchyHelper::MCHierarchy::Node::IsCosmicRay

(

)

const

Check if this is a cosmic ray particle.

Returns

Whether or not this is a cosmic ray

Definition at line 709 of file LArHierarchyHelper.cc.

{
    if (m_mainParticle)
        return LArMCParticleHelper::IsCosmicRay(m_mainParticle);
    else
        return false;
}

bool lar_content::LArHierarchyHelper::MCHierarchy::Node::IsLeadingLepton ( ) const

inline

Returns whether or not this particle is the leading lepton in the event.

Returns

Whether or not this is the leading lepton

Definition at line 933 of file LArHierarchyHelper.h.

{
    return m_isLeadingLepton;
}

bool lar_content::LArHierarchyHelper::MCHierarchy::Node::IsNeutrinoInduced ( ) const

inline

Check if this is a particle induced by a neutrino interaction.

Returns

Whether or not this is neutrino induced

Definition at line 926 of file LArHierarchyHelper.h.

{
    return !(LArHierarchyHelper::MCHierarchy::Node::IsTestBeamParticle() || LArHierarchyHelper::MCHierarchy::Node::IsCosmicRay());
}

bool lar_content::LArHierarchyHelper::MCHierarchy::Node::IsReconstructable

(

)

const

Return whether or not this node should be considered reconstructable.

Returns

true if reconstructable, false otherwise

Definition at line 657 of file LArHierarchyHelper.cc.

{
    const bool enoughHits{m_caloHits.size() >= m_hierarchy.m_recoCriteria.m_minHits};
    if (!enoughHits)
        return false;
    bool enoughGoodViews{false};
    unsigned int nHitsU{0}, nHitsV{0}, nHitsW{0};
    for (const CaloHit *pCaloHit : m_caloHits)
    {
        switch (pCaloHit->GetHitType())
        {
            case TPC_VIEW_U:
                ++nHitsU;
                break;
            case TPC_VIEW_V:
                ++nHitsV;
                break;
            case TPC_VIEW_W:
                ++nHitsW;
                break;
            default:
                break;
        }
        unsigned int nGoodViews{0};
        if (nHitsU >= m_hierarchy.m_recoCriteria.m_minHitsForGoodView)
            ++nGoodViews;
        if (nHitsV >= m_hierarchy.m_recoCriteria.m_minHitsForGoodView)
            ++nGoodViews;
        if (nHitsW >= m_hierarchy.m_recoCriteria.m_minHitsForGoodView)
            ++nGoodViews;
        if (nGoodViews >= m_hierarchy.m_recoCriteria.m_minGoodViews)
        {
            enoughGoodViews = true;
            break;
        }
    }

    return enoughGoodViews;
}

bool lar_content::LArHierarchyHelper::MCHierarchy::Node::IsTestBeamParticle

(

)

const

Check if this is a test beam particle.

Returns

Whether or not this is a test beam particle

Definition at line 699 of file LArHierarchyHelper.cc.

{
    if (m_mainParticle)
        return LArMCParticleHelper::IsBeamParticle(m_mainParticle);
    else
        return false;
}

void lar_content::LArHierarchyHelper::MCHierarchy::Node::SetLeadingLepton ( )

inlineprivate

Tags the particle as the leading lepton.

Definition at line 940 of file LArHierarchyHelper.h.

{
    m_isLeadingLepton = true;
}

const std::string lar_content::LArHierarchyHelper::MCHierarchy::Node::ToString

(

const std::string &

prefix

)

const

Produce a string representation of the hierarchy.

Returns

The string representation of the hierarchy

Definition at line 719 of file LArHierarchyHelper.cc.

{
    std::string str(prefix + "PDG: " + std::to_string(m_pdg) + " Energy: " + std::to_string(m_mainParticle ? m_mainParticle->GetEnergy() : 0) +
                    " Hits: " + std::to_string(m_caloHits.size()) + "\n");
    for (const Node *pChild : m_children)
        str += pChild->ToString(prefix + "   ");

    return str;
}

Friends And Related Function Documentation

friend class MCHierarchy

friend

Definition at line 279 of file LArHierarchyHelper.h.

Member Data Documentation

pandora::CaloHitList lar_content::LArHierarchyHelper::MCHierarchy::Node::m_caloHits

private

The list of calo hits of which this node is composed.

Definition at line 272 of file LArHierarchyHelper.h.

NodeVector lar_content::LArHierarchyHelper::MCHierarchy::Node::m_children

private

The child nodes of this node.

Definition at line 273 of file LArHierarchyHelper.h.

MCHierarchy& lar_content::LArHierarchyHelper::MCHierarchy::Node::m_hierarchy

private

The parent MC hierarchy.

Definition at line 270 of file LArHierarchyHelper.h.

bool lar_content::LArHierarchyHelper::MCHierarchy::Node::m_isLeadingLepton

private

Whether or not this node is the leading lepton.

Definition at line 277 of file LArHierarchyHelper.h.

const pandora::MCParticle* lar_content::LArHierarchyHelper::MCHierarchy::Node::m_mainParticle

private

The leading MC particle for this node.

Definition at line 274 of file LArHierarchyHelper.h.

pandora::MCParticleList lar_content::LArHierarchyHelper::MCHierarchy::Node::m_mcParticles

private

The list of MC particles of which this node is composed.

Definition at line 271 of file LArHierarchyHelper.h.

int lar_content::LArHierarchyHelper::MCHierarchy::Node::m_pdg

private

The PDG code of the leading MC particle for this node.

Definition at line 276 of file LArHierarchyHelper.h.

int lar_content::LArHierarchyHelper::MCHierarchy::Node::m_tier

private

The hierarchy tier for this node.

Definition at line 275 of file LArHierarchyHelper.h.

---

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

• larpandoracontent/larpandoracontent/LArHelpers/LArHierarchyHelper.h
• larpandoracontent/larpandoracontent/LArHelpers/LArHierarchyHelper.cc