RPCDQUtils.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
 
 
// Local
 
#include "RPCDQUtils.h"
 
// Athena
#include "FourMomUtils/xAODP4Helpers.h"
#include "MuonIdHelpers/RpcIdHelper.h"
#include "MuonPrepRawData/RpcPrepDataContainer.h"
#include "MuonReadoutGeometry/RpcReadoutElement.h"
 
// C/C++
#include <cmath>
#include <sstream>
 
//========================================================================================================
// struct RpcPanel
//========================================================================================================
RpcPanel::RpcPanel(Identifier id, const RpcIdHelper &rpcIdHelper) {
    FillRpcId(id, rpcIdHelper);
}
 
//========================================================================================================
void RpcPanel::FillRpcId(Identifier id, const RpcIdHelper &rpcIdHelper) {
    //
    // Read RPC data
    //
    stationName = rpcIdHelper.stationName(id);
    stationEta = rpcIdHelper.stationEta(id);
    stationPhi = rpcIdHelper.stationPhi(id);
    doubletR = rpcIdHelper.doubletR(id);
    doubletZ = rpcIdHelper.doubletZ(id);
    doubletPhi = rpcIdHelper.doubletPhi(id);
    gasGap = rpcIdHelper.gasGap(id);
    measPhi = rpcIdHelper.measuresPhi(id);
 
    panelId =
        rpcIdHelper.panelID(stationName, stationEta, stationPhi, doubletR,
                            doubletZ, doubletPhi, gasGap, measPhi, panel_valid);
 
    // panel_index = stationName*6144 + stationPhi*768 + (stationEta+9)*48 +
    // doubletR*24 + doubletPhi*12 + doubletZ*4 + gasGap*2 + measPhi;
}
 
//========================================================================================================
RpcPanel::RpcPanel(const Muon::IMuonIdHelperSvc &idHelperSvc,
                   const MuonGM::RpcReadoutElement *readoutEl_,
                   const int doubletZ_, const int doubletPhi_,
                   const int gasgap_, const int measPhi_)
    : readoutEl(readoutEl_),
      doubletR(readoutEl_->getDoubletR()),
      doubletZ(doubletZ_),
      doubletPhi(doubletPhi_),
      gasGap(gasgap_),
      measPhi(measPhi_) {
    const RpcIdHelper &rpcIdHelper = idHelperSvc.rpcIdHelper();
    const Identifier readEl_id = readoutEl->identify();
 
    stationName = rpcIdHelper.stationName(readEl_id);
    stationNameStr = rpcIdHelper.stationNameString(stationName);
 
    stationEta = rpcIdHelper.stationEta(readEl_id);
    stationPhi = rpcIdHelper.stationPhi(readEl_id);
 
    //
    // Get Identifier for this panel
    //
    panelId =
        rpcIdHelper.panelID(stationName, stationEta, stationPhi, doubletR,
                            doubletZ, doubletPhi, gasGap, measPhi, panel_valid);
    if (panel_valid) {
        panel_str = idHelperSvc.toString(panelId);
        panel_name = getOnlineConvention();
    } else {
        panel_str = idHelperSvc.toString(panelId) + " - INVALID ID";
    }
}
 
//========================================================================================================
void RpcPanel::SetPanelIndex(int index) {
    panel_index = index;
}
 
//========================================================================================================
std::string RpcPanel::getElementStr() const {
    std::ostringstream ele_key;
 
    ele_key << stationName << "_" << stationEta << "_" << stationPhi << "_"
            << doubletR << "_" << doubletZ;
    return ele_key.str();
}
 
//========================================================================================================
bool RpcPanel::operator==(const RpcPanel &rhs) const {
    if (this->stationName == rhs.stationName &&
        this->stationPhi == rhs.stationPhi &&
        this->stationEta == rhs.stationEta && this->doubletR == rhs.doubletR &&
        this->doubletPhi == rhs.doubletPhi && this->doubletZ == rhs.doubletZ &&
        this->gasGap == rhs.gasGap && this->measPhi == rhs.measPhi) {
        return true;
    } else {
        return false;
    }
}
 
//========================================================================================================
bool RpcPanel::operator<(const RpcPanel &rhs) const {
    return this->panel_index < rhs.panel_index;
}
 
//========================================================================================================
bool RpcPanel::operator>(const RpcPanel &rhs) const {
    return this->panel_index > rhs.panel_index;
}
 
//========================================================================================================
std::string RpcPanel::getOnlineConvention() const {
    const std::string mystring_name = stationNameStr;
    const std::string mystring_eta = std::to_string(std::abs(stationEta));
    const std::string mystring_dPhi = "DP" + std::to_string(doubletPhi) + ".";
    const std::string mystring_gap = "Ly" + std::to_string(gasGap - 1) + ".";
    const std::string mystring_dZ = "DZ" + std::to_string(doubletZ);
 
    std::string mystring_phi;
    std::string mystring_side;
    std::string mystring_PICO;  // pivot or confirm
    std::string mystring_ETAPHI;
 
    int myphi_part = (2 * stationPhi) - 1;
 
    if (stationEta > 0) {
        mystring_side = "A";
    } else if (stationEta < 0) {
        mystring_side = "C";
    } else {
        mystring_side = "N";
    }  // N: NULL, "ETA NOT DEFINED"
 
    if (stationName == 3 || stationName == 5 || stationName == 8 ||
        stationName == 9 || stationName == 10) {
        myphi_part += 1;
    }
 
    if (myphi_part < 10) {
        mystring_phi = "0" + std::to_string(myphi_part);
    } else {
        mystring_phi = std::to_string(myphi_part);
    }
 
    if ((stationNameStr == "BMS" && doubletR == 1) ||
        (stationNameStr == "BML" && doubletR == 1) ||
        (stationNameStr == "BMF" && doubletR == 1)) {
        mystring_PICO = ".CO.";
    } else if ((stationNameStr == "BMS" && doubletR == 2) ||
               (stationNameStr == "BML" && doubletR == 2) ||
               (stationNameStr == "BMF" && doubletR == 2)) {
        mystring_PICO = ".PI.";
    } else if ((stationNameStr == "BOS" && doubletR == 1) ||
               (stationNameStr == "BOL" && doubletR == 1) ||
               (stationNameStr == "BOF" && doubletR == 1) ||
               (stationNameStr == "BOG" && doubletR == 1)) {
        mystring_PICO = ".CO.";
    } else {
        // mystring_PICO = ".PIVOT_CONFIRMED_NOT_DEFINED.";
        mystring_PICO =
            ".NU" + std::to_string(doubletR) + ".";  // NU: NULL, Not defined
    }
 
    if (measPhi == 0) {
        mystring_ETAPHI = "ETA.";
    } else {
        mystring_ETAPHI = "PHI.";
    }
 
    return mystring_name + mystring_eta + mystring_side + mystring_phi +
           mystring_PICO + mystring_dPhi + mystring_gap + mystring_dZ +
           mystring_ETAPHI;
}
 
//========================================================================================================
std::pair<int, int> RpcPanel::getSectorLayer() const {
    // {'2':'BML', '3':'BMS', '4':'BOL', '5':'BOS', '8':'BMF' , '9':'BOF',
    // '10':'BOG', '53':'BME'}
    int sector = 0;
    int layer = 0;
 
    if (stationName == 2 || stationName == 53) {
        sector = stationPhi * 2 - 1;
        layer = (doubletR - 1) * 2 + gasGap;
    } else if (stationName == 4) {
        sector = stationPhi * 2 - 1;
        layer = 4 + (doubletR - 1) * 2 + gasGap;
    } else if (stationName == 3 || stationName == 8) {
        sector = stationPhi * 2;
        layer = (doubletR - 1) * 2 + gasGap;
    } else if (stationName == 5 || stationName == 9 || stationName == 10) {
        sector = stationPhi * 2;
        layer = 4 + (doubletR - 1) * 2 + gasGap;
    }
    if (stationEta < 0)
        sector = -1 * sector;
 
    std::pair<int, int> sec_layer(sector, layer);
 
    return sec_layer;
}
 
//========================================================================================================
// strcuct ExResult
//========================================================================================================
ExResult::ExResult(const Identifier gasgap_id_,
                   const Trk::PropDirection direction_)
    : gasgap_id(gasgap_id_), direction(direction_) {}
 
//========================================================================================================
// GasGapData
//========================================================================================================
GasGapData::GasGapData(const Muon::IMuonIdHelperSvc &idHelperSvc,
                       const MuonGM::RpcReadoutElement *readoutEl_,
                       const int doubletZ_, const int doubletPhi_,
                       const unsigned gasgap_)
    : readoutEl(readoutEl_),
      doubletR(readoutEl_->getDoubletR()),
      doubletZ(doubletZ_),
      doubletPhi(doubletPhi_),
      gasgap(gasgap_) {
    const RpcIdHelper &rpcIdHelper = idHelperSvc.rpcIdHelper();
    const Identifier readEl_id = readoutEl->identify();
 
    stationName = rpcIdHelper.stationName(readEl_id);
    stationEta = rpcIdHelper.stationEta(readEl_id);
    stationPhi = rpcIdHelper.stationPhi(readEl_id);
 
    //
    // Get Identifier for this gas gap
    //
    gapid = rpcIdHelper.gapID(stationName, stationEta, stationPhi, doubletR,
                              doubletZ, doubletPhi, gasgap, gapid_valid);
 
    if (gapid_valid) {
        gapid_str = idHelperSvc.toString(gapid);
    } else {
        gapid_str = idHelperSvc.toString(gapid) + " - INVALID ID";
    }
 
    NetaStrips = readoutEl->NetaStrips();
    NphiStrips = readoutEl->NphiStrips();
 
    // Determine gas gap span in eta
    const Identifier etaIdFirst{rpcIdHelper.channelID(gapid, doubletZ, doubletPhi, gasgap, false, 1)};
    const Amg::Vector3D glbPos_etaStrip_1st = readoutEl->stripPos(etaIdFirst);
    double eta_etaStrip_1st = glbPos_etaStrip_1st.eta();
 
    const Identifier etaIdLast{rpcIdHelper.channelID(gapid, doubletZ, doubletPhi, gasgap, false, NetaStrips)};
    const Amg::Vector3D glbPos_etaStrip_last = readoutEl->stripPos(etaIdLast);
    double eta_etaStrip_last = glbPos_etaStrip_last.eta();
 
    if (eta_etaStrip_1st < eta_etaStrip_last) {
        minStripEta = eta_etaStrip_1st;
        maxStripEta = eta_etaStrip_last;
    } else {
        minStripEta = eta_etaStrip_last;
        maxStripEta = eta_etaStrip_1st;
    }
 
    //
    // Determine gas gap span in phi
    //
    const Identifier phiIdFirst{rpcIdHelper.channelID(gapid, doubletZ, doubletPhi, gasgap, true, 1)};
    const Amg::Vector3D glbPos_phiStrip_1st = readoutEl->stripPos(phiIdFirst);
    double phi_phiStrip_1st = glbPos_phiStrip_1st.phi();
 
    const Identifier phiIdLast{rpcIdHelper.channelID(gapid, doubletZ, doubletPhi, gasgap, true, NphiStrips)};
    const Amg::Vector3D glbPos_phiStrip_last = readoutEl->stripPos(phiIdLast);
    double phi_phiStrip_last = glbPos_phiStrip_last.phi();
 
    if (phi_phiStrip_1st < phi_phiStrip_last) {
        minStripPhi = phi_phiStrip_1st;
        maxStripPhi = phi_phiStrip_last;
    } else {
        minStripPhi = phi_phiStrip_last;
        maxStripPhi = phi_phiStrip_1st;
    }
}
 
//========================================================================================================
void GasGapData::computeTrackDistanceToGasGap(
    ExResult &result, const xAOD::TrackParticle &track) const {
    /*
      This function:
      - computes minum DR distance between track and RpcReadoutElement
      - do this before expensive call to extrapolator
     */
 
    const double deta1 = std::abs(minStripEta - track.eta());
    const double deta2 = std::abs(maxStripEta - track.eta());
 
    const double dphi1 =
        std::abs(xAOD::P4Helpers::deltaPhi(minStripPhi, track.phi()));
    const double dphi2 =
        std::abs(xAOD::P4Helpers::deltaPhi(maxStripPhi, track.phi()));
 
    result.minTrackGasGapDEta = std::min<double>(deta1, deta2);
    result.minTrackGasGapDPhi = std::min<double>(dphi1, dphi2);
 
    //
    // Now check if track position is between min and max - if true, set
    // distance to zero
    //
    if (minStripEta <= track.eta() && track.eta() <= maxStripEta) {
        result.minTrackGasGapDEta = 0.0;
    }
    if (minStripPhi <= track.phi() && track.phi() <= maxStripPhi) {
        result.minTrackGasGapDPhi = 0.0;
    }
 
    //
    // Compute min DR to this gas gap
    //
    result.minTrackGasGapDR =
        std::sqrt(result.minTrackGasGapDEta * result.minTrackGasGapDEta +
                  result.minTrackGasGapDPhi * result.minTrackGasGapDPhi);
}
 
//========================================================================================================
void GasGapData::computeTrackDistanceToGasGap(
    ExResult &result, const Trk::TrackParameters *trackParam) const {
    /*
      This function:
      - computes minum DR distance between track and RpcReadoutElement
      - do this before expensive call to extrapolator
     */
 
    const double deta1 = std::abs(minStripEta - trackParam->position().eta());
    const double deta2 = std::abs(maxStripEta - trackParam->position().eta());
 
    const double dphi1 = std::abs(
        xAOD::P4Helpers::deltaPhi(minStripPhi, trackParam->position().phi()));
    const double dphi2 = std::abs(
        xAOD::P4Helpers::deltaPhi(maxStripPhi, trackParam->position().phi()));
 
    result.minTrackGasGapDEta = std::min<double>(deta1, deta2);
    result.minTrackGasGapDPhi = std::min<double>(dphi1, dphi2);
 
    //
    // Now check if trackParam->position() position is between min and max - if
    // true, set distance to zero
    //
    if (minStripEta <= trackParam->position().eta() &&
        trackParam->position().eta() <= maxStripEta) {
        result.minTrackGasGapDEta = 0.0;
    }
    if (minStripPhi <= trackParam->position().phi() &&
        trackParam->position().phi() <= maxStripPhi) {
        result.minTrackGasGapDPhi = 0.0;
    }
 
    //
    // Compute min DR to this gas gap
    //
    result.minTrackGasGapDR =
        std::sqrt(result.minTrackGasGapDEta * result.minTrackGasGapDEta +
                  result.minTrackGasGapDPhi * result.minTrackGasGapDPhi);
}