lar_content::SimpleCone Class Reference

SimpleCone class. More...

#include "LArThreeDSlidingConeFitResult.h"

Public Member Functions
	SimpleCone (const pandora::CartesianVector &coneApex, const pandora::CartesianVector &coneDirection, const float coneLength, const float coneTanHalfAngle)
	Constructor. More...
const pandora::CartesianVector &	GetConeApex () const
	Get the cone apex. More...
const pandora::CartesianVector &	GetConeDirection () const
	Get the cone direction. More...
float	GetConeLength () const
	Get the cone length. More...
float	GetConeTanHalfAngle () const
	Get the tangent of the cone half-angle. More...
float	GetMeanRT (const pandora::Cluster *const pCluster) const
	Get the mean transverse distance to all hits in a cluster (whether contained or not) More...
float	GetBoundedHitFraction (const pandora::Cluster *const pCluster) const
	Get the fraction of hits in a provided cluster that are bounded within the cone, using fitted cone angle and length. More...
float	GetBoundedHitFraction (const pandora::Cluster *const pCluster, const float coneLength, const float coneTanHalfAngle) const
	Get the fraction of hits in a provided cluster that are bounded within the cone, using provided cone angle and length. More...

Private Attributes
pandora::CartesianVector	m_coneApex
	The cone apex. More...
pandora::CartesianVector	m_coneDirection
	The cone direction. More...
float	m_coneLength
	The cone length. More...
float	m_coneTanHalfAngle
	The tangent of the cone half-angle. More...

Detailed Description

SimpleCone class.

Definition at line 36 of file LArThreeDSlidingConeFitResult.h.

Constructor & Destructor Documentation

lar_content::SimpleCone::SimpleCone ( const pandora::CartesianVector &  coneApex, const pandora::CartesianVector &  coneDirection, const float  coneLength, const float  coneTanHalfAngle  )

inline

Constructor.

Parameters

coneApex
coneDirection
coneLength
coneTanHalfAngle

Definition at line 174 of file LArThreeDSlidingConeFitResult.h.

                                                          :
    m_coneApex(coneApex),
    m_coneDirection(coneDirection),
    m_coneLength(coneLength),
    m_coneTanHalfAngle(coneTanHalfAngle)
{
}

Member Function Documentation

float lar_content::SimpleCone::GetBoundedHitFraction ( const pandora::Cluster *const  pCluster ) const

inline

Get the fraction of hits in a provided cluster that are bounded within the cone, using fitted cone angle and length.

Parameters

pCluster

the address of the cluster

Returns

the bounded hit fraction

Definition at line 213 of file LArThreeDSlidingConeFitResult.h.

References GetConeLength(), and GetConeTanHalfAngle().

{
    return this->GetBoundedHitFraction(pCluster, this->GetConeLength(), this->GetConeTanHalfAngle());
}

float lar_content::SimpleCone::GetBoundedHitFraction	(	const pandora::Cluster *const	pCluster,
		const float	coneLength,
		const float	coneTanHalfAngle
	)		const

Get the fraction of hits in a provided cluster that are bounded within the cone, using provided cone angle and length.

Parameters

pCluster	the address of the cluster
coneLength	the provided cone length
coneTanHalfAngle	the provided tangent of the cone half-angle

Returns

the bounded hit fraction

const pandora::CartesianVector & lar_content::SimpleCone::GetConeApex ( ) const

inline

Get the cone apex.

Returns

the cone apex

Definition at line 185 of file LArThreeDSlidingConeFitResult.h.

References m_coneApex.

{
    return m_coneApex;
}

const pandora::CartesianVector & lar_content::SimpleCone::GetConeDirection ( ) const

inline

Get the cone direction.

Returns

the cone direction

Definition at line 192 of file LArThreeDSlidingConeFitResult.h.

References m_coneDirection.

{
    return m_coneDirection;
}

float lar_content::SimpleCone::GetConeLength ( ) const

inline

Get the cone length.

Returns

the cone length

Definition at line 199 of file LArThreeDSlidingConeFitResult.h.

References m_coneLength.

Referenced by GetBoundedHitFraction().

{
    return m_coneLength;
}

float lar_content::SimpleCone::GetConeTanHalfAngle ( ) const

inline

Get the tangent of the cone half-angle.

Returns

the tangent of the cone half-angle

Definition at line 206 of file LArThreeDSlidingConeFitResult.h.

References m_coneTanHalfAngle.

Referenced by GetBoundedHitFraction().

{
    return m_coneTanHalfAngle;
}

float lar_content::SimpleCone::GetMeanRT

(

const pandora::Cluster *const

pCluster

)

const

Get the mean transverse distance to all hits in a cluster (whether contained or not)

Parameters

pCluster

the address of the cluster

Returns

the mean transverse distance to all hits (whether contained or not)

Definition at line 22 of file LArThreeDSlidingConeFitResult.cc.

References f.

{
    CartesianPointVector hitPositionVector;
    LArClusterHelper::GetCoordinateVector(pCluster, hitPositionVector);

    float rTSum(0.f);
    const unsigned int nClusterHits(pCluster->GetNCaloHits());

    for (const CartesianVector &hitPosition : hitPositionVector)
    {
        const CartesianVector displacement(hitPosition - this->GetConeApex());
        const float rT(displacement.GetCrossProduct(this->GetConeDirection()).GetMagnitude());
        rTSum += rT;
    }

    return ((nClusterHits > 0) ? rTSum / static_cast<float>(nClusterHits) : 0.f);
}

Member Data Documentation

pandora::CartesianVector lar_content::SimpleCone::m_coneApex

private

The cone apex.

Definition at line 107 of file LArThreeDSlidingConeFitResult.h.

Referenced by GetConeApex().

pandora::CartesianVector lar_content::SimpleCone::m_coneDirection

private

The cone direction.

Definition at line 108 of file LArThreeDSlidingConeFitResult.h.

Referenced by GetConeDirection().

float lar_content::SimpleCone::m_coneLength

private

The cone length.

Definition at line 109 of file LArThreeDSlidingConeFitResult.h.

Referenced by GetConeLength().

float lar_content::SimpleCone::m_coneTanHalfAngle

private

The tangent of the cone half-angle.

Definition at line 110 of file LArThreeDSlidingConeFitResult.h.

Referenced by GetConeTanHalfAngle().

---

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

• larpandoracontent/v04_10_00/source/larpandoracontent/LArObjects/LArThreeDSlidingConeFitResult.h
• larpandoracontent/v04_10_00/source/larpandoracontent/LArObjects/LArThreeDSlidingConeFitResult.cc