KLM channel index. More...

#include <KLMChannelIndex.h>

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.

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

	~KLMChannelIndex ()
	Destructor.

void	setIndexLevel (enum IndexLevel indexLevel)
	Set index level.

void	useEKLMSegments (bool useSegments=true)
	Iterate over EKLM segments instead of strips.

void	setKLMModule (KLMModuleNumber module)
	Set KLM module.

void	setEKLMSegment (int segment)
	Set EKLM segment.

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.

KLMChannelNumber	getKLMChannelNumber () const
	Get KLM channel number.

KLMPlaneNumber	getKLMPlaneNumber () const
	Get KLM plane number.

KLMModuleNumber	getKLMModuleNumber () const
	Get KLM module number.

KLMSectorNumber	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) const
	Operator ==.

bool	operator!= (const KLMChannelIndex &index) const
	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 23 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 30 of file KLMChannelIndex.h.

                    {
 
      c_IndexLevelSubdetector = 1,
 
      c_IndexLevelSection = 2,
 
      c_IndexLevelSector = 3,
 
      c_IndexLevelLayer = 4,
 
      c_IndexLevelPlane = 5,
 
      c_IndexLevelStrip = 6,
 
    };

Constructor & Destructor Documentation

◆ KLMChannelIndex() [1/2]

KLMChannelIndex ( enum IndexLevel indexLevel = c_IndexLevelStrip )

explicit

Constructor.

Parameters

[in] indexLevel Index level.

Definition at line 18 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 32 of file KLMChannelIndex.cc.

                              :
  m_IndexLevel(indexLevel),
  m_Subdetector(subdetector),
  m_Section(section),
  m_Sector(sector),
  m_Layer(layer),
  m_Plane(plane),
  m_Strip(strip),
  m_ElementNumbers(&(KLMElementNumbers::Instance())),
  m_eklmElementNumbers(&(EKLMElementNumbers::Instance()))
{
  setNStripsPlane();
}

◆ ~KLMChannelIndex()

~KLMChannelIndex ( )

Destructor.

Definition at line 48 of file KLMChannelIndex.cc.

49{

50}

Member Function Documentation

◆ begin()

KLMChannelIndex begin ( )

inline

First channel.

Definition at line 199 of file KLMChannelIndex.h.

    {
      return beginBKLM();
    }

◆ beginBKLM()

KLMChannelIndex beginBKLM ( )

First channel for BKLM.

Definition at line 187 of file KLMChannelIndex.cc.

{
  return KLMChannelIndex(KLMElementNumbers::c_BKLM, 0, 1, 1, 0, 1,
                         m_IndexLevel);
}

◆ beginEKLM()

KLMChannelIndex beginEKLM ( )

First channel for EKLM.

Definition at line 203 of file KLMChannelIndex.cc.

{
  return KLMChannelIndex(KLMElementNumbers::c_EKLM, 1, 1, 1, 1, 1,
                         m_IndexLevel);
}

◆ end()

KLMChannelIndex & end ( )

inline

Last channel.

Definition at line 207 of file KLMChannelIndex.h.

    {
      return endEKLM();
    }

◆ endBKLM()

KLMChannelIndex & endBKLM ( )

Last channel for BKLM.

Definition at line 193 of file KLMChannelIndex.cc.

{
  /*
   * The index level does not matter for end check, thus,
   * the object can be created once.
   */
  static KLMChannelIndex index(KLMElementNumbers::c_EKLM, 1, 1, 1, 1, 1);
  return index;
}

◆ endEKLM()

KLMChannelIndex & endEKLM ( )

Last channel for EKLM.

Definition at line 209 of file KLMChannelIndex.cc.

{
  /*
   * The index level does not matter for end check, thus,
   * the object can be created once.
   */
  static KLMChannelIndex index(KLMElementNumbers::c_EKLM + 1, 1, 1, 1, 1, 1);
  return index;
}

◆ getEKLMSegmentNumber()

int getEKLMSegmentNumber ( ) const

Get EKLM segment number.

Definition at line 181 of file KLMChannelIndex.cc.

{
  return m_eklmElementNumbers->segmentNumber(
           m_Section, m_Layer, m_Sector, m_Plane, m_Strip);
}

◆ getKLMChannelNumber()

KLMChannelNumber getKLMChannelNumber ( ) const

Get KLM channel number.

Definition at line 143 of file KLMChannelIndex.cc.

{
  if (m_Subdetector == KLMElementNumbers::c_BKLM) {
    return m_ElementNumbers->channelNumberBKLM(
             m_Section, m_Sector, m_Layer, m_Plane, m_Strip);
  } else {
    return m_ElementNumbers->channelNumberEKLM(
             m_Section, m_Sector, m_Layer, m_Plane, m_Strip);
  }
}

◆ getKLMModuleNumber()

KLMModuleNumber getKLMModuleNumber ( ) const

Get KLM module number.

Definition at line 165 of file KLMChannelIndex.cc.

{
  if (m_Subdetector == KLMElementNumbers::c_BKLM)
    return m_ElementNumbers->moduleNumberBKLM(m_Section, m_Sector, m_Layer);
  else
    return m_ElementNumbers->moduleNumberEKLM(m_Section, m_Sector, m_Layer);
}

◆ getKLMPlaneNumber()

KLMPlaneNumber getKLMPlaneNumber ( ) const

Get KLM plane number.

Definition at line 154 of file KLMChannelIndex.cc.

{
  if (m_Subdetector == KLMElementNumbers::c_BKLM) {
    return m_ElementNumbers->planeNumberBKLM(
             m_Section, m_Sector, m_Layer, m_Plane);
  } else {
    return m_ElementNumbers->planeNumberEKLM(
             m_Section, m_Sector, m_Layer, m_Plane);
  }
}

◆ getKLMSectorNumber()

KLMSectorNumber getKLMSectorNumber ( ) const

Get KLM sector number.

Definition at line 173 of file KLMChannelIndex.cc.

{
  if (m_Subdetector == KLMElementNumbers::c_BKLM)
    return m_ElementNumbers->sectorNumberBKLM(m_Section, m_Sector);
  else
    return m_ElementNumbers->sectorNumberEKLM(m_Section, m_Sector);
}

◆ getLayer()

int getLayer ( ) const

inline

Get layer.

Definition at line 130 of file KLMChannelIndex.h.

    {
      return m_Layer;
    }

◆ getPlane()

int getPlane ( ) const

inline

Get plane.

Definition at line 138 of file KLMChannelIndex.h.

    {
      return m_Plane;
    }

◆ getSection()

int getSection ( ) const

inline

Get section.

Definition at line 114 of file KLMChannelIndex.h.

    {
      return m_Section;
    }

◆ getSector()

int getSector ( ) const

inline

Get sector.

Definition at line 122 of file KLMChannelIndex.h.

    {
      return m_Sector;
    }

◆ getStrip()

int getStrip ( ) const

inline

Get strip.

Definition at line 146 of file KLMChannelIndex.h.

    {
      return m_Strip;
    }

◆ getSubdetector()

int getSubdetector ( ) const

inline

Get subdetector.

Definition at line 106 of file KLMChannelIndex.h.

    {
      return m_Subdetector;
    }

◆ increment() [1/2]

KLMChannelIndex & increment ( )

Increment (to use in Python).

Definition at line 314 of file KLMChannelIndex.cc.

{
  increment(m_IndexLevel);
  return *this;
}

◆ increment() [2/2]

void increment ( enum IndexLevel indexLevel )

protected

Increment the index.

Definition at line 219 of file KLMChannelIndex.cc.

{
  if (m_Subdetector == KLMElementNumbers::c_BKLM) {
    switch (indexLevel) {
      case c_IndexLevelStrip:
        m_Strip++;
        if (m_Strip > m_NStripsPlane) {
          m_Strip = 1;
          increment(c_IndexLevelPlane);
          setNStripsPlane();
        }
        break;
      case c_IndexLevelPlane:
        m_Plane++;
        if (m_Plane > BKLMElementNumbers::getMaximalPlaneNumber()) {
          m_Plane = 0;
          increment(c_IndexLevelLayer);
        }
        break;
      case c_IndexLevelLayer:
        m_Layer++;
        if (m_Layer > BKLMElementNumbers::getMaximalLayerNumber()) {
          m_Layer = 1;
          increment(c_IndexLevelSector);
        }
        break;
      case c_IndexLevelSector:
        m_Sector++;
        if (m_Sector > BKLMElementNumbers::getMaximalSectorNumber()) {
          m_Sector = 1;
          increment(c_IndexLevelSection);
        }
        break;
      case c_IndexLevelSection:
        m_Section++;
        if (m_Section > BKLMElementNumbers::getMaximalSectionNumber()) {
          m_Section = 0;
          increment(c_IndexLevelSubdetector);
        }
        break;
      case c_IndexLevelSubdetector:
        *this = beginEKLM();
        break;
    }
  } else {
    switch (indexLevel) {
      case c_IndexLevelStrip:
        m_Strip++;
        if (m_Strip > m_NStripsPlane) {
          m_Strip = 1;
          increment(c_IndexLevelPlane);
          setNStripsPlane();
        }
        break;
      case c_IndexLevelPlane:
        m_Plane++;
        if (m_Plane > EKLMElementNumbers::getMaximalPlaneNumber()) {
          m_Plane = 1;
          increment(c_IndexLevelLayer);
        }
        break;
      case c_IndexLevelLayer:
        m_Layer++;
        if (m_Layer > m_eklmElementNumbers->getMaximalDetectorLayerNumber(m_Section)) {
          m_Layer = 1;
          increment(c_IndexLevelSector);
        }
        break;
      case c_IndexLevelSector:
        m_Sector++;
        if (m_Sector > EKLMElementNumbers::getMaximalSectorNumber()) {
          m_Sector = 1;
          increment(c_IndexLevelSection);
        }
        break;
      case c_IndexLevelSection:
        m_Section++;
        if (m_Section > EKLMElementNumbers::getMaximalSectionNumber()) {
          m_Section = 1;
          increment(c_IndexLevelSubdetector);
        }
        break;
      case c_IndexLevelSubdetector:
        m_Subdetector++;
        break;
    }
  }
}

◆ operator!=()

bool operator!= ( const KLMChannelIndex & index ) const

Operator !=.

Definition at line 350 of file KLMChannelIndex.cc.

{
  switch (m_IndexLevel) {
    case c_IndexLevelStrip:
      if (m_Strip != index.getStrip())
        return true;
      [[fallthrough]];
    case c_IndexLevelPlane:
      if (m_Plane != index.getPlane())
        return true;
      [[fallthrough]];
    case c_IndexLevelLayer:
      if (m_Layer != index.getLayer())
        return true;
      [[fallthrough]];
    case c_IndexLevelSector:
      if (m_Sector != index.getSector())
        return true;
      [[fallthrough]];
    case c_IndexLevelSection:
      if (m_Section != index.getSection())
        return true;
      [[fallthrough]];
    case c_IndexLevelSubdetector:
      if (m_Subdetector != index.getSubdetector())
        return true;
  }
  return false;
}

◆ operator*()

KLMChannelIndex & operator* ( )

Operator *.

Definition at line 380 of file KLMChannelIndex.cc.

{
  return *this;
}

◆ operator++()

KLMChannelIndex & operator++ ( )

Operator ++.

Definition at line 308 of file KLMChannelIndex.cc.

{
  increment(m_IndexLevel);
  return *this;
}

◆ operator==()

bool operator== ( const KLMChannelIndex & index ) const

Operator ==.

Definition at line 320 of file KLMChannelIndex.cc.

{
  switch (m_IndexLevel) {
    case c_IndexLevelStrip:
      if (m_Strip != index.getStrip())
        return false;
      [[fallthrough]];
    case c_IndexLevelPlane:
      if (m_Plane != index.getPlane())
        return false;
      [[fallthrough]];
    case c_IndexLevelLayer:
      if (m_Layer != index.getLayer())
        return false;
      [[fallthrough]];
    case c_IndexLevelSector:
      if (m_Sector != index.getSector())
        return false;
      [[fallthrough]];
    case c_IndexLevelSection:
      if (m_Section != index.getSection())
        return false;
      [[fallthrough]];
    case c_IndexLevelSubdetector:
      if (m_Subdetector != index.getSubdetector())
        return false;
  }
  return true;
}

◆ setEKLMSegment()

void setEKLMSegment ( int segment )

Set EKLM segment.

Parameters

[in] segment Segment.

Definition at line 134 of file KLMChannelIndex.cc.

{
  m_eklmElementNumbers->segmentNumberToElementNumbers(
    segment, &m_Section, &m_Sector, &m_Layer, &m_Plane, &m_Strip);
  m_Subdetector = KLMElementNumbers::c_EKLM;
  useEKLMSegments();
  m_IndexLevel = c_IndexLevelStrip;
}

◆ 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 65 of file KLMChannelIndex.cc.

{
  if (indexLevel > m_IndexLevel) {
    if (m_Subdetector == KLMElementNumbers::c_BKLM) {
      switch (m_IndexLevel) {
        case c_IndexLevelSubdetector:
          m_Section = 0;
          [[fallthrough]];
        case c_IndexLevelSection:
          m_Sector = 1;
          [[fallthrough]];
        case c_IndexLevelSector:
          m_Layer = 1;
          [[fallthrough]];
        case c_IndexLevelLayer:
          m_Plane = 0;
          [[fallthrough]];
        case c_IndexLevelPlane:
          m_Strip = 1;
          [[fallthrough]];
        case c_IndexLevelStrip:
          break;
      }
    } else {
      switch (m_IndexLevel) {
        case c_IndexLevelSubdetector:
          m_Section = 1;
          [[fallthrough]];
        case c_IndexLevelSection:
          m_Sector = 1;
          [[fallthrough]];
        case c_IndexLevelSector:
          m_Layer = 1;
          [[fallthrough]];
        case c_IndexLevelLayer:
          m_Plane = 1;
          [[fallthrough]];
        case c_IndexLevelPlane:
          m_Strip = 1;
          [[fallthrough]];
        case c_IndexLevelStrip:
          break;
      }
    }
  }
  m_IndexLevel = indexLevel;
  if (indexLevel == c_IndexLevelStrip)
    setNStripsPlane();
}

◆ setKLMModule()

void setKLMModule ( KLMModuleNumber module )

Set KLM module.

Parameters

[in] module Module.

Definition at line 121 of file KLMChannelIndex.cc.

{
  m_ElementNumbers->moduleNumberToElementNumbers(
    module, &m_Subdetector, &m_Section, &m_Sector, &m_Layer);
  if (m_Subdetector == KLMElementNumbers::c_BKLM)
    m_Plane = 0;
  else
    m_Plane = 1;
  m_Strip = 1;
  useEKLMSegments(false);
  m_IndexLevel = c_IndexLevelLayer;
}

◆ setNStripsPlane()

void setNStripsPlane ( )

protected

Set number of strips in the current plane.

Definition at line 52 of file KLMChannelIndex.cc.

{
  if (m_Subdetector == KLMElementNumbers::c_BKLM) {
    m_NStripsPlane = BKLMElementNumbers::getNStrips(
                       m_Section, m_Sector, m_Layer, m_Plane);
  } else {
    if (m_UseEKLMSegments)
      m_NStripsPlane = EKLMElementNumbers::getMaximalSegmentNumber();
    else
      m_NStripsPlane = EKLMElementNumbers::getMaximalStripNumber();
  }
}

◆ 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 115 of file KLMChannelIndex.cc.

{
  m_UseEKLMSegments = useSegments;
  setNStripsPlane();
}

Member Data Documentation

◆ m_eklmElementNumbers

const EKLMElementNumbers* m_eklmElementNumbers

protected

EKLM element numbers.

Definition at line 280 of file KLMChannelIndex.h.

◆ m_ElementNumbers

const KLMElementNumbers* m_ElementNumbers

protected

KLM element numbers.

Definition at line 277 of file KLMChannelIndex.h.

◆ m_IndexLevel

enum IndexLevel m_IndexLevel

protected

Index level.

Definition at line 250 of file KLMChannelIndex.h.

◆ m_Layer

int m_Layer

protected

Layer.

Definition at line 262 of file KLMChannelIndex.h.

◆ m_NStripsPlane

int m_NStripsPlane

protected

Number of strips in current plane.

Definition at line 274 of file KLMChannelIndex.h.

◆ m_Plane

int m_Plane

protected

Plane.

Definition at line 265 of file KLMChannelIndex.h.

◆ m_Section

int m_Section

protected

Section.

Definition at line 256 of file KLMChannelIndex.h.

◆ m_Sector

int m_Sector

protected

Sector.

Definition at line 259 of file KLMChannelIndex.h.

◆ m_Strip

int m_Strip

protected

Strip.

Definition at line 268 of file KLMChannelIndex.h.

◆ m_Subdetector

int m_Subdetector

protected

Subdetector.

Definition at line 253 of file KLMChannelIndex.h.

◆ m_UseEKLMSegments

bool m_UseEKLMSegments = false

protected

Iterate over EKLM segments instead of strips.

Definition at line 271 of file KLMChannelIndex.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ IndexLevel

Constructor & Destructor Documentation

◆ KLMChannelIndex() [1/2]

◆ KLMChannelIndex() [2/2]

◆ ~KLMChannelIndex()

Member Function Documentation

◆ begin()

◆ beginBKLM()

◆ beginEKLM()

◆ end()

◆ endBKLM()

◆ endEKLM()

◆ getEKLMSegmentNumber()

◆ getKLMChannelNumber()

◆ getKLMModuleNumber()

◆ getKLMPlaneNumber()

◆ getKLMSectorNumber()

◆ getLayer()

◆ getPlane()

◆ getSection()

◆ getSector()

◆ getStrip()

◆ getSubdetector()

◆ increment() [1/2]

◆ increment() [2/2]

◆ operator!=()

◆ operator*()

◆ operator++()

◆ operator==()

◆ setEKLMSegment()

◆ setIndexLevel()

◆ setKLMModule()

◆ setNStripsPlane()

◆ useEKLMSegments()

Member Data Documentation

◆ m_eklmElementNumbers

◆ m_ElementNumbers

◆ m_IndexLevel

◆ m_Layer

◆ m_NStripsPlane

◆ m_Plane

◆ m_Section

◆ m_Sector

◆ m_Strip

◆ m_Subdetector

◆ m_UseEKLMSegments