KLMElementNumbers Class Reference

KLM element numbers. More...

#include <KLMElementNumbers.h>

Public Types
enum	Subdetector {   c_BKLM = 1 ,   c_EKLM = 2 }
	Subdetector constants. More...

Public Member Functions
KLMChannelNumber	channelNumber (int subdetector, int section, int sector, int layer, int plane, int strip) const
	Get channel number.
KLMChannelNumber	channelNumberBKLM (int section, int sector, int layer, int plane, int strip) const
	Get channel number for BKLM.
KLMChannelNumber	channelNumberBKLM (int bklmChannel) const
	Get channel number for BKLM.
KLMChannelNumber	channelNumberEKLM (int section, int sector, int layer, int plane, int strip) const
	Get channel number for EKLM.
KLMChannelNumber	channelNumberEKLM (int eklmStrip) const
	Get channel number for EKLM.
bool	isBKLMChannel (KLMChannelNumber channel) const
	Determine whether a given channel is in BKLM.
bool	isEKLMChannel (KLMChannelNumber channel) const
	Determine whether a given channel is in EKLM.
int	localChannelNumberBKLM (KLMChannelNumber channel) const
	Get local BKLM channel number.
int	localChannelNumberEKLM (KLMChannelNumber channel) const
	Get local EKLM channel number.
void	channelNumberToElementNumbers (KLMChannelNumber channel, int *subdetector, int *section, int *sector, int *layer, int *plane, int *strip) const
	Get element numbers by channel number.
KLMPlaneNumber	planeNumber (int subdetector, int section, int sector, int layer, int plane) const
	Get plane number.
KLMPlaneNumber	planeNumberBKLM (int section, int sector, int layer, int plane) const
	Get plane number for BKLM.
KLMPlaneNumber	planeNumberEKLM (int section, int sector, int layer, int plane) const
	Get channel number for EKLM.
KLMModuleNumber	moduleNumber (int subdetector, int section, int sector, int layer) const
	Get module number.
KLMModuleNumber	moduleNumberBKLM (int section, int sector, int layer) const
	Get module number for BKLM.
KLMModuleNumber	moduleNumberEKLM (int section, int sector, int layer) const
	Get module number for EKLM.
KLMModuleNumber	moduleNumberByChannel (KLMChannelNumber channel) const
	Get module number by channel number.
void	moduleNumberToElementNumbers (KLMModuleNumber module, int *subdetector, int *section, int *sector, int *layer) const
	Get element numbers by module number.
unsigned int	getNChannelsModule (KLMModuleNumber module) const
	Get number of channels in module.
KLMSectorNumber	sectorNumberBKLM (int section, int sector) const
	Get sector number for BKLM.
KLMSectorNumber	sectorNumberEKLM (int section, int sector) const
	Get sector number for EKLM.
int	getExtrapolationLayer (int subdetector, int layer) const
	Get extrapolation layer number (BKLM - from 1 to 15, EKLM - from 16 to 29).
int	getMinimalPlaneNumber (int subdetector) const
	Get minimal plane number.
std::string	getSectorDAQName (int subdetector, int section, int sector) const
	Get DAQ name for a given sector.

Static Public Member Functions
static const KLMElementNumbers &	Instance ()
	Instantiation.
static constexpr int	getMaximalExtrapolationLayer ()
	Get maximal extrapolation layer.
static constexpr int	getTotalModuleNumber ()
	Get total number of modules.
static constexpr int	getMaximalPlaneNumber ()
	Get maximal plane number.
static constexpr int	getTotalChannelNumber ()
	Get total number of channels.

Private Member Functions
	KLMElementNumbers ()
	Constructor.
	~KLMElementNumbers ()
	Destructor.

Private Attributes
const EKLMElementNumbers *	m_eklmElementNumbers
	EKLM element numbers.

Static Private Attributes
static constexpr uint16_t	m_BKLMOffset = 0x8000
	BKLM offset.

Detailed Description

KLM element numbers.

Definition at line 28 of file KLMElementNumbers.h.

Member Enumeration Documentation

Subdetector

enum Subdetector

Subdetector constants.

Enumerator
c_BKLM	BKLM.
c_EKLM	EKLM.

Definition at line 35 of file KLMElementNumbers.h.

                     {
 
      c_BKLM = 1,
 
      c_EKLM = 2,
 
    };

Constructor & Destructor Documentation

KLMElementNumbers()

KLMElementNumbers ( )

private

Constructor.

Definition at line 20 of file KLMElementNumbers.cc.

                                     :
  m_eklmElementNumbers(&(EKLMElementNumbers::Instance()))
{
}

~KLMElementNumbers()

~KLMElementNumbers ( )

private

Destructor.

Definition at line 25 of file KLMElementNumbers.cc.

{
}

Member Function Documentation

channelNumber()

KLMChannelNumber channelNumber	(	int	subdetector,
		int	section,
		int	sector,
		int	layer,
		int	plane,
		int	strip
	)		const

Get channel number.

Parameters

[in]	subdetector	Sundetector.
[in]	section	Section.
[in]	sector	Sector.
[in]	layer	Layer.
[in]	plane	Plane.
[in]	strip	Strip.

Definition at line 35 of file KLMElementNumbers.cc.

{
  switch (subdetector) {
    case c_BKLM:
      return channelNumberBKLM(section, sector, layer, plane, strip);
    case c_EKLM:
      return channelNumberEKLM(section, sector, layer, plane, strip);
  }
  B2FATAL("Incorrect subdetector number: " << subdetector);
}

channelNumberBKLM() [1/2]

KLMChannelNumber channelNumberBKLM

(

int

bklmChannel

)

const

Get channel number for BKLM.

Parameters

[in]

bklmChannel

BKLM channel.

Definition at line 57 of file KLMElementNumbers.cc.

{
  return bklmChannel + m_BKLMOffset;
}

channelNumberBKLM() [2/2]

KLMChannelNumber channelNumberBKLM	(	int	section,
		int	sector,
		int	layer,
		int	plane,
		int	strip
	)		const

Get channel number for BKLM.

Parameters

[in]	section	Forward (1) or backward (0) BKLM.
[in]	sector	Sector (1-based).
[in]	layer	Layer (1-based).
[in]	plane	Plane (0-based).
[in]	strip	Strip (1-based).

Definition at line 48 of file KLMElementNumbers.cc.

{
  KLMChannelNumber channel;
  channel = BKLMElementNumbers::channelNumber(
              section, sector, layer, plane, strip);
  return channel + m_BKLMOffset;
}

channelNumberEKLM() [1/2]

KLMChannelNumber channelNumberEKLM

(

int

eklmStrip

)

const

Get channel number for EKLM.

Parameters

[in]

eklmStrip

EKLM strip number.

Definition at line 75 of file KLMElementNumbers.cc.

{
  return eklmStrip;
}

channelNumberEKLM() [2/2]

KLMChannelNumber channelNumberEKLM	(	int	section,
		int	sector,
		int	layer,
		int	plane,
		int	strip
	)		const

Get channel number for EKLM.

Parameters

[in]	section	Section number.
[in]	sector	Sector number.
[in]	layer	Layer number.
[in]	plane	Plane number.
[in]	strip	Strip number.

Definition at line 62 of file KLMElementNumbers.cc.

{
  KLMChannelNumber channel;
  /*
   * Note that the default order of elements is different
   * for EKLM-specific code!
   */
  channel = m_eklmElementNumbers->stripNumber(
              section, layer, sector, plane, strip);
  return channel;
}

channelNumberToElementNumbers()

void channelNumberToElementNumbers	(	KLMChannelNumber	channel,
		int *	subdetector,
		int *	section,
		int *	sector,
		int *	layer,
		int *	plane,
		int *	strip
	)		const

Get element numbers by channel number.

Parameters

[in]	channel	KLM channel number.
[out]	subdetector	Subdetector.
[out]	section	Section.
[out]	sector	Sector.
[out]	layer	Layer.
[out]	plane	Plane.
[out]	strip	Strip.

Definition at line 104 of file KLMElementNumbers.cc.

{
  int localChannel;
  if (isBKLMChannel(channel)) {
    *subdetector = c_BKLM;
    localChannel = localChannelNumberBKLM(channel);
    BKLMElementNumbers::channelNumberToElementNumbers(
      localChannel, section, sector, layer, plane, strip);
  } else {
    *subdetector = c_EKLM;
    localChannel = localChannelNumberEKLM(channel);
    /*
     * Note that the default order of elements is different
     * for EKLM-specific code!
     */
    m_eklmElementNumbers->stripNumberToElementNumbers(
      localChannel, section, layer, sector, plane, strip);
  }
}

getExtrapolationLayer()

int getExtrapolationLayer	(	int	subdetector,
		int	layer
	)		const

Get extrapolation layer number (BKLM - from 1 to 15, EKLM - from 16 to 29).

Parameters

[in]	subdetector	Subdetector.
[in]	layer	Layer.

Definition at line 246 of file KLMElementNumbers.cc.

{
  if (subdetector == c_BKLM)
    return layer;
  else
    return BKLMElementNumbers::getMaximalLayerNumber() + layer;
}

getMaximalExtrapolationLayer()

static constexpr int getMaximalExtrapolationLayer ( )

inlinestaticconstexpr

Get maximal extrapolation layer.

Definition at line 244 of file KLMElementNumbers.h.

    {
      return EKLMElementNumbers::getMaximalLayerNumber() +
             BKLMElementNumbers::getMaximalLayerNumber();
    }

getMaximalPlaneNumber()

static constexpr int getMaximalPlaneNumber ( )

inlinestaticconstexpr

Get maximal plane number.

Definition at line 268 of file KLMElementNumbers.h.

    {
      /* BKLM plane number is 0-based! */
      return std::max(EKLMElementNumbers::getMaximalPlaneNumber(),
                      BKLMElementNumbers::getMaximalPlaneNumber() + 1);
    }

getMinimalPlaneNumber()

int getMinimalPlaneNumber

(

int

subdetector

)

const

Get minimal plane number.

Parameters

[in]

subdetector

Subdetector.

Definition at line 254 of file KLMElementNumbers.cc.

{
  if (subdetector == c_BKLM)
    return 0;
  else
    return 1;
}

getNChannelsModule()

unsigned int getNChannelsModule

(

KLMModuleNumber

module

)

const

Get number of channels in module.

Parameters

[in]

module

KLM module number.

Definition at line 216 of file KLMElementNumbers.cc.

{
  if (isBKLMChannel(module)) {
    int localModule = localChannelNumberBKLM(module);
    int section, sector, layer;
    BKLMElementNumbers::moduleNumberToElementNumbers(
      localModule, &section, &sector, &layer);
    return BKLMElementNumbers::getNStrips(section, sector, layer, 0) +
           BKLMElementNumbers::getNStrips(section, sector, layer, 1);
  } else {
    return EKLMElementNumbers::getNStripsSector();
  }
}

getSectorDAQName()

std::string getSectorDAQName	(	int	subdetector,
		int	section,
		int	sector
	)		const

Get DAQ name for a given sector.

Parameters

[in]	subdetector	Subdetector.
[in]	section	Section.
[in]	sector	Sector.

Definition at line 262 of file KLMElementNumbers.cc.

{
  std::string name;
  if (subdetector == c_BKLM) {
    BKLMElementNumbers::checkSector(sector);
    if (section == BKLMElementNumbers::c_BackwardSection)
      name = "BB" + std::to_string(sector - 1);
    if (section == BKLMElementNumbers::c_ForwardSection)
      name = "BF" + std::to_string(sector - 1);
  }
  if (subdetector == c_EKLM) {
    m_eklmElementNumbers->checkSector(sector);
    if (section == EKLMElementNumbers::c_BackwardSection)
      name = "EB" + std::to_string(sector - 1);
    if (section == EKLMElementNumbers::c_ForwardSection)
      name = "EF" + std::to_string(sector - 1);
  }
  if (name.empty())
    B2FATAL("Invalid KLM sector."
            << LogVar("Subdetector", subdetector)
            << LogVar("Section", section)
            << LogVar("Sector", sector));
  return name;
}

getTotalChannelNumber()

static constexpr int getTotalChannelNumber ( )

inlinestaticconstexpr

Get total number of channels.

Definition at line 286 of file KLMElementNumbers.h.

    {
      return BKLMElementNumbers::getTotalChannelNumber() +
             EKLMElementNumbers::getTotalChannelNumber();
    }

getTotalModuleNumber()

static constexpr int getTotalModuleNumber ( )

inlinestaticconstexpr

Get total number of modules.

Definition at line 253 of file KLMElementNumbers.h.

    {
      return EKLMElementNumbers::getMaximalSectorGlobalNumber() +
             BKLMElementNumbers::getMaximalLayerGlobalNumber();
    }

Instance()

const KLMElementNumbers & Instance ( )

static

Instantiation.

Definition at line 29 of file KLMElementNumbers.cc.

{
  static KLMElementNumbers klmElementNumbers;
  return klmElementNumbers;
}

isBKLMChannel()

bool isBKLMChannel

(

KLMChannelNumber

channel

)

const

Determine whether a given channel is in BKLM.

This function also works for modules amd sectors.

Parameters

[in]

channel

KLM channel number.

Definition at line 80 of file KLMElementNumbers.cc.

{
  return (channel >= m_BKLMOffset);
}

isEKLMChannel()

bool isEKLMChannel

(

KLMChannelNumber

channel

)

const

Determine whether a given channel is in EKLM.

This function also works for modules amd sectors.

Parameters

[in]

channel

KLM channel number.

Definition at line 85 of file KLMElementNumbers.cc.

{
  return (channel < m_BKLMOffset);
}

localChannelNumberBKLM()

int localChannelNumberBKLM

(

KLMChannelNumber

channel

)

const

Get local BKLM channel number.

This function also works for modules amd sectors.

Parameters

[in]

channel

KLM channel number.

Definition at line 90 of file KLMElementNumbers.cc.

{
  if (!isBKLMChannel(channel))
    B2FATAL("Cannot get BKLM local channel number for non-BKLM channel.");
  return channel - m_BKLMOffset;
}

localChannelNumberEKLM()

int localChannelNumberEKLM

(

KLMChannelNumber

channel

)

const

Get local EKLM channel number.

This function also works for modules amd sectors.

Parameters

[in]

channel

KLM channel number.

Definition at line 97 of file KLMElementNumbers.cc.

{
  if (!isEKLMChannel(channel))
    B2FATAL("Cannot get EKLM local channel number for non-EKLM channel.");
  return channel;
}

moduleNumber()

KLMModuleNumber moduleNumber	(	int	subdetector,
		int	section,
		int	sector,
		int	layer
	)		const

Get module number.

Parameters

[in]	subdetector	Subdetector.
[in]	section	Section.
[in]	sector	Sector (1-based).
[in]	layer	Layer (1-based).

Definition at line 156 of file KLMElementNumbers.cc.

{
  if (subdetector == c_BKLM)
    return moduleNumberBKLM(section, sector, layer);
  else
    return moduleNumberEKLM(section, sector, layer);
}

moduleNumberBKLM()

KLMModuleNumber moduleNumberBKLM	(	int	section,
		int	sector,
		int	layer
	)		const

Get module number for BKLM.

Parameters

[in]	section	Forward (1) or backward (0) BKLM.
[in]	sector	Sector (1-based).
[in]	layer	Layer (1-based).

Definition at line 165 of file KLMElementNumbers.cc.

{
  KLMModuleNumber module;
  module = BKLMElementNumbers::moduleNumber(section, sector, layer);
  return module + m_BKLMOffset;
}

moduleNumberByChannel()

KLMModuleNumber moduleNumberByChannel

(

KLMChannelNumber

channel

)

const

Get module number by channel number.

Parameters

[in]

channel

Channel.

Definition at line 185 of file KLMElementNumbers.cc.

{
  int subdetector, section, sector, layer, plane, strip;
  channelNumberToElementNumbers(channel, &subdetector, &section, &sector,
                                &layer, &plane, &strip);
  return moduleNumber(subdetector, section, sector, layer);
}

moduleNumberEKLM()

KLMModuleNumber moduleNumberEKLM	(	int	section,
		int	sector,
		int	layer
	)		const

Get module number for EKLM.

Parameters

[in]	section	Section number.
[in]	sector	Sector number.
[in]	layer	Layer number.

Definition at line 173 of file KLMElementNumbers.cc.

{
  KLMModuleNumber module;
  /*
   * Note that the default order of elements is different
   * for EKLM-specific code!
   */
  module = m_eklmElementNumbers->sectorNumber(section, layer, sector);
  return module;
}

moduleNumberToElementNumbers()

void moduleNumberToElementNumbers	(	KLMModuleNumber	module,
		int *	subdetector,
		int *	section,
		int *	sector,
		int *	layer
	)		const

Get element numbers by module number.

Parameters

[in]	module	KLM module number.
[out]	subdetector	Subdetector.
[out]	section	Section.
[out]	sector	Sector.
[out]	layer	Layer.

Definition at line 194 of file KLMElementNumbers.cc.

{
  int localModule;
  if (isBKLMChannel(module)) {
    *subdetector = c_BKLM;
    localModule = localChannelNumberBKLM(module);
    BKLMElementNumbers::moduleNumberToElementNumbers(
      localModule, section, sector, layer);
  } else {
    *subdetector = c_EKLM;
    localModule = localChannelNumberEKLM(module);
    /*
     * Note that the default order of elements is different
     * for EKLM-specific code!
     */
    m_eklmElementNumbers->sectorNumberToElementNumbers(
      localModule, section, layer, sector);
  }
}

planeNumber()

KLMPlaneNumber planeNumber	(	int	subdetector,
		int	section,
		int	sector,
		int	layer,
		int	plane
	)		const

Get plane number.

Parameters

[in]	subdetector	Subdetector.
[in]	section	Section.
[in]	sector	Sector.
[in]	layer	Layer.
[in]	plane	Plane.

Definition at line 126 of file KLMElementNumbers.cc.

{
  if (subdetector == c_BKLM)
    return planeNumberBKLM(section, sector, layer, plane);
  else
    return planeNumberEKLM(section, sector, layer, plane);
}

planeNumberBKLM()

KLMPlaneNumber planeNumberBKLM	(	int	section,
		int	sector,
		int	layer,
		int	plane
	)		const

Get plane number for BKLM.

Parameters

[in]	section	Forward (1) or backward (0) BKLM.
[in]	sector	Sector (1-based).
[in]	layer	Layer (1-based).
[in]	plane	Plane (0-based).

Definition at line 135 of file KLMElementNumbers.cc.

{
  KLMPlaneNumber planeGlobal;
  planeGlobal = BKLMElementNumbers::planeNumber(section, sector, layer, plane);
  return planeGlobal + m_BKLMOffset;
}

planeNumberEKLM()

KLMPlaneNumber planeNumberEKLM	(	int	section,
		int	sector,
		int	layer,
		int	plane
	)		const

Get channel number for EKLM.

Parameters

[in]	section	Section number.
[in]	sector	Sector number.
[in]	layer	Layer number.
[in]	plane	Plane number.

Definition at line 143 of file KLMElementNumbers.cc.

{
  KLMPlaneNumber planeGlobal;
  /*
   * Note that the default order of elements is different
   * for EKLM-specific code!
   */
  planeGlobal = m_eklmElementNumbers->planeNumber(
                  section, layer, sector, plane);
  return planeGlobal;
}

sectorNumberBKLM()

KLMSectorNumber sectorNumberBKLM	(	int	section,
		int	sector
	)		const

Get sector number for BKLM.

Parameters

[in]	section	Forward (1) or backward (0) BKLM.
[in]	sector	Sector (1-based).

Definition at line 230 of file KLMElementNumbers.cc.

{
  KLMSectorNumber sect;
  sect = BKLMElementNumbers::sectorNumber(section, sector);
  return sect + m_BKLMOffset;
}

sectorNumberEKLM()

KLMSectorNumber sectorNumberEKLM	(	int	section,
		int	sector
	)		const

Get sector number for EKLM.

Parameters

[in]	section	Section number.
[in]	sector	Sector number.

Definition at line 238 of file KLMElementNumbers.cc.

{
  KLMSectorNumber sect;
  sect = m_eklmElementNumbers->sectorNumberKLMOrder(section, sector);
  return sect;
}

Member Data Documentation

m_BKLMOffset

constexpr uint16_t m_BKLMOffset = 0x8000

staticconstexprprivate

BKLM offset.

Definition at line 305 of file KLMElementNumbers.h.

m_eklmElementNumbers

const EKLMElementNumbers* m_eklmElementNumbers

private

EKLM element numbers.

Definition at line 308 of file KLMElementNumbers.h.

---

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

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