Muid element numbers. More...

#include <MuidElementNumbers.h>

Public Types
enum	Outcome { c_NotReached = 0 , c_StopInBarrel = 1 , c_StopInForwardEndcap = 2 , c_ExitBarrel = 3 , c_ExitForwardEndcap = 4 , c_StopInBackwardEndcap = 5 , c_ExitBackwardEndcap = 6 , c_CrossBarrelStopInForwardMin = 7 , c_CrossBarrelStopInForwardMax = 21 , c_CrossBarrelStopInBackwardMin = 22 , c_CrossBarrelStopInBackwardMax = 36 , c_CrossBarrelExitForwardMin = 37 , c_CrossBarrelExitForwardMax = 51 , c_CrossBarrelExitBackwardMin = 52 , c_CrossBarrelExitBackwardMax = 66 }
	Outcome of the track extrapolation. More...

enum	DetectorsCrossed { c_Both = 0 , c_OnlyBarrel = KLMElementNumbers::c_BKLM , c_OnlyEndcap = KLMElementNumbers::c_EKLM }
	Labels for detectors crossed. More...

enum	Hypothesis { c_NotValid = -1 , c_Positron = 0 , c_Electron = 1 , c_Deuteron = 2 , c_AntiDeuteron = 3 , c_Proton = 4 , c_AntiProton = 5 , c_PionPlus = 6 , c_PionMinus = 7 , c_KaonPlus = 8 , c_KaonMinus = 9 , c_MuonPlus = 10 , c_MuonMinus = 11 }
	Hypothesis number. More...

enum	IdentifierBits { c_OutcomeBit = 7 , c_LastLayerBit = 4 , c_DetectorBit = 2 , c_DegreesOfFreedomBit = 6 }
	Bits used for unique identifiers in getLongitudinalID() and in getTransverseID(). More...

Public Member Functions
	MuidElementNumbers ()
	Constructor.

	~MuidElementNumbers ()
	Destructor.

Static Public Member Functions
static bool	checkExtrapolationOutcome (unsigned int outcome, int lastLayer)
	Check the track extrapolation outcome.

static unsigned int	calculateExtrapolationOutcome (bool isForward, bool escaped, int lastBarrelLayer, int lastEndcapLayer)
	Calculate the track extrapolation outcome.

static Hypothesis	calculateHypothesisFromPDG (int pdg)
	Calculate hypothesis number from PDG code.

static constexpr int	getMaximalBarrelLayer ()
	Get maximal barrel layer number (0-based).

static constexpr int	getMaximalEndcapForwardLayer ()
	Get maximal endcap-forward layer number (0-based).

static constexpr int	getMaximalEndcapBackwardLayer ()
	Get maximal endcap-forward layer number (0-based).

static constexpr int	getMaximalOutcome ()
	Get maximal value of the track extrapolation outcome.

static constexpr int	getMaximalDetector ()
	Get maximal value of the detector selector (for transverse scattering).

static constexpr int	getMaximalHalfNdof ()
	Get maximal value of NDof/2 (for transverse scattering).

static constexpr int	getSizeReducedChiSquared ()
	Get size of array with reduced chi-squared values (for transverse scattering).

static constexpr double	getMaximalReducedChiSquared ()
	Get maximal value of reduced chi-squared (for transverse scattering).

static std::vector< int >	getPDGVector (int charge)
	Get a vector with all the hypothesis PDG codes used for Muid.

static std::vector< int >	getPDGVector ()
	Get a vector with all the hypothesis PDG codes used for Muid.

static int	getLongitudinalID (int hypothesis, int outcome, int lastLayer)
	Get the unique longitudinal identifier for given hypothesis, outcome and last layer crossed.

static int	getTransverseID (int hypothesis, int detector, int degreesOfFreedom)
	Get the unique transverse identifier for given hypothesis, detector and degrees of freedom.

Static Protected Attributes
static constexpr int	m_MaximalBarrelLayer = BKLMElementNumbers::getMaximalLayerNumber() - 1
	Maximal barrel layer number (0-based).

static constexpr int	m_MaximalEndcapForwardLayer = EKLMElementNumbers::getMaximalLayerNumber() - 1
	Maximal endcap-forward layer number (0-based).

static constexpr int	m_MaximalEndcapBackwardLayer = m_MaximalEndcapForwardLayer - 2
	Maximal endcap-backward layer number (0-based).

static constexpr int	m_MaximalOutcome = c_CrossBarrelExitBackwardMax
	Maximal value of the outcome extrapolation.

static constexpr int	m_MaximalDetector = c_OnlyEndcap
	Maximal value of the detector selector (for transverse scattering).

static constexpr int	m_MaximalHalfNDof = 18
	Maximal value of NDof/2 (for transverse scattering).

static constexpr int	m_SizeReducedChiSquared = 100
	Size of array with reduced chi-squared values (for transverse scattering).

static constexpr double	m_MaximalReducedChiSquared = 10.
	Maximal value of reduced chi-squared (for transverse scattering).

Detailed Description

Muid element numbers.

Definition at line 28 of file MuidElementNumbers.h.

Member Enumeration Documentation

◆ DetectorsCrossed

enum DetectorsCrossed

Labels for detectors crossed.

Definition at line 56 of file MuidElementNumbers.h.

                          {
      c_Both = 0,
      c_OnlyBarrel = KLMElementNumbers::c_BKLM,
      c_OnlyEndcap = KLMElementNumbers::c_EKLM,
    };

◆ Hypothesis

enum Hypothesis

Hypothesis number.

Definition at line 65 of file MuidElementNumbers.h.

                    {
      c_NotValid = -1,
      c_Positron = 0,
      c_Electron = 1,
      c_Deuteron = 2,
      c_AntiDeuteron = 3,
      c_Proton = 4,
      c_AntiProton = 5,
      c_PionPlus = 6,
      c_PionMinus = 7,
      c_KaonPlus = 8,
      c_KaonMinus = 9,
      c_MuonPlus = 10,
      c_MuonMinus = 11,
    };

◆ IdentifierBits

enum IdentifierBits

Bits used for unique identifiers in getLongitudinalID() and in getTransverseID().

Enumerator
c_OutcomeBit	Number of bits occupied by outcome in getLongitudinalID().
c_LastLayerBit	Number of bits occupied by lastLayer in getLongitudinalID().
c_DetectorBit	Number of bits occupied by detector in getTransverseID().
c_DegreesOfFreedomBit	Number of bits occupied by degreesOfFreedom in getTransverseID().

Definition at line 84 of file MuidElementNumbers.h.

                        {
      c_OutcomeBit = 7,
      c_LastLayerBit = 4,
      c_DetectorBit = 2,
      c_DegreesOfFreedomBit = 6
    };

◆ Outcome

enum Outcome

Outcome of the track extrapolation.

Definition at line 35 of file MuidElementNumbers.h.

                 {
      c_NotReached = 0,
      c_StopInBarrel = 1,
      c_StopInForwardEndcap = 2,
      c_ExitBarrel = 3,
      c_ExitForwardEndcap = 4,
      c_StopInBackwardEndcap = 5,
      c_ExitBackwardEndcap = 6,
      c_CrossBarrelStopInForwardMin = 7,
      c_CrossBarrelStopInForwardMax = 21,
      c_CrossBarrelStopInBackwardMin = 22,
      c_CrossBarrelStopInBackwardMax = 36,
      c_CrossBarrelExitForwardMin = 37,
      c_CrossBarrelExitForwardMax = 51,
      c_CrossBarrelExitBackwardMin = 52,
      c_CrossBarrelExitBackwardMax = 66
    };

Constructor & Destructor Documentation

◆ MuidElementNumbers()

MuidElementNumbers ( )

Constructor.

Definition at line 17 of file MuidElementNumbers.cc.

18{

19}

◆ ~MuidElementNumbers()

~MuidElementNumbers ( )

Destructor.

Definition at line 21 of file MuidElementNumbers.cc.

22{

23}

Member Function Documentation

◆ calculateExtrapolationOutcome()

unsigned int calculateExtrapolationOutcome	(	bool	isForward,
		bool	escaped,
		int	lastBarrelLayer,
		int	lastEndcapLayer
	)

static

Calculate the track extrapolation outcome.

Parameters

[in]	isForward	Forward or backward.
[in]	escaped	Escaped or not from KLM volumes.
[in]	lastBarrelLayer	Last barrel layer crossed during the extrapolation.
[in]	lastEndcapLayer	Last endcap layer crossed during the extrapolation.

Definition at line 77 of file MuidElementNumbers.cc.

{
  unsigned int outcome = MuidElementNumbers::c_NotReached;
  if ((lastBarrelLayer >= 0) || (lastEndcapLayer >= 0)) {
    /* Stop or exit in barrel. */
    if (lastEndcapLayer < 0) {
      if (escaped)
        outcome = MuidElementNumbers::c_ExitBarrel;
      else
        outcome = MuidElementNumbers::c_StopInBarrel;
    }
    /* Stop or exit in endcap. */
    else {
      if (escaped) {
        if (lastBarrelLayer < 0) { /* Exit in endcap with no barrel hits. */
          if (isForward)
            outcome = MuidElementNumbers::c_ExitForwardEndcap;
          else
            outcome = MuidElementNumbers::c_ExitBackwardEndcap;
        } else { /* Exit in endcap with barrel hits. */
          if (isForward)
            outcome = MuidElementNumbers::c_CrossBarrelExitForwardMin + lastBarrelLayer;
          else
            outcome = MuidElementNumbers::c_CrossBarrelExitBackwardMin + lastBarrelLayer;
        }
      } else {
        if (lastBarrelLayer < 0) { /* Stop in endcap with no barrel hits. */
          if (isForward)
            outcome = MuidElementNumbers::c_StopInForwardEndcap;
          else
            outcome = MuidElementNumbers::c_StopInBackwardEndcap;
        } else { /* Stop in endcap with barrel hits. */
          if (isForward)
            outcome = MuidElementNumbers::c_CrossBarrelStopInForwardMin + lastBarrelLayer;
          else
            outcome = MuidElementNumbers::c_CrossBarrelStopInBackwardMin + lastBarrelLayer;
        }
      }
    }
  }
  return outcome;
}

◆ calculateHypothesisFromPDG()

MuidElementNumbers::Hypothesis calculateHypothesisFromPDG ( int pdg )

static

Calculate hypothesis number from PDG code.

Parameters

[in] pdg PDG code.

Definition at line 121 of file MuidElementNumbers.cc.

{
  /* For leptons, the sign of the PDG code is opposite to the charge. */
  if (pdg == Const::electron.getPDGCode())
    return MuidElementNumbers::c_Electron;
  if (pdg == -Const::electron.getPDGCode())
    return MuidElementNumbers::c_Positron;
  if (pdg == Const::muon.getPDGCode())
    return MuidElementNumbers::c_MuonMinus;
  if (pdg == -Const::muon.getPDGCode())
    return MuidElementNumbers::c_MuonPlus;
  /* For hadrons, the sign of the PDG code is equal to the charge. */
  if (pdg == Const::deuteron.getPDGCode())
    return MuidElementNumbers::c_Deuteron;
  if (pdg == -Const::deuteron.getPDGCode())
    return MuidElementNumbers::c_AntiDeuteron;
  if (pdg == Const::proton.getPDGCode())
    return MuidElementNumbers::c_Proton;
  if (pdg == -Const::proton.getPDGCode())
    return MuidElementNumbers::c_AntiProton;
  if (pdg == Const::pion.getPDGCode())
    return MuidElementNumbers::c_PionPlus;
  if (pdg == -Const::pion.getPDGCode())
    return MuidElementNumbers::c_PionMinus;
  if (pdg == Const::kaon.getPDGCode())
    return MuidElementNumbers::c_KaonPlus;
  if (pdg == -Const::kaon.getPDGCode())
    return MuidElementNumbers::c_KaonMinus;
  /* Only charged final state particles are supported. */
  return MuidElementNumbers::c_NotValid;
}

◆ checkExtrapolationOutcome()

bool checkExtrapolationOutcome	(	unsigned int	outcome,
		int	lastLayer
	)

static

Check the track extrapolation outcome.

Parameters

[in]	outcome	Track extrapolation outcome.
[in]	lastLayer	Last layer crossed during the extrapolation.

Definition at line 25 of file MuidElementNumbers.cc.

{
  /* KLM volume not reached during the extrapolation. */
  if (outcome == MuidElementNumbers::c_NotReached)
    return false;
  /* Barrel stop: never in layer 14. */
  if ((outcome == MuidElementNumbers::c_StopInBarrel)
      && (lastLayer > MuidElementNumbers::getMaximalBarrelLayer() - 1))
    return false;
  /* Forward endcap stop: never in layer 13. */
  if ((outcome == MuidElementNumbers::c_StopInForwardEndcap)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapForwardLayer() - 1))
    return false;
  /* Barrel exit: no layers greater than 15. */
  if ((outcome == MuidElementNumbers::c_ExitBarrel)
      && (lastLayer > MuidElementNumbers::getMaximalBarrelLayer()))
    return false;
  /* Forward endcap exit: no layers greater than 14. */
  if ((outcome == MuidElementNumbers::c_ExitForwardEndcap)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapForwardLayer()))
    return false;
  /* Backward endcap stop: never in layer 11. */
  if ((outcome == MuidElementNumbers::c_StopInBackwardEndcap)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapBackwardLayer() - 1))
    return false;
  /* Backward endcap exit: no layers greater than 12. */
  if ((outcome == MuidElementNumbers::c_ExitBackwardEndcap)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapBackwardLayer()))
    return false;
  /* Like outcome == c_StopInForwardEndcap. */
  if ((outcome >= MuidElementNumbers::c_CrossBarrelStopInForwardMin)
      && (outcome <= MuidElementNumbers::c_CrossBarrelStopInForwardMax)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapForwardLayer() - 1))
    return false;
  /* Like outcome == c_StopInBackwardEndcap. */
  if ((outcome >= MuidElementNumbers::c_CrossBarrelStopInBackwardMin)
      && (outcome <= MuidElementNumbers::c_CrossBarrelStopInBackwardMax)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapBackwardLayer() - 1))
    return false;
  /* Like outcome == c_ExitForwardEndcap. */
  if ((outcome >= MuidElementNumbers::c_CrossBarrelExitForwardMin)
      && (outcome <= MuidElementNumbers::c_CrossBarrelExitForwardMax)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapForwardLayer()))
    return false;
  /* Like outcome == c_ExitBackwardEndcap. */
  if ((outcome >= MuidElementNumbers::c_CrossBarrelExitBackwardMin)
      && (outcome <= MuidElementNumbers::c_CrossBarrelExitBackwardMax)
      && (lastLayer > MuidElementNumbers::getMaximalEndcapBackwardLayer()))
    return false;
  return true;
}

◆ getLongitudinalID()

int getLongitudinalID	(	int	hypothesis,
		int	outcome,
		int	lastLayer
	)

static

Get the unique longitudinal identifier for given hypothesis, outcome and last layer crossed.

bits 0-3 for hypothesis; bits 4-10 for outcome; bits 11-14 for last layer crossed.

Parameters

[in]	hypothesis	Hypothesis number.
[in]	outcome	Track extrapolation outcome.
[in]	lastLayer	Last layer crossed during the extrapolation..

Definition at line 174 of file MuidElementNumbers.cc.

{
  int id = lastLayer;
  id += (outcome << MuidElementNumbers::c_LastLayerBit);
  id += (hypothesis << (MuidElementNumbers::c_LastLayerBit + MuidElementNumbers::c_OutcomeBit));
  return id;
}

◆ getMaximalBarrelLayer()

static constexpr int getMaximalBarrelLayer ( )

inlinestaticconstexpr

Get maximal barrel layer number (0-based).

Definition at line 130 of file MuidElementNumbers.h.

    {
      return m_MaximalBarrelLayer;
    }

◆ getMaximalDetector()

static constexpr int getMaximalDetector ( )

inlinestaticconstexpr

Get maximal value of the detector selector (for transverse scattering).

Definition at line 162 of file MuidElementNumbers.h.

    {
      return m_MaximalDetector;
    }

◆ getMaximalEndcapBackwardLayer()

static constexpr int getMaximalEndcapBackwardLayer ( )

inlinestaticconstexpr

Get maximal endcap-forward layer number (0-based).

Definition at line 146 of file MuidElementNumbers.h.

    {
      return m_MaximalEndcapBackwardLayer;
    }

◆ getMaximalEndcapForwardLayer()

static constexpr int getMaximalEndcapForwardLayer ( )

inlinestaticconstexpr

Get maximal endcap-forward layer number (0-based).

Definition at line 138 of file MuidElementNumbers.h.

    {
      return m_MaximalEndcapForwardLayer;
    }

◆ getMaximalHalfNdof()

static constexpr int getMaximalHalfNdof ( )

inlinestaticconstexpr

Get maximal value of NDof/2 (for transverse scattering).

Definition at line 170 of file MuidElementNumbers.h.

    {
      return m_MaximalHalfNDof;
    }

◆ getMaximalOutcome()

static constexpr int getMaximalOutcome ( )

inlinestaticconstexpr

Get maximal value of the track extrapolation outcome.

Definition at line 154 of file MuidElementNumbers.h.

    {
      return m_MaximalOutcome;
    }

◆ getMaximalReducedChiSquared()

static constexpr double getMaximalReducedChiSquared ( )

inlinestaticconstexpr

Get maximal value of reduced chi-squared (for transverse scattering).

Definition at line 186 of file MuidElementNumbers.h.

    {
      return m_MaximalReducedChiSquared;
    }

◆ getPDGVector() [1/2]

std::vector< int > getPDGVector ( )

static

Get a vector with all the hypothesis PDG codes used for Muid.

Both positive and negative charges are returned.

Definition at line 165 of file MuidElementNumbers.cc.

{
  std::vector<int> pdgVector = getPDGVector(1);
  std::vector<int> temp = getPDGVector(-1);
  pdgVector.insert(pdgVector.end(), temp.begin(), temp.end());
  std::sort(pdgVector.begin(), pdgVector.end());
  return pdgVector;
}

◆ getPDGVector() [2/2]

std::vector< int > getPDGVector ( int charge )

static

Get a vector with all the hypothesis PDG codes used for Muid.

Only the codes of the selected charge are returned.

Parameters

[in] charge Only codes of the selected charge are returned.

Definition at line 153 of file MuidElementNumbers.cc.

{
  std::vector<int> pdgVector;
  for (const Const::ChargedStable particle : Const::chargedStableSet) {
    if ((particle == Const::electron) || (particle == Const::muon))
      pdgVector.push_back(-charge * particle.getPDGCode());
    else
      pdgVector.push_back(charge * particle.getPDGCode());
  }
  return pdgVector;
}

◆ getSizeReducedChiSquared()

static constexpr int getSizeReducedChiSquared ( )

inlinestaticconstexpr

Get size of array with reduced chi-squared values (for transverse scattering).

Definition at line 178 of file MuidElementNumbers.h.

    {
      return m_SizeReducedChiSquared;
    }

◆ getTransverseID()

int getTransverseID	(	int	hypothesis,
		int	detector,
		int	degreesOfFreedom
	)

static

Get the unique transverse identifier for given hypothesis, detector and degrees of freedom.

bit 0-3 for hypothesis; bit 4-5 for detector; bit 6-11 for degrees of freedom.

Parameters

[in]	hypothesis	Hypothesis number.
[in]	detector	Detector number.
[in]	degreesOfFreedom	Number of degrees of freedom.

Definition at line 182 of file MuidElementNumbers.cc.

{
  int id = degreesOfFreedom;
  id += (detector << MuidElementNumbers::c_DegreesOfFreedomBit);
  id += (hypothesis << (MuidElementNumbers::c_DegreesOfFreedomBit + MuidElementNumbers::c_DetectorBit));
  return id;
}

Member Data Documentation

◆ m_MaximalBarrelLayer

constexpr int m_MaximalBarrelLayer = BKLMElementNumbers::getMaximalLayerNumber() - 1

staticconstexprprotected

Maximal barrel layer number (0-based).

Definition at line 229 of file MuidElementNumbers.h.

◆ m_MaximalDetector

constexpr int m_MaximalDetector = c_OnlyEndcap

staticconstexprprotected

Maximal value of the detector selector (for transverse scattering).

Definition at line 241 of file MuidElementNumbers.h.

◆ m_MaximalEndcapBackwardLayer

constexpr int m_MaximalEndcapBackwardLayer = m_MaximalEndcapForwardLayer - 2

staticconstexprprotected

Maximal endcap-backward layer number (0-based).

Definition at line 235 of file MuidElementNumbers.h.

◆ m_MaximalEndcapForwardLayer

constexpr int m_MaximalEndcapForwardLayer = EKLMElementNumbers::getMaximalLayerNumber() - 1

staticconstexprprotected

Maximal endcap-forward layer number (0-based).

Definition at line 232 of file MuidElementNumbers.h.

◆ m_MaximalHalfNDof

constexpr int m_MaximalHalfNDof = 18

staticconstexprprotected

Maximal value of NDof/2 (for transverse scattering).

Definition at line 244 of file MuidElementNumbers.h.

◆ m_MaximalOutcome

constexpr int m_MaximalOutcome = c_CrossBarrelExitBackwardMax

staticconstexprprotected

Maximal value of the outcome extrapolation.

Definition at line 238 of file MuidElementNumbers.h.

◆ m_MaximalReducedChiSquared

constexpr double m_MaximalReducedChiSquared = 10.

staticconstexprprotected

Maximal value of reduced chi-squared (for transverse scattering).

Definition at line 250 of file MuidElementNumbers.h.

◆ m_SizeReducedChiSquared

constexpr int m_SizeReducedChiSquared = 100

staticconstexprprotected

Size of array with reduced chi-squared values (for transverse scattering).

Definition at line 247 of file MuidElementNumbers.h.

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

klm/muid/include/MuidElementNumbers.h
klm/muid/src/MuidElementNumbers.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ DetectorsCrossed

◆ Hypothesis

◆ IdentifierBits

◆ Outcome

Constructor & Destructor Documentation

◆ MuidElementNumbers()

◆ ~MuidElementNumbers()

Member Function Documentation

◆ calculateExtrapolationOutcome()

◆ calculateHypothesisFromPDG()

◆ checkExtrapolationOutcome()

◆ getLongitudinalID()

◆ getMaximalBarrelLayer()

◆ getMaximalDetector()

◆ getMaximalEndcapBackwardLayer()

◆ getMaximalEndcapForwardLayer()

◆ getMaximalHalfNdof()

◆ getMaximalOutcome()

◆ getMaximalReducedChiSquared()

◆ getPDGVector() [1/2]

◆ getPDGVector() [2/2]

◆ getSizeReducedChiSquared()

◆ getTransverseID()

Member Data Documentation

◆ m_MaximalBarrelLayer

◆ m_MaximalDetector

◆ m_MaximalEndcapBackwardLayer

◆ m_MaximalEndcapForwardLayer

◆ m_MaximalHalfNDof

◆ m_MaximalOutcome

◆ m_MaximalReducedChiSquared

◆ m_SizeReducedChiSquared