TwoViewTransverseTracksAlgorithm class. More...

#include <TwoViewTransverseTracksAlgorithm.h>

Inheritance diagram for lar_content::TwoViewTransverseTracksAlgorithm:

Public Types
typedef NViewTrackMatchingAlgorithm < TwoViewMatchingControl < TwoViewTransverseOverlapResult > >	BaseAlgorithm

typedef std::set< unsigned int >	UIntSet

Public Types inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
typedef TwoViewMatchingControl < TwoViewTransverseOverlapResult >	MatchingType

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

Public Member Functions inherited from lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
	NViewTrackMatchingAlgorithm ()
	Default constructor. More...

virtual	~NViewTrackMatchingAlgorithm ()
	Destructor. 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...

Public Member Functions inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
	NViewMatchingAlgorithm ()
	Default constructor. More...

virtual	~NViewMatchingAlgorithm ()
	Destructor. 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...

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

virtual	~MatchingBaseAlgorithm ()
	Destructor. 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...

Private Types
typedef std::vector < TransverseMatrixTool * >	MatrixToolVector

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

pandora::StatusCode	CalculateOverlapResult (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, TwoViewTransverseOverlapResult &overlapResult)
	Calculates the two view overlap result. More...

unsigned int	CalculateNumberOfLocallyMatchingSamplingPoints (const DiscreteProbabilityVector &discreteProbabilityVector1, const DiscreteProbabilityVector &discreteProbabilityVector2, std::mt19937 &randomNumberGenerator)
	Calculates the number of the sliding windows that contains charge bins that locally match. More...

float	GetPrimaryAxisDotDriftAxis (const pandora::Cluster *const pCluster)
	Get the dot product between the cluster's primary axis and the drift axis. 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
MatrixToolVector	m_algorithmToolVector
	The algorithm tool vector. More...

unsigned int	m_nMaxMatrixToolRepeats
	The maximum number of repeat loops over matrix tools. More...

unsigned int	m_downsampleFactor
	The downsampling (hit merging) applied to hits in the overlap region. More...

unsigned int	m_minSamples
	The minimum number of samples needed for comparing charges. More...

unsigned int	m_nPermutations
	The number of permutations for calculating p-values. More...

float	m_localMatchingScoreThreshold
	The minimum score to classify a local region as matching. More...

float	m_maxDotProduct

float	m_minOverallMatchingScore
	M The maximum allowed cluster primary qxis Dot drift axis to fill the overlap result. More...

float	m_minOverallLocallyMatchedFraction
	The minimum required lcoally matched fraction to fill the overlap result. More...

std::mt19937	m_randomNumberGenerator
	The random number generator. More...

Additional Inherited Members
Static Public Member Functions inherited from lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
static bool	SortSplitPositions (const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs)
	Sort split position cartesian vectors by increasing x coordinate. More...

Protected Member Functions inherited from lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
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...

Protected Member Functions inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
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 inherited from lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >
MatchingType	m_matchingControl
	The matching control. More...

Detailed Description

TwoViewTransverseTracksAlgorithm class.

Definition at line 32 of file TwoViewTransverseTracksAlgorithm.h.

Member Typedef Documentation

typedef NViewTrackMatchingAlgorithm<TwoViewMatchingControl<TwoViewTransverseOverlapResult> > lar_content::TwoViewTransverseTracksAlgorithm::BaseAlgorithm

Definition at line 35 of file TwoViewTransverseTracksAlgorithm.h.

typedef std::vector<TransverseMatrixTool *> lar_content::TwoViewTransverseTracksAlgorithm::MatrixToolVector

private

Definition at line 80 of file TwoViewTransverseTracksAlgorithm.h.

typedef std::set<unsigned int> lar_content::TwoViewTransverseTracksAlgorithm::UIntSet

Definition at line 36 of file TwoViewTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TwoViewTransverseTracksAlgorithm::TwoViewTransverseTracksAlgorithm ( )

Default constructor.

Definition at line 23 of file TwoViewTransverseTracksAlgorithm.cc.

                                                                    :
     m_nMaxMatrixToolRepeats(1000),
     m_downsampleFactor(5),
     m_minSamples(11),
     m_nPermutations(1000),
     m_localMatchingScoreThreshold(0.99f),
     m_maxDotProduct(0.998f),
     m_minOverallMatchingScore(0.1f),
     m_minOverallLocallyMatchedFraction(0.1f),
     m_randomNumberGenerator(static_cast<std::mt19937::result_type>(0))
 {
 }

Member Function Documentation

unsigned int lar_content::TwoViewTransverseTracksAlgorithm::CalculateNumberOfLocallyMatchingSamplingPoints	(	const DiscreteProbabilityVector &	discreteProbabilityVector1,
		const DiscreteProbabilityVector &	discreteProbabilityVector2,
		std::mt19937 &	randomNumberGenerator
	)

private

Calculates the number of the sliding windows that contains charge bins that locally match.

Parameters

discreteProbabilityVector1	the view 0 discrete probability vector containing the charge information
pCluster2	the view 1 discrete probability vector containing the charge information
randomNumberGenerator	a seeded random number generator

Returns: the number of locally matching sampling points

Definition at line 145 of file TwoViewTransverseTracksAlgorithm.cc.

 {
     if (discreteProbabilityVector1.GetSize() != discreteProbabilityVector2.GetSize() ||
         0 == discreteProbabilityVector1.GetSize() * discreteProbabilityVector2.GetSize())
         throw STATUS_CODE_INVALID_PARAMETER;
 
     if (m_minSamples > discreteProbabilityVector1.GetSize())
         throw STATUS_CODE_INVALID_PARAMETER;
 
     pandora::FloatVector localValues1, localValues2;
     unsigned int nMatchedComparisons(0);
 
     for (unsigned int iValue = 0; iValue < discreteProbabilityVector1.GetSize(); ++iValue)
     {
         localValues1.emplace_back(discreteProbabilityVector1.GetProbability(iValue));
         localValues2.emplace_back(discreteProbabilityVector2.GetProbability(iValue));
         if (localValues1.size() == m_minSamples)
         {
             float localPValue(0);
             try
             {
                 localPValue = LArDiscreteProbabilityHelper::CalculateCorrelationCoefficientPValueFromPermutationTest(
                     localValues1, localValues2, randomNumberGenerator, m_nPermutations);
             }
             catch (const StatusCodeException &)
             {
                 std::cout << "TwoViewTransverseTracksAlgorithm: failed to calculate correlation coefficient p-value for these numbers" << std::endl;
                 ;
                 std::cout << "----view 0: ";
                 for (unsigned int iElement = 0; iElement < localValues1.size(); ++iElement)
                     std::cout << localValues1.at(iElement) << " ";
                 std::cout << std::endl;
                 std::cout << "----view 1: ";
                 for (unsigned int iElement = 0; iElement < localValues2.size(); ++iElement)
                     std::cout << localValues2.at(iElement) << " ";
                 std::cout << std::endl;
             }
 
             if ((1.f - localPValue) - m_localMatchingScoreThreshold > std::numeric_limits<float>::epsilon())
                 nMatchedComparisons++;
 
             localValues1.erase(localValues1.begin());
             localValues2.erase(localValues2.begin());
         }
     }
     return nMatchedComparisons;
 }

void lar_content::TwoViewTransverseTracksAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::Cluster *	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.

pandora::StatusCode lar_content::TwoViewTransverseTracksAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		TwoViewTransverseOverlapResult &	overlapResult
	)

private

Calculates the two view overlap result.

Parameters

pCluster1	the view 0 cluster
pCluster2	the view 1 cluster
overlapResult	the two view overlap result

void lar_content::TwoViewTransverseTracksAlgorithm::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 213 of file TwoViewTransverseTracksAlgorithm.cc.

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

float lar_content::TwoViewTransverseTracksAlgorithm::GetPrimaryAxisDotDriftAxis ( const pandora::Cluster *const pCluster )

private

Get the dot product between the cluster's primary axis and the drift axis.

Parameters

pCluster the cluster

Returns: dot product

Definition at line 196 of file TwoViewTransverseTracksAlgorithm.cc.

 {
     pandora::CartesianPointVector pointVector;
     LArClusterHelper::GetCoordinateVector(pCluster, pointVector);
 
     pandora::CartesianVector centroid(0.f, 0.f, 0.f);
     LArPcaHelper::EigenVectors eigenVecs;
     LArPcaHelper::EigenValues eigenValues(0.f, 0.f, 0.f);
     LArPcaHelper::RunPca(pointVector, centroid, eigenValues, eigenVecs);
 
     const pandora::CartesianVector primaryAxis(eigenVecs.at(0));
     const pandora::CartesianVector driftAxis(1.f, 0.f, 0.f);
     return primaryAxis.GetDotProduct(driftAxis);
 }

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

privatevirtual

Reimplemented from lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >.

Definition at line 234 of file TwoViewTransverseTracksAlgorithm.cc.

 {
     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)
     {
         TransverseMatrixTool *const pTransverseMatrixTool(dynamic_cast<TransverseMatrixTool *>(*iter));
 
         if (!pTransverseMatrixTool)
             return STATUS_CODE_INVALID_PARAMETER;
 
         m_algorithmToolVector.push_back(pTransverseMatrixTool);
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NMaxMatrixToolRepeats", m_nMaxMatrixToolRepeats));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "DownsampleFactor", m_downsampleFactor));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinSamples", m_minSamples));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NPermutations", m_nPermutations));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "LocalMatchingScoreThreshold", m_localMatchingScoreThreshold));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxDotProduct", m_maxDotProduct));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinOverallMatchingScore", m_minOverallMatchingScore));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinOverallLocallyMatchedFraction", m_minOverallLocallyMatchedFraction));
 
     return BaseAlgorithm::ReadSettings(xmlHandle);
 }