#include "TrackSplittingTool.h"

Inheritance diagram for lar_content::TrackSplittingTool:

Classes
class	Particle
	Particle class. More...

Public Types
typedef ThreeDTransverseTracksAlgorithm::TensorType	TensorType

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

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

bool	Run (ThreeDTransverseTracksAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	FindTracks (ThreeDTransverseTracksAlgorithm *const pAlgorithm, const TensorType &overlapTensor, SplitPositionMap &splitPositionMap) const
	Find remaining tracks, hidden by spurious track segments (and maybe other ambiguities) in the tensor. More...

void	SelectElements (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
	Select a list of the relevant elements from a set of connected tensor elements. More...

bool	PassesChecks (ThreeDTransverseTracksAlgorithm *const pAlgorithm, const TensorType::Element &element, const bool isMinX, pandora::ClusterSet &usedClusters, SplitPositionMap &splitPositionMap) const
	Whether a provided tensor element can be used to construct a pfo. More...

bool	CheckSplitPosition (const pandora::CartesianVector &splitPosition, const float splitX, const TwoDSlidingFitResult &longFitResult) const
	Check a candidate split position for consistency with the associated track cluster sliding linear fit. More...

Private Attributes
float	m_minMatchedFraction
	The min matched sampling point fraction for particle creation. More...

unsigned int	m_minMatchedSamplingPoints
	The min number of matched sampling points for particle creation. More...

float	m_minXOverlapFraction
	The min x overlap fraction (between long clusters and short cluster vs. shared overlap) More...

unsigned int	m_minMatchedSamplingPointRatio
	The min ratio between 1st and 2nd highest msps for simple ambiguity resolution. More...

float	m_maxShortDeltaXFraction
	Max x distance between ends of two short clusters (measured as fraction of long cluster x length) More...

float	m_maxAbsoluteShortDeltaX
	Max x distance between ends of two short clusters (measured as an absolute distance) More...

float	m_minLongDeltaXFraction
	Min x distance between ends of short and long clusters (measured as fraction of long cluster x length) More...

float	m_minAbsoluteLongDeltaX
	Min x distance between ends of short and long clusters (measured as an absolute distance) More...

float	m_minSplitToVertexProjection
	Min projected distance between split position and either inner or outer vertex of long cluster. More...

float	m_maxSplitVsFitPositionDistance
	Max allowed distance between split position and sliding linear fit position at the split x coordinate. More...

Detailed Description

TrackSplittingTool class.

Definition at line 19 of file TrackSplittingTool.h.

Member Typedef Documentation

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

inherited

Definition at line 128 of file ThreeDTransverseTracksAlgorithm.h.

typedef ThreeDTransverseTracksAlgorithm::TensorType lar_content::TransverseTensorTool::TensorType

inherited

Definition at line 127 of file ThreeDTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TrackSplittingTool::TrackSplittingTool ( )

Default constructor.

Definition at line 23 of file TrackSplittingTool.cc.

                                        :
     m_minMatchedFraction(0.75f),
     m_minMatchedSamplingPoints(10),
     m_minXOverlapFraction(0.75f),
     m_minMatchedSamplingPointRatio(2),
     m_maxShortDeltaXFraction(0.2f),
     m_maxAbsoluteShortDeltaX(5.f),
     m_minLongDeltaXFraction(0.2f),
     m_minAbsoluteLongDeltaX(1.f),
     m_minSplitToVertexProjection(1.f),
     m_maxSplitVsFitPositionDistance(1.5f)
 {
 }

Member Function Documentation

bool lar_content::TrackSplittingTool::CheckSplitPosition	(	const pandora::CartesianVector &	splitPosition,
		const float	splitX,
		const TwoDSlidingFitResult &	longFitResult
	)		const

private

Check a candidate split position for consistency with the associated track cluster sliding linear fit.

Parameters

splitPosition	the candidate split position
splitX	the split x coordinate
longFitResult	the sliding linear fit for the long cluster

Definition at line 191 of file TrackSplittingTool.cc.

References lar_content::TwoDSlidingFitResult::GetGlobalFitPositionListAtX(), and m_maxSplitVsFitPositionDistance.

Referenced by PassesChecks().

 {
     CartesianPointVector fitPositionList;
     if (STATUS_CODE_SUCCESS != longFitResult.GetGlobalFitPositionListAtX(splitX, fitPositionList))
         return false;
 
     for (CartesianPointVector::const_iterator iter = fitPositionList.begin(), iterEnd = fitPositionList.end(); iter != iterEnd; ++iter)
     {
         if ((splitPosition - *iter).GetMagnitude() < m_maxSplitVsFitPositionDistance)
             return true;
     }
 
     return false;
 }

void lar_content::TrackSplittingTool::FindTracks	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		const TensorType &	overlapTensor,
		SplitPositionMap &	splitPositionMap
	)		const

private

Find remaining tracks, hidden by spurious track segments (and maybe other ambiguities) in the tensor.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor
splitPositionMap	to receive the split position map

Definition at line 53 of file TrackSplittingTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), lar_content::LongTracksTool::HasLongDirectConnections(), lar_content::LongTracksTool::IsLongerThanDirectConnections(), m_minMatchedSamplingPointRatio, PassesChecks(), and SelectElements().

Referenced by Run().

 {
     ClusterSet usedClusters;
     ClusterVector sortedKeyClusters;
     overlapTensor.GetSortedKeyClusters(sortedKeyClusters);
 
     for (const Cluster *const pKeyCluster : sortedKeyClusters)
     {
         if (!pKeyCluster->IsAvailable())
             continue;
 
         unsigned int nU(0), nV(0), nW(0);
         TensorType::ElementList elementList;
         overlapTensor.GetConnectedElements(pKeyCluster, true, elementList, nU, nV, nW);
 
         IteratorList iteratorList;
         this->SelectElements(elementList, usedClusters, iteratorList);
 
         for (IteratorList::const_iterator iIter = iteratorList.begin(), iIterEnd = iteratorList.end(); iIter != iIterEnd; ++iIter)
         {
             if (LongTracksTool::HasLongDirectConnections(iIter, iteratorList))
                 continue;
 
             if (!LongTracksTool::IsLongerThanDirectConnections(iIter, elementList, m_minMatchedSamplingPointRatio, usedClusters))
                 continue;
 
             if (!this->PassesChecks(pAlgorithm, *(*iIter), true, usedClusters, splitPositionMap) &&
                 !this->PassesChecks(pAlgorithm, *(*iIter), false, usedClusters, splitPositionMap))
             {
                 continue;
             }
 
             usedClusters.insert((*iIter)->GetClusterU());
             usedClusters.insert((*iIter)->GetClusterV());
             usedClusters.insert((*iIter)->GetClusterW());
         }
     }
 }

bool lar_content::TrackSplittingTool::PassesChecks	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		const TensorType::Element &	element,
		const bool	isMinX,
		pandora::ClusterSet &	usedClusters,
		SplitPositionMap &	splitPositionMap
	)		const

private

Whether a provided tensor element can be used to construct a pfo.

Parameters

pAlgorithm	address of the calling algorithm
element	the tensor element
isMinX	whether to look for track splits at min or max x coordinate
usedClusters	the list of used clusters
splitPositionMap	to receive the split position map

Definition at line 131 of file TrackSplittingTool.cc.

Referenced by FindTracks().

 {
     try
     {
         const Particle particle(element);
 
         if (usedClusters.count(particle.m_pLongCluster) || usedClusters.count(particle.m_pCluster1) || usedClusters.count(particle.m_pCluster2))
             return false;
 
         const float longXSpan(particle.m_longMaxX - particle.m_longMinX);
 
         if (longXSpan < std::numeric_limits<float>::epsilon())
             return false;
 
         const float splitX(isMinX ? (0.5f * (particle.m_short1MinX + particle.m_short2MinX)) : (0.5f * (particle.m_short1MaxX + particle.m_short2MaxX)));
         const float shortDeltaX(isMinX ? std::fabs(particle.m_short1MinX - particle.m_short2MinX) : std::fabs(particle.m_short1MaxX - particle.m_short2MaxX));
         const float longDeltaX(isMinX ? (splitX - particle.m_longMinX) : (particle.m_longMaxX - splitX));
 
         if (((shortDeltaX / longXSpan) > m_maxShortDeltaXFraction) || (shortDeltaX > m_maxAbsoluteShortDeltaX) ||
             ((longDeltaX / longXSpan) < m_minLongDeltaXFraction) || (longDeltaX < m_minAbsoluteLongDeltaX))
         {
             return false;
         }
 
         const LArPointingCluster pointingCluster1(pAlgorithm->GetCachedSlidingFitResult(particle.m_pCluster1));
         const LArPointingCluster pointingCluster2(pAlgorithm->GetCachedSlidingFitResult(particle.m_pCluster2));
         const LArPointingCluster longPointingCluster(pAlgorithm->GetCachedSlidingFitResult(particle.m_pLongCluster));
 
         const CartesianVector &position1(pointingCluster1.GetInnerVertex().GetPosition().GetX() < pointingCluster1.GetOuterVertex().GetPosition().GetX() ? pointingCluster1.GetInnerVertex().GetPosition() : pointingCluster1.GetOuterVertex().GetPosition());
         const CartesianVector &position2(pointingCluster2.GetInnerVertex().GetPosition().GetX() < pointingCluster2.GetOuterVertex().GetPosition().GetX() ? pointingCluster2.GetInnerVertex().GetPosition() : pointingCluster2.GetOuterVertex().GetPosition());
 
         CartesianVector splitPosition(0.f, 0.f, 0.f);
         float chiSquared(std::numeric_limits<float>::max());
         LArGeometryHelper::MergeTwoPositions(this->GetPandora(), LArClusterHelper::GetClusterHitType(particle.m_pCluster1),
             LArClusterHelper::GetClusterHitType(particle.m_pCluster2), position1, position2, splitPosition, chiSquared);
 
         if (!this->CheckSplitPosition(splitPosition, splitX, pAlgorithm->GetCachedSlidingFitResult(particle.m_pLongCluster)))
             return false;
 
         const CartesianVector splitToInnerVertex(splitPosition - longPointingCluster.GetInnerVertex().GetPosition());
         const CartesianVector outerVertexToSplit(longPointingCluster.GetOuterVertex().GetPosition() - splitPosition);
         const CartesianVector outerToInnerUnitVector((longPointingCluster.GetOuterVertex().GetPosition() - longPointingCluster.GetInnerVertex().GetPosition()).GetUnitVector());
 
         if ((splitToInnerVertex.GetDotProduct(outerToInnerUnitVector) > m_minSplitToVertexProjection) &&
             (outerVertexToSplit.GetDotProduct(outerToInnerUnitVector) > m_minSplitToVertexProjection))
         {
             splitPositionMap[particle.m_pLongCluster].push_back(splitPosition);
             return true;
         }
     }
     catch (StatusCodeException &)
     {
     }
 
     return false;
 }

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

private

Definition at line 234 of file TrackSplittingTool.cc.

References m_maxAbsoluteShortDeltaX, m_maxShortDeltaXFraction, m_maxSplitVsFitPositionDistance, m_minAbsoluteLongDeltaX, m_minLongDeltaXFraction, m_minMatchedFraction, m_minMatchedSamplingPointRatio, m_minMatchedSamplingPoints, m_minSplitToVertexProjection, and m_minXOverlapFraction.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedFraction", m_minMatchedFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedSamplingPoints", m_minMatchedSamplingPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinXOverlapFraction", m_minXOverlapFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedSamplingPointRatio", m_minMatchedSamplingPointRatio));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxShortDeltaXFraction", m_maxShortDeltaXFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxAbsoluteShortDeltaX", m_maxAbsoluteShortDeltaX));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinLongDeltaXFraction", m_minLongDeltaXFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinAbsoluteLongDeltaX", m_minAbsoluteLongDeltaX));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinSplitToVertexProjection", m_minSplitToVertexProjection));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxSplitVsFitPositionDistance", m_maxSplitVsFitPositionDistance));
 
     return STATUS_CODE_SUCCESS;
 }

bool lar_content::TrackSplittingTool::Run	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

virtual

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::TransverseTensorTool.

Definition at line 39 of file TrackSplittingTool.cc.

References FindTracks(), and lar_content::ThreeDTracksBaseAlgorithm< T >::MakeClusterSplits().

 {
     if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     SplitPositionMap splitPositionMap;
     this->FindTracks(pAlgorithm, overlapTensor, splitPositionMap);
 
     const bool splitsMade(pAlgorithm->MakeClusterSplits(splitPositionMap));
     return splitsMade;
 }

void lar_content::TrackSplittingTool::SelectElements	(	const TensorType::ElementList &	elementList,
		const pandora::ClusterSet &	usedClusters,
		IteratorList &	iteratorList
	)		const

private

Select a list of the relevant elements from a set of connected tensor elements.

Parameters

elementList	the full list of connected tensor elements
usedClusters	the list of clusters already marked as to be added to a pfo
iteratorList	to receive a list of iterators to long track-like elements

Definition at line 94 of file TrackSplittingTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPoints, m_minXOverlapFraction, max, and min.

Referenced by FindTracks().

 {
     for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
     {
         if (usedClusters.count(eIter->GetClusterU()) || usedClusters.count(eIter->GetClusterV()) || usedClusters.count(eIter->GetClusterW()))
             continue;
 
         if (eIter->GetOverlapResult().GetMatchedFraction() < m_minMatchedFraction)
             continue;
 
         if (eIter->GetOverlapResult().GetNMatchedSamplingPoints() < m_minMatchedSamplingPoints)
             continue;
 
         const XOverlap &xOverlap(eIter->GetOverlapResult().GetXOverlap());
         const float longSpan(std::max(xOverlap.GetXSpanU(), std::max(xOverlap.GetXSpanV(), xOverlap.GetXSpanW())));
         const float shortSpan1(std::min(xOverlap.GetXSpanU(), std::min(xOverlap.GetXSpanV(), xOverlap.GetXSpanW())));
         const float shortSpan2(((xOverlap.GetXSpanU() > shortSpan1) && (xOverlap.GetXSpanU() < longSpan)) ? xOverlap.GetXSpanU() :
             ((xOverlap.GetXSpanV() > shortSpan1) && (xOverlap.GetXSpanV() < longSpan)) ? xOverlap.GetXSpanV() : xOverlap.GetXSpanW());
 
         if ((shortSpan1 < std::numeric_limits<float>::epsilon()) || (longSpan < std::numeric_limits<float>::epsilon()))
             continue;
 
         if ((shortSpan1 / xOverlap.GetXOverlapSpan()) < m_minXOverlapFraction)
             continue;
 
         if ((shortSpan1 / shortSpan2) < m_minXOverlapFraction)
             continue;
 
         if ((shortSpan1 / longSpan) > m_minXOverlapFraction)
             continue;
 
         iteratorList.push_back(eIter);
     }
 }

Member Data Documentation

float lar_content::TrackSplittingTool::m_maxAbsoluteShortDeltaX

private

Max x distance between ends of two short clusters (measured as an absolute distance)

Definition at line 101 of file TrackSplittingTool.h.

Referenced by PassesChecks(), and ReadSettings().

float lar_content::TrackSplittingTool::m_maxShortDeltaXFraction

private

Max x distance between ends of two short clusters (measured as fraction of long cluster x length)

Definition at line 100 of file TrackSplittingTool.h.

Referenced by PassesChecks(), and ReadSettings().

float lar_content::TrackSplittingTool::m_maxSplitVsFitPositionDistance

private

Max allowed distance between split position and sliding linear fit position at the split x coordinate.

Definition at line 105 of file TrackSplittingTool.h.

Referenced by CheckSplitPosition(), and ReadSettings().

float lar_content::TrackSplittingTool::m_minAbsoluteLongDeltaX

private

Min x distance between ends of short and long clusters (measured as an absolute distance)

Definition at line 103 of file TrackSplittingTool.h.

Referenced by PassesChecks(), and ReadSettings().

float lar_content::TrackSplittingTool::m_minLongDeltaXFraction

private

Min x distance between ends of short and long clusters (measured as fraction of long cluster x length)

Definition at line 102 of file TrackSplittingTool.h.

Referenced by PassesChecks(), and ReadSettings().

float lar_content::TrackSplittingTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 95 of file TrackSplittingTool.h.

Referenced by ReadSettings(), and SelectElements().

unsigned int lar_content::TrackSplittingTool::m_minMatchedSamplingPointRatio

private

The min ratio between 1st and 2nd highest msps for simple ambiguity resolution.

Definition at line 98 of file TrackSplittingTool.h.

Referenced by FindTracks(), and ReadSettings().

unsigned int lar_content::TrackSplittingTool::m_minMatchedSamplingPoints

private

The min number of matched sampling points for particle creation.

Definition at line 96 of file TrackSplittingTool.h.

Referenced by ReadSettings(), and SelectElements().

float lar_content::TrackSplittingTool::m_minSplitToVertexProjection

private

Min projected distance between split position and either inner or outer vertex of long cluster.

Definition at line 104 of file TrackSplittingTool.h.

Referenced by PassesChecks(), and ReadSettings().

float lar_content::TrackSplittingTool::m_minXOverlapFraction

private

The min x overlap fraction (between long clusters and short cluster vs. shared overlap)

Definition at line 97 of file TrackSplittingTool.h.

Referenced by ReadSettings(), and SelectElements().

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

larpandoracontent/v03_13_02/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/TrackSplittingTool.h
larpandoracontent/v03_13_02/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/TrackSplittingTool.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation