VertexBasedPfoMopUpAlgorithm class. More...

#include "VertexBasedPfoMopUpAlgorithm.h"

Inheritance diagram for lar_content::VertexBasedPfoMopUpAlgorithm:

Classes
class	ClusterAssociation
	ClusterAssociation class. More...

class	ConeParameters
	ConeParameters class. More...

class	PfoAssociation
	PfoAssociation class. More...

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

virtual void	MergeAndDeletePfos (const pandora::ParticleFlowObject const pPfoToEnlarge, const pandora::ParticleFlowObject const pPfoToDelete) const
	Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc. More...

template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object. More...

Static Public Member Functions
static const pandora::Cluster *	GetParentCluster (const pandora::ClusterList &clusterList, const pandora::HitType hitType)
	Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type. More...

Protected Types
typedef std::vector< PfoAssociation >	PfoAssociationList

typedef std::map< pandora::HitType, ClusterAssociation >	HitTypeToAssociationMap

typedef std::set< pandora::HitType >	HitTypeSet

typedef std::map< pandora::HitType, const pandora::Cluster * >	HitTypeToClusterMap

Protected Member Functions
pandora::StatusCode	Run ()

virtual bool	IsVertexAssociated (const pandora::CartesianVector &vertex2D, const LArPointingCluster &pointingCluster) const
	Whether a specified pfo is associated with a specified vertex. More...

virtual PfoAssociation	GetPfoAssociation (const pandora::Pfo const pVertexPfo, const pandora::Pfo const pDaughterPfo, HitTypeToAssociationMap &hitTypeToAssociationMap) const
	Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo. More...

void	GetInputPfos (const pandora::Vertex *const pVertex, pandora::PfoList &vertexPfos, pandora::PfoList &nonVertexPfos) const
	Get the list of input pfos and divide them into vertex-associated and non-vertex-associated lists. More...

bool	IsVertexAssociated (const pandora::Pfo const pPfo, const pandora::Vertex const pVertex) const
	Whether a specified pfo is associated with a specified vertex. More...

void	GetPfoAssociations (const pandora::Vertex *const pVertex, const pandora::PfoList &vertexPfos, const pandora::PfoList &nonVertexPfos, PfoAssociationList &pfoAssociationList) const
	Get the list of associations between vertex-associated pfos and non-vertex-associated pfos. More...

PfoAssociation	GetPfoAssociation (const pandora::Vertex const pVertex, const pandora::Pfo const pVertexPfo, const pandora::Pfo *const pDaughterPfo) const
	Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo. More...

ClusterAssociation	GetClusterAssociation (const pandora::Vertex const pVertex, const pandora::Cluster const pVertexCluster, const pandora::Cluster *const pDaughterCluster) const
	Get cluster association details between a vertex-associated cluster and a non-vertex associated daughter candidate cluster. More...

bool	ProcessPfoAssociations (const PfoAssociationList &pfoAssociationList) const
	Process the list of pfo associations, merging the best-matching pfo. More...

void	MergePfos (const PfoAssociation &pfoAssociation) const
	Merge the vertex and daughter pfos (deleting daughter pfo, merging clusters, etc.) described in the specified pfoAssociation. More...

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

Protected Attributes
std::string	m_trackPfoListName
	The input track pfo list name. More...

std::string	m_showerPfoListName
	The input shower pfo list name. More...

float	m_minVertexLongitudinalDistance
	Vertex association check: min longitudinal distance cut. More...

float	m_maxVertexTransverseDistance
	Vertex association check: max transverse distance cut. More...

unsigned int	m_minVertexAssociatedHitTypes
	The min number of vertex associated hit types for a vertex associated pfo. More...

float	m_coneAngleCentile
	Cluster cone angle is defined using specified centile of distribution of hit half angles. More...

float	m_maxConeCosHalfAngle
	Maximum value for cosine of cone half angle. More...

float	m_maxConeLengthMultiplier
	Consider hits as bound if inside cone, with projected distance less than N times cone length. More...

float	m_directionTanAngle
	Direction determination, look for vertex inside triangle with apex shifted along the cluster length. More...

float	m_directionApexShift
	Direction determination, look for vertex inside triangle with apex shifted along the cluster length. More...

float	m_meanBoundedFractionCut
	Cut on association info (mean bounded fraction) for determining pfo merges. More...

float	m_maxBoundedFractionCut
	Cut on association info (max bounded fraction) for determining pfo merges. More...

float	m_minBoundedFractionCut
	Cut on association info (min bounded fraction) for determining pfo merges. More...

unsigned int	m_minConsistentDirections
	The minimum number of consistent cluster directions to allow a pfo merge. More...

unsigned int	m_minConsistentDirectionsTrack
	The minimum number of consistent cluster directions to allow a merge involving a track pfo. More...

pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names. More...

Detailed Description

VertexBasedPfoMopUpAlgorithm class.

Definition at line 21 of file VertexBasedPfoMopUpAlgorithm.h.

Member Typedef Documentation

typedef std::set<pandora::HitType> lar_content::VertexBasedPfoMopUpAlgorithm::HitTypeSet

protected

Definition at line 343 of file VertexBasedPfoMopUpAlgorithm.h.

typedef std::map<pandora::HitType, ClusterAssociation> lar_content::VertexBasedPfoMopUpAlgorithm::HitTypeToAssociationMap

protected

Definition at line 258 of file VertexBasedPfoMopUpAlgorithm.h.

typedef std::map<pandora::HitType, const pandora::Cluster*> lar_content::VertexBasedPfoMopUpAlgorithm::HitTypeToClusterMap

protected

Definition at line 344 of file VertexBasedPfoMopUpAlgorithm.h.

typedef std::vector<PfoAssociation> lar_content::VertexBasedPfoMopUpAlgorithm::PfoAssociationList

protected

Definition at line 186 of file VertexBasedPfoMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::VertexBasedPfoMopUpAlgorithm::VertexBasedPfoMopUpAlgorithm ( )

Default constructor.

Definition at line 26 of file VertexBasedPfoMopUpAlgorithm.cc.

                                                            :
     m_minVertexLongitudinalDistance(-2.5f),
     m_maxVertexTransverseDistance(1.5f),
     m_minVertexAssociatedHitTypes(2),
     m_coneAngleCentile(0.8f),
     m_maxConeCosHalfAngle(0.95f),
     m_maxConeLengthMultiplier(3.f),
     m_directionTanAngle(1.732f),
     m_directionApexShift(0.333f),
     m_meanBoundedFractionCut(0.6f),
     m_maxBoundedFractionCut(0.7f),
     m_minBoundedFractionCut(0.3f),
     m_minConsistentDirections(2),
     m_minConsistentDirectionsTrack(3)
 {
 }

Member Function Documentation

VertexBasedPfoMopUpAlgorithm::ClusterAssociation lar_content::VertexBasedPfoMopUpAlgorithm::GetClusterAssociation	(	const pandora::Vertex *const	pVertex,
		const pandora::Cluster *const	pVertexCluster,
		const pandora::Cluster *const	pDaughterCluster
	)		const

protected

Get cluster association details between a vertex-associated cluster and a non-vertex associated daughter candidate cluster.

Parameters

pVertex	the address of the vertex
pVertexCluster	the address of the vertex-associated cluster
pDaughterCluster	the address of the non-vertex-associated cluster

Returns: the cluster association details

Definition at line 202 of file VertexBasedPfoMopUpAlgorithm.cc.

References lar_content::VertexBasedPfoMopUpAlgorithm::ConeParameters::GetBoundedFraction(), lar_content::LArVertexHelper::GetClusterDirectionInZ(), lar_content::LArClusterHelper::GetClusterHitType(), m_coneAngleCentile, m_directionApexShift, m_directionTanAngle, m_maxConeCosHalfAngle, m_maxConeLengthMultiplier, and lar_content::LArGeometryHelper::ProjectPosition().

Referenced by GetPfoAssociations().

 {
     const HitType vertexHitType(LArClusterHelper::GetClusterHitType(pVertexCluster));
     const CartesianVector vertexPosition2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), vertexHitType));
 
     const ConeParameters coneParameters(pVertexCluster, vertexPosition2D, m_coneAngleCentile, m_maxConeCosHalfAngle);
     const float boundedFraction(coneParameters.GetBoundedFraction(pDaughterCluster, m_maxConeLengthMultiplier));
 
     const LArVertexHelper::ClusterDirection vertexClusterDirection(LArVertexHelper::GetClusterDirectionInZ(this->GetPandora(), pVertex,
         pVertexCluster, m_directionTanAngle, m_directionApexShift));
     const LArVertexHelper::ClusterDirection daughterClusterDirection(LArVertexHelper::GetClusterDirectionInZ(this->GetPandora(), pVertex,
         pDaughterCluster, m_directionTanAngle, m_directionApexShift));
     const bool isConsistentDirection(vertexClusterDirection == daughterClusterDirection);
 
     return ClusterAssociation(pVertexCluster, pDaughterCluster, boundedFraction, isConsistentDirection);
 }

void lar_content::VertexBasedPfoMopUpAlgorithm::GetInputPfos	(	const pandora::Vertex *const	pVertex,
		pandora::PfoList &	vertexPfos,
		pandora::PfoList &	nonVertexPfos
	)		const

protected

Get the list of input pfos and divide them into vertex-associated and non-vertex-associated lists.

Parameters

pVertex	the address of the 3d vertex
vertexPfos	to receive the list of vertex-associated pfos
nonVertexPfos	to receive the list of nonvertex-associated pfos

Definition at line 99 of file VertexBasedPfoMopUpAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), IsVertexAssociated(), m_minVertexAssociatedHitTypes, m_showerPfoListName, m_trackPfoListName, and lar_content::LArGeometryHelper::ProjectPosition().

Referenced by Run().

 {
     StringVector listNames;
     listNames.push_back(m_trackPfoListName);
     listNames.push_back(m_showerPfoListName);
 
     for (const std::string &listName : listNames)
     {
         const PfoList *pPfoList(nullptr);
 
         if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, listName, pPfoList))
             continue;
 
         for (const Pfo *const pPfo : *pPfoList)
         {
             PfoList &pfoTargetList(this->IsVertexAssociated(pPfo, pVertex) ? vertexPfos : nonVertexPfos);
             pfoTargetList.push_back(pPfo);
         }
     }
 }

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(), lar_content::ClusterMopUpBaseAlgorithm::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);
 }

const Cluster * lar_content::PfoMopUpBaseAlgorithm::GetParentCluster	(	const pandora::ClusterList &	clusterList,
		const pandora::HitType	hitType
	)

staticinherited

Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type.

Parameters

clusterList	the cluster list
hitType	the hit type

Returns: the address of the parent cluster

Definition at line 60 of file PfoMopUpBaseAlgorithm.cc.

Referenced by lar_content::SlidingConeClusterMopUpAlgorithm::MakeClusterMerges(), lar_content::SlidingConeClusterMopUpAlgorithm::ClusterMerge::operator<(), lar_content::SlidingConePfoMopUpAlgorithm::ClusterMerge::operator<(), and lar_content::MasterAlgorithm::StitchPfos().

 {
     unsigned int mostHits(0);
     const Cluster *pBestParentCluster(nullptr);
 
     for (const Cluster *const pParentCluster : clusterList)
     {
         if (hitType != LArClusterHelper::GetClusterHitType(pParentCluster))
             continue;
 
         const unsigned int nParentHits(pParentCluster->GetNCaloHits());
 
         if (nParentHits > mostHits)
         {
             mostHits = nParentHits;
             pBestParentCluster = pParentCluster;
         }
     }
 
     return pBestParentCluster;
 }

virtual PfoAssociation lar_content::VertexBasedPfoMopUpAlgorithm::GetPfoAssociation	(	const pandora::Pfo *const	pVertexPfo,
		const pandora::Pfo *const	pDaughterPfo,
		HitTypeToAssociationMap &	hitTypeToAssociationMap
	)		const

protectedvirtual

Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo.

Parameters

pVertexPfo	the address of the vertex-associated pfo
pDaughterPfo	the address of the non-vertex-associated pfo
hitTypeToAssociationMap	the hit type to association map

Returns: the pfo association details

Reimplemented in lar_content::ShowerPfoMopUpAlgorithm.

Referenced by GetPfoAssociations(), and Run().

PfoAssociation lar_content::VertexBasedPfoMopUpAlgorithm::GetPfoAssociation	(	const pandora::Vertex *const	pVertex,
		const pandora::Pfo *const	pVertexPfo,
		const pandora::Pfo *const	pDaughterPfo
	)		const

protected

Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo.

Parameters

pVertex	the address of the 3d vertex
pVertexPfo	the address of the vertex-associated pfo
pDaughterPfo	the address of the non-vertex-associated pfo

Returns: the pfo association details

void lar_content::VertexBasedPfoMopUpAlgorithm::GetPfoAssociations	(	const pandora::Vertex *const	pVertex,
		const pandora::PfoList &	vertexPfos,
		const pandora::PfoList &	nonVertexPfos,
		PfoAssociationList &	pfoAssociationList
	)		const

protected

Get the list of associations between vertex-associated pfos and non-vertex-associated pfos.

Parameters

pVertex	the address of the 3d vertex
vertexPfos	the list of vertex-associated pfos
nonVertexPfos	the list of nonvertex-associated pfos
pfoAssociationList	to receive the pfo association list

Definition at line 154 of file VertexBasedPfoMopUpAlgorithm.cc.

References GetClusterAssociation(), lar_content::LArClusterHelper::GetClusterHitType(), and GetPfoAssociation().

Referenced by Run().

 {
     for (const Pfo *const pVertexPfo : vertexPfos)
     {
         for (const Pfo *const pDaughterPfo : nonVertexPfos)
         {
             try
             {
                 const PfoAssociation pfoAssociation(this->GetPfoAssociation(pVertex, pVertexPfo, pDaughterPfo));
                 pfoAssociationList.push_back(pfoAssociation);
             }
             catch (StatusCodeException &) {}
         }
     }
 }

virtual bool lar_content::VertexBasedPfoMopUpAlgorithm::IsVertexAssociated	(	const pandora::CartesianVector &	vertex2D,
		const LArPointingCluster &	pointingCluster
	)		const

protectedvirtual

Whether a specified pfo is associated with a specified vertex.

Parameters

vertex2D	the 2d vertex position
pointingCluster	the pointing cluster

Returns: boolean

Reimplemented in lar_content::ShowerPfoMopUpAlgorithm.

Referenced by GetInputPfos(), and Run().

bool lar_content::VertexBasedPfoMopUpAlgorithm::IsVertexAssociated	(	const pandora::Pfo *const	pPfo,
		const pandora::Vertex *const	pVertex
	)		const

protected

Whether a specified pfo is associated with a specified vertex.

Parameters

pPfo	the address of the pfo
pVertex	the address of the 3d vertex

Returns: boolean

void lar_content::PfoMopUpBaseAlgorithm::MergeAndDeletePfos	(	const pandora::ParticleFlowObject *const	pPfoToEnlarge,
		const pandora::ParticleFlowObject *const	pPfoToDelete
	)		const

virtualinherited

Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc.

Parameters

pPfoToEnlarge	the address of the pfo to enlarge
pPfoToDelete	the address of the pfo to delete (will become a dangling pointer)

Definition at line 20 of file PfoMopUpBaseAlgorithm.cc.

Referenced by lar_content::SlidingConePfoMopUpAlgorithm::MakePfoMerges(), and MergePfos().

 {
     if (pPfoToEnlarge == pPfoToDelete)
         throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
 
     const PfoList daughterPfos(pPfoToDelete->GetDaughterPfoList());
     const ClusterVector daughterClusters(pPfoToDelete->GetClusterList().begin(), pPfoToDelete->GetClusterList().end());
     const VertexVector daughterVertices(pPfoToDelete->GetVertexList().begin(), pPfoToDelete->GetVertexList().end());
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete(*this, pPfoToDelete, this->GetListName(pPfoToDelete)));
 
     for (const ParticleFlowObject *const pDaughterPfo : daughterPfos)
     {
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SetPfoParentDaughterRelationship(*this, pPfoToEnlarge, pDaughterPfo));
     }
 
     for (const  Vertex *const pDaughterVertex : daughterVertices)
     {
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete(*this, pDaughterVertex, this->GetListName(pDaughterVertex)));
     }
 
     for (const Cluster *const pDaughterCluster : daughterClusters)
     {
         const HitType daughterHitType(LArClusterHelper::GetClusterHitType(pDaughterCluster));
         const Cluster *pParentCluster(PfoMopUpBaseAlgorithm::GetParentCluster(pPfoToEnlarge->GetClusterList(), daughterHitType));
 
         if (pParentCluster)
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pParentCluster, pDaughterCluster,
                 this->GetListName(pParentCluster), this->GetListName(pDaughterCluster)));
         }
         else
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToPfo(*this, pPfoToEnlarge, pDaughterCluster));
         }
     }
 }

void lar_content::VertexBasedPfoMopUpAlgorithm::MergePfos ( const PfoAssociation & pfoAssociation ) const

protected

Merge the vertex and daughter pfos (deleting daughter pfo, merging clusters, etc.) described in the specified pfoAssociation.

Parameters

pfoAssociation the pfo association details

Definition at line 262 of file VertexBasedPfoMopUpAlgorithm.cc.

References lar_content::VertexBasedPfoMopUpAlgorithm::PfoAssociation::GetDaughterPfo(), lar_content::VertexBasedPfoMopUpAlgorithm::PfoAssociation::GetVertexPfo(), m_showerPfoListName, m_trackPfoListName, and lar_content::PfoMopUpBaseAlgorithm::MergeAndDeletePfos().

Referenced by ProcessPfoAssociations().

 {
     const PfoList *pTrackPfoList(nullptr), *pShowerPfoList(nullptr);
     (void) PandoraContentApi::GetList(*this, m_trackPfoListName, pTrackPfoList);
     (void) PandoraContentApi::GetList(*this, m_showerPfoListName, pShowerPfoList);
 
     if (!pTrackPfoList && !pShowerPfoList)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     const Pfo *const pVertexPfo(pfoAssociation.GetVertexPfo());
     const bool isvertexTrack(pTrackPfoList && (pTrackPfoList->end() != std::find(pTrackPfoList->begin(), pTrackPfoList->end(), pVertexPfo)));
     const Pfo *pDaughterPfo(pfoAssociation.GetDaughterPfo());
     const bool isDaughterShower(pShowerPfoList && (pShowerPfoList->end() != std::find(pShowerPfoList->begin(), pShowerPfoList->end(), pDaughterPfo)));
 
     this->MergeAndDeletePfos(pVertexPfo, pDaughterPfo);
 
     if (isvertexTrack && isDaughterShower)
     {
         const PfoList vertexPfoList(1, pVertexPfo);
 
         PandoraContentApi::ParticleFlowObject::Metadata metadata;
         metadata.m_particleId = E_MINUS;
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*this, pVertexPfo, metadata));
 
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, m_trackPfoListName, m_showerPfoListName, vertexPfoList));
     }
 }

bool lar_content::VertexBasedPfoMopUpAlgorithm::ProcessPfoAssociations ( const PfoAssociationList & pfoAssociationList ) const

protected

Process the list of pfo associations, merging the best-matching pfo.

Parameters

pfoAssociationList the pfo association list

Returns: whether a pfo merge was made

Definition at line 222 of file VertexBasedPfoMopUpAlgorithm.cc.

References m_maxBoundedFractionCut, m_meanBoundedFractionCut, m_minBoundedFractionCut, m_minConsistentDirections, m_minConsistentDirectionsTrack, m_trackPfoListName, and MergePfos().

Referenced by Run().

 {
     const PfoList *pTrackPfoList(nullptr);
     (void) PandoraContentApi::GetList(*this, m_trackPfoListName, pTrackPfoList);
 
     for (const PfoAssociation &pfoAssociation : pfoAssociationList)
     {
         if ((pfoAssociation.GetMeanBoundedFraction() < m_meanBoundedFractionCut) ||
             (pfoAssociation.GetMaxBoundedFraction() < m_maxBoundedFractionCut) ||
             (pfoAssociation.GetMinBoundedFraction() < m_minBoundedFractionCut) ||
             (pfoAssociation.GetNConsistentDirections() < m_minConsistentDirections))
         {
             continue;
         }
 
         if (pTrackPfoList)
         {
             if ((pTrackPfoList->end() != std::find(pTrackPfoList->begin(), pTrackPfoList->end(), pfoAssociation.GetVertexPfo())) &&
                 (pTrackPfoList->end() != std::find(pTrackPfoList->begin(), pTrackPfoList->end(), pfoAssociation.GetDaughterPfo())))
             {
                 continue;
             }
 
             if (((pTrackPfoList->end() != std::find(pTrackPfoList->begin(), pTrackPfoList->end(), pfoAssociation.GetVertexPfo())) ||
                 (pTrackPfoList->end() != std::find(pTrackPfoList->begin(), pTrackPfoList->end(), pfoAssociation.GetDaughterPfo()))) &&
                 (pfoAssociation.GetNConsistentDirections() < m_minConsistentDirectionsTrack))
             {
                 continue;
             }
         }
 
         this->MergePfos(pfoAssociation);
         return true;
     }
 
     return false;
 }

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

protectedvirtual

Reimplemented from lar_content::PfoMopUpBaseAlgorithm.

Definition at line 499 of file VertexBasedPfoMopUpAlgorithm.cc.

References m_coneAngleCentile, lar_content::MopUpBaseAlgorithm::m_daughterListNames, m_directionApexShift, m_directionTanAngle, m_maxBoundedFractionCut, m_maxConeCosHalfAngle, m_maxConeLengthMultiplier, m_maxVertexTransverseDistance, m_meanBoundedFractionCut, m_minBoundedFractionCut, m_minConsistentDirections, m_minConsistentDirectionsTrack, m_minVertexAssociatedHitTypes, m_minVertexLongitudinalDistance, m_showerPfoListName, m_trackPfoListName, and lar_content::PfoMopUpBaseAlgorithm::ReadSettings().

Referenced by lar_content::ShowerPfoMopUpAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "TrackPfoListName", m_trackPfoListName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "ShowerPfoListName", m_showerPfoListName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinVertexLongitudinalDistance", m_minVertexLongitudinalDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxVertexTransverseDistance", m_maxVertexTransverseDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinVertexAssociatedHitTypes", m_minVertexAssociatedHitTypes));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, 
         "ConeAngleCentile", m_coneAngleCentile));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, 
         "MaxConeCosHalfAngle", m_maxConeCosHalfAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, 
         "MaxConeLengthMultiplier", m_maxConeLengthMultiplier));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "DirectionTanAngle", m_directionTanAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "DirectionApexShift", m_directionApexShift));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MeanBoundedFractionCut", m_meanBoundedFractionCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxBoundedFractionCut", m_maxBoundedFractionCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinBoundedFractionCut", m_minBoundedFractionCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinConsistentDirections", m_minConsistentDirections));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinConsistentDirectionsTrack", m_minConsistentDirectionsTrack));
 
     m_daughterListNames.push_back(m_trackPfoListName);
     m_daughterListNames.push_back(m_showerPfoListName);
 
     return PfoMopUpBaseAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::VertexBasedPfoMopUpAlgorithm::Run ( )

protected

Definition at line 45 of file VertexBasedPfoMopUpAlgorithm.cc.

References lar_content::LArPointingCluster::GetInnerVertex(), GetInputPfos(), lar_content::LArPointingCluster::GetOuterVertex(), GetPfoAssociation(), GetPfoAssociations(), lar_content::LArPointingClusterHelper::IsNode(), IsVertexAssociated(), m_maxVertexTransverseDistance, m_minVertexLongitudinalDistance, and ProcessPfoAssociations().

 {
     const VertexList *pVertexList = nullptr;
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetCurrentList(*this, pVertexList));
 
     const Vertex *const pSelectedVertex((pVertexList && (pVertexList->size() == 1) && (VERTEX_3D == (*(pVertexList->begin()))->GetVertexType())) ? *(pVertexList->begin()) : nullptr);
 
     if (!pSelectedVertex)
     {
         if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             std::cout << "VertexBasedPfoMopUp: unable to find vertex in current list " << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     while (true)
     {
         PfoList vertexPfos, nonVertexPfos;
         this->GetInputPfos(pSelectedVertex, vertexPfos, nonVertexPfos);
 
         PfoAssociationList pfoAssociationList;
         this->GetPfoAssociations(pSelectedVertex, vertexPfos, nonVertexPfos, pfoAssociationList);
 
         std::sort(pfoAssociationList.begin(), pfoAssociationList.end());
         const bool pfoMergeMade(this->ProcessPfoAssociations(pfoAssociationList));
 
         if (!pfoMergeMade)
             break;
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

float lar_content::VertexBasedPfoMopUpAlgorithm::m_coneAngleCentile

protected

Cluster cone angle is defined using specified centile of distribution of hit half angles.

Definition at line 353 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetClusterAssociation(), and ReadSettings().

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

float lar_content::VertexBasedPfoMopUpAlgorithm::m_directionApexShift

protected

Direction determination, look for vertex inside triangle with apex shifted along the cluster length.

Definition at line 358 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetClusterAssociation(), and ReadSettings().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_directionTanAngle

protected

Direction determination, look for vertex inside triangle with apex shifted along the cluster length.

Definition at line 357 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetClusterAssociation(), and ReadSettings().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxBoundedFractionCut

protected

Cut on association info (max bounded fraction) for determining pfo merges.

Definition at line 361 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by ProcessPfoAssociations(), ReadSettings(), and lar_content::ShowerPfoMopUpAlgorithm::ShowerPfoMopUpAlgorithm().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxConeCosHalfAngle

protected

Maximum value for cosine of cone half angle.

Definition at line 354 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetClusterAssociation(), and ReadSettings().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxConeLengthMultiplier

protected

Consider hits as bound if inside cone, with projected distance less than N times cone length.

Definition at line 355 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetClusterAssociation(), and ReadSettings().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxVertexTransverseDistance

protected

Vertex association check: max transverse distance cut.

Definition at line 350 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by lar_content::ShowerPfoMopUpAlgorithm::IsVertexAssociated(), ReadSettings(), Run(), and lar_content::ShowerPfoMopUpAlgorithm::ShowerPfoMopUpAlgorithm().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_meanBoundedFractionCut

protected

Cut on association info (mean bounded fraction) for determining pfo merges.

Definition at line 360 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by ProcessPfoAssociations(), ReadSettings(), and lar_content::ShowerPfoMopUpAlgorithm::ShowerPfoMopUpAlgorithm().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_minBoundedFractionCut

protected

Cut on association info (min bounded fraction) for determining pfo merges.

Definition at line 362 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by ProcessPfoAssociations(), ReadSettings(), and lar_content::ShowerPfoMopUpAlgorithm::ShowerPfoMopUpAlgorithm().

unsigned int lar_content::VertexBasedPfoMopUpAlgorithm::m_minConsistentDirections

protected

The minimum number of consistent cluster directions to allow a pfo merge.

Definition at line 364 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by ProcessPfoAssociations(), ReadSettings(), and lar_content::ShowerPfoMopUpAlgorithm::ShowerPfoMopUpAlgorithm().

unsigned int lar_content::VertexBasedPfoMopUpAlgorithm::m_minConsistentDirectionsTrack

protected

The minimum number of consistent cluster directions to allow a merge involving a track pfo.

Definition at line 365 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by ProcessPfoAssociations(), ReadSettings(), and lar_content::ShowerPfoMopUpAlgorithm::ShowerPfoMopUpAlgorithm().

unsigned int lar_content::VertexBasedPfoMopUpAlgorithm::m_minVertexAssociatedHitTypes

protected

The min number of vertex associated hit types for a vertex associated pfo.

Definition at line 351 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetInputPfos(), and ReadSettings().

float lar_content::VertexBasedPfoMopUpAlgorithm::m_minVertexLongitudinalDistance

protected

Vertex association check: min longitudinal distance cut.

Definition at line 349 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by lar_content::ShowerPfoMopUpAlgorithm::IsVertexAssociated(), ReadSettings(), and Run().

std::string lar_content::VertexBasedPfoMopUpAlgorithm::m_showerPfoListName

protected

The input shower pfo list name.

Definition at line 347 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetInputPfos(), MergePfos(), and ReadSettings().

std::string lar_content::VertexBasedPfoMopUpAlgorithm::m_trackPfoListName

protected

The input track pfo list name.

Definition at line 346 of file VertexBasedPfoMopUpAlgorithm.h.

Referenced by GetInputPfos(), MergePfos(), ProcessPfoAssociations(), and ReadSettings().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArPfoMopUp/VertexBasedPfoMopUpAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArPfoMopUp/VertexBasedPfoMopUpAlgorithm.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation