Muon::MuonStationIndex Namespace Reference

Enumerations
enum	ChIndex : int8_t {   ChIndex::ChUnknown = -1, ChIndex::BIS, ChIndex::BIL, ChIndex::BMS,   ChIndex::BML, ChIndex::BOS, ChIndex::BOL, ChIndex::BEE,   ChIndex::EIS, ChIndex::EIL, ChIndex::EMS, ChIndex::EML,   ChIndex::EOS, ChIndex::EOL, ChIndex::EES, ChIndex::EEL,   ChIndex::CSS, ChIndex::CSL, ChIndex::ChIndexMax }
	enum to classify the different chamber layers in the muon spectrometer More...
enum	StIndex : int8_t {   StIndex::StUnknown = -1, StIndex::BI, StIndex::BM, StIndex::BO,   StIndex::BE, StIndex::EI, StIndex::EM, StIndex::EO,   StIndex::EE, StIndex::StIndexMax }
	enum to classify the different station layers in the muon spectrometer More...
enum	PhiIndex : int8_t {   PhiIndex::PhiUnknown = -1, PhiIndex::BI1, PhiIndex::BI2, PhiIndex::BM1,   PhiIndex::BM2, PhiIndex::BO1, PhiIndex::BO2, PhiIndex::T1,   PhiIndex::T2, PhiIndex::T3, PhiIndex::T4, PhiIndex::CSC,   PhiIndex::STGC1, PhiIndex::STGC2, PhiIndex::PhiIndexMax }
	enum to classify the different phi layers in the muon spectrometer More...
enum	LayerIndex : int8_t {   LayerIndex::LayerUnknown = -1, LayerIndex::Inner, LayerIndex::Middle, LayerIndex::Outer,   LayerIndex::Extended, LayerIndex::BarrelExtended, LayerIndex::LayerIndexMax }
	enum to classify the different layers in the muon spectrometer More...
enum	DetectorRegionIndex : int8_t {   DetectorRegionIndex::DetectorRegionUnknown = -1, DetectorRegionIndex::EndcapA, DetectorRegionIndex::Barrel, DetectorRegionIndex::EndcapC,   DetectorRegionIndex::DetectorRegionIndexMax }
	enum to classify the different layers in the muon spectrometer More...
enum	TechnologyIndex : int8_t {   TechnologyIndex::TechnologyUnknown = -1, TechnologyIndex::MDT, TechnologyIndex::CSC, TechnologyIndex::RPC,   TechnologyIndex::TGC, TechnologyIndex::STGC, TechnologyIndex::MM, TechnologyIndex::TechnologyIndexMax }
	enum to classify the different layers in the muon spectrometer More...

Functions
template<typename EnumType >
constexpr int	toInt (const EnumType enumVal)
StIndex	toStationIndex (ChIndex index)
	convert ChIndex into StIndex More...
LayerIndex	toLayerIndex (ChIndex index)
	convert ChIndex into LayerIndex More...
LayerIndex	toLayerIndex (StIndex index)
	convert StIndex into LayerIndex More...
StIndex	toStationIndex (DetectorRegionIndex region, LayerIndex layer)
	convert DetectorRegionIndex + LayerIndex into StIndex More...
ChIndex	toChamberIndex (DetectorRegionIndex region, LayerIndex layer, bool isSmall)
	convert DetectorRegionIndex + LayerIndex + isSmall into ChIndex More...
bool	isBarrel (const ChIndex index)
	Returns true if the chamber index points to a barrel chamber. More...
bool	isBarrel (const StIndex index)
	Returns true if the station index points to a barrel chamber. More...
bool	isSmall (const ChIndex index)
	Returns true if the chamber index is in a small sector. More...
ChIndex	toChamberIndex (StIndex stIndex, bool isSmall)
	convert StIndex + isSmall into ChIndex More...
const std::string &	phiName (PhiIndex index)
	convert PhiIndex into a string More...
const std::string &	stName (StIndex index)
	convert StIndex into a string More...
const std::string &	chName (ChIndex index)
	convert ChIndex into a string More...
const std::string &	regionName (DetectorRegionIndex index)
	convert DetectorRegionIndex into a string More...
const std::string &	layerName (LayerIndex index)
	convert LayerIndex into a string More...
const std::string &	technologyName (TechnologyIndex index)
	convert LayerIndex into a string More...
unsigned int	sectorLayerHash (DetectorRegionIndex detectorRegionIndex, LayerIndex layerIndex)
	create a hash out of region and layer More...
constexpr unsigned int	sectorLayerHashMax ()
	maximum create a hash out of region and layer More...
std::pair< DetectorRegionIndex, LayerIndex >	decomposeSectorLayerHash (unsigned int hash)
	decompose the hash into Region and Layer More...
constexpr unsigned	numberOfSectors ()
	return total number of sectors More...
ChIndex	chIndex (const std::string &index)
	convert ChIndex name string to enum More...

Enumeration Type Documentation

ChIndex

enum Muon::MuonStationIndex::ChIndex : int8_t

strong

enum to classify the different chamber layers in the muon spectrometer

Enumerator
ChUnknown
BIS
BIL
BMS
BML
BOS
BOL
BEE
EIS
EIL
EMS
EML
EOS
EOL
EES
EEL
CSS
CSL
ChIndexMax

Definition at line 15 of file MuonStationIndex.h.

                      : int8_t {
      ChUnknown = -1,
      BIS, BIL, BMS, BML, BOS, BOL, BEE,
      EIS, EIL, EMS, EML, EOS, EOL, EES, EEL, CSS, CSL,
      ChIndexMax
    };

DetectorRegionIndex

enum Muon::MuonStationIndex::DetectorRegionIndex : int8_t

strong

enum to classify the different layers in the muon spectrometer

Enumerator
DetectorRegionUnknown
EndcapA
Barrel
EndcapC
DetectorRegionIndexMax

Definition at line 47 of file MuonStationIndex.h.

                                  : int8_t {
      DetectorRegionUnknown = -1,
      EndcapA, Barrel, EndcapC,
      DetectorRegionIndexMax 
    };    

LayerIndex

enum Muon::MuonStationIndex::LayerIndex : int8_t

strong

enum to classify the different layers in the muon spectrometer

Enumerator
LayerUnknown
Inner
Middle
Outer
Extended
BarrelExtended	EE.
LayerIndexMax	BEE.

Definition at line 38 of file MuonStationIndex.h.

                         : int8_t {
      LayerUnknown = -1,
      Inner, Middle, Outer, 
      Extended,       
      BarrelExtended, 
      LayerIndexMax
    };

PhiIndex

enum Muon::MuonStationIndex::PhiIndex : int8_t

strong

enum to classify the different phi layers in the muon spectrometer

Enumerator
PhiUnknown
BI1
BI2
BM1
BM2
BO1
BO2
T1
T2
T3
T4
CSC
STGC1
STGC2
PhiIndexMax

Definition at line 31 of file MuonStationIndex.h.

                       : int8_t {
      PhiUnknown = -1,
      BI1, BI2, BM1, BM2, BO1, BO2, T1, T2, T3, T4, CSC, STGC1, STGC2,
      PhiIndexMax
    };

StIndex

enum Muon::MuonStationIndex::StIndex : int8_t

strong

enum to classify the different station layers in the muon spectrometer

Enumerator
StUnknown
BI
BM
BO
BE
EI
EM
EO
EE
StIndexMax

Definition at line 23 of file MuonStationIndex.h.

                      : int8_t {
      StUnknown = -1,
      BI, BM, BO, BE,
      EI, EM, EO, EE,
      StIndexMax
    };

TechnologyIndex

enum Muon::MuonStationIndex::TechnologyIndex : int8_t

strong

enum to classify the different layers in the muon spectrometer

Enumerator
TechnologyUnknown
MDT
CSC
RPC
TGC
STGC
MM
TechnologyIndexMax

Definition at line 54 of file MuonStationIndex.h.

                              : int8_t {
      TechnologyUnknown = -1,
      MDT, CSC, RPC, TGC, STGC, MM,
      TechnologyIndexMax  
    };    

Function Documentation

chIndex()

ChIndex Muon::MuonStationIndex::chIndex

(

const std::string &

index

)

convert ChIndex name string to enum

Definition at line 11 of file MuonStationIndex.cxx.

                                            {
      if( index == "BIL" ) {
         return ChIndex::BIL;
      } else if( index == "BMS" ) {
         return ChIndex::BMS;
      } else if( index == "BIS" ) {
         return ChIndex::BIS;
      } else if( index == "BML" ) {
         return ChIndex::BML;
      } else if( index == "BOS" ) {
         return ChIndex::BOS;
      } else if( index == "BOL" ) {
         return ChIndex::BOL;
      } else if( index == "BEE" ) {
         return ChIndex::BEE;
      } else if( index == "EIS" ) {
         return ChIndex::EIS;
      } else if( index == "EIL" ) {
         return ChIndex::EIL;
      } else if( index == "EMS" ) {
         return ChIndex::EMS;
      } else if( index == "EML" ) {
         return ChIndex::EML;
      } else if( index == "EOS" ) {
         return ChIndex::EOS;
      } else if( index == "EOL" ) {
         return ChIndex::EOL;
      } else if( index == "EES" ) {
         return ChIndex::EES;
      } else if( index == "EEL" ) {
         return ChIndex::EEL;
      } else if( index == "CSS" ) {
         return ChIndex::CSS;
      } else if( index == "CSL" ) {
         return ChIndex::CSL;
      } 
      return ChIndex::ChUnknown; 
   }

chName()

const std::string & Muon::MuonStationIndex::chName

(

ChIndex

index

)

convert ChIndex into a string

Definition at line 119 of file MuonStationIndex.cxx.

                                            {
      static const std::array<std::string, toInt(ChIndex::ChIndexMax)> chamberIndexNames {
         "BIS", "BIL", "BMS", "BML", "BOS", "BOL", "BEE",
         "EIS", "EIL", "EMS", "EML", "EOS", "EOL", "EES",
         "EEL", "CSS", "CSL"
      };
 
      if( index == ChIndex::ChUnknown ) {
         static const std::string dummy{"ChUnknown"};
         return dummy;
      }
      if( index >= ChIndex::ChIndexMax ) {
         static const std::string dummy{"ChOutOfRange"};
         return dummy;
      }
      return chamberIndexNames[toInt(index)];
   }

decomposeSectorLayerHash()

std::pair<DetectorRegionIndex,LayerIndex> Muon::MuonStationIndex::decomposeSectorLayerHash

(

unsigned int

hash

)

decompose the hash into Region and Layer

isBarrel() [1/2]

bool Muon::MuonStationIndex::isBarrel

(

const ChIndex

index

)

Returns true if the chamber index points to a barrel chamber.

isBarrel() [2/2]

bool Muon::MuonStationIndex::isBarrel

(

const StIndex

index

)

Returns true if the station index points to a barrel chamber.

isSmall()

bool Muon::MuonStationIndex::isSmall

(

const ChIndex

index

)

Returns true if the chamber index is in a small sector.

layerName()

const std::string & Muon::MuonStationIndex::layerName

(

LayerIndex

index

)

convert LayerIndex into a string

Definition at line 153 of file MuonStationIndex.cxx.

                                                  {
      static const std::array<std::string, toInt(LayerIndex::LayerIndexMax)> layerIndexNames {
         "Inner", "Middle", "Outer", "Extended", "BarrelExtended"};
 
      if( index == LayerIndex::LayerUnknown ) {
         static const std::string dummy{"LayerUnknown"};
         return dummy;
      }
      if( index >= LayerIndex::LayerIndexMax) {
         static const std::string dummy{"LayerOutOfRange"};
         return dummy;
      }
      return layerIndexNames[toInt(index)];
   }

numberOfSectors()

constexpr unsigned Muon::MuonStationIndex::numberOfSectors ( )

constexpr

return total number of sectors

Definition at line 118 of file MuonStationIndex.h.

{ return 16; }

phiName()

const std::string & Muon::MuonStationIndex::phiName

(

PhiIndex

index

)

convert PhiIndex into a string

Definition at line 87 of file MuonStationIndex.cxx.

                                              { 
      static const std::array<std::string, toInt(PhiIndex::PhiIndexMax)> phiIndexNames = {
         "BI1", "BI2", "BM1", "BM2", "BO1", "BO2", "T1", "T2", "T3", "T4", "CSC", "STGC1",
         "STGC2"
      };
 
      if(index == PhiIndex::PhiUnknown ) {
         static const std::string dummy{"PhiUnknown"};
         return dummy;
      }
      if(index >= PhiIndex::PhiIndexMax) {
         static const std::string dummy{"PhiOutOfRange"};
         return dummy;
      }
      return phiIndexNames[toInt(index)];
   }

regionName()

const std::string & Muon::MuonStationIndex::regionName

(

DetectorRegionIndex

index

)

convert DetectorRegionIndex into a string

Definition at line 138 of file MuonStationIndex.cxx.

                                           {
      static const std::array<std::string, toInt(DetectorRegionIndex::DetectorRegionIndexMax)> detectorRegionIndexNames {
         "EndcapA", "Barrel", "EndcapC"};
 
      if( index == DetectorRegionIndex::DetectorRegionUnknown ) {
         static const std::string dummy( "DetectorRegionUnknown" );
         return dummy;
      }
      if( index >= DetectorRegionIndex::DetectorRegionIndexMax ) {
         static const std::string dummy( "DetectorRegionIndexMax" );
         return dummy;
      }
      return detectorRegionIndexNames[ toInt(index) ];
   }

sectorLayerHash()

unsigned int Muon::MuonStationIndex::sectorLayerHash	(	DetectorRegionIndex	detectorRegionIndex,
		LayerIndex	layerIndex
	)

create a hash out of region and layer

sectorLayerHashMax()

constexpr unsigned int Muon::MuonStationIndex::sectorLayerHashMax ( )

constexpr

maximum create a hash out of region and layer

Definition at line 110 of file MuonStationIndex.h.

                                                {
       return toInt(DetectorRegionIndex::DetectorRegionIndexMax)*toInt(LayerIndex::LayerIndexMax);
    }

stName()

const std::string & Muon::MuonStationIndex::stName

(

StIndex

index

)

convert StIndex into a string

Definition at line 104 of file MuonStationIndex.cxx.

                                            {
      static const std::array<std::string, toInt(StIndex::StIndexMax)> stationIndexNames {
         "BI", "BM", "BO", "BE", "EI", "EM", "EO", "EE"};
 
      if( index == StIndex::StUnknown ) {
         static const std::string dummy{"StUnknown"};
         return dummy;
      }
      if( index >= StIndex::StIndexMax) {
         static const std::string dummy{"StIndexMax"};
         return dummy;
      }
      return stationIndexNames[ toInt(index) ];
   }

technologyName()

const std::string & Muon::MuonStationIndex::technologyName

(

TechnologyIndex

index

)

convert LayerIndex into a string

Definition at line 169 of file MuonStationIndex.cxx.

                                           {
      using TechIdx = TechnologyIndex;
      static const std::array<std::string, toInt(TechIdx::TechnologyIndexMax)> technologyIndexNames {
         "MDT", "CSC", "RPC", "TGC", "STGC", "MM"};
 
      if( index == TechIdx::TechnologyUnknown ) {
         static const std::string dummy{"TechnologyUnknown"};
         return dummy;
      }
      if( index >= TechIdx::TechnologyIndexMax ) {
         static const std::string dummy{"TechnologyIndexMax"};
         return dummy;
      }
      return technologyIndexNames[ toInt(index) ];
   }

toChamberIndex() [1/2]

ChIndex Muon::MuonStationIndex::toChamberIndex	(	DetectorRegionIndex	region,
		LayerIndex	layer,
		bool	isSmall
	)

convert DetectorRegionIndex + LayerIndex + isSmall into ChIndex

EndCapA hash

Barrel hash column BEE is not counted for the small sectors

EndCapC hash

EndCapA hash

Barrel hash column BEE is not counted for the large sectors

EndCapC hash

EndCapA hash

Barrel hash column BEE is not counted for the small sectors

EndCapC hash

EndCapA hash

Barrel hash column BEE is not counted for the large sectors

EndCapC hash

Definition at line 63 of file MuonStationIndex.cxx.

                                                                                {
      constexpr unsigned nMax = sectorLayerHashMax();
      static constexpr std::array<ChIndex, nMax> regionLayerToChamberIndexSmall {
         ChIndex::EIS, ChIndex::EMS, ChIndex::EOS, ChIndex::EES, ChIndex::BEE,
         ChIndex::BIS, ChIndex::BMS, ChIndex::BOS, ChIndex::ChUnknown, ChIndex::ChUnknown,
         ChIndex::EIS, ChIndex::EMS, ChIndex::EOS, ChIndex::EES, ChIndex::BEE
      };
      static constexpr std::array<ChIndex, nMax> regionLayerToChamberIndexLarge {
         ChIndex::EIL, ChIndex::EML, ChIndex::EOL, ChIndex::EEL, ChIndex::ChUnknown,
         ChIndex::BIL, ChIndex::BML, ChIndex::BOL, ChIndex::ChUnknown, ChIndex::ChUnknown,
         ChIndex::EIL, ChIndex::EML, ChIndex::EOL, ChIndex::EEL, ChIndex::ChUnknown,
      };
      if( isSmall ) {
         return regionLayerToChamberIndexSmall[ sectorLayerHash(region, layer)];
      }
      return regionLayerToChamberIndexLarge[sectorLayerHash(region, layer )];
   }

toChamberIndex() [2/2]

ChIndex Muon::MuonStationIndex::toChamberIndex	(	StIndex	stIndex,
		bool	isSmall
	)

convert StIndex + isSmall into ChIndex

toInt()

template<typename EnumType >

constexpr int Muon::MuonStationIndex::toInt ( const EnumType  enumVal )

constexpr

Definition at line 61 of file MuonStationIndex.h.

                                                {
      return static_cast<int>(enumVal);
    }

toLayerIndex() [1/2]

LayerIndex Muon::MuonStationIndex::toLayerIndex

(

ChIndex

index

)

convert ChIndex into LayerIndex

toLayerIndex() [2/2]

LayerIndex Muon::MuonStationIndex::toLayerIndex

(

StIndex

index

)

convert StIndex into LayerIndex

toStationIndex() [1/2]

StIndex Muon::MuonStationIndex::toStationIndex

(

ChIndex

index

)

convert ChIndex into StIndex

toStationIndex() [2/2]

StIndex Muon::MuonStationIndex::toStationIndex	(	DetectorRegionIndex	region,
		LayerIndex	layer
	)

convert DetectorRegionIndex + LayerIndex into StIndex

Definition at line 49 of file MuonStationIndex.cxx.

                                                                          {
      constexpr unsigned nMax = sectorLayerHashMax();
      static constexpr std::array<StIndex, nMax> regionLayerToStationIndex {
         StIndex::EI, StIndex::EM, StIndex::EO,
         StIndex::EE, StIndex::BE, StIndex::BI,
         StIndex::BM, StIndex::BO, StIndex::StUnknown,
         StIndex::StUnknown,
         StIndex::EI, StIndex::EM, StIndex::EO,
         StIndex::EE, StIndex::BE
      };
      return regionLayerToStationIndex[ sectorLayerHash( region, layer ) ];
   }