pandora::LineGap Class Reference

LineGap class, associated only with 2D TPC hit types and applied only to the z coordinate when sampling position vectors. More...

#include "DetectorGap.h"

Inheritance diagram for pandora::LineGap:

Collaboration diagram for pandora::LineGap:

Public Member Functions
bool	IsInGap (const CartesianVector &positionVector, const HitType hitType, const float gapTolerance) const
	Whether a specified position lies within the gap.
LineGapType	GetLineGapType () const
	Get the line gap type.
float	GetLineStartX () const
	Get the line start x coordinate.
float	GetLineEndX () const
	Get the line end x coordinate.
float	GetLineStartZ () const
	Get the line start z coordinate.
float	GetLineEndZ () const
	Get the line end z coordinate.

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

Private Attributes
const LineGapType	m_lineGapType
	The type of line gap, e.g. TPC wire-type gap (u, v, w), or drift-type gap.
const float	m_lineStartX
	The line x start coordinate, units mm.
const float	m_lineEndX
	The line x end coordinate, units mm.
const float	m_lineStartZ
	The line z start coordinate, units mm.
const float	m_lineEndZ
	The line z end coordinate, units mm.

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

Detailed Description

LineGap class, associated only with 2D TPC hit types and applied only to the z coordinate when sampling position vectors.

Definition at line 49 of file DetectorGap.h.

Constructor & Destructor Documentation

LineGap()

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

private

Constructor.

Parameters

parameters

the gap parameters

Definition at line 21 of file DetectorGap.cc.

Member Function Documentation

GetLineEndX()

float pandora::LineGap::GetLineEndX ( ) const

inline

Get the line end x coordinate.

Parameters

the	line end x coordinate

Definition at line 289 of file DetectorGap.h.

Here is the caller graph for this function:

GetLineEndZ()

float pandora::LineGap::GetLineEndZ ( ) const

inline

Get the line end z coordinate.

Parameters

the	line end z coordinate

Definition at line 303 of file DetectorGap.h.

Here is the caller graph for this function:

GetLineGapType()

LineGapType pandora::LineGap::GetLineGapType ( ) const

inline

Get the line gap type.

Parameters

the	line gap type

Definition at line 275 of file DetectorGap.h.

Here is the caller graph for this function:

GetLineStartX()

float pandora::LineGap::GetLineStartX ( ) const

inline

Get the line start x coordinate.

Parameters

the	line start x coordinate

Definition at line 282 of file DetectorGap.h.

Here is the caller graph for this function:

GetLineStartZ()

float pandora::LineGap::GetLineStartZ ( ) const

inline

Get the line start z coordinate.

Parameters

the	line start z coordinate

Definition at line 296 of file DetectorGap.h.

Here is the caller graph for this function:

IsInGap()

bool pandora::LineGap::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 34 of file DetectorGap.cc.

Here is the call graph for this function:

Friends And Related Symbol Documentation

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

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

friend

Definition at line 101 of file DetectorGap.h.

Member Data Documentation

m_lineEndX

const float pandora::LineGap::m_lineEndX

private

The line x end coordinate, units mm.

Definition at line 99 of file DetectorGap.h.

m_lineEndZ

const float pandora::LineGap::m_lineEndZ

private

The line z end coordinate, units mm.

Definition at line 101 of file DetectorGap.h.

m_lineGapType

const LineGapType pandora::LineGap::m_lineGapType

private

The type of line gap, e.g. TPC wire-type gap (u, v, w), or drift-type gap.

Definition at line 97 of file DetectorGap.h.

m_lineStartX

const float pandora::LineGap::m_lineStartX

private

The line x start coordinate, units mm.

Definition at line 98 of file DetectorGap.h.

m_lineStartZ

const float pandora::LineGap::m_lineStartZ

private

The line z start coordinate, units mm.

Definition at line 100 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