MuonMDT_CablingAlg.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#include "MuonMDT_CablingAlg.h"
 
#include <fstream>
#include <map>
#include "AthenaPoolUtilities/AthenaAttributeList.h"
#include "AthenaPoolUtilities/CondAttrListCollection.h"
#include "AthenaKernel/IOVInfiniteRange.h"
#include "CoralBase/Attribute.h"
#include "CoralBase/AttributeListSpecification.h"
#include "CxxUtils/StringUtils.h"
#include "MuonIdHelpers/MdtIdHelper.h"
#include "PathResolver/PathResolver.h"
#include "SGTools/TransientAddress.h"
 
#include <CoralBase/Blob.h>
#include <CoralUtilities/blobaccess.h>
 
 
using DataSource = MuonMDT_CablingMap::DataSource;
 
MuonMDT_CablingAlg::MuonMDT_CablingAlg(const std::string& name, ISvcLocator* pSvcLocator) : 
    AthCondAlgorithm(name, pSvcLocator) {}
 
StatusCode MuonMDT_CablingAlg::initialize() {
    ATH_MSG_DEBUG("initialize " << name());
    const bool initCondKey = m_mezzJSON.value().empty() &&
                             m_chambJSON.value().empty();
    ATH_CHECK(m_readKeyMez.initialize(initCondKey));
    ATH_CHECK(m_readKeyMap.initialize(initCondKey));
    ATH_CHECK(m_writeKey.initialize());
    ATH_CHECK(m_idHelperSvc.retrieve());
    return StatusCode::SUCCESS;
}
 
StatusCode MuonMDT_CablingAlg::execute(const EventContext& ctx) const {
    ATH_MSG_VERBOSE("MuonMDT_CablingAlg::execute()");
    // Write Cond Handle
    SG::WriteCondHandle<MuonMDT_CablingMap> writeHandle{m_writeKey, ctx};
    if (writeHandle.isValid()) {
        ATH_MSG_DEBUG("CondHandle " << writeHandle.fullKey() << " is already valid."
                                    << ". In theory this should not be called, but may happen"
                                    << " if multiple concurrent events are being processed out of order.");
        return StatusCode::SUCCESS;
    }
    writeHandle.addDependency(EventIDRange(IOVInfiniteRange::infiniteRunLB()));
    ATH_MSG_INFO("Load the Mdt cabling");
    std::unique_ptr<MuonMDT_CablingMap> writeCdo{std::make_unique<MuonMDT_CablingMap>()};
 
    ATH_CHECK(loadMezzanineSchema(ctx, writeHandle, *writeCdo));
    ATH_CHECK(loadCablingSchema(ctx, writeHandle, *writeCdo));
    if (!writeCdo->finalize_init(msgStream())) return StatusCode::FAILURE;
    
    ATH_CHECK(writeHandle.record(std::move(writeCdo)));
    ATH_MSG_INFO("recorded new " << writeHandle.key() << " with range " << writeHandle.getRange() << " into Conditions Store");
    return StatusCode::SUCCESS;
}
 
StatusCode MuonMDT_CablingAlg::dbPayloadToJson(SG::ReadCondHandle<CondAttrListCollection>& readHandle, nlohmann::json& json) const {
    for (CondAttrListCollection::const_iterator itr = readHandle->begin(); 
                                                itr != readHandle->end(); ++itr) {
        const coral::AttributeList& atr = itr->second;
        std::string data{};
        if (atr["data"].specification().type() == typeid(coral::Blob)) {
 
            ATH_MSG_VERBOSE("Loading data as a BLOB, uncompressing...");
            if (!CoralUtilities::readBlobAsString(atr["data"].data<coral::Blob>(), data)) {
                ATH_MSG_FATAL("Cannot uncompress BLOB! Aborting...");
                return StatusCode::FAILURE;
            }
        } else {
            data = *(static_cast<const std::string*>((atr["data"]).addressOfData()));
        }
        json = nlohmann::json::parse(data);
    }
    return StatusCode::SUCCESS;
}
 
StatusCode MuonMDT_CablingAlg::loadCablingSchema(const EventContext& ctx, SG::WriteCondHandle<MuonMDT_CablingMap>& writeHandle,
                                                 MuonMDT_CablingMap& cabling_map)  const {
    
    if (m_chambJSON.value().size()){
        std::ifstream in_json{m_chambJSON};
        if (!in_json.good()) {
            ATH_MSG_FATAL("Failed to open external JSON file "<<m_chambJSON);
            return StatusCode::FAILURE;
        }
        nlohmann::json payload{};
        in_json >> payload;
        ATH_CHECK(loadCablingSchemaFromJSON( std::move(payload), cabling_map));  
        return StatusCode::SUCCESS;
    }
    SG::ReadCondHandle<CondAttrListCollection> readHandleMap{m_readKeyMap, ctx};
    if (!readHandleMap.isValid()) {
        ATH_MSG_ERROR("Null pointer to the read conditions object "<<readHandleMap.fullKey());
        return StatusCode::FAILURE;
    }
    writeHandle.addDependency(readHandleMap);
    
    ATH_MSG_INFO("Size of CondAttrListCollection " << readHandleMap.fullKey() 
                  << " readCdoMap->size()= " << readHandleMap->size());
   
    ATH_MSG_VERBOSE("Collection CondAttrListCollection CLID " << readHandleMap->clID());
    if (m_useJSONFormat) {
        nlohmann::json json;
        ATH_CHECK(dbPayloadToJson(readHandleMap, json));
        ATH_CHECK(loadCablingSchemaFromJSON(std::move(json),cabling_map));
        return StatusCode::SUCCESS;
    }
    // access to Map Schema Table to obtained the Map
    CondAttrListCollection::const_iterator itrMap;
    for (itrMap = readHandleMap->begin(); itrMap != readHandleMap->end(); ++itrMap) {
        const coral::AttributeList& atr = itrMap->second;
 
        CablingData map_data;
        if (!extractStationInfo(atr, map_data)) continue;
 
        constexpr std::string_view delimiter{","};
        const std::string map = *(static_cast<const std::string*>((atr["Map"]).addressOfData()));
        std::vector<std::string> info_map = CxxUtils::tokenize(map, delimiter);
 
        while (extractLayerInfo(info_map, map_data)) {
            ATH_MSG_VERBOSE("Adding new mezzanine stationName: " << m_idHelperSvc->mdtIdHelper().stationNameString(map_data.stationIndex)
                                                                 << " " << map_data);
            if (!cabling_map.addMezzanine(map_data, DataSource::LegacyCOOL, msgStream())) {
                ATH_MSG_ERROR("Failed to add cabling " << map_data);
                return StatusCode::FAILURE;
            } else
                ATH_MSG_VERBOSE("Added new cabling channel " << map_data);
        }
    }  // end of CondAttrListCollection loop
    if (m_isRun3) {
        ATH_MSG_INFO("Found a round 3 setup. Will add the cabling for BIS78 manually");
        const int BIS_stat = m_idHelperSvc->mdtIdHelper().stationNameIndex("BIS");
        constexpr int eta_index = 7;
        for (unsigned int sector = 1; sector <= 8; ++sector) {
            int is_biy{0}, tdcId{0};
            auto increment_tdc = [&is_biy, &tdcId]() {
                ++tdcId;
                constexpr int tdcMax = 17;  // Maximum 18 tdcs per CSM
                if (tdcId > tdcMax) {
                    tdcId = 0;
                    ++is_biy;
                }
            };
            constexpr int tubesPerCsm = 54;  
            bool added_tdc = true;
            while (added_tdc) {
                added_tdc = false;
                for (int ml = 1; ml <= 2; ++ml) {
                    const Identifier layer_id = m_idHelperSvc->mdtIdHelper().channelID(BIS_stat, eta_index, sector, ml, 1, 1);
                    const int tubes_per_layer = m_idHelperSvc->mdtIdHelper().tubeMax(layer_id);
 
                    const int first_tube = 6 * (1 + tdcId / 2) + tubesPerCsm * is_biy;
                    const bool valid_tube = (first_tube <= tubes_per_layer);
                    added_tdc |= valid_tube;
                    if (!valid_tube) {
                        increment_tdc();
                        continue;
                    }
 
                    CablingData bis78_data{};
                    bis78_data.tubes_per_layer = MdtIdHelper::maxNTubesPerLayer;
                    bis78_data.stationIndex = BIS_stat;
                    bis78_data.eta = eta_index;
                    bis78_data.phi = sector;
                    bis78_data.mrod = (is_biy ? -1 : 7) + sector;
                    bis78_data.csm = is_biy ? 5 : 0;
                    bis78_data.subdetectorId = 99;
 
                    bis78_data.mezzanine_type = sector != 6 ? 61 : 71;
                    const unsigned int tube_coding = first_tube + bis78_data.tubes_per_layer * (4 + bis78_data.layer_block * ml);
                    ATH_MSG_VERBOSE("ooooh BIS78 is being hacked in " << m_idHelperSvc->toString(layer_id) << " tubes_per_layer  "
                                                                      << m_idHelperSvc->mdtIdHelper().tubeMax(layer_id) << " tdcId: "
                                                                      << tdcId << " is_Biy: " << is_biy << " first_tube: " << first_tube);
 
                    std::vector<std::string> db_coding{std::to_string(tdcId), "0", std::to_string(tube_coding)};
                    if (extractLayerInfo(db_coding, bis78_data)) {
                        ATH_MSG_VERBOSE("Adding new mezzanine stationName: "
                                        << m_idHelperSvc->mdtIdHelper().stationNameString(bis78_data.stationIndex) << " " << bis78_data);
                        if (!cabling_map.addMezzanine(bis78_data, DataSource::LegacyCOOL, msgStream())) {
                            ATH_MSG_ERROR("Failed to add mezzanine card " << bis78_data);
                            return StatusCode::FAILURE;
                        }
                    }
                    if (bis78_data.tube != first_tube) {
                        ATH_MSG_ERROR("BIS78 data tube encoding failed. Expected " << first_tube << " got " << bis78_data.tube << ".");
                        return StatusCode::FAILURE;
                    } else if (bis78_data.multilayer != ml) {
                        ATH_MSG_ERROR("BIS78 data ml encoding failed. Expected " << ml << " got " << bis78_data.multilayer << ".");
                        return StatusCode::FAILURE;
                    }
                    increment_tdc();
                }
            }
        }
    }
    return StatusCode::SUCCESS;
}
 
bool MuonMDT_CablingAlg::extractStationInfo(const coral::AttributeList& atr, CablingData& map_data) const {
    map_data.eta = *(static_cast<const int*>((atr["Eta"]).addressOfData()));
    map_data.phi = *(static_cast<const int*>((atr["Phi"]).addressOfData()));
    map_data.mrod = *(static_cast<const int*>((atr["MROD"]).addressOfData()));
    map_data.csm = *(static_cast<const int*>((atr["CSM"]).addressOfData()));
    map_data.channelId = *(static_cast<const int*>((atr["Chan"]).addressOfData()));
    map_data.mezzanine_type = *(static_cast<const int*>((atr["Mezzanine_Type"]).addressOfData()));
 
    const std::string chamber_name = *(static_cast<const std::string*>((atr["Chamber_Name"]).addressOfData()));
    const std::string subdetector_id = *(static_cast<const std::string*>((atr["SubDet_Id"]).addressOfData()));
 
    // convert the string name to index
    std::string stationNameString = chamber_name.substr(0, 3);
    // fix for the BOE chambers, which in the offline are treated as BOL
    if (stationNameString == "BOE") { stationNameString = "BOL"; }
    if (stationNameString == "BIX" || stationNameString == "BIY") {
        stationNameString = "BIS";
        static std::atomic<bool> sInfoPrinted{false};
        if (!sInfoPrinted)
            ATH_MSG_INFO("Found an entry concerning the new BIS78 chambers. Will increase the number of tube per layer to "
                         << MdtIdHelper::maxNTubesPerLayer);
        sInfoPrinted = true;
 
        map_data.tubes_per_layer = MdtIdHelper::maxNTubesPerLayer;
    }
    if (m_isRun3) {
        if ((stationNameString == "EIS" && (!m_idHelperSvc->hasCSC() || chamber_name.find('A') != std::string::npos)) ||
            chamber_name.find("BIS7A") != std::string::npos) {
            ATH_MSG_VERBOSE("It's sooo sad but the chamber " << chamber_name << " is no longer with us");
            return false;
        }
    }
    map_data.stationIndex = m_idHelperSvc->mdtIdHelper().stationNameIndex(stationNameString);
    ATH_MSG_VERBOSE("station name: " << stationNameString << " index: " << static_cast<int>(map_data.stationIndex));
    // convert the subdetector id to integer
    map_data.subdetectorId = CxxUtils::atoi(subdetector_id);
 
    ATH_MSG_VERBOSE("Data load is chamber_Name = " << chamber_name <<" translated to "<<map_data<<" FINISHED HERE ");
 
    if (map_data.stationIndex < 0) {
        static std::atomic<bool> stWarningPrinted{false};
        if (!stWarningPrinted) {
            ATH_MSG_WARNING("Found stationIndex=" << static_cast<int>(map_data.stationIndex)
                                                  << " which is not reasonable, maybe related to ATLASRECTS-5961, continuing...");
            stWarningPrinted = true;
        }
    }
    return map_data.stationIndex >= 0;
}
bool MuonMDT_CablingAlg::extractLayerInfo(std::vector<std::string>& info_map, CablingData& map_data) const {
    ATH_MSG_VERBOSE(" parsing of the map");
    constexpr unsigned int coding_block_size = 3;
    const unsigned int n = info_map.size() >= coding_block_size ? coding_block_size : info_map.size();
    bool decoded_full_block{false};
    for (unsigned int i = 0; i < n; ++i) {
        ATH_MSG_VERBOSE(i << "..." << info_map[i]);
        int info = CxxUtils::atoi(info_map[i]);
        // this is a tdcid
        if (i == 0) {
            map_data.tdcId = info;
        }
        // this is a channel Id
        else if (i == 1) {
            map_data.channelId = info;
        }
        // this is a tube id that must be unpacked
        else if (i == 2) {
            map_data.tube = info % map_data.tubes_per_layer;
            map_data.layer = ((info - map_data.tube) / map_data.tubes_per_layer) % map_data.layer_block;
            map_data.multilayer = (((info - map_data.tube) / map_data.tubes_per_layer) - map_data.layer) / map_data.layer_block;
            decoded_full_block = true;
        }
    }
 
    // the stationIndex is later on passed to the MdtIdHelper, thus, it must be a reasonable station name, i.e. not < 0
    if (decoded_full_block) info_map.erase(info_map.begin(), info_map.begin() + coding_block_size);
    return decoded_full_block;
}
 
StatusCode MuonMDT_CablingAlg::loadMezzanineSchema(const EventContext& ctx,SG::WriteCondHandle<MuonMDT_CablingMap>& writeHandle,
                                                    MuonMDT_CablingMap& cabling_map) const{
    if (m_mezzJSON.value().size()){
        std::ifstream in_json{m_mezzJSON};
        if (!in_json.good()) {
            ATH_MSG_FATAL("Failed to open external JSON file "<<m_mezzJSON);
            return StatusCode::FAILURE;
        }
        nlohmann::json payload{};
        in_json >> payload;
        ATH_CHECK(loadMezzanineFromJSON(std::move(payload), cabling_map)); 
        return StatusCode::SUCCESS;
    }

    SG::ReadCondHandle<CondAttrListCollection> readHandleMez{m_readKeyMez, ctx};    
    if (!readHandleMez.isValid()) {
        ATH_MSG_ERROR("Null pointer to the read conditions object "<<m_readKeyMez.fullKey());
        return StatusCode::FAILURE;
    }
    writeHandle.addDependency(readHandleMez);
 
    ATH_MSG_INFO("Size of CondAttrListCollection " << readHandleMez.fullKey() 
                  << " readCdoMez->size()= " << readHandleMez->size());
    
    if (m_useJSONFormat) {
        nlohmann::json json;
        ATH_CHECK(dbPayloadToJson(readHandleMez, json));
        ATH_CHECK(loadMezzanineFromJSON(std::move(json),cabling_map));
        return StatusCode::SUCCESS;
    }
    CondAttrListCollection::const_iterator itrMez;
    for (itrMez = readHandleMez->begin(); itrMez != readHandleMez->end(); ++itrMez) {
        const coral::AttributeList& atr = itrMez->second;
        int sequence{0}, layer{0}, mezzanine_type{0};
 
        mezzanine_type = *(static_cast<const int*>((atr["Mezzanine_Type"]).addressOfData()));
        layer = *(static_cast<const int*>((atr["Layer"]).addressOfData()));
        sequence = *(static_cast<const int*>((atr["Sequence"]).addressOfData()));
        ATH_MSG_VERBOSE("Sequence load is " << sequence << " for the mezzanine type =  " << mezzanine_type
                                            << " for the layer  number  = " << layer);
 
        // here add the mezzanine type to the cabling class
        if (!cabling_map.addMezzanineLine(mezzanine_type, layer, sequence, msgStream())) {
            ATH_MSG_ERROR("Could not add the mezzanine sequence to the map ");
            return StatusCode::FAILURE;
        } else {
            ATH_MSG_VERBOSE("Sequence added successfully to the map");
        }
    }    
    return StatusCode::SUCCESS;
}
StatusCode MuonMDT_CablingAlg::loadMezzanineFromJSON(nlohmann::json&& payload, MuonMDT_CablingMap& cabling_map) const {
    using MezzMapping = MdtMezzanineCard::Mapping;
    for (const auto &cabl_chan : payload.items()) {
        nlohmann::json mezz_payload = cabl_chan.value();
        const uint8_t id = mezz_payload["mezzId"];
        const uint8_t nLay = mezz_payload["nTubeLayer"];
        const MezzMapping mapping = mezz_payload["tdcToTubeMap"];        
        if(!cabling_map.addMezanineLayout(std::make_unique<MdtMezzanineCard>(mapping, nLay, id), 
                                        msgStream())) return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
}
StatusCode MuonMDT_CablingAlg::loadCablingSchemaFromJSON(nlohmann::json&& payload, MuonMDT_CablingMap& cabling_map) const {
    const MdtIdHelper& id_helper = m_idHelperSvc->mdtIdHelper();
    for (const auto &db_channel : payload.items()) {
        nlohmann::json ms_payload = db_channel.value();
        CablingData ms_channel{};
        ms_channel.stationIndex = id_helper.stationNameIndex(ms_payload["station"]);
        ms_channel.eta = ms_payload["eta"];
        ms_channel.phi = ms_payload["phi"];
        ms_channel.multilayer = ms_payload["ml"];
 
        ms_channel.subdetectorId = ms_payload["subDet"];
        ms_channel.csm = ms_payload["csm"];
        ms_channel.mrod = ms_payload["mrod"];
 
        ms_channel.mezzanine_type = ms_payload["mezzId"];
        ms_channel.tdcId = ms_payload["tdcId"];
        ms_channel.tube = ms_payload["tubeZero"];
 
        ms_channel.layer = 1;
        MdtMezzanineCard::MezzCardPtr hedgeHogCard = cabling_map.getHedgeHogMapping(ms_channel.mezzanine_type);
        ms_channel.channelId = hedgeHogCard ? (*std::min_element(
                                                    hedgeHogCard->tubeToTdcMap().begin(),
                                                    hedgeHogCard->tubeToTdcMap().end())) : 0;
        if (!cabling_map.addMezzanine(std::move(ms_channel), DataSource::JSON, msgStream())) return StatusCode::FAILURE;   
    }
    return StatusCode::SUCCESS;
}