CosmicRayBaseMatchingAlgorithm class. More...

#include <CosmicRayBaseMatchingAlgorithm.h>

Inheritance diagram for lar_content::CosmicRayBaseMatchingAlgorithm:

Classes
class	Particle
	Particle class. More...

Protected Types
typedef std::vector< Particle >	ParticleList

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

typedef std::set< unsigned int >	UIntSet

Protected Member Functions
pandora::StatusCode	Run ()

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

virtual void	SelectCleanClusters (const pandora::ClusterVector &inputVector, pandora::ClusterVector &outputVector) const =0
	Select a set of clusters judged to be clean. More...

virtual bool	MatchClusters (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2) const =0
	Match a pair of clusters from two views. More...

virtual bool	CheckMatchedClusters3D (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const pandora::Cluster *const pCluster3) const =0
	Check that three clusters have a consistent 3D position. More...

virtual void	SetPfoParameters (const CosmicRayBaseMatchingAlgorithm::Particle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const =0
	Calculate Pfo properties from proto particle. More...

Private Member Functions
pandora::StatusCode	GetAvailableClusters (const std::string inputClusterListName, pandora::ClusterVector &clusterVector) const
	Get a vector of available clusters. More...

void	MatchClusters (const pandora::ClusterVector &clusterVector1, const pandora::ClusterVector &clusterVector2, CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters12) const
	Match sets of clusters from two views. More...

void	MatchThreeViews (const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters12, const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters23, const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters31, ParticleList &particleList) const
	Match clusters from three views and form into particles. More...

void	MatchTwoViews (const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters12, const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters23, const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters31, ParticleList &particleList) const
	Match clusters from two views and form into particles. More...

void	MatchTwoViews (const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &matchedClusters12, ParticleList &particleList) const
	Match clusters from two views and form into particles. More...

void	ResolveAmbiguities (const ParticleList &inputList, ParticleList &outputList) const
	Remove ambiguities between candidate particles. More...

void	BuildParticles (const ParticleList &particleList)
	Build PFO objects from candidate particles. More...

Private Attributes
std::string	m_inputClusterListNameU
	The name of the view U cluster list. More...

std::string	m_inputClusterListNameV
	The name of the view V cluster list. More...

std::string	m_inputClusterListNameW
	The name of the view W cluster list. More...

std::string	m_outputPfoListName
	The name of the output PFO list. More...

Detailed Description

CosmicRayBaseMatchingAlgorithm class.

Definition at line 22 of file CosmicRayBaseMatchingAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::Cluster *, pandora::ClusterList> lar_content::CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap

protected

Definition at line 49 of file CosmicRayBaseMatchingAlgorithm.h.

typedef std::vector<Particle> lar_content::CosmicRayBaseMatchingAlgorithm::ParticleList

protected

Definition at line 48 of file CosmicRayBaseMatchingAlgorithm.h.

typedef std::set<unsigned int> lar_content::CosmicRayBaseMatchingAlgorithm::UIntSet

protected

Definition at line 50 of file CosmicRayBaseMatchingAlgorithm.h.

Member Function Documentation

void lar_content::CosmicRayBaseMatchingAlgorithm::BuildParticles ( const ParticleList & particleList )

private

Build PFO objects from candidate particles.

Parameters

particleList the input list of particles

Definition at line 248 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     if (particleList.empty())
         return;
 
     const PfoList *pPfoList = NULL;
     std::string pfoListName;
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pPfoList, pfoListName));
 
     for (const Particle &particle : particleList)
     {
         const Cluster *const pClusterU = particle.m_pClusterU;
         const Cluster *const pClusterV = particle.m_pClusterV;
         const Cluster *const pClusterW = particle.m_pClusterW;
 
         const bool isAvailableU((NULL != pClusterU) ? pClusterU->IsAvailable() : true);
         const bool isAvailableV((NULL != pClusterV) ? pClusterV->IsAvailable() : true);
         const bool isAvailableW((NULL != pClusterW) ? pClusterW->IsAvailable() : true);
 
         if (!(isAvailableU && isAvailableV && isAvailableW))
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
         this->SetPfoParameters(particle, pfoParameters);
 
         if (pfoParameters.m_clusterList.empty())
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         const ParticleFlowObject *pPfo(NULL);
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::Create(*this, pfoParameters, pPfo));
     }
 
     if (!pPfoList->empty())
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Pfo>(*this, m_outputPfoListName));
 }

virtual bool lar_content::CosmicRayBaseMatchingAlgorithm::CheckMatchedClusters3D	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::Cluster *const	pCluster3
	)		const

protectedpure virtual

Check that three clusters have a consistent 3D position.

Parameters

pCluster1	the cluster from the first view
pCluster2	the cluster from the second view
pCluster3	the cluster from the third view

Returns: boolean

Implemented in lar_content::CosmicRayShowerMatchingAlgorithm, and lar_content::CosmicRayTrackMatchingAlgorithm.

StatusCode lar_content::CosmicRayBaseMatchingAlgorithm::GetAvailableClusters	(	const std::string	inputClusterListName,
		pandora::ClusterVector &	clusterVector
	)		const

private

Get a vector of available clusters.

Parameters

inputClusterListName	the input name of the cluster list
clusterVector	the output vector of available clusters

Definition at line 52 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     const ClusterList *pClusterList = NULL;
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, inputClusterListName, pClusterList))
 
     if (!pClusterList || pClusterList->empty())
     {
         if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             std::cout << "CosmicRayBaseMatchingAlgorithm: unable to find cluster list " << inputClusterListName << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     for (const Cluster *const pCluster : *pClusterList)
     {
         if (!pCluster->IsAvailable())
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
 
     return STATUS_CODE_SUCCESS;
 }

virtual bool lar_content::CosmicRayBaseMatchingAlgorithm::MatchClusters	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2
	)		const

protectedpure virtual

Match a pair of clusters from two views.

Parameters

pCluster1	the first cluster
pCluster2	the second cluster

Returns: boolean

Implemented in lar_content::CosmicRayShowerMatchingAlgorithm, and lar_content::CosmicRayTrackMatchingAlgorithm.

void lar_content::CosmicRayBaseMatchingAlgorithm::MatchClusters	(	const pandora::ClusterVector &	clusterVector1,
		const pandora::ClusterVector &	clusterVector2,
		CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters12
	)		const

private

Match sets of clusters from two views.

Parameters

clusterVector1	the vector of clusters from the first view
clusterVector2	the vector of clusters from the second view
matchedClusters12	the map of cluster matches

void lar_content::CosmicRayBaseMatchingAlgorithm::MatchThreeViews	(	const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters12,
		const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters23,
		const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters31,
		ParticleList &	particleList
	)		const

private

Match clusters from three views and form into particles.

Parameters

matchedClusters12	the map of matches between the view 1 and view 2
matchedClusters23	the map of matches between the view 2 and view 3
matchedClusters31	the map of matches between the view 3 and view 1
particleList	the output list of particles

Definition at line 112 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     if (matchedClusters12.empty() || matchedClusters23.empty() || matchedClusters31.empty())
         return;
 
     ParticleList candidateParticles;
 
     ClusterList clusterList1;
     for (const auto &mapEntry : matchedClusters12)
         clusterList1.push_back(mapEntry.first);
     clusterList1.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster1 : clusterList1)
     {
         const ClusterList &clusterList2(matchedClusters12.at(pCluster1));
 
         for (const Cluster *const pCluster2 : clusterList2)
         {
             ClusterAssociationMap::const_iterator iter23 = matchedClusters23.find(pCluster2);
 
             if (matchedClusters23.end() == iter23)
                 continue;
 
             const ClusterList &clusterList3 = iter23->second;
 
             for (const Cluster *const pCluster3 : clusterList3)
             {
                 ClusterAssociationMap::const_iterator iter31 = matchedClusters31.find(pCluster3);
 
                 if (matchedClusters31.end() == iter31)
                     continue;
 
                 if (iter31->second.end() == std::find(iter31->second.begin(), iter31->second.end(), pCluster1))
                     continue;
 
                 const HitType hitType1(LArClusterHelper::GetClusterHitType(pCluster1));
                 const HitType hitType2(LArClusterHelper::GetClusterHitType(pCluster2));
                 const HitType hitType3(LArClusterHelper::GetClusterHitType(pCluster3));
 
                 if (!this->CheckMatchedClusters3D(pCluster1, pCluster2, pCluster3))
                     continue;
 
                 const Cluster *const pClusterU(
                     (TPC_VIEW_U == hitType1) ? pCluster1 : (TPC_VIEW_U == hitType2) ? pCluster2 : (TPC_VIEW_U == hitType3) ? pCluster3 : NULL);
                 const Cluster *const pClusterV(
                     (TPC_VIEW_V == hitType1) ? pCluster1 : (TPC_VIEW_V == hitType2) ? pCluster2 : (TPC_VIEW_V == hitType3) ? pCluster3 : NULL);
                 const Cluster *const pClusterW(
                     (TPC_VIEW_W == hitType1) ? pCluster1 : (TPC_VIEW_W == hitType2) ? pCluster2 : (TPC_VIEW_W == hitType3) ? pCluster3 : NULL);
 
                 candidateParticles.push_back(Particle(pClusterU, pClusterV, pClusterW));
             }
         }
     }
 
     return this->ResolveAmbiguities(candidateParticles, matchedParticles);
 }

void lar_content::CosmicRayBaseMatchingAlgorithm::MatchTwoViews	(	const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters12,
		const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters23,
		const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters31,
		ParticleList &	particleList
	)		const

private

Match clusters from two views and form into particles.

Parameters

matchedClusters12	the map of matches between the view 1 and view 2
matchedClusters23	the map of matches between the view 2 and view 3
matchedClusters31	the map of matches between the view 3 and view 1
particleList	the output list of particles

Definition at line 172 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     ParticleList candidateParticles;
     this->MatchTwoViews(matchedClusters12, candidateParticles);
     this->MatchTwoViews(matchedClusters23, candidateParticles);
     this->MatchTwoViews(matchedClusters31, candidateParticles);
 
     return this->ResolveAmbiguities(candidateParticles, matchedParticles);
 }

void lar_content::CosmicRayBaseMatchingAlgorithm::MatchTwoViews	(	const CosmicRayBaseMatchingAlgorithm::ClusterAssociationMap &	matchedClusters12,
		ParticleList &	particleList
	)		const

private

Match clusters from two views and form into particles.

Parameters

matchedClusters12	the map of matches between the first and second views
particleList	the output list of particles

Definition at line 185 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     if (matchedClusters12.empty())
         return;
 
     ClusterList clusterList1;
     for (const auto &mapEntry : matchedClusters12)
         clusterList1.push_back(mapEntry.first);
     clusterList1.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster1 : clusterList1)
     {
         const ClusterList &clusterList2(matchedClusters12.at(pCluster1));
 
         for (const Cluster *const pCluster2 : clusterList2)
         {
             const HitType hitType1(LArClusterHelper::GetClusterHitType(pCluster1));
             const HitType hitType2(LArClusterHelper::GetClusterHitType(pCluster2));
 
             const Cluster *const pClusterU((TPC_VIEW_U == hitType1) ? pCluster1 : (TPC_VIEW_U == hitType2) ? pCluster2 : NULL);
             const Cluster *const pClusterV((TPC_VIEW_V == hitType1) ? pCluster1 : (TPC_VIEW_V == hitType2) ? pCluster2 : NULL);
             const Cluster *const pClusterW((TPC_VIEW_W == hitType1) ? pCluster1 : (TPC_VIEW_W == hitType2) ? pCluster2 : NULL);
 
             matchedParticles.push_back(Particle(pClusterU, pClusterV, pClusterW));
         }
     }
 }

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

protected

Definition at line 304 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputPfoListName", m_outputPfoListName));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameU", m_inputClusterListNameU));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameV", m_inputClusterListNameV));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameW", m_inputClusterListNameW));
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::CosmicRayBaseMatchingAlgorithm::ResolveAmbiguities	(	const ParticleList &	inputList,
		ParticleList &	outputList
	)		const

private

Remove ambiguities between candidate particles.

Parameters

inputList	the input list of particles
outputList	the output list of particles

Definition at line 215 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     for (const Particle &particle1 : candidateParticles)
     {
         bool isGoodMatch(true);
 
         for (const Particle &particle2 : candidateParticles)
         {
             const bool commonU(particle1.m_pClusterU == particle2.m_pClusterU);
             const bool commonV(particle1.m_pClusterV == particle2.m_pClusterV);
             const bool commonW(particle1.m_pClusterW == particle2.m_pClusterW);
 
             const bool ambiguousU(commonU && NULL != particle1.m_pClusterU);
             const bool ambiguousV(commonV && NULL != particle1.m_pClusterV);
             const bool ambiguousW(commonW && NULL != particle1.m_pClusterW);
 
             if (commonU && commonV && commonW)
                 continue;
 
             if (ambiguousU || ambiguousV || ambiguousW)
             {
                 isGoodMatch = false;
                 break;
             }
         }
 
         if (isGoodMatch)
             matchedParticles.push_back(particle1);
     }
 }

StatusCode lar_content::CosmicRayBaseMatchingAlgorithm::Run ( )

protected

Definition at line 21 of file CosmicRayBaseMatchingAlgorithm.cc.

 {
     // Get the available clusters for each view
     ClusterVector availableClustersU, availableClustersV, availableClustersW;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->GetAvailableClusters(m_inputClusterListNameU, availableClustersU));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->GetAvailableClusters(m_inputClusterListNameV, availableClustersV));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->GetAvailableClusters(m_inputClusterListNameW, availableClustersW));
 
     // Select clean clusters in each view
     ClusterVector cleanClustersU, cleanClustersV, cleanClustersW;
     this->SelectCleanClusters(availableClustersU, cleanClustersU);
     this->SelectCleanClusters(availableClustersV, cleanClustersV);
     this->SelectCleanClusters(availableClustersW, cleanClustersW);
 
     // Build associations between pairs of views
     ClusterAssociationMap matchedClusterUV, matchedClusterVW, matchedClusterWU;
     this->MatchClusters(cleanClustersU, cleanClustersV, matchedClusterUV);
     this->MatchClusters(cleanClustersV, cleanClustersW, matchedClusterVW);
     this->MatchClusters(cleanClustersW, cleanClustersU, matchedClusterWU);
 
     // Build particles from associations
     ParticleList particleList;
     this->MatchThreeViews(matchedClusterUV, matchedClusterVW, matchedClusterWU, particleList);
     this->MatchTwoViews(matchedClusterUV, matchedClusterVW, matchedClusterWU, particleList);
     this->BuildParticles(particleList);
 
     return STATUS_CODE_SUCCESS;
 }

virtual void lar_content::CosmicRayBaseMatchingAlgorithm::SelectCleanClusters	(	const pandora::ClusterVector &	inputVector,
		pandora::ClusterVector &	outputVector
	)		const

protectedpure virtual

Select a set of clusters judged to be clean.

Parameters

inputVector	the input vector of all available clusters
outputVector	the output vector of clean clusters

Implemented in lar_content::CosmicRayShowerMatchingAlgorithm, and lar_content::CosmicRayTrackMatchingAlgorithm.

virtual void lar_content::CosmicRayBaseMatchingAlgorithm::SetPfoParameters	(	const CosmicRayBaseMatchingAlgorithm::Particle &	protoParticle,
		PandoraContentApi::ParticleFlowObject::Parameters &	pfoParameters
	)		const