#include "LongTracksTool.h"

Inheritance diagram for lar_content::LongTracksTool:

Public Types
typedef ThreeDTransverseTracksAlgorithm::TensorType	TensorType

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

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

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

Static Public Member Functions
static bool	HasLongDirectConnections (IteratorList::const_iterator iIter, const IteratorList &iteratorList)
	Whether a long element shares clusters with any other long elements. More...

static bool	IsLongerThanDirectConnections (IteratorList::const_iterator iIter, const TensorType::ElementList &elementList, const unsigned int minMatchedSamplingPointRatio, const pandora::ClusterSet &usedClusters)
	Whether a long element is significantly longer that other elements with which it shares a cluster. More...

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

void	FindLongTracks (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Find long tracks, hidden by simple ambiguities in the tensor. More...

void	SelectLongElements (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
	Select a list of long track-like elements from a set of connected tensor elements. 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 (in each view) for particle creation. More...

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

Detailed Description

LongTracksTool class.

Definition at line 19 of file LongTracksTool.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::LongTracksTool::LongTracksTool ( )

Default constructor.

Definition at line 18 of file LongTracksTool.cc.

                                :
     m_minMatchedFraction(0.9f),
     m_minMatchedSamplingPoints(20),
     m_minXOverlapFraction(0.9f),
     m_minMatchedSamplingPointRatio(2)
 {
 }

Member Function Documentation

void lar_content::LongTracksTool::FindLongTracks	(	const TensorType &	overlapTensor,
		ProtoParticleVector &	protoParticleVector
	)		const

private

Find long tracks, hidden by simple ambiguities in the tensor.

Parameters

overlapTensor	the overlap tensor
protoParticleVector	to receive the list of proto particles

Definition at line 83 of file LongTracksTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), HasLongDirectConnections(), IsLongerThanDirectConnections(), lar_content::ProtoParticle::m_clusterListU, lar_content::ProtoParticle::m_clusterListV, lar_content::ProtoParticle::m_clusterListW, m_minMatchedSamplingPointRatio, and SelectLongElements().

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->SelectLongElements(elementList, usedClusters, iteratorList);
 
         // Check that elements are not directly connected and are significantly longer than any other directly connected elements
         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;
 
             ProtoParticle protoParticle;
             protoParticle.m_clusterListU.push_back((*iIter)->GetClusterU());
             protoParticle.m_clusterListV.push_back((*iIter)->GetClusterV());
             protoParticle.m_clusterListW.push_back((*iIter)->GetClusterW());
             protoParticleVector.push_back(protoParticle);
 
             usedClusters.insert((*iIter)->GetClusterU());
             usedClusters.insert((*iIter)->GetClusterV());
             usedClusters.insert((*iIter)->GetClusterW());
         }
     }
 }

bool lar_content::LongTracksTool::HasLongDirectConnections	(	IteratorList::const_iterator	iIter,
		const IteratorList &	iteratorList
	)

static

Whether a long element shares clusters with any other long elements.

Parameters

iIter	specifies the long element under consideration
iteratorList	list of iterators to other long elements

Returns: boolean

Definition at line 28 of file LongTracksTool.cc.

Referenced by FindLongTracks(), lar_content::TracksCrossingGapsTool::FindTracks(), lar_content::TrackSplittingTool::FindTracks(), and lar_content::MissingTrackSegmentTool::FindTracks().

 {
     for (IteratorList::const_iterator iIter2 = iteratorList.begin(), iIter2End = iteratorList.end(); iIter2 != iIter2End; ++iIter2)
     {
         if (iIter == iIter2)
             continue;
 
         if (((*iIter)->GetClusterU() == (*iIter2)->GetClusterU()) || ((*iIter)->GetClusterV() == (*iIter2)->GetClusterV()) || ((*iIter)->GetClusterW() == (*iIter2)->GetClusterW()) )
             return true;
     }
 
     return false;
 }

bool lar_content::LongTracksTool::IsLongerThanDirectConnections	(	IteratorList::const_iterator	iIter,
		const TensorType::ElementList &	elementList,
		const unsigned int	minMatchedSamplingPointRatio,
		const pandora::ClusterSet &	usedClusters
	)

static

Whether a long element is significantly longer that other elements with which it shares a cluster.

Parameters

iIter	specifies the long element under consideration
elementList	the full list of connected tensor elements
minMatchedSamplingPointRatio	the min ratio between 1st and 2nd highest msps for simple ambiguity resolution
usedClusters	the list of clusters already marked as to be added to a pfo

Definition at line 44 of file LongTracksTool.cc.

Referenced by FindLongTracks(), lar_content::TracksCrossingGapsTool::FindTracks(), lar_content::TrackSplittingTool::FindTracks(), and lar_content::MissingTrackSegmentTool::FindTracks().

 {
     const unsigned int nMatchedSamplingPoints((*iIter)->GetOverlapResult().GetNMatchedSamplingPoints());
 
     for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
     {
         if ((*iIter) == eIter)
             continue;
 
         if (usedClusters.count(eIter->GetClusterU()) || usedClusters.count(eIter->GetClusterV()) || usedClusters.count(eIter->GetClusterW()))
             continue;
 
         if (((*iIter)->GetClusterU() != eIter->GetClusterU()) && ((*iIter)->GetClusterV() != eIter->GetClusterV()) && ((*iIter)->GetClusterW() != eIter->GetClusterW()))
             continue;
 
         if (nMatchedSamplingPoints < minMatchedSamplingPointRatio * eIter->GetOverlapResult().GetNMatchedSamplingPoints())
             return false;
     }
 
     return true;
 }

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

private

Definition at line 152 of file LongTracksTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPointRatio, m_minMatchedSamplingPoints, 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));
 
     return STATUS_CODE_SUCCESS;
 }

bool lar_content::LongTracksTool::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 69 of file LongTracksTool.cc.

References lar_content::ThreeDBaseAlgorithm< T >::CreateThreeDParticles(), and FindLongTracks().

 {
     if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     ProtoParticleVector protoParticleVector;
     this->FindLongTracks(overlapTensor, protoParticleVector);
 
     const bool particlesMade(pAlgorithm->CreateThreeDParticles(protoParticleVector));
     return particlesMade;
 }

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

private

Select a list of long track-like 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 125 of file LongTracksTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPoints, and m_minXOverlapFraction.

Referenced by FindLongTracks().

 {
     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());
 
         if ((xOverlap.GetXSpanU() > std::numeric_limits<float>::epsilon()) && (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanU() > m_minXOverlapFraction) &&
             (xOverlap.GetXSpanV() > std::numeric_limits<float>::epsilon()) && (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanV() > m_minXOverlapFraction) &&
             (xOverlap.GetXSpanW() > std::numeric_limits<float>::epsilon()) && (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanW() > m_minXOverlapFraction))
         {
             iteratorList.push_back(eIter);
         }
     }
 }

Member Data Documentation

float lar_content::LongTracksTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 71 of file LongTracksTool.h.

Referenced by ReadSettings(), and SelectLongElements().

unsigned int lar_content::LongTracksTool::m_minMatchedSamplingPointRatio

private

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

Definition at line 74 of file LongTracksTool.h.

Referenced by FindLongTracks(), and ReadSettings().

unsigned int lar_content::LongTracksTool::m_minMatchedSamplingPoints

private

The min number of matched sampling points for particle creation.

Definition at line 72 of file LongTracksTool.h.

Referenced by ReadSettings(), and SelectLongElements().

float lar_content::LongTracksTool::m_minXOverlapFraction

private

The min x overlap fraction (in each view) for particle creation.

Definition at line 73 of file LongTracksTool.h.

Referenced by ReadSettings(), and SelectLongElements().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation