CP::MuonCalibIntSagittaTool Class Reference

#include <MuonCalibIntSagittaTool.h>

Inheritance diagram for CP::MuonCalibIntSagittaTool:

Collaboration diagram for CP::MuonCalibIntSagittaTool:

Classes
struct	ParameterSetSagitta

Public Member Functions
	MuonCalibIntSagittaTool (const std::string &name)
virtual	~MuonCalibIntSagittaTool ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual CorrectionCode	applyCorrection (MCP::MuonObj &mu) const =0
	Declare the interface that the class provides.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Types
typedef std::map< MCP::SagittaCorrection, std::shared_ptr< MCP::CalibContainer > >	SagittaCorrConstMap

Protected Member Functions
StatusCode	calcSystematicVariation (const SystematicSet &systConfig, ParameterSetSagitta &param) const
void	applySagittaCorrection (double &pt, const std::vector< double > &correction, const int &charge, const bool &isData) const
std::vector< double >	getCorrections (const MCP::TrackCalibObj &mu) const
double	statCombCorrection (const MCP::MuonObj &mu, double corrIDpT, double corrMEpT, double CBpT) const
CorrectionCode	applyStatCombination (AmgVector(5) parsID, const AmgSymMatrix(5)&covID, AmgVector(5) parsMS, const AmgSymMatrix(5)&covMS, int charge, AmgVector(5) &parsCB, AmgSymMatrix(5) &covCB, double &chi2) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}
Gaudi::Property< std::string >	m_release {this, "release", "Recs2025_03_26_Run2Run3", "Release"}
Gaudi::Property< bool >	m_doEtaSagittaSys {this, "doEtaSagittaSys", false, "Do Eta dependant systematic system"}
Gaudi::Property< bool >	m_applyCorrectionOnData {this, "applyCorrectionOnData", true, "If to apply sagitta corrections on data, or take the full effect as systematic"}
Gaudi::Property< bool >	m_doDirectCBCalib {this, "doDirectCBCalib", true, "Apply sagitta corrections on CB tracks, otherwise, on ID+MS"}
Gaudi::Property< bool >	m_useFixedRho {this, "useFixedRho", true, "Force Fixed Rho"}
Gaudi::Property< float >	m_fixedRhoValue {this, "fixedRhoValue", 1, "Value for rho, if it is forced"}
Gaudi::Property< std::string >	m_sysScheme {this, "systematicScheme", "Corr_Scale", "Systematic scheme to be configured"}
Gaudi::Property< float >	m_extraRebiasSys {this, "extraRebias", 0.00002, "Additional systematic applied for the residual bias observed"}
SystematicsCache< ParameterSetSagitta >	m_Parameters {this}
const ParameterSetSagitta *	m_currentParameters {nullptr}
std::map< MCP::DataYear, SagittaCorrConstMap >	m_sagittaCorrConst_ID
std::map< MCP::DataYear, SagittaCorrConstMap >	m_sagittaCorrConst_ME
std::map< MCP::DataYear, SagittaCorrConstMap >	m_sagittaCorrConst_CB
std::map< MCP::DataYear, SagittaCorrConstMap >	m_sagittaCorrConst_mcID
std::map< MCP::DataYear, SagittaCorrConstMap >	m_sagittaCorrConst_mcME
std::map< MCP::DataYear, SagittaCorrConstMap >	m_sagittaCorrConst_mcCB

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual ASG_TOOL_CLASS3(MuonCalibIntSagittaTool, CP::IMuonCalibIntTool, CP::ISystematicsTool, CP::IReentrantSystematicsTool) public bool	isAffectedBySystematic (const SystematicVariation &systematic) const override
	Declare the interface that this class provides.
virtual SystematicSet	affectingSystematics () const override
	the list of all systematics this tool can be affected by
virtual SystematicSet	recommendedSystematics () const override
	the list of all systematics this tool recommends to use
virtual StatusCode	applySystematicVariation (const SystematicSet &systConfig) override
	effects: configure this tool for the given list of systematic variations.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 27 of file MuonCalibIntSagittaTool.h.

Member Typedef Documentation

SagittaCorrConstMap

typedef std::map<MCP::SagittaCorrection, std::shared_ptr<MCP::CalibContainer> > CP::MuonCalibIntSagittaTool::SagittaCorrConstMap

protected

Definition at line 95 of file MuonCalibIntSagittaTool.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MuonCalibIntSagittaTool()

CP::MuonCalibIntSagittaTool::MuonCalibIntSagittaTool

(

const std::string &

name

)

Definition at line 20 of file MuonCalibIntSagittaTool.cxx.

                                                                          : asg::AsgTool(name)
    {    }

~MuonCalibIntSagittaTool()

virtual CP::MuonCalibIntSagittaTool::~MuonCalibIntSagittaTool ( )

virtualdefault

Member Function Documentation

affectingSystematics()

SystematicSet CP::MuonCalibIntSagittaTool::affectingSystematics ( ) const

overrideprivatevirtual

the list of all systematics this tool can be affected by

Sagitta Systematis

Implements CP::IReentrantSystematicsTool.

Definition at line 452 of file MuonCalibIntSagittaTool.cxx.

    {
        SystematicSet result;
        if (!m_useFixedRho || m_sysScheme == "AllSys") {
            result.insert(SystematicVariation("MUON_SAGITTA_RHO", 1));
            result.insert(SystematicVariation("MUON_SAGITTA_RHO", -1));
        }
 
        if (m_doEtaSagittaSys) {
            // Sagitta correction residual bias
            result.insert(SystematicVariation("MUON_SAGITTA_RESBIAS_NEGETA", 1));
            result.insert(SystematicVariation("MUON_SAGITTA_RESBIAS_NEGETA", -1));
 
            result.insert(SystematicVariation("MUON_SAGITTA_RESBIAS_POSETA", 1));
            result.insert(SystematicVariation("MUON_SAGITTA_RESBIAS_POSETA", -1));
 
        } 
        else {
            // Sagitta correction residual bias
            result.insert(SystematicVariation("MUON_SAGITTA_RESBIAS", 1));
            result.insert(SystematicVariation("MUON_SAGITTA_RESBIAS", -1));
        }
 
        result.insert(SystematicVariation("MUON_SAGITTA_DATASTAT", 1));
        result.insert(SystematicVariation("MUON_SAGITTA_DATASTAT", -1));
        
        result.insert(SystematicVariation("MUON_SAGITTA_GLOBAL", 1));
        result.insert(SystematicVariation("MUON_SAGITTA_GLOBAL", -1));
 
        result.insert(SystematicVariation("MUON_SAGITTA_PTEXTRA", 1));
        result.insert(SystematicVariation("MUON_SAGITTA_PTEXTRA", -1));
 
        return result;
    }

applyCorrection()

virtual CorrectionCode CP::IMuonCalibIntTool::applyCorrection ( MCP::MuonObj & mu ) const

pure virtualinherited

Declare the interface that the class provides.

Apply the correction on a modifyable object

applySagittaCorrection()

void CP::MuonCalibIntSagittaTool::applySagittaCorrection ( double & pt, const std::vector< double > & correction, const int & charge, const bool & isData ) const

protected

Definition at line 134 of file MuonCalibIntSagittaTool.cxx.

    {
        for(const auto& corr: correction)
        {
            double originalPt = pt;
            if(isData) pt = pt / (1 + charge * corr * pt);
            else pt = pt / (1 - charge * corr * pt);
            ATH_MSG_DEBUG("CorrectForCharge - in pT: " << originalPt << " corrPt: " << pt << " applied saggita: " << corr);
 
        }
    }

applyStatCombination()

CorrectionCode CP::MuonCalibIntSagittaTool::applyStatCombination ( AmgVector(5) parsID, const AmgSymMatrix(5)& covID, AmgVector(5) parsMS, const AmgSymMatrix(5)& covMS, int charge, AmgVector(5) & parsCB, AmgSymMatrix(5) & covCB, double & chi2 ) const

protected

Definition at line 390 of file MuonCalibIntSagittaTool.cxx.

                                                                                                                     {
        chi2 = 1e20;
        parsID[4] = std::abs(parsID[4]);
        parsMS[4] = std::abs(parsMS[4]);
 
 
        Eigen::FullPivLU<AmgSymMatrix(5)> matID(covID);
        if (!matID.isInvertible()) {
            ATH_MSG_DEBUG(" ID weight matrix computation failed     ");
            return CorrectionCode::Error;
        }
        const AmgSymMatrix(5) weightID = matID.inverse();
 
 
        Eigen::FullPivLU<AmgSymMatrix(5)> matMS(covMS);
        if (!matMS.isInvertible()) {
            ATH_MSG_DEBUG(" MS weight matrix computation failed     ");
            return CorrectionCode::Error;
        }
        const AmgSymMatrix(5) weightMS = matMS.inverse();
 
 
        Eigen::FullPivLU<AmgSymMatrix(5)> matCB(weightID + weightMS);
        if (!matCB.isInvertible()) {
            ATH_MSG_DEBUG(" Inversion of weightCB failed ");
            return CorrectionCode::Error;
        }
        covCB = matCB.inverse();
 
 
        Eigen::FullPivLU<AmgSymMatrix(5)> matSum(covID + covMS);
        if (!matSum.isInvertible()) {
            ATH_MSG_DEBUG(" Inversion of weightCB failed ");
            return CorrectionCode::Error;
        }
        AmgSymMatrix(5) invCovSum = matSum.inverse();
 
 
        AmgVector(5) diffPars = parsID - parsMS;
        chi2 = diffPars.transpose() * invCovSum * diffPars;
        chi2 = chi2 / 5.;
 
        parsCB = covCB * (weightID * parsID + weightMS * parsMS);
        parsCB[4] *= charge;
 
        if (parsCB[2] > M_PI)
            parsCB[2] -= 2. * M_PI;
        else if (parsCB[2] < -M_PI)
            parsCB[2] += 2. * M_PI;
        return CorrectionCode::Ok;
    }

applySystematicVariation()

StatusCode CP::MuonCalibIntSagittaTool::applySystematicVariation ( const SystematicSet & systConfig )

overrideprivatevirtual

effects: configure this tool for the given list of systematic variations.

any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). failures: systematic unknown failures: requesting multiple variations on the same systematic (e.g. up & down) failures: requesting an unsupported variation on an otherwise supported systematic (e.g. a 2 sigma variation and the tool only supports 1 sigma variations) failures: unsupported combination of supported systematic failures: other tool specific errors

Implements CP::ISystematicsTool.

Definition at line 577 of file MuonCalibIntSagittaTool.cxx.

    {
        return m_Parameters.get(systConfig, m_currentParameters);
    }

calcSystematicVariation()

StatusCode CP::MuonCalibIntSagittaTool::calcSystematicVariation ( const SystematicSet & systConfig, ParameterSetSagitta & param ) const

protected

Definition at line 492 of file MuonCalibIntSagittaTool.cxx.

    {
        param.SagittaRho        = MCP::SystVariation::Default;
        param.SagittaBias       = MCP::SystVariation::Default;
        param.SagittaGlobal     = MCP::SystVariation::Default;
        param.SagittaPtExtra    = MCP::SystVariation::Default;
        param.SagittaDataStat   = MCP::SystVariation::Default;
        param.SagittaEtaSlice   = MCP::SystVariation::Default;
 
        // Sagitta Rho systematics
        SystematicVariation syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_RHO");
 
        if      (syst == SystematicVariation("MUON_SAGITTA_RHO",  1)) param.SagittaRho = MCP::SystVariation::Down;
        else if (syst == SystematicVariation("MUON_SAGITTA_RHO", -1)) param.SagittaRho = MCP::SystVariation::Up;
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        // Sagitta Residual Bias systematics
        syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_RESBIAS");
 
        if      (syst == SystematicVariation("MUON_SAGITTA_RESBIAS",  1)) param.SagittaBias = MCP::SystVariation::Down;
        else if (syst == SystematicVariation("MUON_SAGITTA_RESBIAS", -1)) param.SagittaBias = MCP::SystVariation::Up;
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        // Sagitta Residual Global Bias systematics
        syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_GLOBAL");
 
        if      (syst == SystematicVariation("MUON_SAGITTA_GLOBAL",  1)) param.SagittaGlobal = MCP::SystVariation::Down;
        else if (syst == SystematicVariation("MUON_SAGITTA_GLOBAL", -1)) param.SagittaGlobal = MCP::SystVariation::Up;
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        // Sagitta Residual Bias systematics pt extrapolation
        syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_PTEXTRA");
 
        if      (syst == SystematicVariation("MUON_SAGITTA_PTEXTRA",  1)) param.SagittaPtExtra = MCP::SystVariation::Down;
        else if (syst == SystematicVariation("MUON_SAGITTA_PTEXTRA", -1)) param.SagittaPtExtra = MCP::SystVariation::Up;
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        // Sagitta Residual Bias systematics
        syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_RESBIAS_POSETA");
 
        if (syst == SystematicVariation("MUON_SAGITTA_RESBIAS_POSETA", 1)) 
        {
            param.SagittaBias = MCP::SystVariation::Down;
            param.SagittaEtaSlice = MCP::SystVariation::Up;
        } 
        else if (syst == SystematicVariation("MUON_SAGITTA_RESBIAS_POSETA", -1)) 
        {
            param.SagittaBias = MCP::SystVariation::Up;
            param.SagittaEtaSlice = MCP::SystVariation::Up;
        } 
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        // Sagitta Residual Bias systematics
        syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_RESBIAS_NEGETA");
 
        if (syst == SystematicVariation("MUON_SAGITTA_RESBIAS_NEGETA", 1)) 
        {
            param.SagittaBias = MCP::SystVariation::Down;
            param.SagittaEtaSlice = MCP::SystVariation::Down;
        }
        else if (syst == SystematicVariation("MUON_SAGITTA_RESBIAS_NEGETA", -1)) 
        {
            param.SagittaBias = MCP::SystVariation::Up;
            param.SagittaEtaSlice = MCP::SystVariation::Down;
        } 
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        // Sagitta Residual Bias systematics
        syst = systConfig.getSystematicByBaseName("MUON_SAGITTA_DATASTAT");
 
        if      (syst == SystematicVariation("MUON_SAGITTA_DATASTAT",  1)) param.SagittaDataStat = MCP::SystVariation::Up;
        else if (syst == SystematicVariation("MUON_SAGITTA_DATASTAT", -1)) param.SagittaDataStat = MCP::SystVariation::Down;
        else if (!syst.empty()) return StatusCode::FAILURE;
 
        //
        ATH_MSG_DEBUG("Systematic variation's parameters, SagittaRho: " << param.SagittaRho);
        ATH_MSG_DEBUG("Systematic variation's parameters, SagittaBias: " << param.SagittaBias);
        ATH_MSG_DEBUG("Systematic variation's parameters, SagittaGlobal: " << param.SagittaGlobal);
        ATH_MSG_DEBUG("Systematic variation's parameters, SagittaPtExtra: " << param.SagittaPtExtra);
        ATH_MSG_DEBUG("Systematic variation's parameters, SagittaDataStat: " << param.SagittaDataStat);
        ATH_MSG_DEBUG("Systematic variation's parameters, SagittaEtaSlice: " << param.SagittaEtaSlice);
 
        return StatusCode::SUCCESS;
    }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

getCorrections()

std::vector< double > CP::MuonCalibIntSagittaTool::getCorrections ( const MCP::TrackCalibObj & mu ) const

protected

Definition at line 148 of file MuonCalibIntSagittaTool.cxx.

    {        
        double eta = trk.eta;
        double pT = trk.calib_pt;
        SagittaCorrConstMap const *corrMap{nullptr};
        SagittaCorrConstMap const *kinematicTermMap{nullptr};
        if(trk.type == MCP::TrackType::CB)
        {
            corrMap          = &m_sagittaCorrConst_CB.at(trk.year);
            kinematicTermMap = &m_sagittaCorrConst_mcCB.at(trk.year);
        } 
        else if(trk.type == MCP::TrackType::ID)
        { 
            corrMap          = &m_sagittaCorrConst_ID.at(trk.year);
            kinematicTermMap = &m_sagittaCorrConst_mcID.at(trk.year);
        }
        else if(trk.type == MCP::TrackType::ME)
        { 
            corrMap          = &m_sagittaCorrConst_ME.at(trk.year);
            kinematicTermMap = &m_sagittaCorrConst_mcME.at(trk.year);
        }
        
        std::vector<double> corrections;
        if(trk.isData)
        {
            if(!m_applyCorrectionOnData) return corrections;
            else if (m_applyCorrectionOnData)
            {
                // Apply data - kinematic term for the nominal
                double corr = corrMap->at(MCP::SagittaCorrection::Nominal)->getCalibConstant(trk);
                corr -= kinematicTermMap->at(MCP::SagittaCorrection::Nominal)->getCalibConstant(trk);
                corrections.push_back(corr);
            }
        }
        else // if it is MC
        {
            // Otherwise do as needed
            if(m_currentParameters->SagittaBias != MCP::SystVariation::Default)
            {
                int scale = (m_currentParameters->SagittaBias ==  MCP::SystVariation::Up) ? 1: -1;
                // Sanity check
                if((m_currentParameters->SagittaEtaSlice != MCP::SystVariation::Default) && !m_applyCorrectionOnData)
                {
                    ATH_MSG_ERROR("Sagitta correction is not applied to data, yet Eta dependant systematics are requested. This configuration is not supported");
                    return corrections;
                }
 
                // if no apply correction on data, apply 100% of (Data - kinematic term)
                // TODO: Check if it 50% or 100%? 
                if(!m_applyCorrectionOnData) 
                {
                    // Apply data - kinematic term for the nominal
                    double corr =  corrMap->at(MCP::SagittaCorrection::Nominal)->getCalibConstant(trk);
                    ATH_MSG_VERBOSE("Raw corr: "<<corr);
                    // corr -= kinematicTermMap->at(MCP::SagittaCorrection::Nominal)->getCalibConstant(eta, phi);
                    // ATH_MSG_VERBOSE("Raw - Kinematic corr: "<<corr);
                    corr *= (scale);
                    ATH_MSG_VERBOSE("corr: "<<corr);
                    corrections.push_back(corr);
                }
 
                // 100% of resbiasMap added as res bias 
                double corr =  corrMap->at(MCP::SagittaCorrection::Residual__1up)->getCalibConstant(trk);
                corr *= scale;
                ATH_MSG_VERBOSE("Residual corr: "<<corr);
 
                // If eta dependant, set the p2 to 0, if it not in the given eta slices
                if ((m_currentParameters->SagittaEtaSlice == MCP::SystVariation::Up) && eta < 0) corr = 0;
                if ((m_currentParameters->SagittaEtaSlice == MCP::SystVariation::Down) && eta > 0) corr = 0;
 
                corrections.push_back(corr);
                ATH_MSG_VERBOSE("final corr: "<<corr);
            }
            else if(m_currentParameters->SagittaGlobal != MCP::SystVariation::Default)
            {
                int scale = (m_currentParameters->SagittaGlobal ==  MCP::SystVariation::Up) ? 1: -1;
 
                double deltas = m_extraRebiasSys;
                // systematic for Run3 data 2022
                if (trk.year==MCP::DataYear::Data22) {
                   if(m_release.value().find("Recs2023") != std::string::npos) deltas = 1.2 * deltas;
                   else if(std::abs(eta)>1.05)  deltas = 1.5 * deltas;
                }
                double corr = deltas * scale;
                ATH_MSG_VERBOSE("Deltas corr: "<<deltas);
 
                corrections.push_back(corr);
                ATH_MSG_VERBOSE("final corr: "<<corr);
 
            }
            else if(m_currentParameters->SagittaPtExtra != MCP::SystVariation::Default)
            {
                int scale = (m_currentParameters->SagittaPtExtra ==  MCP::SystVariation::Up) ? 1: -1;
 
                // Extra scaling to cover for non-closure in the forward and transition region
                // As seen in the Rel 21 validation of the sagitta correction
                // It is only concetrateed in a few high eta bin. Idea is to apply a linearly increasing sys
                // Till it reach 450 GeV and then to flatten it. 
                // The value is chosen in an arbitrary fashion. To be replaced and fixed, once we have a better idea of 
                double corr = 0;
                double deltas = 0.00002;
               
                if (corrMap->at(MCP::SagittaCorrection::PtExtra__1up)->mapExist()) {
                  deltas = corrMap->at(MCP::SagittaCorrection::PtExtra__1up)->getCalibConstant(trk);
                  if (pT > 450.0)
                    corr += std::abs(450.0 - 45) * deltas;  // Above 450 GeV flat
                  else
                    corr += std::abs(pT - 45) * deltas;
                } else {
                  // old style uncertainty for Run2 and early Run3 recommendations 
                  if (eta > 2 || (eta > -2 && eta < -1.05)) {
                      if (pT > 450.0)
                          corr += std::abs(450.0 - 45) / 100 * deltas;  // Above 450 GeV flat
                      else
                          corr += std::abs(pT - 45) / 100 * deltas;
                  }
                  if (eta < -2 || (eta < 2 && eta> 1.5)) {
                      if (pT > 450.0)
                          corr += std::abs(450.0 - 45) / 200 * deltas;  // Above 450 GeV flat
                      else
                          corr += std::abs(pT - 45) / 200 * deltas;
                  }
                  // additional uncertainties for 2022 data
                  if (m_release.value().find("Recs2023") != std::string::npos) {
                    if ( (trk.year==MCP::DataYear::Data22) && pT > 100.0) {
                      if (eta < 0 && eta> -0.5) corr += 2.1*deltas;
                      else if (eta < -1.05) corr += 1.1*deltas;
                      else if (eta > 0.5 ) corr += 0.8*deltas;
                    }
                  } else {
                    if ( trk.year==MCP::DataYear::Data22 ) {
                      if (eta > -2 && eta < -1.05) corr = corr*2.5;
                      if (eta < -2) corr = corr*6;
                      if (eta > 1.5 && eta < 2) {
                        if (pT > 450.0)
                          corr += std::abs(450.0 - 45) / 80 * deltas;  // Above 450 GeV flat
                        else
                          corr += std::abs(pT - 45) / 80 * deltas;
                      }
                      if (eta > 1.05 && eta < 1.5) {
                        if (pT > 450.0)
                          corr += std::abs(450.0 - 45) / 40 * deltas;  // Above 450 GeV flat
                        else
                          corr += std::abs(pT - 45) / 40 * deltas;
                      }
                    }
                  }
                  // done for old style uncertainty for Run2 and early Run3 recommendations 
                }
 
                corrections.push_back(corr*scale);
                ATH_MSG_VERBOSE("High pT variation for pT "<<pT<<" deltas "<<deltas<<"  final corr: "<<corr);
 
            }
            else if(m_currentParameters->SagittaDataStat != MCP::SystVariation::Default)
            {
                int scale = (m_currentParameters->SagittaDataStat ==  MCP::SystVariation::Up) ? 1: -1;
                // Apply 50% of the datastat map, up and down as stat error
                // TODO change to 100%
                // -1 is to match the convention
                double corr = corrMap->at(MCP::SagittaCorrection::Datastat__1up)->getCalibConstant(trk);
                corr *= (0.5 * scale);
                ATH_MSG_VERBOSE("data stat final corr: "<<corr);
                corrections.push_back(corr);
            }
            else if(m_currentParameters->SagittaRho != MCP::SystVariation::Default)
            {
                // For rho systematic, nothing happens right now
            }
            else
            {
                // if it is MC, then for nominal corrections - we don't apply anything
            }
        }
 
        return corrections;
    }

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

initialize()

StatusCode CP::MuonCalibIntSagittaTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 23 of file MuonCalibIntSagittaTool.cxx.

    {
        // Greet the user:
        ATH_MSG_INFO("Initializing MuonCalibIntSagittaTool");
 
        // Get the m_eventinfo container
        ATH_CHECK(m_eventInfo.initialize());
 
        // Read the recommendations
        for(const auto& year: MCP::dataYearList)
        {
            m_sagittaCorrConst_ID[year] = MCP::CalibInitializer::createSagittaCorrMap(year, MCP::TrackType::ID, m_release, "data");
            m_sagittaCorrConst_ME[year] = MCP::CalibInitializer::createSagittaCorrMap(year, MCP::TrackType::ME, m_release, "data");
            m_sagittaCorrConst_CB[year] = MCP::CalibInitializer::createSagittaCorrMap(year, MCP::TrackType::CB, m_release, "data");
 
            // Corrections from the MC - what is typically referred to as the kinematic term
            m_sagittaCorrConst_mcID[year] = MCP::CalibInitializer::createSagittaCorrMap(year, MCP::TrackType::ID, m_release, "mc");
            m_sagittaCorrConst_mcME[year] = MCP::CalibInitializer::createSagittaCorrMap(year, MCP::TrackType::ME, m_release, "mc");
            m_sagittaCorrConst_mcCB[year] = MCP::CalibInitializer::createSagittaCorrMap(year, MCP::TrackType::CB, m_release, "mc");
            ATH_MSG_VERBOSE("Sagitta initilised: Year " <<m_release);
        }
 
        m_currentParameters = nullptr;
        // Init the systematics
        m_Parameters.initialize(affectingSystematics(), [this](const SystematicSet &systConfig, ParameterSetSagitta &param)
                                { return calcSystematicVariation(systConfig, param); });
        if (!applySystematicVariation(SystematicSet()))
        {
            ATH_MSG_ERROR("Unable to run with no systematic");
            return StatusCode::FAILURE;
        }
        SystematicRegistry &registry = SystematicRegistry::getInstance();
        if (registry.registerSystematics(*this) != StatusCode::SUCCESS)
        {
            ATH_MSG_ERROR("Unkown systematic list");
            return StatusCode::FAILURE;
        }
        // Return gracefully:
        return StatusCode::SUCCESS;
    }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isAffectedBySystematic()

bool CP::MuonCalibIntSagittaTool::isAffectedBySystematic ( const SystematicVariation & systematic ) const

overrideprivatevirtual

Declare the interface that this class provides.

returns: whether this tool is affected by the given systematics

Implements CP::ISystematicsTool.

Definition at line 446 of file MuonCalibIntSagittaTool.cxx.

    {
        SystematicSet sys = affectingSystematics();
        return sys.find(systematic) != sys.end();
    }

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

recommendedSystematics()

SystematicSet CP::MuonCalibIntSagittaTool::recommendedSystematics ( ) const

overrideprivatevirtual

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 490 of file MuonCalibIntSagittaTool.cxx.

{ return affectingSystematics(); }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

statCombCorrection()

double CP::MuonCalibIntSagittaTool::statCombCorrection ( const MCP::MuonObj & mu, double corrIDpT, double corrMEpT, double CBpT ) const

protected

Definition at line 327 of file MuonCalibIntSagittaTool.cxx.

    {
        ATH_MSG_VERBOSE("Sag mu.ID.calib_pt: "<<mu.ID.calib_pt);
        ATH_MSG_VERBOSE("Sag mu.ME.calib_pt: "<<mu.ME.calib_pt);
        ATH_MSG_VERBOSE("Sag mu.CB.calib_pt: "<<mu.CB.calib_pt);
 
        // Corner cases to prevent a NaN in the combination
        if(mu.ID.calib_pt == 0) return CBpT;
        if(mu.ME.calib_pt == 0) return CBpT;
        if(corrIDpT == 0) return CBpT;
        if(corrMEpT == 0) return CBpT;
        
        double chi2Nom = -999;
        AmgVector(5)        parsCBNom   = mu.CB.pars;
        AmgVector(5)        parsID      = mu.ID.pars;
        AmgVector(5)        parsMS      = mu.ME.pars;
        AmgSymMatrix(5)     covCBNom    = mu.CB.covariance;
        AmgSymMatrix(5)     covID       = mu.ID.covariance;
        AmgSymMatrix(5)     covMS       = mu.ME.covariance;
           
        AmgVector(5)        parsCBCorr;
        AmgSymMatrix(5)     covCBCorr;
 
        // Do the statistical combination, with the original pTs
        // create the TLV with original ID pT
        using TLV = ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<double>>;
        TLV tlv{mu.ID.calib_pt, mu.ID.eta, mu.ID.phi, mu.ID.mass};
        // Now modify the ID covariance matrix, and convert it to MeV
        if(tlv.P() == 0) parsID[4] = 1e12;
        else parsID[4] = 1.0 / (tlv.P() * 1e3);
 
        tlv.SetCoordinates(mu.ME.calib_pt, mu.ME.eta, mu.ME.phi, mu.ME.mass);   
        // Now modify the ME covariance matrix
        if(tlv.P() == 0) parsMS[4] = 1e12;
        else parsMS[4] = 1.0 / (tlv.P() * 1e3);
 
        CorrectionCode SysCorrCode = applyStatCombination(parsID, covID, parsMS, covMS, mu.CB.calib_charge, parsCBNom, covCBNom, chi2Nom);
        if (SysCorrCode != CorrectionCode::Ok) return CBpT;
 
 
        // Do the statistical combination, with the original pTs
        // create the TLV with original ID pT
        tlv.SetCoordinates(corrIDpT,  mu.ID.eta, mu.ID.phi, mu.ID.mass);
        // Now modify the ID covariance matrix, and convert it to MeV
        if(tlv.P() == 0) parsID[4] = 1e12;
        else parsID[4] = 1.0 / (tlv.P() * 1e3);
 
        tlv.SetCoordinates(corrMEpT, mu.ME.eta, mu.ME.phi, mu.ME.mass);   
        // Now modify the ME covariance matrix
        if(tlv.P() == 0) parsMS[4] = 1e12;
        else parsMS[4] = 1.0 / (tlv.P() * 1e3);
 
        SysCorrCode = applyStatCombination(parsID, covID, parsMS, covMS, mu.CB.calib_charge, parsCBCorr, covCBCorr, chi2Nom);
        if (SysCorrCode != CorrectionCode::Ok) return CBpT;
 
 
        double statCombPtNom  = std::sin(parsCBNom[3]) / std::abs(parsCBNom[4]);
        double statCombPtCorr = std::sin(parsCBCorr[3]) / std::abs(parsCBCorr[4]);
        double corrCBpT = CBpT * (statCombPtCorr / statCombPtNom);
 
        return corrCBpT;
 
    }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_applyCorrectionOnData

Gaudi::Property<bool> CP::MuonCalibIntSagittaTool::m_applyCorrectionOnData {this, "applyCorrectionOnData", true, "If to apply sagitta corrections on data, or take the full effect as systematic"}

protected

Definition at line 66 of file MuonCalibIntSagittaTool.h.

{this, "applyCorrectionOnData",   true, "If to apply sagitta corrections on data, or take the full effect as systematic"};

m_currentParameters

const ParameterSetSagitta* CP::MuonCalibIntSagittaTool::m_currentParameters {nullptr}

protected

Definition at line 93 of file MuonCalibIntSagittaTool.h.

{nullptr};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doDirectCBCalib

Gaudi::Property<bool> CP::MuonCalibIntSagittaTool::m_doDirectCBCalib {this, "doDirectCBCalib", true, "Apply sagitta corrections on CB tracks, otherwise, on ID+MS"}

protected

Definition at line 69 of file MuonCalibIntSagittaTool.h.

{this, "doDirectCBCalib", true, "Apply sagitta corrections on CB tracks, otherwise, on ID+MS"};

m_doEtaSagittaSys

Gaudi::Property<bool> CP::MuonCalibIntSagittaTool::m_doEtaSagittaSys {this, "doEtaSagittaSys", false, "Do Eta dependant systematic system"}

protected

Definition at line 65 of file MuonCalibIntSagittaTool.h.

{this, "doEtaSagittaSys",   false, "Do Eta dependant systematic system"};

m_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> CP::MuonCalibIntSagittaTool::m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}

protected

Definition at line 59 of file MuonCalibIntSagittaTool.h.

{this, "EventInfoContName", "EventInfo", "event info key"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extraRebiasSys

Gaudi::Property<float> CP::MuonCalibIntSagittaTool::m_extraRebiasSys {this, "extraRebias", 0.00002, "Additional systematic applied for the residual bias observed"}

protected

Definition at line 77 of file MuonCalibIntSagittaTool.h.

{this, "extraRebias", 0.00002,     "Additional systematic applied for the residual bias observed"};

m_fixedRhoValue

Gaudi::Property<float> CP::MuonCalibIntSagittaTool::m_fixedRhoValue {this, "fixedRhoValue", 1, "Value for rho, if it is forced"}

protected

Definition at line 73 of file MuonCalibIntSagittaTool.h.

{this, "fixedRhoValue", 1,     "Value for rho, if it is forced"};

m_Parameters

SystematicsCache<ParameterSetSagitta> CP::MuonCalibIntSagittaTool::m_Parameters {this}

protected

Definition at line 92 of file MuonCalibIntSagittaTool.h.

{this};

m_release

Gaudi::Property<std::string> CP::MuonCalibIntSagittaTool::m_release {this, "release", "Recs2025_03_26_Run2Run3", "Release"}

protected

Definition at line 62 of file MuonCalibIntSagittaTool.h.

{this, "release", "Recs2025_03_26_Run2Run3",     "Release"};

m_sagittaCorrConst_CB

std::map<MCP::DataYear, SagittaCorrConstMap> CP::MuonCalibIntSagittaTool::m_sagittaCorrConst_CB

protected

Definition at line 100 of file MuonCalibIntSagittaTool.h.

m_sagittaCorrConst_ID

std::map<MCP::DataYear, SagittaCorrConstMap> CP::MuonCalibIntSagittaTool::m_sagittaCorrConst_ID

protected

Definition at line 98 of file MuonCalibIntSagittaTool.h.

m_sagittaCorrConst_mcCB

std::map<MCP::DataYear, SagittaCorrConstMap> CP::MuonCalibIntSagittaTool::m_sagittaCorrConst_mcCB

protected

Definition at line 105 of file MuonCalibIntSagittaTool.h.

m_sagittaCorrConst_mcID

std::map<MCP::DataYear, SagittaCorrConstMap> CP::MuonCalibIntSagittaTool::m_sagittaCorrConst_mcID

protected

Definition at line 103 of file MuonCalibIntSagittaTool.h.

m_sagittaCorrConst_mcME

std::map<MCP::DataYear, SagittaCorrConstMap> CP::MuonCalibIntSagittaTool::m_sagittaCorrConst_mcME

protected

Definition at line 104 of file MuonCalibIntSagittaTool.h.

m_sagittaCorrConst_ME

std::map<MCP::DataYear, SagittaCorrConstMap> CP::MuonCalibIntSagittaTool::m_sagittaCorrConst_ME

protected

Definition at line 99 of file MuonCalibIntSagittaTool.h.

m_sysScheme

Gaudi::Property<std::string> CP::MuonCalibIntSagittaTool::m_sysScheme {this, "systematicScheme", "Corr_Scale", "Systematic scheme to be configured"}

protected

Definition at line 76 of file MuonCalibIntSagittaTool.h.

{this, "systematicScheme", "Corr_Scale",     "Systematic scheme to be configured"};

m_useFixedRho

Gaudi::Property<bool> CP::MuonCalibIntSagittaTool::m_useFixedRho {this, "useFixedRho", true, "Force Fixed Rho"}

protected

Definition at line 72 of file MuonCalibIntSagittaTool.h.

{this, "useFixedRho",   true, "Force Fixed Rho"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

The documentation for this class was generated from the following files:

• MuonCalibIntSagittaTool.h
• MuonCalibIntSagittaTool.cxx