Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
pandora::SubDetector Class Reference

SubDetector class. More...

#include "SubDetector.h"

Classes

class  SubDetectorLayer
 SubDetectorLayer class. More...
 

Public Types

typedef std::vector< SubDetectorLayer > SubDetectorLayerVector
 

Public Member Functions

const std::string & GetSubDetectorName () const
 Get the sub detector name, uniquely specifying the sub detector.
 
SubDetectorType GetSubDetectorType () const
 Get the sub detector type, e.g. ECAL_BARREL, HCAL_ENDCAP, TPC, etc.
 
float GetInnerRCoordinate () const
 Get the inner cylindrical polar r coordinate, origin interaction point, units mm.
 
float GetInnerZCoordinate () const
 Get the inner cylindrical polar z coordinate, origin interaction point, units mm.
 
float GetInnerPhiCoordinate () const
 Get the inner cylindrical polar phi coordinate (angle wrt cartesian x axis)
 
unsigned int GetInnerSymmetryOrder () const
 Get the order of symmetry of the innermost edge of subdetector.
 
float GetOuterRCoordinate () const
 Get the outer cylindrical polar r coordinate, origin interaction point, units mm.
 
float GetOuterZCoordinate () const
 Get the outer cylindrical polar z coordinate, origin interaction point, units mm.
 
float GetOuterPhiCoordinate () const
 Get the outer cylindrical polar phi coordinate (angle wrt cartesian x axis)
 
unsigned int GetOuterSymmetryOrder () const
 Get the order of symmetry of the outermost edge of sub detector.
 
bool IsMirroredInZ () const
 Whether a second sub detector exists, equivalent to a reflection in z=0 plane.
 
unsigned int GetNLayers () const
 Get the number of layers in the sub detector.
 
const SubDetectorLayerVector & GetSubDetectorLayerVector () const
 Get the vector of layer parameters for the sub detector.
 

Protected Member Functions

 SubDetector (const object_creation::Geometry::SubDetector::Parameters &inputParameters)
 Constructor.
 
virtual ~SubDetector ()
 Destructor.
 

Protected Attributes

std::string m_subDetectorName
 The sub detector name, must uniquely specify a single sub detector.
 
SubDetectorType m_subDetectorType
 The sub detector type, e.g. ECAL_BARREL, HCAL_ENDCAP, TPC, etc.
 
float m_innerRCoordinate
 Inner cylindrical polar r coordinate, origin interaction point, units mm.
 
float m_innerZCoordinate
 Inner cylindrical polar z coordinate, origin interaction point, units mm.
 
float m_innerPhiCoordinate
 Inner cylindrical polar phi coordinate (angle wrt cartesian x axis)
 
unsigned int m_innerSymmetryOrder
 Order of symmetry of the innermost edge of sub detector.
 
float m_outerRCoordinate
 Outer cylindrical polar r coordinate, origin interaction point, units mm.
 
float m_outerZCoordinate
 Outer cylindrical polar z coordinate, origin interaction point, units mm.
 
float m_outerPhiCoordinate
 Outer cylindrical polar phi coordinate (angle wrt cartesian x axis)
 
unsigned int m_outerSymmetryOrder
 Order of symmetry of the outermost edge of sub detector.
 
bool m_isMirroredInZ
 Whether a second sub detector exists, equivalent to a reflection in z=0 plane.
 
unsigned int m_nLayers
 The number of layers in the sub detector section.
 
SubDetectorLayerVector m_subDetectorLayerVector
 The vector of layer parameters for the sub detector section.
 

Friends

class GeometryManager
 
class PandoraObjectFactory< object_creation::Geometry::SubDetector::Parameters, object_creation::Geometry::SubDetector::Object >
 

Detailed Description

SubDetector class.

Definition at line 25 of file SubDetector.h.

Member Typedef Documentation

◆ SubDetectorLayerVector

typedef std::vector<SubDetectorLayer> pandora::SubDetector::SubDetectorLayerVector

Definition at line 70 of file SubDetector.h.

Constructor & Destructor Documentation

◆ SubDetector()

pandora::SubDetector::SubDetector ( const object_creation::Geometry::SubDetector::Parameters &  inputParameters)
protected

Constructor.

Parameters
inputParametersthe input sub detector parameters

Definition at line 14 of file SubDetector.cc.

◆ ~SubDetector()

pandora::SubDetector::~SubDetector ( )
protectedvirtual

Destructor.

Definition at line 49 of file SubDetector.cc.

Member Function Documentation

◆ GetInnerPhiCoordinate()

float pandora::SubDetector::GetInnerPhiCoordinate ( ) const
inline

Get the inner cylindrical polar phi coordinate (angle wrt cartesian x axis)

Returns
The inner cylindrical polar phi coordinate

Definition at line 255 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetInnerRCoordinate()

float pandora::SubDetector::GetInnerRCoordinate ( ) const
inline

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

Returns
The inner cylindrical polar r coordinate

Definition at line 241 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetInnerSymmetryOrder()

unsigned int pandora::SubDetector::GetInnerSymmetryOrder ( ) const
inline

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

Returns
The order of symmetry of the innermost edge of subdetector

Definition at line 262 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetInnerZCoordinate()

float pandora::SubDetector::GetInnerZCoordinate ( ) const
inline

Get the inner cylindrical polar z coordinate, origin interaction point, units mm.

Returns
The inner cylindrical polar z coordinate

Definition at line 248 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetNLayers()

unsigned int pandora::SubDetector::GetNLayers ( ) const
inline

Get the number of layers in the sub detector.

Returns
The number of layers in the sub detector

Definition at line 304 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetOuterPhiCoordinate()

float pandora::SubDetector::GetOuterPhiCoordinate ( ) const
inline

Get the outer cylindrical polar phi coordinate (angle wrt cartesian x axis)

Returns
The outer cylindrical polar phi coordinate

Definition at line 283 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetOuterRCoordinate()

float pandora::SubDetector::GetOuterRCoordinate ( ) const
inline

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

Returns
The outer cylindrical polar r coordinate

Definition at line 269 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetOuterSymmetryOrder()

unsigned int pandora::SubDetector::GetOuterSymmetryOrder ( ) const
inline

Get the order of symmetry of the outermost edge of sub detector.

Returns
The order of symmetry of the outermost edge of sub detector

Definition at line 290 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetOuterZCoordinate()

float pandora::SubDetector::GetOuterZCoordinate ( ) const
inline

Get the outer cylindrical polar z coordinate, origin interaction point, units mm.

Returns
The outer cylindrical polar z coordinate

Definition at line 276 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetSubDetectorLayerVector()

const SubDetector::SubDetectorLayerVector & pandora::SubDetector::GetSubDetectorLayerVector ( ) const
inline

Get the vector of layer parameters for the sub detector.

Returns
The vector of layer parameters for the sub detector

Definition at line 311 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetSubDetectorName()

const std::string & pandora::SubDetector::GetSubDetectorName ( ) const
inline

Get the sub detector name, uniquely specifying the sub detector.

Returns
The sub detector name

Definition at line 227 of file SubDetector.h.

Here is the caller graph for this function:

◆ GetSubDetectorType()

SubDetectorType pandora::SubDetector::GetSubDetectorType ( ) const
inline

Get the sub detector type, e.g. ECAL_BARREL, HCAL_ENDCAP, TPC, etc.

Returns
The sub detector type

Definition at line 234 of file SubDetector.h.

Here is the caller graph for this function:

◆ IsMirroredInZ()

bool pandora::SubDetector::IsMirroredInZ ( ) const
inline

Whether a second sub detector exists, equivalent to a reflection in z=0 plane.

Returns
boolean

Definition at line 297 of file SubDetector.h.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ GeometryManager

friend class GeometryManager
friend

Definition at line 190 of file SubDetector.h.

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

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

Definition at line 190 of file SubDetector.h.

Member Data Documentation

◆ m_innerPhiCoordinate

float pandora::SubDetector::m_innerPhiCoordinate
protected

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

Definition at line 180 of file SubDetector.h.

◆ m_innerRCoordinate

float pandora::SubDetector::m_innerRCoordinate
protected

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

Definition at line 178 of file SubDetector.h.

◆ m_innerSymmetryOrder

unsigned int pandora::SubDetector::m_innerSymmetryOrder
protected

Order of symmetry of the innermost edge of sub detector.

Definition at line 181 of file SubDetector.h.

◆ m_innerZCoordinate

float pandora::SubDetector::m_innerZCoordinate
protected

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

Definition at line 179 of file SubDetector.h.

◆ m_isMirroredInZ

bool pandora::SubDetector::m_isMirroredInZ
protected

Whether a second sub detector exists, equivalent to a reflection in z=0 plane.

Definition at line 186 of file SubDetector.h.

◆ m_nLayers

unsigned int pandora::SubDetector::m_nLayers
protected

The number of layers in the sub detector section.

Definition at line 187 of file SubDetector.h.

◆ m_outerPhiCoordinate

float pandora::SubDetector::m_outerPhiCoordinate
protected

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

Definition at line 184 of file SubDetector.h.

◆ m_outerRCoordinate

float pandora::SubDetector::m_outerRCoordinate
protected

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

Definition at line 182 of file SubDetector.h.

◆ m_outerSymmetryOrder

unsigned int pandora::SubDetector::m_outerSymmetryOrder
protected

Order of symmetry of the outermost edge of sub detector.

Definition at line 185 of file SubDetector.h.

◆ m_outerZCoordinate

float pandora::SubDetector::m_outerZCoordinate
protected

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

Definition at line 183 of file SubDetector.h.

◆ m_subDetectorLayerVector

SubDetectorLayerVector pandora::SubDetector::m_subDetectorLayerVector
protected

The vector of layer parameters for the sub detector section.

Definition at line 188 of file SubDetector.h.

◆ m_subDetectorName

std::string pandora::SubDetector::m_subDetectorName
protected

The sub detector name, must uniquely specify a single sub detector.

Definition at line 176 of file SubDetector.h.

◆ m_subDetectorType

SubDetectorType pandora::SubDetector::m_subDetectorType
protected

The sub detector type, e.g. ECAL_BARREL, HCAL_ENDCAP, TPC, etc.

Definition at line 177 of file SubDetector.h.

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