ThreeViewTransverseTracksAlgorithm class. More...

#include "ThreeViewTransverseTracksAlgorithm.h"

Inheritance diagram for lar_content::ThreeViewTransverseTracksAlgorithm:

Public Types
typedef NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >	BaseAlgorithm

typedef ThreeViewMatchingControl< TransverseOverlapResult >	MatchingType

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

const TwoDSlidingFitResult &	GetCachedSlidingFitResult (const pandora::Cluster *const pCluster) const
	Get a sliding fit result from the algorithm cache. More...

unsigned int	GetSlidingFitWindow () const
	Get the layer window for the sliding linear fits. More...

virtual bool	MakeClusterSplits (const SplitPositionMap &splitPositionMap)
	Make cluster splits. More...

virtual bool	MakeClusterSplit (const pandora::CartesianVector &splitPosition, const pandora::Cluster &pCurrentCluster, const pandora::Cluster &pLowXCluster, const pandora::Cluster *&pHighXCluster) const
	Make a cluster split. More...

virtual void	UpdateForNewCluster (const pandora::Cluster *const pNewCluster)
	Update to reflect addition of a new cluster to the problem space. More...

virtual void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. More...

virtual void	SelectInputClusters (const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const
	Select a subset of input clusters for processing in this algorithm. More...

virtual void	PrepareInputClusters (pandora::ClusterList &preparedClusterList)
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results. More...

virtual void	SetPfoParticleId (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set pfo particle id. More...

const std::string &	GetClusterListName (const pandora::HitType hitType) const
	Get the cluster list name corresponding to a specified hit type. More...

const pandora::ClusterList &	GetInputClusterList (const pandora::HitType hitType) const
	Get the input cluster list corresponding to a specified hit type. More...

const pandora::ClusterList &	GetSelectedClusterList (const pandora::HitType hitType) const
	Get the selected cluster list corresponding to a specified hit type. More...

virtual bool	MakeClusterMerges (const ClusterMergeMap &clusterMergeMap)
	Merge clusters together. More...

virtual bool	CreateThreeDParticles (const ProtoParticleVector &protoParticleVector)
	Create particles using findings from recent algorithm processing. More...

virtual void	SetPfoParameters (const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set Pfo properties. More...

Static Public Member Functions
static bool	SortSplitPositions (const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs)
	Sort split position cartesian vectors by increasing x coordinate. More...

Protected Member Functions
void	AddToSlidingFitCache (const pandora::Cluster *const pCluster)
	Add a new sliding fit result, for the specified cluster, to the algorithm cache. More...

void	RemoveFromSlidingFitCache (const pandora::Cluster *const pCluster)
	Remova an existing sliding fit result, for the specified cluster, from the algorithm cache. More...

virtual void	TidyUp ()
	Tidy member variables in derived class. More...

MatchingType &	GetMatchingControl ()
	Get the matching control. More...

virtual void	SelectAllInputClusters ()
	Select a subset of input clusters for processing in this algorithm. More...

virtual void	PrepareAllInputClusters ()
	Perform any preparatory steps required, e.g. caching expensive fit results for clusters. More...

virtual void	PerformMainLoop ()
	Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult. More...

Protected Attributes
MatchingType	m_matchingControl
	The matching control. More...

Private Types
typedef std::map< unsigned int, TransverseOverlapResult >	FitSegmentToOverlapResultMap

typedef std::map< unsigned int, FitSegmentToOverlapResultMap >	FitSegmentMatrix

typedef std::map< unsigned int, FitSegmentMatrix >	FitSegmentTensor

typedef std::vector< TransverseTensorTool * >	TensorToolVector

Private Member Functions
void	CalculateOverlapResult (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW)
	Calculate cluster overlap result and store in container. More...

pandora::StatusCode	CalculateOverlapResult (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW, TransverseOverlapResult &overlapResult)
	Calculate the overlap result for given group of clusters. More...

void	GetFitSegmentTensor (const TwoDSlidingFitResult &slidingFitResultU, const TwoDSlidingFitResult &slidingFitResultV, const TwoDSlidingFitResult &slidingFitResultW, FitSegmentTensor &fitSegmentTensor) const
	Get the number of matched points for three fit segments and accompanying sliding fit results. More...

pandora::StatusCode	GetSegmentOverlap (const FitSegment &fitSegmentU, const FitSegment &fitSegmentV, const FitSegment &fitSegmentW, const TwoDSlidingFitResult &slidingFitResultU, const TwoDSlidingFitResult &slidingFitResultV, const TwoDSlidingFitResult &slidingFitResultW, TransverseOverlapResult &transverseOverlapResult) const
	Get the overlap result for three fit segments and the accompanying sliding fit results. More...

void	GetBestOverlapResult (const FitSegmentTensor &fitSegmentTensor, TransverseOverlapResult &bestTransverseOverlapResult) const
	Get the best overlap result, by examining the fit segment tensor. More...

void	GetPreviousOverlapResults (const unsigned int indexU, const unsigned int indexV, const unsigned int indexW, FitSegmentTensor &fitSegmentSumTensor, TransverseOverlapResultVector &transverseOverlapResultVector) const
	Get track overlap results for possible connected segments. More...

void	ExamineOverlapContainer ()
	Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required. More...

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

Private Attributes
TensorToolVector	m_algorithmToolVector
	The algorithm tool vector. More...

unsigned int	m_nMaxTensorToolRepeats
	The maximum number of repeat loops over tensor tools. More...

unsigned int	m_maxFitSegmentIndex
	The maximum number of fit segments used when identifying best overlap result. More...

float	m_pseudoChi2Cut
	The pseudo chi2 cut to identify matched sampling points. More...

float	m_minSegmentMatchedFraction
	The minimum segment matched sampling fraction to allow segment grouping. More...

unsigned int	m_minSegmentMatchedPoints
	The minimum number of matched segment sampling points to allow segment grouping. More...

float	m_minOverallMatchedFraction
	The minimum matched sampling fraction to allow particle creation. More...

unsigned int	m_minOverallMatchedPoints
	The minimum number of matched segment sampling points to allow particle creation. More...

float	m_minSamplingPointsPerLayer
	The minimum number of sampling points per layer to allow particle creation. More...

Detailed Description

ThreeViewTransverseTracksAlgorithm class.

Definition at line 29 of file ThreeViewTransverseTracksAlgorithm.h.

Member Typedef Documentation

typedef NViewTrackMatchingAlgorithm<ThreeViewMatchingControl<TransverseOverlapResult> > lar_content::ThreeViewTransverseTracksAlgorithm::BaseAlgorithm

Definition at line 32 of file ThreeViewTransverseTracksAlgorithm.h.

typedef std::map<unsigned int, FitSegmentToOverlapResultMap> lar_content::ThreeViewTransverseTracksAlgorithm::FitSegmentMatrix

private

Definition at line 41 of file ThreeViewTransverseTracksAlgorithm.h.

typedef std::map<unsigned int, FitSegmentMatrix> lar_content::ThreeViewTransverseTracksAlgorithm::FitSegmentTensor

private

Definition at line 42 of file ThreeViewTransverseTracksAlgorithm.h.

typedef std::map<unsigned int, TransverseOverlapResult> lar_content::ThreeViewTransverseTracksAlgorithm::FitSegmentToOverlapResultMap

private

Definition at line 40 of file ThreeViewTransverseTracksAlgorithm.h.

typedef ThreeViewMatchingControl< TransverseOverlapResult > lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::MatchingType

inherited

Definition at line 23 of file NViewMatchingAlgorithm.h.

typedef std::vector<TransverseTensorTool *> lar_content::ThreeViewTransverseTracksAlgorithm::TensorToolVector

private

Definition at line 109 of file ThreeViewTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeViewTransverseTracksAlgorithm::ThreeViewTransverseTracksAlgorithm ( )

Default constructor.

Definition at line 21 of file ThreeViewTransverseTracksAlgorithm.cc.

References CalculateOverlapResult(), f, GetBestOverlapResult(), lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetCachedSlidingFitResult(), GetFitSegmentTensor(), lar_content::TrackOverlapResult::GetMatchedFraction(), lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetMatchingControl(), lar_content::TwoDSlidingFitResult::GetMaxLayer(), lar_content::TwoDSlidingFitResult::GetMinLayer(), lar_content::TrackOverlapResult::GetNMatchedSamplingPoints(), lar_content::TrackOverlapResult::GetNSamplingPoints(), lar_content::ThreeViewMatchingControl< T >::GetOverlapTensor(), lar_content::TrackOverlapResult::IsInitialized(), m_minOverallMatchedFraction, m_minOverallMatchedPoints, m_minSamplingPointsPerLayer, and lar_content::OverlapTensor< T >::SetOverlapResult().

                                                                        :
     m_nMaxTensorToolRepeats(1000),
     m_maxFitSegmentIndex(50),
     m_pseudoChi2Cut(3.f),
     m_minSegmentMatchedFraction(0.1f),
     m_minSegmentMatchedPoints(3),
     m_minOverallMatchedFraction(0.5f),
     m_minOverallMatchedPoints(10),
     m_minSamplingPointsPerLayer(0.1f)
 {
 }

Member Function Documentation

void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::AddToSlidingFitCache ( const pandora::Cluster *const pCluster )

protectedinherited

Add a new sliding fit result, for the specified cluster, to the algorithm cache.

Parameters

pCluster address of the relevant cluster

void lar_content::ThreeViewTransverseTracksAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::Cluster *const	pCluster3
	)

privatevirtual

Calculate cluster overlap result and store in container.

Parameters

pCluster1	address of cluster1
pCluster2	address of cluster2
pCluster3	address of cluster3

Implements lar_content::MatchingBaseAlgorithm.

Referenced by ThreeViewTransverseTracksAlgorithm().

pandora::StatusCode lar_content::ThreeViewTransverseTracksAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pClusterU,
		const pandora::Cluster *const	pClusterV,
		const pandora::Cluster *const	pClusterW,
		TransverseOverlapResult &	overlapResult
	)

private

Calculate the overlap result for given group of clusters.

Parameters

pClusterU	the cluster from the U view
pClusterV	the cluster from the V view
pClusterW	the cluster from the W view
overlapResult	to receive the overlap result

Returns: statusCode, faster than throwing in regular use-cases

bool lar_content::MatchingBaseAlgorithm::CreateThreeDParticles ( const ProtoParticleVector & protoParticleVector )

virtualinherited

Create particles using findings from recent algorithm processing.

Parameters

protoParticleVector	the proto particle vector
whether	particles were created

Definition at line 88 of file MatchingBaseAlgorithm.cc.

 {
     bool particlesMade(false);
     const PfoList *pPfoList(nullptr);
     std::string pfoListName;
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pPfoList, pfoListName));
 
     for (const ProtoParticle &protoParticle : protoParticleVector)
     {
         PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
         this->SetPfoParameters(protoParticle, pfoParameters);
 
         const ParticleFlowObject *pPfo(nullptr);
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::Create(*this, pfoParameters, pPfo));
         particlesMade = true;
     }
 
     if (!pPfoList->empty())
     {
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Pfo>(*this, m_outputPfoListName));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Pfo>(*this, m_outputPfoListName));
     }
 
     return particlesMade;
 }

void lar_content::ThreeViewTransverseTracksAlgorithm::ExamineOverlapContainer ( )

privatevirtual

Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required.

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 297 of file ThreeViewTransverseTracksAlgorithm.cc.

References m_algorithmToolVector, and m_nMaxTensorToolRepeats.

 {
     unsigned int repeatCounter(0);
 
     for (TensorToolVector::const_iterator iter = m_algorithmToolVector.begin(), iterEnd = m_algorithmToolVector.end(); iter != iterEnd;)
     {
         if ((*iter)->Run(this, this->GetMatchingControl().GetOverlapTensor()))
         {
             iter = m_algorithmToolVector.begin();
 
             if (++repeatCounter > m_nMaxTensorToolRepeats)
                 break;
         }
         else
         {
             ++iter;
         }
     }
 }

void lar_content::ThreeViewTransverseTracksAlgorithm::GetBestOverlapResult	(	const FitSegmentTensor &	fitSegmentTensor,
		TransverseOverlapResult &	bestTransverseOverlapResult
	)		const

private

Get the best overlap result, by examining the fit segment tensor.

Parameters

fitSegmentTensor	the fit segment tensor
bestTransverseOverlapResult	to receive the best transverse overlap result

Definition at line 193 of file ThreeViewTransverseTracksAlgorithm.cc.

References GetPreviousOverlapResults(), lar_content::TrackOverlapResult::IsInitialized(), and m_maxFitSegmentIndex.

Referenced by ThreeViewTransverseTracksAlgorithm().

 {
     if (fitSegmentTensor.empty())
     {
         bestTransverseOverlapResult = TransverseOverlapResult();
         return;
     }
 
     unsigned int maxIndexU(0), maxIndexV(0), maxIndexW(0);
     for (FitSegmentTensor::const_iterator tIter = fitSegmentTensor.begin(), tIterEnd = fitSegmentTensor.end(); tIter != tIterEnd; ++tIter)
     {
         maxIndexU = std::max(tIter->first, maxIndexU);
 
         for (FitSegmentMatrix::const_iterator mIter = tIter->second.begin(), mIterEnd = tIter->second.end(); mIter != mIterEnd; ++mIter)
         {
             maxIndexV = std::max(mIter->first, maxIndexV);
 
             for (FitSegmentToOverlapResultMap::const_iterator rIter = mIter->second.begin(), rIterEnd = mIter->second.end(); rIter != rIterEnd; ++rIter)
                 maxIndexW = std::max(rIter->first, maxIndexW);
         }
     }
 
     // ATTN Protect against longitudinal tracks winding back and forth; can cause large number of memory allocations
     maxIndexU = std::min(m_maxFitSegmentIndex, maxIndexU);
     maxIndexV = std::min(m_maxFitSegmentIndex, maxIndexV);
     maxIndexW = std::min(m_maxFitSegmentIndex, maxIndexW);
 
     FitSegmentTensor fitSegmentSumTensor;
     for (unsigned int indexU = 0; indexU <= maxIndexU; ++indexU)
     {
         for (unsigned int indexV = 0; indexV <= maxIndexV; ++indexV)
         {
             for (unsigned int indexW = 0; indexW <= maxIndexW; ++indexW)
             {
                 TransverseOverlapResultVector transverseOverlapResultVector;
                 this->GetPreviousOverlapResults(indexU, indexV, indexW, fitSegmentSumTensor, transverseOverlapResultVector);
 
                 TransverseOverlapResultVector::const_iterator maxElement =
                     std::max_element(transverseOverlapResultVector.begin(), transverseOverlapResultVector.end());
                 TransverseOverlapResult maxTransverseOverlapResult(
                     (transverseOverlapResultVector.end() != maxElement) ? *maxElement : TransverseOverlapResult());
 
                 TransverseOverlapResult thisOverlapResult;
                 if (fitSegmentTensor.count(indexU) && (fitSegmentTensor.find(indexU))->second.count(indexV) &&
                     ((fitSegmentTensor.find(indexU))->second.find(indexV))->second.count(indexW))
                     thisOverlapResult = (((fitSegmentTensor.find(indexU))->second.find(indexV))->second.find(indexW))->second;
 
                 if (!thisOverlapResult.IsInitialized() && !maxTransverseOverlapResult.IsInitialized())
                     continue;
 
                 fitSegmentSumTensor[indexU][indexV][indexW] = thisOverlapResult + maxTransverseOverlapResult;
             }
         }
     }
 
     for (unsigned int indexU = 0; indexU <= maxIndexU; ++indexU)
     {
         for (unsigned int indexV = 0; indexV <= maxIndexV; ++indexV)
         {
             for (unsigned int indexW = 0; indexW <= maxIndexW; ++indexW)
             {
                 const TransverseOverlapResult &transverseOverlapResult(fitSegmentSumTensor[indexU][indexV][indexW]);
 
                 if (!transverseOverlapResult.IsInitialized())
                     continue;
 
                 if (transverseOverlapResult > bestTransverseOverlapResult)
                     bestTransverseOverlapResult = transverseOverlapResult;
             }
         }
     }
 }

const TwoDSlidingFitResult& lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetCachedSlidingFitResult ( const pandora::Cluster *const pCluster ) const

inherited

Get a sliding fit result from the algorithm cache.

Parameters

pCluster address of the relevant cluster

Referenced by ThreeViewTransverseTracksAlgorithm().

const std::string& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetClusterListName ( const pandora::HitType hitType ) const

virtualinherited

Get the cluster list name corresponding to a specified hit type.

Parameters

hitType the hit type

Returns: the cluster list name

Implements lar_content::MatchingBaseAlgorithm.

void lar_content::ThreeViewTransverseTracksAlgorithm::GetFitSegmentTensor	(	const TwoDSlidingFitResult &	slidingFitResultU,
		const TwoDSlidingFitResult &	slidingFitResultV,
		const TwoDSlidingFitResult &	slidingFitResultW,
		FitSegmentTensor &	fitSegmentTensor
	)		const

private

Get the number of matched points for three fit segments and accompanying sliding fit results.

Parameters

slidingFitResultU	sliding fit result for u cluster
slidingFitResultV	sliding fit result for v cluster
slidingFitResultW	sliding fit result for w cluster
fitSegmentTensor	the fit segment tensor

Definition at line 87 of file ThreeViewTransverseTracksAlgorithm.cc.

References lar_content::TwoDSlidingFitResult::GetFitSegmentList(), GetSegmentOverlap(), m_minSegmentMatchedFraction, and m_minSegmentMatchedPoints.

Referenced by ThreeViewTransverseTracksAlgorithm().

 {
     FitSegmentList fitSegmentListU(slidingFitResultU.GetFitSegmentList());
     FitSegmentList fitSegmentListV(slidingFitResultV.GetFitSegmentList());
     FitSegmentList fitSegmentListW(slidingFitResultW.GetFitSegmentList());
 
     for (unsigned int indexU = 0, indexUEnd = fitSegmentListU.size(); indexU < indexUEnd; ++indexU)
     {
         const FitSegment &fitSegmentU(fitSegmentListU.at(indexU));
 
         for (unsigned int indexV = 0, indexVEnd = fitSegmentListV.size(); indexV < indexVEnd; ++indexV)
         {
             const FitSegment &fitSegmentV(fitSegmentListV.at(indexV));
 
             for (unsigned int indexW = 0, indexWEnd = fitSegmentListW.size(); indexW < indexWEnd; ++indexW)
             {
                 const FitSegment &fitSegmentW(fitSegmentListW.at(indexW));
 
                 TransverseOverlapResult segmentOverlap;
                 if (STATUS_CODE_SUCCESS !=
                     this->GetSegmentOverlap(fitSegmentU, fitSegmentV, fitSegmentW, slidingFitResultU, slidingFitResultV, slidingFitResultW, segmentOverlap))
                     continue;
 
                 if ((segmentOverlap.GetMatchedFraction() < m_minSegmentMatchedFraction) ||
                     (segmentOverlap.GetNMatchedSamplingPoints() < m_minSegmentMatchedPoints))
                     continue;
 
                 fitSegmentTensor[indexU][indexV][indexW] = segmentOverlap;
             }
         }
     }
 }

const pandora::ClusterList& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetInputClusterList ( const pandora::HitType hitType ) const

virtualinherited

Get the input cluster list corresponding to a specified hit type.

Parameters

hitType the hit type

Returns: the input cluster list

Implements lar_content::MatchingBaseAlgorithm.

MatchingType& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetMatchingControl ( )

protectedinherited

Get the matching control.

Referenced by ThreeViewTransverseTracksAlgorithm().

void lar_content::ThreeViewTransverseTracksAlgorithm::GetPreviousOverlapResults	(	const unsigned int	indexU,
		const unsigned int	indexV,
		const unsigned int	indexW,
		FitSegmentTensor &	fitSegmentSumTensor,
		TransverseOverlapResultVector &	transverseOverlapResultVector
	)		const

private

Get track overlap results for possible connected segments.

Parameters

indexU	the index u
indexV	the index v
indexW	the index w
transverseOverlapResultVector	the transverse overlap result vector

Definition at line 269 of file ThreeViewTransverseTracksAlgorithm.cc.

References lar_content::TrackOverlapResult::IsInitialized(), and x1.

Referenced by GetBestOverlapResult().

 {
     for (unsigned int iPermutation = 1; iPermutation < 8; ++iPermutation)
     {
         const bool decrementU((iPermutation >> 0) & 0x1);
         const bool decrementV((iPermutation >> 1) & 0x1);
         const bool decrementW((iPermutation >> 2) & 0x1);
 
         if ((decrementU && (0 == indexU)) || (decrementV && (0 == indexV)) || (decrementW && (0 == indexW)))
             continue;
 
         const unsigned int newIndexU(decrementU ? indexU - 1 : indexU);
         const unsigned int newIndexV(decrementV ? indexV - 1 : indexV);
         const unsigned int newIndexW(decrementW ? indexW - 1 : indexW);
 
         const TransverseOverlapResult &transverseOverlapResult(fitSegmentSumTensor[newIndexU][newIndexV][newIndexW]);
 
         if (transverseOverlapResult.IsInitialized())
             transverseOverlapResultVector.push_back(transverseOverlapResult);
     }
 
     if (transverseOverlapResultVector.empty())
         transverseOverlapResultVector.push_back(TransverseOverlapResult());
 }

StatusCode lar_content::ThreeViewTransverseTracksAlgorithm::GetSegmentOverlap	(	const FitSegment &	fitSegmentU,
		const FitSegment &	fitSegmentV,
		const FitSegment &	fitSegmentW,
		const TwoDSlidingFitResult &	slidingFitResultU,
		const TwoDSlidingFitResult &	slidingFitResultV,
		const TwoDSlidingFitResult &	slidingFitResultW,
		TransverseOverlapResult &	transverseOverlapResult
	)		const

private

Get the overlap result for three fit segments and the accompanying sliding fit results.

Parameters

fitSegmentU	the fit segment u
fitSegmentV	the fit segment v
fitSegmentW	the fit segment w
slidingFitResultU	sliding fit result for u cluster
slidingFitResultV	sliding fit result for v cluster
slidingFitResultW	sliding fit result for w cluster
transverseOverlapResult	to receive the transverse overlap result

Returns: statusCode, faster than throwing in regular use-cases

Definition at line 123 of file ThreeViewTransverseTracksAlgorithm.cc.

References f, lar_content::FitSegment::GetEndLayer(), lar_content::FitSegment::GetMaxX(), lar_content::FitSegment::GetMinX(), lar_content::FitSegment::GetStartLayer(), lar_content::TwoDSlidingFitResult::GetTransverseProjection(), m_pseudoChi2Cut, lar_content::LArGeometryHelper::MergeTwoPositions(), n, w, and x.

Referenced by GetFitSegmentTensor().

 {
     // Assess x-overlap
     const float xSpanU(fitSegmentU.GetMaxX() - fitSegmentU.GetMinX());
     const float xSpanV(fitSegmentV.GetMaxX() - fitSegmentV.GetMinX());
     const float xSpanW(fitSegmentW.GetMaxX() - fitSegmentW.GetMinX());
 
     const float minX(std::max(fitSegmentU.GetMinX(), std::max(fitSegmentV.GetMinX(), fitSegmentW.GetMinX())));
     const float maxX(std::min(fitSegmentU.GetMaxX(), std::min(fitSegmentV.GetMaxX(), fitSegmentW.GetMaxX())));
     const float xOverlap(maxX - minX);
 
     if (xOverlap < std::numeric_limits<float>::epsilon())
         return STATUS_CODE_NOT_FOUND;
 
     // Sampling in x
     const float nPointsU(std::fabs((xOverlap / xSpanU) * static_cast<float>(fitSegmentU.GetEndLayer() - fitSegmentU.GetStartLayer())));
     const float nPointsV(std::fabs((xOverlap / xSpanV) * static_cast<float>(fitSegmentV.GetEndLayer() - fitSegmentV.GetStartLayer())));
     const float nPointsW(std::fabs((xOverlap / xSpanW) * static_cast<float>(fitSegmentW.GetEndLayer() - fitSegmentW.GetStartLayer())));
 
     const unsigned int nPoints(1 + static_cast<unsigned int>((nPointsU + nPointsV + nPointsW) / 3.f));
 
     // Chi2 calculations
     float pseudoChi2Sum(0.f);
     unsigned int nSamplingPoints(0), nMatchedSamplingPoints(0);
 
     for (unsigned int n = 0; n <= nPoints; ++n)
     {
         const float x(minX + (maxX - minX) * static_cast<float>(n) / static_cast<float>(nPoints));
 
         CartesianVector fitUVector(0.f, 0.f, 0.f), fitVVector(0.f, 0.f, 0.f), fitWVector(0.f, 0.f, 0.f);
         CartesianVector fitUDirection(0.f, 0.f, 0.f), fitVDirection(0.f, 0.f, 0.f), fitWDirection(0.f, 0.f, 0.f);
 
         if ((STATUS_CODE_SUCCESS != slidingFitResultU.GetTransverseProjection(x, fitSegmentU, fitUVector, fitUDirection)) ||
             (STATUS_CODE_SUCCESS != slidingFitResultV.GetTransverseProjection(x, fitSegmentV, fitVVector, fitVDirection)) ||
             (STATUS_CODE_SUCCESS != slidingFitResultW.GetTransverseProjection(x, fitSegmentW, fitWVector, fitWDirection)))
         {
             continue;
         }
 
         const float u(fitUVector.GetZ()), v(fitVVector.GetZ()), w(fitWVector.GetZ());
         const float uv2w(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, u, v));
         const float uw2v(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_W, u, w));
         const float vw2u(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_V, TPC_VIEW_W, v, w));
 
         ++nSamplingPoints;
         const float deltaU((vw2u - u) * fitUDirection.GetX());
         const float deltaV((uw2v - v) * fitVDirection.GetX());
         const float deltaW((uv2w - w) * fitWDirection.GetX());
 
         const float pseudoChi2(deltaW * deltaW + deltaV * deltaV + deltaU * deltaU);
         pseudoChi2Sum += pseudoChi2;
 
         if (pseudoChi2 < m_pseudoChi2Cut)
             ++nMatchedSamplingPoints;
     }
 
     if (0 == nSamplingPoints)
         return STATUS_CODE_NOT_FOUND;
 
     const XOverlap xOverlapObject(fitSegmentU.GetMinX(), fitSegmentU.GetMaxX(), fitSegmentV.GetMinX(), fitSegmentV.GetMaxX(),
         fitSegmentW.GetMinX(), fitSegmentW.GetMaxX(), xOverlap);
 
     transverseOverlapResult = TransverseOverlapResult(nMatchedSamplingPoints, nSamplingPoints, pseudoChi2Sum, xOverlapObject);
     return STATUS_CODE_SUCCESS;
 }

const pandora::ClusterList& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetSelectedClusterList ( const pandora::HitType hitType ) const

virtualinherited

Get the selected cluster list corresponding to a specified hit type.

Parameters

hitType the hit type

Returns: the selected cluster list

Implements lar_content::MatchingBaseAlgorithm.

unsigned int lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::GetSlidingFitWindow ( ) const

inherited

Get the layer window for the sliding linear fits.

Returns: the layer window for the sliding linear fits

bool lar_content::MatchingBaseAlgorithm::MakeClusterMerges ( const ClusterMergeMap & clusterMergeMap )

virtualinherited

Merge clusters together.

Parameters

clusterMergeMap the cluster merge map

Returns: whether changes to the overlap container have been made

Definition at line 48 of file MatchingBaseAlgorithm.cc.

Referenced by lar_content::SplitShowersTool::ApplyChanges(), lar_content::ThreeDKinkBaseTool::ApplyChanges(), lar_content::TwoViewThreeDKinkTool::ApplyChanges(), lar_content::ConnectedRemnantsTool::Run(), and lar_content::MissingTrackSegmentTool::Run().

 {
     ClusterSet deletedClusters;
 
     ClusterList parentClusters;
     for (const auto &mapEntry : clusterMergeMap)
         parentClusters.push_back(mapEntry.first);
     parentClusters.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : parentClusters)
     {
         const HitType hitType(LArClusterHelper::GetClusterHitType(pParentCluster));
         const std::string &clusterListName(this->GetClusterListName(hitType));
 
         if (!((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType)))
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         ClusterList daughterClusters(clusterMergeMap.at(pParentCluster));
         daughterClusters.sort(LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : daughterClusters)
         {
             if (deletedClusters.count(pParentCluster) || deletedClusters.count(pDaughterCluster))
                 throw StatusCodeException(STATUS_CODE_FAILURE);
 
             this->UpdateUponDeletion(pDaughterCluster);
             this->UpdateUponDeletion(pParentCluster);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                 PandoraContentApi::MergeAndDeleteClusters(*this, pParentCluster, pDaughterCluster, clusterListName, clusterListName));
 
             this->UpdateForNewCluster(pParentCluster);
             deletedClusters.insert(pDaughterCluster);
         }
     }
 
     return !(deletedClusters.empty());
 }

virtual bool lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::MakeClusterSplit	(	const pandora::CartesianVector &	splitPosition,
		const pandora::Cluster *&	pCurrentCluster,
		const pandora::Cluster *&	pLowXCluster,
		const pandora::Cluster *&	pHighXCluster
	)		const

virtualinherited

Make a cluster split.

Parameters

splitPosition	the split position
pCurrentCluster	the cluster to split
pLowXCluster	to receive the low x cluster
pHighXCluster	to receive the high x cluster

Returns: whether a cluster split occurred

virtual bool lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::MakeClusterSplits ( const SplitPositionMap & splitPositionMap )

virtualinherited

Make cluster splits.

Parameters

splitPositionMap the split position map

Returns: whether changes to the overlap container have been made

virtual void lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::PerformMainLoop ( )

protectedvirtualinherited

Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult.

Implements lar_content::MatchingBaseAlgorithm.

virtual void lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::PrepareAllInputClusters ( )

protectedvirtualinherited

Perform any preparatory steps required, e.g. caching expensive fit results for clusters.

Implements lar_content::MatchingBaseAlgorithm.

virtual void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::PrepareInputClusters ( pandora::ClusterList & preparedClusterList )

virtualinherited

Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results.

Parameters

preparedClusterList to receive the prepared cluster list, non const so as to be able to modify input selected list

Reimplemented from lar_content::MatchingBaseAlgorithm.

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

privatevirtual

Reimplemented from lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >.

Definition at line 320 of file ThreeViewTransverseTracksAlgorithm.cc.

References m_algorithmToolVector, m_maxFitSegmentIndex, m_minOverallMatchedFraction, m_minOverallMatchedPoints, m_minSamplingPointsPerLayer, m_minSegmentMatchedFraction, m_minSegmentMatchedPoints, m_nMaxTensorToolRepeats, m_pseudoChi2Cut, and lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::ReadSettings().

 {
     AlgorithmToolVector algorithmToolVector;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "TrackTools", algorithmToolVector));
 
     for (AlgorithmToolVector::const_iterator iter = algorithmToolVector.begin(), iterEnd = algorithmToolVector.end(); iter != iterEnd; ++iter)
     {
         TransverseTensorTool *const pTransverseTensorTool(dynamic_cast<TransverseTensorTool *>(*iter));
 
         if (!pTransverseTensorTool)
             return STATUS_CODE_INVALID_PARAMETER;
 
         m_algorithmToolVector.push_back(pTransverseTensorTool);
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NMaxTensorToolRepeats", m_nMaxTensorToolRepeats));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxFitSegmentIndex", m_maxFitSegmentIndex));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PseudoChi2Cut", m_pseudoChi2Cut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinSegmentMatchedFraction", m_minSegmentMatchedFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinSegmentMatchedPoints", m_minSegmentMatchedPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinOverallMatchedFraction", m_minOverallMatchedFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinOverallMatchedPoints", m_minOverallMatchedPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinSamplingPointsPerLayer", m_minSamplingPointsPerLayer));
 
     return BaseAlgorithm::ReadSettings(xmlHandle);
 }

void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::RemoveFromSlidingFitCache ( const pandora::Cluster *const pCluster )

protectedinherited

Remova an existing sliding fit result, for the specified cluster, from the algorithm cache.

Parameters

pCluster address of the relevant cluster

virtual void lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::SelectAllInputClusters ( )

protectedvirtualinherited

Select a subset of input clusters for processing in this algorithm.

Implements lar_content::MatchingBaseAlgorithm.

virtual void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::SelectInputClusters	(	const pandora::ClusterList *const	pInputClusterList,
		pandora::ClusterList &	selectedClusterList
	)		const

virtualinherited

Select a subset of input clusters for processing in this algorithm.

Parameters

pInputClusterList	address of an input cluster list
selectedClusterList	to receive the selected cluster list

Reimplemented from lar_content::MatchingBaseAlgorithm.

void lar_content::MatchingBaseAlgorithm::SetPfoParameters	(	const ProtoParticle &	protoParticle,
		PandoraContentApi::ParticleFlowObject::Parameters &	pfoParameters
	)		const

virtualinherited

Set Pfo properties.

Parameters

protoParticle	the input proto particle
pfoParameters	the output pfo parameters

Definition at line 116 of file MatchingBaseAlgorithm.cc.

References f, and lar_content::ProtoParticle::m_clusterList.

 {
     this->SetPfoParticleId(pfoParameters);
     pfoParameters.m_charge = PdgTable::GetParticleCharge(pfoParameters.m_particleId.Get());
     pfoParameters.m_mass = PdgTable::GetParticleMass(pfoParameters.m_particleId.Get());
     pfoParameters.m_energy = 0.f;
     pfoParameters.m_momentum = CartesianVector(0.f, 0.f, 0.f);
     pfoParameters.m_clusterList = protoParticle.m_clusterList;
 }

virtual void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::SetPfoParticleId ( PandoraContentApi::ParticleFlowObject::Parameters & pfoParameters ) const

virtualinherited

Set pfo particle id.

Parameters

pfoParameters the output pfo parameters

Reimplemented from lar_content::MatchingBaseAlgorithm.

static bool lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::SortSplitPositions	(	const pandora::CartesianVector &	lhs,
		const pandora::CartesianVector &	rhs
	)

staticinherited

Sort split position cartesian vectors by increasing x coordinate.

Parameters

lhs	the first cartesian vector
rhs	the second cartesian vector

virtual void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::TidyUp ( )

protectedvirtualinherited

Tidy member variables in derived class.

Reimplemented from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >.

virtual void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::UpdateForNewCluster ( const pandora::Cluster *const pNewCluster )

virtualinherited

Update to reflect addition of a new cluster to the problem space.

Parameters

pNewCluster address of the new cluster

Reimplemented from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >.

virtual void lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::UpdateUponDeletion ( const pandora::Cluster *const pDeletedCluster )

virtualinherited

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Reimplemented from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >.

Member Data Documentation

TensorToolVector lar_content::ThreeViewTransverseTracksAlgorithm::m_algorithmToolVector

private

The algorithm tool vector.

Definition at line 110 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by ExamineOverlapContainer(), and ReadSettings().

MatchingType lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >::m_matchingControl

protectedinherited

The matching control.

Definition at line 53 of file NViewMatchingAlgorithm.h.

unsigned int lar_content::ThreeViewTransverseTracksAlgorithm::m_maxFitSegmentIndex

private

The maximum number of fit segments used when identifying best overlap result.

Definition at line 113 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by GetBestOverlapResult(), and ReadSettings().

float lar_content::ThreeViewTransverseTracksAlgorithm::m_minOverallMatchedFraction

private

The minimum matched sampling fraction to allow particle creation.

Definition at line 117 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by ReadSettings(), and ThreeViewTransverseTracksAlgorithm().

unsigned int lar_content::ThreeViewTransverseTracksAlgorithm::m_minOverallMatchedPoints

private

The minimum number of matched segment sampling points to allow particle creation.

Definition at line 118 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by ReadSettings(), and ThreeViewTransverseTracksAlgorithm().

float lar_content::ThreeViewTransverseTracksAlgorithm::m_minSamplingPointsPerLayer

private

The minimum number of sampling points per layer to allow particle creation.

Definition at line 119 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by ReadSettings(), and ThreeViewTransverseTracksAlgorithm().

float lar_content::ThreeViewTransverseTracksAlgorithm::m_minSegmentMatchedFraction

private

The minimum segment matched sampling fraction to allow segment grouping.

Definition at line 115 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by GetFitSegmentTensor(), and ReadSettings().

unsigned int lar_content::ThreeViewTransverseTracksAlgorithm::m_minSegmentMatchedPoints

private

The minimum number of matched segment sampling points to allow segment grouping.

Definition at line 116 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by GetFitSegmentTensor(), and ReadSettings().

unsigned int lar_content::ThreeViewTransverseTracksAlgorithm::m_nMaxTensorToolRepeats

private

The maximum number of repeat loops over tensor tools.

Definition at line 112 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by ExamineOverlapContainer(), and ReadSettings().

float lar_content::ThreeViewTransverseTracksAlgorithm::m_pseudoChi2Cut

private

The pseudo chi2 cut to identify matched sampling points.

Definition at line 114 of file ThreeViewTransverseTracksAlgorithm.h.

Referenced by GetSegmentOverlap(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ThreeViewTransverseTracksAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ThreeViewTransverseTracksAlgorithm.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation