CosmicRayExtensionAlgorithm class. More...

#include <CosmicRayExtensionAlgorithm.h>

Inheritance diagram for lar_content::CosmicRayExtensionAlgorithm:

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

Private Member Functions
void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &clusterVector) const
	Populate cluster vector with subset of cluster list, containing clusters judged to be clean. More...

void	FillClusterAssociationMatrix (const pandora::ClusterVector &clusterVector, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Fill the cluster association matrix. More...

void	FillClusterMergeMap (const ClusterAssociationMatrix &clusterAssociationMatrix, ClusterMergeMap &clusterMergeMap) const
	Fill the cluster merge map. More...

void	FillClusterAssociationMatrix (const LArPointingCluster &clusterI, const LArPointingCluster &clusterJ, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Form association between two pointing clusters. More...

float	CalculateRms (const pandora::Cluster *const pCluster, const pandora::CartesianVector &position, const pandora::CartesianVector &direction) const
	Calculate RMS deviation of a cluster with respect to the reference line. More...

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

Private Attributes
float	m_minClusterLength

float	m_minSeedClusterLength

float	m_maxLongitudinalDisplacement

float	m_maxTransverseDisplacement

float	m_minCosRelativeAngle

float	m_maxAverageRms

Additional Inherited Members
Protected Types inherited from lar_content::ClusterExtensionAlgorithm
typedef std::unordered_map < const pandora::Cluster *, ClusterAssociation >	ClusterAssociationMap

typedef std::unordered_map < const pandora::Cluster *, ClusterAssociationMap >	ClusterAssociationMatrix

Protected Types inherited from lar_content::ClusterMergingAlgorithm
typedef std::unordered_map < const pandora::Cluster *, pandora::ClusterList >	ClusterMergeMap

Protected Member Functions inherited from lar_content::ClusterExtensionAlgorithm
void	PopulateClusterMergeMap (const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMatrix) const
	Form associations between pointing clusters. More...

Protected Member Functions inherited from lar_content::ClusterMergingAlgorithm
virtual pandora::StatusCode	Run ()

void	MergeClusters (pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const
	Merge associated clusters. More...

void	CollectAssociatedClusters (const pandora::Cluster *const pSeedCluster, const ClusterMergeMap &clusterMergeMap, pandora::ClusterList &associatedClusterList) const
	Collect up all clusters associations related to a given seed cluster. More...

void	CollectAssociatedClusters (const pandora::Cluster const pSeedCluster, const pandora::Cluster const pCurrentCluster, const ClusterMergeMap &clusterMergeMap, const pandora::ClusterSet &clusterVetoList, pandora::ClusterList &associatedClusterList) const
	Collect up all clusters associations related to a given seed cluster. More...

void	GetSortedListOfCleanClusters (const pandora::ClusterVector &inputClusters, pandora::ClusterVector &outputClusters) const
	Sort the selected clusters, so that they have a well-defined ordering. More...

Protected Attributes inherited from lar_content::ClusterMergingAlgorithm
std::string	m_inputClusterListName
	The name of the input cluster list. If not specified, will access current list. More...

Detailed Description

CosmicRayExtensionAlgorithm class.

Definition at line 23 of file CosmicRayExtensionAlgorithm.h.

Constructor & Destructor Documentation

lar_content::CosmicRayExtensionAlgorithm::CosmicRayExtensionAlgorithm ( )

Default constructor.

Definition at line 21 of file CosmicRayExtensionAlgorithm.cc.

                                                          :
     m_minClusterLength(3.f),
     m_minSeedClusterLength(6.f),
     m_maxLongitudinalDisplacement(30.f),
     m_maxTransverseDisplacement(2.f),
     m_minCosRelativeAngle(0.966f),
     m_maxAverageRms(1.f)
 {
 }

Member Function Documentation

float lar_content::CosmicRayExtensionAlgorithm::CalculateRms	(	const pandora::Cluster *const	pCluster,
		const pandora::CartesianVector &	position,
		const pandora::CartesianVector &	direction
	)		const

private

Calculate RMS deviation of a cluster with respect to the reference line.

Parameters

pCluster	the input cluster
position	the intercept of the reference line
direction	the direction of the reference line

Definition at line 346 of file CosmicRayExtensionAlgorithm.cc.

 {
     float totalChi2(0.f);
     float totalHits(0.f);
 
     CaloHitList caloHitList;
     pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     for (CaloHitList::const_iterator iter = caloHitList.begin(), iterEnd = caloHitList.end(); iter != iterEnd; ++iter)
     {
         const CaloHit *const pCaloHit = *iter;
 
         const CartesianVector hitPosition(pCaloHit->GetPositionVector());
         const CartesianVector predictedPosition(position + direction * direction.GetDotProduct(hitPosition - position));
 
         totalChi2 += (predictedPosition - hitPosition).GetMagnitudeSquared();
         totalHits += 1.f;
     }
 
     if (totalHits > 0.f)
         return std::sqrt(totalChi2 / totalHits);
 
     return 0.f;
 }

void lar_content::CosmicRayExtensionAlgorithm::FillClusterAssociationMatrix	(	const pandora::ClusterVector &	clusterVector,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

privatevirtual

Fill the cluster association matrix.

Parameters

clusterVector	the input vector of clusters
clusterAssociationMatrix	the matrix of associations

Implements lar_content::ClusterExtensionAlgorithm.

void lar_content::CosmicRayExtensionAlgorithm::FillClusterAssociationMatrix	(	const LArPointingCluster &	clusterI,
		const LArPointingCluster &	clusterJ,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

private

Form association between two pointing clusters.

Parameters

clusterI	the first pointing cluster
clusterJ	the second pointing cluster
clusterAssociationMatrix	the matrix of cluster associations

Definition at line 85 of file CosmicRayExtensionAlgorithm.cc.

 {
     const Cluster *const pClusterI(clusterI.GetCluster());
     const Cluster *const pClusterJ(clusterJ.GetCluster());
 
     if (pClusterI == pClusterJ)
         return;
 
     // Get closest pair of vertices
     LArPointingCluster::Vertex clusterVertexI, clusterVertexJ;
 
     try
     {
         LArPointingClusterHelper::GetClosestVertices(clusterI, clusterJ, clusterVertexI, clusterVertexJ);
     }
     catch (StatusCodeException &)
     {
         return;
     }
 
     // (Just in case...)
     if (!(clusterVertexI.IsInitialized() && clusterVertexJ.IsInitialized()))
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     const CartesianVector vertexI(clusterVertexI.GetPosition());
     const CartesianVector vertexJ(clusterVertexJ.GetPosition());
 
     const CartesianVector endI(clusterVertexI.IsInnerVertex() ? clusterI.GetOuterVertex().GetPosition() : clusterI.GetInnerVertex().GetPosition());
     const CartesianVector endJ(clusterVertexJ.IsInnerVertex() ? clusterJ.GetOuterVertex().GetPosition() : clusterJ.GetInnerVertex().GetPosition());
 
     // Requirements on length
     const float lengthSquaredI(LArPointingClusterHelper::GetLengthSquared(clusterI));
     const float lengthSquaredJ(LArPointingClusterHelper::GetLengthSquared(clusterJ));
 
     if (std::max(lengthSquaredI, lengthSquaredJ) < m_minSeedClusterLength * m_minSeedClusterLength)
         return;
 
     // Requirements on proximity
     const float distanceSquaredIJ((vertexI - vertexJ).GetMagnitudeSquared());
 
     if (distanceSquaredIJ > m_maxLongitudinalDisplacement * m_maxLongitudinalDisplacement)
         return;
 
     // Requirements on pointing information
     const CartesianVector directionI((endI - vertexI).GetUnitVector());
     const CartesianVector directionJ((endJ - vertexJ).GetUnitVector());
 
     const float cosTheta(-directionI.GetDotProduct(directionJ));
     const float cosThetaCut(-1.f + 2.f * m_minCosRelativeAngle);
 
     if (cosTheta < cosThetaCut)
         return;
 
     // Requirements on overlap between clusters
     const CartesianVector directionIJ((endJ - endI).GetUnitVector());
     const CartesianVector directionJI((endI - endJ).GetUnitVector());
 
     const float overlapL(directionIJ.GetDotProduct(vertexJ - vertexI));
     const float overlapT(directionIJ.GetCrossProduct(vertexJ - vertexI).GetMagnitude());
 
     if (overlapL < -1.f || overlapL * overlapL > 2.f * std::min(lengthSquaredI, lengthSquaredJ) ||
         overlapT > m_maxTransverseDisplacement + std::fabs(overlapL) * std::tan(5.f * M_PI / 180.f))
         return;
 
     // Calculate RMS deviations on composite cluster
     const float rms1(this->CalculateRms(pClusterI, endI, directionIJ));
     const float rms2(this->CalculateRms(pClusterJ, endJ, directionJI));
 
     const float rms(0.5f * (rms1 + rms2));
     const float rmsCut(2.f * m_maxAverageRms * (cosTheta - cosThetaCut) / (1.0 - cosThetaCut));
 
     if (rms > rmsCut)
         return;
 
     // Record the association
     const ClusterAssociation::VertexType vertexTypeI(clusterVertexI.IsInnerVertex() ? ClusterAssociation::INNER : ClusterAssociation::OUTER);
     const ClusterAssociation::VertexType vertexTypeJ(clusterVertexJ.IsInnerVertex() ? ClusterAssociation::INNER : ClusterAssociation::OUTER);
     const ClusterAssociation::AssociationType associationType(ClusterAssociation::STRONG);
 
     (void)clusterAssociationMatrix[pClusterI].insert(
         ClusterAssociationMap::value_type(pClusterJ, ClusterAssociation(vertexTypeI, vertexTypeJ, associationType, lengthSquaredJ)));
 
     (void)clusterAssociationMatrix[pClusterJ].insert(
         ClusterAssociationMap::value_type(pClusterI, ClusterAssociation(vertexTypeJ, vertexTypeI, associationType, lengthSquaredI)));
 }

void lar_content::CosmicRayExtensionAlgorithm::FillClusterMergeMap	(	const ClusterAssociationMatrix &	clusterAssociationMatrix,
		ClusterMergeMap &	clusterMergeMap
	)		const

privatevirtual

Fill the cluster merge map.

Parameters

clusterAssociationMatrix	the matrix of cluster associations
clusterMergeMap	the map of cluster merges

Implements lar_content::ClusterExtensionAlgorithm.

Definition at line 174 of file CosmicRayExtensionAlgorithm.cc.

 {
     // Decide which associations will become merges
     // To make the merge A <-> B, both A -> B and B -> A must be strong associations
     // with the largest figures of merit of all the A -> X and B -> Y associations
 
     // First step: remove double-counting from the map of associations
     // i.e. if the map has A <-> B, B <-> C, A <-> C, then remove A <-> C
     ClusterAssociationMatrix clusterAssociationMatrix;
 
     ClusterVector sortedInputClusters;
     for (const auto &mapEntry : inputAssociationMatrix)
         sortedInputClusters.push_back(mapEntry.first);
     std::sort(sortedInputClusters.begin(), sortedInputClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster1 : sortedInputClusters)
     {
         const ClusterAssociationMap &associationMap1(inputAssociationMatrix.at(pCluster1));
 
         for (const Cluster *const pCluster2 : sortedInputClusters)
         {
             if (pCluster1 == pCluster2)
                 continue;
 
             const ClusterAssociationMap &associationMap2(inputAssociationMatrix.at(pCluster2));
 
             ClusterAssociationMap::const_iterator iter12 = associationMap1.find(pCluster2);
             if (associationMap1.end() == iter12)
                 continue;
 
             ClusterAssociationMap::const_iterator iter21 = associationMap2.find(pCluster1);
             if (associationMap2.end() == iter21)
                 continue;
 
             const ClusterAssociation &association12(iter12->second);
             const ClusterAssociation &association21(iter21->second);
 
             bool isAssociated(true);
 
             ClusterVector sortedAssociationClusters;
             for (const auto &mapEntry : associationMap1)
                 sortedAssociationClusters.push_back(mapEntry.first);
             std::sort(sortedAssociationClusters.begin(), sortedAssociationClusters.end(), LArClusterHelper::SortByNHits);
 
             for (const Cluster *const pCluster3 : sortedAssociationClusters)
             {
                 const ClusterAssociation &association13(associationMap1.at(pCluster3));
 
                 ClusterAssociationMap::const_iterator iter23 = associationMap2.find(pCluster3);
                 if (associationMap2.end() == iter23)
                     continue;
 
                 const ClusterAssociation &association23(iter23->second);
 
                 if (association12.GetParent() == association13.GetParent() && association23.GetParent() == association21.GetParent() &&
                     association13.GetDaughter() != association23.GetDaughter())
                 {
                     isAssociated = false;
                     break;
                 }
             }
 
             if (isAssociated)
             {
                 (void)clusterAssociationMatrix[pCluster1].insert(ClusterAssociationMap::value_type(pCluster2, association12));
                 (void)clusterAssociationMatrix[pCluster2].insert(ClusterAssociationMap::value_type(pCluster1, association21));
             }
         }
     }
 
     // Second step: find the best associations A -> X and B -> Y
     ClusterAssociationMatrix intermediateAssociationMatrix;
 
     ClusterVector sortedClusters;
     for (const auto &mapEntry : clusterAssociationMatrix)
         sortedClusters.push_back(mapEntry.first);
     std::sort(sortedClusters.begin(), sortedClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : sortedClusters)
     {
         const ClusterAssociationMap &clusterAssociationMap(clusterAssociationMatrix.at(pParentCluster));
 
         const Cluster *pBestClusterInner(nullptr);
         ClusterAssociation bestAssociationInner(ClusterAssociation::UNDEFINED, ClusterAssociation::UNDEFINED, ClusterAssociation::NONE, 0.f);
 
         const Cluster *pBestClusterOuter(nullptr);
         ClusterAssociation bestAssociationOuter(ClusterAssociation::UNDEFINED, ClusterAssociation::UNDEFINED, ClusterAssociation::NONE, 0.f);
 
         ClusterVector sortedAssociationClusters;
         for (const auto &mapEntry : clusterAssociationMap)
             sortedAssociationClusters.push_back(mapEntry.first);
         std::sort(sortedAssociationClusters.begin(), sortedAssociationClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : sortedAssociationClusters)
         {
             const ClusterAssociation &clusterAssociation(clusterAssociationMap.at(pDaughterCluster));
 
             // Inner associations
             if (clusterAssociation.GetParent() == ClusterAssociation::INNER)
             {
                 if (clusterAssociation.GetFigureOfMerit() > bestAssociationInner.GetFigureOfMerit())
                 {
                     bestAssociationInner = clusterAssociation;
                     pBestClusterInner = pDaughterCluster;
                 }
             }
 
             // Outer associations
             if (clusterAssociation.GetParent() == ClusterAssociation::OUTER)
             {
                 if (clusterAssociation.GetFigureOfMerit() > bestAssociationOuter.GetFigureOfMerit())
                 {
                     bestAssociationOuter = clusterAssociation;
                     pBestClusterOuter = pDaughterCluster;
                 }
             }
         }
 
         if (pBestClusterInner)
             (void)intermediateAssociationMatrix[pParentCluster].insert(ClusterAssociationMap::value_type(pBestClusterInner, bestAssociationInner));
 
         if (pBestClusterOuter)
             (void)intermediateAssociationMatrix[pParentCluster].insert(ClusterAssociationMap::value_type(pBestClusterOuter, bestAssociationOuter));
     }
 
     // Third step: make the merge if A -> X and B -> Y is in fact A -> B and B -> A
     ClusterVector intermediateSortedClusters;
     for (const auto &mapEntry : intermediateAssociationMatrix)
         intermediateSortedClusters.push_back(mapEntry.first);
     std::sort(intermediateSortedClusters.begin(), intermediateSortedClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : intermediateSortedClusters)
     {
         const ClusterAssociationMap &parentAssociationMap(intermediateAssociationMatrix.at(pParentCluster));
 
         ClusterVector sortedAssociationClusters;
         for (const auto &mapEntry : parentAssociationMap)
             sortedAssociationClusters.push_back(mapEntry.first);
         std::sort(sortedAssociationClusters.begin(), sortedAssociationClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : sortedAssociationClusters)
         {
             const ClusterAssociation &parentToDaughterAssociation(parentAssociationMap.at(pDaughterCluster));
 
             ClusterAssociationMatrix::const_iterator iter5 = intermediateAssociationMatrix.find(pDaughterCluster);
 
             if (intermediateAssociationMatrix.end() == iter5)
                 continue;
 
             const ClusterAssociationMap &daughterAssociationMap(iter5->second);
 
             ClusterAssociationMap::const_iterator iter6 = daughterAssociationMap.find(pParentCluster);
 
             if (daughterAssociationMap.end() == iter6)
                 continue;
 
             const ClusterAssociation &daughterToParentAssociation(iter6->second);
 
             if (parentToDaughterAssociation.GetParent() == daughterToParentAssociation.GetDaughter() &&
                 parentToDaughterAssociation.GetDaughter() == daughterToParentAssociation.GetParent())
             {
                 ClusterList &parentList(clusterMergeMap[pParentCluster]);
 
                 if (parentList.end() == std::find(parentList.begin(), parentList.end(), pDaughterCluster))
                     parentList.push_back(pDaughterCluster);
             }
         }
     }
 }

void lar_content::CosmicRayExtensionAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

privatevirtual

Populate cluster vector with subset of cluster list, containing clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
clusterVector	to receive the populated cluster vector

Implements lar_content::ClusterMergingAlgorithm.

Definition at line 33 of file CosmicRayExtensionAlgorithm.cc.

 {
     for (ClusterList::const_iterator iter = pClusterList->begin(), iterEnd = pClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (LArClusterHelper::GetLengthSquared(pCluster) < m_minClusterLength * m_minClusterLength)
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 373 of file CosmicRayExtensionAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterLength", m_minClusterLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinSeedClusterLength", m_minSeedClusterLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxLongitudinalDisplacement", m_maxLongitudinalDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxTransverseDisplacement", m_maxTransverseDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinCosRelativeAngle", m_minCosRelativeAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxAverageRms", m_maxAverageRms));
 
     return ClusterExtensionAlgorithm::ReadSettings(xmlHandle);
 }