ClusterMopUpBaseAlgorithm class. More...

#include <ClusterMopUpBaseAlgorithm.h>

Inheritance diagram for lar_content::ClusterMopUpBaseAlgorithm:

Public Member Functions
	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...

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	ClusterMopUp (const pandora::ClusterList &pfoClusters, const pandora::ClusterList &remnantClusters) const =0
	Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations. 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...

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

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

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

Detailed Description

ClusterMopUpBaseAlgorithm class.

Definition at line 22 of file ClusterMopUpBaseAlgorithm.h.

Member Typedef Documentation

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

protected

Definition at line 71 of file ClusterMopUpBaseAlgorithm.h.

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

protected

Definition at line 72 of file ClusterMopUpBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ClusterMopUpBaseAlgorithm::ClusterMopUpBaseAlgorithm ( )

Default constructor.

Definition at line 21 of file ClusterMopUpBaseAlgorithm.cc.

                                                      : m_excludePfosContainingTracks(true)
 {
 }

Member Function Documentation

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

protectedpure virtual

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

Implemented in lar_content::BoundedClusterMopUpAlgorithm, lar_content::IsolatedClusterMopUpAlgorithm, lar_content::NearbyClusterMopUpAlgorithm, and lar_content::ConeClusterMopUpAlgorithm.

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

protectedvirtual

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 81 of file ClusterMopUpBaseAlgorithm.cc.

 {
     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

protectedvirtual

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 66 of file ClusterMopUpBaseAlgorithm.cc.

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

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

protectedvirtual

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 44 of file ClusterMopUpBaseAlgorithm.cc.

 {
     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::ClusterMopUpBaseAlgorithm::MakeClusterMerges ( const ClusterAssociationMap & clusterAssociationMap ) const

protectedvirtual

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 103 of file ClusterMopUpBaseAlgorithm.cc.

 {
     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::ClusterMopUpBaseAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protectedvirtual

Reimplemented from lar_content::MopUpBaseAlgorithm.

Reimplemented in lar_content::BoundedClusterMopUpAlgorithm, lar_content::IsolatedClusterMopUpAlgorithm, lar_content::ConeClusterMopUpAlgorithm, and lar_content::NearbyClusterMopUpAlgorithm.

Definition at line 143 of file ClusterMopUpBaseAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "PfoListNames", m_pfoListNames));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "ExcludePfosContainingTracks", m_excludePfosContainingTracks));
 
     return MopUpBaseAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::ClusterMopUpBaseAlgorithm::Run ( )

protectedvirtual

Definition at line 27 of file ClusterMopUpBaseAlgorithm.cc.

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