AtlasDetectorID.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
/***************************************************************************
 Detector Description
 -----------------------------------------
***************************************************************************/
 
#include "AtlasDetDescr/AtlasDetectorID.h"
#include "AtlasDetectorIDHelper.h"
#include "Identifier/IdContext.h"
#include "Identifier/ExpandedIdentifier.h"
#include "IdDict/IdDictDictionary.h"
#include "IdDict/IdDictField.h"
#include "IdDict/IdDictLabel.h"
#include "IdDict/IdDictMgr.h"
#include "IdDict/IdDictRange.h"
#include "IdDict/IdDictRegion.h"
#include <stdio.h>
#include <assert.h>
#include <format>
 
AtlasDetectorID::AtlasDetectorID(const std::string &name,
                                 const std::string& group)
  : AthMessaging(name),
    m_group (group)
{
}
AtlasDetectorID::~AtlasDetectorID() {
    if(m_helper) delete m_helper;
}
 
const std::string& AtlasDetectorID::group() const
{
  return m_group;
}
 
Identifier AtlasDetectorID::mdt() const {
    return Identifier{};
}
Identifier AtlasDetectorID::csc() const {
    return Identifier{};
}
Identifier AtlasDetectorID::rpc() const {
    return Identifier{};
}
Identifier AtlasDetectorID::tgc() const {
    return Identifier{};
}
Identifier AtlasDetectorID::stgc() const {
    return Identifier{};
}
Identifier AtlasDetectorID::mm() const {
    return Identifier{};
}
Identifier AtlasDetectorID::indet() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(indet_field_value(), result);
    return result;
}
 
Identifier AtlasDetectorID::lar() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(lar_field_value(), result);
    return result;
}
 
Identifier AtlasDetectorID::tile() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(tile_field_value(), result);
    return result;
}
 
Identifier AtlasDetectorID::muon() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(muon_field_value(), result);
    return result;
}
 
Identifier AtlasDetectorID::calo() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(calo_field_value(), result);
    return result;
}
 
Identifier AtlasDetectorID::pixel() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(indet_field_value(), result);
    m_indet_part_impl.pack(m_PIXEL_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::sct() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(indet_field_value(), result);
    m_indet_part_impl.pack(m_SCT_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::trt() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(indet_field_value(), result);
    m_indet_part_impl.pack(m_TRT_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::hgtd() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(indet_field_value(), result);
    m_indet_part_impl.pack(m_HGTD_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::lumi() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(indet_field_value(), result);
    m_indet_part_impl.pack(m_LUMI_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::lar_em() const { 
    Identifier result{0};
    // Pack field
    m_det_impl.pack(lar_field_value(), result);
    m_lar_part_impl.pack(m_LAR_EM_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::lar_lvl1() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(calo_field_value(), result);
    m_calo_side_impl.pack(-1, result);
    return result;
}
 
Identifier AtlasDetectorID::lar_dm() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(calo_field_value(), result);
    m_calo_side_impl.pack(-4, result);
    return result;
}
 
Identifier AtlasDetectorID::tile_dm() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(calo_field_value(), result);
    m_calo_side_impl.pack(-5, result);
    return result;
}
 
Identifier AtlasDetectorID::lar_hec() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(lar_field_value(), result);
    m_lar_part_impl.pack(m_LAR_HEC_ID, result);
    return result;
}
 
Identifier AtlasDetectorID::lar_fcal() const {
    Identifier result{0};
    // Pack field
    m_det_impl.pack(lar_field_value(), result);
    m_lar_part_impl.pack(m_LAR_FCAL_ID, result);
    return result;
}
IdContext AtlasDetectorID::detsystem_context() const {
    ExpandedIdentifier id{};
    return IdContext{id, 0, m_DET_INDEX};
}
 
IdContext AtlasDetectorID::subdet_context() const {
    ExpandedIdentifier id{};
    return IdContext{id, 0, m_SUBDET_INDEX};
}
 
int AtlasDetectorID::get_id(const IdentifierHash & /*hash_id*/,
                            Identifier & /*id*/,
                            const IdContext * /*context*/) const {
    return 0;
}
 
int AtlasDetectorID::get_hash(const Identifier & /*id*/,
                              IdentifierHash & /*hash_id*/,
                              const IdContext * /*context*/) const {
    return 0;
}
 
int AtlasDetectorID::register_dict_tag(const IdDictMgr &dict_mgr,
                                       const std::string &dict_name) {
    // Register version of dictionary dict_name
 
    // Access dictionary by name
    const IdDictDictionary *dict = dict_mgr.find_dictionary(dict_name);
    if (!dict) {
        ATH_MSG_ERROR(__func__<<":"<<__LINE__<<" No dictionary found");
        return 1;
 
    }
    // Add in dict name, file name and version
    m_dict_names.push_back(dict_name);
    m_file_names.push_back(dict->file_name());
    m_dict_tags.push_back(dict->dict_tag());
    return 0;
}
 
bool AtlasDetectorID::reinitialize(const IdDictMgr &dict_mgr) {
    // If no tag has been registered, then reinitialize
    if (m_dict_tags.size() == 0){
        return true;
    }
    // If no dict names have been registered, then reinitialize
    if (m_dict_names.size() == 0){
        return true;
    }
    // Loop over dict names and check version tags
    if (m_dict_names.size() != m_dict_tags.size()) {
        ATH_MSG_ERROR("reinitialize: dict names and tags vectors not the same length ");
        ATH_MSG_ERROR("names: " << m_dict_names.size() << " tags: " << m_dict_tags.size());
    }
    for (unsigned int i = 0; i < m_dict_names.size(); ++i) {
        // Access dictionary by name
        const IdDictDictionary *dict = dict_mgr.find_dictionary(m_dict_names[i]);
        if (!dict) {
            ATH_MSG_ERROR("reinitialize: could not find dict -  " << m_dict_names[i]);
            return false;
        }
        if (m_dict_tags[i] != dict->dict_tag()) {
            // Remove all memory of versions
            m_dict_names.clear();
            m_dict_tags.clear();
            m_file_names.clear();
            return true;
        }
    }
 
    // Tags match - don't reinitialize
    return false;
}
 
int AtlasDetectorID::initialize_from_dictionary(const IdDictMgr &dict_mgr) {
 
    // Register version of ATLAS dictionary
    if (register_dict_tag(dict_mgr, "ATLAS")){
        ATH_MSG_ERROR(__func__<<":"<<__LINE__<<" - Failed to register dict tag");
        return 1;
    }
    // Initialize helper, needed for init of AtlasDetectorID
    if (!m_helper) {
        m_helper = std::make_unique<AtlasDetectorIDHelper>().release();
    }
 
    if (m_helper->initialize_from_dictionary(dict_mgr)){
        ATH_MSG_ERROR(__func__<<":"<<__LINE__<<" - Initialization from dictionary failed.");
        return 1;
    }
    // Initialize level indices and id values from dicts
    if (initLevelsFromDict(dict_mgr)) {
        ATH_MSG_ERROR(__func__<<":"<<__LINE__<<" - Level initialization from dictionary failed.");
        return 1;
    }
    m_is_initialized_from_dict = true;
    ATH_MSG_DEBUG("initialize_from_dictionary - OK");
    return 0;
}
 
std::string AtlasDetectorID::dictionaryVersion() const {
    return m_dict_version;
}
bool AtlasDetectorID::is_indet(const ExpandedIdentifier &id) const{
    return  id.fields() > 0 && id[0] == m_INDET_ID;
}
bool AtlasDetectorID::is_lar(const ExpandedIdentifier &id) const {
    return id.fields() > 0 && id[0] == m_LAR_ID;
}
bool AtlasDetectorID::is_tile(const ExpandedIdentifier &id) const {
    return id.fields() > 0 && id[0] == m_TILE_ID;
}
bool AtlasDetectorID::is_muon(const ExpandedIdentifier &id) const {
    return id.fields() > 0 && id[0] == m_MUON_ID;
}
bool AtlasDetectorID::is_calo(const ExpandedIdentifier &id) const {
    return id.fields() > 0 && id[0] == m_CALO_ID;
}
bool AtlasDetectorID::is_pixel(const ExpandedIdentifier &id) const {
    return is_indet(id) && id.fields() > 1 && id[1] == m_PIXEL_ID;
}
 
bool AtlasDetectorID::is_sct(const ExpandedIdentifier &id) const {
    return is_indet(id) && id.fields() > 1 && id[1] == m_SCT_ID;
}
bool AtlasDetectorID::is_trt(const ExpandedIdentifier &id) const {
    return is_indet(id) && id.fields() > 1;
}
bool AtlasDetectorID::is_hgtd(const ExpandedIdentifier &id) const {
    return is_indet(id) && id.fields() > 1 && id[1] == m_HGTD_ID;
}
bool AtlasDetectorID::is_lumi(const ExpandedIdentifier &id) const {
    return is_indet(id) && id.fields() > 1 && id[1] == m_LUMI_ID;
}
bool AtlasDetectorID::is_plr(const ExpandedIdentifier &id) const {
    return is_lumi(id) && id.fields() > 2 && id[2] == m_LUMI_PLR_ID;
}
 
bool AtlasDetectorID::is_lar_em(const ExpandedIdentifier &id) const {
    return is_lar(id) && id.fields() > 1 && std::abs(id[1]) == m_LAR_EM_ID;
}
bool AtlasDetectorID::is_lar_hec(const ExpandedIdentifier &id) const {
    return is_lar(id) && id.fields() > 1 && std::abs(id[1]) == m_LAR_HEC_ID;
}
 
bool AtlasDetectorID::is_lar_fcal(const ExpandedIdentifier &id) const {
    return is_lar(id) && id.fields() > 1 && std::abs(id[1]) == m_LAR_FCAL_ID;
}
 
bool AtlasDetectorID::is_lar_minifcal(const ExpandedIdentifier &id) const {
    return is_lar_fcal(id) && id.fields() > 3 &&std::abs(id[3]) == 0;
}
 
bool AtlasDetectorID::is_mdt(const ExpandedIdentifier &id) const{
    return id.fields() > 4 && id[0] == m_MUON_ID && id[4] == m_MDT_ID;
}
 
bool AtlasDetectorID::is_csc(const ExpandedIdentifier &id) const {
    return id.fields() > 4 && id[0] == m_MUON_ID && id[4] == m_CSC_ID;
}
 
bool AtlasDetectorID::is_rpc(const ExpandedIdentifier &id) const {
    return id.fields() > 4 && id[0] == m_MUON_ID && id[4] == m_RPC_ID;
}
 
bool AtlasDetectorID::is_tgc(const ExpandedIdentifier &id) const {
    return id.fields() > 4 && id[0] == m_MUON_ID && id[4] == m_TGC_ID;
}
 
bool AtlasDetectorID::is_stgc(const ExpandedIdentifier &id) const {
    return id.fields() > 4 && id[0] == m_MUON_ID && id[4] == m_STGC_ID;
}
 
bool AtlasDetectorID::is_mm(const ExpandedIdentifier &id) const {
    return id.fields() > 4 && id[0] == m_MUON_ID && id[4] == m_MM_ID;
}
 
// Short print out of any identifier:
void AtlasDetectorID::show(const Identifier id, const IdContext *context, char sep) const {
    ATH_MSG_INFO(show_to_string(id, context, sep));
}
 
// or provide the printout in string form
std::string
AtlasDetectorID::show_to_string(const Identifier id, const IdContext *context, char sep) const {
    // Do a generic printout of identifier
 
    std::string result("Unable to decode id");
    unsigned int max_index = (context) ? context->end_index() : 999;
 
    if (!id.is_valid()) {
      return "[INVALID]";
    }
 
    if (!m_is_initialized_from_dict)
        return result;
 
    // Find the dictionary to use:
    const IdDictDictionary *dict{nullptr};
    ExpandedIdentifier expId{};
    ExpandedIdentifier prefix{}; // default is null prefix
    Identifier compact = id;
 
    if (is_indet(id)) {
        dict = m_indet_dict;
    } else if (is_lar(id)) {
        dict = m_lar_dict;
    } else if (is_tile(id)) {
        dict = m_tile_dict;
    } else if (is_muon(id)) {
        dict = m_muon_dict;
    } else if (is_lvl1_trig_towers(id) || is_lvl1_online(id) ||
               is_lar_dm(id) || is_tile_dm(id)) {
        dict = m_calo_dict;
    } else if (is_forward(id)) {
        dict = m_fwd_dict;
    }
 
    if (!dict) {
        ATH_MSG_WARNING(__func__<<" No detector type associated to id "<<id);
        return result;
    }
    if (dict->unpack(m_group, compact, prefix, max_index, expId)) {
        return result;
    }
 
    bool first = true;
    result = "";
    if ('.' == sep)
        result = "[";
    for (unsigned int i = 0; i < expId.fields(); ++i) {
        if (first)
            first = false;
        else
            result += sep;
        result += std::format("{}", expId[i]);
    }
    if ('.' == sep)
        result += "]";
    return result;
}
 
void AtlasDetectorID::print(Identifier id, const IdContext *context) const {
    ATH_MSG_INFO(print_to_string(id, context));
}
 
std::string AtlasDetectorID::print_to_string(Identifier id,
                                             const IdContext *context) const {
    // Print out for any Atlas identifier
    std::string result;
    if (m_is_initialized_from_dict) {
 
        // Do a generic printout of identifier from dictionary
        unsigned int max_index = (context) ? context->end_index() : 999;
 
        // Find the dictionary to use:
        const IdDictDictionary *dict{nullptr};
        ExpandedIdentifier expId;
        ExpandedIdentifier prefix; // default is null prefix
        Identifier compact = id;
 
        if (is_indet(id)) {
            dict = m_indet_dict;
        } else if (is_lar(id)) {
            dict = m_lar_dict;
        } else if (is_tile(id)) {
            dict = m_tile_dict;
        } else if (is_muon(id)) {
            dict = m_muon_dict;
        } else if (is_lvl1_trig_towers(id) ||  is_lvl1_online(id) ||
                   is_lar_dm(id) || is_tile_dm(id)) {
            dict = m_calo_dict;
        } else if (is_forward(id)) {
            dict = m_fwd_dict;
        }
 
        if (!dict) {
            ATH_MSG_WARNING(__func__<<":"<<__LINE__<<" No dictionary could be associated to "<<id);
            return result;
        }
        if (dict->unpack(m_group, compact, prefix, max_index," ", result)) {
            return result;
        }
    }
    return result;
}
const std::vector<std::string> & AtlasDetectorID::dict_names() const {
    return m_dict_names;
}
const std::vector<std::string>& AtlasDetectorID::file_names() const {
    return m_file_names;
}
const std::vector<std::string> & AtlasDetectorID::dict_tags() const {
    return m_dict_tags;
}
bool AtlasDetectorID::do_checks() const {
    return m_do_checks;
}
void AtlasDetectorID::set_do_checks(bool do_checks) {
    m_do_checks = do_checks;
}
 
bool AtlasDetectorID::do_neighbours() const {
    return m_do_neighbours;
}
 
void AtlasDetectorID::set_do_neighbours(bool do_neighbours) {
    m_do_neighbours = do_neighbours;
}
 
void AtlasDetectorID::setMessageSvc(IMessageSvc *msgSvc) {
    m_msgSvc = msgSvc;
}
 
void AtlasDetectorID::set_quiet(bool quiet) {
    m_quiet = quiet;
}
 
void AtlasDetectorID::setDictVersion(const IdDictMgr &dict_mgr, const std::string &name) {
    const IdDictDictionary *dict = dict_mgr.find_dictionary(name);
    m_dict_version = dict->version();
}
 
std::string AtlasDetectorID::to_range(const ExpandedIdentifier &id) const {
 
    // Build a string from the contents of an identifier
    int fields = id.fields();
    std::string result("");
    for (int i = 0; i < fields; ++i) {
        if (i > 0) {
            result += '/'; // add '/' only if NOT last one
        }
        result += std::format("{}", id[i]);
    }
    return result;
}
 
int AtlasDetectorID::initLevelsFromDict(const IdDictMgr &dict_mgr) {
 
    // Set do_checks flag
    if (dict_mgr.do_checks())
        m_do_checks = true;
    // Set do_neighbours flag
    if (!dict_mgr.do_neighbours())
        m_do_neighbours = false;
 
    
    const IdDictField *field{nullptr};
 
    // Find out from the dictionary the detector and subdetector
    // levels and id values
    m_DET_INDEX = 999;
    m_SUBDET_INDEX = 999;
    m_MUON_SUBDET_INDEX = 999;
    m_INDET_ID = -1;
    m_LAR_ID = -1;
    m_TILE_ID = -1;
    m_MUON_ID = -1;
    m_PIXEL_ID = -1;
    m_SCT_ID = -1;
    m_TRT_ID = -1;
    m_HGTD_ID = -1;
    m_FWD_ID = -1;
    m_ALFA_ID = -1;
    m_BCM_ID = -1;
    m_LUCID_ID = -1;
    m_ZDC_ID = -1;
    m_LAR_EM_ID = -1;
    m_LAR_HEC_ID = -1;
    m_LAR_FCAL_ID = -1;
    m_LAR_FCAL_MODULE_INDEX = 999;
    m_MDT_ID = -1;
    m_CSC_ID = -1;
    m_RPC_ID = -1;
    m_TGC_ID = -1;
    m_STGC_ID = -1;
    m_MM_ID = -1;
 
    // Save generic dict for top levels
    const IdDictDictionary *top_dict {nullptr};
 
    auto assignSystemId = [this, &field](const std::string& systemName,
                                   int& idToAssign, 
                                   bool mandatory = true) ->bool {
        const IdDictLabel *label = field->find_label(systemName);
        if (label && label->valued()){
            idToAssign = label->value();
            ATH_MSG_VERBOSE("Assign system "<<systemName<<" to "<<idToAssign<<".");
            return true;
        } else if (label) {
            ATH_MSG_ERROR("initLevelsFromDict - label "<<systemName<<" does NOT have a value ");
            return false;
        }
        if (mandatory) {
            ATH_MSG_ERROR("initLevelsFromDict - unable to find '"<<systemName<<"' label");
            return false;
        }
        ATH_MSG_DEBUG("initLevelsFromDict - unable to find '"<<systemName<<"' label");
        return true;
    };
    // Get det ids
 
    // Initialize ids for InDet subdet
    m_indet_dict = dict_mgr.find_dictionary("InnerDetector");
    if (!m_indet_dict) {
        ATH_MSG_WARNING("initLevelsFromDict - cannot access InnerDetector dictionary");
    } else  {
        // Found InDet dict
        top_dict = m_indet_dict; // save as top_dict
        // Check if this is High Luminosity LHC layout
        // should just use std::string::contains once that is available... (C++23)
        std::string versionString = m_indet_dict->version();
        m_isHighLuminosityLHC = (versionString.find("ITk") != std::string::npos || versionString.find("P2-RUN4") != std::string::npos);
 
        // Get InDet subdets
        field = m_indet_dict->find_field("part");
        if (!field) {
            ATH_MSG_ERROR("initLevelsFromDict - unable to find 'part' field for InnerDetector dictionary");
            return 1;
        }
 
        if (!assignSystemId("Pixel", m_PIXEL_ID)) {
            return 1;
        }
        if (!assignSystemId("SCT", m_SCT_ID)) {
            return 1;
        }
        if (!assignSystemId("TRT", m_TRT_ID, !m_isHighLuminosityLHC)) {
            return 1;
        }
        if (m_isHighLuminosityLHC) {
            if (!assignSystemId("LuminosityDetectors", m_LUMI_ID, versionString.find("PLR") != std::string::npos || 
                                                                  versionString.find("P2-RUN4") != std::string::npos)) {
                return 1;
            }
            if (!assignSystemId("HGTD", m_HGTD_ID)){
                return 1;
            }  
        }
    }
    // Initialize ids for Forward dets
    m_fwd_dict = dict_mgr.find_dictionary("ForwardDetectors");
    if (!m_fwd_dict) {
        ATH_MSG_WARNING("initLevelsFromDict - cannot access ForwardDetectors dictionary");
    } else {
 
        // Found ForwardDetectors dict
 
        if (!top_dict){
            top_dict = m_fwd_dict; // save as top_dict
        }
        // Get Forward subdets
 
        field = m_fwd_dict->find_field("part");
        if (!field) {
            ATH_MSG_ERROR("initLevelsFromDict - unable to find 'part' field for ForwardDetectors dictionary");
            return 1;
        }
        if (!assignSystemId("ALFA", m_ALFA_ID)) {
            return 1;
        }
        if (!assignSystemId("BCM", m_BCM_ID)) {
            return 1;
        }
        if (!assignSystemId("LUCID", m_LUCID_ID)) {
            return 1;
        }
        if (!assignSystemId("ZDC", m_ZDC_ID)) {
            return 1;
        }
    }
 
    // Initialize ids for LAr detectors
    m_lar_dict = dict_mgr.find_dictionary("LArCalorimeter");
    if (!m_lar_dict) {
        ATH_MSG_WARNING("initLevelsFromDict -  cannot access LArCalorimeter dictionary");
    } else {
        // Found LAr dict
 
        if (!top_dict) {
            top_dict = m_lar_dict; // save as top_dict
        }
        field = m_lar_dict->find_field("part");
        if (!field) {
            ATH_MSG_ERROR("initLevelsFromDict - unable to find 'part' field for LArCalorimeter dictionary");
            return 1;
        }
        if (!assignSystemId("LArEM", m_LAR_EM_ID)) {
            return 1;
        }
        if (!assignSystemId("LArHEC", m_LAR_HEC_ID)) {
            return 1;
        }
        if (!assignSystemId("LArFCAL", m_LAR_FCAL_ID)) {
            return 1;
        }
        field = m_lar_dict->find_field("module");
        if (field) {
            m_LAR_FCAL_MODULE_INDEX = field->index();
        } else {
            ATH_MSG_DEBUG("initLevelsFromDict - unable to find 'module' field for miniFCAL");
        }
    }
 
    // Initialize ids for Tile calo
    m_tile_dict = dict_mgr.find_dictionary("TileCalorimeter");
    if (!m_tile_dict) {
        ATH_MSG_WARNING("initLevelsFromDict -  cannot access TileCalorimeter dictionary");
    } else {
        // File Tile
        if (!top_dict)
            top_dict = m_tile_dict; // save as top_dict
    }
 
    // Initialize ids for Muon detectors
    m_muon_dict = dict_mgr.find_dictionary("MuonSpectrometer");
    if (!m_muon_dict) {
        ATH_MSG_WARNING("initLevelsFromDict - cannot access MuonSpectrometer dictionary");
    } else {
        // Found muon dict
        if (!top_dict){
            top_dict = m_muon_dict; // save as top_dict
        }
        /*
          During initialisation from the dictionary we parse the
          information which muon stationName belongs to which muon
          subsystem. This information is not entirely encoded in the
          identifiers however it is frequently tested during
          reconstruction. In order to speed up these checks this info
          is now stored locally into m_muon_tech_bits.
          P.Fleischmann 04.04.2013
         */
        if (m_muon_tech_bits.empty()) {
            // we only need to load this once
            field = m_muon_dict->find_field("stationName");
            if (!field) {
                ATH_MSG_ERROR("initLevelsFromDict - unable to find 'stationName' field for MuonSpectrometer dictionary");
                return 1; 
            }
 
            size_type nStationNames = field->get_label_number();
            std::string stationNameString{};
 
            // first check for the maximum value assigned to any stationName
            int stationNameIndex{};
            int maxStationNameIndex{-1};
            for (size_type i = 0; i < nStationNames; ++i) {
                // in case no individual values are given,
                // the order inside the dictionary is used
                const IdDictLabel& label = field->label(i);
                stationNameIndex = label.valued() ? label.value() : i;
 
                maxStationNameIndex = std::max(maxStationNameIndex, stationNameIndex);
            }
 
            // the vector may contain gaps (value=0) in case of jumps
            // in the values
            m_muon_tech_bits.resize(maxStationNameIndex + 1);
 
            // loop over all stationNames and search for associations
            // to technology
            for (size_type i = 0; i < nStationNames; ++i) {
                const IdDictLabel& label = field->label(i);
                stationNameString = label.name();
                // in case no individual values are given,
                // the order inside the dictionary is used
                stationNameIndex = label.valued() ? label.value() : i;
                // next loop over all regions to look for
                // stationName <-> technology associations
                bool found{false}, stationNameFound{false}, technologyFound{false};
                std::string techLabel{};
                size_t nregions = m_muon_dict->n_regions();
                for (size_type j = 0; j < nregions; ++j) {
                    const IdDictRegion& region = m_muon_dict->region(j);
                    // loop over all entries of a region to look for
                    // stationName and technology information
                    stationNameFound = technologyFound = false;
                    size_t nentries = region.n_entries();
                    for (size_type k = 0; k < nentries; ++k) {
                        const IdDictRange *range =
                          dynamic_cast<const IdDictRange *>(&region.entry(k));
                        if (!range) {
                            continue;
                        }
                        
                        if (range->field_name() == "stationName") {
 
                          if (range->label() == stationNameString) {
                                // we found a region containing the current stationName
                                stationNameFound = true;
                                continue;
                            } else {
                                // we found a region containing a different stationName,
                                // let's skip
                                break;
                            }
                        }  else if (range->field_name() == "technology") {
                            technologyFound = true;
                            techLabel = range->label();
                        }
 
                        if (!stationNameFound || !technologyFound) {
                            continue;
                        }
 
                        // we found a stationName <-> technology association
                        if (techLabel == "MDT") {
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fAtlasMDT;
                        } else if (techLabel == "RPC") {
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fAtlasRPC;
                        } else if (techLabel == "CSC") {
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fAtlasCSC;
                        } else if (techLabel == "TGC"){
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fAtlasTGC;
                        } else if (techLabel == "MM") {
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fAtlasMM;
                        } else if (techLabel == "STGC") {
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fAtlasSTGC;
                        } else {
                            m_muon_tech_bits[stationNameIndex] = AtlasDetDescr::fUndefined;
                        }
                        found = true;
                        break;
                    } // end of loop overregion entries
 
                    if (found) {
                        // no need to continue to look for this stationName,
                        // since each stationName must be uniquely associated
                        // to a technology, except for MDT/PRC
                        break;
                    }
 
                } // end of loop over regions
 
            } // end of loop over stationNames
        }
        // end of filling stationName <-> technology associations
 
        field = m_muon_dict->find_field("technology");
        if (field) {
            m_MUON_SUBDET_INDEX = field->index();
        }
        else {
            ATH_MSG_ERROR("initLevelsFromDict - unable to find 'technology' field for MuonSpectrometer dictionary");
            return 1;
        }
 
        if (!assignSystemId("MDT", m_MDT_ID)) {
            return 1;
        }
        if (!assignSystemId("RPC", m_RPC_ID)) {
            return 1;
        }
        if (!assignSystemId("TGC", m_TGC_ID)) {
            return 1;
        }
        if (!assignSystemId("STGC", m_STGC_ID, false)) {
            return 1;
        }
        if (!assignSystemId("MM", m_MM_ID, false)) {
            return 1;
        }
        if (!assignSystemId("CSC", m_CSC_ID, false)) {
            return 1;
        }
    }
 
    // Initialize id for Calo and fields for lvl1 and dead material
    m_calo_dict = dict_mgr.find_dictionary("Calorimeter");
    if (!m_calo_dict) {
        ATH_MSG_WARNING("initLevelsFromDict - Warning cannot access Calorimeter dictionary");
    } else {
        // Found calo dict
        if (!top_dict) {
            top_dict = m_calo_dict; // save as top_dict
        }
        // Set lvl1 field for is_lvl1_trig_towers
        int value{0};
        m_lvl1_field.clear();
        // negative half
        if (m_calo_dict->get_label_value("DetZside", "negative_lvl1_side", value)) {
            ATH_MSG_ERROR("initLevelsFromDict - Could not get value for label 'negative_lvl1_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
            return 1;
        }
        m_lvl1_field.add_value(value);
        // positive half
        if (m_calo_dict->get_label_value("DetZside", "positive_lvl1_side", value)) {
            ATH_MSG_ERROR("initLevelsFromDict - Could not get value for label 'positive_lvl1_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
            return 1;
        }
        m_lvl1_field.add_value(value);
        // Set lar dead material field for is_lar_dm
        m_lar_dm_field.clear();
        // negative half
        if (m_calo_dict->get_label_value("DetZside", "negative_DMLar_side", value)) {
            ATH_MSG_ERROR("initLevelsFromDict - Could not get value for label 'negative_DMLar_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
            return 1;
        }
        m_lar_dm_field.add_value(value);
        // positive half
        if (m_calo_dict->get_label_value("DetZside", "positive_DMLar_side", value)) {
            ATH_MSG_ERROR("initLevelsFromDict - Could not get value for label 'positive_DMLar_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
            return 1;
        }
        m_lar_dm_field.add_value(value);
 
        // Set tile dead material field for is_tile_dm
        m_tile_dm_field.clear();
        // negative half
        if (m_calo_dict->get_label_value("DetZside", "negative_DMTile_side", value)) {
            ATH_MSG_ERROR("initLevelsFromDict - Could not get value for label 'negative_DMTile_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
            return 1;
        }
        m_tile_dm_field.add_value(value);
        // positive half
        if (m_calo_dict->get_label_value("DetZside", "positive_DMTile_side", value)) {
            ATH_MSG_ERROR("initLevelsFromDict - Could not get value for label 'positive_DMTile_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
            return 1;
        }
        m_tile_dm_field.add_value(value);
 
        // Set lvl1 field for is_lvl1_online
        m_lvl1_onl_field.clear();
        if (m_calo_dict->get_label_value("DetZside", "no_side", value)) {
            ATH_MSG_DEBUG("initLevelsFromDict -  Could not get value for label 'no_side' of field 'DetZside' in dictionary " << m_calo_dict->name());
        } else {
            m_lvl1_onl_field.add_value(value);
        }
    }
 
    // set det/subdet indices
    if (top_dict){
 
        field = top_dict->find_field("subdet");
        if (field) {
            m_DET_INDEX = field->index();
        } else {
            ATH_MSG_ERROR("initLevelsFromDict -  - unable to find 'subdet' field from dict "
                          << top_dict->name());
            return 1;
        }
 
        if (!assignSystemId("InnerDetector", m_INDET_ID)) {
            return 1;
        }
        if (!assignSystemId("ForwardDetectors", m_FWD_ID)) {
            return 1;
        }
        if (!assignSystemId("LArCalorimeter", m_LAR_ID)) {
            return 1;
        }
        if (!assignSystemId("TileCalorimeter", m_TILE_ID)) {
            return 1;
        }
 
        if (!assignSystemId("MuonSpectrometer", m_MUON_ID)) {
            return 1;
        }
        if (!assignSystemId("Calorimeter", m_CALO_ID)) {
            return 1;
        }
        // Get name of next level
        std::string name{};
        if (top_dict->name() == "InnerDetector") {
            name = "part";
        } else if (top_dict->name() == "Calorimeter") {
            name = "DetZside";
        } else if (top_dict->name() == "LArCalorimeter") {
            name = "part";
        } else if (top_dict->name() == "MuonSpectrometer") {
            name = "stationName";
        } else if (top_dict->name() == "TileCalorimeter") {
            name = "section";
        } else if (top_dict->name() == "ForwardDetectors") {
            name = "part";
        }
        // While we're here, save the index to the sub-detector level
        // ("part" for InDet)
        field = top_dict->find_field(name);
        if (field) {
            m_SUBDET_INDEX = field->index();
        }
        else {
            ATH_MSG_ERROR("initLevelsFromDict - unable to find field " << name << " from dict "<< top_dict->name());
            return 1;
        }
    } else {
        ATH_MSG_ERROR("initLevelsFromDict - no top dictionary defined");
        return 1;
    }
 
    // Set the field implementations
 
    size_type region_index = m_helper->pixel_region_index();
    if (m_indet_dict && AtlasDetectorIDHelper::UNDEFINED != region_index) {
 
        const IdDictRegion& region = m_indet_dict->region(region_index);
 
        // Detector
        m_det_impl = region.implementation(m_DET_INDEX);
 
        // Add on extra values to assure that one has a value per
        // bit. This is needed to avoid an overflow decoding error
        // when a pixel channel id is decoded
        if (not m_det_impl.ored_field().isEnumerated()) {
            ATH_MSG_ERROR("initLevelsFromDict - ERROR det implementation is not enumerated: "
                          << m_det_impl.show_to_string());
            return 1;
        }
 
        size_type bits = m_det_impl.bits();
        size_type nvalues = static_cast<size_type>(1) << bits;
        Range::field det = m_det_impl.ored_field();
        size_type max = det.get_maximum();
        for (size_type i = det.get_values().size(); i < nvalues; ++i) {
            ++max;
            det.add_value(max);
        }
        // Replace ored field with modified one
        m_det_impl.set_ored_field(det);
        ATH_MSG_VERBOSE("set extra bits    "<< m_det_impl.show_to_string());
 
        // InDet part
        m_indet_part_impl = region.implementation(m_SUBDET_INDEX);
    }
 
    // Calo side: LVL1, LAr & Tile DeadMat
    region_index = m_helper->lvl1_region_index();
    if (m_calo_dict && AtlasDetectorIDHelper::UNDEFINED != region_index) {
        const IdDictRegion& region = m_calo_dict->region(region_index);
        m_calo_side_impl = region.implementation(m_SUBDET_INDEX);
    }
 
    // LAr part
    region_index = m_helper->lar_em_region_index();
    if (m_lar_dict && AtlasDetectorIDHelper::UNDEFINED != region_index) {
        const IdDictRegion& region = m_lar_dict->region(region_index);
        m_lar_part_impl = region.implementation(m_SUBDET_INDEX);
    }
 
    // LAr part
    region_index = m_helper->lar_fcal_region_index();
    if (m_lar_dict && AtlasDetectorIDHelper::UNDEFINED != region_index &&
        m_LAR_FCAL_MODULE_INDEX != 999) {
        const IdDictRegion& region = m_lar_dict->region(region_index);
        m_lar_fcal_module_impl = region.implementation(m_LAR_FCAL_MODULE_INDEX);
    }
 
    // Muon station name
    region_index = m_helper->mdt_region_index();
    if (m_muon_dict && AtlasDetectorIDHelper::UNDEFINED != region_index) {
        const IdDictRegion& region = m_muon_dict->region(region_index);
        m_muon_station_name_impl = region.implementation(m_SUBDET_INDEX);
        // Muon MDT
        m_muon_mdt_impl = region.implementation(m_MUON_SUBDET_INDEX);
        // Muon RPC
        region_index = m_helper->rpc_region_index();
        if (AtlasDetectorIDHelper::UNDEFINED != region_index) {
            const IdDictRegion& rpc_region = m_muon_dict->region(region_index);
            m_muon_rpc_impl = rpc_region.implementation(m_MUON_SUBDET_INDEX);
        }
    }
    return 0;
}
 
 
ExpandedIdentifier
AtlasDetectorID::indet_exp           (void) const
{
    ExpandedIdentifier result;
    return (result << m_INDET_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::lar_exp             (void) const
{
    ExpandedIdentifier result;
    return (result << m_LAR_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::tile_exp            (void) const
{
    ExpandedIdentifier result;
    return (result << m_TILE_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::muon_exp            (void) const
{
    ExpandedIdentifier result;
    return (result << m_MUON_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::calo_exp(void) const
{
    ExpandedIdentifier result;
    return (result << m_CALO_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::fwd_exp             (void) const
{
    ExpandedIdentifier result;
    return (result << m_FWD_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::pixel_exp           (void) const
{
    ExpandedIdentifier result(indet_exp());
    return (result << m_PIXEL_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::sct_exp             (void) const
{
    ExpandedIdentifier result(indet_exp());
    return (result << m_SCT_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::trt_exp             (void) const
{
    ExpandedIdentifier result(indet_exp());
    return (result << m_TRT_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::hgtd_exp           (void) const
{
    ExpandedIdentifier result(indet_exp());
    return (result << m_HGTD_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::lumi_exp           (void) const
{
    ExpandedIdentifier result(indet_exp());
    return (result << m_LUMI_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::lar_em_exp          (void) const
{
    ExpandedIdentifier result(lar_exp());
    return (result << m_LAR_EM_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::lar_hec_exp         (void) const
{
    ExpandedIdentifier result(lar_exp());
    return (result << m_LAR_HEC_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::lar_fcal_exp        (void) const
{
    ExpandedIdentifier result(lar_exp());
    return (result << m_LAR_FCAL_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::alfa_exp             (void) const
{
    ExpandedIdentifier result(fwd_exp());
    return (result << m_ALFA_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::bcm_exp             (void) const
{
    ExpandedIdentifier result(fwd_exp());
    return (result << m_BCM_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::lucid_exp           (void) const
{
    ExpandedIdentifier result(fwd_exp());
    return (result << m_LUCID_ID);
}
 
ExpandedIdentifier
AtlasDetectorID::zdc_exp             (void) const
{
    ExpandedIdentifier result(fwd_exp());
    return (result << m_ZDC_ID);
}