pandora::BoxGap Class Reference

BoxGap class, associated with all 3D hit types. More...

#include "DetectorGap.h"

Inheritance diagram for pandora::BoxGap:

Collaboration diagram for pandora::BoxGap:

Public Member Functions
bool	IsInGap (const CartesianVector &positionVector, const HitType hitType, const float gapTolerance) const
	Whether a specified position lies within the gap.
const CartesianVector &	GetVertex () const
	Get the gap vertex.
const CartesianVector &	GetSide1 () const
	Get the vector describing first side meeting vertex.
const CartesianVector &	GetSide2 () const
	Get the vector describing second side meeting vertex.
const CartesianVector &	GetSide3 () const
	Get the vector describing third side meeting vertex.

Private Member Functions
	BoxGap (const object_creation::Geometry::BoxGap::Parameters &parameters)
	Constructor.

Private Attributes
const CartesianVector	m_vertex
	Cartesian coordinates of a gap vertex, units mm.
const CartesianVector	m_side1
	Cartesian vector describing first side meeting vertex, units mm.
const CartesianVector	m_side2
	Cartesian vector describing second side meeting vertex, units mm.
const CartesianVector	m_side3
	Cartesian vector describing third side meeting vertex, units mm.

Friends
class	PandoraObjectFactory< object_creation::Geometry::BoxGap::Parameters, object_creation::Geometry::BoxGap::Object >

Detailed Description

BoxGap class, associated with all 3D hit types.

Definition at line 111 of file DetectorGap.h.

Constructor & Destructor Documentation

BoxGap()

pandora::BoxGap::BoxGap ( const object_creation::Geometry::BoxGap::Parameters &  parameters )

private

Constructor.

Parameters

parameters

the gap parameters

Definition at line 58 of file DetectorGap.cc.

Member Function Documentation

GetSide1()

const CartesianVector & pandora::BoxGap::GetSide1 ( ) const

inline

Get the vector describing first side meeting vertex.

Parameters

the	vector describing first side meeting vertex

Definition at line 318 of file DetectorGap.h.

Here is the caller graph for this function:

GetSide2()

const CartesianVector & pandora::BoxGap::GetSide2 ( ) const

inline

Get the vector describing second side meeting vertex.

Parameters

the	vector describing second side meeting vertex

Definition at line 325 of file DetectorGap.h.

Here is the caller graph for this function:

GetSide3()

const CartesianVector & pandora::BoxGap::GetSide3 ( ) const

inline

Get the vector describing third side meeting vertex.

Parameters

the	vector describing third side meeting vertex

Definition at line 332 of file DetectorGap.h.

Here is the caller graph for this function:

GetVertex()

const CartesianVector & pandora::BoxGap::GetVertex ( ) const

inline

Get the gap vertex.

Parameters

the	gap vertex

Definition at line 311 of file DetectorGap.h.

Here is the caller graph for this function:

IsInGap()

bool pandora::BoxGap::IsInGap ( const CartesianVector &  positionVector, const HitType  hitType, const float  gapTolerance  ) const

virtual

Whether a specified position lies within the gap.

Parameters

positionVector	the position vector
hitType	the hit type, providing context to aid interpretation of provided position vector
gapTolerance	tolerance allowed when declaring a point to be "in" a gap region, units mm

Returns

boolean

Implements pandora::DetectorGap.

Definition at line 68 of file DetectorGap.cc.

Here is the call graph for this function:

Friends And Related Symbol Documentation

PandoraObjectFactory< object_creation::Geometry::BoxGap::Parameters, object_creation::Geometry::BoxGap::Object >

friend class PandoraObjectFactory< object_creation::Geometry::BoxGap::Parameters, object_creation::Geometry::BoxGap::Object >

friend

Definition at line 155 of file DetectorGap.h.

Member Data Documentation

m_side1

const CartesianVector pandora::BoxGap::m_side1

private

Cartesian vector describing first side meeting vertex, units mm.

Definition at line 153 of file DetectorGap.h.

m_side2

const CartesianVector pandora::BoxGap::m_side2

private

Cartesian vector describing second side meeting vertex, units mm.

Definition at line 154 of file DetectorGap.h.

m_side3

const CartesianVector pandora::BoxGap::m_side3

private

Cartesian vector describing third side meeting vertex, units mm.

Definition at line 155 of file DetectorGap.h.

m_vertex

const CartesianVector pandora::BoxGap::m_vertex

private

Cartesian coordinates of a gap vertex, units mm.

Definition at line 152 of file DetectorGap.h.

---

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

• PandoraSDK/include/Geometry/DetectorGap.h
• PandoraSDK/src/Geometry/DetectorGap.cc