SlidingConeClusterMopUpAlgorithm class. More...

#include <SlidingConeClusterMopUpAlgorithm.h>

Inheritance diagram for lar_content::SlidingConeClusterMopUpAlgorithm:

Classes
class	ClusterMerge
	ClusterMerge class. More...

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

Public Member Functions inherited from lar_content::PfoMopUpBaseAlgorithm
virtual void	MergeAndDeletePfos (const pandora::ParticleFlowObject const pPfoToEnlarge, const pandora::ParticleFlowObject const pPfoToDelete) const
	Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc. More...

Public Member Functions inherited from lar_content::MopUpBaseAlgorithm
template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object. More...

Private Types
typedef std::vector< ClusterMerge >	ClusterMergeList

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

typedef std::unordered_map< const pandora::Cluster *, ClusterMergeList >	ClusterMergeMap

Private Member Functions
pandora::StatusCode	Run ()

void	GetInteractionVertex (const pandora::Vertex *&pVertex) const
	Get the neutrino interaction vertex if it is available and if the algorithm is configured to do so. More...

void	GetThreeDClusters (pandora::ClusterVector &clusters3D, ClusterToPfoMap &clusterToPfoMap) const
	Get all 3d clusters contained in the input pfo lists and a mapping from clusters to pfos. More...

void	GetAvailableTwoDClusters (pandora::ClusterVector &availableClusters2D) const
	Get all available 2d clusters contained in the input cluster lists. More...

void	GetClusterMergeMap (const pandora::Vertex *const pVertex, const pandora::ClusterVector &clusters3D, const pandora::ClusterVector &availableClusters2D, ClusterMergeMap &clusterMergeMap) const
	Get the cluster merge map describing all potential 3d cluster merges. More...

void	MakeClusterMerges (const ClusterToPfoMap &clusterToPfoMap, const ClusterMergeMap &clusterMergeMap) const
	Make cluster merges based on the provided cluster merge map. More...

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

Private Attributes
pandora::StringVector	m_inputPfoListNames
	The input pfo list names. More...

bool	m_useVertex
	Whether to use the interaction vertex to select useful cone directions. More...

unsigned int	m_maxIterations
	The maximum allowed number of algorithm iterations. More...

unsigned int	m_maxHitsToConsider3DTrack
	The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm. More...

unsigned int	m_minHitsToConsider3DShower
	The minimum number of hits in a 3d shower cluster to attempt cone fits. More...

unsigned int	m_maxHitsToConsider2DCluster
	The maximum number of hits in a 2d cluster to allow pick-up via sliding cone fits. More...

unsigned int	m_halfWindowLayers
	The number of layers to use for half-window of sliding fit. More...

unsigned int	m_nConeFitLayers
	The number of layers over which to sum fitted direction to obtain cone fit. More...

unsigned int	m_nConeFits
	The number of cone fits to perform, spread roughly uniformly along the shower length. More...

float	m_coneLengthMultiplier
	The cone length multiplier to use when calculating bounded cluster fractions. More...

float	m_maxConeLength
	The maximum allowed cone length to use when calculating bounded cluster fractions. More...

float	m_coneTanHalfAngle
	The cone tan half angle to use when calculating bounded cluster fractions. More...

float	m_coneBoundedFraction
	The minimum cluster bounded fraction for association. More...

Additional Inherited Members
Static Public Member Functions inherited from lar_content::PfoMopUpBaseAlgorithm
static const pandora::Cluster *	GetParentCluster (const pandora::ClusterList &clusterList, const pandora::HitType hitType)
	Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type. More...

Protected Attributes inherited from lar_content::MopUpBaseAlgorithm
pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names. More...

Detailed Description

SlidingConeClusterMopUpAlgorithm class.

Definition at line 21 of file SlidingConeClusterMopUpAlgorithm.h.

Member Typedef Documentation

typedef std::vector<ClusterMerge> lar_content::SlidingConeClusterMopUpAlgorithm::ClusterMergeList

private

Definition at line 81 of file SlidingConeClusterMopUpAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster *, ClusterMergeList> lar_content::SlidingConeClusterMopUpAlgorithm::ClusterMergeMap

private

Definition at line 109 of file SlidingConeClusterMopUpAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster *, const pandora::ParticleFlowObject *> lar_content::SlidingConeClusterMopUpAlgorithm::ClusterToPfoMap

private

Definition at line 92 of file SlidingConeClusterMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::SlidingConeClusterMopUpAlgorithm::SlidingConeClusterMopUpAlgorithm ( )

Default constructor.

Definition at line 24 of file SlidingConeClusterMopUpAlgorithm.cc.

                                                                    :
     m_useVertex(true),
     m_maxIterations(1000),
     m_maxHitsToConsider3DTrack(100),
     m_minHitsToConsider3DShower(20),
     m_maxHitsToConsider2DCluster(50),
     m_halfWindowLayers(20),
     m_nConeFitLayers(40),
     m_nConeFits(5),
     m_coneLengthMultiplier(3.f),
     m_maxConeLength(126.f),
     m_coneTanHalfAngle(0.2f),
     m_coneBoundedFraction(0.5f)
 {
 }

Member Function Documentation

void lar_content::SlidingConeClusterMopUpAlgorithm::GetAvailableTwoDClusters ( pandora::ClusterVector & availableClusters2D ) const

private

Get all available 2d clusters contained in the input cluster lists.

Parameters

availableClusters2D to receive the sorted list of available 2d clusters

Definition at line 120 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     for (const std::string &clusterListName : m_daughterListNames)
     {
         const ClusterList *pClusterList(nullptr);
 
         if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, clusterListName, pClusterList))
             continue;
 
         for (const Cluster *const pCluster : *pClusterList)
         {
             if (!PandoraContentApi::IsAvailable(*this, pCluster))
                 continue;
 
             if (pCluster->GetNCaloHits() > m_maxHitsToConsider2DCluster)
                 continue;
 
             availableClusters2D.push_back(pCluster);
         }
     }
 
     std::sort(availableClusters2D.begin(), availableClusters2D.end(), LArClusterHelper::SortByNHits);
 }

void lar_content::SlidingConeClusterMopUpAlgorithm::GetClusterMergeMap	(	const pandora::Vertex *const	pVertex,
		const pandora::ClusterVector &	clusters3D,
		const pandora::ClusterVector &	availableClusters2D,
		ClusterMergeMap &	clusterMergeMap
	)		const

private

Get the cluster merge map describing all potential 3d cluster merges.

Parameters

pVertex	the neutrino interaction vertex, if available
clusters3D	the sorted list of 3d clusters
availableClusters2D	the sorted list of available 2d clusters
clusterMergeMap	to receive the populated cluster merge map

Definition at line 146 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     const float layerPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
 
     for (const Cluster *const pShowerCluster : clusters3D)
     {
         float coneLength3D(0.f);
         SimpleConeList simpleConeList3D;
 
         try
         {
             const ThreeDSlidingConeFitResult slidingConeFitResult3D(pShowerCluster, m_halfWindowLayers, layerPitch);
 
             const CartesianVector &minLayerPosition(slidingConeFitResult3D.GetSlidingFitResult().GetGlobalMinLayerPosition());
             const CartesianVector &maxLayerPosition(slidingConeFitResult3D.GetSlidingFitResult().GetGlobalMaxLayerPosition());
             coneLength3D = std::min(m_coneLengthMultiplier * (maxLayerPosition - minLayerPosition).GetMagnitude(), m_maxConeLength);
 
             const float vertexToMinLayer(!pVertex ? 0.f : (pVertex->GetPosition() - minLayerPosition).GetMagnitude());
             const float vertexToMaxLayer(!pVertex ? 0.f : (pVertex->GetPosition() - maxLayerPosition).GetMagnitude());
             const ConeSelection coneSelection(
                 !pVertex ? CONE_BOTH_DIRECTIONS : (vertexToMaxLayer > vertexToMinLayer) ? CONE_FORWARD_ONLY : CONE_BACKWARD_ONLY);
 
             slidingConeFitResult3D.GetSimpleConeList(m_nConeFitLayers, m_nConeFits, coneSelection, simpleConeList3D);
         }
         catch (const StatusCodeException &)
         {
             continue;
         }
 
         for (const Cluster *const pNearbyCluster2D : availableClusters2D)
         {
             ClusterMerge bestClusterMerge(nullptr, 0.f, 0.f);
             const HitType hitType(LArClusterHelper::GetClusterHitType(pNearbyCluster2D));
 
             for (const SimpleCone &simpleCone3D : simpleConeList3D)
             {
                 const CartesianVector coneBaseCentre3D(simpleCone3D.GetConeApex() + simpleCone3D.GetConeDirection() * coneLength3D);
                 const CartesianVector coneApex2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), simpleCone3D.GetConeApex(), hitType));
                 const CartesianVector coneBaseCentre2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), coneBaseCentre3D, hitType));
 
                 const CartesianVector apexToBase2D(coneBaseCentre2D - coneApex2D);
                 const SimpleCone simpleCone2D(coneApex2D, apexToBase2D.GetUnitVector(), apexToBase2D.GetMagnitude(), m_coneTanHalfAngle);
                 const ClusterMerge clusterMerge(
                     pShowerCluster, simpleCone2D.GetBoundedHitFraction(pNearbyCluster2D), simpleCone2D.GetMeanRT(pNearbyCluster2D));
 
                 if (clusterMerge < bestClusterMerge)
                     bestClusterMerge = clusterMerge;
             }
 
             if (bestClusterMerge.GetParentCluster() && (bestClusterMerge.GetBoundedFraction() > m_coneBoundedFraction))
                 clusterMergeMap[pNearbyCluster2D].push_back(bestClusterMerge);
         }
     }
 
     for (ClusterMergeMap::value_type &mapEntry : clusterMergeMap)
         std::sort(mapEntry.second.begin(), mapEntry.second.end());
 }

void lar_content::SlidingConeClusterMopUpAlgorithm::GetInteractionVertex ( const pandora::Vertex *& pVertex ) const

private

Get the neutrino interaction vertex if it is available and if the algorithm is configured to do so.

Parameters

pVertex to receive the neutrino interaction vertex

Definition at line 71 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     if (!m_useVertex)
         return;
 
     const VertexList *pVertexList = nullptr;
     PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetCurrentList(*this, pVertexList));
 
     pVertex =
         ((pVertexList && (pVertexList->size() == 1) && (VERTEX_3D == (*(pVertexList->begin()))->GetVertexType())) ? *(pVertexList->begin()) : nullptr);
 }

void lar_content::SlidingConeClusterMopUpAlgorithm::GetThreeDClusters	(	pandora::ClusterVector &	clusters3D,
		ClusterToPfoMap &	clusterToPfoMap
	)		const

private

Get all 3d clusters contained in the input pfo lists and a mapping from clusters to pfos.

Parameters

clusters3D	to receive the sorted list of 3d clusters
clusterToPfoMap	to receive the mapping from 3d cluster to pfo

Definition at line 85 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     for (const std::string &pfoListName : m_inputPfoListNames)
     {
         const PfoList *pPfoList(nullptr);
 
         if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, pfoListName, pPfoList))
             continue;
 
         for (const Pfo *const pPfo : *pPfoList)
         {
             ClusterList pfoClusters3D;
             LArPfoHelper::GetThreeDClusterList(pPfo, pfoClusters3D);
 
             for (const Cluster *const pCluster3D : pfoClusters3D)
             {
                 if (LArPfoHelper::IsTrack(pPfo) && (pCluster3D->GetNCaloHits() > m_maxHitsToConsider3DTrack))
                     continue;
 
                 if (LArPfoHelper::IsShower(pPfo) && (pCluster3D->GetNCaloHits() < m_minHitsToConsider3DShower))
                     continue;
 
                 if (!clusterToPfoMap.insert(ClusterToPfoMap::value_type(pCluster3D, pPfo)).second)
                     throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
 
                 clusters3D.push_back(pCluster3D);
             }
         }
     }
 
     std::sort(clusters3D.begin(), clusters3D.end(), LArClusterHelper::SortByNHits);
 }

void lar_content::SlidingConeClusterMopUpAlgorithm::MakeClusterMerges	(	const ClusterToPfoMap &	clusterToPfoMap,
		const ClusterMergeMap &	clusterMergeMap
	)		const

private

Make cluster merges based on the provided cluster merge map.

Parameters

clusterToPfoMap	the mapping from 3d cluster to pfo
clusterMergeMap	the populated cluster merge map

Definition at line 207 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     ClusterVector daughterClusters;
     for (const ClusterMergeMap::value_type &mapEntry : clusterMergeMap)
         daughterClusters.push_back(mapEntry.first);
     std::sort(daughterClusters.begin(), daughterClusters.end(), LArClusterHelper::SortByNHits);
 
     for (ClusterVector::const_reverse_iterator rIter = daughterClusters.rbegin(), rIterEnd = daughterClusters.rend(); rIter != rIterEnd; ++rIter)
     {
         const Cluster *const pDaughterCluster(*rIter);
         const HitType daughterHitType(LArClusterHelper::GetClusterHitType(pDaughterCluster));
         const Cluster *const pParentCluster3D(clusterMergeMap.at(pDaughterCluster).at(0).GetParentCluster());
 
         const Pfo *const pParentPfo(clusterToPfoMap.at(pParentCluster3D));
         const Cluster *const pParentCluster(this->GetParentCluster(pParentPfo->GetClusterList(), daughterHitType));
 
         if (pParentCluster)
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                 PandoraContentApi::MergeAndDeleteClusters(
                     *this, pParentCluster, pDaughterCluster, this->GetListName(pParentCluster), this->GetListName(pDaughterCluster)));
         }
         else
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToPfo(*this, pParentPfo, pDaughterCluster));
         }
     }
 }

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

privatevirtual

Reimplemented from lar_content::PfoMopUpBaseAlgorithm.

Definition at line 262 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputPfoListNames", m_inputPfoListNames));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseVertex", m_useVertex));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxIterations", m_maxIterations));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxHitsToConsider3DTrack", m_maxHitsToConsider3DTrack));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinHitsToConsider3DShower", m_minHitsToConsider3DShower));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxHitsToConsider2DCluster", m_maxHitsToConsider2DCluster));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitHalfWindow", m_halfWindowLayers));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NConeFitLayers", m_nConeFitLayers));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NConeFits", m_nConeFits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeLengthMultiplier", m_coneLengthMultiplier));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxConeLength", m_maxConeLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeTanHalfAngle", m_coneTanHalfAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeBoundedFraction", m_coneBoundedFraction));
 
     return PfoMopUpBaseAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::SlidingConeClusterMopUpAlgorithm::Run ( )

private

Definition at line 42 of file SlidingConeClusterMopUpAlgorithm.cc.

 {
     const Vertex *pVertex(nullptr);
     this->GetInteractionVertex(pVertex);
 
     if (m_useVertex && !pVertex)
     {
         if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             std::cout << "SlidingConeClusterMopUpAlgorithm - interaction vertex not available for use." << std::endl;
         return STATUS_CODE_SUCCESS;
     }
 
     ClusterVector clusters3D;
     ClusterToPfoMap clusterToPfoMap;
     this->GetThreeDClusters(clusters3D, clusterToPfoMap);
 
     ClusterVector availableClusters2D;
     this->GetAvailableTwoDClusters(availableClusters2D);
 
     ClusterMergeMap clusterMergeMap;
     this->GetClusterMergeMap(pVertex, clusters3D, availableClusters2D, clusterMergeMap);
 
     this->MakeClusterMerges(clusterToPfoMap, clusterMergeMap);
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

float lar_content::SlidingConeClusterMopUpAlgorithm::m_coneBoundedFraction

private

The minimum cluster bounded fraction for association.

Definition at line 144 of file SlidingConeClusterMopUpAlgorithm.h.

float lar_content::SlidingConeClusterMopUpAlgorithm::m_coneLengthMultiplier

private

The cone length multiplier to use when calculating bounded cluster fractions.

Definition at line 141 of file SlidingConeClusterMopUpAlgorithm.h.

float lar_content::SlidingConeClusterMopUpAlgorithm::m_coneTanHalfAngle

private

The cone tan half angle to use when calculating bounded cluster fractions.

Definition at line 143 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_halfWindowLayers

private

The number of layers to use for half-window of sliding fit.

Definition at line 138 of file SlidingConeClusterMopUpAlgorithm.h.

pandora::StringVector lar_content::SlidingConeClusterMopUpAlgorithm::m_inputPfoListNames

private

The input pfo list names.

Definition at line 132 of file SlidingConeClusterMopUpAlgorithm.h.

float lar_content::SlidingConeClusterMopUpAlgorithm::m_maxConeLength

private

The maximum allowed cone length to use when calculating bounded cluster fractions.

Definition at line 142 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_maxHitsToConsider2DCluster

private

The maximum number of hits in a 2d cluster to allow pick-up via sliding cone fits.

Definition at line 137 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_maxHitsToConsider3DTrack

private

The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm.

Definition at line 135 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_maxIterations

private

The maximum allowed number of algorithm iterations.

Definition at line 134 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_minHitsToConsider3DShower

private

The minimum number of hits in a 3d shower cluster to attempt cone fits.

Definition at line 136 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_nConeFitLayers

private

The number of layers over which to sum fitted direction to obtain cone fit.

Definition at line 139 of file SlidingConeClusterMopUpAlgorithm.h.

unsigned int lar_content::SlidingConeClusterMopUpAlgorithm::m_nConeFits

private

The number of cone fits to perform, spread roughly uniformly along the shower length.

Definition at line 140 of file SlidingConeClusterMopUpAlgorithm.h.

bool lar_content::SlidingConeClusterMopUpAlgorithm::m_useVertex

private

Whether to use the interaction vertex to select useful cone directions.

Definition at line 133 of file SlidingConeClusterMopUpAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArTwoDReco/LArClusterMopUp/SlidingConeClusterMopUpAlgorithm.h
larpandoracontent/larpandoracontent/LArTwoDReco/LArClusterMopUp/SlidingConeClusterMopUpAlgorithm.cc

Classes

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