KLMChannelIndex Class Reference

KLM channel index. More...

#include <KLMChannelIndex.h>

Collaboration diagram for KLMChannelIndex:

Public Types
enum	IndexLevel {   c_IndexLevelSubdetector = 1,   c_IndexLevelSection = 2,   c_IndexLevelSector = 3,   c_IndexLevelLayer = 4,   c_IndexLevelPlane = 5,   c_IndexLevelStrip = 6 }
	Index level (loop over KLM elements at the specified level). More...

Public Member Functions
	KLMChannelIndex (enum IndexLevel indexLevel=c_IndexLevelStrip)
	Constructor. More...
	KLMChannelIndex (int subdetector, int section, int sector, int layer, int plane, int strip, enum IndexLevel indexLevel=c_IndexLevelStrip)
	Constructor. More...
	~KLMChannelIndex ()
	Destructor.
void	setIndexLevel (enum IndexLevel indexLevel)
	Set index level. More...
void	useEKLMSegments (bool useSegments=true)
	Iterate over EKLM segments instead of strips. More...
void	setKLMModule (uint16_t module)
	Set KLM module. More...
void	setEKLMSegment (int segment)
	Set EKLM segment. More...
int	getSubdetector () const
	Get subdetector.
int	getSection () const
	Get section.
int	getSector () const
	Get sector.
int	getLayer () const
	Get layer.
int	getPlane () const
	Get plane.
int	getStrip () const
	Get strip.
uint16_t	getKLMChannelNumber () const
	Get KLM channel number.
uint16_t	getKLMPlaneNumber () const
	Get KLM plane number.
uint16_t	getKLMModuleNumber () const
	Get KLM module number.
uint16_t	getKLMSectorNumber () const
	Get KLM sector number.
int	getEKLMSegmentNumber () const
	Get EKLM segment number.
KLMChannelIndex	beginBKLM ()
	First channel for BKLM.
KLMChannelIndex &	endBKLM ()
	Last channel for BKLM.
KLMChannelIndex	beginEKLM ()
	First channel for EKLM.
KLMChannelIndex &	endEKLM ()
	Last channel for EKLM.
KLMChannelIndex	begin ()
	First channel.
KLMChannelIndex &	end ()
	Last channel.
KLMChannelIndex &	operator++ ()
	Operator ++.
KLMChannelIndex &	increment ()
	Increment (to use in Python).
bool	operator== (const KLMChannelIndex &index)
	Operator ==.
bool	operator!= (const KLMChannelIndex &index)
	Operator !=.
KLMChannelIndex &	operator* ()
	Operator *.

Protected Member Functions
void	setNStripsPlane ()
	Set number of strips in the current plane.
void	increment (enum IndexLevel indexLevel)
	Increment the index.

Protected Attributes
enum IndexLevel	m_IndexLevel
	Index level.
int	m_Subdetector
	Subdetector.
int	m_Section
	Section.
int	m_Sector
	Sector.
int	m_Layer
	Layer.
int	m_Plane
	Plane.
int	m_Strip
	Strip.
bool	m_UseEKLMSegments = false
	Iterate over EKLM segments instead of strips.
int	m_NStripsPlane
	Number of strips in current plane.
const KLMElementNumbers *	m_ElementNumbers
	KLM element numbers.
const EKLMElementNumbers *	m_eklmElementNumbers
	EKLM element numbers.

Detailed Description

KLM channel index.

Definition at line 33 of file KLMChannelIndex.h.

Member Enumeration Documentation

IndexLevel

enum IndexLevel

Index level (loop over KLM elements at the specified level).

Enumerator
c_IndexLevelSubdetector	Subdetector (BKLM or EKLM).
c_IndexLevelSection	Section.
c_IndexLevelSector	Sector.
c_IndexLevelLayer	Layer.
c_IndexLevelPlane	Plane.
c_IndexLevelStrip	Strip.

Definition at line 40 of file KLMChannelIndex.h.

    {

Constructor & Destructor Documentation

KLMChannelIndex() [1/2]

KLMChannelIndex ( enum IndexLevel  indexLevel = c_IndexLevelStrip )

explicit

Constructor.

Parameters

[in]

indexLevel

Index level.

Definition at line 20 of file KLMChannelIndex.cc.

                                                           :
  m_IndexLevel(indexLevel),
  m_Subdetector(KLMElementNumbers::c_BKLM),
  m_Section(0),
  m_Sector(1),
  m_Layer(1),
  m_Plane(0),
  m_Strip(1),
  m_ElementNumbers(&(KLMElementNumbers::Instance())),
  m_eklmElementNumbers(&(EKLMElementNumbers::Instance()))
{
  setNStripsPlane();
}

KLMChannelIndex() [2/2]

KLMChannelIndex	(	int	subdetector,
		int	section,
		int	sector,
		int	layer,
		int	plane,
		int	strip,
		enum IndexLevel	indexLevel = c_IndexLevelStrip
	)

Constructor.

Parameters

[in]	subdetector	Subdetector.
[in]	section	Section.
[in]	sector	Sector.
[in]	layer	Layer.
[in]	plane	Plane.
[in]	strip	Strip.
[in]	indexLevel	Index level.

Definition at line 34 of file KLMChannelIndex.cc.

Member Function Documentation

setEKLMSegment()

void setEKLMSegment

(

int

segment

)

Set EKLM segment.

Parameters

[in]

segment

Segment.

Definition at line 136 of file KLMChannelIndex.cc.

setIndexLevel()

void setIndexLevel

(

enum IndexLevel

indexLevel

)

Set index level.

If the index level is increased, then the index is set to the first element of the higher-order level.

Definition at line 67 of file KLMChannelIndex.cc.

setKLMModule()

void setKLMModule

(

uint16_t

module

)

Set KLM module.

Parameters

[in]

module

Module.

Definition at line 123 of file KLMChannelIndex.cc.

useEKLMSegments()

void useEKLMSegments

(

bool

useSegments = true

)

Iterate over EKLM segments instead of strips.

Turning this on does not make sense for BKLM, in this case the iteration would still be performed over BKLM strips. Make sure that the iteration is performed for EKLM only, e. g. by using beginEKLM() and endEKLM().

Definition at line 117 of file KLMChannelIndex.cc.

---

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

• klm/dataobjects/include/KLMChannelIndex.h
• klm/dataobjects/src/KLMChannelIndex.cc