SimpleClusterCreationAlgorithm class. More...

#include "SimpleClusterCreationAlgorithm.h"

Inheritance diagram for lar_content::SimpleClusterCreationAlgorithm:

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

Private Types
typedef std::unordered_map< const pandora::CaloHit *, pandora::CaloHitList >	HitAssociationMap

Private Member Functions
pandora::StatusCode	Run ()

void	SelectCaloHits (const pandora::CaloHitList *const pInputList, pandora::CaloHitList &outputList) const
	Select calo hits for clustering. More...

void	BuildAssociationMap (const pandora::CaloHitList &caloHitList, HitAssociationMap &hitAssociationMap) const
	Create map of associations between calo hits. More...

void	CreateClusters (const pandora::CaloHitList &caloHitList, const HitAssociationMap &hitAssociationMap) const
	Create clusters from selected calo hits and their associations. More...

void	CollectAssociatedHits (const pandora::CaloHit const pSeedCaloHit, const pandora::CaloHit const pCurrentCaloHit, const HitAssociationMap &hitAssociationMap, const pandora::CaloHitSet &vetoList, pandora::CaloHitList &mergeList) const
	For a given seed calo hits, collect up all the associated calo hits. More...

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

Private Attributes
float	m_clusteringWindowSquared
	Maximum distance (squared) for two hits to be joined. More...

Detailed Description

SimpleClusterCreationAlgorithm class.

Definition at line 21 of file SimpleClusterCreationAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::CaloHit *, pandora::CaloHitList> lar_content::SimpleClusterCreationAlgorithm::HitAssociationMap

private

Definition at line 32 of file SimpleClusterCreationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::SimpleClusterCreationAlgorithm::SimpleClusterCreationAlgorithm ( )

Default constructor.

Definition at line 20 of file SimpleClusterCreationAlgorithm.cc.

                                                                :
     m_clusteringWindowSquared(1.f)
 {
 }

Member Function Documentation

void lar_content::SimpleClusterCreationAlgorithm::BuildAssociationMap	(	const pandora::CaloHitList &	caloHitList,
		HitAssociationMap &	hitAssociationMap
	)		const

private

Create map of associations between calo hits.

Parameters

caloHitList	The input list of calo hits
hitAssociationMap	The map of associations between calo hits

Definition at line 62 of file SimpleClusterCreationAlgorithm.cc.

References m_clusteringWindowSquared.

Referenced by Run().

 {
     for (const CaloHit *const pCaloHitI : caloHitList)
     {
         for (const CaloHit *const pCaloHitJ : caloHitList)
         {
             if (pCaloHitI == pCaloHitJ)
                 continue;
 
             if ((pCaloHitI->GetPositionVector() - pCaloHitJ->GetPositionVector()).GetMagnitudeSquared() < m_clusteringWindowSquared)
             {
                 CaloHitList &caloHitListI(hitAssociationMap[pCaloHitI]);
 
                 if (caloHitListI.end() == std::find(caloHitListI.begin(), caloHitListI.end(), pCaloHitJ))
                     caloHitListI.push_back(pCaloHitJ);
 
                 CaloHitList &caloHitListJ(hitAssociationMap[pCaloHitI]);
 
                 if (caloHitListJ.end() == std::find(caloHitListJ.begin(), caloHitListJ.end(), pCaloHitI))
                     caloHitListJ.push_back(pCaloHitI);
             }
         }
     }
 }

void lar_content::SimpleClusterCreationAlgorithm::CollectAssociatedHits	(	const pandora::CaloHit *const	pSeedCaloHit,
		const pandora::CaloHit *const	pCurrentCaloHit,
		const HitAssociationMap &	hitAssociationMap,
		const pandora::CaloHitSet &	vetoList,
		pandora::CaloHitList &	mergeList
	)		const

private

For a given seed calo hits, collect up all the associated calo hits.

Parameters

pSeedCaloHit	the seed calo hits
pCurrentCaloHit	a possible associated calo hit
hitAssociationMap	the map of associations between hits
vetoList	the list of used calo hits
mergeList	the list of hits associated with the seed hit

Definition at line 119 of file SimpleClusterCreationAlgorithm.cc.

References lar_content::LArClusterHelper::SortHitsByPosition().

Referenced by CreateClusters().

 {
     if (vetoList.count(pCurrentCaloHit))
         return;
 
     HitAssociationMap::const_iterator iter1 = hitAssociationMap.find(pCurrentCaloHit);
     if (iter1 == hitAssociationMap.end())
         return;
 
     CaloHitVector caloHitVector(iter1->second.begin(), iter1->second.end());
     std::sort(caloHitVector.begin(), caloHitVector.end(), LArClusterHelper::SortHitsByPosition);
 
     for (const CaloHit *const pAssociatedCaloHit : caloHitVector)
     {
         if (pAssociatedCaloHit == pSeedCaloHit)
             continue;
 
         if (mergeList.end() != std::find(mergeList.begin(), mergeList.end(), pAssociatedCaloHit))
             continue;
 
         mergeList.push_back(pAssociatedCaloHit);
 
         this->CollectAssociatedHits(pSeedCaloHit, pAssociatedCaloHit, hitAssociationMap, vetoList, mergeList);
     }
 }

void lar_content::SimpleClusterCreationAlgorithm::CreateClusters	(	const pandora::CaloHitList &	caloHitList,
		const HitAssociationMap &	hitAssociationMap
	)		const

private

Create clusters from selected calo hits and their associations.

Parameters

caloHitList	The input list of calo hits
hitAssociationMap	The map of associations between calo hits

Definition at line 89 of file SimpleClusterCreationAlgorithm.cc.

References CollectAssociatedHits(), and lar_content::LArClusterHelper::SortHitsByPosition().

Referenced by Run().

 {
     CaloHitSet vetoList;
     CaloHitVector caloHitVector(caloHitList.begin(), caloHitList.end());
     std::sort(caloHitVector.begin(), caloHitVector.end(), LArClusterHelper::SortHitsByPosition);
 
     for (const CaloHit *const pSeedCaloHit : caloHitVector)
     {
         if (vetoList.count(pSeedCaloHit))
             continue;
 
         CaloHitList mergeList;
         this->CollectAssociatedHits(pSeedCaloHit, pSeedCaloHit, hitAssociationMap, vetoList, mergeList);
 
         const Cluster *pCluster = NULL;
         PandoraContentApi::Cluster::Parameters parameters;
         parameters.m_caloHitList.push_back(pSeedCaloHit);
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::Create(*this, parameters, pCluster));
         vetoList.insert(pSeedCaloHit);
 
         for (const CaloHit *const pAssociatedCaloHit : mergeList)
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToCluster(*this, pCluster, pAssociatedCaloHit));
             vetoList.insert(pAssociatedCaloHit);
         }
     }
 }

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

private

Definition at line 147 of file SimpleClusterCreationAlgorithm.cc.

References m_clusteringWindowSquared.

 {
     float clusteringWindow = std::sqrt(m_clusteringWindowSquared);
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ClusteringWindow", clusteringWindow));
     m_clusteringWindowSquared = clusteringWindow * clusteringWindow;
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::SimpleClusterCreationAlgorithm::Run ( )

private

Definition at line 27 of file SimpleClusterCreationAlgorithm.cc.

References BuildAssociationMap(), CreateClusters(), and SelectCaloHits().

 {
     const CaloHitList *pCaloHitList = NULL;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pCaloHitList));
 
     // Select available calo hits for clustering
     CaloHitList caloHitList;
     this->SelectCaloHits(pCaloHitList, caloHitList);
 
     if (caloHitList.empty())
         return STATUS_CODE_SUCCESS;
 
     // Build map of associations between selected calo hits
     HitAssociationMap hitAssociationMap;
     this->BuildAssociationMap(caloHitList, hitAssociationMap);
 
     // Create new clusters
     this->CreateClusters(caloHitList, hitAssociationMap);
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::SimpleClusterCreationAlgorithm::SelectCaloHits	(	const pandora::CaloHitList *const	pInputList,
		pandora::CaloHitList &	outputList
	)		const

private

Select calo hits for clustering.

Parameters

pInputList	The input list of calo hits
outputList	The output list of selected calo hits

Definition at line 51 of file SimpleClusterCreationAlgorithm.cc.

Referenced by Run().

 {
     for (const CaloHit *const pCaloHit : *pInputList)
     {
         if (PandoraContentApi::IsAvailable(*this, pCaloHit))
             outputList.push_back(pCaloHit);
     }
 }

Member Data Documentation

float lar_content::SimpleClusterCreationAlgorithm::m_clusteringWindowSquared

private

Maximum distance (squared) for two hits to be joined.

Definition at line 72 of file SimpleClusterCreationAlgorithm.h.

Referenced by BuildAssociationMap(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterCreation/SimpleClusterCreationAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterCreation/SimpleClusterCreationAlgorithm.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation