ThreeViewDeltaRayMatchingAlgorithm class. More...

#include <ThreeViewDeltaRayMatchingAlgorithm.h>

Inheritance diagram for lar_content::ThreeViewDeltaRayMatchingAlgorithm:

Public Types
typedef NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >	BaseAlgorithm

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

Public Types inherited from lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
typedef std::map< const pandora::CaloHit , const pandora::Cluster >	HitToClusterMap

typedef std::map< const pandora::Cluster , const pandora::ParticleFlowObject >	ClusterToPfoMap

typedef std::map< const pandora::Cluster *, pandora::ClusterList >	ClusterProximityMap

typedef KDTreeLinkerAlgo< const pandora::CaloHit *, 2 >	HitKDTree2D

typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D

typedef std::vector< HitKDNode2D >	HitKDNode2DList

typedef std::vector< pandora::HitType >	HitTypeVector

Public Types inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
typedef ThreeViewMatchingControl< DeltaRayOverlapResult >	MatchingType

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

std::string	GetClusteringAlgName () const
	Get the name of the clustering algorithm to be used to recluster created delta ray remnants. More...

Public Member Functions inherited from lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
	NViewDeltaRayMatchingAlgorithm ()
	Default constructor. More...

pandora::StatusCode	GetMuonCluster (const pandora::PfoList &commonMuonPfoList, const pandora::HitType hitType, const pandora::Cluster *&pMuonCluster) const
	Return the cluster of the common cosmic ray pfo in a given view (function demands there to be only one common CR pfo) More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::Cluster *const pCluster3, float &reducedChiSquared) const
	To determine how well three clusters (one in each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW, float &chiSquaredSum, unsigned int &nSamplingPoints, unsigned int &nMatchedSamplingPoints, XOverlap &XOverlap) const
	To determine how well three clusters (one in each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::CaloHitList &pCluster1, const pandora::CaloHitList &pCluster2, const pandora::CaloHitList &pCluster3, float &reducedChiSquared) const
	To determine how well three CaloHitLists (one in each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	PerformThreeViewMatching (const pandora::CaloHitList &clusterU, const pandora::CaloHitList &clusterV, const pandora::CaloHitList &clusterW, float &chiSquaredSum, unsigned int &nSamplingPoints, unsigned int &nMatchedSamplingPoints, XOverlap &XOverlap) const
	To determine how well three CaloHitLists (one for each view) map onto one another expressing this in terms of a chi-squared like parameter. More...

pandora::StatusCode	ProjectMuonPositions (const pandora::HitType &thirdViewHitType, const pandora::ParticleFlowObject *const pParentMuon, pandora::CartesianPointVector &projectedPositions) const
	Use two views of a cosmic ray pfo to calculate projected positions in a given the third view. More...

pandora::StatusCode	GetProjectedPositions (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, pandora::CartesianPointVector &projectedPositions) const
	Use two clusters from different views to calculate projected positions in the remaining third view. More...

pandora::StatusCode	CollectHitsFromMuon (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::Cluster const pThirdViewCluster, const pandora::ParticleFlowObject const pParentMuon, const float minDistanceFromMuon, const float maxDistanceToCollected, pandora::CaloHitList &collectedHits) const
	In one view, pull out any hits from a cosmic ray cluster that belong to the child delta ray cluster. More...

void	CollectHitsFromMuon (const pandora::CartesianVector &positionOnMuon, const pandora::CartesianVector &muonDirection, const pandora::Cluster *const pMuonCluster, const pandora::CartesianPointVector &deltaRayProjectedPositions, const float &minDistanceFromMuon, const float maxDistanceToCollected, pandora::CaloHitList &collectedHits) const
	In one view, pull out any hits from a cosmic ray cluster that belong to the child delta ray cluster. More...

pandora::StatusCode	ParameteriseMuon (const pandora::ParticleFlowObject const pParentMuon, const pandora::Cluster const pDeltaRayCluster, pandora::CartesianVector &positionOnMuon, pandora::CartesianVector &muonDirection) const
	Parameterise the projection of a cosmic ray track in order to avoid poor/sparse projections. More...

pandora::StatusCode	ParameteriseMuon (const pandora::ParticleFlowObject *const pParentMuon, const pandora::CartesianPointVector &deltaRayProjectedPositions, const pandora::HitType hitType, pandora::CartesianVector &positionOnMuon, pandora::CartesianVector &muonDirection) const
	Parameterise the projection of a cosmic ray track in order to avoid poor/sparse projections. More...

void	SplitMuonCluster (const std::string &clusterListName, const pandora::Cluster const pMuonCluster, const pandora::CaloHitList &collectedHits, const pandora::Cluster &pDeltaRayCluster) const
	Move a list of hits from a cosmic ray cluster into the given child delta ray cluster. More...

bool	CreatePfos (ProtoParticleVector &protoParticleVector)
	Create delta ray pfos maxmising completeness by searching for and merging in any stray clusters. More...

void	UpdateForNewClusters (const pandora::ClusterVector &newClusterVector, const pandora::PfoVector &pfoVector)
	Add a new cluster to algorithm ownership maps and, if it a delta ray cluster, to the underlying matches container (tensor/matrix) More...

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

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

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

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

virtual	~NViewMatchingAlgorithm ()
	Destructor. More...

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

void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. 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...

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

Private Types
typedef std::vector< DeltaRayTensorTool * >	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...

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)

virtual bool	DoesClusterPassTensorThreshold (const pandora::Cluster *const pCluster) const
	To check whether a given cluster meets the requirements to be added into the matching container (tensor/matrix) More...

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

void	FindCommonMuonParents (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW, pandora::PfoList &commonMuonPfoList) const
	Find the cosmic ray pfos that, in each view, lie close to the clusters of the tensor element. More...

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

std::string	m_reclusteringAlgorithmName
	The name of the clustering algorithm to be used to recluster created delta ray remnants. More...

unsigned int	m_minClusterCaloHits
	The threshold number of hits for a cluster to be considered. More...

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

Additional Inherited Members
Protected Member Functions inherited from lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
void	FillStrayClusterList (const pandora::HitType hitType)
	Fill the stray cluster list with clusters that do not pass the tensor threshold requirement. More...

void	GetNearbyMuonPfos (const pandora::Cluster *const pCluster, pandora::ClusterList &consideredClusters, pandora::PfoList &nearbyMuonPfos) const
	Use the cluster proximity map to travel along paths of nearby clusters finding the cosmic ray clusters on which they terminate. More...

void	GetClusterSpanX (const pandora::CaloHitList &caloHitList, float &xMin, float &xMax) const
	Calculate the xSpan of a list of CaloHits. More...

pandora::StatusCode	GetClusterSpanZ (const pandora::CaloHitList &caloHitList, const float xMin, const float xMax, float &zMin, float &zMax) const
	Calculate the zSpan of a list of CaloHits in a specified x range. More...

void	CollectStrayClusters (const pandora::Cluster *const pClusterToEnlarge, const float rangeMinX, const float rangeMaxX, pandora::ClusterList &collectedClusters)
	Collect the stray clusters that are close to a specified cluster and that lie within a given x range. More...

void	AddInStrayClusters (const pandora::Cluster *const pClusterToEnlarge, const pandora::ClusterList &collectedClusters)
	Merge in the collected stray clusters of a given delta ray cluster. More...

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

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

Protected Member Functions inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
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::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
std::string	m_muonPfoListName
	The list of reconstructed cosmic ray pfos. More...

pandora::ClusterList	m_strayClusterListU
	The list of U clusters that do not pass the tensor threshold requirement. More...

pandora::ClusterList	m_strayClusterListV
	The list of V clusters that do not pass the tensor threshold requirement. More...

pandora::ClusterList	m_strayClusterListW
	The list of W clusters that do not pass the tensor threshold requirement. More...

DeltaRayMatchingContainers	m_deltaRayMatchingContainers
	The class of hit, cluster and pfo ownership and proximity maps. More...

float	m_pseudoChi2Cut
	Pseudo chi2 cut for three view matching. More...

float	m_xOverlapWindow
	The maximum allowed displacement in x position. More...

float	m_minMatchedFraction
	The threshold matched fraction of sampling points for a good match. More...

unsigned int	m_minMatchedPoints
	The threshold number of matched sampling points for a good match. More...

unsigned int	m_minProjectedPositions
	The threshold number of projected points for a good projection. More...

float	m_maxCosmicRayHitFraction
	The maximum allowed fraction of hits to be removed from the cosmic ray track. More...

float	m_maxDistanceToCluster
	the maximum distance of a projected point to the cosmic ray cluster used when parameterising the cosmic ray cluster More...

float	m_maxDistanceToReferencePoint
	the maximum distance of a projected point to the cosmic ray vertex used when parameterising the cosmic ray cluster More...

float	m_strayClusterSeparation
	The maximum allowed separation of a stray cluster and a delta ray cluster for merge. More...

Protected Attributes inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >
MatchingType	m_matchingControl
	The matching control. More...

Detailed Description

ThreeViewDeltaRayMatchingAlgorithm class.

Definition at line 29 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Member Typedef Documentation

typedef NViewDeltaRayMatchingAlgorithm<ThreeViewMatchingControl<DeltaRayOverlapResult> > lar_content::ThreeViewDeltaRayMatchingAlgorithm::BaseAlgorithm

Definition at line 32 of file ThreeViewDeltaRayMatchingAlgorithm.h.

typedef std::vector<DeltaRayTensorTool *> lar_content::ThreeViewDeltaRayMatchingAlgorithm::TensorToolVector

private

Definition at line 48 of file ThreeViewDeltaRayMatchingAlgorithm.h.

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType lar_content::ThreeViewDeltaRayMatchingAlgorithm::TensorType

Definition at line 33 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeViewDeltaRayMatchingAlgorithm::ThreeViewDeltaRayMatchingAlgorithm ( )

Default constructor.

Definition at line 18 of file ThreeViewDeltaRayMatchingAlgorithm.cc.

                                                                        : m_minClusterCaloHits(5), m_nMaxTensorToolRepeats(10)
 {
 }

Member Function Documentation

void lar_content::ThreeViewDeltaRayMatchingAlgorithm::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.

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

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::ThreeViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold ( const pandora::Cluster *const pCluster ) const

privatevirtual

To check whether a given cluster meets the requirements to be added into the matching container (tensor/matrix)

Parameters

pCluster the address of the input cluster

Returns: whether the checks were met

Implements lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >.

Definition at line 24 of file ThreeViewDeltaRayMatchingAlgorithm.cc.

 {
     return (pCluster->GetNCaloHits() >= m_minClusterCaloHits);
 }

void lar_content::ThreeViewDeltaRayMatchingAlgorithm::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 108 of file ThreeViewDeltaRayMatchingAlgorithm.cc.

 {
     // Apply tools sequentially restarting if a change is made and ending if the tools finish or the restart limit is reached
     unsigned int repeatCounter(0);
 
     for (auto toolIter = m_algorithmToolVector.begin(); toolIter != m_algorithmToolVector.end();)
     {
         DeltaRayTensorTool *const pTool(*toolIter);
         const bool repeatTools(pTool->Run(this, this->GetMatchingControl().GetOverlapTensor()));
 
         toolIter = repeatTools ? m_algorithmToolVector.begin() : toolIter + 1;
         repeatCounter = repeatTools ? repeatCounter + 1 : repeatCounter;
 
         if (repeatCounter > m_nMaxTensorToolRepeats)
             break;
     }
 }

void lar_content::ThreeViewDeltaRayMatchingAlgorithm::FindCommonMuonParents	(	const pandora::Cluster *const	pClusterU,
		const pandora::Cluster *const	pClusterV,
		const pandora::Cluster *const	pClusterW,
		pandora::PfoList &	commonMuonPfoList
	)		const

private

Find the cosmic ray pfos that, in each view, lie close to the clusters of the tensor element.

Parameters

pClusterU	the cluster from the U view
pClusterV	the cluster from the V view
pClusterW	the cluster from the W view
commonMuonPfoList	the output list of common cosmic ray pfos

Definition at line 69 of file ThreeViewDeltaRayMatchingAlgorithm.cc.

 {
     ClusterList consideredClustersU, consideredClustersV, consideredClustersW;
     PfoList nearbyMuonPfosU, nearbyMuonPfosV, nearbyMuonPfosW;
 
     this->GetNearbyMuonPfos(pClusterU, consideredClustersU, nearbyMuonPfosU);
 
     if (nearbyMuonPfosU.empty())
         return;
 
     this->GetNearbyMuonPfos(pClusterV, consideredClustersV, nearbyMuonPfosV);
 
     if (nearbyMuonPfosV.empty())
         return;
 
     this->GetNearbyMuonPfos(pClusterW, consideredClustersW, nearbyMuonPfosW);
 
     if (nearbyMuonPfosW.empty())
         return;
 
     for (const ParticleFlowObject *const pNearbyMuonU : nearbyMuonPfosU)
     {
         for (const ParticleFlowObject *const pNearbyMuonV : nearbyMuonPfosV)
         {
             if (pNearbyMuonV != pNearbyMuonU)
                 continue;
 
             for (const ParticleFlowObject *const pNearbyMuonW : nearbyMuonPfosW)
             {
                 if (pNearbyMuonW == pNearbyMuonV)
                     commonMuonPfoList.emplace_back(pNearbyMuonU);
             }
         }
     }
 }

std::string lar_content::ThreeViewDeltaRayMatchingAlgorithm::GetClusteringAlgName ( ) const

inline

Get the name of the clustering algorithm to be used to recluster created delta ray remnants.

Returns: the clustering algorithm name

Definition at line 119 of file ThreeViewDeltaRayMatchingAlgorithm.h.

 {
     return m_reclusteringAlgorithmName;
 }

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

privatevirtual

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

Definition at line 128 of file ThreeViewDeltaRayMatchingAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MuonPfoListName", m_muonPfoListName));
 
     AlgorithmToolVector algorithmToolVector;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "DeltaRayTools", algorithmToolVector));
 
     for (auto algorithmTool : algorithmToolVector)
     {
         DeltaRayTensorTool *const pDeltaRayTensorTool(dynamic_cast<DeltaRayTensorTool *>(algorithmTool));
 
         if (!pDeltaRayTensorTool)
             return STATUS_CODE_INVALID_PARAMETER;
 
         m_algorithmToolVector.push_back(pDeltaRayTensorTool);
     }
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithm(*this, xmlHandle, "ClusterRebuilding", m_reclusteringAlgorithmName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterCaloHits", m_minClusterCaloHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NMaxTensorToolRepeats", m_nMaxTensorToolRepeats));
 
     return BaseAlgorithm::ReadSettings(xmlHandle);
 }

Member Data Documentation

TensorToolVector lar_content::ThreeViewDeltaRayMatchingAlgorithm::m_algorithmToolVector

private

The algorithm tool vector.

Definition at line 87 of file ThreeViewDeltaRayMatchingAlgorithm.h.

unsigned int lar_content::ThreeViewDeltaRayMatchingAlgorithm::m_minClusterCaloHits

private

The threshold number of hits for a cluster to be considered.

Definition at line 89 of file ThreeViewDeltaRayMatchingAlgorithm.h.

unsigned int lar_content::ThreeViewDeltaRayMatchingAlgorithm::m_nMaxTensorToolRepeats

private

The maximum number of repeat loops over tensor tools.

Definition at line 90 of file ThreeViewDeltaRayMatchingAlgorithm.h.

std::string lar_content::ThreeViewDeltaRayMatchingAlgorithm::m_reclusteringAlgorithmName

private

The name of the clustering algorithm to be used to recluster created delta ray remnants.

Definition at line 88 of file ThreeViewDeltaRayMatchingAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/ThreeViewDeltaRayMatchingAlgorithm.h
larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/ThreeViewDeltaRayMatchingAlgorithm.cc

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation