TwoViewDeltaRayMatchingAlgorithm class. More...

#include <TwoViewDeltaRayMatchingAlgorithm.h>

Inheritance diagram for lar_content::TwoViewDeltaRayMatchingAlgorithm:

Public Types
typedef NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >	BaseAlgorithm

typedef TwoViewDeltaRayMatchingAlgorithm::MatchingType::MatrixType	MatrixType

Public Types inherited from lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
typedef std::map< const pandora::CaloHit , const pandora::Cluster >	HitToClusterMap

typedef std::map< const pandora::Cluster , const pandora::ParticleFlowObject >	ClusterToPfoMap

typedef std::map< const pandora::Cluster *, pandora::ClusterList >	ClusterProximityMap

typedef KDTreeLinkerAlgo< const pandora::CaloHit *, 2 >	HitKDTree2D

typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D

typedef std::vector< HitKDNode2D >	HitKDNode2DList

typedef std::vector< pandora::HitType >	HitTypeVector

Public Types inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
typedef TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >	MatchingType

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

const std::string &	GetThirdViewClusterListName () const
	Get the name of the third view clusters. More...

const std::string &	GetClusteringAlgName () const
	Get the name of the clustering algorithm to be used to recluster created delta ray remnants. More...

HitTypeVector	GetHitTypeVector ()
	Obtain the HitTypeVector of input views. More...

const pandora::Cluster *	GetCluster (const MatrixType::Element &element, const pandora::HitType hitType)
	Get the address of the given hit type cluster. More...

bool	CreatePfo (const MatrixType::Element &element)
	Create delta ray pfos out of a given element, merging the third view clusters together and adding in any stray clusters. More...

void	UpdateForThirdViewClusterModification (const pandora::Cluster *const pModifiedCluster, const bool isMuon)
	Update the matrix after a third view cluster modification - remove delta ray clusters and reassess the matching of cosmic ray clusters. More...

Public Member Functions inherited from lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
	NViewDeltaRayMatchingAlgorithm ()
	Default constructor. More...

pandora::StatusCode	GetMuonCluster (const pandora::PfoList &commonMuonPfoList, const pandora::HitType hitType, const pandora::Cluster *&pMuonCluster) const
	Return the cluster of the common cosmic ray pfo in a given view (function demands there to be only one common CR pfo) More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::Cluster *const pCluster3, float &reducedChiSquared) const
	To determine how well three clusters (one in each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW, float &chiSquaredSum, unsigned int &nSamplingPoints, unsigned int &nMatchedSamplingPoints, XOverlap &XOverlap) const
	To determine how well three clusters (one in each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::CaloHitList &pCluster1, const pandora::CaloHitList &pCluster2, const pandora::CaloHitList &pCluster3, float &reducedChiSquared) const
	To determine how well three CaloHitLists (one in each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::CaloHitList &clusterU, const pandora::CaloHitList &clusterV, const pandora::CaloHitList &clusterW, float &chiSquaredSum, unsigned int &nSamplingPoints, unsigned int &nMatchedSamplingPoints, XOverlap &XOverlap) const
	To determine how well three CaloHitLists (one for each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	ProjectMuonPositions (const pandora::HitType &thirdViewHitType, const pandora::ParticleFlowObject *const pParentMuon, pandora::CartesianPointVector &projectedPositions) const
	Use two views of a cosmic ray pfo to calculate projected positions in a given the third view. More...

pandora::StatusCode	GetProjectedPositions (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, pandora::CartesianPointVector &projectedPositions) const
	Use two clusters from different views to calculate projected positions in the remaining third view. More...

pandora::StatusCode	CollectHitsFromMuon (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::Cluster const pThirdViewCluster, const pandora::ParticleFlowObject const pParentMuon, const float minDistanceFromMuon, const float maxDistanceToCollected, pandora::CaloHitList &collectedHits) const
	In one view, pull out any hits from a cosmic ray cluster that belong to the child delta ray cluster. More...

void	CollectHitsFromMuon (const pandora::CartesianVector &positionOnMuon, const pandora::CartesianVector &muonDirection, const pandora::Cluster *const pMuonCluster, const pandora::CartesianPointVector &deltaRayProjectedPositions, const float &minDistanceFromMuon, const float maxDistanceToCollected, pandora::CaloHitList &collectedHits) const
	In one view, pull out any hits from a cosmic ray cluster that belong to the child delta ray cluster. More...

pandora::StatusCode	ParameteriseMuon (const pandora::ParticleFlowObject const pParentMuon, const pandora::Cluster const pDeltaRayCluster, pandora::CartesianVector &positionOnMuon, pandora::CartesianVector &muonDirection) const
	Parameterise the projection of a cosmic ray track in order to avoid poor/sparse projections. More...

pandora::StatusCode	ParameteriseMuon (const pandora::ParticleFlowObject *const pParentMuon, const pandora::CartesianPointVector &deltaRayProjectedPositions, const pandora::HitType hitType, pandora::CartesianVector &positionOnMuon, pandora::CartesianVector &muonDirection) const
	Parameterise the projection of a cosmic ray track in order to avoid poor/sparse projections. More...

void	SplitMuonCluster (const std::string &clusterListName, const pandora::Cluster const pMuonCluster, const pandora::CaloHitList &collectedHits, const pandora::Cluster &pDeltaRayCluster) const
	Move a list of hits from a cosmic ray cluster into the given child delta ray cluster. More...

bool	CreatePfos (ProtoParticleVector &protoParticleVector)
	Create delta ray pfos maxmising completeness by searching for and merging in any stray clusters. More...

void	UpdateForNewClusters (const pandora::ClusterVector &newClusterVector, const pandora::PfoVector &pfoVector)
	Add a new cluster to algorithm ownership maps and, if it a delta ray cluster, to the underlying matches container (tensor/matrix) More...

void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. More...

void	SelectInputClusters (const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const
	Select a subset of input clusters for processing in this algorithm. More...

void	PrepareInputClusters (pandora::ClusterList &preparedClusterList)
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results. More...

Public Member Functions inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
	NViewMatchingAlgorithm ()
	Default constructor. More...

virtual	~NViewMatchingAlgorithm ()
	Destructor. More...

void	UpdateForNewCluster (const pandora::Cluster *const pNewCluster)
	Update to reflect addition of a new cluster to the problem space. More...

void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. More...

const std::string &	GetClusterListName (const pandora::HitType hitType) const
	Get the cluster list name corresponding to a specified hit type. More...

const pandora::ClusterList &	GetInputClusterList (const pandora::HitType hitType) const
	Get the input cluster list corresponding to a specified hit type. More...

const pandora::ClusterList &	GetSelectedClusterList (const pandora::HitType hitType) const
	Get the selected cluster list corresponding to a specified hit type. More...

Public Member Functions inherited from lar_content::MatchingBaseAlgorithm
	MatchingBaseAlgorithm ()
	Default constructor. More...

virtual	~MatchingBaseAlgorithm ()
	Destructor. More...

virtual bool	MakeClusterMerges (const ClusterMergeMap &clusterMergeMap)
	Merge clusters together. More...

virtual bool	CreateThreeDParticles (const ProtoParticleVector &protoParticleVector)
	Create particles using findings from recent algorithm processing. More...

virtual void	SetPfoParameters (const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set Pfo properties. More...

virtual void	SetPfoParticleId (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set pfo particle id. More...

Private Types
typedef std::vector< DeltaRayMatrixTool * >	MatrixToolVector

Private Member Functions
void	CalculateOverlapResult (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::Cluster *const pCluster3)
	Calculate cluster overlap result and store in container. More...

virtual bool	DoesClusterPassTensorThreshold (const pandora::Cluster *const pCluster) const
	To check whether a given cluster meets the requirements to be added into the matching container (tensor/matrix) More...

pandora::StatusCode	CalculateOverlapResult (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, TwoViewDeltaRayOverlapResult &overlapResult) const
	Calculate the overlap result for given pair of clusters. More...

void	FindCommonMuonParents (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, pandora::PfoList &commonMuonPfoList) const
	Find the cosmic ray pfos that, in each view, lie close to the clusters of the matrix element. More...

void	CollectThirdViewClusters (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::CartesianPointVector &projectedPositions, pandora::ClusterList &matchedClusters) const
	Collect the available and unavailable third view clusters that lie close to the projected delta ray hits. More...

const pandora::Cluster *	GetBestMatchedCluster (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::PfoList &commonMuonPfoList, const pandora::ClusterList &matchedClusters, float &reducedChiSquared) const
	Determine the best matched third view cluster and calculate the reduced chi-squared value of the three cluster match. More...

void	FormThirdViewCluster (const MatrixType::Element &element, ProtoParticle &protoParticle)
	Form the third view cluster by removing hits from cosmic ray clusters and merging the matched clusters where appropriate. More...

void	MergeThirdView (const MatrixType::Element &element, const pandora::Cluster *const pSeedCluster)
	Starting with an input seed cluster, sequentially merge in matched clusters that retain a good reduced chi-squared. More...

void	ExamineOverlapContainer ()
	Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required. More...

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_inputClusterListName
	The name of the cluster list in the view in which to project into. More...

std::string	m_reclusteringAlgorithmName
	The name of the clustering algorithm to be used to recluster created delta ray remnants. More...

MatrixToolVector	m_algorithmToolVector
	The algorithm tool vector. More...

unsigned int	m_nMaxMatrixToolRepeats
	The maximum number of repeat loops over matrix tools. More...

unsigned int	m_minClusterCaloHits
	The threshold number of hits for a cluster to be considered. More...

float	m_maxDistanceFromPrediction
	The maximum distance of a matched cluster from the third view projection points. More...

float	m_maxGoodMatchReducedChiSquared
	The maximum reduced chi squared value of a good 1:1:1 match. More...

float	m_minDistanceFromMuon
	The minimum distance of a hit from the cosmic ray track required for removal. More...

float	m_maxDistanceToCollected
	The maximim distance of a hit from the projected delta ray hits required for removal. More...

Additional Inherited Members
Protected Member Functions inherited from lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
void	FillStrayClusterList (const pandora::HitType hitType)
	Fill the stray cluster list with clusters that do not pass the tensor threshold requirement. More...

void	GetNearbyMuonPfos (const pandora::Cluster *const pCluster, pandora::ClusterList &consideredClusters, pandora::PfoList &nearbyMuonPfos) const
	Use the cluster proximity map to travel along paths of nearby clusters finding the cosmic ray clusters on which they terminate. More...

void	GetClusterSpanX (const pandora::CaloHitList &caloHitList, float &xMin, float &xMax) const
	Calculate the xSpan of a list of CaloHits. More...

pandora::StatusCode	GetClusterSpanZ (const pandora::CaloHitList &caloHitList, const float xMin, const float xMax, float &zMin, float &zMax) const
	Calculate the zSpan of a list of CaloHits in a specified x range. More...

void	CollectStrayClusters (const pandora::Cluster *const pClusterToEnlarge, const float rangeMinX, const float rangeMaxX, pandora::ClusterList &collectedClusters)
	Collect the stray clusters that are close to a specified cluster and that lie within a given x range. More...

void	AddInStrayClusters (const pandora::Cluster *const pClusterToEnlarge, const pandora::ClusterList &collectedClusters)
	Merge in the collected stray clusters of a given delta ray cluster. More...

void	TidyUp ()
	Tidy member variables in derived class. More...

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Protected Member Functions inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
MatchingType &	GetMatchingControl ()
	Get the matching control. More...

virtual void	SelectAllInputClusters ()
	Select a subset of input clusters for processing in this algorithm. More...

virtual void	PrepareAllInputClusters ()
	Perform any preparatory steps required, e.g. caching expensive fit results for clusters. More...

virtual void	PerformMainLoop ()
	Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult. More...

Protected Attributes inherited from lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
std::string	m_muonPfoListName
	The list of reconstructed cosmic ray pfos. More...

pandora::ClusterList	m_strayClusterListU
	The list of U clusters that do not pass the tensor threshold requirement. More...

pandora::ClusterList	m_strayClusterListV
	The list of V clusters that do not pass the tensor threshold requirement. More...

pandora::ClusterList	m_strayClusterListW
	The list of W clusters that do not pass the tensor threshold requirement. More...

DeltaRayMatchingContainers	m_deltaRayMatchingContainers
	The class of hit, cluster and pfo ownership and proximity maps. More...

float	m_pseudoChi2Cut
	Pseudo chi2 cut for three view matching. More...

float	m_xOverlapWindow
	The maximum allowed displacement in x position. More...

float	m_minMatchedFraction
	The threshold matched fraction of sampling points for a good match. More...

unsigned int	m_minMatchedPoints
	The threshold number of matched sampling points for a good match. More...

unsigned int	m_minProjectedPositions
	The threshold number of projected points for a good projection. More...

float	m_maxCosmicRayHitFraction
	The maximum allowed fraction of hits to be removed from the cosmic ray track. More...

float	m_maxDistanceToCluster
	the maximum distance of a projected point to the cosmic ray cluster used when parameterising the cosmic ray cluster More...

float	m_maxDistanceToReferencePoint
	the maximum distance of a projected point to the cosmic ray vertex used when parameterising the cosmic ray cluster More...

float	m_strayClusterSeparation
	The maximum allowed separation of a stray cluster and a delta ray cluster for merge. More...

Protected Attributes inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >
MatchingType	m_matchingControl
	The matching control. More...

Detailed Description

TwoViewDeltaRayMatchingAlgorithm class.

Definition at line 31 of file TwoViewDeltaRayMatchingAlgorithm.h.

Member Typedef Documentation

typedef NViewDeltaRayMatchingAlgorithm<TwoViewMatchingControl<TwoViewDeltaRayOverlapResult> > lar_content::TwoViewDeltaRayMatchingAlgorithm::BaseAlgorithm

Definition at line 34 of file TwoViewDeltaRayMatchingAlgorithm.h.

typedef std::vector<DeltaRayMatrixTool *> lar_content::TwoViewDeltaRayMatchingAlgorithm::MatrixToolVector

private

Definition at line 166 of file TwoViewDeltaRayMatchingAlgorithm.h.

typedef TwoViewDeltaRayMatchingAlgorithm::MatchingType::MatrixType lar_content::TwoViewDeltaRayMatchingAlgorithm::MatrixType

Definition at line 35 of file TwoViewDeltaRayMatchingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TwoViewDeltaRayMatchingAlgorithm::TwoViewDeltaRayMatchingAlgorithm ( )

Default constructor.

Definition at line 24 of file TwoViewDeltaRayMatchingAlgorithm.cc.

                                                                    :
     m_nMaxMatrixToolRepeats(10),
     m_minClusterCaloHits(3),
     m_maxDistanceFromPrediction(2.f),
     m_maxGoodMatchReducedChiSquared(1.f),
     m_minDistanceFromMuon(1.f),
     m_maxDistanceToCollected(1.f)
 {
 }

Member Function Documentation

void lar_content::TwoViewDeltaRayMatchingAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::Cluster *const	pCluster3
	)

privatevirtual

Calculate cluster overlap result and store in container.

Parameters

pCluster1	address of cluster1
pCluster2	address of cluster2
pCluster3	address of cluster3

Implements lar_content::MatchingBaseAlgorithm.

pandora::StatusCode lar_content::TwoViewDeltaRayMatchingAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		TwoViewDeltaRayOverlapResult &	overlapResult
	)		const

private

Calculate the overlap result for given pair of clusters.

Parameters

pCluster1	the cluster from the first input view
pCluster2	the cluster from the second input view
overlapResult	to receive the overlap result

Returns: statusCode, faster than throwing in regular use-cases

void lar_content::TwoViewDeltaRayMatchingAlgorithm::CollectThirdViewClusters	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::CartesianPointVector &	projectedPositions,
		pandora::ClusterList &	matchedClusters
	)		const

private

Collect the available and unavailable third view clusters that lie close to the projected delta ray hits.

Parameters

pCluster1	the cluster from the first input view
pCluster2	the cluster from the second input view
projectedPositions	the projected positions of the matched cluster pair
matchedClusters	the output list of collected clusters

Definition at line 170 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     const ClusterList *pInputClusterList(nullptr);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_inputClusterListName, pInputClusterList));
 
     if (!pInputClusterList || pInputClusterList->empty())
         return;
 
     for (const Cluster *const pCluster : *pInputClusterList)
     {
         const float separation(LArMuonLeadingHelper::GetClosestDistance(pCluster, projectedPositions));
 
         if (separation > m_maxDistanceFromPrediction)
             continue;
 
         float reducedChiSquared(0.f);
         if (this->PerformThreeViewMatching(pCluster1, pCluster2, pCluster, reducedChiSquared) == STATUS_CODE_NOT_FOUND)
             continue;
 
         if (reducedChiSquared > m_maxGoodMatchReducedChiSquared)
             continue;
 
         matchedClusters.push_back(pCluster);
     }
 }

bool lar_content::TwoViewDeltaRayMatchingAlgorithm::CreatePfo ( const MatrixType::Element & element )

Create delta ray pfos out of a given element, merging the third view clusters together and adding in any stray clusters.

Parameters

element the matrix element

Returns: whether any pfos were created

Definition at line 241 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     ProtoParticle protoParticle;
 
     protoParticle.m_clusterList.push_back(protoParticleElement.GetCluster1());
     protoParticle.m_clusterList.push_back(protoParticleElement.GetCluster2());
 
     const Cluster *const pBestMatchedCluster(protoParticleElement.GetOverlapResult().GetBestMatchedCluster());
 
     if (pBestMatchedCluster)
         this->FormThirdViewCluster(protoParticleElement, protoParticle);
 
     ProtoParticleVector protoParticleVector({protoParticle});
 
     return (this->CreatePfos(protoParticleVector));
 }

bool lar_content::TwoViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold ( const pandora::Cluster *const pCluster ) const

privatevirtual

To check whether a given cluster meets the requirements to be added into the matching container (tensor/matrix)

Parameters

pCluster the address of the input cluster

Returns: whether the checks were met

Implements lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >.

Definition at line 67 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     return (pCluster->GetNCaloHits() >= m_minClusterCaloHits);
 }

void lar_content::TwoViewDeltaRayMatchingAlgorithm::ExamineOverlapContainer ( )

privatevirtual

Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required.

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 403 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     // Apply tools sequentially restarting if a change is made and ending if the tools finish or the restart limit is reached
     unsigned int repeatCounter(0);
 
     for (auto toolIter = m_algorithmToolVector.begin(); toolIter != m_algorithmToolVector.end();)
     {
         DeltaRayMatrixTool *const pTool(*toolIter);
         const bool repeatTools(pTool->Run(this, this->GetMatchingControl().GetOverlapMatrix()));
 
         toolIter = repeatTools ? m_algorithmToolVector.begin() : toolIter + 1;
         repeatCounter = repeatTools ? repeatCounter + 1 : repeatCounter;
 
         if (repeatCounter > m_nMaxMatrixToolRepeats)
             break;
     }
 }

void lar_content::TwoViewDeltaRayMatchingAlgorithm::FindCommonMuonParents	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		pandora::PfoList &	commonMuonPfoList
	)		const

private

Find the cosmic ray pfos that, in each view, lie close to the clusters of the matrix element.

Parameters

pCluster1	the cluster from the first input view
pCluster2	the cluster from the second input view
commonMuonPfoList	the output list of common cosmic ray pfos

Definition at line 143 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     ClusterList consideredClusters1, consideredClusters2;
     PfoList nearbyMuonPfos1, nearbyMuonPfos2;
 
     this->GetNearbyMuonPfos(pCluster1, consideredClusters1, nearbyMuonPfos1);
 
     if (nearbyMuonPfos1.empty())
         return;
 
     this->GetNearbyMuonPfos(pCluster2, consideredClusters2, nearbyMuonPfos2);
 
     if (nearbyMuonPfos2.empty())
         return;
 
     for (const ParticleFlowObject *const pNearbyMuon1 : nearbyMuonPfos1)
     {
         for (const ParticleFlowObject *const pNearbyMuon2 : nearbyMuonPfos2)
         {
             if (pNearbyMuon1 == pNearbyMuon2)
                 commonMuonPfoList.push_back(pNearbyMuon1);
         }
     }
 }

void lar_content::TwoViewDeltaRayMatchingAlgorithm::FormThirdViewCluster	(	const MatrixType::Element &	element,
		ProtoParticle &	protoParticle
	)

private

Form the third view cluster by removing hits from cosmic ray clusters and merging the matched clusters where appropriate.

Parameters

element	the matrix element
protoParticle	the output proto particle

Definition at line 260 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     const PfoList &commonMuonPfoList(element.GetOverlapResult().GetCommonMuonPfoList());
     const Cluster *const pBestMatchedCluster(element.GetOverlapResult().GetBestMatchedCluster());
     const HitType thirdViewHitType(LArClusterHelper::GetClusterHitType(pBestMatchedCluster));
     const ParticleFlowObject *pMatchedMuonPfo(nullptr);
 
     for (const ParticleFlowObject *const pMuonPfo : commonMuonPfoList)
     {
         ClusterList muonClusterList;
         LArPfoHelper::GetClusters(pMuonPfo, thirdViewHitType, muonClusterList);
 
         if (std::find(muonClusterList.begin(), muonClusterList.end(), pBestMatchedCluster) != muonClusterList.end())
             pMatchedMuonPfo = pMuonPfo;
     }
 
     const Cluster *pThirdViewCluster(pMatchedMuonPfo ? nullptr : pBestMatchedCluster);
 
     if (pMatchedMuonPfo)
     {
         CaloHitList deltaRayHitList;
 
         if (this->CollectHitsFromMuon(element.GetCluster1(), element.GetCluster2(), nullptr, pMatchedMuonPfo, m_minDistanceFromMuon,
                 m_maxDistanceToCollected, deltaRayHitList) == STATUS_CODE_SUCCESS)
         {
             this->SplitMuonCluster(this->GetThirdViewClusterListName(), pBestMatchedCluster, deltaRayHitList, pThirdViewCluster);
             this->UpdateForThirdViewClusterModification(pBestMatchedCluster, true);
         }
         else
         {
             pThirdViewCluster = element.GetOverlapResult().GetBestMatchedAvailableCluster();
         }
     }
 
     if (!pThirdViewCluster)
         return;
 
     this->UpdateForThirdViewClusterModification(pThirdViewCluster, false);
     this->MergeThirdView(element, pThirdViewCluster);
 
     protoParticle.m_clusterList.push_back(pThirdViewCluster);
 }

const Cluster * lar_content::TwoViewDeltaRayMatchingAlgorithm::GetBestMatchedCluster	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::PfoList &	commonMuonPfoList,
		const pandora::ClusterList &	matchedClusters,
		float &	reducedChiSquared
	)		const

private

Determine the best matched third view cluster and calculate the reduced chi-squared value of the three cluster match.

Parameters

pCluster1	the cluster from the first input view
pCluster2	the cluster from the second input view
commonMuonPfoList	the list of common cosmic ray pfos
matchedClusters	the list of third view matched clusters
reducedChiSquared	to receive the calculated reduced chi-squared value

Returns: the address of the best matched third view cluster

Definition at line 199 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     const Cluster *pBestMatchedCluster(nullptr);
 
     if (matchedClusters.empty())
         return pBestMatchedCluster;
 
     const HitType thirdViewHitType(LArClusterHelper::GetClusterHitType(matchedClusters.front()));
     ClusterList muonClusterList;
 
     for (const ParticleFlowObject *const pMuonPfo : commonMuonPfoList)
         LArPfoHelper::GetClusters(pMuonPfo, thirdViewHitType, muonClusterList);
 
     unsigned int highestNHits(0);
 
     for (const Cluster *const pMatchedCluster : matchedClusters)
     {
         if (!pMatchedCluster->IsAvailable())
         {
             if (std::find(muonClusterList.begin(), muonClusterList.end(), pMatchedCluster) == muonClusterList.end())
                 continue;
         }
 
         if (pMatchedCluster->GetNCaloHits() > highestNHits)
         {
             highestNHits = pMatchedCluster->GetNCaloHits();
             pBestMatchedCluster = pMatchedCluster;
         }
     }
 
     if (!pBestMatchedCluster)
         return pBestMatchedCluster;
 
     if (this->PerformThreeViewMatching(pCluster1, pCluster2, pBestMatchedCluster, reducedChiSquared) == STATUS_CODE_NOT_FOUND)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     return pBestMatchedCluster;
 }

const Cluster * lar_content::TwoViewDeltaRayMatchingAlgorithm::GetCluster	(	const MatrixType::Element &	element,
		const pandora::HitType	hitType
	)

Get the address of the given hit type cluster.

Parameters

hitType hit type of the required cluster

Returns: address of the required cluster

Definition at line 55 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     const unsigned int hitTypeIndex(this->GetMatchingControl().GetHitTypeIndex(hitType));
 
     if ((hitTypeIndex != 1) && (hitTypeIndex != 2))
         return element.GetOverlapResult().GetBestMatchedAvailableCluster();
 
     return hitTypeIndex == 1 ? element.GetCluster1() : element.GetCluster2();
 }

const std::string & lar_content::TwoViewDeltaRayMatchingAlgorithm::GetClusteringAlgName ( ) const

inline

Get the name of the clustering algorithm to be used to recluster created delta ray remnants.

Returns: the clustering algorithm name

Definition at line 188 of file TwoViewDeltaRayMatchingAlgorithm.h.

 {
     return m_reclusteringAlgorithmName;
 }

TwoViewDeltaRayMatchingAlgorithm::HitTypeVector lar_content::TwoViewDeltaRayMatchingAlgorithm::GetHitTypeVector ( )

Obtain the HitTypeVector of input views.

Returns: the HitTypeVector of input views

Definition at line 36 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     HitTypeVector hitTypeVector;
 
     for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
     {
         const unsigned int hitTypeIndex(this->GetMatchingControl().GetHitTypeIndex(hitType));
 
         if ((hitTypeIndex != 1) && (hitTypeIndex != 2))
             continue;
 
         hitTypeVector.push_back(hitType);
     }
 
     return hitTypeVector;
 }

const std::string & lar_content::TwoViewDeltaRayMatchingAlgorithm::GetThirdViewClusterListName ( ) const

inline

Get the name of the third view clusters.

Returns: the third view cluster list name

Definition at line 181 of file TwoViewDeltaRayMatchingAlgorithm.h.

 {
     return m_inputClusterListName;
 }

void lar_content::TwoViewDeltaRayMatchingAlgorithm::MergeThirdView	(	const MatrixType::Element &	element,
		const pandora::Cluster *const	pSeedCluster
	)

private

Starting with an input seed cluster, sequentially merge in matched clusters that retain a good reduced chi-squared.

Parameters

element	the matrix element
pSeedCluster	the address of the input seed cluster

Definition at line 305 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     CaloHitList caloHitList1, caloHitList2;
     element.GetCluster1()->GetOrderedCaloHitList().FillCaloHitList(caloHitList1);
     element.GetCluster2()->GetOrderedCaloHitList().FillCaloHitList(caloHitList2);
 
     // ATTN: Need copy as original will change throughout function
     ClusterList matchedClusters(element.GetOverlapResult().GetMatchedClusterList());
 
     ClusterSet checkedClusters;
 
     if (std::find(matchedClusters.begin(), matchedClusters.end(), pSeedCluster) != matchedClusters.end())
         checkedClusters.insert(pSeedCluster);
 
     while (checkedClusters.size() != matchedClusters.size())
     {
         const Cluster *pClusterToDelete(nullptr);
         unsigned int highestHit(0);
 
         for (const Cluster *const pMatchedCluster : matchedClusters)
         {
             if (checkedClusters.count(pMatchedCluster))
                 continue;
 
             if (pMatchedCluster->GetNCaloHits() > highestHit)
             {
                 pClusterToDelete = pMatchedCluster;
                 highestHit = pMatchedCluster->GetNCaloHits();
             }
         }
 
         if (!pClusterToDelete)
             return;
 
         checkedClusters.insert(pClusterToDelete);
 
         if (!pClusterToDelete->IsAvailable())
             continue;
 
         CaloHitList caloHitList3;
         pSeedCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList3);
         pClusterToDelete->GetOrderedCaloHitList().FillCaloHitList(caloHitList3);
 
         float reducedChiSquared(std::numeric_limits<float>::max());
         const StatusCode status(this->PerformThreeViewMatching(caloHitList1, caloHitList2, caloHitList3, reducedChiSquared));
 
         if (status == STATUS_CODE_NOT_FOUND)
             continue;
 
         if (reducedChiSquared > m_maxGoodMatchReducedChiSquared)
             continue;
 
         this->UpdateForThirdViewClusterModification(pClusterToDelete, false);
 
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Cluster>(*this, this->GetThirdViewClusterListName()));
 
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pSeedCluster, pClusterToDelete));
     }
 }

StatusCode lar_content::TwoViewDeltaRayMatchingAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Reimplemented from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >.

Definition at line 423 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListName", m_inputClusterListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithm(*this, xmlHandle, "ClusterRebuilding", m_reclusteringAlgorithmName));
 
     AlgorithmToolVector algorithmToolVector;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "DeltaRayTools", algorithmToolVector));
 
     for (auto algorithmTool : algorithmToolVector)
     {
         DeltaRayMatrixTool *const pDeltaRayMatrixTool(dynamic_cast<DeltaRayMatrixTool *>(algorithmTool));
 
         if (!pDeltaRayMatrixTool)
             return STATUS_CODE_INVALID_PARAMETER;
 
         m_algorithmToolVector.push_back(pDeltaRayMatrixTool);
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NMaxMatrixToolRepeats", m_nMaxMatrixToolRepeats));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterCaloHits", m_minClusterCaloHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxDistanceFromPrediction", m_maxDistanceFromPrediction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxGoodMatchReducedChiSquared", m_maxGoodMatchReducedChiSquared));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinDistanceFromMuon", m_minDistanceFromMuon));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxDistanceToCollected", m_maxDistanceToCollected));
 
     return BaseAlgorithm::ReadSettings(xmlHandle);
 }

void lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification	(	const pandora::Cluster *const	pModifiedCluster,
		const bool	isMuon
	)

Update the matrix after a third view cluster modification - remove delta ray clusters and reassess the matching of cosmic ray clusters.

Parameters

pModifiedCluster	the address of the modified cluster
isMuon	whether the modified cluster belongs to a cosmic ray pfo

Definition at line 367 of file TwoViewDeltaRayMatchingAlgorithm.cc.

 {
     auto &theMatrix(this->GetMatchingControl().GetOverlapMatrix());
 
     for (auto [pCluster1, overlapList] : theMatrix)
     {
         for (auto [pCluster2, overlapResult] : overlapList)
         {
             ClusterList matchedClusters(overlapResult.GetMatchedClusterList());
 
             auto matchedClustersIter(std::find(matchedClusters.begin(), matchedClusters.end(), pModifiedCluster));
 
             if (matchedClustersIter == matchedClusters.end())
                 continue;
 
             float tempReducedChiSquared(std::numeric_limits<float>::max());
 
             if (isMuon)
                 this->PerformThreeViewMatching(pCluster1, pCluster2, pModifiedCluster, tempReducedChiSquared);
 
             if (tempReducedChiSquared > m_maxGoodMatchReducedChiSquared)
                 matchedClusters.erase(matchedClustersIter);
 
             float reducedChiSquared(std::numeric_limits<float>::max());
             const Cluster *const pBestMatchedCluster =
                 this->GetBestMatchedCluster(pCluster1, pCluster2, overlapResult.GetCommonMuonPfoList(), matchedClusters, reducedChiSquared);
 
             TwoViewDeltaRayOverlapResult newOverlapResult(
                 overlapResult.GetXOverlap(), overlapResult.GetCommonMuonPfoList(), pBestMatchedCluster, matchedClusters, reducedChiSquared);
             theMatrix.ReplaceOverlapResult(pCluster1, pCluster2, newOverlapResult);
         }
     }
 }

Member Data Documentation

MatrixToolVector lar_content::TwoViewDeltaRayMatchingAlgorithm::m_algorithmToolVector

private

The algorithm tool vector.

Definition at line 170 of file TwoViewDeltaRayMatchingAlgorithm.h.

std::string lar_content::TwoViewDeltaRayMatchingAlgorithm::m_inputClusterListName

private

The name of the cluster list in the view in which to project into.

Definition at line 168 of file TwoViewDeltaRayMatchingAlgorithm.h.

float lar_content::TwoViewDeltaRayMatchingAlgorithm::m_maxDistanceFromPrediction

private

The maximum distance of a matched cluster from the third view projection points.

Definition at line 173 of file TwoViewDeltaRayMatchingAlgorithm.h.

float lar_content::TwoViewDeltaRayMatchingAlgorithm::m_maxDistanceToCollected

private

The maximim distance of a hit from the projected delta ray hits required for removal.

Definition at line 176 of file TwoViewDeltaRayMatchingAlgorithm.h.

float lar_content::TwoViewDeltaRayMatchingAlgorithm::m_maxGoodMatchReducedChiSquared

private

The maximum reduced chi squared value of a good 1:1:1 match.

Definition at line 174 of file TwoViewDeltaRayMatchingAlgorithm.h.

unsigned int lar_content::TwoViewDeltaRayMatchingAlgorithm::m_minClusterCaloHits

private

The threshold number of hits for a cluster to be considered.

Definition at line 172 of file TwoViewDeltaRayMatchingAlgorithm.h.

float lar_content::TwoViewDeltaRayMatchingAlgorithm::m_minDistanceFromMuon

private

The minimum distance of a hit from the cosmic ray track required for removal.

Definition at line 175 of file TwoViewDeltaRayMatchingAlgorithm.h.

unsigned int lar_content::TwoViewDeltaRayMatchingAlgorithm::m_nMaxMatrixToolRepeats

private

The maximum number of repeat loops over matrix tools.

Definition at line 171 of file TwoViewDeltaRayMatchingAlgorithm.h.

std::string lar_content::TwoViewDeltaRayMatchingAlgorithm::m_reclusteringAlgorithmName

private

The name of the clustering algorithm to be used to recluster created delta ray remnants.

Definition at line 169 of file TwoViewDeltaRayMatchingAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/TwoViewDeltaRayMatchingAlgorithm.h
larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/TwoViewDeltaRayMatchingAlgorithm.cc

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation