lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation Class Reference

ClusterAssociation class. More...

#include <VertexBasedPfoMopUpAlgorithm.h>

Public Member Functions
	ClusterAssociation ()
	Default constructor. More...
	ClusterAssociation (const pandora::Cluster *const pVertexCluster, const pandora::Cluster *const pDaughterCluster, const float boundedFraction, const bool isConsistentDirection)
	Constructor. More...
const pandora::Cluster *	GetVertexCluster () const
	Get the address of the vertex cluster. More...
const pandora::Cluster *	GetDaughterCluster () const
	Get the address of the daughter cluster. More...
float	GetBoundedFraction () const
	Get the fraction of daughter hits bounded by the cone defined by the vertex cluster. More...
bool	IsConsistentDirection () const
	Whether the vertex and daughter clusters have consistent directions. More...

Private Attributes
const pandora::Cluster *	m_pVertexCluster
	The address of the vertex cluster. More...
const pandora::Cluster *	m_pDaughterCluster
	The address of the daughter cluster. More...
float	m_boundedFraction
	The fraction of daughter hits bounded by the cone defined by the vertex cluster. More...
bool	m_isConsistentDirection
	Whether the vertex and daughter clusters have consistent directions. More...

Detailed Description

ClusterAssociation class.

Definition at line 33 of file VertexBasedPfoMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::ClusterAssociation

(

)

Default constructor.

Definition at line 298 of file VertexBasedPfoMopUpAlgorithm.cc.

                                                                   :
    m_pVertexCluster(nullptr),
    m_pDaughterCluster(nullptr),
    m_boundedFraction(0.f),
    m_isConsistentDirection(false)
{
}

lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::ClusterAssociation	(	const pandora::Cluster *const	pVertexCluster,
		const pandora::Cluster *const	pDaughterCluster,
		const float	boundedFraction,
		const bool	isConsistentDirection
	)

Constructor.

Parameters

pVertexCluster	the address of the vertex cluster
pDaughterCluster	the address of the daughter cluster
boundedFraction	the fraction of daughter hits bounded by the cone defined by the vertex cluster
isConsistentDirection	whether clusters have consistent directions

Member Function Documentation

float lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::GetBoundedFraction ( ) const

inline

Get the fraction of daughter hits bounded by the cone defined by the vertex cluster.

Returns

the bounded fraction

Definition at line 385 of file VertexBasedPfoMopUpAlgorithm.h.

{
    return m_boundedFraction;
}

const pandora::Cluster * lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::GetDaughterCluster ( ) const

inline

Get the address of the daughter cluster.

Returns

the address of the daughter cluster

Definition at line 378 of file VertexBasedPfoMopUpAlgorithm.h.

{
    return m_pDaughterCluster;
}

const pandora::Cluster * lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::GetVertexCluster ( ) const

inline

Get the address of the vertex cluster.

Returns

the address of the vertex cluster

Definition at line 371 of file VertexBasedPfoMopUpAlgorithm.h.

{
    return m_pVertexCluster;
}

bool lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::IsConsistentDirection ( ) const

inline

Whether the vertex and daughter clusters have consistent directions.

Returns

boolean

Definition at line 392 of file VertexBasedPfoMopUpAlgorithm.h.

{
    return m_isConsistentDirection;
}

Member Data Documentation

float lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::m_boundedFraction

private

The fraction of daughter hits bounded by the cone defined by the vertex cluster.

Definition at line 83 of file VertexBasedPfoMopUpAlgorithm.h.

bool lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::m_isConsistentDirection

private

Whether the vertex and daughter clusters have consistent directions.

Definition at line 84 of file VertexBasedPfoMopUpAlgorithm.h.

const pandora::Cluster* lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::m_pDaughterCluster

private

The address of the daughter cluster.

Definition at line 82 of file VertexBasedPfoMopUpAlgorithm.h.

const pandora::Cluster* lar_content::VertexBasedPfoMopUpAlgorithm::ClusterAssociation::m_pVertexCluster

private

The address of the vertex cluster.

Definition at line 81 of file VertexBasedPfoMopUpAlgorithm.h.

---

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

• larpandoracontent/larpandoracontent/LArThreeDReco/LArPfoMopUp/VertexBasedPfoMopUpAlgorithm.h
• larpandoracontent/larpandoracontent/LArThreeDReco/LArPfoMopUp/VertexBasedPfoMopUpAlgorithm.cc