BoundedClusterMopUpAlgorithm class. More...

#include "BoundedClusterMopUpAlgorithm.h"

Inheritance diagram for lar_content::BoundedClusterMopUpAlgorithm:

Classes
class	XSampling
	XSampling class. More...

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

template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object. More...

Protected Types
typedef std::unordered_map< const pandora::Cluster *, float >	AssociationDetails

typedef std::unordered_map< const pandora::Cluster *, AssociationDetails >	ClusterAssociationMap

Protected Member Functions
virtual pandora::StatusCode	Run ()

virtual void	GetPfoClusterLists (pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in the input pfo list, divided into three different views. More...

virtual void	GetDaughterClusterLists (pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in the input remant/daughter cluster lists, divided into three different views. More...

virtual void	GetClusterLists (const pandora::ClusterList &inputClusterList, const bool availabilityFlag, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in an input cluster list, divided into three different views. More...

virtual void	MakeClusterMerges (const ClusterAssociationMap &clusterAssociationMap) const
	Make the cluster merges specified in the cluster association map, using list name information in the cluster list name map. More...

Protected Attributes
pandora::StringVector	m_pfoListNames
	The list of pfo list names. More...

bool	m_excludePfosContainingTracks
	Whether to exclude any pfos containing clusters flagged as fixed tracks. More...

pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names. More...

Private Member Functions
void	ClusterMopUp (const pandora::ClusterList &pfoClusters, const pandora::ClusterList &remnantClusters) const
	Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations. More...

void	GetShowerPositionMap (const TwoDSlidingShowerFitResult &fitResult, const XSampling &xSampling, ShowerPositionMap &showerPositionMap) const
	Get the shower position map containing high and low edge z positions in bins of x. More...

float	GetBoundedFraction (const pandora::Cluster *const pCluster, const XSampling &xSampling, const ShowerPositionMap &showerPositionMap) const
	Get the fraction of hits in a cluster bounded by a specified shower position map. More...

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

Private Attributes
unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits. More...

float	m_showerEdgeMultiplier
	Artificially tune width of shower envelope so as to make it more/less inclusive. More...

float	m_minBoundedFraction
	The minimum cluster bounded fraction for merging. More...

Detailed Description

BoundedClusterMopUpAlgorithm class.

Definition at line 24 of file BoundedClusterMopUpAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::Cluster*, float> lar_content::ClusterMopUpBaseAlgorithm::AssociationDetails

protectedinherited

Definition at line 71 of file ClusterMopUpBaseAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster*, AssociationDetails> lar_content::ClusterMopUpBaseAlgorithm::ClusterAssociationMap

protectedinherited

Definition at line 72 of file ClusterMopUpBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::BoundedClusterMopUpAlgorithm::BoundedClusterMopUpAlgorithm ( )

Default constructor.

Definition at line 21 of file BoundedClusterMopUpAlgorithm.cc.

                                                            :
     m_slidingFitWindow(20),
     m_showerEdgeMultiplier(1.5f),
     m_minBoundedFraction(0.5f)
 {
 }

Member Function Documentation

void lar_content::BoundedClusterMopUpAlgorithm::ClusterMopUp	(	const pandora::ClusterList &	pfoClusters,
		const pandora::ClusterList &	remnantClusters
	)		const

privatevirtual

Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations.

Parameters

pfoClusters	the list of pfo clusters
remnantClusters	the list of remnant clusters

Implements lar_content::ClusterMopUpBaseAlgorithm.

Definition at line 30 of file BoundedClusterMopUpAlgorithm.cc.

References GetBoundedFraction(), lar_content::TwoDSlidingShowerFitResult::GetShowerFitResult(), GetShowerPositionMap(), lar_content::LArGeometryHelper::GetWireZPitch(), m_minBoundedFraction, m_showerEdgeMultiplier, m_slidingFitWindow, lar_content::ClusterMopUpBaseAlgorithm::MakeClusterMerges(), and lar_content::LArClusterHelper::SortByNHits().

 {
     ClusterAssociationMap clusterAssociationMap;
     const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
 
     ClusterVector sortedPfoClusters(pfoClusters.begin(), pfoClusters.end());
     std::sort(sortedPfoClusters.begin(), sortedPfoClusters.end(), LArClusterHelper::SortByNHits);
 
     ClusterVector sortedRemnantClusters(remnantClusters.begin(), remnantClusters.end());
     std::sort(sortedRemnantClusters.begin(), sortedRemnantClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pPfoCluster : sortedPfoClusters)
     {
         const TwoDSlidingShowerFitResult fitResult(pPfoCluster, m_slidingFitWindow, slidingFitPitch, m_showerEdgeMultiplier);
 
         ShowerPositionMap showerPositionMap;
         const XSampling xSampling(fitResult.GetShowerFitResult());
         this->GetShowerPositionMap(fitResult, xSampling, showerPositionMap);
 
         for (const Cluster *const pRemnantCluster : sortedRemnantClusters)
         {
             const float boundedFraction(this->GetBoundedFraction(pRemnantCluster, xSampling, showerPositionMap));
 
             if (boundedFraction < m_minBoundedFraction)
                 continue;
 
             AssociationDetails &associationDetails(clusterAssociationMap[pRemnantCluster]);
 
             if (!associationDetails.insert(AssociationDetails::value_type(pPfoCluster, boundedFraction)).second)
                 throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
         }
     }
 
     this->MakeClusterMerges(clusterAssociationMap);
 }

float lar_content::BoundedClusterMopUpAlgorithm::GetBoundedFraction	(	const pandora::Cluster *const	pCluster,
		const XSampling &	xSampling,
		const ShowerPositionMap &	showerPositionMap
	)		const

private

Get the fraction of hits in a cluster bounded by a specified shower position map.

Parameters

pCluster	address of the cluster
xSampling	the x sampling details
showerPositionMap	the shower position map

Returns: the fraction of bounded hits

Definition at line 96 of file BoundedClusterMopUpAlgorithm.cc.

References lar_content::BoundedClusterMopUpAlgorithm::XSampling::GetBin(), lar_content::BoundedClusterMopUpAlgorithm::XSampling::m_maxX, lar_content::BoundedClusterMopUpAlgorithm::XSampling::m_minX, lar_content::BoundedClusterMopUpAlgorithm::XSampling::m_nPoints, x, and z.

Referenced by ClusterMopUp().

 {
   if (((xSampling.m_maxX - xSampling.m_minX) < std::numeric_limits<float>::epsilon()) || (0 >= xSampling.m_nPoints) || 
       (0 == pCluster->GetNCaloHits()))
     {
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
     }
 
     unsigned int nMatchedHits(0);
     const OrderedCaloHitList &orderedCaloHitList(pCluster->GetOrderedCaloHitList());
 
     for (OrderedCaloHitList::const_iterator iter = orderedCaloHitList.begin(), iterEnd = orderedCaloHitList.end(); iter != iterEnd; ++iter)
     {
         for (CaloHitList::const_iterator hIter = iter->second->begin(), hIterEnd = iter->second->end(); hIter != hIterEnd; ++hIter)
         {
             const CaloHit *const pCaloHit = *hIter;
             const float x(pCaloHit->GetPositionVector().GetX());
             const float z(pCaloHit->GetPositionVector().GetZ());
 
             try
             {
                 const int xBin(xSampling.GetBin(x));
             
                 ShowerPositionMap::const_iterator positionIter = showerPositionMap.find(xBin);
 
                 if ((showerPositionMap.end() != positionIter) && (z > positionIter->second.GetLowEdgeZ()) && (z < positionIter->second.GetHighEdgeZ()))
                     ++nMatchedHits;
             }
             catch (StatusCodeException &)
             {
             }
         }
     }
 
     return (static_cast<float>(nMatchedHits) / static_cast<float>(pCluster->GetNCaloHits()));
 }

void lar_content::ClusterMopUpBaseAlgorithm::GetClusterLists	(	const pandora::ClusterList &	inputClusterList,
		const bool	availabilityFlag,
		pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protectedvirtualinherited

Get the two dimensional clusters contained in an input cluster list, divided into three different views.

Parameters

inputClusterList	the input cluster list
availabilityFlag	only clusters with matching availability will be considered
clusterListU	to receive the list of clusters in the u view
clusterListV	to receive the list of clusters in the v view
clusterListW	to receive the list of clusters in the w view

Definition at line 82 of file ClusterMopUpBaseAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), and target.

Referenced by lar_content::ClusterMopUpBaseAlgorithm::GetDaughterClusterLists(), and lar_content::ClusterMopUpBaseAlgorithm::GetPfoClusterLists().

 {
     for (ClusterList::const_iterator cIter = inputClusterList.begin(), cIterEnd = inputClusterList.end(); cIter != cIterEnd; ++cIter)
     {
         const Cluster *const pCluster(*cIter);
 
         if (availabilityFlag != pCluster->IsAvailable())
             continue;
 
         const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
 
         if ((TPC_VIEW_U != hitType) && (TPC_VIEW_V != hitType) && (TPC_VIEW_W != hitType))
             continue;
 
         ClusterList &target((TPC_VIEW_U == hitType) ? clusterListU : (TPC_VIEW_V == hitType) ? clusterListV : clusterListW);
         target.push_back(pCluster);
     }
 }

void lar_content::ClusterMopUpBaseAlgorithm::GetDaughterClusterLists	(	pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protectedvirtualinherited

Get the two dimensional clusters contained in the input remant/daughter cluster lists, divided into three different views.

Parameters

clusterListU	to receive the list of clusters in the u view
clusterListV	to receive the list of clusters in the v view
clusterListW	to receive the list of clusters in the w view

Definition at line 67 of file ClusterMopUpBaseAlgorithm.cc.

References lar_content::ClusterMopUpBaseAlgorithm::GetClusterLists(), and lar_content::MopUpBaseAlgorithm::m_daughterListNames.

Referenced by lar_content::ClusterMopUpBaseAlgorithm::Run().

 {
     for (const std::string &daughterListName : m_daughterListNames)
     {
         const ClusterList *pClusterList(nullptr);
 
         if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, daughterListName, pClusterList))
             continue;
 
         this->GetClusterLists(*pClusterList, true, clusterListU, clusterListV, clusterListW);
     }
 }

template<typename T >

template const std::string lar_content::MopUpBaseAlgorithm::GetListName ( const T *const pT ) const

inherited

Find the name of the list hosting a specific object.

Parameters

pT	the address of the object

Returns: the name of the list

Definition at line 19 of file MopUpBaseAlgorithm.cc.

Referenced by lar_content::IsolatedClusterMopUpAlgorithm::DissolveClustersToHits(), lar_content::ClusterMopUpBaseAlgorithm::MakeClusterMerges(), and lar_content::SlidingConeClusterMopUpAlgorithm::MakeClusterMerges().

 {
     std::string currentListName;
     const MANAGED_CONTAINER<const T*> *pCurrentList(nullptr);
     (void) PandoraContentApi::GetCurrentList(*this, pCurrentList, currentListName);
 
     if (pCurrentList && (pCurrentList->end() != std::find(pCurrentList->begin(), pCurrentList->end(), pT)))
         return currentListName;
 
     for (const std::string &listName : m_daughterListNames)
     {
         const MANAGED_CONTAINER<const T*> *pList(nullptr);
         (void) PandoraContentApi::GetList(*this, listName, pList);
 
         if (pList && (pList->end() != std::find(pList->begin(), pList->end(), pT)))
             return listName;
     }
 
     throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 }

void lar_content::ClusterMopUpBaseAlgorithm::GetPfoClusterLists	(	pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protectedvirtualinherited

Get the two dimensional clusters contained in the input pfo list, divided into three different views.

Parameters

clusterListU	to receive the list of clusters in the u view
clusterListV	to receive the list of clusters in the v view
clusterListW	to receive the list of clusters in the w view

Definition at line 45 of file ClusterMopUpBaseAlgorithm.cc.

References lar_content::ClusterMopUpBaseAlgorithm::GetClusterLists(), lar_content::LArPfoHelper::IsTrack(), lar_content::ClusterMopUpBaseAlgorithm::m_excludePfosContainingTracks, and lar_content::ClusterMopUpBaseAlgorithm::m_pfoListNames.

Referenced by lar_content::ClusterMopUpBaseAlgorithm::Run().

 {
     for (StringVector::const_iterator sIter = m_pfoListNames.begin(), sIterEnd = m_pfoListNames.end(); sIter != sIterEnd; ++sIter)
     {
         const PfoList *pPfoList = NULL;
         if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, *sIter, pPfoList))
             continue;
 
         for (PfoList::const_iterator pIter = pPfoList->begin(), pIterEnd = pPfoList->end(); pIter != pIterEnd; ++pIter)
         {
             const ParticleFlowObject *const pPfo = *pIter;
 
             if (m_excludePfosContainingTracks && LArPfoHelper::IsTrack(pPfo))
                 continue;
 
             this->GetClusterLists(pPfo->GetClusterList(), false, clusterListU, clusterListV, clusterListW);
         }
     }
 }

void lar_content::BoundedClusterMopUpAlgorithm::GetShowerPositionMap	(	const TwoDSlidingShowerFitResult &	fitResult,
		const XSampling &	xSampling,
		ShowerPositionMap &	showerPositionMap
	)		const

private

Get the shower position map containing high and low edge z positions in bins of x.

Parameters

fitResult	the sliding shower fit result
xSampling	the x sampling details
showerPositionMap	to receive the shower position map

Definition at line 68 of file BoundedClusterMopUpAlgorithm.cc.

References lar_content::BoundedClusterMopUpAlgorithm::XSampling::GetBin(), lar_content::TwoDSlidingShowerFitResult::GetShowerEdges(), lar_content::BoundedClusterMopUpAlgorithm::XSampling::m_maxX, lar_content::BoundedClusterMopUpAlgorithm::XSampling::m_minX, lar_content::BoundedClusterMopUpAlgorithm::XSampling::m_nPoints, n, and x.

Referenced by ClusterMopUp().

 {
     for (int n=0; n <= xSampling.m_nPoints; ++n)
     {
         const float x(xSampling.m_minX + (xSampling.m_maxX - xSampling.m_minX) * static_cast<float>(n) / static_cast<float>(xSampling.m_nPoints));
 
         FloatVector edgePositions;
         fitResult.GetShowerEdges(x, false, edgePositions);
 
         if (edgePositions.size() < 2)
             continue;
 
         std::sort(edgePositions.begin(), edgePositions.end());
 
         try
         {
             const int xBin(xSampling.GetBin(x));
             showerPositionMap.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, edgePositions.front(), edgePositions.back())));
         }
         catch (StatusCodeException &)
         {
         }
     }
 }

void lar_content::ClusterMopUpBaseAlgorithm::MakeClusterMerges ( const ClusterAssociationMap & clusterAssociationMap ) const

protectedvirtualinherited

Make the cluster merges specified in the cluster association map, using list name information in the cluster list name map.

Parameters

clusterAssociationMap the cluster association map

Definition at line 104 of file ClusterMopUpBaseAlgorithm.cc.

References lar_content::MopUpBaseAlgorithm::GetListName(), max, and lar_content::LArClusterHelper::SortByNHits().

Referenced by lar_content::ConeClusterMopUpAlgorithm::ClusterMopUp(), lar_content::NearbyClusterMopUpAlgorithm::ClusterMopUp(), and ClusterMopUp().

 {
     ClusterVector sortedRemnantClusters;
     for (const auto &remnantMapEntry : clusterAssociationMap) sortedRemnantClusters.push_back(remnantMapEntry.first);
     std::sort(sortedRemnantClusters.begin(), sortedRemnantClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pRemnantCluster : sortedRemnantClusters)
     {
         const AssociationDetails &associationDetails(clusterAssociationMap.at(pRemnantCluster));
         const Cluster *pBestPfoCluster(nullptr);
         float bestFigureOfMerit(-std::numeric_limits<float>::max());
 
         ClusterVector sortedPfoClusters;
         for (const auto &pfoMapEntry : associationDetails) sortedPfoClusters.push_back(pfoMapEntry.first);
         std::sort(sortedPfoClusters.begin(), sortedPfoClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pPfoCluster : sortedPfoClusters)
         {
             const float figureOfMerit(associationDetails.at(pPfoCluster));
 
             if (figureOfMerit > bestFigureOfMerit)
             {
                 pBestPfoCluster = pPfoCluster;
                 bestFigureOfMerit = figureOfMerit;
             }
         }
 
         if (!pBestPfoCluster)
             continue;
 
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pBestPfoCluster, pRemnantCluster,
             this->GetListName(pBestPfoCluster), this->GetListName(pRemnantCluster)));
     }
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMopUpBaseAlgorithm.

Definition at line 159 of file BoundedClusterMopUpAlgorithm.cc.

References m_minBoundedFraction, m_showerEdgeMultiplier, m_slidingFitWindow, and lar_content::ClusterMopUpBaseAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, 
         "SlidingFitWindow", m_slidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, 
         "ShowerEdgeMultiplier", m_showerEdgeMultiplier));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, 
         "MinBoundedFraction", m_minBoundedFraction));
 
     return ClusterMopUpBaseAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::ClusterMopUpBaseAlgorithm::Run ( )

protectedvirtualinherited

Definition at line 28 of file ClusterMopUpBaseAlgorithm.cc.

References lar_content::ClusterMopUpBaseAlgorithm::ClusterMopUp(), lar_content::ClusterMopUpBaseAlgorithm::GetDaughterClusterLists(), and lar_content::ClusterMopUpBaseAlgorithm::GetPfoClusterLists().

 {
     ClusterList pfoClusterListU, pfoClusterListV, pfoClusterListW;
     this->GetPfoClusterLists(pfoClusterListU, pfoClusterListV, pfoClusterListW);
 
     ClusterList daughterClusterListU, daughterClusterListV, daughterClusterListW;
     this->GetDaughterClusterLists(daughterClusterListU, daughterClusterListV, daughterClusterListW);
 
     this->ClusterMopUp(pfoClusterListU, daughterClusterListU);
     this->ClusterMopUp(pfoClusterListV, daughterClusterListV);
     this->ClusterMopUp(pfoClusterListW, daughterClusterListW);
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

pandora::StringVector lar_content::MopUpBaseAlgorithm::m_daughterListNames

protectedinherited

The list of potential daughter object list names.

Definition at line 35 of file MopUpBaseAlgorithm.h.

Referenced by lar_content::SlidingConeClusterMopUpAlgorithm::GetAvailableTwoDClusters(), lar_content::ClusterMopUpBaseAlgorithm::GetDaughterClusterLists(), lar_content::SlidingConePfoMopUpAlgorithm::ReadSettings(), and lar_content::VertexBasedPfoMopUpAlgorithm::ReadSettings().

bool lar_content::ClusterMopUpBaseAlgorithm::m_excludePfosContainingTracks

protectedinherited

Whether to exclude any pfos containing clusters flagged as fixed tracks.

Definition at line 84 of file ClusterMopUpBaseAlgorithm.h.

Referenced by lar_content::ClusterMopUpBaseAlgorithm::GetPfoClusterLists(), lar_content::IsolatedClusterMopUpAlgorithm::IsolatedClusterMopUpAlgorithm(), and lar_content::ClusterMopUpBaseAlgorithm::ReadSettings().

float lar_content::BoundedClusterMopUpAlgorithm::m_minBoundedFraction

private

The minimum cluster bounded fraction for merging.

Definition at line 84 of file BoundedClusterMopUpAlgorithm.h.

Referenced by ClusterMopUp(), and ReadSettings().

pandora::StringVector lar_content::ClusterMopUpBaseAlgorithm::m_pfoListNames

protectedinherited

The list of pfo list names.

Definition at line 83 of file ClusterMopUpBaseAlgorithm.h.

Referenced by lar_content::ClusterMopUpBaseAlgorithm::GetPfoClusterLists(), and lar_content::ClusterMopUpBaseAlgorithm::ReadSettings().

float lar_content::BoundedClusterMopUpAlgorithm::m_showerEdgeMultiplier

private

Artificially tune width of shower envelope so as to make it more/less inclusive.

Definition at line 83 of file BoundedClusterMopUpAlgorithm.h.

Referenced by ClusterMopUp(), and ReadSettings().

unsigned int lar_content::BoundedClusterMopUpAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 82 of file BoundedClusterMopUpAlgorithm.h.

Referenced by ClusterMopUp(), and ReadSettings().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterMopUp/BoundedClusterMopUpAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterMopUp/BoundedClusterMopUpAlgorithm.cc

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation