#include <DeltaRayMergeTool.h>

Inheritance diagram for lar_content::DeltaRayMergeTool:

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

Private Member Functions
bool	Run (ThreeViewDeltaRayMatchingAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

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

bool	ExamineConnectedElements (TensorType &overlapTensor) const
	Identify ambiguous matches (e.g. 3:2:1) and attempt to merge clusters together. More...

bool	MakeTwoCommonViewMerges (const TensorType::ElementList &elementList) const
	Search for two matches with two common clusters and attempt to merge the clusters in the third view together. More...

void	CombineCommonMuonPfoLists (const pandora::PfoList &commonMuonPfoList1, const pandora::PfoList &commonMuonPfoList2, pandora::PfoList &commonMuonPfoList) const
	Create a list of the shared common muon pfos of two elements. More...

bool	AreAssociated (const TensorType::Element &element1, const TensorType::Element &element2, const pandora::HitType &mergeHitType) const
	Determine, from a topological point of view, whether two delta ray clusters should be merged together. More...

void	GetConnectedMuons (const pandora::Cluster *const pDeltaRayCluster, const pandora::PfoList &commonMuonPfoList, pandora::PfoList &connectedMuonPfoList) const
	Return the list of muon pfos that a specified delta ray cluster is directly connected to. More...

bool	IsConnected (const pandora::Cluster const pCluster, const pandora::Pfo const pCommonMuonPfo) const
	Determine whether a given cluster is connected to a cosmic ray pfo. More...

bool	IsBrokenCluster (const pandora::Cluster const pClusterToEnlarge, const pandora::Cluster const pClusterToDelete) const
	Determine whether two delta ray clusters have been split. More...

bool	IsHiddenByTrack (const pandora::ParticleFlowObject const pMuonPfo, const pandora::Cluster const pCluster1, const pandora::Cluster *const pCluster2) const
	Determine whether two delta ray clusters are actually a single cluster that is hidden behind a cosmic ray track. More...

void	FindVertices (const pandora::Pfo const pCommonMuonPfo, const pandora::Cluster const pCluster, pandora::CaloHitList &vertexList) const
	Find all connection points of a delta ray cluster and a cosmic ray pfo. More...

bool	MakeOneCommonViewMerges (const TensorType::ElementList &elementList) const
	Search for two matches with a single common cluster and attempt to merge the clusters in the other two views together. More...

Private Attributes
float	m_maxDRSeparationFromTrack
	The maximum distance of a connected delta ray from a cosmic ray track. More...

float	m_maxClusterSeparation
	The maximum separation of two broken clusters that should be merged. More...

float	m_maxVertexSeparation
	The maximum separation of the connection points of two delta ray clusters that are hidden by a CR track and should be merged. More...

float	m_maxGoodMatchReducedChiSquared
	The threshold reduced chi squared value for a potential two view merge to go ahead. More...

Additional Inherited Members
Public Types inherited from lar_content::DeltaRayTensorTool
typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Attributes inherited from lar_content::DeltaRayTensorTool
ThreeViewDeltaRayMatchingAlgorithm *	m_pParentAlgorithm
	Address of the parent matching algorithm. More...

Detailed Description

DeltaRayMergeTool class.

Definition at line 18 of file DeltaRayMergeTool.h.

Constructor & Destructor Documentation

lar_content::DeltaRayMergeTool::DeltaRayMergeTool ( )

Default constructor.

Definition at line 22 of file DeltaRayMergeTool.cc.

                                      :
     m_maxDRSeparationFromTrack(1.5f),
     m_maxClusterSeparation(3.f),
     m_maxVertexSeparation(10.f),
     m_maxGoodMatchReducedChiSquared(1.f)
 {
 }

Member Function Documentation

bool lar_content::DeltaRayMergeTool::AreAssociated	(	const TensorType::Element &	element1,
		const TensorType::Element &	element2,
		const pandora::HitType &	mergeHitType
	)		const

private

Determine, from a topological point of view, whether two delta ray clusters should be merged together.

Parameters

element1	the first tensor element
element2	the second tensor element
mergeHitType	the hit type of the view in which to assess the merge

Returns: whether the clusters are topologically associated

Definition at line 145 of file DeltaRayMergeTool.cc.

 {
     const PfoList &commonMuonPfoList1(element1.GetOverlapResult().GetCommonMuonPfoList());
     const PfoList &commonMuonPfoList2(element2.GetOverlapResult().GetCommonMuonPfoList());
 
     // Demand the elements to have a shared common muon
     PfoList commonMuonPfoList;
     this->CombineCommonMuonPfoLists(commonMuonPfoList1, commonMuonPfoList2, commonMuonPfoList);
 
     if (commonMuonPfoList.empty())
         return false;
 
     const Cluster *const pCluster1(element1.GetCluster(mergeHitType)), *const pCluster2(element2.GetCluster(mergeHitType));
 
     PfoList connectedMuonPfoList1, connectedMuonPfoList2;
     this->GetConnectedMuons(pCluster1, commonMuonPfoList1, connectedMuonPfoList1);
     this->GetConnectedMuons(pCluster2, commonMuonPfoList2, connectedMuonPfoList2);
 
     if (connectedMuonPfoList1.empty() || connectedMuonPfoList2.empty())
         return (this->IsBrokenCluster(pCluster1, pCluster2));
 
     for (const ParticleFlowObject *const pConnectedMuon1 : connectedMuonPfoList1)
     {
         for (const ParticleFlowObject *const pConnectedMuon2 : connectedMuonPfoList2)
         {
             if ((pConnectedMuon1 == pConnectedMuon2) && (this->IsHiddenByTrack(pConnectedMuon1, pCluster1, pCluster2)))
                 return true;
         }
     }
 
     return false;
 }

void lar_content::DeltaRayMergeTool::CombineCommonMuonPfoLists	(	const pandora::PfoList &	commonMuonPfoList1,
		const pandora::PfoList &	commonMuonPfoList2,
		pandora::PfoList &	commonMuonPfoList
	)		const

private

Create a list of the shared common muon pfos of two elements.

Parameters

commonMuonPfoList1	the common muon pfo list of the first element
commonMuonPfoList2	the common muon pfo list of the second element
commonMuonPfoList	the output common muon pfo list

Definition at line 180 of file DeltaRayMergeTool.cc.

 {
     for (const ParticleFlowObject *const pCommonMuonPfo1 : commonMuonPfoList1)
     {
         for (const ParticleFlowObject *const pCommonMuonPfo2 : commonMuonPfoList2)
         {
             if (pCommonMuonPfo1 == pCommonMuonPfo2)
                 commonMuonPfoList.push_back(pCommonMuonPfo1);
         }
     }
 }

bool lar_content::DeltaRayMergeTool::ExamineConnectedElements ( TensorType & overlapTensor ) const

private

Identify ambiguous matches (e.g. 3:2:1) and attempt to merge clusters together.

Parameters

overlapTensor the overlap tensor

Returns: whether any merges have been made

Definition at line 44 of file DeltaRayMergeTool.cc.

 {
     bool mergeMade(false), mergesMade(false), finishedTwoViewMerges(false);
 
     do
     {
         mergeMade = false;
 
         ClusterVector sortedKeyClusters;
         overlapTensor.GetSortedKeyClusters(sortedKeyClusters);
 
         ClusterSet usedKeyClusters;
         for (const Cluster *const pKeyCluster : sortedKeyClusters)
         {
             if (usedKeyClusters.count(pKeyCluster))
                 continue;
 
             TensorType::ElementList elementList;
             overlapTensor.GetConnectedElements(pKeyCluster, true, elementList);
 
             for (const TensorType::Element &element : elementList)
                 usedKeyClusters.insert(element.GetClusterU());
 
             if (elementList.size() < 2)
                 continue;
 
             if (!finishedTwoViewMerges && this->MakeTwoCommonViewMerges(elementList))
             {
                 mergeMade = true;
                 mergesMade = true;
                 break;
             }
 
             finishedTwoViewMerges = true;
 
             if (this->MakeOneCommonViewMerges(elementList))
             {
                 mergeMade = true;
                 mergesMade = true;
                 break;
             }
         }
     } while (mergeMade);
 
     return mergesMade;
 }

void lar_content::DeltaRayMergeTool::FindVertices	(	const pandora::Pfo *const	pCommonMuonPfo,
		const pandora::Cluster *const	pCluster,
		pandora::CaloHitList &	vertexList
	)		const

private

Find all connection points of a delta ray cluster and a cosmic ray pfo.

Parameters

pCommonMuonPfo	the address of the cosmic ray pfo
pCluster	the address of the delta ray cluster
vertexList	the output list of connection points

Definition at line 253 of file DeltaRayMergeTool.cc.

 {
     HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
 
     ClusterList muonClusterList;
     LArPfoHelper::GetClusters(pCommonMuonPfo, hitType, muonClusterList);
 
     if (muonClusterList.size() != 1)
         return;
 
     CaloHitList caloHitList;
     muonClusterList.front()->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         if (LArClusterHelper::GetClosestDistance(pCaloHit->GetPositionVector(), pCluster) < m_maxDRSeparationFromTrack)
             vertexList.push_back(pCaloHit);
     }
 }

void lar_content::DeltaRayMergeTool::GetConnectedMuons	(	const pandora::Cluster *const	pDeltaRayCluster,
		const pandora::PfoList &	commonMuonPfoList,
		pandora::PfoList &	connectedMuonPfoList
	)		const

private

Return the list of muon pfos that a specified delta ray cluster is directly connected to.

Parameters

pDeltaRayCluster	the address of the input delta ray cluster
commonMuonPfoList	the common muon pfo list of the element to which the DR cluster belongs
connectedMuonPfoList	the output list of connected muon pfos

Definition at line 194 of file DeltaRayMergeTool.cc.

 {
     for (const ParticleFlowObject *const pCommonMuonPfo : commonMuonPfoList)
     {
         if (this->IsConnected(pDeltaRayCluster, pCommonMuonPfo))
             connectedMuonPfoList.push_back(pCommonMuonPfo);
     }
 }

bool lar_content::DeltaRayMergeTool::IsBrokenCluster	(	const pandora::Cluster *const	pClusterToEnlarge,
		const pandora::Cluster *const	pClusterToDelete
	)		const

private

Determine whether two delta ray clusters have been split.

Parameters

pClusterToEnlarge	the address of one delta ray cluster
pClusterToDelete	the address of the other delta ray cluster

Returns: whether the clusters have been split

Definition at line 222 of file DeltaRayMergeTool.cc.

 {
     const float clusterSeparation(LArClusterHelper::GetClosestDistance(pClusterToEnlarge, pClusterToDelete));
 
     return clusterSeparation < m_maxClusterSeparation;
 }

bool lar_content::DeltaRayMergeTool::IsConnected	(	const pandora::Cluster *const	pCluster,
		const pandora::Pfo *const	pCommonMuonPfo
	)		const

private

Determine whether a given cluster is connected to a cosmic ray pfo.

Parameters

pCluster	the address of the input cluster
pCommonMuonPfo	the address of the cosmic ray pfo

Returns: whether the cluster is connected to the cosmic ray pfo

Definition at line 205 of file DeltaRayMergeTool.cc.

 {
     HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
 
     ClusterList muonClusterList;
     LArPfoHelper::GetClusters(pCommonMuonPfo, hitType, muonClusterList);
 
     if (muonClusterList.size() != 1)
         return false;
 
     const float separation(LArClusterHelper::GetClosestDistance(pCluster, muonClusterList));
 
     return separation < m_maxDRSeparationFromTrack;
 }

bool lar_content::DeltaRayMergeTool::IsHiddenByTrack	(	const pandora::ParticleFlowObject *const	pMuonPfo,
		const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2
	)		const

private

Determine whether two delta ray clusters are actually a single cluster that is hidden behind a cosmic ray track.

Parameters

pMuonPfo	the address of the cosmic ray pfo
pCluster1	the address of one delta ray cluster
pCluster2	the address of the other delta ray cluster

Returns: whether the delta ray clusters are one delta ray cluster, hidden behind a cosmic ray track

Definition at line 231 of file DeltaRayMergeTool.cc.

 {
     CaloHitList vertices1, vertices2;
     this->FindVertices(pMuonPfo, pCluster1, vertices1);
     this->FindVertices(pMuonPfo, pCluster2, vertices2);
 
     if (vertices1.empty() || vertices2.empty())
         return false;
 
     for (const CaloHit *const pCaloHit : vertices1)
     {
         const float separation(LArClusterHelper::GetClosestDistance(pCaloHit->GetPositionVector(), vertices2));
 
         if (separation < m_maxVertexSeparation)
             return true;
     }
 
     return false;
 }

bool lar_content::DeltaRayMergeTool::MakeOneCommonViewMerges ( const TensorType::ElementList & elementList ) const

private

Search for two matches with a single common cluster and attempt to merge the clusters in the other two views together.

Parameters

elementList the tensor element list

Returns: whether a merge was made

Definition at line 275 of file DeltaRayMergeTool.cc.

 {
     for (auto iter1 = elementList.begin(); iter1 != elementList.end(); ++iter1)
     {
         const TensorType::Element &element1(*iter1);
 
         for (auto iter2 = std::next(iter1); iter2 != elementList.end(); ++iter2)
         {
             const TensorType::Element &element2(*iter2);
 
             for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
             {
                 if (element1.GetCluster(hitType) == element2.GetCluster(hitType))
                 {
                     const HitType mergeHitType1(hitType == TPC_VIEW_U ? TPC_VIEW_V : hitType == TPC_VIEW_V ? TPC_VIEW_W : TPC_VIEW_U);
                     const HitType mergeHitType2(mergeHitType1 == TPC_VIEW_U ? TPC_VIEW_V : mergeHitType1 == TPC_VIEW_V ? TPC_VIEW_W : TPC_VIEW_U);
 
                     const Cluster *pClusterToEnlarge1 = element1.GetCluster(mergeHitType1), *pClusterToDelete1 = element2.GetCluster(mergeHitType1);
                     const Cluster *pClusterToEnlarge2 = element1.GetCluster(mergeHitType2), *pClusterToDelete2 = element2.GetCluster(mergeHitType2);
 
                     if ((pClusterToEnlarge1 == pClusterToDelete1) || (pClusterToEnlarge2 == pClusterToDelete2))
                         continue;
 
                     if (!this->AreAssociated(element1, element2, mergeHitType1))
                         continue;
 
                     if (!this->AreAssociated(element1, element2, mergeHitType2))
                         continue;
 
                     CaloHitList caloHitList1, caloHitList2, caloHitList3;
                     pClusterToEnlarge1->GetOrderedCaloHitList().FillCaloHitList(caloHitList1);
                     pClusterToDelete1->GetOrderedCaloHitList().FillCaloHitList(caloHitList1);
                     pClusterToEnlarge2->GetOrderedCaloHitList().FillCaloHitList(caloHitList2);
                     pClusterToDelete2->GetOrderedCaloHitList().FillCaloHitList(caloHitList2);
                     element1.GetCluster(hitType)->GetOrderedCaloHitList().FillCaloHitList(caloHitList3);
 
                     float reducedChiSquared(std::numeric_limits<float>::max());
                     StatusCode status(m_pParentAlgorithm->PerformThreeViewMatching(caloHitList1, caloHitList2, caloHitList3, reducedChiSquared));
 
                     if (status == STATUS_CODE_NOT_FOUND)
                         continue;
 
                     if (reducedChiSquared < m_maxGoodMatchReducedChiSquared)
                     {
                         m_pParentAlgorithm->UpdateUponDeletion(pClusterToEnlarge1);
                         m_pParentAlgorithm->UpdateUponDeletion(pClusterToDelete1);
 
                         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                             PandoraContentApi::ReplaceCurrentList<Cluster>(*m_pParentAlgorithm, m_pParentAlgorithm->GetClusterListName(mergeHitType1)));
 
                         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                             PandoraContentApi::MergeAndDeleteClusters(*m_pParentAlgorithm, pClusterToEnlarge1, pClusterToDelete1));
 
                         m_pParentAlgorithm->UpdateForNewClusters({pClusterToEnlarge1}, {nullptr});
 
                         m_pParentAlgorithm->UpdateUponDeletion(pClusterToEnlarge2);
                         m_pParentAlgorithm->UpdateUponDeletion(pClusterToDelete2);
 
                         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                             PandoraContentApi::ReplaceCurrentList<Cluster>(*m_pParentAlgorithm, m_pParentAlgorithm->GetClusterListName(mergeHitType2)));
 
                         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                             PandoraContentApi::MergeAndDeleteClusters(*m_pParentAlgorithm, pClusterToEnlarge2, pClusterToDelete2));
 
                         m_pParentAlgorithm->UpdateForNewClusters({pClusterToEnlarge2}, {nullptr});
 
                         return true;
                     }
                 }
             }
         }
     }
 
     return false;
 }

bool lar_content::DeltaRayMergeTool::MakeTwoCommonViewMerges ( const TensorType::ElementList & elementList ) const

private

Search for two matches with two common clusters and attempt to merge the clusters in the third view together.

Parameters

elementList the tensor element list

Returns: whether a merge was made

Definition at line 93 of file DeltaRayMergeTool.cc.

 {
     for (auto iter1 = elementList.begin(); iter1 != elementList.end(); ++iter1)
     {
         const TensorType::Element &element1(*iter1);
 
         for (auto iter2 = std::next(iter1); iter2 != elementList.end(); ++iter2)
         {
             const TensorType::Element &element2(*iter2);
 
             for (const HitType hitType1 : {TPC_VIEW_U, TPC_VIEW_V})
             {
                 if ((element1.GetCluster(hitType1) == element2.GetCluster(hitType1)))
                 {
                     for (const HitType hitType2 : {TPC_VIEW_V, TPC_VIEW_W})
                     {
                         if (hitType1 == hitType2)
                             continue;
 
                         if ((element1.GetCluster(hitType2) == element2.GetCluster(hitType2)))
                         {
                             const HitType mergeHitType(hitType1 == TPC_VIEW_U ? (hitType2 == TPC_VIEW_V ? TPC_VIEW_W : TPC_VIEW_V) : TPC_VIEW_U);
                             const Cluster *pClusterToEnlarge(element1.GetCluster(mergeHitType)), *pClusterToDelete(element2.GetCluster(mergeHitType));
 
                             if (this->AreAssociated(element1, element2, mergeHitType))
                             {
                                 m_pParentAlgorithm->UpdateUponDeletion(pClusterToEnlarge);
                                 m_pParentAlgorithm->UpdateUponDeletion(pClusterToDelete);
 
                                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                                     PandoraContentApi::ReplaceCurrentList<Cluster>(
                                         *m_pParentAlgorithm, m_pParentAlgorithm->GetClusterListName(mergeHitType)));
 
                                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                                     PandoraContentApi::MergeAndDeleteClusters(*m_pParentAlgorithm, pClusterToEnlarge, pClusterToDelete));
 
                                 m_pParentAlgorithm->UpdateForNewClusters({pClusterToEnlarge}, {nullptr});
 
                                 return true;
                             }
                         }
                     }
                 }
             }
         }
     }
 
     return false;
 }

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

private

Definition at line 353 of file DeltaRayMergeTool.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxDRSeparationFromTrack", m_maxDRSeparationFromTrack));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxClusterSeparation", m_maxClusterSeparation));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxVertexSeparation", m_maxVertexSeparation));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxGoodMatchReducedChiSquared", m_maxGoodMatchReducedChiSquared));
 
     return STATUS_CODE_SUCCESS;
 }

bool lar_content::DeltaRayMergeTool::Run	(	ThreeViewDeltaRayMatchingAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

privatevirtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns: whether changes have been made by the tool

Implements lar_content::DeltaRayTensorTool.

Definition at line 32 of file DeltaRayMergeTool.cc.

 {
     m_pParentAlgorithm = pAlgorithm;
 
     if (PandoraContentApi::GetSettings(*m_pParentAlgorithm)->ShouldDisplayAlgorithmInfo())
         std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     return this->ExamineConnectedElements(overlapTensor);
 }

Member Data Documentation

float lar_content::DeltaRayMergeTool::m_maxClusterSeparation

private

The maximum separation of two broken clusters that should be merged.

Definition at line 130 of file DeltaRayMergeTool.h.

float lar_content::DeltaRayMergeTool::m_maxDRSeparationFromTrack

private

The maximum distance of a connected delta ray from a cosmic ray track.

Definition at line 129 of file DeltaRayMergeTool.h.

float lar_content::DeltaRayMergeTool::m_maxGoodMatchReducedChiSquared

private

The threshold reduced chi squared value for a potential two view merge to go ahead.

Definition at line 132 of file DeltaRayMergeTool.h.

float lar_content::DeltaRayMergeTool::m_maxVertexSeparation

private

The maximum separation of the connection points of two delta ray clusters that are hidden by a CR track and should be merged.

Definition at line 131 of file DeltaRayMergeTool.h.

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

larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayMergeTool.h
larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayMergeTool.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation