MdtAnalyticRtCalibAlg.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#include "MdtAnalyticRtCalibAlg.h"
 
#include "StoreGate/ReadCondHandle.h"
#include "StoreGate/WriteCondHandle.h"
 
#include "MdtCalibData/CalibParamSorter.h"
#include "MdtCalibData/RtFromPoints.h"
#include "MdtCalibData/SamplePointUtils.h"
 
#include "MuonVisualizationHelpersR4/VisualizationHelpers.h"
#include "TGraph.h"
#include "TGraphErrors.h"
#include "TH1F.h"
#include "TCanvas.h"
#include "TLegend.h"
#include "TROOT.h"
 
#include <format>
 
using namespace MuonCalib;
using namespace Acts;
namespace MuonCalibR4{
 
    StatusCode MdtAnalyticRtCalibAlg::initialize() {
        ATH_CHECK(m_idHelperSvc.retrieve());
        ATH_CHECK(m_readKey.initialize());
        ATH_CHECK(m_writeKey.initialize());
        if (m_saveDiagnostic) {
            ATH_CHECK(m_visualSvc.retrieve());
            m_clientToken.canvasLimit = -1;
            m_clientToken.preFixName = "AnalyticMdtCalib";
            ATH_CHECK(m_visualSvc->registerClient(m_clientToken));
       }
       return StatusCode::SUCCESS;
    } 
    StatusCode MdtAnalyticRtCalibAlg::execute(const EventContext& ctx) const {
      SG::WriteCondHandle writeHandle{m_writeKey, ctx};
      if(writeHandle.isValid()) {
          ATH_MSG_DEBUG("CondHandle " << writeHandle.fullKey() << " is already valid.");
          return StatusCode::SUCCESS;
      }
      SG::ReadCondHandle readHandle{m_readKey, ctx};
      ATH_CHECK(readHandle.isValid());
      writeHandle.addDependency(readHandle);
      auto writeCdo = std::make_unique<MdtCalibDataContainer>(m_idHelperSvc.get(), readHandle->granularity());
      const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
      std::map<RtRelationPtr, RtRelationPtr, CalibParamSorter> translatedRts{CalibParamSorter{std::pow(0.1, m_precCutOff)}};
      
      RtRelationPtr dummyFillerRt{};
      MdtFullCalibData::CorrectionPtr dummyFillerCorr{};
      std::unordered_set<Identifier> missedElements{};
      for (auto itr = idHelper.detectorElement_begin(); itr != idHelper.detectorElement_end(); ++itr){
          const Identifier& detId{*itr};
          if (!readHandle->hasDataForChannel(detId, msgStream())){
              ATH_MSG_VERBOSE("There's no calibration data available for "<<m_idHelperSvc->toStringDetEl(detId));
              missedElements.insert(detId);
              continue;
          }
          const MdtFullCalibData* copyMe = readHandle->getCalibData(detId, msgStream());
          
          if (copyMe->corrections && !writeCdo->storeData(detId, copyMe->corrections, msgStream())) {
            return StatusCode::FAILURE;
          }
          const std::vector<Identifier> tubes = tubeIds(detId);
          if (std::ranges::none_of(tubes, [copyMe](const Identifier& tubeId){
                return !copyMe->tubeCalib->getCalib(tubeId);
          })) {
            if (!writeCdo->storeData(detId, copyMe->tubeCalib, msgStream())) {
                return StatusCode::FAILURE;
            }
          } else {
            ATH_MSG_VERBOSE("Tube calibration constants invalid for: "<<m_idHelperSvc->toStringDetEl(detId));
            missedElements.insert(detId);
          }
 
          RtRelationPtr& translated = translatedRts[copyMe->rtRelation];
          if (!translated) {
              translated = translateRt(ctx, detId, *copyMe->rtRelation);
          }
          if (!dummyFillerRt) {
            dummyFillerRt = translated;
            dummyFillerCorr = copyMe->corrections;
          }
          if (!writeCdo->storeData(detId, translated, msgStream())) {
            ATH_MSG_FATAL("Failed to store rt relation for "<<m_idHelperSvc->toStringDetEl(detId));
            return StatusCode::FAILURE;
          }
      }
      if (!m_fillMissingCh) {
        missedElements.clear();
      }
      for (const Identifier& detId: missedElements) {
        ATH_MSG_WARNING("Initial container did not contain any constants for "<<m_idHelperSvc->toString(detId)
                        <<". Insert instead the first translated rt-relation for those channels");
        const bool fillRt = !writeCdo->hasDataForChannel(detId, msgStream()) || 
                            !writeCdo->getCalibData(detId, msgStream())->rtRelation;
        if(fillRt) {
            if (!writeCdo->storeData(detId, dummyFillerRt, msgStream())) {
                ATH_MSG_FATAL("Failed to store rt relation for "<<m_idHelperSvc->toStringDetEl(detId));
                return StatusCode::FAILURE;
            }
            if (dummyFillerCorr && !writeCdo->storeData(detId, dummyFillerCorr, msgStream())) {
                return StatusCode::FAILURE;
            }
        }
        if (writeCdo->getCalibData(detId, msgStream())->tubeCalib) {
            continue;
        }
        MdtCalibDataContainer::TubeContainerPtr dummyT0cont = std::make_unique<MdtTubeCalibContainer>(m_idHelperSvc.get(), detId);
        MdtTubeCalibContainer::SingleTubeCalib dummyT0Calib{};
        dummyT0Calib.t0 = m_missingT0;
        for (const Identifier& tubeId : tubeIds(detId)) {
            if (!dummyT0cont->setCalib(dummyT0Calib, tubeId, msgStream())) {
                return StatusCode::FAILURE;
            } 
        }
        if (!writeCdo->storeData(detId, std::move(dummyT0cont), msgStream())) {
            return StatusCode::FAILURE;
        }
      }
      ATH_CHECK(writeHandle.record(std::move(writeCdo)));
      return StatusCode::SUCCESS;
    }
    std::vector<Identifier> MdtAnalyticRtCalibAlg::tubeIds(const Identifier& chId) const {
        std::vector<Identifier> tubes{};
         const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
        for (int ml = 1; ml <= idHelper.multilayerMax(chId); ++ml) {
            const Identifier detId = idHelper.multilayerID(chId, ml);
            for (int layer = 1; layer <= idHelper.tubeLayerMax(detId); ++layer) {
                for (int tube = 1; tube <= idHelper.tubeMax(detId); ++tube) {
                    tubes.emplace_back(idHelper.channelID(detId, ml, layer, tube));
                }
            }
        }
        return tubes;
    }
 
    MdtAnalyticRtCalibAlg::RtRelationPtr 
        MdtAnalyticRtCalibAlg::translateRt(const EventContext& ctx,
                                           const Identifier& detId,
                                           const MdtRtRelation& inRel) const {
        
        const std::vector<SamplePoint> rtPoints = fetchDataPoints(*inRel.rt(), *inRel.rtRes());
        IRtRelationPtr rt{};
        ITrRelationPtr tr{};
        unsigned int order{0};
        while (order++ <= m_maxOrder && !rt) {
            ATH_MSG_DEBUG("Attempt to fit rt relation for "<<m_idHelperSvc->toStringDetEl(detId)
                        <<" using a polynomial of order  "<<order);
            switch(m_polyTypeRt) {
                case toUnderlying(PolyType::ChebyChev):
                    rt = RtFromPoints::getRtChebyshev(rtPoints, order);
                    break;
                case toUnderlying(PolyType::Legendre): 
                    rt = RtFromPoints::getRtLegendre(rtPoints, order);
                    break;
                case toUnderlying(PolyType::Simple): 
                    rt = RtFromPoints::getRtSimplePoly(rtPoints, order);
                    break;
                default:
                    break;
            }
            const unsigned rtNdoF = rtPoints.size() - rt->nDoF();
            const double rtChi2 = calculateChi2(rtPoints, *rt) / rtNdoF;
            ATH_MSG_VERBOSE("Fit has a chi2 of "<<rtChi2<<". Cut off at "<<m_chiCutOff);
            if (rtChi2  > m_chiCutOff) {
                rt.reset();
            }
        }
        if (!rt) {
            ATH_MSG_ERROR("Failed to fit rt relation for "<<m_idHelperSvc->toStringDetEl(detId));
            return nullptr;
        }
        const std::vector<SamplePoint> trPoints = swapCoordinates(rtPoints, *rt);
        order = 0;
        while (order++ <= m_maxOrder && !tr) {
            ATH_MSG_DEBUG("Now continue with tr fit for "<<m_idHelperSvc->toStringDetEl(detId)
                        <<" using a polynomial of order  "<<order);
            switch(m_polyTypeTr) {
                case toUnderlying(PolyType::Legendre): 
                    tr = RtFromPoints::getTrLegendre(trPoints, order);
                    break;
                case toUnderlying(PolyType::ChebyChev):
                    tr = RtFromPoints::getTrChebyshev(trPoints, order);
                    break;
                case toUnderlying(PolyType::Simple): 
                    tr = RtFromPoints::getTrSimplePoly(trPoints, order);
                    break;
                default:
                    break;
            }
            const unsigned trNdoF = rtPoints.size() - tr->nDoF();
            const double trChi2 = calculateChi2(trPoints, *tr) / trNdoF; 
            ATH_MSG_VERBOSE("T-R fit resulted in a chi2/nDoF for tr: "<<trChi2<<" ("<<trNdoF<<")");
            if (trChi2 > m_chiCutOff) {
                tr.reset();
            }
        }        
        if (!tr) {
            ATH_MSG_FATAL("Failed to fit tr relation for "<<m_idHelperSvc->toStringDetEl(detId));
            return nullptr;
        }
        auto rtReso = inRel.smartReso();
        if (m_fitRtReso) {
            std::unique_ptr<IRtResolution> fittedReso{};
            std::vector<SamplePoint> rtResoPoints = fetchResolution(rtPoints, m_relUncReso);
            order = 0;
            while (order++ <= m_maxOrderReso && !fittedReso) {
                ATH_MSG_VERBOSE("Finally fit the resolution function "<<m_idHelperSvc->toStringDetEl(detId)
                        <<" using a polynomial of order  "<<order);
                fittedReso = RtFromPoints::getResoChebyshev(rtPoints, rt, m_relUncReso, order);
                const unsigned nDoF = rtResoPoints.size() - fittedReso->nDoF();
                const double chi2 = calculateChi2(rtResoPoints, *fittedReso) / nDoF;
                ATH_MSG_VERBOSE("Fit has a chi2 of "<<chi2<<". Cut off at "<<m_chiCutOff);
                if (chi2  > m_chiCutOff) {
                    if (order == m_maxOrderReso) {
                        drawResoFunc(ctx, detId, rtResoPoints, *fittedReso);
                    }
                    fittedReso.reset();
                }
            }
 
            if (fittedReso) {
                drawResoFunc(ctx, detId, rtResoPoints, *fittedReso);
                rtReso = std::move(fittedReso);
            } else {
                ATH_MSG_WARNING("Despite of having a "<<m_maxOrderReso
                            <<" no rt resolution function could be fitted for "<<m_idHelperSvc->toStringDetEl(detId));
            }
        }
        auto finalRt = std::make_unique<MdtRtRelation>(std::move(rt), rtReso, std::move(tr)); 
        drawRt(ctx, detId, rtPoints, *finalRt);
        return finalRt;
    }
    void MdtAnalyticRtCalibAlg::drawRt(const EventContext& ctx, 
                                       const Identifier& detId,
                                       const std::vector<SamplePoint>& rtPoints,
                                       const MdtRtRelation& inRel) const {
        if (!m_saveDiagnostic) {
            return;
        }
        const std::string chName = std::format("{:}{:d}{:}{:d}M{:1d}",
                                               m_idHelperSvc->stationNameString(detId),
                                               std::abs(m_idHelperSvc->stationEta(detId)),
                                               m_idHelperSvc->stationEta(detId)> 0? 'A' : 'C',
                                               m_idHelperSvc->stationPhi(detId),
                                               m_idHelperSvc->mdtIdHelper().multilayer(detId));
        auto canvas = m_visualSvc->prepareCanvas(ctx, m_clientToken, std::format("RtRelation_{:}", chName) );
        canvas->setAxisTitles("drift time [ns]", "drift radius [mm]");
        auto dataGraph = std::make_unique<TGraphErrors>();
        for (const SamplePoint& dataPoint : rtPoints) {
            dataGraph->SetPoint(dataGraph->GetN(), dataPoint.x1(), dataPoint.x2());
            dataGraph->SetPointError(dataGraph->GetN()-1, 0., dataPoint.error());
            canvas->expandPad(dataPoint.x1(), dataPoint.x2());
        }
 
        auto rtGraph = std::make_unique<TGraph>();
        auto trGraph = std::make_unique<TGraph>();
 
        double driftTime{inRel.rt()->tLower()};
        while (driftTime <= inRel.rt()->tUpper()) {
            const double radius = inRel.rt()->radius(driftTime);
            const double backRadius = std::clamp(radius,inRel.tr()->minRadius(), inRel.tr()->maxRadius());
            const double backTime = inRel.tr()->driftTime(backRadius).value_or(-666.);
            rtGraph->SetPoint(rtGraph->GetN(), driftTime, radius);
            trGraph->SetPoint(trGraph->GetN(), backTime, radius);
            canvas->expandPad(driftTime, radius);
            canvas->expandPad(backTime, radius);
            driftTime+=1.;
        }
       
        const unsigned rtNDoF= rtPoints.size() - inRel.rt()->nDoF();
        const unsigned trNDoF= rtPoints.size() - inRel.tr()->nDoF();
        const double rtChi2 = calculateChi2(rtPoints, *inRel.rt())/ rtNDoF;
        const double trChi2 = calculateChi2(swapCoordinates(rtPoints, *inRel.rt()), *inRel.tr())/ trNDoF;
 
        auto legend = std::make_unique<TLegend>(0.2,0.7,0.6, 0.9,chName.c_str());
        legend->SetFillStyle(0);
        legend->SetBorderSize(0);
        legend->AddEntry(rtGraph.get(),std::format("{:}, order: {:d}, #chi^{{2}}: {:.3f}({:d})",
                                                        inRel.rt()->name(), inRel.rt()->nDoF(), rtChi2, rtNDoF).c_str(),"L");
 
        legend->AddEntry(trGraph.get(),std::format("{:}, order: {:d}, #chi^{{2}}: {:.3f}({:d})",
                                                        inRel.tr()->name(), inRel.tr()->nDoF(), trChi2, trNDoF).c_str(),"L");
 
        dataGraph->SetMarkerSize(0);
        rtGraph->SetLineColor(kRed);
        trGraph->SetLineColor(kBlue);
 
        canvas->add(std::move(dataGraph), "P");
        canvas->add(std::move(rtGraph), "C");
        canvas->add(std::move(trGraph), "C");
        canvas->add(std::move(legend));
    }
    
    void MdtAnalyticRtCalibAlg::drawResoFunc(const EventContext& ctx,
                                             const Identifier& detId,
                                             const std::vector<SamplePoint>& resoPoints,
                                             const IRtResolution& inReso) const{
 
        const std::string chName = std::format("{:}{:d}{:}{:d}M{:1d}",
                                               m_idHelperSvc->stationNameString(detId),
                                               std::abs(m_idHelperSvc->stationEta(detId)),
                                               m_idHelperSvc->stationEta(detId)> 0? 'A' : 'C',
                                               m_idHelperSvc->stationPhi(detId),
                                               m_idHelperSvc->mdtIdHelper().multilayer(detId));
 
        auto canvas = m_visualSvc->prepareCanvas(ctx, m_clientToken, std::format("RtReso_{:}", chName) );
        canvas->setAxisTitles("drift time [ns]", "#sigma(r_{drift}) [mm]");
        auto dataGraph = std::make_unique<TGraphErrors>();
        for (const SamplePoint& dataPoint : resoPoints) {
            dataGraph->SetPoint(dataGraph->GetN(), dataPoint.x1(), dataPoint.x2());
            dataGraph->SetPointError(dataGraph->GetN()-1, 0., dataPoint.error());
            canvas->expandPad(dataPoint.x1(), dataPoint.x2());
        }
        auto resoGraph = std::make_unique<TGraph>();
        const auto [tLow, tHigh] = interval(resoPoints);
        const auto [resoLow, resoHigh] = minMax(resoPoints);
        canvas->expandPad(tLow, resoLow);
        canvas->expandPad(tHigh, resoHigh);
        double driftTime{tLow};
        while (driftTime <= tHigh) {
            const double evalReso = inReso.resolution(driftTime);
            resoGraph->SetPoint(resoGraph->GetN(), driftTime, evalReso);
            driftTime+=0.5;
        }
        canvas->add(std::move(dataGraph), "P");
        canvas->add(std::move(resoGraph), "C");
 
        const double chi2 = calculateChi2(resoPoints, inReso) / (resoPoints.size() - inReso.nDoF());
        canvas->add(MuonValR4::drawLabel(std::format("{:}, {:}, order: {:1d}  #chi^{{2}}: {:.3f}", chName, inReso.name(), 
                                                        inReso.nDoF(), chi2), 0.2, 0.8));
    } 
}