MCMatches class. More...

#include <LArHierarchyHelper.h>

Public Member Functions
	MCMatches (const MCHierarchy::Node *pMCParticle)
	Constructor. More...

void	AddRecoMatch (const RecoHierarchy::Node *pReco, const int nSharedHits)
	Add a reconstructed node as a match for this MC node. More...

const MCHierarchy::Node *	GetMC () const
	Retrieve the MC node. More...

const RecoHierarchy::NodeVector &	GetRecoMatches () const
	Retrieve the vector of matched reco nodes. More...

unsigned int	GetSharedHits (const RecoHierarchy::Node *pReco) const
	Retrieve the number of shared hits in the match. More...

float	GetPurity (const RecoHierarchy::Node *pReco, const bool adcWeighted=false) const
	Retrieve the purity of the match. More...

float	GetPurity (const RecoHierarchy::Node *pReco, const pandora::HitType view, const bool adcWeighted=false) const
	Retrieve the purity of the match. More...

float	GetCompleteness (const RecoHierarchy::Node *pReco, const bool adcWeighted=false) const
	Retrieve the completeness of the match. More...

float	GetCompleteness (const RecoHierarchy::Node *pReco, const pandora::HitType view, const bool adcWeighted=false) const
	Retrieve the completeness of the match. More...

size_t	GetNRecoMatches () const
	Get the number of reco nodes matched (both above and below quality cut thresholds) to the MC node. More...

bool	IsQuality (const QualityCuts &qualityCuts) const
	Get whether this match passes quality cuts. More...

Private Member Functions
float	GetPurity (const pandora::CaloHitVector &intersection, const pandora::CaloHitList &recoHits, const bool adcWeighted) const
	Core purity calculation given intersecting hits and reco hits. More...

float	GetCompleteness (const pandora::CaloHitVector &intersection, const pandora::CaloHitList &mcHits, const bool adcWeighted) const
	Core completeness calculation given intersecting hits and MC hits. More...

Private Attributes
const MCHierarchy::Node *	m_pMCParticle
	MC node associated with any matches. More...

RecoHierarchy::NodeVector	m_recoNodes
	Matched reco nodes. More...

pandora::IntVector	m_sharedHits
	Number of shared hits for each match. More...

Detailed Description

MCMatches class.

Definition at line 590 of file LArHierarchyHelper.h.

Constructor & Destructor Documentation

lar_content::LArHierarchyHelper::MCMatches::MCMatches ( const MCHierarchy::Node * pMCParticle )

Constructor.

Parameters

pMCParticle The MCParticle being matched

Definition at line 999 of file LArHierarchyHelper.cc.

                                                                          : m_pMCParticle{pMCParticle}
 {
 }

Member Function Documentation

void lar_content::LArHierarchyHelper::MCMatches::AddRecoMatch	(	const RecoHierarchy::Node *	pReco,
		const int	nSharedHits
	)

Add a reconstructed node as a match for this MC node.

Parameters

pReco	The reconstructed node that matches this MC node
nSharedHits	The number of hits shared betweeb reco and MC nodes

Definition at line 1005 of file LArHierarchyHelper.cc.

 {
     m_recoNodes.emplace_back(pReco);
     m_sharedHits.emplace_back(nSharedHits);
 }

float lar_content::LArHierarchyHelper::MCMatches::GetCompleteness	(	const RecoHierarchy::Node *	pReco,
		const bool	adcWeighted = `false`
	)		const

Retrieve the completeness of the match.

Parameters

pReco	The reco node to consider
adcWeighted	Whether or not to weight completeness according to the charge contribution

Returns: The completeness of the match

Definition at line 1065 of file LArHierarchyHelper.cc.

 {
     auto iter{std::find(m_recoNodes.begin(), m_recoNodes.end(), pReco)};
     if (iter == m_recoNodes.end())
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     const CaloHitList &recoHits{pReco->GetCaloHits()};
     const CaloHitList &mcHits{m_pMCParticle->GetCaloHits()};
     CaloHitVector intersection;
     std::set_intersection(mcHits.begin(), mcHits.end(), recoHits.begin(), recoHits.end(), std::back_inserter(intersection));
 
     return this->GetCompleteness(intersection, mcHits, adcWeighted);
 }

float lar_content::LArHierarchyHelper::MCMatches::GetCompleteness	(	const RecoHierarchy::Node *	pReco,
		const pandora::HitType	view,
		const bool	adcWeighted = `false`
	)		const

Retrieve the completeness of the match.

Parameters

pReco	The reco node to consider
view	The view for which purity should be calculated
adcWeighted	Whether or not to weight completeness according to the charge contribution

Returns: The completeness of the match

float lar_content::LArHierarchyHelper::MCMatches::GetCompleteness	(	const pandora::CaloHitVector &	intersection,
		const pandora::CaloHitList &	mcHits,
		const bool	adcWeighted
	)		const

private

Core completeness calculation given intersecting hits and MC hits.

Parameters

intersection	The intersecting reco and MC hits
mcHits	The MC hits
adcWeighted	Whether or not to weight completeness according to the charge contribution

Returns: The completeness of the match

const LArHierarchyHelper::MCHierarchy::Node * lar_content::LArHierarchyHelper::MCMatches::GetMC ( ) const

inline

Retrieve the MC node.

Returns: The MC node

Definition at line 1000 of file LArHierarchyHelper.h.

 {
     return m_pMCParticle;
 }

size_t lar_content::LArHierarchyHelper::MCMatches::GetNRecoMatches ( ) const

inline

Get the number of reco nodes matched (both above and below quality cut thresholds) to the MC node.

Returns: The number of reco nodes matched to the MC node

Definition at line 1014 of file LArHierarchyHelper.h.

 {
     return m_recoNodes.size();
 }

float lar_content::LArHierarchyHelper::MCMatches::GetPurity	(	const RecoHierarchy::Node *	pReco,
		const bool	adcWeighted = `false`
	)		const

Retrieve the purity of the match.

Parameters

pReco	The reco node to consider
adcWeighted	Whether or not to weight purity according to the charge contribution

Returns: The purity of the match

Definition at line 1025 of file LArHierarchyHelper.cc.

 {
     auto iter{std::find(m_recoNodes.begin(), m_recoNodes.end(), pReco)};
     if (iter == m_recoNodes.end())
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     const CaloHitList &recoHits{pReco->GetCaloHits()};
     const CaloHitList &mcHits{m_pMCParticle->GetCaloHits()};
     CaloHitVector intersection;
     std::set_intersection(mcHits.begin(), mcHits.end(), recoHits.begin(), recoHits.end(), std::back_inserter(intersection));
 
     return this->GetPurity(intersection, recoHits, adcWeighted);
 }

float lar_content::LArHierarchyHelper::MCMatches::GetPurity	(	const RecoHierarchy::Node *	pReco,
		const pandora::HitType	view,
		const bool	adcWeighted = `false`
	)		const

Retrieve the purity of the match.

Parameters

pReco	The reco node to consider
view	The view for which purity should be calculated
adcWeighted	Whether or not to weight purity according to the charge contribution

Returns: The purity of the match

float lar_content::LArHierarchyHelper::MCMatches::GetPurity	(	const pandora::CaloHitVector &	intersection,
		const pandora::CaloHitList &	recoHits,
		const bool	adcWeighted
	)		const

private

Core purity calculation given intersecting hits and reco hits.

Parameters

intersection	The intersecting reco and MC hits
recoHits	The reco hits
adcWeighted	Whether or not to weight purity according to the charge contribution

Returns: The purity of the match

const LArHierarchyHelper::RecoHierarchy::NodeVector & lar_content::LArHierarchyHelper::MCMatches::GetRecoMatches ( ) const

inline

Retrieve the vector of matched reco nodes.

Returns: The vector of matched reco nodes

Definition at line 1007 of file LArHierarchyHelper.h.

 {
     return m_recoNodes;
 }

unsigned int lar_content::LArHierarchyHelper::MCMatches::GetSharedHits ( const RecoHierarchy::Node * pReco ) const

Retrieve the number of shared hits in the match.

Parameters

pReco The reco node to consider

Returns: The number of shared hits

Definition at line 1013 of file LArHierarchyHelper.cc.

 {
     auto iter{std::find(m_recoNodes.begin(), m_recoNodes.end(), pReco)};
     if (iter == m_recoNodes.end())
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
     int index = iter - m_recoNodes.begin();
 
     return static_cast<int>(m_sharedHits[index]);
 }

bool lar_content::LArHierarchyHelper::MCMatches::IsQuality ( const QualityCuts & qualityCuts ) const

Get whether this match passes quality cuts.

Parameters

qualityCuts The quality cuts to pass

Returns: Whether or not this match passes quality cuts

Definition at line 1161 of file LArHierarchyHelper.cc.

 {
     if (m_recoNodes.size() != 1)
         return false;
 
     if (this->GetPurity(m_recoNodes.front()) < qualityCuts.m_minPurity)
         return false;
 
     if (this->GetCompleteness(m_recoNodes.front()) < qualityCuts.m_minCompleteness)
         return false;
 
     return true;
 }

Member Data Documentation

const MCHierarchy::Node* lar_content::LArHierarchyHelper::MCMatches::m_pMCParticle

private

MC node associated with any matches.

Definition at line 712 of file LArHierarchyHelper.h.

RecoHierarchy::NodeVector lar_content::LArHierarchyHelper::MCMatches::m_recoNodes

private

Matched reco nodes.

Definition at line 713 of file LArHierarchyHelper.h.

pandora::IntVector lar_content::LArHierarchyHelper::MCMatches::m_sharedHits

private

Number of shared hits for each match.

Definition at line 714 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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation