TwoDSlidingFitConsolidationAlgorithm class. More...

#include <TwoDSlidingFitConsolidationAlgorithm.h>

Inheritance diagram for lar_content::TwoDSlidingFitConsolidationAlgorithm:

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

Protected Types
typedef std::unordered_map < const pandora::Cluster *, pandora::CaloHitList >	ClusterToHitMap

Protected Member Functions
pandora::StatusCode	Run ()

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

virtual void	GetReclusteredHits (const TwoDSlidingFitResultList &slidingFitResultList, const pandora::ClusterVector &showerClusters, ClusterToHitMap &caloHitsToAdd, ClusterToHitMap &caloHitsToRemove) const =0
	Get the list of hits to be added or removed from clusters. More...

Private Member Functions
void	SortInputClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &trackClusters, pandora::ClusterVector &showerClusters) const
	Sort input cluster list into track-like clusters and shower-like clusters. More...

void	BuildSlidingLinearFits (const pandora::ClusterVector &trackClusters, TwoDSlidingFitResultList &slidingFitResultList) const
	Apply sliding linear fits to track clusters. More...

pandora::StatusCode	RemoveHitsFromClusters (const ClusterToHitMap &clustersToRebuild, pandora::ClusterSet &unavailableClusters) const
	Remove hits from clusters. More...

pandora::StatusCode	AddHitsToClusters (const ClusterToHitMap &clustersToRebuild, pandora::ClusterSet &unavailableClusters) const
	Add hits to clusters. More...

pandora::StatusCode	RebuildClusters (const ClusterToHitMap &clustersAtStart, const pandora::ClusterSet &unavailableClusters) const
	Re-build clusters. More...

Private Attributes
std::string	m_reclusteringAlgorithmName
	Name of daughter algorithm to use for cluster re-building. More...

float	m_minTrackLength
	Minimum length of track clusters to consolidate. More...

float	m_maxClusterLength
	Maximum length of shower clusters to use in re-building. More...

unsigned int	m_halfWindowLayers
	Size of layer window for sliding fit results. More...

Detailed Description

TwoDSlidingFitConsolidationAlgorithm class.

Definition at line 23 of file TwoDSlidingFitConsolidationAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::Cluster *, pandora::CaloHitList> lar_content::TwoDSlidingFitConsolidationAlgorithm::ClusterToHitMap

protected

Definition at line 35 of file TwoDSlidingFitConsolidationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TwoDSlidingFitConsolidationAlgorithm::TwoDSlidingFitConsolidationAlgorithm ( )

Default constructor.

Definition at line 21 of file TwoDSlidingFitConsolidationAlgorithm.cc.

                                                                            :
     m_minTrackLength(7.5f),
     m_maxClusterLength(15.f),
     m_halfWindowLayers(25)
 {
 }

Member Function Documentation

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::AddHitsToClusters	(	const ClusterToHitMap &	clustersToRebuild,
		pandora::ClusterSet &	unavailableClusters
	)		const

private

Add hits to clusters.

Parameters

clustersToRebuild	the list of hits to be added to clusters
unavailableClusters	the list of modified clusters

Definition at line 146 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     ClusterList clusterList;
 
     for (const auto &mapEntry : clustersToExpand)
     {
         if (!unavailableClusters.count(mapEntry.first))
             clusterList.push_back(mapEntry.first);
     }
 
     clusterList.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster : clusterList)
     {
         const CaloHitList &caloHitList(clustersToExpand.at(pCluster));
 
         if (caloHitList.empty())
             continue;
 
         if (unavailableClusters.count(pCluster))
             continue;
 
         unavailableClusters.insert(pCluster);
 
         for (const CaloHit *const pCaloHit : caloHitList)
         {
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToCluster(*this, pCluster, pCaloHit));
         }
     }
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::TwoDSlidingFitConsolidationAlgorithm::BuildSlidingLinearFits	(	const pandora::ClusterVector &	trackClusters,
		TwoDSlidingFitResultList &	slidingFitResultList
	)		const

private

Apply sliding linear fits to track clusters.

Parameters

trackClusters	the input vector of track-like clusters
slidingFitResultList	the output list of sliding linear fits

Definition at line 80 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
 
     for (ClusterVector::const_iterator iter = trackClusters.begin(), iterEnd = trackClusters.end(); iter != iterEnd; ++iter)
     {
         try
         {
             const TwoDSlidingFitResult slidingFitResult(*iter, m_halfWindowLayers, slidingFitPitch);
             slidingFitResultList.push_back(slidingFitResult);
         }
         catch (StatusCodeException &statusCodeException)
         {
             if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
                 throw statusCodeException;
         }
     }
 }

virtual void lar_content::TwoDSlidingFitConsolidationAlgorithm::GetReclusteredHits	(	const TwoDSlidingFitResultList &	slidingFitResultList,
		const pandora::ClusterVector &	showerClusters,
		ClusterToHitMap &	caloHitsToAdd,
		ClusterToHitMap &	caloHitsToRemove
	)		const

protectedpure virtual

Get the list of hits to be added or removed from clusters.

Parameters

slidingFitResultList	the list of sliding linear fits to track clusters
showerClusters	the vector of shower clusters
caloHitsToAdd	the output map of hits to be added to clusters
caloHitsToRemove	the output map of hits to be removed from clusters

Implemented in lar_content::TrackConsolidationAlgorithm.

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

protected

Definition at line 221 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithm(*this, xmlHandle, "ClusterRebuilding", m_reclusteringAlgorithmName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinTrackLength", m_minTrackLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxClusterLength", m_maxClusterLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitHalfWindow", m_halfWindowLayers));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::RebuildClusters	(	const ClusterToHitMap &	clustersAtStart,
		const pandora::ClusterSet &	unavailableClusters
	)		const

private

Re-build clusters.

Parameters

clustersAtStart	the initial mapping of clusters to hits
unavailableClusters	the list of unavailable clusters

Definition at line 181 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     if (clustersToRebuild.empty())
         return STATUS_CODE_SUCCESS;
 
     ClusterVector sortedClusters;
     for (const auto &mapEntry : clustersToRebuild)
     {
         if (!unavailableClusters.count(mapEntry.first))
             sortedClusters.push_back(mapEntry.first);
     }
 
     std::sort(sortedClusters.begin(), sortedClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster : sortedClusters)
     {
         const CaloHitList &caloHitList(clustersToRebuild.at(pCluster));
         const Cluster *const pClusterToDelete(pCluster);
 
         if (caloHitList.empty())
             continue;
 
         std::string currentClusterListName;
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentListName<Cluster>(*this, currentClusterListName));
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete<Cluster>(*this, pClusterToDelete));
 
         const ClusterList *pClusterList = NULL;
         std::string newClusterListName;
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=,
             PandoraContentApi::RunClusteringAlgorithm(*this, m_reclusteringAlgorithmName, pClusterList, newClusterListName));
 
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Cluster>(*this, newClusterListName, currentClusterListName));
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Cluster>(*this, currentClusterListName));
     }
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::RemoveHitsFromClusters	(	const ClusterToHitMap &	clustersToRebuild,
		pandora::ClusterSet &	unavailableClusters
	)		const

private

Remove hits from clusters.

Parameters

clustersToRebuild	the list of hits to be removed from clusters
unavailableClusters	the list of deleted clusters

Definition at line 101 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     ClusterList clusterList;
     for (const auto &mapEntry : clustersToContract)
         clusterList.push_back(mapEntry.first);
     clusterList.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster : clusterList)
     {
         const CaloHitList &caloHitListToRemove(clustersToContract.at(pCluster));
 
         if (caloHitListToRemove.empty())
             continue;
 
         if (unavailableClusters.count(pCluster))
             continue;
 
         CaloHitList caloHitList, caloHitListToKeep;
         pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
         for (const CaloHit *const pCaloHit : caloHitList)
         {
             if (caloHitListToRemove.end() == std::find(caloHitListToRemove.begin(), caloHitListToRemove.end(), pCaloHit))
                 caloHitListToKeep.push_back(pCaloHit);
         }
 
         if (caloHitListToKeep.empty())
         {
             // ATTN clustersToContract and unavailable clusters now contain dangling pointers
             unavailableClusters.insert(pCluster);
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete<Cluster>(*this, pCluster));
             continue;
         }
 
         for (const CaloHit *const pCaloHit : caloHitListToRemove)
         {
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RemoveFromCluster(*this, pCluster, pCaloHit));
         }
     }
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::Run ( )

protected

Definition at line 30 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     const ClusterList *pClusterList = NULL;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
 
     // Select tracks and showers for re-clustering (Note: samples not mutually exclusive)
     ClusterVector trackClusters, showerClusters;
     this->SortInputClusters(pClusterList, trackClusters, showerClusters);
 
     // Build sliding linear fits from track clusters
     TwoDSlidingFitResultList slidingFitResultList;
     this->BuildSlidingLinearFits(trackClusters, slidingFitResultList);
 
     // Recluster the hits
     ClusterToHitMap clustersToExpand, clustersToContract;
     this->GetReclusteredHits(slidingFitResultList, showerClusters, clustersToExpand, clustersToContract);
 
     // Consolidate and re-build clusters
     ClusterSet unavailableClusters;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->RemoveHitsFromClusters(clustersToContract, unavailableClusters));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->AddHitsToClusters(clustersToExpand, unavailableClusters));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->RebuildClusters(clustersToContract, unavailableClusters));
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::TwoDSlidingFitConsolidationAlgorithm::SortInputClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	trackClusters,
		pandora::ClusterVector &	showerClusters
	)		const

private

Sort input cluster list into track-like clusters and shower-like clusters.

Parameters

pClusterList	the input cluster list
trackClusters	the output vector of track-like clusters
showerClusters	the output vector of shower-like clusters

Definition at line 58 of file TwoDSlidingFitConsolidationAlgorithm.cc.

 {
     for (ClusterList::const_iterator iter = pClusterList->begin(), iterEnd = pClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         const float thisLengthSquared(LArClusterHelper::GetLengthSquared(pCluster));
 
         if (thisLengthSquared < m_maxClusterLength * m_maxClusterLength)
             showerClusters.push_back(pCluster);
 
         if (thisLengthSquared > m_minTrackLength * m_minTrackLength)
             trackClusters.push_back(pCluster);
     }
 
     std::sort(trackClusters.begin(), trackClusters.end(), LArClusterHelper::SortByNHits);
     std::sort(showerClusters.begin(), showerClusters.end(), LArClusterHelper::SortByNHits);
 }