EtaCMA.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "RPC_CondCabling/EtaCMA.h"
 
#include "RPC_CondCabling/CMAprogram.h"
#include "RPC_CondCabling/SectorLogicSetup.h"
 
#include "GaudiKernel/MsgStream.h"
#include "AthenaKernel/errorcheck.h"
 
#include <cstdio> //for sprintf
#include <cstdlib> //for abs
#include <fstream>
#include <sstream>
#include <string>
#include <memory>
#include <algorithm>
 
using namespace RPC_CondCabling;
using TrigRoadsMap = RPC_CondCabling::SectorLogicSetup::TrigRoadsMap;
 
EtaCMA::EtaCMA(const CMAparameters::parseParams& parse)
  : CMAparameters(parse)
{
    m_pivot_rpc_read = 1;
    m_lowPt_rpc_read = 1;
    m_highPt_rpc_read = 1;
    m_conf_type = CMAparameters::Atlas;
 
    create_pivot_map(m_pivot_rpc_read);
    create_lowPt_map(m_lowPt_rpc_read);
    create_highPt_map(m_highPt_rpc_read);
}
 
EtaCMA::EtaCMA(const EtaCMA& cma)
  : CMAparameters(cma),
    m_pivot_RPCs (cma.pivot_RPCs()),
    m_lowPt_RPCs (cma.lowPt_RPCs()),
    m_highPt_RPCs (cma.highPt_RPCs()),
    m_inversion (cma.inversion())
{
    m_conf_type = CMAparameters::Atlas;
}
 
EtaCMA::~EtaCMA() = default;
 
EtaCMA& EtaCMA::operator=(const EtaCMA& cma) {
    if (this != &cma) {
        CMAparameters::operator=(cma);
        m_pivot_RPCs = cma.pivot_RPCs();
        m_lowPt_RPCs = cma.lowPt_RPCs();
        m_highPt_RPCs = cma.highPt_RPCs();
        m_inversion = cma.inversion();
        m_conf_type = CMAparameters::Atlas;
    }
    return *this;
}
 
bool EtaCMA::cable_CMA_channels(HalfType side) {
    if (pivot_station())  // Check and connect strips with Pivot matrix channels
    {
        for (int i = pivot_start_ch(); i <= pivot_stop_ch(); ++i) {
            int strip_number = (m_active_pivot_chs) ? 1 : pivot_start_st();
            RPClink::iterator found = m_pivot_RPCs.find(i);
            if (found == m_pivot_RPCs.end()) continue;
            RPCchamber* rpc = (*found).second;
            int final_strip = rpc->eta_strips();
            if (i == pivot_stop_ch()) final_strip = pivot_stop_st();
            do {
                if (m_active_pivot_chs == pivot_channels) {
                    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << noMoreChannels("Pivot");
                    return false;
                }
 
                int st_effective = strip_number - 1;
                if (!i && side == Negative) st_effective = abs(st_effective - final_strip) - 1;
 
                if (rpc->ijk_etaReadout() == 1) {
                    m_pivot[0][0][m_active_pivot_chs] = i * 100 + st_effective;
                    m_pivot[0][1][m_active_pivot_chs] = 10000 + i * 100 + st_effective;
                } else {
                    m_pivot[0][1][m_active_pivot_chs] = i * 100 + st_effective;
                    m_pivot[0][0][m_active_pivot_chs] = 10000 + i * 100 + st_effective;
                }
                rpc->add_eta_channel(st_effective);
                ++m_active_pivot_chs;
            } while (++strip_number <= final_strip);
        }
        // Set first and last connectors code
        int code = pivot_station() * 100000 + 2 * 100000000;
        m_first_pivot_code = code + m_pivot[0][0][0];
        m_last_pivot_code = code + m_pivot[0][0][m_active_pivot_chs - 1];
    }
    if (lowPt_station() && lowPt_number_co() != -1) {
        for (int i = lowPt_start_ch(); i <= lowPt_stop_ch(); ++i) {
            int strip_number = (m_active_lowPt_chs) ? 1 : lowPt_start_st();
            RPClink::iterator found = m_lowPt_RPCs.find(i);
            if (found == m_lowPt_RPCs.end()) continue;
            RPCchamber* rpc = (*found).second;
            int final_strip = rpc->eta_strips();
            if (i == lowPt_stop_ch()) final_strip = lowPt_stop_st();
            do {
                if (m_active_lowPt_chs == confirm_channels) {
                    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << noMoreChannels("Low Pt");
                    return false;
                }
 
                int st_effective = strip_number - 1;
                if (!i && side == Negative) st_effective = abs(st_effective - final_strip) - 1;
 
                if (rpc->ijk_etaReadout() == 1) {
                    m_lowPt[0][0][m_active_lowPt_chs] = i * 100 + st_effective;
                    m_lowPt[0][1][m_active_lowPt_chs] = 10000 + i * 100 + st_effective;
                } else {
                    m_lowPt[0][1][m_active_lowPt_chs] = i * 100 + st_effective;
                    m_lowPt[0][0][m_active_lowPt_chs] = 10000 + i * 100 + st_effective;
                }
                rpc->add_eta_channel(st_effective);
                ++m_active_lowPt_chs;
            } while (++strip_number <= final_strip);
        }
        // Set first and last connectors code
        int code = lowPt_station() * 100000 + 2 * 100000000;
        m_first_lowPt_code = code + m_lowPt[0][0][0];
        m_last_lowPt_code = code + m_lowPt[0][0][m_active_lowPt_chs - 1];
    }
    if (highPt_station() && highPt_number_co() != -1) {
        for (int i = highPt_start_ch(); i <= highPt_stop_ch(); ++i) {
            int strip_number = (m_active_highPt_chs) ? 1 : highPt_start_st();
            RPClink::iterator found = m_highPt_RPCs.find(i);
            if (found == m_highPt_RPCs.end()){
              continue;
            }
            RPCchamber* rpc = (*found).second;
            int final_strip = rpc->eta_strips();
            if (i == highPt_stop_ch()) final_strip = highPt_stop_st();
            do {
                if (m_active_highPt_chs == confirm_channels) {
                    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << noMoreChannels("High Pt");
                    return false;
                }
 
                int st_effective = strip_number - 1;
                if (!i && side == Negative) st_effective = abs(st_effective - final_strip) - 1;
 
                if (rpc->ijk_etaReadout() == 1) {
                    m_highPt[0][0][m_active_highPt_chs] = i * 100 + st_effective;
                    m_highPt[0][1][m_active_highPt_chs] = 10000 + i * 100 + st_effective;
                } else {
                    m_highPt[0][1][m_active_highPt_chs] = i * 100 + st_effective;
                    m_highPt[0][0][m_active_highPt_chs] = 10000 + i * 100 + st_effective;
                }
                rpc->add_eta_channel(st_effective);
                ++m_active_highPt_chs;
            } while (++strip_number <= final_strip);
        }
        // Set first and last connectors code
        int code = highPt_station() * 100000 + 2 * 100000000;
        m_first_highPt_code = code + m_highPt[0][0][0];
        m_last_highPt_code = code + m_highPt[0][0][m_active_highPt_chs - 1];
    }
    return true;
}
 
bool EtaCMA::connect(SectorLogicSetup& setup) {
    if (pivot_station())  // Check and connect Pivot chambers
    {
        for (int i = pivot_start_ch(); i <= pivot_stop_ch(); ++i) {
            RPCchamber* rpc = setup.find_chamber(pivot_station(), i);
            if (rpc) {
                rpc->add_cma(this);
                m_pivot_RPCs.insert(RPClink::value_type(i, rpc));
            } else {
                REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << no_connection_error("RPC - pivot", i);
                return false;
            }
        }
    }
 
    if (lowPt_station() && lowPt_number_co() != -1) {  // Check and connect Low Pt chambers
        if (got_confirm_cabling(setup, lowPt_station())) {
            ++m_lowPt_start_st;  // RPC strips starts from 1!
            for (int i = m_lowPt_start_ch; i <= m_lowPt_stop_ch; ++i) {
                RPCchamber* rpc = setup.find_chamber(lowPt_station(), i);
                if (rpc) {
                    rpc->add_cma(this);
                    m_lowPt_RPCs.insert(RPClink::value_type(i, rpc));
                } else {
                    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << no_connection_error("RPC - low Pt", i);
                    return false;
                }
                if (i == m_lowPt_stop_ch) m_lowPt_stop_st += rpc->strips_in_Eta_Conn();
            }
        } else {
            REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << no_confirm_error(lowPt_station());
            return false;
        }
    }
 
    if (highPt_station() && highPt_number_co() != -1) {  // Check and connect High Pt chambers
        if (got_confirm_cabling(setup, highPt_station())) {
            ++m_highPt_start_st;  // RPC strips starts from 1!
            for (int i = m_highPt_start_ch; i <= m_highPt_stop_ch; ++i) {
                RPCchamber* rpc = setup.find_chamber(highPt_station(), i);
                if (rpc) {
                    rpc->add_cma(this);
                    m_highPt_RPCs.insert(RPClink::value_type(i, rpc));
                } else {
                    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << no_connection_error("RPC - high Pt", i);
                    return false;
                }
                if (i == m_highPt_stop_ch) m_highPt_stop_st += rpc->strips_in_Eta_Conn();
            }
        } else {
            REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EtaCMA") << no_confirm_error(highPt_station());
            return false;
        }
    }
    return true;
}
 
bool EtaCMA::got_confirm_cabling(SectorLogicSetup& setup, int stat) {
    int l;
    if (stat == lowPt_station()) {
        bool result = setup.local_conn_add(Eta, stat, lowPt_start_co(), l, m_lowPt_start_ch, m_lowPt_start_st) &&
                      setup.local_conn_add(Eta, stat, lowPt_stop_co(), l, m_lowPt_stop_ch, m_lowPt_stop_st);
        if ((!m_lowPt_start_ch || !m_lowPt_stop_ch) && setup.side() == NoHalf) {
            REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EvenPhiCMA") << "Sector Type must belong "
                "to a specific side when RPC chamber is in between eta 0";
             return false;
        }
        return result;
    } else if (stat == highPt_station()) {
        bool result = setup.local_conn_add(Eta, stat, highPt_start_co(), l, m_highPt_start_ch, m_highPt_start_st) &&
                      setup.local_conn_add(Eta, stat, highPt_stop_co(), l, m_highPt_stop_ch, m_highPt_stop_st);
        if ((!m_highPt_start_ch || !m_highPt_stop_ch) && setup.side() == NoHalf) {
            REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EvenPhiCMA") << "Sector Type must belong "
                "to a specific side when RPC chamber is in between eta 0";
            return false;
        }
        return result;
 
    } else {
        REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "EvenPhiCMA") << "Station n. " << stat
             << " don't give input to CMA confirm planes!";
        return false;
    }
}
 
bool EtaCMA::setup(SectorLogicSetup& setup, MsgStream& log) {
    // Connect the CMA with RPC chambers
    if (!connect(setup)) return false;
 
    // Check boundary of CMA channels
    EtaCMA* prev = setup.previousCMA(*this);
    if (prev && pivot_station()) {
        if (pivot_start_ch() == prev->pivot_stop_ch()) {
            if (!(pivot_start_st() == prev->pivot_stop_st() + 1)) {
                log << MSG::ERROR << two_obj_error_message("strips mismatch", prev) << endmsg;
                return false;
            }
        } else if (!(pivot_start_ch() == prev->pivot_stop_ch() + 1)) {
            log << MSG::ERROR << two_obj_error_message("chambers mismatch", prev) << endmsg;
            return false;
        } else {
            if (!prev->end_at_RPC_Z_boundary() || !begin_at_RPC_Z_boundary()) {
                log << MSG::ERROR << two_obj_error_message("boundary mismatch", prev) << endmsg;
                return false;
            }
        }
    }
 
    // Build the cabling map
    if (!cable_CMA_channels(setup.side())) return false;
 
    // invert the strip cabling if needed
    if (!doInversion(setup)) return false;
 
    // only 1 repository allowed so far
    std::string LVL1_configuration_repository;
    LVL1_configuration_repository = "ATLAS.data";
 
    // Read the program file if exist
    SectorLogicSetup::SECTORlist sectors = setup.sectors();
    SectorLogicSetup::SECTORlist::const_iterator it = sectors.begin();
 
    char s_tag[4];
    sprintf(s_tag, "s%02d", *it);
 
    char t_tag[3];
    sprintf(t_tag, "t%1d", id().PAD_index());
 
    char c_tag[4] = {'_', 'c', '2', '\0'};
    if (id().Ixx_index() == 1) c_tag[2] = '3';
 
    std::ifstream CMAprogLow;
    std::istringstream CMAprogLow_COOL;
    char name[200];
 
    // LB retrieve pointer to the map of the trigger roads
    const SectorLogicSetup::TrigRoadsMap * p_trigroads = setup.GetPtoTrigRoads();
 
    // Read trigger configurations from files
 
    if (p_trigroads == nullptr) {
        while (!CMAprogLow.is_open() && it != sectors.end()) {
            std::ostringstream namestr;
 
            std::string dir;
            dir = setup.online_database();
            namestr << dir << "/" << s_tag << "_" << t_tag << "_pl" << c_tag << ".txt" << std::ends;  // M.C. search for local files
 
            namestr.str().copy(name, namestr.str().length(), 0);
            name[namestr.str().length()] = 0;
            if (log.level() <= MSG::DEBUG) {
                log << "filename for the trigger roads " << name << endmsg;
            }
 
            CMAprogLow.open(name);
            ++it;
            namestr.clear();
        }
    }
    // Trigger configuration loaded from COOL
    else {
        while (CMAprogLow_COOL.str().empty() && it != sectors.end()) {
            std::ostringstream namestr;
            namestr << s_tag << "_" << t_tag << "_pl" << c_tag << ".txt" << std::ends;
            namestr.str().copy(name, namestr.str().length(), 0);
            name[namestr.str().length()] = 0;
            TrigRoadsMap::const_iterator itc;
            itc = p_trigroads->find(name);
            if (itc != p_trigroads->end()) {
                CMAprogLow_COOL.str(itc->second.c_str());
 
                if (log.level() <= MSG::VERBOSE) {
                    log << MSG::VERBOSE << "EtaCMA low: key " << name << "found in the Trigger Road Map --> OK"
                         << ", EtaCMA low: key " << itc->second.c_str()
                         << ", Etacma:CMAPROGLOW " << CMAprogLow_COOL.str()
                         << endmsg;
                }
            }
            ++it;
            namestr.clear();
        }
    }
    if (CMAprogLow.is_open()) {
        std::unique_ptr<CMAprogram> program = std::make_unique<CMAprogram>(CMAprogLow, true);
        if (program->check()) {
            m_lowPt_program = std::move(program);
            if (setup.cosmic()) {
                m_lowPt_program->open_threshold(0);
                m_lowPt_program->open_threshold(1);
            }
            for (unsigned int i = 0; i < 3; ++i) {
                if (!m_lowPt_program->hasProgrammed(i)) {
                    if (log.level() <= MSG::DEBUG) {
                        log << MSG::DEBUG << s_tag << ": " << id() << ": low-pt: has threshold " << i
                             << " not programmed." << endmsg;
                    }
                }
            }
        }
        CMAprogLow.close();
        if (log.level() <= MSG::DEBUG) {
            log << MSG::DEBUG << "EtaCMA::setup low_pt program has been read ---- " << endmsg;
        }
    } else if (!CMAprogLow_COOL.str().empty()) {
        std::unique_ptr<CMAprogram> program = std::make_unique<CMAprogram>(CMAprogLow_COOL, true);
        if (program->check()) {
            m_lowPt_program = std::move(program);
            if (setup.cosmic()) {
                m_lowPt_program->open_threshold(0);
                m_lowPt_program->open_threshold(1);
            }
            for (unsigned int i = 0; i < 3; ++i) {
                if (!m_lowPt_program->hasProgrammed(i)) {
                    if (log.level() <= MSG::DEBUG) {
                        log << MSG::DEBUG << s_tag << ": " << id() << ": low-pt: has threshold " << i
                             << " not programmed." << endmsg;
                    }
                }
            }
        }
        CMAprogLow_COOL.str("");
    } else {
        if (log.level() <= MSG::DEBUG) {
            log << MSG::DEBUG << name << " not found! Putting a dummy configuration" << endmsg;
        }
        m_lowPt_program = std::make_unique<CMAprogram>();
        m_lowPt_program->open_threshold(0);
    }
 
    it = sectors.begin();
    std::ifstream CMAprogHigh;
    std::istringstream CMAprogHigh_COOL;
 
    if (p_trigroads == nullptr) {
        while (!CMAprogHigh.is_open() && it != sectors.end()) {
            std::ostringstream namestr;
            std::string dir;
            dir = setup.online_database();
            namestr << dir << "/" << s_tag << "_" << t_tag << "_ph" << c_tag << ".txt" << std::ends;
 
            namestr.str().copy(name, namestr.str().length(), 0);
            name[namestr.str().length()] = 0;
            if (log.level() <= MSG::DEBUG) {
                log << MSG::DEBUG << "filename for the trigger roads " << name << endmsg;
            }
            CMAprogHigh.open(name);
            ++it;
            namestr.clear();
        }
    }
    // Trigger configuration loaded from COOL
    else {
        while (CMAprogHigh_COOL.str().empty() && it != sectors.end()) {
            std::ostringstream namestr;
            namestr << s_tag << "_" << t_tag << "_ph" << c_tag << ".txt" << std::ends;
            namestr.str().copy(name, namestr.str().length(), 0);
            name[namestr.str().length()] = 0;
            TrigRoadsMap::const_iterator itc;
            itc = p_trigroads->find(name);
            if (itc != p_trigroads->end()) {
                if (log.level() <= MSG::VERBOSE) {
                    log << MSG::VERBOSE << "EtaCMA high: key " << name << "found in the Trigger Road Map --> OK"
                         << ", EtaCMA high: key " << itc->second.c_str() << endmsg;
                }
                CMAprogHigh_COOL.str(itc->second.c_str());
                if (log.level() <= MSG::VERBOSE) {
                    log << MSG::VERBOSE << "EtaCMA:CMAPROGHIGH " << CMAprogHigh_COOL.str() << endmsg;
                }
            }
            ++it;
            namestr.clear();
        }
    }
 
    if (CMAprogHigh.is_open()) {
        std::unique_ptr<CMAprogram> program = std::make_unique<CMAprogram>(CMAprogHigh, true);
        if (program->check()) {
            m_highPt_program = std::move(program);
            if (setup.cosmic()) {
                m_highPt_program->open_threshold(0);
                m_highPt_program->open_threshold(1);
            }
            for (unsigned int i = 0; i < 3; ++i) {
                if (!m_highPt_program->hasProgrammed(i)) {
                    if (log.level() <= MSG::DEBUG) {
                        log << MSG::DEBUG << s_tag << ": " << id() << ": high-pt: has threshold " << i
                             << " not programmed." << endmsg;
                    }
                }
            }
        }
        CMAprogHigh.close();
        if (log.level() <= MSG::DEBUG) {
            log << MSG::DEBUG << "EtaCMA::setup high_pt program has been read ---- " << endmsg;
        }
    } else if (!CMAprogHigh_COOL.str().empty()) {
        std::unique_ptr<CMAprogram> program = std::make_unique<CMAprogram>(CMAprogHigh_COOL, true);
        if (program->check()) {
            m_highPt_program = std::move(program);
            if (setup.cosmic()) {
                m_highPt_program->open_threshold(0);
                m_highPt_program->open_threshold(1);
            }
            for (unsigned int i = 0; i < 3; ++i) {
                if (!m_highPt_program->hasProgrammed(i)) {
                    if (log.level() <= MSG::DEBUG) {
                        log << MSG::DEBUG << s_tag << ": " << id() << ": high-pt: has threshold " << i
                            << " not programmed." << endmsg;
                    }
                }
            }
        }
        CMAprogHigh_COOL.str("");
    } else {
        if (log.level() <= MSG::DEBUG) {
            log << MSG::DEBUG << " not found! Putting a dummy configuration" << endmsg;
        }
        m_highPt_program = std::make_unique<CMAprogram>();
        m_highPt_program->open_threshold(0);
    }
 
    return true;
}
 
bool EtaCMA::doInversion(SectorLogicSetup& setup) {
    SectorLogicSetup::SECTORlist Sectors = setup.sectors();
    SectorLogicSetup::SECTORlist::const_iterator it = Sectors.begin();
    int sector = *it;
 
    RPClink::const_iterator rpc;
    if (lowPt_station() && lowPt_number_co() != -1) {
        rpc = m_lowPt_RPCs.begin();
        if ((*rpc).second->inversion(sector)) {
            m_inversion = true;
            correct(Inversion, LowPt, 0, first_lowPt_channel(), last_lowPt_channel(), 0);
            correct(Inversion, LowPt, 1, first_lowPt_channel(), last_lowPt_channel(), 0);
            int tmp = m_first_lowPt_code;
            m_first_lowPt_code = m_last_lowPt_code;
            m_last_lowPt_code = tmp;
        }
    }
 
    if (pivot_station()) {
        rpc = m_pivot_RPCs.begin();
        if ((*rpc).second->inversion(sector)) {
            m_inversion = true;
            correct(Inversion, Pivot, 0, first_pivot_channel(), last_pivot_channel(), 0);
            correct(Inversion, Pivot, 1, first_pivot_channel(), last_pivot_channel(), 0);
            int tmp = m_first_pivot_code;
            m_first_pivot_code = m_last_pivot_code;
            m_last_pivot_code = tmp;
        }
    }
 
    if (highPt_station() && highPt_number_co() != -1) {
        rpc = m_highPt_RPCs.begin();
        if ((*rpc).second->inversion(sector)) {
            m_inversion = true;
            correct(Inversion, HighPt, 0, first_highPt_channel(), last_highPt_channel(), 0);
            correct(Inversion, HighPt, 1, first_highPt_channel(), last_highPt_channel(), 0);
            int tmp = m_first_highPt_code;
            m_first_highPt_code = m_last_highPt_code;
            m_last_highPt_code = tmp;
        }
    }
 
    if (m_inversion) m_id->inversion();
 
    return true;
}
 
bool EtaCMA::end_at_RPC_Z_boundary(void) const {
    RPClink::const_iterator found = m_pivot_RPCs.find(pivot_stop_ch());
    if (found == m_pivot_RPCs.end()) return false;
    return (*found).second->eta_strips() == pivot_stop_st();
}
 
bool EtaCMA::begin_at_RPC_Z_boundary(void) const {
    return pivot_start_st() == 1;
}