MuonCalibTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// Framework include(s):
#include "AsgDataHandles/ReadHandle.h"
#include "PathResolver/PathResolver.h"
#include "xAODCore/ShallowCopy.h"
 
// Local include(s):
#include <cmath>
#include "TRandom3.h"
 
#include "MuonMomentumCorrections/MuonCalibTool.h"
 
#include "ColumnarCore/OptObjectId.h"
 
namespace ADD_CMODE(CP)
{
 
    MuonCalibTool::MuonCalibTool(const std::string &name) : asg::AsgTool(name){
        
        m_MuonSelectionTool.declarePropertyFor(this,"MuonSelectionTool", "Instance of the MuonSelectionTool needed for the HighPt categorization");
        m_MuonIntSagittaTool.declarePropertyFor(this, "SagittaTool", "Instance of the Sagitta bias corrections sub tool");
        m_MuonIntScaleSmearTool.declarePropertyFor(this, "ScaleAndSmearTool", "Instance of the tool that applies the smearing & scale corrections");
        m_MuonIntHighTSmearTool.declarePropertyFor(this, "HighPtSmearingTool", "Extra smearing of the high pt working point");       
    }
 
    StatusCode MuonCalibTool::initialize()
    {
        // Greet the user:
        ATH_MSG_INFO("Initialising...");
 
        // Get the m_eventinfo container
        ATH_CHECK(m_eventInfo.initialize());
 
        // Set the options
        if (m_calibMode == MuonCalibTool::correctData_CB) {
            ATH_MSG_INFO("Data will be corrected for sagitta bias and Montecarlo will be corrected using CB calibration");
        m_applyCorrectionOnData = true;
        } else if (m_calibMode == MuonCalibTool::correctData_IDMS) {
            ATH_MSG_INFO("Data will be corrected for sagitta bias and Montecarlo will be corrected using ID+MS calibration");
        m_applyCorrectionOnData = true;
        } else if (m_calibMode == MuonCalibTool::notCorrectData_IDMS) {
        ATH_MSG_INFO("Data will be untouched (no sagitta bias corrections) and Montecarlo will be corrected using ID+MS calibration");
        m_applyCorrectionOnData = false;
        } else if (m_calibMode == MuonCalibTool::notCorrectData_CB) {
            ATH_MSG_INFO("Data will be untouched (no sagitta bias corrections) and Montecarlo will be corrected using CB calibration");
        m_applyCorrectionOnData = false;
    } else if (m_calibMode == MuonCalibTool::correctData_IDonly) {
        ATH_MSG_INFO("Data will be corrected for sagitta bias and Montecarlo will be corrected using ID calibration only");
        m_applyCorrectionOnData = true;
    } else if (m_calibMode == MuonCalibTool::correctData_MSonly) {
        ATH_MSG_INFO("Data will be corrected for sagitta bias and Montecarlo will be corrected using MS calibration only");
        m_applyCorrectionOnData = true;
    } else if (m_calibMode == MuonCalibTool::userDefined) {
            ATH_MSG_INFO("Using options as provided by the user");
        } 
        else {
            ATH_MSG_FATAL("Invalid  calibration mode: " << m_calibMode << " Allowed modes are correctData_CB("
                                                        << MuonCalibTool::correctData_CB << ") correctData_IDMS ("
                                                        << MuonCalibTool::correctData_IDMS << ") or notCorrectData_IDMS ("
                                                        << MuonCalibTool::notCorrectData_IDMS << ") or notCorrectData_CB ("
                                                        << MuonCalibTool::notCorrectData_CB << ") or correctData_IDonly ("
                                            << MuonCalibTool::correctData_IDonly << ") or correctData_MSonly ("
                                            << MuonCalibTool::correctData_MSonly << ")");
            return StatusCode::FAILURE;
        }
 
        if (!m_skipResolutionCategory.value())
        {
            // Get the muon selection tool
            if (m_MuonSelectionTool.empty()) {
                m_MuonSelectionTool.setTypeAndName("CP::MuonSelectionTool/MCaST_Own_MST");
                ATH_CHECK(m_MuonSelectionTool.setProperty("MaxEta", 2.7));
                ATH_CHECK(m_MuonSelectionTool.setProperty("MuQuality", 1));
                ATH_CHECK(m_MuonSelectionTool.setProperty("TurnOffMomCorr", true));
                ATH_CHECK(m_MuonSelectionTool.setProperty("IsRun3Geo", m_isRun3.value()));
                ATH_CHECK(m_MuonSelectionTool.setProperty("OutputLevel", msg().level()));
        ATH_CHECK(m_MuonSelectionTool.setProperty("ExcludeNSWFromPrecisionLayers", m_excludeNSWFromPrecisionLayers.value()));
            }
            ATH_CHECK(m_MuonSelectionTool.retrieve());
            if (auto *selectionTool = dynamic_cast<columnar::ColumnarTool<>*>(m_MuonSelectionTool.get()))
                addSubtool (*selectionTool);
        }
 
        // Create the Sagitta tool
        if (m_MuonIntSagittaTool.empty()) {
            m_MuonIntSagittaTool.setTypeAndName(columnar::add_cmode("CP") + "::MuonCalibIntSagittaTool/" + name() + "_MCaST_Sagitta");
            ATH_CHECK(m_MuonIntSagittaTool.setProperty("release", m_release.value()));
            ATH_CHECK(m_MuonIntSagittaTool.setProperty("systematicScheme", m_sysScheme.value()));
        ATH_CHECK(m_MuonIntSagittaTool.setProperty("calibMode", m_calibMode));
            ATH_CHECK(m_MuonIntSagittaTool.setProperty("doEtaSagittaSys", m_doEtaSagittaSys.value()));
            ATH_CHECK(m_MuonIntSagittaTool.setProperty("OutputLevel", msg().level()));
        }       
        ATH_CHECK(m_MuonIntSagittaTool.retrieve());
 
        // Create the scale smear tool
        if (m_MuonIntScaleSmearTool.empty()) {
            m_MuonIntScaleSmearTool.setTypeAndName(columnar::add_cmode("CP") + "::MuonCalibIntScaleSmearTool/" + name() + "_MCaST_ScaleSmear");
            ATH_CHECK(m_MuonIntScaleSmearTool.setProperty("release", m_release.value()));
            ATH_CHECK(m_MuonIntScaleSmearTool.setProperty("systematicScheme", m_sysScheme.value()));
            ATH_CHECK(m_MuonIntScaleSmearTool.setProperty("calibMode", m_calibMode));
            ATH_CHECK(m_MuonIntScaleSmearTool.setProperty("OutputLevel", msg().level()));
        }
        ATH_CHECK(m_MuonIntScaleSmearTool.retrieve());
        
        if (m_extra_highpt_smearing || m_2stations_highpt_smearing) {
            if (m_MuonIntHighTSmearTool.empty()) {
                m_MuonIntHighTSmearTool.setTypeAndName(columnar::add_cmode("CP") + "::MuonCalibIntHighpTSmearTool/" + name() + "_MCaST_highPtScaleSmear");
                ATH_CHECK(m_MuonIntHighTSmearTool.setProperty("release", m_release.value()));
                ATH_CHECK(m_MuonIntHighTSmearTool.setProperty("OutputLevel", msg().level()));
            }
            ATH_CHECK(m_MuonIntHighTSmearTool.retrieve());
            m_MuonIntHighTSmearToolInitialized = !m_MuonIntHighTSmearTool.empty();
        }
        if (!applySystematicVariation(CP::SystematicSet()))
        {
            ATH_MSG_ERROR("Unable to run with no systematic");
            return StatusCode::FAILURE;
        }
        CP::SystematicRegistry &registry = CP::SystematicRegistry::getInstance();
        if (registry.registerSystematics(*this) != StatusCode::SUCCESS)
        {
            ATH_MSG_ERROR("Unkown systematic list");
            return StatusCode::FAILURE;
        }
        ATH_CHECK (initializeColumns());
        // Return gracefully:
        return StatusCode::SUCCESS;
    }
 
    CP::CorrectionCode MuonCalibTool::applyCorrection(xAOD::Muon &mu) const
    {
        // Retrieve the event information:
        SG::ReadHandle<xAOD::EventInfo> evtInfo(m_eventInfo);
        return applyCorrection(columnar::MuonId(mu), columnar::EventInfoId(*evtInfo));
    }
 
    CP::CorrectionCode MuonCalibTool::applyCorrection(columnar::MuonId mu, columnar::EventInfoId evtInfo) const
    {
        auto& acc = *m_acc;
        ATH_MSG_VERBOSE("Muon Type = " << mu(acc.muonTypeAcc) << " ( 0: Combined, 1: StandAlone, 2: SegmentTagged, 3: CaloTagged, 4: SiliconAssociatedForwardMuon)");
        ATH_MSG_VERBOSE("Muon Author = " << mu(acc.authorAcc));
 
        // Convert to the internal object
        MCP::MuonObj muonObj = convertToMuonObj(mu, evtInfo);
        
        ATH_MSG_VERBOSE("input ID pT "<<muonObj.ID.calib_pt);
        ATH_MSG_VERBOSE("input ME pT "<<muonObj.ME.calib_pt);
        ATH_MSG_VERBOSE("input CB pT "<<muonObj.CB.calib_pt);
        ATH_MSG_VERBOSE("input eta "<<muonObj.CB.eta);
        ATH_MSG_VERBOSE("input phi "<<muonObj.CB.phi);
 
        if (muonObj.CB.isData) 
        {
            ATH_MSG_VERBOSE("Doing data corrections");
 
            // Sagitta Correction  specifics
            if (m_applyCorrectionOnData) 
            {
                CP::CorrectionCode sgCode = m_MuonIntSagittaTool->applyCorrection(muonObj);
                if (sgCode != CP::CorrectionCode::Ok) return sgCode;
            }
 
            // Override combined momentum for special cases
            if (std::abs(muonObj.ME.calib_pt) == 0) muonObj.CB.calib_pt = muonObj.ID.calib_pt;
            if (std::abs(muonObj.ID.calib_pt) == 0) muonObj.CB.calib_pt = muonObj.ME.calib_pt;
 
            // Only for combined set it
            if (mu(acc.muonTypeAcc) == xAOD::Muon::MuonType::Combined) 
            {
                acc.ptOutDec (mu) = muonObj.CB.calib_pt * GeVtoMeV;
            }
 
 
            acc.dec_idPt(mu) = muonObj.ID.calib_pt * GeVtoMeV;
            acc.dec_mePt(mu) = muonObj.ME.calib_pt * GeVtoMeV;
            acc.dec_idCharge(mu) = muonObj.ID.calib_charge;
            acc.dec_meCharge(mu) = muonObj.ME.calib_charge;
 
            ATH_MSG_DEBUG("Checking Output Muon Info for data - Pt_ID: " << acc.dec_idPt(mu));
            ATH_MSG_DEBUG("Checking Output Muon Info for data - Pt_MS: " << acc.dec_mePt(mu));
            ATH_MSG_DEBUG("Checking Output Muon Info for data - Pt_CB: " << mu(acc.ptAcc));
 
            return CP::CorrectionCode::Ok;
        }
 
        // Do Scale and Smearing corrections
        CP::CorrectionCode sgCode = m_MuonIntScaleSmearTool->applyCorrection(muonObj);
        if (sgCode != CP::CorrectionCode::Ok) return sgCode;
 
        // Systematics for sagitta correction
        if ((mu(acc.muonTypeAcc) != xAOD::Muon::MuonType::SiliconAssociatedForwardMuon)) 
        {
            ATH_MSG_VERBOSE("Systematic uncertainties for sagitta bias ");
            // TODO:: something specific for calo tags
            CP::CorrectionCode sgCode = m_MuonIntSagittaTool->applyCorrection(muonObj);
            if (sgCode != CP::CorrectionCode::Ok) return sgCode;
        }
 
        // Override combined momentum for special cases
        if (std::abs(muonObj.ME.calib_pt) == 0) muonObj.CB.calib_pt = muonObj.ID.calib_pt;
        if (std::abs(muonObj.ID.calib_pt) == 0) muonObj.CB.calib_pt = muonObj.ME.calib_pt;
 
        // Setting the output object properties right now, so the resolution category get the corrected info
        acc.ptOutDec(mu) = muonObj.CB.calib_pt * GeVtoMeV;
        acc.chargeOutDec(mu) = muonObj.CB.calib_charge;
        acc.dec_idPt(mu) = muonObj.ID.calib_pt * GeVtoMeV;
        acc.dec_mePt(mu) = muonObj.ME.calib_pt * GeVtoMeV;
        acc.dec_idCharge(mu) = muonObj.ID.calib_charge;
        acc.dec_meCharge(mu) = muonObj.ME.calib_charge;
 
        if(!m_validationMode && !m_skipResolutionCategory.value())
        {
            muonObj.raw_mst_category = (CP::IMuonSelectionTool::ResolutionCategory) m_MuonSelectionTool->getResolutionCategory(mu.getXAODObject());
        }
 
        // Special case: if the proper flags are selected (m_extra_highpt_smearing or m_2stations_highpt_smearing)
        // an ad-hoc smearing of the combined momentum has to be applied
        bool extra_smearing   = (m_extra_highpt_smearing && (muonObj.raw_mst_category.value() >= 0) && !( muonObj.raw_mst_category.value() & CP::IMuonSelectionTool::CategoryFour));  // Extra smearing, if selected, gets anyway only applied to non-3-station muons!
        bool highpt_smearing = (m_2stations_highpt_smearing && (muonObj.raw_mst_category.value() >= 0) && ( muonObj.raw_mst_category.value() & CP::IMuonSelectionTool::CategoryThree));  // Special highpt smearing, if selected, gets anyway only applied to missing-inner, 2-station muons only!
 
        if (((extra_smearing || highpt_smearing)) && (mu(acc.ptAcc) > m_HighPtSystThreshold * GeVtoMeV))
        {
            sgCode = m_MuonIntHighTSmearTool->applyCorrection(muonObj);
            if (sgCode != CP::CorrectionCode::Ok) return sgCode;
        }
 
        // Final info to be written to the muon object
        acc.ptOutDec(mu) = muonObj.CB.calib_pt * GeVtoMeV;
        acc.dec_idPt(mu) = muonObj.ID.calib_pt * GeVtoMeV;
        acc.dec_mePt(mu) = muonObj.ME.calib_pt * GeVtoMeV;
 
 
        ATH_MSG_DEBUG("Checking Output Muon Info - Pt_ID: " << acc.dec_idPt(mu));
        ATH_MSG_DEBUG("Checking Output Muon Info - Pt_MS: " << acc.dec_mePt(mu));
        ATH_MSG_DEBUG("Checking Output Muon Info - Pt_CB: " << acc.ptOutDec(mu));
 
        // If saggita was out of validity, return it here
        if (sgCode == CP::CorrectionCode::OutOfValidityRange) return sgCode;
 
        // Return gracefully:
        return CP::CorrectionCode::Ok;
    }
 
    CP::CorrectionCode MuonCalibTool::applyCorrectionTrkOnly(xAOD::TrackParticle &inTrk, const int DetType) const
    {
        // Convert to the internal object
        MCP::MuonObj muonObj = convertToMuonObj(inTrk, DetType);
 
        // Do Scale and Smearing corrections
        CP::CorrectionCode sgCode = m_MuonIntScaleSmearTool->applyCorrection(muonObj);
        if (sgCode != CP::CorrectionCode::Ok) return sgCode;
 
        double res_pt = (DetType == MCP::DetectorType::MS) ? muonObj.ME.calib_pt*GeVtoMeV : muonObj.ID.calib_pt*GeVtoMeV;
 
        inTrk.setDefiningParameters(inTrk.d0(), inTrk.z0(), inTrk.phi0(), inTrk.theta(),
                            inTrk.charge() / (res_pt * std::cosh(inTrk.eta())));
 
        // Return gracefully:
        return CP::CorrectionCode::Ok;
    }
 
    CP::CorrectionCode MuonCalibTool::correctedCopy(const xAOD::Muon &input, xAOD::Muon *&output) const
    {
        // A sanity check:
        if (output)
            ATH_MSG_WARNING(
                "Non-null pointer received. "
                "There's a possible memory leak!");
 
        // Create a new object:
        ATH_MSG_VERBOSE("Going to create new xAOD::Muon...");
        output = new xAOD::Muon();
        ATH_MSG_VERBOSE("Calling makePrivateStore...");
        output->makePrivateStore(input);
 
        // Use the other function to modify this object:
        ATH_MSG_VERBOSE("Calling applyCorrection...");
 
        CP::CorrectionCode retCode = applyCorrection(*output);
 
        return retCode;
    }
 
    bool MuonCalibTool::isAffectedBySystematic(const CP::SystematicVariation &systematic) const
    {
        CP::SystematicSet sys = affectingSystematics();
        return sys.find(systematic) != sys.end();
    }
 
    CP::SystematicSet MuonCalibTool::affectingSystematics() const
    {
        CP::SystematicSet result = m_MuonIntSagittaTool->affectingSystematics();
        result.insert(m_MuonIntScaleSmearTool->affectingSystematics());
        if (m_MuonIntHighTSmearToolInitialized) result.insert(m_MuonIntHighTSmearTool->affectingSystematics());
        return result;
    }
 
    CP::SystematicSet MuonCalibTool::recommendedSystematics() const { return affectingSystematics(); }
 
    StatusCode MuonCalibTool::applySystematicVariation(const CP::SystematicSet &systConfig)
    {
        // Apply to the underlying tool
        StatusCode code = m_MuonIntSagittaTool->applySystematicVariation(systConfig);
        if(code != StatusCode::SUCCESS) return code;
        
        code = m_MuonIntScaleSmearTool->applySystematicVariation(systConfig);          
        if(code != StatusCode::SUCCESS) return code;
 
        if (m_MuonIntHighTSmearToolInitialized){
            code = m_MuonIntHighTSmearTool->applySystematicVariation(systConfig);          
            if(code != StatusCode::SUCCESS) return code;
        }
        return code;
    }
 
    double MuonCalibTool::expectedResolution(const std::string &DetType, const xAOD::Muon &mu, const bool addMCCorrectionSmearing) const
    {
        // Expected resolution in data (or unsmeared MC if second argument is true)
        if (DetType == "MS") {
            return expectedResolution(MCP::DetectorType::MS, mu, addMCCorrectionSmearing);
        } else if (DetType == "ID") {
            return expectedResolution(MCP::DetectorType::ID, mu, addMCCorrectionSmearing);
        } else if (DetType == "CB") {
            return expectedResolution(MCP::DetectorType::CB, mu, addMCCorrectionSmearing);
        } else {
            ATH_MSG_ERROR("The DetType that you entered is not allows - DetType = " << DetType);
            return 0.;
        }
    }
 
    double MuonCalibTool::expectedResolution(const int &DetType, const xAOD::Muon &mu, const bool addMCCorrectionSmearing) const
    {
        SG::ReadHandle<xAOD::EventInfo> evtInfo(m_eventInfo);
        return expectedResolution(DetType, columnar::MuonId(mu), columnar::EventInfoId(*evtInfo), addMCCorrectionSmearing);
    }
 
    double MuonCalibTool::expectedResolution(const int &DetType, columnar::MuonId mu, columnar::EventInfoId evtInfo, const bool addMCCorrectionSmearing) const
    {
        auto& acc = *m_acc;
        // Get information about data
        bool isData = false;
        if (m_validationMode) isData = m_expertMode_isData;
        else 
        {
            // Retrieve the event information:
            isData = !evtInfo(acc.eventTypeAcc, xAOD::EventInfo::IS_SIMULATION);
        }
 
        // Get information about which year it is here
        MCP::DataYear dataYear = MuonCalibTool::getPeriod(isData, evtInfo);
 
        // get the pt measurements from the xAOD::Muon object
        double loc_ptid = 0;
        double loc_ptms = 0;
        double loc_ptcb = 0;
 
        double Primary_eta = mu(acc.etaAcc);
        double Primary_phi = mu(acc.phiAcc);
 
        if (m_validationMode) 
        {
            static const SG::Accessor<float> id_pt("expert_ptid");
            static const SG::Accessor<float> ms_pt("expert_ptms");
            static const SG::Accessor<float> cb_pt("expert_ptcb");
 
            loc_ptid = id_pt(mu.getXAODObject()) * MeVtoGeV;
            loc_ptms = ms_pt(mu.getXAODObject()) * MeVtoGeV;
            loc_ptcb = cb_pt(mu.getXAODObject()) * MeVtoGeV;
 
        } else {
 
            // Retrieve all the trans
            auto CB_track = mu(acc.combinedTrackParticleLinkAcc);
            auto ID_track = mu(acc.inDetTrackParticleLinkAcc).opt_value();
            auto ME_track = mu(acc.extrapolatedMuonSpectrometerTrackParticleLinkAcc);
 
            if(CB_track) loc_ptcb = acc.trkMomentumAcc.pt(CB_track.value(), ParticleConstants::muonMassInMeV) * MeVtoGeV;
            if(ID_track) loc_ptid = acc.trkMomentumAcc.pt(ID_track.value(), ParticleConstants::muonMassInMeV) * MeVtoGeV;
            if(ME_track) loc_ptms = acc.trkMomentumAcc.pt(ME_track.value(), ParticleConstants::muonMassInMeV) * MeVtoGeV;
        }
 
        if (DetType == MCP::DetectorType::MS) 
        {
            return m_MuonIntScaleSmearTool->getExpectedResolution(DetType, loc_ptms, Primary_eta, Primary_phi, dataYear, addMCCorrectionSmearing);
        } 
        else if (DetType == MCP::DetectorType::ID) 
        {
            return m_MuonIntScaleSmearTool->getExpectedResolution(DetType, loc_ptid, Primary_eta, Primary_phi, dataYear, addMCCorrectionSmearing);
        } 
        else if (DetType == MCP::DetectorType::CB) 
        {
            // Due to complicated maths, the expected combined resolution
            // is given by this equation (note: all sigmas are fractional uncertainties):
            // sigma_CB = std::sqrt(2) * sigma_ID * sigma_MS * pTMS * pTID / {pTCB * std::sqrt({sigma_ID*pTID}^2 + {sigma_MS*pTMS}^2)}
            // Do a little recursive calling to make things easier to read
            // Turn these into *absolute* uncertainties to make life easier
            double sigmaID = expectedResolution(MCP::DetectorType::ID, mu, evtInfo, addMCCorrectionSmearing) * loc_ptid;
            double sigmaMS = expectedResolution(MCP::DetectorType::MS, mu, evtInfo, addMCCorrectionSmearing) * loc_ptms;
            double denominator = (loc_ptcb)*std::sqrt(sigmaID * sigmaID + sigmaMS * sigmaMS);
            return denominator ? sigmaID * sigmaMS / denominator : 0.;
        } 
        else
         {
            ATH_MSG_ERROR("wrong DetType in input " << DetType);
        }
        return 0.;
 
    }
 
    // Internal tool function
    MCP::MuonObj MuonCalibTool::convertToMuonObj(columnar::MuonId mu, columnar::EventInfoId evtInfo) const
    {
        auto& acc = *m_acc;
        // Get information about data
        bool isData = false;
        if (m_validationMode) isData = m_expertMode_isData;
        else 
        {
            // Retrieve the event information:
            isData = !evtInfo(acc.eventTypeAcc, xAOD::EventInfo::IS_SIMULATION);
        }
        ATH_MSG_VERBOSE("Checking Simulation flag: " << !isData);
 
        // Get information about which year it is here
        auto year = MuonCalibTool::getPeriod(isData, evtInfo);
 
 
        double Primary_eta = mu(acc.etaAcc);
        double Primary_phi = mu(acc.phiAcc);
        int charge = mu(acc.chargeAcc);
        double mass = ParticleConstants::muonMassInMeV * MeVtoGeV;
 
        if (m_validationMode)
        {
            static const SG::Accessor<float> cb_pt("expert_ptcb");
            static const SG::Accessor<float> id_pt("expert_ptid");
            static const SG::Accessor<float> ms_pt("expert_ptms");
            static const SG::Accessor<AmgVector(5)> CBParam("CBParam");
            static const SG::Accessor<AmgSymMatrix(5)> CBCov("CBCov");
            static const SG::Accessor<AmgVector(5)>  IDParam("IDParam");
            static const SG::Accessor<AmgSymMatrix(5)>  IDCov("IDCov");
            static const SG::Accessor<AmgVector(5)> MEParam("MEParam");
            static const SG::Accessor<AmgSymMatrix(5)> MECov("MECov");
 
            // Use the constructor where the eta/phi are overwritten to keep it inma line with current recommendations. To be changed in the future
            auto CB = MCP::TrackCalibObj(MCP::TrackType::CB, charge, cb_pt(mu.getXAODObject()), Primary_eta, Primary_phi, mass, CBParam(mu.getXAODObject()), CBCov(mu.getXAODObject()), year, isData);
            auto ID = MCP::TrackCalibObj(MCP::TrackType::ID, charge, id_pt(mu.getXAODObject()), Primary_eta, Primary_phi, mass, IDParam(mu.getXAODObject()), IDCov(mu.getXAODObject()), year, isData);
            auto ME = MCP::TrackCalibObj(MCP::TrackType::ME, charge, ms_pt(mu.getXAODObject()), Primary_eta, Primary_phi, mass, MEParam(mu.getXAODObject()), MECov(mu.getXAODObject()), year, isData);
 
            MCP::MuonObj muonObj{CB,ID,ME};
            initializeRandNumbers(muonObj, evtInfo);
 
            muonObj.expectedPercentResID = expectedResolution(MCP::DetectorType::ID, mu, evtInfo, false);
            muonObj.expectedPercentResME = expectedResolution(MCP::DetectorType::MS, mu, evtInfo, false);
            muonObj.expectedResID = expectedResolution(MCP::DetectorType::ID, mu, evtInfo, true) * muonObj.CB.calib_pt;
            muonObj.expectedResME = expectedResolution(MCP::DetectorType::MS, mu, evtInfo, true) * muonObj.CB.calib_pt;
 
            return muonObj;
        }
        
 
            // Retrieve all the trans
            auto CB_track = mu(acc.combinedTrackParticleLinkAcc);
            auto ID_track = mu(acc.inDetTrackParticleLinkAcc).opt_value();
            auto ME_track = mu(acc.extrapolatedMuonSpectrometerTrackParticleLinkAcc);
 
            // For SI muons, overwrite the charge from the CB track
            if (mu(acc.muonTypeAcc) == xAOD::Muon::MuonType::SiliconAssociatedForwardMuon)
            {
                if (CB_track) charge = CB_track.value()(acc.trkChargeAcc);
            }
 
            // Use the constructor where the eta/phi are overwritten to keep it inma line with current recommendations. To be changed in the future
            auto CB = MCP::TrackCalibObj(acc, columnar::OptObjectId<columnar::MuonTrackDef>(CB_track), MCP::TrackType::CB, charge, Primary_eta, Primary_phi, year, isData);
            auto ID = MCP::TrackCalibObj(acc, columnar::OptObjectId<columnar::MuonTrackDef>(ID_track), MCP::TrackType::ID, charge, Primary_eta, Primary_phi, year, isData);
            auto ME = MCP::TrackCalibObj(acc, columnar::OptObjectId<columnar::MuonTrackDef>(ME_track), MCP::TrackType::ME, charge, Primary_eta, Primary_phi, year, isData);
 
            MCP::MuonObj muonObj{CB,ID,ME};
            initializeRandNumbers(muonObj, evtInfo);
            muonObj.expectedPercentResID = expectedResolution(MCP::DetectorType::ID, mu, evtInfo, false);
            muonObj.expectedPercentResME = expectedResolution(MCP::DetectorType::MS, mu, evtInfo, false);
 
            muonObj.expectedResID = expectedResolution(MCP::DetectorType::ID, mu, evtInfo, true) * muonObj.CB.calib_pt;
            muonObj.expectedResME = expectedResolution(MCP::DetectorType::MS, mu, evtInfo, true) * muonObj.CB.calib_pt;
            return muonObj;
    }
    MCP::MuonObj MuonCalibTool::convertToMuonObj(const xAOD::TrackParticle& inTrk, const int DetType) const
    {
        auto& acc = *m_acc;
        // Get information about data
        bool isData = false;
 
        // Retrieve the event information:
        SG::ReadHandle<xAOD::EventInfo> evtInfo(m_eventInfo);
        isData = !evtInfo->eventType(xAOD::EventInfo::IS_SIMULATION);
        
        ATH_MSG_VERBOSE("Checking Simulation flag: " << !isData);
 
        // Get information about which year it is here
        auto year = MuonCalibTool::getPeriod(isData, *evtInfo);
        int charge = inTrk.charge();
        if (DetType == MCP::DetectorType::ID) 
        {  
            auto CB = MCP::TrackCalibObj(acc, &inTrk,   MCP::TrackType::CB, charge, year, isData);
            auto ID = MCP::TrackCalibObj(acc, &inTrk,   MCP::TrackType::ID, charge, year, isData);
            auto ME = MCP::TrackCalibObj(acc, &inTrk,  MCP::TrackType::ME, charge, year, isData);
 
            MCP::MuonObj muonObj{CB,ID,ME};
            return muonObj;
        } 
 
        auto CB = MCP::TrackCalibObj(acc, &inTrk,   MCP::TrackType::CB, charge, year, isData);
        auto ID = MCP::TrackCalibObj(acc, nullptr,  MCP::TrackType::ID, charge, year, isData);
        auto ME = MCP::TrackCalibObj(acc, &inTrk,   MCP::TrackType::ME, charge, year, isData);
 
        MCP::MuonObj muonObj{CB,ID,ME};
        return muonObj;
    }
 
 
    void MuonCalibTool::initializeRandNumbers(MCP::MuonObj& muonObj, columnar::EventInfoId evtInfo) const
    {
        auto& acc = *m_acc;
        // Random number generation for smearing
        TRandom3 loc_random3;
        // Get Event Number, Retrieve the event information:
        unsigned long long eventNumber = 0;
        if(m_expertMode_EvtNumber.value()!=0) eventNumber=m_expertMode_EvtNumber.value();
        else eventNumber = evtInfo(acc.eventNumberAcc);
        // Construct a seed for the random number generator:
        const UInt_t seed = 1 + std::abs(muonObj.CB.phi) * 1E6 + std::abs(muonObj.CB.eta) * 1E3 + eventNumber;
        loc_random3.SetSeed(seed);
 
        muonObj.rnd_g0 = loc_random3.Gaus(0, 1);
        muonObj.rnd_g1 = loc_random3.Gaus(0, 1);
        muonObj.rnd_g2 = loc_random3.Gaus(0, 1);
        muonObj.rnd_g3 = loc_random3.Gaus(0, 1);
        muonObj.rnd_g4 = loc_random3.Gaus(0, 1);
        muonObj.rnd_g_highPt = loc_random3.Gaus(0, 1);
 
 
    }
 
    MCP::DataYear MuonCalibTool::getPeriod(bool isData, columnar::EventInfoId evtInfo) const 
    {
        // I've copied the run number ranges from SUSYTools (Run2) - Haider
        // https://gitlab.cern.ch/atlas/athena/blob/21.2/PhysicsAnalysis/SUSYPhys/SUSYTools/Root/SUSYObjDef_xAOD.cxx#L2438
    // Range for Run3 taken from COMA - Luca
    // https://atlas-tagservices.cern.ch/tagservices/RunBrowser/runBrowserReport/rBR_Period_Report.php?fnt=data22_13p6TeV
    // https://atlas-tagservices.cern.ch/tagservices/RunBrowser/runBrowserReport/rBR_Period_Report.php?fnt=data23_13p6TeV
    // https://atlas-tagservices.cern.ch/tagservices/RunBrowser/runBrowserReport/rBR_Period_Report.php?fnt=data24_13p6TeV
        // https://atlas-tagservices.cern.ch/tagservices/RunBrowser/runBrowserReport/rBR_Period_Report.php?fnt=data25_13p6TeV
        // https://atlas-tagservices.cern.ch/tagservices/RunBrowser/runBrowserReport/rBR_Period_Report.php?fnt=data26_13p6TeV
        constexpr unsigned int last_run_16 = 320000;
        constexpr unsigned int last_run_17 = 342000;
        constexpr unsigned int last_run_18 = 370000;
        constexpr unsigned int last_run_22 = 440613;
        constexpr unsigned int last_run_23 = 461002;
    constexpr unsigned int last_run_24 = 486894;
    constexpr unsigned int last_run_25 = 509891;
    constexpr unsigned int last_run_26 = 524099;
 
        static const std::set<int> MCperiods1516{284500};
        static const std::set<int> MCperiods17{300000, 304000, 305000};
        static const std::set<int> MCperiods18{310000};
        static const std::set<int> MCperiods22{330000, 410000};
        static const std::set<int> MCperiods23{450000, 460000};
    static const std::set<int> MCperiods24{470000, 488000, 488600};
    static const std::set<int> MCperiods25{495000};
 
        static const std::set<int> MCperiodsRun4{350000, 350060, 350140, 350200};
 
        auto& acc = *m_acc;
        unsigned int run = 0;
        if(m_expertMode_RunNumber.value()!=0) run=m_expertMode_RunNumber.value();
        else run = evtInfo(acc.runNumberAcc);
        // retrieve the random run number
        if (!isData && m_useRndRun) {
            if (acc.acc_rnd.isAvailable(evtInfo))
                run = acc.acc_rnd(evtInfo);
            else {
                ATH_MSG_ERROR(
                    "No random runnumber could be found although the tool is configured to assign the years based on it. Please make sure "
                    "to apply the prwTool before-hand or consider to set the property 'useRandomRunNumber' to false.");
                return MCP::DataYear::Data16;
            }
        }
        // Check the Monte carlo
        if (!isData && (!m_useRndRun || !acc.acc_rnd.isAvailable(evtInfo))) {
            if (MCperiods1516.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc20a / data15-16");
                return MCP::DataYear::Data16;
            } else if (MCperiods17.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc20d / data17");
                return MCP::DataYear::Data17;
            } else if (MCperiods18.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc20e / data18");
                return MCP::DataYear::Data18;
            } else if (MCperiods22.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc21 / mc23a / data22");
                return MCP::DataYear::Data22;
            } else if (MCperiods23.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc23c / mc23d / data23");
                return MCP::DataYear::Data23;
            } else if (MCperiods24.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc23e / data24");
                return MCP::DataYear::Data24;
            } else if (MCperiods25.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data mc23g / data25 / data26");
                return MCP::DataYear::Data25;
            } else if (MCperiodsRun4.count(run)) {
                ATH_MSG_DEBUG("The current run " << run << " corresponds to data Run4");
                return MCP::DataYear::Run4;
            }
 
        }
        // Check data itself or the random run number is used
        else if (isData || m_useRndRun) {
            if (run < last_run_16) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 15-16");
                return MCP::DataYear::Data16;
            } else if (run <= last_run_17) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 17");
                return MCP::DataYear::Data17;
            } else if (run <= last_run_18) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 18");
                return MCP::DataYear::Data18;
            }  else if (run <= last_run_22) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 22");
                return MCP::DataYear::Data22;
            }  else if (run <= last_run_23) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 23");
                return MCP::DataYear::Data23;
            }  else if (run <= last_run_24) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 24");
                return MCP::DataYear::Data24;
            }  else if (run <= last_run_25) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 25");
                return MCP::DataYear::Data25;
            }  else if (run <= last_run_26) {
                ATH_MSG_DEBUG("The current run " << run << " is taken in data 26");
                return MCP::DataYear::Data25;
            }
        }
        static std::atomic<bool> warningPrinted {false};
        if (!warningPrinted) {
            ATH_MSG_WARNING("Could not assign run-number " << run << " to a specific year of data-taking, using default run 4");
            warningPrinted = true;
        }
        return MCP::DataYear::Run4;
    }
 
 
    void MuonCalibTool::callSingleEvent (columnar::MuonRange muons, columnar::EventInfoId event) const
    {
        for (columnar::MuonId muon : muons)
        {
            switch (applyCorrection(muon, event).code())
            {
            case CP::CorrectionCode::Ok:
                break;
            case CP::CorrectionCode::OutOfValidityRange:
                throw std::runtime_error("OutOfValidityRange in applyCorrection");
                break;
            case CP::CorrectionCode::Error:
                throw std::runtime_error("Error in applyCorrection");
            }
        }
    }
 
    void MuonCalibTool::callEvents (columnar::EventContextRange events) const {
        auto& acc = *m_acc;
        for (columnar::EventContextId event : events)
        {
            auto eventInfo = acc.m_eventInfoCol(event);
            callSingleEvent (acc.m_muons(event), eventInfo);
        }
    }
 
} // namespace ADD_CMODE(CP)