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

#include "DetectorGap.h"

Inheritance diagram for pandora::ConcentricGap:

Collaboration diagram for pandora::ConcentricGap:

Public Member Functions
bool	IsInGap (const CartesianVector &positionVector, const HitType hitType, const float gapTolerance) const
	Whether a specified position lies within the gap.

float	GetMinZCoordinate () const
	Get the min cylindrical polar z coordinate, origin interaction point.

float	GetMaxZCoordinate () const
	Get the max cylindrical polar z coordinate, origin interaction point.

float	GetInnerRCoordinate () const
	Get the inner cylindrical polar r coordinate, origin interaction point.

float	GetInnerPhiCoordinate () const
	Get the inner cylindrical polar phi coordinate.

unsigned int	GetInnerSymmetryOrder () const
	Get the order of symmetry of the innermost edge of gap.

float	GetOuterRCoordinate () const
	Get the outer cylindrical polar r coordinate, origin interaction point.

float	GetOuterPhiCoordinate () const
	Get the outer cylindrical polar phi coordinate.

unsigned int	GetOuterSymmetryOrder () const
	Get the order of symmetry of the outermost edge of gap.

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

void	GetPolygonVertices (const float rCoordinate, const float zCoordinate, const float phiCoordinate, const unsigned int symmetryOrder, VertexPointList &vertexPointList) const
	Populate list of polygon vertices, assuming regular polygon in XY plane at constant z coordinate.

bool	IsIn2DPolygon (const CartesianVector &point, const VertexPointList &vertexPointList, const unsigned int symmetryOrder) const
	Winding number test for a point in a 2D polygon in the XY plane (z coordinates are ignored)

Private Attributes
const float	m_minZCoordinate
	Min cylindrical polar z coordinate, origin interaction point, units mm.

const float	m_maxZCoordinate
	Max cylindrical polar z coordinate, origin interaction point, units mm.

const float	m_innerRCoordinate
	Inner cylindrical polar r coordinate, origin interaction point, units mm.

const float	m_innerPhiCoordinate
	Inner cylindrical polar phi coordinate (angle wrt cartesian x axis)

const unsigned int	m_innerSymmetryOrder
	Order of symmetry of the innermost edge of gap.

const float	m_outerRCoordinate
	Outer cylindrical polar r coordinate, origin interaction point, units mm.

const float	m_outerPhiCoordinate
	Outer cylindrical polar phi coordinate (angle wrt cartesian x axis)

const unsigned int	m_outerSymmetryOrder
	Order of symmetry of the outermost edge of gap.

VertexPointList	m_innerVertexPointList
	The vertex points of the inner polygon.

VertexPointList	m_outerVertexPointList
	The vertex points of the outer polygon.

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

Detailed Description

ConcentricGap class, associated with all 3D hit types.

Definition at line 165 of file DetectorGap.h.

Constructor & Destructor Documentation

◆ ConcentricGap()

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

private

Constructor.

Parameters

parameters the gap parameters

Definition at line 96 of file DetectorGap.cc.

Here is the call graph for this function:

Member Function Documentation

◆ GetInnerPhiCoordinate()

float pandora::ConcentricGap::GetInnerPhiCoordinate ( ) const

inline

Get the inner cylindrical polar phi coordinate.

Parameters

the	inner cylindrical polar phi coordinate

Definition at line 361 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetInnerRCoordinate()

float pandora::ConcentricGap::GetInnerRCoordinate ( ) const

inline

Get the inner cylindrical polar r coordinate, origin interaction point.

Parameters

the	inner cylindrical polar r coordinate

Definition at line 354 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetInnerSymmetryOrder()

unsigned int pandora::ConcentricGap::GetInnerSymmetryOrder ( ) const

inline

Get the order of symmetry of the innermost edge of gap.

Parameters

the	order of symmetry of the innermost edge of gap

Definition at line 368 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetMaxZCoordinate()

float pandora::ConcentricGap::GetMaxZCoordinate ( ) const

inline

Get the max cylindrical polar z coordinate, origin interaction point.

Parameters

the	max cylindrical polar z coordinate

Definition at line 347 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetMinZCoordinate()

float pandora::ConcentricGap::GetMinZCoordinate ( ) const

inline

Get the min cylindrical polar z coordinate, origin interaction point.

Parameters

the	min cylindrical polar z coordinate

Definition at line 340 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetOuterPhiCoordinate()

float pandora::ConcentricGap::GetOuterPhiCoordinate ( ) const

inline

Get the outer cylindrical polar phi coordinate.

Parameters

the	outer cylindrical polar phi coordinate

Definition at line 382 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetOuterRCoordinate()

float pandora::ConcentricGap::GetOuterRCoordinate ( ) const

inline

Get the outer cylindrical polar r coordinate, origin interaction point.

Parameters

the	outer cylindrical polar r coordinate

Definition at line 375 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetOuterSymmetryOrder()

unsigned int pandora::ConcentricGap::GetOuterSymmetryOrder ( ) const

inline

Get the order of symmetry of the outermost edge of gap.

Parameters

the	order of symmetry of the outermost edge of gap

Definition at line 389 of file DetectorGap.h.

Here is the caller graph for this function:

◆ GetPolygonVertices()

void pandora::ConcentricGap::GetPolygonVertices	(	const float	rCoordinate,
		const float	zCoordinate,
		const float	phiCoordinate,
		const unsigned int	symmetryOrder,
		VertexPointList &	vertexPointList
	)		const

private

Populate list of polygon vertices, assuming regular polygon in XY plane at constant z coordinate.

rCoordinate polygon r coordinate

zCoordinate polygon z coordinate

phiCoordinate polygon phi coordinate

symmetryOrder polygon symmetry order

Parameters

vertexPointList to receive the vertex point list, with vertexPointList[symmetryOrder] = vertexPointList[0]

Definition at line 149 of file DetectorGap.cc.

Here is the caller graph for this function:

◆ IsIn2DPolygon()

bool pandora::ConcentricGap::IsIn2DPolygon	(	const CartesianVector &	point,
		const VertexPointList &	vertexPointList,
		const unsigned int	symmetryOrder
	)		const

private

Winding number test for a point in a 2D polygon in the XY plane (z coordinates are ignored)

Parameters

point	the test point
vertexPointList	vertex points of a polygon, with vertexPointList[symmetryOrder] = vertexPointList[0]
symmetryOrder	order of symmetry of polygon

Returns: whether point is inside polygon

Definition at line 170 of file DetectorGap.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsInGap()

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

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ PandoraObjectFactory< object_creation::Geometry::ConcentricGap::Parameters, object_creation::Geometry::ConcentricGap::Object >

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

friend

Definition at line 267 of file DetectorGap.h.

Member Data Documentation

◆ m_innerPhiCoordinate

const float pandora::ConcentricGap::m_innerPhiCoordinate

private

Inner cylindrical polar phi coordinate (angle wrt cartesian x axis)

Definition at line 260 of file DetectorGap.h.

◆ m_innerRCoordinate

const float pandora::ConcentricGap::m_innerRCoordinate

private

Inner cylindrical polar r coordinate, origin interaction point, units mm.

Definition at line 259 of file DetectorGap.h.

◆ m_innerSymmetryOrder

const unsigned int pandora::ConcentricGap::m_innerSymmetryOrder

private

Order of symmetry of the innermost edge of gap.

Definition at line 261 of file DetectorGap.h.

◆ m_innerVertexPointList

VertexPointList pandora::ConcentricGap::m_innerVertexPointList

private

The vertex points of the inner polygon.

Definition at line 266 of file DetectorGap.h.

◆ m_maxZCoordinate

const float pandora::ConcentricGap::m_maxZCoordinate

private

Max cylindrical polar z coordinate, origin interaction point, units mm.

Definition at line 258 of file DetectorGap.h.

◆ m_minZCoordinate

const float pandora::ConcentricGap::m_minZCoordinate

private

Min cylindrical polar z coordinate, origin interaction point, units mm.

Definition at line 257 of file DetectorGap.h.

◆ m_outerPhiCoordinate

const float pandora::ConcentricGap::m_outerPhiCoordinate

private

Outer cylindrical polar phi coordinate (angle wrt cartesian x axis)

Definition at line 263 of file DetectorGap.h.

◆ m_outerRCoordinate

const float pandora::ConcentricGap::m_outerRCoordinate

private

Outer cylindrical polar r coordinate, origin interaction point, units mm.

Definition at line 262 of file DetectorGap.h.

◆ m_outerSymmetryOrder

const unsigned int pandora::ConcentricGap::m_outerSymmetryOrder

private

Order of symmetry of the outermost edge of gap.

Definition at line 264 of file DetectorGap.h.

◆ m_outerVertexPointList

VertexPointList pandora::ConcentricGap::m_outerVertexPointList

private

The vertex points of the outer polygon.

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ConcentricGap()

Member Function Documentation

◆ GetInnerPhiCoordinate()

◆ GetInnerRCoordinate()

◆ GetInnerSymmetryOrder()

◆ GetMaxZCoordinate()

◆ GetMinZCoordinate()

◆ GetOuterPhiCoordinate()

◆ GetOuterRCoordinate()

◆ GetOuterSymmetryOrder()

◆ GetPolygonVertices()

◆ IsIn2DPolygon()

◆ IsInGap()

Friends And Related Symbol Documentation

◆ PandoraObjectFactory< object_creation::Geometry::ConcentricGap::Parameters, object_creation::Geometry::ConcentricGap::Object >

Member Data Documentation

◆ m_innerPhiCoordinate

◆ m_innerRCoordinate

◆ m_innerSymmetryOrder

◆ m_innerVertexPointList

◆ m_maxZCoordinate

◆ m_minZCoordinate

◆ m_outerPhiCoordinate

◆ m_outerRCoordinate

◆ m_outerSymmetryOrder

◆ m_outerVertexPointList