CosmicRayShowerMatchingAlgorithm class. More...

#include "CosmicRayShowerMatchingAlgorithm.h"

Inheritance diagram for lar_content::CosmicRayShowerMatchingAlgorithm:

Public Member Functions
	CosmicRayShowerMatchingAlgorithm ()
	Default constructor. 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 ()

Private Member Functions
void	SelectCleanClusters (const pandora::ClusterVector &inputVector, pandora::ClusterVector &outputVector) const
	Select a set of clusters judged to be clean. More...

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

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

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

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

Private Attributes
float	m_minCaloHitsPerCluster
	minimum size of clusters for this algorithm More...

float	m_minXOverlap
	requirement on minimum X overlap for associated clusters More...

float	m_minXOverlapFraction
	requirement on minimum X overlap fraction for associated clusters More...

float	m_pseudoChi2Cut
	The selection cut on the matched chi2. More...

Detailed Description

CosmicRayShowerMatchingAlgorithm class.

Definition at line 19 of file CosmicRayShowerMatchingAlgorithm.h.

Member Typedef Documentation

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

protectedinherited

Definition at line 49 of file CosmicRayBaseMatchingAlgorithm.h.

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

protectedinherited

Definition at line 48 of file CosmicRayBaseMatchingAlgorithm.h.

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

protectedinherited

Definition at line 50 of file CosmicRayBaseMatchingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::CosmicRayShowerMatchingAlgorithm::CosmicRayShowerMatchingAlgorithm ( )

Default constructor.

Definition at line 21 of file CosmicRayShowerMatchingAlgorithm.cc.

                                                                    :
     m_minCaloHitsPerCluster(10),
     m_minXOverlap(1.f),
     m_minXOverlapFraction(0.5f),
     m_pseudoChi2Cut(5.f)
 {
 }

Member Function Documentation

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

privatevirtual

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

Implements lar_content::CosmicRayBaseMatchingAlgorithm.

Definition at line 64 of file CosmicRayShowerMatchingAlgorithm.cc.

References f, lar_content::LArClusterHelper::GetAverageZ(), lar_content::LArClusterHelper::GetClusterHitType(), m_pseudoChi2Cut, and lar_content::LArGeometryHelper::MergeTwoPositions().

 {
     // Check that three clusters have a consistent 3D position
     const HitType hitType1(LArClusterHelper::GetClusterHitType(pCluster1));
     const HitType hitType2(LArClusterHelper::GetClusterHitType(pCluster2));
     const HitType hitType3(LArClusterHelper::GetClusterHitType(pCluster3));
 
     if (hitType1 == hitType2 || hitType2 == hitType3 || hitType3 == hitType1)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     // Requirements on X matching
     float xMin1(0.f), xMin2(0.f), xMin3(0.f), xMax1(0.f), xMax2(0.f), xMax3(0.f);
     pCluster1->GetClusterSpanX(xMin1, xMax1);
     pCluster2->GetClusterSpanX(xMin2, xMax2);
     pCluster3->GetClusterSpanX(xMin3, xMax3);
 
     const float xMin(std::max(xMin1, std::max(xMin2, xMin3)));
     const float xMax(std::min(xMax1, std::min(xMax2, xMax3)));
     const float xOverlap(xMax - xMin);
 
     if (xOverlap < std::numeric_limits<float>::epsilon())
         return false;
 
     float p1(std::numeric_limits<float>::max()), p2(std::numeric_limits<float>::max()), p3(std::numeric_limits<float>::max());
 
     if ((STATUS_CODE_SUCCESS != LArClusterHelper::GetAverageZ(pCluster1, xMin, xMax, p1)) ||
         (STATUS_CODE_SUCCESS != LArClusterHelper::GetAverageZ(pCluster2, xMin, xMax, p2)) ||
         (STATUS_CODE_SUCCESS != LArClusterHelper::GetAverageZ(pCluster3, xMin, xMax, p3)))
     {
         return false;
     }
 
     const float q3(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), hitType1, hitType2, p1, p2));
     const float q1(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), hitType2, hitType3, p2, p3));
     const float q2(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), hitType3, hitType1, p3, p1));
 
     const float pseudoChi2(((q1 - p1) * (q1 - p1) + (q2 - p2) * (q2 - p2) + (q3 - p3) * (q3 - p3)) / 3.f);
 
     if (pseudoChi2 > m_pseudoChi2Cut)
         return false;
 
     return true;
 }

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

privatevirtual

Match a pair of clusters from two views.

Parameters

pCluster1	the first cluster
pCluster2	the second cluster

Returns: boolean

Implements lar_content::CosmicRayBaseMatchingAlgorithm.

Definition at line 44 of file CosmicRayShowerMatchingAlgorithm.cc.

References f, m_minXOverlap, and m_minXOverlapFraction.

 {
     float xMin1(0.f), xMax1(0.f), xMin2(0.f), xMax2(0.f);
     pCluster1->GetClusterSpanX(xMin1, xMax1);
     pCluster2->GetClusterSpanX(xMin2, xMax2);
 
     const float xOverlap(std::min(xMax1, xMax2) - std::max(xMin1, xMin2));
     const float xSpan(std::max(xMax1, xMax2) - std::min(xMin1, xMin2));
 
     if (xSpan < std::numeric_limits<float>::epsilon())
         return false;
 
     if (xOverlap > m_minXOverlap && xOverlap / xSpan > m_minXOverlapFraction)
         return true;
 
     return false;
 }

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

private

Definition at line 132 of file CosmicRayShowerMatchingAlgorithm.cc.

References m_minCaloHitsPerCluster, m_minXOverlap, m_minXOverlapFraction, m_pseudoChi2Cut, and lar_content::CosmicRayBaseMatchingAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinCaloHitsPerCluster", m_minCaloHitsPerCluster));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinXOverlap", m_minXOverlap));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinXOverlapFraction", m_minXOverlapFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PseudoChi2Cut", m_pseudoChi2Cut));
 
     return CosmicRayBaseMatchingAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::CosmicRayBaseMatchingAlgorithm::Run ( )

protectedinherited

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

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

privatevirtual

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

Implements lar_content::CosmicRayBaseMatchingAlgorithm.

Definition at line 31 of file CosmicRayShowerMatchingAlgorithm.cc.

References m_minCaloHitsPerCluster.

 {
     for (const Cluster *const pCluster : inputVector)
     {
         if (pCluster->GetNCaloHits() < m_minCaloHitsPerCluster)
             continue;
 
         outputVector.push_back(pCluster);
     }
 }

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

privatevirtual

Calculate Pfo properties from proto particle.

Parameters

protoParticle	the input proto particle
pfoParameters	the output pfo parameters

Implements lar_content::CosmicRayBaseMatchingAlgorithm.

Definition at line 111 of file CosmicRayShowerMatchingAlgorithm.cc.

References f, lar_content::CosmicRayBaseMatchingAlgorithm::Particle::m_pClusterU, lar_content::CosmicRayBaseMatchingAlgorithm::Particle::m_pClusterV, and lar_content::CosmicRayBaseMatchingAlgorithm::Particle::m_pClusterW.

 {
     ClusterList clusterList;
     if (particle.m_pClusterU)
         clusterList.push_back(particle.m_pClusterU);
     if (particle.m_pClusterV)
         clusterList.push_back(particle.m_pClusterV);
     if (particle.m_pClusterW)
         clusterList.push_back(particle.m_pClusterW);
 
     // TODO Correct these placeholder parameters
     pfoParameters.m_particleId = E_MINUS; // SHOWER
     pfoParameters.m_charge = PdgTable::GetParticleCharge(pfoParameters.m_particleId.Get());
     pfoParameters.m_mass = PdgTable::GetParticleMass(pfoParameters.m_particleId.Get());
     pfoParameters.m_energy = 0.f;
     pfoParameters.m_momentum = CartesianVector(0.f, 0.f, 0.f);
     pfoParameters.m_clusterList = clusterList;
 }

Member Data Documentation

float lar_content::CosmicRayShowerMatchingAlgorithm::m_minCaloHitsPerCluster

private

minimum size of clusters for this algorithm

Definition at line 36 of file CosmicRayShowerMatchingAlgorithm.h.

Referenced by ReadSettings(), and SelectCleanClusters().

float lar_content::CosmicRayShowerMatchingAlgorithm::m_minXOverlap

private

requirement on minimum X overlap for associated clusters

Definition at line 37 of file CosmicRayShowerMatchingAlgorithm.h.

Referenced by MatchClusters(), and ReadSettings().

float lar_content::CosmicRayShowerMatchingAlgorithm::m_minXOverlapFraction

private

requirement on minimum X overlap fraction for associated clusters

Definition at line 38 of file CosmicRayShowerMatchingAlgorithm.h.

Referenced by MatchClusters(), and ReadSettings().

float lar_content::CosmicRayShowerMatchingAlgorithm::m_pseudoChi2Cut

private

The selection cut on the matched chi2.

Definition at line 39 of file CosmicRayShowerMatchingAlgorithm.h.

Referenced by CheckMatchedClusters3D(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/CosmicRayShowerMatchingAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/CosmicRayShowerMatchingAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation