ClusterContact class, describing the interactions and proximity between parent and daughter candidate clusters. More...

#include <FragmentRemovalHelper.h>

Inheritance diagram for april_content::ClusterContact:

Classes
class	Parameters
	Parameters class. More...

Public Member Functions
	ClusterContact (const pandora::Pandora &pandora, const pandora::Cluster const pDaughterCluster, const pandora::Cluster const pParentCluster, const Parameters &parameters)
	Constructor. More...

const pandora::Cluster *	GetDaughterCluster () const
	Get the address of the daughter candidate cluster. More...

const pandora::Cluster *	GetParentCluster () const
	Get the address of the parent candidate cluster. More...

unsigned int	GetNContactLayers () const
	Get the number of contact layers for parent and daughter clusters two clusters. More...

float	GetContactFraction () const
	Get the ratio of the number of contact layers to the number of overlap layers. More...

float	GetDistanceToClosestHit () const
	Distance between closest hits in parent and daughter clusters, units mm. More...

float	GetCloseHitFraction1 () const
	Get the fraction of daughter hits that lie within sepcified distance 1 of parent cluster. More...

float	GetCloseHitFraction2 () const
	Get the fraction of daughter hits that lie within sepcified distance 2 of parent cluster. More...

float	GetConeFraction1 () const
	Get the fraction of daughter hits that lie within specified cone 1 along parent direction. More...

Protected Member Functions
void	HitDistanceComparison (const pandora::Cluster const pDaughterCluster, const pandora::Cluster const pParentCluster, const Parameters &parameters)
	Compare hits in daughter cluster with those in parent cluster to calculate minimum hit separation and close hit fractions. Calculate these properties in a single loop, for efficiency. More...

Protected Attributes
const pandora::Cluster *	m_pDaughterCluster
	Address of the daughter candidate cluster.

const pandora::Cluster *	m_pParentCluster
	Address of the parent candidate cluster.

unsigned int	m_nContactLayers
	The number of contact layers for parent and daughter clusters.

float	m_contactFraction
	The ratio of the number of contact layers to the number of overlap layers.

float	m_coneFraction1
	Fraction of daughter hits that lie within specified cone 1 along parent direction.

float	m_closeHitFraction1
	Fraction of daughter hits that lie within sepcified distance 1 of parent cluster.

float	m_closeHitFraction2
	Fraction of daughter hits that lie within sepcified distance 2 of parent cluster.

float	m_distanceToClosestHit
	Distance between closest hits in parent and daughter clusters, units mm.

Detailed Description

ClusterContact class, describing the interactions and proximity between parent and daughter candidate clusters.

Constructor & Destructor Documentation

april_content::ClusterContact::ClusterContact	(	const pandora::Pandora &	pandora,
		const pandora::Cluster *const	pDaughterCluster,
		const pandora::Cluster *const	pParentCluster,
		const Parameters &	parameters
	)

Constructor.

Parameters

pandora	the associated pandora instance
pDaughterCluster	address of the daughter candidate cluster
pParentCluster	address of the parent candidate cluster
parameters	the cluster contact parameters

Member Function Documentation

float april_content::ClusterContact::GetCloseHitFraction1 ( ) const

inline

Get the fraction of daughter hits that lie within sepcified distance 1 of parent cluster.

Returns: The daughter close hit fraction

float april_content::ClusterContact::GetCloseHitFraction2 ( ) const

inline

Get the fraction of daughter hits that lie within sepcified distance 2 of parent cluster.

Returns: The daughter close hit fraction

float april_content::ClusterContact::GetConeFraction1 ( ) const

inline

Get the fraction of daughter hits that lie within specified cone 1 along parent direction.

Returns: The daughter cone fraction

float april_content::ClusterContact::GetContactFraction ( ) const

inline

Get the ratio of the number of contact layers to the number of overlap layers.

Returns: The ratio of contact layers to overlap layers

const pandora::Cluster * april_content::ClusterContact::GetDaughterCluster ( ) const

inline

Get the address of the daughter candidate cluster.

Returns: The address of the daughter candidate cluster

float april_content::ClusterContact::GetDistanceToClosestHit ( ) const

inline

Distance between closest hits in parent and daughter clusters, units mm.

Returns: The distance between closest hits

unsigned int april_content::ClusterContact::GetNContactLayers ( ) const

inline

Get the number of contact layers for parent and daughter clusters two clusters.

Returns: The number of contact layers

const pandora::Cluster * april_content::ClusterContact::GetParentCluster ( ) const

inline

Get the address of the parent candidate cluster.

Returns: The address of the parent candidate cluster

void april_content::ClusterContact::HitDistanceComparison	(	const pandora::Cluster *const	pDaughterCluster,
		const pandora::Cluster *const	pParentCluster,
		const Parameters &	parameters
	)

protected

Compare hits in daughter cluster with those in parent cluster to calculate minimum hit separation and close hit fractions. Calculate these properties in a single loop, for efficiency.

Parameters

pDaughterCluster	address of the daughter candidate cluster
pParentCluster	address of the parent candidate cluster
parameters	the cluster contact parameters

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

APRILContent/include/APRILHelpers/FragmentRemovalHelper.h
APRILContent/src/APRILHelpers/FragmentRemovalHelper.cc

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation