TrackMergeRefinementAlgorithm class. More...

#include <TrackMergeRefinementAlgorithm.h>

Inheritance diagram for lar_content::TrackMergeRefinementAlgorithm:

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

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

template<typename T >
void	InitialiseContainers (const ClusterList *pClusterList, const T sortFunction, ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const

template<typename T >
void	UpdateContainers (const ClusterList &clustersToAdd, const ClusterList &clustersToDelete, const T sortFunction, ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const

Private Member Functions
pandora::StatusCode	Run ()

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

bool	FindBestClusterAssociation (const pandora::ClusterVector &clusterVector, const SlidingFitResultMapPair &slidingFitResultMapPair, ClusterPairAssociation &clusterAssociation) const
	Find the best cluster association. More...

bool	AreClustersAssociated (const pandora::CartesianVector &upstreamPoint, const pandora::CartesianVector &upstreamDirection, const pandora::CartesianVector &downstreamPoint, const pandora::CartesianVector &downstreamDirection) const
	Whether two clusters are assoicated to one another. More...

void	GetUnavailableProtectedClusters (const ClusterPairAssociation &clusterAssociation, const pandora::ClusterList &createdMainTrackClusters, pandora::ClusterList &unavailableProtectedClusters) const
	Obtain a list of clusters whos hits are protected and cannot be reassigned. More...

bool	AreExtrapolatedHitsNearBoundaries (const pandora::CaloHitVector &extrapolatedHitVector, ClusterAssociation &clusterAssociation) const
	Check the separation of the extremal extrapolated hits with the cluster merge points or, in the case of no hits, the cluster merge point separation. More...

void	ConsiderClusterAssociation (const ClusterPairAssociation &clusterAssociation, pandora::ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const
	Remove the cluster association from the cluster vector so that the same cluster pair is not considered again. More...

const pandora::Cluster *	CreateMainTrack (const ClusterPairAssociation &clusterAssociation, const ClusterToCaloHitListMap &clusterToCaloHitListMap, const pandora::ClusterList *pClusterList, pandora::ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const
	Refine the cluster endpoints and merge together the associated clusters alongside any extrapolated hits. More...

Private Attributes
unsigned int	m_maxLoopIterations
	The maximum number of main loop iterations. More...

float	m_minClusterLengthSum
	The threshold cluster and associated cluster length sum. More...

float	m_minSeparationDistance
	The threshold separation distance between associated clusters. More...

float	m_minDirectionDeviationCosAngle
	The threshold cos opening angle of the associated cluster directions. More...

float	m_maxPredictedMergePointOffset
	The threshold separation distance between the predicted and true cluster merge points. More...

float	m_distanceToLine
	The threshold hit distance of an extrapolated hit from the segment connecting line. More...

float	m_boundaryTolerance
	The maximum allowed distance of an extremal extrapolate hit to a cluster merge point. More...

Additional Inherited Members
Protected Types inherited from lar_content::TrackRefinementBaseAlgorithm
typedef std::pair< TwoDSlidingFitResultMap , TwoDSlidingFitResultMap >	SlidingFitResultMapPair

typedef std::unordered_map< const pandora::Cluster *, pandora::CaloHitList >	ClusterToCaloHitListMap

Protected Member Functions inherited from lar_content::TrackRefinementBaseAlgorithm
template<typename T >
void	InitialiseContainers (const pandora::ClusterList *pClusterList, const T sortFunction, pandora::ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const
	Fill the cluster vector and sliding fit maps with clusters that are determined to be track-like. More...

bool	GetClusterMergingCoordinates (const TwoDSlidingFitResult &clusterMicroFitResult, const TwoDSlidingFitResult &clusterMacroFitResult, const TwoDSlidingFitResult &associatedMacroFitResult, const bool isEndUpstream, pandora::CartesianVector &clusterMergePosition, pandora::CartesianVector &clusterMergeDirection) const
	Get the merging coordinate and direction for an input cluster with respect to an associated cluster. More...

void	GetHitsInBoundingBox (const pandora::CartesianVector &firstCorner, const pandora::CartesianVector &secondCorner, const pandora::ClusterList *const pClusterList, ClusterToCaloHitListMap &clusterToCaloHitListMap, const pandora::ClusterList &unavailableProtectedClusters=pandora::ClusterList(), const float distanceToLine=-1.f) const
	Find the unprotected hits that are contained within a defined box with the option to apply a cut on the distance to the connecting line. More...

bool	IsInBoundingBox (const float minX, const float maxX, const float minZ, const float maxZ, const pandora::CartesianVector &hitPosition) const
	check whether a hit is contained within a defined square region More...

bool	IsCloseToLine (const pandora::CartesianVector &hitPosition, const pandora::CartesianVector &lineStart, const pandora::CartesianVector &lineDirection, const float distanceToLine) const
	Check whether a hit is close to a line. More...

bool	AreExtrapolatedHitsGood (const ClusterToCaloHitListMap &clusterToCaloHitListMap, ClusterAssociation &clusterAssociation) const
	Perform topological checks on the collected hits to ensure no gaps are present. More...

bool	IsNearBoundary (const pandora::CaloHit *const pCaloHit, const pandora::CartesianVector &boundaryPosition2D, const float boundaryTolerance) const
	Check whether a hit is close to a boundary point. More...

bool	IsTrackContinuous (const ClusterAssociation &clusterAssociation, const pandora::CaloHitVector &extrapolatedCaloHitVector) const
	Check whether the extrapolatedCaloHitVector contains a continuous line of hits between the cluster merge points. More...

void	GetTrackSegmentBoundaries (const ClusterAssociation &clusterAssociation, pandora::CartesianPointVector &trackSegmentBoundaries) const
	Obtain the segment boundaries of the connecting line to test whether extrapolated hits are continuous. More...

void	RepositionIfInGap (const pandora::CartesianVector &mergeDirection, pandora::CartesianVector &trackPoint) const
	Move an input position to the higher line gap edge if it lies within a gap. More...

float	DistanceInGap (const pandora::CartesianVector &upstreamPoint, const pandora::CartesianVector &downstreamPoint, const pandora::CartesianVector &connectingLine, pandora::DetectorGapList &consideredGaps) const
	Calculate the track length between two points that lies in gaps. More...

bool	IsInLineSegment (const pandora::CartesianVector &lowerBoundary, const pandora::CartesianVector &upperBoundary, const pandora::CartesianVector &point) const
	Whether a position falls within a specified segment of the cluster connecting line. More...

const pandora::Cluster *	RemoveOffAxisHitsFromTrack (const pandora::Cluster *const pCluster, const pandora::CartesianVector &splitPosition, const bool isEndUpstream, const ClusterToCaloHitListMap &clusterToCaloHitListMap, pandora::ClusterList &remnantClusterList, TwoDSlidingFitResultMap &microSlidingFitResultMap, TwoDSlidingFitResultMap &macroSlidingFitResultMap) const
	Remove any hits in the upstream/downstream cluster that lie off of the main track axis (i.e. clustering errors) More...

void	AddHitsToMainTrack (const pandora::Cluster const pMainTrackCluster, const pandora::Cluster const pShowerTrackCluster, const pandora::CaloHitList &caloHitsToMerge, const ClusterAssociation &clusterAssociation, pandora::ClusterList &remnantClusterList) const
	Remove the hits from a shower cluster that belong to the main track and add them into the main track cluster. More...

void	ProcessRemnantClusters (const pandora::ClusterList &remnantClusterList, const pandora::Cluster const pMainTrackCluster, const pandora::ClusterList const pClusterList, pandora::ClusterList &createdClusters) const
	Process the remnant clusters separating those that stradle the main track. More...

bool	AddToNearestCluster (const pandora::Cluster const pClusterToMerge, const pandora::Cluster const pMainTrackCluster, const pandora::ClusterList *const pClusterList) const
	Add a cluster to the nearest cluster satisfying separation distance thresholds. More...

bool	IsClusterRemnantDisconnected (const pandora::Cluster *const pRemnantCluster) const
	Whether a remnant cluster is considered to be disconnected and therefore should undergo further fragmentation. More...

void	FragmentRemnantCluster (const pandora::Cluster *const pRemnantCluster, pandora::ClusterList &fragmentedClusterList) const
	Fragment a cluster using simple hit separation logic. More...

template<typename T >
void	UpdateContainers (const pandora::ClusterList &clustersToAdd, const pandora::ClusterList &clustersToDelete, const T sortFunction, pandora::ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const
	Remove deleted clusters from the cluster vector and sliding fit maps and add in created clusters that are determined to be track-like. More...

void	RemoveClusterFromContainers (const pandora::Cluster *const pClustertoRemove, pandora::ClusterVector &clusterVector, SlidingFitResultMapPair &slidingFitResultMapPair) const
	Remove a cluster from the cluster vector and sliding fit maps. More...

Protected Attributes inherited from lar_content::TrackRefinementBaseAlgorithm
float	m_minClusterLength
	The minimum length of a considered cluster. More...

unsigned int	m_microSlidingFitWindow
	The sliding fit window used in the fits contained within the microSlidingFitResultMap. More...

unsigned int	m_macroSlidingFitWindow
	The sliding fit window used in the fits contained within the macroSlidingFitResultMap. More...

float	m_stableRegionClusterFraction
	The threshold fraction of fit contributing layers which defines the stable region. More...

float	m_mergePointMinCosAngleDeviation
	The threshold cos opening angle between the cluster local gradient and the associated cluster global gradient used to determine merge points. More...

float	m_minHitFractionForHitRemoval
	The threshold fraction of hits to be removed from the cluster for hit removal to proceed. More...

float	m_maxDistanceFromMainTrack
	The threshold distance for a hit to be added to the main track. More...

float	m_maxHitDistanceFromCluster
	The threshold separation between a hit and cluster for the hit to be merged into the cluster. More...

float	m_maxHitSeparationForConnectedCluster
	The maximum separation between two adjacent (in z) hits in a connected cluster. More...

unsigned int	m_maxTrackGaps
	The maximum number of graps allowed in the extrapolated hit vector. More...

float	m_lineSegmentLength
	The length of a track gap. More...

bool	m_hitWidthMode
	Whether to consider the width of hits. More...

Detailed Description

TrackMergeRefinementAlgorithm class.

Definition at line 18 of file TrackMergeRefinementAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TrackMergeRefinementAlgorithm::TrackMergeRefinementAlgorithm ( )

Default constructor.

Definition at line 21 of file TrackMergeRefinementAlgorithm.cc.

                                                              :
     m_maxLoopIterations(10),
     m_minClusterLengthSum(75.f),
     m_minSeparationDistance(0.f),
     m_minDirectionDeviationCosAngle(0.99f),
     m_maxPredictedMergePointOffset(5.f),
     m_distanceToLine(0.35f),
     m_boundaryTolerance(2.f)
 {
 }

Member Function Documentation

bool lar_content::TrackMergeRefinementAlgorithm::AreClustersAssociated	(	const pandora::CartesianVector &	upstreamPoint,
		const pandora::CartesianVector &	upstreamDirection,
		const pandora::CartesianVector &	downstreamPoint,
		const pandora::CartesianVector &	downstreamDirection
	)		const

private

Whether two clusters are assoicated to one another.

Parameters

upstreamPoint	the merge point of the upstream cluster
upstreamDirection	the local direction of the upstream cluster at the merge point
downstreamPoint	the merge point of the downstream cluster
downstreamDirection	the local direction of the downstrean cluster at the merge point

Returns: whether the clusters are associated

Definition at line 175 of file TrackMergeRefinementAlgorithm.cc.

 {
     if (downstreamPoint.GetZ() < upstreamPoint.GetZ())
         return false;
 
     const float separationDistance(std::sqrt(upstreamPoint.GetDistanceSquared(downstreamPoint)));
     if (separationDistance < m_minSeparationDistance)
         return false;
 
     if (upstreamDirection.GetCosOpeningAngle(downstreamDirection) < m_minDirectionDeviationCosAngle)
         return false;
 
     const CartesianVector predictedDownstreamPoint(upstreamPoint + (upstreamDirection * separationDistance));
     const float predictedDownstreamOffset((predictedDownstreamPoint - downstreamPoint).GetMagnitude());
 
     if (predictedDownstreamOffset > m_maxPredictedMergePointOffset)
         return false;
 
     const CartesianVector predictedUpstreamPoint(downstreamPoint - (downstreamDirection * separationDistance));
     const float predictedUpstreamOffset((predictedUpstreamPoint - upstreamPoint).GetMagnitude());
 
     if (predictedUpstreamOffset > m_maxPredictedMergePointOffset)
         return false;
 
     return true;
 }

bool lar_content::TrackMergeRefinementAlgorithm::AreExtrapolatedHitsNearBoundaries	(	const pandora::CaloHitVector &	extrapolatedHitVector,
		ClusterAssociation &	clusterAssociation
	)		const

privatevirtual

Check the separation of the extremal extrapolated hits with the cluster merge points or, in the case of no hits, the cluster merge point separation.

Parameters

extrapolatedHitVector	the extrapolated hit vector (ordered closest hit to the upstream merge point -> furthest hit)
clusterAssociation	the cluster association

Returns: whether the checks pass

Implements lar_content::TrackRefinementBaseAlgorithm.

Definition at line 217 of file TrackMergeRefinementAlgorithm.cc.

 {
     if (extrapolatedHitVector.empty())
     {
         const float separationDistance((clusterAssociation.GetUpstreamMergePoint() - clusterAssociation.GetDownstreamMergePoint()).GetMagnitude());
         return (separationDistance < m_boundaryTolerance);
     }
 
     if (!this->IsNearBoundary(extrapolatedHitVector.front(), clusterAssociation.GetUpstreamMergePoint(), m_boundaryTolerance))
         return false;
 
     if (!this->IsNearBoundary(extrapolatedHitVector.back(), clusterAssociation.GetDownstreamMergePoint(), m_boundaryTolerance))
         return false;
 
     return true;
 }

void lar_content::TrackMergeRefinementAlgorithm::ConsiderClusterAssociation	(	const ClusterPairAssociation &	clusterAssociation,
		pandora::ClusterVector &	clusterVector,
		SlidingFitResultMapPair &	slidingFitResultMapPair
	)		const

private

Remove the cluster association from the cluster vector so that the same cluster pair is not considered again.

Parameters

clusterAssociation	the cluster pair association
clusterVector	the vector of clusters considered in future iterations of the algorithm
slidingFitResultMapPair	the {micro, macro} pair of [cluster -> TwoDSlidingFitResult] maps

Definition at line 236 of file TrackMergeRefinementAlgorithm.cc.

 {
     const Cluster *const upstreamCluster(clusterAssociation.GetUpstreamCluster()), *const downstreamCluster(clusterAssociation.GetDownstreamCluster());
     const Cluster *const pConsideredCluster(upstreamCluster->GetNCaloHits() > downstreamCluster->GetNCaloHits() ? downstreamCluster : upstreamCluster);
     RemoveClusterFromContainers(pConsideredCluster, clusterVector, slidingFitResultMapPair);
 }

const Cluster * lar_content::TrackMergeRefinementAlgorithm::CreateMainTrack	(	const ClusterPairAssociation &	clusterAssociation,
		const ClusterToCaloHitListMap &	clusterToCaloHitListMap,
		const pandora::ClusterList *	pClusterList,
		pandora::ClusterVector &	clusterVector,
		SlidingFitResultMapPair &	slidingFitResultMapPair
	)		const

private

Refine the cluster endpoints and merge together the associated clusters alongside any extrapolated hits.

Parameters

clusterAssociation	the cluster pair association
clusterToCaloHitListMap	the map [parent cluster -> list of hits which belong to the main track]
pClusterList	the list of all clusters
clusterVector	the vector of clusters considered in future iterations of the algorithm
slidingFitResultMapPair	the {micro, macro} pair of [cluster -> TwoDSlidingFitResult] maps

Returns: the address of the created main track cluster

Definition at line 246 of file TrackMergeRefinementAlgorithm.cc.

 {
     // Determine the shower clusters which contain hits that belong to the main track
     ClusterVector showerClustersToFragment;
     for (const auto &entry : clusterToCaloHitListMap)
     {
         if ((entry.first != clusterAssociation.GetUpstreamCluster()) && (entry.first != clusterAssociation.GetDownstreamCluster()))
             showerClustersToFragment.push_back(entry.first);
     }
 
     std::sort(showerClustersToFragment.begin(), showerClustersToFragment.end(), LArClusterHelper::SortByNHits);
 
     ClusterList remnantClusterList;
     const Cluster *const pMainTrackCluster(
         this->RemoveOffAxisHitsFromTrack(clusterAssociation.GetUpstreamCluster(), clusterAssociation.GetUpstreamMergePoint(), false,
             clusterToCaloHitListMap, remnantClusterList, *slidingFitResultMapPair.first, *slidingFitResultMapPair.second));
     const Cluster *const pClusterToDelete(
         this->RemoveOffAxisHitsFromTrack(clusterAssociation.GetDownstreamCluster(), clusterAssociation.GetDownstreamMergePoint(), true,
             clusterToCaloHitListMap, remnantClusterList, *slidingFitResultMapPair.first, *slidingFitResultMapPair.second));
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pMainTrackCluster, pClusterToDelete));
 
     for (const Cluster *const pShowerCluster : showerClustersToFragment)
     {
         const CaloHitList &caloHitsToMerge(clusterToCaloHitListMap.at(pShowerCluster));
         this->AddHitsToMainTrack(pMainTrackCluster, pShowerCluster, caloHitsToMerge, clusterAssociation, remnantClusterList);
     }
 
     ClusterList createdClusters;
     this->ProcessRemnantClusters(remnantClusterList, pMainTrackCluster, pClusterList, createdClusters);
 
     // ATTN: Cleanup containers - choose to add created clusters back into containers
     ClusterList modifiedClusters(showerClustersToFragment.begin(), showerClustersToFragment.end());
     modifiedClusters.push_back(clusterAssociation.GetUpstreamCluster());
     modifiedClusters.push_back(clusterAssociation.GetDownstreamCluster());
     createdClusters.push_back(pMainTrackCluster);
     this->UpdateContainers(createdClusters, modifiedClusters, LArClusterHelper::SortByNHits, clusterVector, slidingFitResultMapPair);
 
     return pMainTrackCluster;
 }

bool lar_content::TrackMergeRefinementAlgorithm::FindBestClusterAssociation	(	const pandora::ClusterVector &	clusterVector,
		const SlidingFitResultMapPair &	slidingFitResultMapPair,
		ClusterPairAssociation &	clusterAssociation
	)		const

private

Find the best cluster association.

Parameters

clusterVector	the vector of clusters to consider
slidingFitResultMapPair	the {micro, macro} pair of [cluster -> TwoDSlidingFitResult] maps
clusterAssociation	the cluster pair association

Returns: whether a cluster pair association was found

Definition at line 91 of file TrackMergeRefinementAlgorithm.cc.

 {
     bool foundAssociation(false);
     float maxLength(0.f);
 
     // ATTN: Find the associated cluster pair with the longest length sum
     for (ClusterVector::const_iterator currentIter = clusterVector.begin(); currentIter != clusterVector.end(); ++currentIter)
     {
         const Cluster *const pCurrentCluster(*currentIter);
 
         const TwoDSlidingFitResultMap::const_iterator currentMicroFitIter(slidingFitResultMapPair.first->find(pCurrentCluster));
         if (currentMicroFitIter == slidingFitResultMapPair.first->end())
             return false;
 
         const TwoDSlidingFitResultMap::const_iterator currentMacroFitIter(slidingFitResultMapPair.second->find(pCurrentCluster));
         if (currentMacroFitIter == slidingFitResultMapPair.second->end())
             return false;
 
         for (ClusterVector::const_iterator testIter = std::next(currentIter); testIter != clusterVector.end(); ++testIter)
         {
             const Cluster *const pTestCluster(*testIter);
 
             const float lengthSum(LArClusterHelper::GetLength(pCurrentCluster) + LArClusterHelper::GetLength(pTestCluster));
             if ((lengthSum < maxLength) || (lengthSum < m_minClusterLengthSum))
                 continue;
 
             const TwoDSlidingFitResultMap::const_iterator testMicroFitIter(slidingFitResultMapPair.first->find(pTestCluster));
             if (testMicroFitIter == slidingFitResultMapPair.first->end())
                 continue;
 
             const TwoDSlidingFitResultMap::const_iterator testMacroFitIter(slidingFitResultMapPair.second->find(pTestCluster));
             if (testMacroFitIter == slidingFitResultMapPair.second->end())
                 continue;
 
             const bool isCurrentUpstream(LArClusterHelper::SortByPosition(pCurrentCluster, pTestCluster));
 
             // ATTN: Ensure that clusters are not contained within one another
             const float currentMinLayerZ(currentMacroFitIter->second.GetGlobalMinLayerPosition().GetZ()),
                 currentMaxLayerZ(currentMacroFitIter->second.GetGlobalMaxLayerPosition().GetZ());
             const float testMinLayerZ(testMacroFitIter->second.GetGlobalMinLayerPosition().GetZ()),
                 testMaxLayerZ(testMacroFitIter->second.GetGlobalMaxLayerPosition().GetZ());
 
             if (((currentMinLayerZ > testMinLayerZ) && (currentMaxLayerZ < testMaxLayerZ)) ||
                 ((testMinLayerZ > currentMinLayerZ) && (testMaxLayerZ < currentMaxLayerZ)))
                 continue;
 
             CartesianVector currentMergePoint(0.f, 0.f, 0.f), testMergePoint(0.f, 0.f, 0.f), currentMergeDirection(0.f, 0.f, 0.f),
                 testMergeDirection(0.f, 0.f, 0.f);
             if (!this->GetClusterMergingCoordinates(currentMicroFitIter->second, currentMacroFitIter->second, testMacroFitIter->second,
                     !isCurrentUpstream, currentMergePoint, currentMergeDirection) ||
                 !this->GetClusterMergingCoordinates(testMicroFitIter->second, testMacroFitIter->second, currentMacroFitIter->second,
                     isCurrentUpstream, testMergePoint, testMergeDirection))
             {
                 continue;
             }
 
             if ((isCurrentUpstream && !this->AreClustersAssociated(currentMergePoint, currentMergeDirection, testMergePoint, testMergeDirection)) ||
                 (!isCurrentUpstream && !this->AreClustersAssociated(testMergePoint, testMergeDirection, currentMergePoint, currentMergeDirection)))
             {
                 continue;
             }
 
             if (isCurrentUpstream)
             {
                 clusterAssociation = ClusterPairAssociation(
                     currentMergePoint, currentMergeDirection, testMergePoint, testMergeDirection * (-1.f), pCurrentCluster, pTestCluster);
             }
             else
             {
                 clusterAssociation = ClusterPairAssociation(
                     testMergePoint, testMergeDirection, currentMergePoint, currentMergeDirection * (-1.f), pTestCluster, pCurrentCluster);
             }
 
             foundAssociation = true;
             maxLength = lengthSum;
         }
     }
 
     return foundAssociation;
 }

void lar_content::TrackMergeRefinementAlgorithm::GetUnavailableProtectedClusters	(	const ClusterPairAssociation &	clusterAssociation,
		const pandora::ClusterList &	createdMainTrackClusters,
		pandora::ClusterList &	unavailableProtectedClusters
	)		const

private

Obtain a list of clusters whos hits are protected and cannot be reassigned.

Parameters

clusterAssociation	the clusterPairAssociation
createdMainTrackClusters	the list of main track clusters that have hitherto collected
unavailableProtectedClusters	the output list of protected clusters

Definition at line 205 of file TrackMergeRefinementAlgorithm.cc.

 {
     for (const Cluster *const pMainTrackCluster : createdMainTrackClusters)
     {
         if ((pMainTrackCluster != clusterAssociation.GetUpstreamCluster()) && (pMainTrackCluster != clusterAssociation.GetDownstreamCluster()))
             protectedClusters.push_back(pMainTrackCluster);
     }
 }

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

privatevirtual

Implements lar_content::TrackRefinementBaseAlgorithm.

Definition at line 291 of file TrackMergeRefinementAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxLoopIterations", m_maxLoopIterations));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterLengthSum", m_minClusterLengthSum));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinSeparationDistance", m_minSeparationDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinDirectionDeviationCosAngle", m_minDirectionDeviationCosAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxPredictedMergePointOffset", m_maxPredictedMergePointOffset));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "DistanceToLine", m_distanceToLine));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "BoundaryTolerance", m_boundaryTolerance));
 
     return TrackRefinementBaseAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::TrackMergeRefinementAlgorithm::Run ( )

privatevirtual

Implements lar_content::TrackRefinementBaseAlgorithm.

Definition at line 34 of file TrackMergeRefinementAlgorithm.cc.

 {
     const ClusterList *pClusterList(nullptr);
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
 
     const CaloHitList *pCaloHitList(nullptr);
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pCaloHitList));
 
     ClusterVector clusterVector;
     TwoDSlidingFitResultMap microSlidingFitResultMap, macroSlidingFitResultMap;
     SlidingFitResultMapPair slidingFitResultMapPair({&microSlidingFitResultMap, &macroSlidingFitResultMap});
 
     this->InitialiseContainers(pClusterList, LArClusterHelper::SortByNHits, clusterVector, slidingFitResultMapPair);
 
     // ATTN: Keep track of created main track clusters so their hits can be protected in future iterations
     unsigned int loopIterations(0);
     ClusterList createdMainTrackClusters;
     while (loopIterations < m_maxLoopIterations)
     {
         ++loopIterations;
 
         ClusterPairAssociation clusterAssociation;
         if (!this->FindBestClusterAssociation(clusterVector, slidingFitResultMapPair, clusterAssociation))
             break;
 
         ClusterList unavailableProtectedClusters;
         this->GetUnavailableProtectedClusters(clusterAssociation, createdMainTrackClusters, unavailableProtectedClusters);
 
         ClusterToCaloHitListMap clusterToCaloHitListMap;
         this->GetHitsInBoundingBox(clusterAssociation.GetUpstreamMergePoint(), clusterAssociation.GetDownstreamMergePoint(), pClusterList,
             clusterToCaloHitListMap, unavailableProtectedClusters, m_distanceToLine);
 
         if (!this->AreExtrapolatedHitsGood(clusterToCaloHitListMap, clusterAssociation))
         {
             this->ConsiderClusterAssociation(clusterAssociation, clusterVector, slidingFitResultMapPair);
             continue;
         }
 
         const ClusterList::const_iterator upstreamIter(
             std::find(createdMainTrackClusters.begin(), createdMainTrackClusters.end(), clusterAssociation.GetUpstreamCluster()));
         if (upstreamIter != createdMainTrackClusters.end())
             createdMainTrackClusters.erase(upstreamIter);
 
         const ClusterList::const_iterator downstreamIter(
             std::find(createdMainTrackClusters.begin(), createdMainTrackClusters.end(), clusterAssociation.GetDownstreamCluster()));
         if (downstreamIter != createdMainTrackClusters.end())
             createdMainTrackClusters.erase(downstreamIter);
 
         createdMainTrackClusters.push_back(
             this->CreateMainTrack(clusterAssociation, clusterToCaloHitListMap, pClusterList, clusterVector, slidingFitResultMapPair));
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

float lar_content::TrackMergeRefinementAlgorithm::m_boundaryTolerance

private

The maximum allowed distance of an extremal extrapolate hit to a cluster merge point.

Definition at line 105 of file TrackMergeRefinementAlgorithm.h.

float lar_content::TrackMergeRefinementAlgorithm::m_distanceToLine

private

The threshold hit distance of an extrapolated hit from the segment connecting line.

Definition at line 104 of file TrackMergeRefinementAlgorithm.h.

unsigned int lar_content::TrackMergeRefinementAlgorithm::m_maxLoopIterations

private

The maximum number of main loop iterations.

Definition at line 99 of file TrackMergeRefinementAlgorithm.h.

float lar_content::TrackMergeRefinementAlgorithm::m_maxPredictedMergePointOffset

private

The threshold separation distance between the predicted and true cluster merge points.

Definition at line 103 of file TrackMergeRefinementAlgorithm.h.

float lar_content::TrackMergeRefinementAlgorithm::m_minClusterLengthSum

private

The threshold cluster and associated cluster length sum.

Definition at line 100 of file TrackMergeRefinementAlgorithm.h.

float lar_content::TrackMergeRefinementAlgorithm::m_minDirectionDeviationCosAngle

private

The threshold cos opening angle of the associated cluster directions.

Definition at line 102 of file TrackMergeRefinementAlgorithm.h.

float lar_content::TrackMergeRefinementAlgorithm::m_minSeparationDistance

private

The threshold separation distance between associated clusters.

Definition at line 101 of file TrackMergeRefinementAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArTwoDReco/LArCosmicRay/TrackMergeRefinementAlgorithm.h
larpandoracontent/larpandoracontent/LArTwoDReco/LArCosmicRay/TrackMergeRefinementAlgorithm.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation