lar_content::LArHierarchyHelper::MatchInfo Class Reference

MatcheInfo class. More...

#include "LArHierarchyHelper.h"

Public Member Functions
	MatchInfo (const MCHierarchy &mcHierarchy, const RecoHierarchy &recoHierarchy)
	Default constructor. More...
	MatchInfo (const MCHierarchy &mcHierarchy, const RecoHierarchy &recoHierarchy, const QualityCuts &qualityCuts)
	Constructor. More...
void	Match ()
	Match the nodes in the MC and reco hierarchies. More...
const MCMatchesVector &	GetMatches (const pandora::MCParticle *const pRoot) const
	Retrieve the vector of matches (this will include null matches - i.e. MC nodes with no corresponding reco) More...
const RecoHierarchy::NodeVector &	GetUnmatchedReco () const
	Retrieve the vector of unmatched reco nodes. More...
unsigned int	GetNMCNodes (const pandora::MCParticle *const pRoot) const
	Retrieve the number of MC nodes available to match. More...
unsigned int	GetNNeutrinoMCNodes (const pandora::MCParticle *const pRoot) const
	Retrieve the number of neutrino interaction derived MC nodes available to match. More...
unsigned int	GetNCosmicRayMCNodes (const pandora::MCParticle *const pRoot) const
	Retrieve the number of cosmic ray derived MC nodes available to match. More...
unsigned int	GetNTestBeamMCNodes (const pandora::MCParticle *const pRoot) const
	Retrieve the number of test beam derived MC nodes available to match. More...
const MCHierarchy &	GetMCHierarchy () const
	Retrieve the MC hierarchy used for the matching. More...
const RecoHierarchy &	GetRecoHierarchy () const
	Retrieve the reco hierarchy used for the matching. More...
void	GetRootMCParticles (pandora::MCParticleList &rootMCParticles) const
	Retrieve the root MC particles of the interaction hierarchies. More...
const QualityCuts &	GetQualityCuts () const
	Retrieve the quality cuts for matching. More...
void	Print (const MCHierarchy &mcHierarchy) const
	Prints information about which reco nodes are matched to the MC nodes, information about hit sharing, purity and completeness. More...

Private Attributes
const MCHierarchy &	m_mcHierarchy
	The MC hierarchy for the matching procedure. More...
const RecoHierarchy &	m_recoHierarchy
	The Reco hierarchy for the matching procedure. More...
InteractionInfo	m_matches
	The map between an interaction and the vector of good matches from MC to reco. More...
RecoHierarchy::NodeVector	m_unmatchedReco
	The vector of unmatched reco nodes. More...
QualityCuts	m_qualityCuts
	The quality cuts to be applied to matches. More...

Detailed Description

MatcheInfo class.

Definition at line 737 of file LArHierarchyHelper.h.

Constructor & Destructor Documentation

lar_content::LArHierarchyHelper::MatchInfo::MatchInfo	(	const MCHierarchy &	mcHierarchy,
		const RecoHierarchy &	recoHierarchy
	)

Default constructor.

Parameters

mcHierarchy	The MC hierarchy
recoHierarchy	The reco hierarchy

Definition at line 1276 of file LArHierarchyHelper.cc.

                                                                                                         :
    MatchInfo(mcHierarchy, recoHierarchy, QualityCuts())
{
}

lar_content::LArHierarchyHelper::MatchInfo::MatchInfo	(	const MCHierarchy &	mcHierarchy,
		const RecoHierarchy &	recoHierarchy,
		const QualityCuts &	qualityCuts
	)

Constructor.

Parameters

mcHierarchy	The MC hierarchy
recoHierarchy	The reco hierarchy
qualityCuts	The quality cuts to be applied to matched nodes

Definition at line 1283 of file LArHierarchyHelper.cc.

References m_qualityCuts, and m_recoHierarchy.

                                                                                                                                         :
    m_mcHierarchy{mcHierarchy},
    m_recoHierarchy{recoHierarchy},
    m_qualityCuts{qualityCuts}
{
}

Member Function Documentation

const LArHierarchyHelper::MCMatchesVector & lar_content::LArHierarchyHelper::MatchInfo::GetMatches ( const pandora::MCParticle *const  pRoot ) const

inline

Retrieve the vector of matches (this will include null matches - i.e. MC nodes with no corresponding reco)

Parameters

pRoot

The root of the interaction hierarchy

Returns

The vector of matches

Definition at line 1009 of file LArHierarchyHelper.h.

Referenced by Print(), lar_content::HierarchyValidationAlgorithm::Run(), and lar_content::HierarchyMonitoringAlgorithm::Run().

{
    if (m_matches.find(pRoot) == m_matches.end())
        throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_FOUND);

    return m_matches.at(pRoot);
}

const LArHierarchyHelper::MCHierarchy & lar_content::LArHierarchyHelper::MatchInfo::GetMCHierarchy ( ) const

inline

Retrieve the MC hierarchy used for the matching.

Returns

The MCHierarchy used for matching

Definition at line 1026 of file LArHierarchyHelper.h.

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

{
    return m_mcHierarchy;
}

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNCosmicRayMCNodes

(

const pandora::MCParticle *const

pRoot

)

const

Retrieve the number of cosmic ray derived MC nodes available to match.

Parameters

pRoot

The root of the interaction hierarchy

Returns

The number of MC nodes available to match

Definition at line 1428 of file LArHierarchyHelper.cc.

References m_matches.

Referenced by Print().

{
    if (m_matches.find(pRoot) == m_matches.end())
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    unsigned int nNodes{0};
    for (const MCMatches &match : m_matches.at(pRoot))
    {
        const MCHierarchy::Node *pNode{match.GetMC()};
        if (pNode->IsCosmicRay())
            ++nNodes;
    }

    return nNodes;
}

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNMCNodes

(

const pandora::MCParticle *const

pRoot

)

const

Retrieve the number of MC nodes available to match.

Parameters

pRoot

The root of the interaction hierarchy

Returns

The number of MC nodes available to match

Definition at line 1400 of file LArHierarchyHelper.cc.

References m_matches.

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

{
    if (m_matches.find(pRoot) == m_matches.end())
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    return static_cast<unsigned int>(m_matches.at(pRoot).size());
}

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNNeutrinoMCNodes

(

const pandora::MCParticle *const

pRoot

)

const

Retrieve the number of neutrino interaction derived MC nodes available to match.

Parameters

pRoot

The root of the interaction hierarchy

Returns

The number of MC nodes available to match

Definition at line 1410 of file LArHierarchyHelper.cc.

References m_matches.

Referenced by Print().

{
    if (m_matches.find(pRoot) == m_matches.end())
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    unsigned int nNodes{0};
    for (const MCMatches &match : m_matches.at(pRoot))
    {
        const MCHierarchy::Node *pNode{match.GetMC()};
        if (!(pNode->IsCosmicRay() || pNode->IsTestBeamParticle()))
            ++nNodes;
    }

    return nNodes;
}

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNTestBeamMCNodes

(

const pandora::MCParticle *const

pRoot

)

const

Retrieve the number of test beam derived MC nodes available to match.

Parameters

pRoot

The root of the interaction hierarchy

Returns

The number of MC nodes available to match

Definition at line 1446 of file LArHierarchyHelper.cc.

References m_matches.

Referenced by Print().

{
    if (m_matches.find(pRoot) == m_matches.end())
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    unsigned int nNodes{0};
    for (const MCMatches &match : m_matches.at(pRoot))
    {
        const MCHierarchy::Node *pNode{match.GetMC()};
        if (pNode->IsTestBeamParticle())
            ++nNodes;
    }

    return nNodes;
}

const LArHierarchyHelper::QualityCuts & lar_content::LArHierarchyHelper::MatchInfo::GetQualityCuts ( ) const

inline

Retrieve the quality cuts for matching.

Returns

The quality cuts

Definition at line 1040 of file LArHierarchyHelper.h.

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

{
    return m_qualityCuts;
}

const LArHierarchyHelper::RecoHierarchy & lar_content::LArHierarchyHelper::MatchInfo::GetRecoHierarchy ( ) const

inline

Retrieve the reco hierarchy used for the matching.

Returns

The RecoHierarchy used for matching

Definition at line 1033 of file LArHierarchyHelper.h.

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

{
    return m_recoHierarchy;
}

void lar_content::LArHierarchyHelper::MatchInfo::GetRootMCParticles

(

pandora::MCParticleList &

rootMCParticles

)

const

Retrieve the root MC particles of the interaction hierarchies.

Parameters

rootMCParticles

The output list of root MC particles

Definition at line 1578 of file LArHierarchyHelper.cc.

References m_matches.

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

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

const LArHierarchyHelper::RecoHierarchy::NodeVector & lar_content::LArHierarchyHelper::MatchInfo::GetUnmatchedReco ( ) const

inline

Retrieve the vector of unmatched reco nodes.

Definition at line 1019 of file LArHierarchyHelper.h.

Referenced by Print().

{
    return m_unmatchedReco;
}

void lar_content::LArHierarchyHelper::MatchInfo::Match

(

)

Match the nodes in the MC and reco hierarchies.

Definition at line 1292 of file LArHierarchyHelper.cc.

References lar_content::LArHierarchyHelper::MCMatches::AddRecoMatch(), util::begin(), util::end(), lar_content::LArHierarchyHelper::MCHierarchy::Node::GetCaloHits(), lar_content::LArHierarchyHelper::RecoHierarchy::Node::GetCaloHits(), lar_content::LArHierarchyHelper::MCHierarchy::GetFlattenedNodes(), lar_content::LArHierarchyHelper::RecoHierarchy::GetFlattenedNodes(), lar_content::LArHierarchyHelper::MCMatches::GetMC(), lar_content::LArHierarchyHelper::MCHierarchy::GetRootMCParticles(), lar_content::LArHierarchyHelper::RecoHierarchy::GetRootPfos(), m_matches, m_mcHierarchy, m_recoHierarchy, and m_unmatchedReco.

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

{
    MCParticleList rootMCParticles;
    m_mcHierarchy.GetRootMCParticles(rootMCParticles);
    PfoList rootPfos;
    m_recoHierarchy.GetRootPfos(rootPfos);
    std::map<const MCHierarchy::Node *, MCMatches> mcToMatchMap;

    for (const MCParticle *const pRootMC : rootMCParticles)
    {
        MCHierarchy::NodeVector mcNodes;
        m_mcHierarchy.GetFlattenedNodes(pRootMC, mcNodes);
        for (const ParticleFlowObject *const pRootPfo : rootPfos)
        {
            RecoHierarchy::NodeVector recoNodes;
            m_recoHierarchy.GetFlattenedNodes(pRootPfo, recoNodes);

            std::sort(mcNodes.begin(), mcNodes.end(),
                [](const MCHierarchy::Node *lhs, const MCHierarchy::Node *rhs)
                { return lhs->GetCaloHits().size() > rhs->GetCaloHits().size(); });
            std::sort(recoNodes.begin(), recoNodes.end(),
                [](const RecoHierarchy::Node *lhs, const RecoHierarchy::Node *rhs)
                { return lhs->GetCaloHits().size() > rhs->GetCaloHits().size(); });

            for (const RecoHierarchy::Node *pRecoNode : recoNodes)
            {
                const CaloHitList &recoHits{pRecoNode->GetCaloHits()};
                const MCHierarchy::Node *pBestNode{nullptr};
                size_t bestSharedHits{0};
                for (const MCHierarchy::Node *pMCNode : mcNodes)
                {
                    if (!pMCNode->IsReconstructable())
                        continue;
                    const CaloHitList &mcHits{pMCNode->GetCaloHits()};
                    CaloHitVector intersection;
                    std::set_intersection(mcHits.begin(), mcHits.end(), recoHits.begin(), recoHits.end(), std::back_inserter(intersection));

                    if (!intersection.empty())
                    {
                        const size_t sharedHits{intersection.size()};
                        if (sharedHits > bestSharedHits)
                        {
                            bestSharedHits = sharedHits;
                            pBestNode = pMCNode;
                        }
                    }
                }
                if (pBestNode)
                {
                    auto iter{mcToMatchMap.find(pBestNode)};
                    if (iter != mcToMatchMap.end())
                    {
                        MCMatches &match(iter->second);
                        match.AddRecoMatch(pRecoNode, static_cast<int>(bestSharedHits));
                    }
                    else
                    {
                        MCMatches match(pBestNode);
                        match.AddRecoMatch(pRecoNode, static_cast<int>(bestSharedHits));
                        mcToMatchMap.insert(std::make_pair(pBestNode, match));
                    }
                }
                else
                {
                    m_unmatchedReco.emplace_back(pRecoNode);
                }
            }
        }
    }

    for (auto [pMCNode, matches] : mcToMatchMap)
    {
        // We need to figure out which MC interaction hierarchy the matches belongs to
        for (const MCParticle *const pRootMC : rootMCParticles)
        {
            MCHierarchy::NodeVector mcNodes;
            m_mcHierarchy.GetFlattenedNodes(pRootMC, mcNodes);
            if (std::find(mcNodes.begin(), mcNodes.end(), pMCNode) != mcNodes.end())
            {
                m_matches[pRootMC].emplace_back(matches);
                break;
            }
        }
    }

    const auto predicate = [](const MCMatches &lhs, const MCMatches &rhs)
    { return lhs.GetMC()->GetCaloHits().size() > rhs.GetMC()->GetCaloHits().size(); };

    for (const MCParticle *const pRootMC : rootMCParticles)
    {
        std::sort(m_matches[pRootMC].begin(), m_matches[pRootMC].end(), predicate);

        MCHierarchy::NodeVector mcNodes;
        m_mcHierarchy.GetFlattenedNodes(pRootMC, mcNodes);

        for (const MCHierarchy::Node *pMCNode : mcNodes)
        {
            if (pMCNode->IsReconstructable() && mcToMatchMap.find(pMCNode) == mcToMatchMap.end())
            {
                MCMatches match(pMCNode);
                m_matches[pRootMC].emplace_back(match);
            }
        }
    }
}

void lar_content::LArHierarchyHelper::MatchInfo::Print

(

const MCHierarchy &

mcHierarchy

)

const

Prints information about which reco nodes are matched to the MC nodes, information about hit sharing, purity and completeness.

Parameters

mcHierarchy

The MC hierarchy

Definition at line 1464 of file LArHierarchyHelper.cc.

References f, lar_content::LArInteractionTypeHelper::GetInteractionDescriptor(), lar_content::LArHierarchyHelper::MCHierarchy::Node::GetLeadingMCParticle(), GetMatches(), GetNCosmicRayMCNodes(), GetNNeutrinoMCNodes(), GetNTestBeamMCNodes(), lar_content::LArHierarchyHelper::MCHierarchy::Node::GetParticleId(), lar_content::LArHierarchyHelper::MCHierarchy::GetRootMCParticles(), GetUnmatchedReco(), lar_content::LArMCParticleHelper::IsBeamParticle(), lar_content::LArMCParticleHelper::IsCosmicRay(), lar_content::LArMCParticleHelper::IsNeutrino(), m_matches, lar_content::LArMCParticleHelper::SortByMomentum(), and util::to_string().

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

{
    (void)mcHierarchy;
    MCParticleList rootMCParticles;
    mcHierarchy.GetRootMCParticles(rootMCParticles);

    for (const MCParticle *const pRootMC : rootMCParticles)
    {
        const LArHierarchyHelper::MCMatchesVector &matches{this->GetMatches(pRootMC)};

        MCParticleList primaries;
        for (const LArHierarchyHelper::MCMatches &match : matches)
        {
            const LArHierarchyHelper::MCHierarchy::Node *pMCNode{match.GetMC()};
            if (pMCNode->GetHierarchyTier() == 1)
            {
                const MCParticle *const pLeadingMC{pMCNode->GetLeadingMCParticle()};
                primaries.emplace_back(pLeadingMC);
            }
        }
        primaries.sort(LArMCParticleHelper::SortByMomentum);
        const InteractionDescriptor descriptor{LArInteractionTypeHelper::GetInteractionDescriptor(primaries)};

        const LArMCParticle *const pLArRoot{dynamic_cast<const LArMCParticle *const>(pRootMC)};
        if (pLArRoot)
            std::cout << "=== MC Interaction : PDG " << std::to_string(pLArRoot->GetParticleId())
                      << " Energy: " << std::to_string(pLArRoot->GetEnergy()) << " Type: " << descriptor.ToString() << std::endl;
        else
            std::cout << "=== MC Interaction : PDG " << std::to_string(pRootMC->GetParticleId())
                      << " Energy: " << std::to_string(pRootMC->GetEnergy()) << " Type: " << descriptor.ToString() << std::endl;

        unsigned int nNeutrinoMCParticles{this->GetNNeutrinoMCNodes(pRootMC)}, nNeutrinoRecoParticles{0};
        unsigned int nCosmicMCParticles{this->GetNCosmicRayMCNodes(pRootMC)}, nCosmicRecoParticles{0};
        unsigned int nTestBeamMCParticles{this->GetNTestBeamMCNodes(pRootMC)}, nTestBeamRecoParticles{0};
        std::cout << "   === Matches ===" << std::endl;
        std::cout << std::fixed << std::setprecision(2);
        for (const MCMatches &match : m_matches.at(pRootMC))
        {
            const MCHierarchy::Node *pMCNode{match.GetMC()};
            const int pdg{pMCNode->GetParticleId()};
            const size_t mcHits{pMCNode->GetCaloHits().size()};
            const std::string tag{pMCNode->IsTestBeamParticle() ? "(Beam) " : pMCNode->IsCosmicRay() ? "(Cosmic) " : ""};
            std::cout << "   MC " << tag << pdg << " hits " << mcHits << std::endl;
            const RecoHierarchy::NodeVector &nodeVector{match.GetRecoMatches()};

            for (const RecoHierarchy::Node *pRecoNode : nodeVector)
            {
                const unsigned int recoHits{static_cast<unsigned int>(pRecoNode->GetCaloHits().size())};
                const unsigned int sharedHits{match.GetSharedHits(pRecoNode)};
                const float purity{match.GetPurity(pRecoNode)};
                const float completeness{match.GetCompleteness(pRecoNode)};
                if (completeness > 0.1f)
                    std::cout << "   Matched " << sharedHits << " out of " << recoHits << " with purity " << purity << " and completeness "
                              << completeness << std::endl;
                else
                    std::cout << "   (Below threshold) " << sharedHits << " out of " << recoHits << " with purity " << purity
                              << " and completeness " << completeness << std::endl;
            }
            if (nodeVector.empty())
            {
                std::cout << "      Unmatched" << std::endl;
            }
            else if (match.IsQuality(this->GetQualityCuts()))
            {
                if (pMCNode->IsTestBeamParticle())
                    ++nTestBeamRecoParticles;
                else if (pMCNode->IsCosmicRay())
                    ++nCosmicRecoParticles;
                else
                    ++nNeutrinoRecoParticles;
            }
        }

        if (LArMCParticleHelper::IsNeutrino(pRootMC))
        {
            std::cout << "   Neutrino Interaction Summary:" << std::endl;
            if (nNeutrinoMCParticles)
            {
                std::cout << "   Good final state particles: " << nNeutrinoRecoParticles << " of " << nNeutrinoMCParticles << " : "
                          << (100 * nNeutrinoRecoParticles / static_cast<float>(nNeutrinoMCParticles)) << "%" << std::endl;
            }
        }
        else if (LArMCParticleHelper::IsCosmicRay(pRootMC))
        {
            std::cout << "   Cosmic Ray Interaction Summary:" << std::endl;
            std::cout << std::fixed << std::setprecision(1);
            if (nCosmicMCParticles)
            {
                std::cout << "   Good cosmics: " << nCosmicRecoParticles << " of " << nCosmicMCParticles << " : "
                          << (100 * nCosmicRecoParticles / static_cast<float>(nCosmicMCParticles)) << "%" << std::endl;
            }
        }
        else if (LArMCParticleHelper::IsBeamParticle(pRootMC))
        {
            std::cout << "   Test Beam Interaction Summary:" << std::endl;
            std::cout << std::fixed << std::setprecision(1);
            if (nTestBeamMCParticles)
            {
                std::cout << "   Good test beam particles: " << nTestBeamRecoParticles << " of " << nTestBeamMCParticles << " : "
                          << (100 * nTestBeamRecoParticles / static_cast<float>(nTestBeamMCParticles)) << "%" << std::endl;
            }
            if (nCosmicMCParticles)
            {
                std::cout << "   Matched cosmics: " << nCosmicRecoParticles << " of " << nCosmicMCParticles << " : "
                          << (100 * nCosmicRecoParticles / static_cast<float>(nCosmicMCParticles)) << "%" << std::endl;
            }
        }
        if (!this->GetUnmatchedReco().empty())
            std::cout << "   Unmatched reco: " << this->GetUnmatchedReco().size() << std::endl;
    }
}

Member Data Documentation

InteractionInfo lar_content::LArHierarchyHelper::MatchInfo::m_matches

private

The map between an interaction and the vector of good matches from MC to reco.

Definition at line 852 of file LArHierarchyHelper.h.

Referenced by GetNCosmicRayMCNodes(), GetNMCNodes(), GetNNeutrinoMCNodes(), GetNTestBeamMCNodes(), GetRootMCParticles(), Match(), and Print().

const MCHierarchy& lar_content::LArHierarchyHelper::MatchInfo::m_mcHierarchy

private

The MC hierarchy for the matching procedure.

Definition at line 850 of file LArHierarchyHelper.h.

Referenced by Match().

QualityCuts lar_content::LArHierarchyHelper::MatchInfo::m_qualityCuts

private

The quality cuts to be applied to matches.

Definition at line 854 of file LArHierarchyHelper.h.

Referenced by MatchInfo().

const RecoHierarchy& lar_content::LArHierarchyHelper::MatchInfo::m_recoHierarchy

private

The Reco hierarchy for the matching procedure.

Definition at line 851 of file LArHierarchyHelper.h.

Referenced by Match(), and MatchInfo().

RecoHierarchy::NodeVector lar_content::LArHierarchyHelper::MatchInfo::m_unmatchedReco

private

The vector of unmatched reco nodes.

Definition at line 853 of file LArHierarchyHelper.h.

Referenced by Match().

---

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