MatcheInfo class. More...

#include <LArHierarchyHelper.h>

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

	MatchInfo (const QualityCuts &qualityCuts)
	Constructor. More...

void	Match (const MCHierarchy &mcHierarchy, const RecoHierarchy &recoHierarchy)
	Match the nodes in the MC and reco hierarchies. More...

const MCMatchesVector &	GetMatches () 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...

const pandora::MCParticle *	GetMCNeutrino () const
	Retrieve the parent MC neutrino if it exists. More...

const pandora::ParticleFlowObject *	GetRecoNeutrino () const
	Retrieve the parent reco neutrino if it exists. More...

unsigned int	GetNMCNodes () const
	Retrieve the number of MC nodes available to match. More...

unsigned int	GetNNeutrinoMCNodes () const
	Retrieve the number of neutrino interaction derived MC nodes available to match. More...

unsigned int	GetNCosmicRayMCNodes () const
	Retrieve the number of cosmic ray derived MC nodes available to match. More...

unsigned int	GetNTestBeamMCNodes () const
	Retrieve the number of test beam derived MC nodes available to match. 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 pandora::MCParticle *	m_pMCNeutrino
	The parent neutrino if it exists. More...

const pandora::ParticleFlowObject *	m_pRecoNeutrino
	The parent neutrino if it exists. More...

MCMatchesVector	m_matches
	The vector of good matches from MC to reco. More...

MCMatchesVector	m_goodMatches
	The vector of good matches - above threshold one reco to one MC matches. More...

MCMatchesVector	m_aboveThresholdMatches
	The vector of matches that pass quality but with multiple reco matches to the MC. More...

MCMatchesVector	m_subThresholdMatches
	The vector of matches that don't pass quality cuts. More...

MCHierarchy::NodeVector	m_unmatchedMC
	The vector of unmatched MC nodes. 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 722 of file LArHierarchyHelper.h.

Constructor & Destructor Documentation

lar_content::LArHierarchyHelper::MatchInfo::MatchInfo ( )

Default constructor.

Definition at line 1178 of file LArHierarchyHelper.cc.

                                        : MatchInfo(QualityCuts())
 {
 }

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

Constructor.

Parameters

qualityCuts The quality cuts to be applied to matched nodes

Definition at line 1184 of file LArHierarchyHelper.cc.

                                                                      :
     m_pMCNeutrino{nullptr},
     m_pRecoNeutrino{nullptr},
     m_qualityCuts{qualityCuts}
 {
 }

Member Function Documentation

const LArHierarchyHelper::MCMatchesVector & lar_content::LArHierarchyHelper::MatchInfo::GetMatches ( ) const

inline

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

Returns: The vector of matches

Definition at line 1022 of file LArHierarchyHelper.h.

 {
     return m_matches;
 }

const pandora::MCParticle * lar_content::LArHierarchyHelper::MatchInfo::GetMCNeutrino ( ) const

inline

Retrieve the parent MC neutrino if it exists.

Parameters

The	parent neutrino if it exists (nullptr otherwise)

Definition at line 1036 of file LArHierarchyHelper.h.

 {
     return m_pMCNeutrino;
 }

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNCosmicRayMCNodes ( ) const

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

Returns: The number of MC nodes available to match

Definition at line 1294 of file LArHierarchyHelper.cc.

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

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNMCNodes ( ) const

Retrieve the number of MC nodes available to match.

Returns: The number of MC nodes available to match

Definition at line 1272 of file LArHierarchyHelper.cc.

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

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNNeutrinoMCNodes ( ) const

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

Returns: The number of MC nodes available to match

Definition at line 1279 of file LArHierarchyHelper.cc.

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

unsigned int lar_content::LArHierarchyHelper::MatchInfo::GetNTestBeamMCNodes ( ) const

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

Returns: The number of MC nodes available to match

Definition at line 1309 of file LArHierarchyHelper.cc.

 {
     unsigned int nNodes{0};
     for (const MCMatches &match : m_matches)
     {
         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 1050 of file LArHierarchyHelper.h.

 {
     return m_qualityCuts;
 }

const pandora::ParticleFlowObject * lar_content::LArHierarchyHelper::MatchInfo::GetRecoNeutrino ( ) const

inline

Retrieve the parent reco neutrino if it exists.

Parameters

The	parent neutrino if it exists (nullptr otherwise)

Definition at line 1043 of file LArHierarchyHelper.h.

 {
     return m_pRecoNeutrino;
 }

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

inline

Retrieve the vector of unmatched reco nodes.

Definition at line 1029 of file LArHierarchyHelper.h.

 {
     return m_unmatchedReco;
 }

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

Match the nodes in the MC and reco hierarchies.

Parameters

mcHierarchy	The MC hierarchy
recoHierarchy	The reco hierarchy

Definition at line 1193 of file LArHierarchyHelper.cc.

 {
     m_pMCNeutrino = mcHierarchy.GetNeutrino();
     m_pRecoNeutrino = recoHierarchy.GetNeutrino();
     MCHierarchy::NodeVector mcNodes;
     mcHierarchy.GetFlattenedNodes(mcNodes);
     RecoHierarchy::NodeVector recoNodes;
     recoHierarchy.GetFlattenedNodes(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(); });
 
     std::map<const MCHierarchy::Node *, MCMatches> mcToMatchMap;
     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)
         m_matches.emplace_back(matches);
 
     const auto predicate = [](const MCMatches &lhs, const MCMatches &rhs) {
         return lhs.GetMC()->GetCaloHits().size() > rhs.GetMC()->GetCaloHits().size();
     };
     std::sort(m_matches.begin(), m_matches.end(), predicate);
 
     for (const MCHierarchy::Node *pMCNode : mcNodes)
     {
         if (pMCNode->IsReconstructable() && mcToMatchMap.find(pMCNode) == mcToMatchMap.end())
         {
             MCMatches match(pMCNode);
             m_matches.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 1324 of file LArHierarchyHelper.cc.

 {
     unsigned int nNeutrinoMCParticles{this->GetNNeutrinoMCNodes()}, nNeutrinoRecoParticles{0};
     unsigned int nCosmicMCParticles{this->GetNCosmicRayMCNodes()}, nCosmicRecoParticles{0}, nCosmicRecoBTParticles{0};
     unsigned int nTestBeamMCParticles{this->GetNTestBeamMCNodes()}, nTestBeamRecoParticles{0}, nTestBeamRecoBTParticles{0};
     std::cout << "=== Matches ===" << std::endl;
     for (const MCMatches &match : m_matches)
     {
         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)};
             std::cout << "   Matched " << sharedHits << " out of " << recoHits << " with purity " << purity << " and completeness "
                       << completeness << std::endl;
         }
         if (nodeVector.empty())
             std::cout << "   Unmatched" << std::endl;
 
         if (pMCNode->IsTestBeamParticle())
             ++nTestBeamRecoParticles;
         else if (pMCNode->IsCosmicRay())
             ++nCosmicRecoParticles;
         else
             ++nNeutrinoRecoParticles;
     }
 
     if (mcHierarchy.IsNeutrinoHierarchy())
     {
         std::cout << "Neutrino Interaction Summary:" << std::endl;
         std::cout << std::fixed << std::setprecision(1);
         if (nNeutrinoMCParticles)
         {
             std::cout << "Matched final state particles: " << nNeutrinoRecoParticles << " of " << nNeutrinoMCParticles << " : "
                       << (100 * nNeutrinoRecoParticles / static_cast<float>(nNeutrinoMCParticles)) << "%" << std::endl;
         }
         if (nCosmicMCParticles)
         {
             std::cout << "Matched cosmics: " << nCosmicRecoParticles << " of " << nCosmicMCParticles << " : "
                       << (100 * nCosmicRecoParticles / static_cast<float>(nCosmicMCParticles)) << "%" << std::endl;
         }
     }
     else if (mcHierarchy.IsTestBeamHierarchy())
     {
         std::cout << "Test Beam Interaction Summary:" << std::endl;
         std::cout << std::fixed << std::setprecision(1);
         if (nTestBeamMCParticles)
         {
             std::cout << "Matched test beam particles: " << nTestBeamRecoParticles << " of " << nTestBeamMCParticles << " : "
                       << (100 * nTestBeamRecoParticles / static_cast<float>(nTestBeamMCParticles)) << "%" << std::endl;
             std::cout << "Loosely matched test beam particles: " << (nTestBeamRecoParticles + nTestBeamRecoBTParticles) << " of " << nTestBeamMCParticles
                       << " : " << (100 * (nTestBeamRecoParticles + nTestBeamRecoBTParticles) / static_cast<float>(nTestBeamMCParticles))
                       << "%" << std::endl;
         }
         if (nCosmicMCParticles)
         {
             std::cout << "Matched cosmics: " << nCosmicRecoParticles << " of " << nCosmicMCParticles << " : "
                       << (100 * nCosmicRecoParticles / static_cast<float>(nCosmicMCParticles)) << "%" << std::endl;
             std::cout << "Loosely matched cosmics: " << (nCosmicRecoParticles + nCosmicRecoBTParticles) << " of " << nCosmicMCParticles << " : "
                       << (100 * (nCosmicRecoParticles + nCosmicRecoBTParticles) / static_cast<float>(nCosmicMCParticles)) << "%" << std::endl;
         }
     }
     if (!this->GetUnmatchedReco().empty())
         std::cout << "Unmatched reco: " << this->GetUnmatchedReco().size() << std::endl;
 }

Member Data Documentation

MCMatchesVector lar_content::LArHierarchyHelper::MatchInfo::m_aboveThresholdMatches

private

The vector of matches that pass quality but with multiple reco matches to the MC.

Definition at line 820 of file LArHierarchyHelper.h.

MCMatchesVector lar_content::LArHierarchyHelper::MatchInfo::m_goodMatches

private

The vector of good matches - above threshold one reco to one MC matches.

Definition at line 819 of file LArHierarchyHelper.h.

MCMatchesVector lar_content::LArHierarchyHelper::MatchInfo::m_matches

private

The vector of good matches from MC to reco.

Definition at line 818 of file LArHierarchyHelper.h.

const pandora::MCParticle* lar_content::LArHierarchyHelper::MatchInfo::m_pMCNeutrino

private

The parent neutrino if it exists.

Definition at line 815 of file LArHierarchyHelper.h.

const pandora::ParticleFlowObject* lar_content::LArHierarchyHelper::MatchInfo::m_pRecoNeutrino

private

The parent neutrino if it exists.

Definition at line 816 of file LArHierarchyHelper.h.

QualityCuts lar_content::LArHierarchyHelper::MatchInfo::m_qualityCuts

private

The quality cuts to be applied to matches.

Definition at line 824 of file LArHierarchyHelper.h.

MCMatchesVector lar_content::LArHierarchyHelper::MatchInfo::m_subThresholdMatches

private

The vector of matches that don't pass quality cuts.

Definition at line 821 of file LArHierarchyHelper.h.

MCHierarchy::NodeVector lar_content::LArHierarchyHelper::MatchInfo::m_unmatchedMC

private

The vector of unmatched MC nodes.

Definition at line 822 of file LArHierarchyHelper.h.

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

private

The vector of unmatched reco nodes.

Definition at line 823 of file LArHierarchyHelper.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation