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...

Public Member Functions inherited from lar_content::ClusterMopUpBaseAlgorithm
	ClusterMopUpBaseAlgorithm ()
	Default constructor. 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 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...

Additional Inherited Members
Protected Types inherited from lar_content::ClusterMopUpBaseAlgorithm
typedef std::unordered_map < const pandora::Cluster *, float >	AssociationDetails

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

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

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

Detailed Description

BoundedClusterMopUpAlgorithm class.

Definition at line 24 of file BoundedClusterMopUpAlgorithm.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.

 {
     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)
     {
         CaloHitList clusterHitList;
         pPfoCluster->GetOrderedCaloHitList().FillCaloHitList(clusterHitList);
         if (clusterHitList.size() <= 3)
             continue;
         try
         {
             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);
             }
         }
         catch (const StatusCodeException &e)
         {
             if (e.GetStatusCode() != STATUS_CODE_NOT_INITIALIZED)
                 throw e;
         }
     }
 
     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 107 of file BoundedClusterMopUpAlgorithm.cc.

 {
     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::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 79 of file BoundedClusterMopUpAlgorithm.cc.

 {
     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 &)
         {
         }
     }
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMopUpBaseAlgorithm.

Definition at line 170 of file BoundedClusterMopUpAlgorithm.cc.

 {
     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);
 }