Service for creating and interpreting LAr readout modules identifiers. More...

#include <LArReadoutModuleService.h>

Collaboration diagram for LArReadoutModuleService:

Public Member Functions
	~LArReadoutModuleService ()
	destructor

Static Public Member Functions
static HWIdentifier	createReadoutModuleID (int atlas_tb, int barrel_ec, int pos_neg, int em_hec_fcal, int rosId, int rodFragId, int rodCrate, int rodSlot)
	create a HWIdentifier valid parameter values atlas_tb : 0 atlas , 1 test beam barrel_ec : 0 barrel , 1 end-cap pos_neg : 0 negative eta side (C side) , 1 positive eta side (A side) em_hec_fcal : 0 em , 1 hec, 2 FCAL rosId : 0 -> 27 (EMB), 0 -> 17 (EMEC), 0 -> 2 (HEC), 0 -> 1 (FCAL) rodFragId : 0 -> 223 (EMB), 0 -> 137 (EMEC), 0 -> 23 (HEC), 0 -> 13 (FCAL) rodCrate : 1 -> 4 (EMB), 1 -> 3 (EMEC), 1 (HEC), 1 (FCAL) rodSlot : 1 -> 14 (EMB), 1 -> 13 (EMEC), 1 -> 6 (HEC), 1 -> 4 (FCAL) (reference: xls table by Fred Wickens)
static int	atlas_tb (const HWIdentifier &id)
	return 0 for ATLAS , 1 for Test Beam
static int	barrel_ec (const HWIdentifier &id)
	return location (0: barrel or 1: end cap )
static int	pos_neg (const HWIdentifier &id)
	return side positive side : 1 negative side : 0
static int	em_hec_fcal (const HWIdentifier &id)
	return subdetector em : 0, hec : 1, fcal : 2
static int	subDet (const HWIdentifier &id)
	return sub-detector identifier
static int	robFragId (const HWIdentifier &id)
	return ROB fragment identifier ( == ROL == RODFrag identifier )
static int	rol (const HWIdentifier &id)
	return ROL identifier ( == RODFrag == ROBFrag identifier )
static int	rosId (const HWIdentifier &id)
	return ROS identifier
static int	rodFragId (const HWIdentifier &id)
	return ROD fragment identifier ( == ROL == ROB identifier )
static int	rodCrate (const HWIdentifier &id)
	return ROD crate number
static int	rodSlot (const HWIdentifier &id)
	return ROD slot number
static std::string	cnvToString (const HWIdentifier &id)
	convert a HWIdentifier into a STL string
static std::string	cnvToStringTDAQ (const HWIdentifier &id)
	convert a HWIdentifier into a STL string, TDAQ convention for sub-detector numbering
static std::string	checkReadoutModuleValues (int atlas_tb, int barrel_ec, int pos_neg, int em_hec_fcal, int rosId, int rodFragId, int rodCrate, int rodSlot)

Static Private Attributes
static const unsigned int	m_atlas_tb = 1
static const unsigned int	m_barrel_ec = 2
static const unsigned int	m_pos_neg = 4
static const unsigned int	m_emhf = 8
static const unsigned int	s_rosId = 32
static const unsigned int	s_rodFragId = 1024
static const unsigned int	s_rodCrate = 262144
static const unsigned int	s_rodSlot = 1048576
static const int	s_LAR_EM_BARREL_A_SIDE = 0x41
static const int	s_LAR_EM_BARREL_C_SIDE = 0x42
static const int	s_LAR_EM_ENDCAP_A_SIDE = 0x43
static const int	s_LAR_EM_ENDCAP_C_SIDE = 0x44
static const int	s_LAR_HAD_ENDCAP_A_SIDE = 0x45
static const int	s_LAR_HAD_ENDCAP_C_SIDE = 0x46
static const int	s_LAR_FCAL_A_SIDE = 0x47
static const int	s_LAR_FCAL_C_SIDE = 0x48

Detailed Description

Service for creating and interpreting LAr readout modules identifiers.

Author: F. Ledroit

Version: 00-00-00 @stereotype interface

Definition at line 20 of file LArReadoutModuleService.h.

Constructor & Destructor Documentation

◆ ~LArReadoutModuleService()

LArReadoutModuleService::~LArReadoutModuleService ( )

inline

destructor

Definition at line 125 of file LArReadoutModuleService.h.

125{ }

Member Function Documentation

◆ atlas_tb()

int LArReadoutModuleService::atlas_tb ( const HWIdentifier & id )

static

return 0 for ATLAS , 1 for Test Beam

Definition at line 147 of file LArReadoutModuleService.cxx.

                                                               {
    return   ( ((int) l_id.get_identifier32().get_compact()) & 1 )  ;
}

◆ barrel_ec()

int LArReadoutModuleService::barrel_ec ( const HWIdentifier & id )

static

return location (0: barrel or 1: end cap )

Definition at line 151 of file LArReadoutModuleService.cxx.

                                                                {
   return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 2 ) ) >> 1 ;
}

◆ checkReadoutModuleValues()

std::string LArReadoutModuleService::checkReadoutModuleValues	(	int	atlas_tb,
		int	barrel_ec,
		int	pos_neg,
		int	em_hec_fcal,
		int	rosId,
		int	rodFragId,
		int	rodCrate,
		int	rodSlot )

static

Definition at line 61 of file LArReadoutModuleService.cxx.

{ 
    std::string l_std_str = "";
 
    if( l_atlas_tb > 1 || l_atlas_tb < 0 ) { // check of atlas_tb 
      l_std_str += std::string("atlas_tb out of range ,") ; 
    }
    if( l_barrel_ec > 1 || l_barrel_ec < 0 ) {  // check of barrel_ec
      l_std_str += std::string("barrel_ec out of range ,") ; 
    }
    if( l_pos_neg > 1 || l_pos_neg < 0 ) {  // check of pos_neg
      l_std_str += std::string("pos_neg out of range ,") ; 
    }
    if( l_em_hec_fcal > 2 || l_em_hec_fcal < 0 ) {  // check of em_hec_fcal
      l_std_str += std::string("em_hec_fcal out of range ,") ; 
    }
    // check of rodID, rodFragId, rodCrate and rodSlot
    if( l_barrel_ec == 0 && l_em_hec_fcal == 0 ) {
    // EMB
    if( l_rosId > 27 || l_rosId < 0) {
      l_std_str += std::string("rosId out of range ,") ; 
        }
    if( l_rodFragId > 223 || l_rodFragId < 0) {
      l_std_str += std::string("rodFragId out of range ,") ; 
        }
    if( l_rodCrate > 4 || l_rodCrate < 1) {
      l_std_str += std::string("rodCrate out of range ,") ; 
        }
    if( l_rodSlot > 14 || l_rodSlot < 1) {
      l_std_str += std::string("rodSlot out of range ,") ; 
        }
    } 
    if( l_barrel_ec == 1 && l_em_hec_fcal == 0 ) {
    // EMEC
    if( l_rosId > 17 || l_rosId < 0) {
      l_std_str += std::string("rosId out of range ,") ; 
        }
    if( l_rodFragId > 137 || l_rodFragId < 0) {
      l_std_str += std::string("rodFragId out of range ,") ; 
        }
    if( l_rodCrate > 3 || l_rodCrate < 1) {
      l_std_str += std::string("rodCrate out of range ,") ; 
        }
    if( l_rodSlot > 13 || l_rodSlot < 1) {
      l_std_str += std::string("rodSlot out of range ,") ; 
        }
    }
    if( l_barrel_ec == 1 && l_em_hec_fcal == 1 ) {
    // HEC
    if( l_rosId > 2 || l_rosId < 0) {
      l_std_str += std::string("rosId out of range ,") ; 
        }
    if( l_rodFragId > 23 || l_rodFragId < 0) {
      l_std_str += std::string("rodFragId out of range ,") ; 
        }
//  if( l_rodCrate > 1 || l_rodCrate < 1) {
    if( l_rodCrate > 2 || l_rodCrate < 1) {
      l_std_str += std::string("rodCrate out of range ,") ; 
        }
    if( l_rodSlot > 6 || l_rodSlot < 1) {
      l_std_str += std::string("rodSlot out of range ,") ; 
        }
    }
    if( l_barrel_ec == 1 && l_em_hec_fcal == 2 ) {
    // FCAL
    if( l_rosId > 1 || l_rosId < 0) {
      l_std_str += std::string("rosId out of range ,") ; 
        }
    if( l_rodFragId > 13 || l_rodFragId < 0) {
      l_std_str += std::string("rodFragId out of range ,") ; 
        }
    if( l_rodCrate > 2 || l_rodCrate < 1) {
//  if( l_rodCrate > 1 || l_rodCrate < 1) {
      l_std_str += std::string("rodCrate out of range ,") ; 
        }
    if( l_rodSlot > 4 || l_rodSlot < 1) {
      l_std_str += std::string("rodSlot out of range ,") ; 
        }
    }
 
 
  return l_std_str;
 
}

◆ cnvToString()

std::string LArReadoutModuleService::cnvToString ( const HWIdentifier & id )

static

convert a HWIdentifier into a STL string

Definition at line 226 of file LArReadoutModuleService.cxx.

                                                                      { 
    char * l_str = new char[200] ; 
    sprintf( l_str , "atlas_tb : %d, barrel_ec : %d, pos_neg: %d, em_hec_fcal: %d, rosId: %d, rodFragId: %d, rodCrate: %d, rodSlot: %d ", 
             atlas_tb(id) , barrel_ec(id) , pos_neg(id) , em_hec_fcal(id) , rosId(id) , rodFragId(id), rodCrate(id), rodSlot(id) ) ;
    std::string str(l_str);
    delete[] l_str ;
    return str ;
 
}

◆ cnvToStringTDAQ()

std::string LArReadoutModuleService::cnvToStringTDAQ ( const HWIdentifier & id )

static

convert a HWIdentifier into a STL string, TDAQ convention for sub-detector numbering

Definition at line 236 of file LArReadoutModuleService.cxx.

                                                                          { 
    char * l_str = new char[200] ; 
    sprintf( l_str , "atlas_tb : %d, subDet : %x, rosId: %d, rodFragId: %d, rodCrate: %d, rodSlot: %d ", 
             atlas_tb(id) , subDet(id) , rosId(id) , rodFragId(id), rodCrate(id), rodSlot(id) ) ;
    std::string str(l_str);
    delete[] l_str ;
    return str ;
 
}

◆ createReadoutModuleID()

HWIdentifier LArReadoutModuleService::createReadoutModuleID	(	int	atlas_tb,
		int	barrel_ec,
		int	pos_neg,
		int	em_hec_fcal,
		int	rosId,
		int	rodFragId,
		int	rodCrate,
		int	rodSlot )

static

create a HWIdentifier

valid parameter values
atlas_tb : 0 atlas , 1 test beam
barrel_ec : 0 barrel , 1 end-cap
pos_neg : 0 negative eta side (C side) , 1 positive eta side (A side)
em_hec_fcal : 0 em , 1 hec, 2 FCAL
rosId : 0 -> 27 (EMB), 0 -> 17 (EMEC), 0 -> 2 (HEC), 0 -> 1 (FCAL) rodFragId : 0 -> 223 (EMB), 0 -> 137 (EMEC), 0 -> 23 (HEC), 0 -> 13 (FCAL) rodCrate : 1 -> 4 (EMB), 1 -> 3 (EMEC), 1 (HEC), 1 (FCAL) rodSlot : 1 -> 14 (EMB), 1 -> 13 (EMEC), 1 -> 6 (HEC), 1 -> 4 (FCAL)

(reference: xls table by Fred Wickens)

Creates LArReadoutModuleID from explicit ReadoutModule descriptors.

Throw a LArID_Exception if one parameter is out of range.

// usage example 

try { 
 myCablingService->createLArReadoutModuleID( 0 , 0 , 0 , 0 , 1 , 0 , 0 , 0) ;
}
catch( LArID_Exception & except ) { 
 ...
}

Definition at line 36 of file LArReadoutModuleService.cxx.

                                                                                                                                                                                          {
 
        
    std::string errorReport = checkReadoutModuleValues(l_atlas_tb, l_barrel_ec, l_pos_neg, l_em_hec_fcal, l_rosId, l_rodFragId, l_rodCrate, l_rodSlot) ;
 
    if( errorReport.length() != 0 ) { // error detected 
      MsgStream msg(Athena::getMessageSvc(), " LArReadoutModuleService");
      msg << MSG::ERROR << " createReadoutModuleID called with parameters: "  
      << l_atlas_tb << ", " << l_barrel_ec << ", " << l_pos_neg << ", " << l_em_hec_fcal 
      << ", " << l_rosId << ", " << l_rodFragId << ", " << l_rodCrate << ", " << l_rodSlot << endmsg;
      msg << MSG::ERROR << errorReport << endmsg;
      return {}; //Return (invalid) default instance
    }
    
    l_rodCrate = l_rodCrate-1; 
 
    unsigned int id_int = l_atlas_tb * m_atlas_tb + l_barrel_ec * m_barrel_ec + l_pos_neg * m_pos_neg + l_em_hec_fcal * m_emhf +
                          l_rosId * s_rosId + l_rodFragId * s_rodFragId + l_rodCrate * s_rodCrate + l_rodSlot * s_rodSlot ;
    HWIdentifier l_id(id_int) ;
    return l_id ; 
}

◆ em_hec_fcal()

int LArReadoutModuleService::em_hec_fcal ( const HWIdentifier & id )

static

return subdetector
em : 0, hec : 1, fcal : 2

Definition at line 159 of file LArReadoutModuleService.cxx.

                                                                  {
    return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0x18 ) ) >> 3 ;
}

◆ pos_neg()

int LArReadoutModuleService::pos_neg ( const HWIdentifier & id )

static

return side
positive side : 1
negative side : 0

Definition at line 155 of file LArReadoutModuleService.cxx.

                                                              {
   return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 4 ) ) >> 2  ;
}

◆ robFragId()

int LArReadoutModuleService::robFragId ( const HWIdentifier & id )

static

return ROB fragment identifier ( == ROL == RODFrag identifier )

Definition at line 200 of file LArReadoutModuleService.cxx.

                                                                {
    return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0x3fc00 ) ) >> 10 ;
}

◆ rodCrate()

int LArReadoutModuleService::rodCrate ( const HWIdentifier & id )

static

return ROD crate number

Definition at line 216 of file LArReadoutModuleService.cxx.

                                                               {
// Shift by 1, internally (0-3), external (1-4)
    return ( ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0xc0000 ) ) >> 18 ) + 1 ;
}

◆ rodFragId()

int LArReadoutModuleService::rodFragId ( const HWIdentifier & id )

static

return ROD fragment identifier ( == ROL == ROB identifier )

Definition at line 212 of file LArReadoutModuleService.cxx.

                                                                {
    return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0x3fc00 ) ) >> 10 ;
}

◆ rodSlot()

int LArReadoutModuleService::rodSlot ( const HWIdentifier & id )

static

return ROD slot number

Definition at line 221 of file LArReadoutModuleService.cxx.

                                                              {
    return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0xf00000 ) ) >> 20 ;
}

◆ rol()

int LArReadoutModuleService::rol ( const HWIdentifier & id )

static

return ROL identifier ( == RODFrag == ROBFrag identifier )

Definition at line 204 of file LArReadoutModuleService.cxx.

                                                          {
    return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0x3fc00 ) ) >> 10 ;
}

◆ rosId()

int LArReadoutModuleService::rosId ( const HWIdentifier & id )

static

return ROS identifier

Definition at line 208 of file LArReadoutModuleService.cxx.

                                                            {
    return ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0x3e0 ) ) >> 5 ;
}

◆ subDet()

int LArReadoutModuleService::subDet ( const HWIdentifier & id )

static

return sub-detector identifier

Definition at line 163 of file LArReadoutModuleService.cxx.

                                                             {
    int value=0 ;
    int l_barrel_ec = ( ( ( (int) l_id.get_identifier32().get_compact() ) & 2 ) ) >> 1 ;
    int l_pos_neg   = ( ( ( (int) l_id.get_identifier32().get_compact() ) & 4 ) ) >> 2  ;
    int l_emhf      = ( ( ( (int) l_id.get_identifier32().get_compact() ) & 0x18 ) ) >> 3 ;
    if(l_barrel_ec == 0) {
      if(l_pos_neg == 1) {
        value = s_LAR_EM_BARREL_A_SIDE ;
      } else {
        value = s_LAR_EM_BARREL_C_SIDE ;
      }
    }
    else if(l_emhf == 0) {
      if(l_pos_neg == 1) {
        value = s_LAR_EM_ENDCAP_A_SIDE ;
      } else {
        value = s_LAR_EM_ENDCAP_C_SIDE ;
      }
    }
    else if(l_emhf == 1) {
      if(l_pos_neg == 1) {
        value = s_LAR_HAD_ENDCAP_A_SIDE ;
      } else {
        value = s_LAR_HAD_ENDCAP_C_SIDE ;
      }
    }
    else if(l_emhf == 2) {
      if(l_pos_neg == 1) {
        value = s_LAR_FCAL_A_SIDE ;
      } else {
        value = s_LAR_FCAL_C_SIDE ;
      }
    }
    
    return value ;
}

Member Data Documentation

◆ m_atlas_tb

const unsigned int LArReadoutModuleService::m_atlas_tb = 1

staticprivate

Definition at line 128 of file LArReadoutModuleService.h.

◆ m_barrel_ec

const unsigned int LArReadoutModuleService::m_barrel_ec = 2

staticprivate

Definition at line 129 of file LArReadoutModuleService.h.

◆ m_emhf

const unsigned int LArReadoutModuleService::m_emhf = 8

staticprivate

Definition at line 133 of file LArReadoutModuleService.h.

◆ m_pos_neg

const unsigned int LArReadoutModuleService::m_pos_neg = 4

staticprivate

Definition at line 130 of file LArReadoutModuleService.h.

◆ s_LAR_EM_BARREL_A_SIDE

const int LArReadoutModuleService::s_LAR_EM_BARREL_A_SIDE = 0x41

staticprivate

Definition at line 139 of file LArReadoutModuleService.h.

◆ s_LAR_EM_BARREL_C_SIDE

const int LArReadoutModuleService::s_LAR_EM_BARREL_C_SIDE = 0x42

staticprivate

Definition at line 140 of file LArReadoutModuleService.h.

◆ s_LAR_EM_ENDCAP_A_SIDE

const int LArReadoutModuleService::s_LAR_EM_ENDCAP_A_SIDE = 0x43

staticprivate

Definition at line 141 of file LArReadoutModuleService.h.

◆ s_LAR_EM_ENDCAP_C_SIDE

const int LArReadoutModuleService::s_LAR_EM_ENDCAP_C_SIDE = 0x44

staticprivate

Definition at line 142 of file LArReadoutModuleService.h.

◆ s_LAR_FCAL_A_SIDE

const int LArReadoutModuleService::s_LAR_FCAL_A_SIDE = 0x47

staticprivate

Definition at line 145 of file LArReadoutModuleService.h.

◆ s_LAR_FCAL_C_SIDE

const int LArReadoutModuleService::s_LAR_FCAL_C_SIDE = 0x48

staticprivate

Definition at line 146 of file LArReadoutModuleService.h.

◆ s_LAR_HAD_ENDCAP_A_SIDE

const int LArReadoutModuleService::s_LAR_HAD_ENDCAP_A_SIDE = 0x45

staticprivate

Definition at line 143 of file LArReadoutModuleService.h.

◆ s_LAR_HAD_ENDCAP_C_SIDE

const int LArReadoutModuleService::s_LAR_HAD_ENDCAP_C_SIDE = 0x46

staticprivate

Definition at line 144 of file LArReadoutModuleService.h.

◆ s_rodCrate

const unsigned int LArReadoutModuleService::s_rodCrate = 262144

staticprivate

Definition at line 136 of file LArReadoutModuleService.h.

◆ s_rodFragId

const unsigned int LArReadoutModuleService::s_rodFragId = 1024

staticprivate

Definition at line 135 of file LArReadoutModuleService.h.

◆ s_rodSlot

const unsigned int LArReadoutModuleService::s_rodSlot = 1048576

staticprivate

Definition at line 137 of file LArReadoutModuleService.h.

◆ s_rosId

const unsigned int LArReadoutModuleService::s_rosId = 32

staticprivate

Definition at line 134 of file LArReadoutModuleService.h.

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

Public Member Functions

Static Public Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~LArReadoutModuleService()

Member Function Documentation

◆ atlas_tb()

◆ barrel_ec()

◆ checkReadoutModuleValues()

◆ cnvToString()

◆ cnvToStringTDAQ()

◆ createReadoutModuleID()

◆ em_hec_fcal()

◆ pos_neg()

◆ robFragId()

◆ rodCrate()

◆ rodFragId()

◆ rodSlot()

◆ rol()

◆ rosId()

◆ subDet()

Member Data Documentation

◆ m_atlas_tb

◆ m_barrel_ec

◆ m_emhf

◆ m_pos_neg

◆ s_LAR_EM_BARREL_A_SIDE

◆ s_LAR_EM_BARREL_C_SIDE

◆ s_LAR_EM_ENDCAP_A_SIDE

◆ s_LAR_EM_ENDCAP_C_SIDE

◆ s_LAR_FCAL_A_SIDE

◆ s_LAR_FCAL_C_SIDE

◆ s_LAR_HAD_ENDCAP_A_SIDE

◆ s_LAR_HAD_ENDCAP_C_SIDE

◆ s_rodCrate

◆ s_rodFragId

◆ s_rodSlot

◆ s_rosId