ClusterMopUpBaseAlgorithm class. More...

#include "ClusterMopUpBaseAlgorithm.h"

Inheritance diagram for lar_content::ClusterMopUpBaseAlgorithm:

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

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.

Referenced by Run().

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

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

Referenced by GetDaughterClusterLists(), and 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

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

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

Referenced by 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(), 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

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

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

Referenced by 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::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 104 of file ClusterMopUpBaseAlgorithm.cc.

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

Referenced by lar_content::ConeClusterMopUpAlgorithm::ClusterMopUp(), lar_content::NearbyClusterMopUpAlgorithm::ClusterMopUp(), and lar_content::BoundedClusterMopUpAlgorithm::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::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 144 of file ClusterMopUpBaseAlgorithm.cc.

References m_excludePfosContainingTracks, m_pfoListNames, and lar_content::MopUpBaseAlgorithm::ReadSettings().

Referenced by lar_content::NearbyClusterMopUpAlgorithm::ReadSettings(), lar_content::ConeClusterMopUpAlgorithm::ReadSettings(), lar_content::IsolatedClusterMopUpAlgorithm::ReadSettings(), and lar_content::BoundedClusterMopUpAlgorithm::ReadSettings().

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

References ClusterMopUp(), GetDaughterClusterLists(), and 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(), GetDaughterClusterLists(), lar_content::SlidingConePfoMopUpAlgorithm::ReadSettings(), and lar_content::VertexBasedPfoMopUpAlgorithm::ReadSettings().

bool lar_content::ClusterMopUpBaseAlgorithm::m_excludePfosContainingTracks

protected

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

Definition at line 84 of file ClusterMopUpBaseAlgorithm.h.

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

pandora::StringVector lar_content::ClusterMopUpBaseAlgorithm::m_pfoListNames

protected

The list of pfo list names.

Definition at line 83 of file ClusterMopUpBaseAlgorithm.h.

Referenced by GetPfoClusterLists(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterMopUp/ClusterMopUpBaseAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterMopUp/ClusterMopUpBaseAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation