CP::MuonCalibTool Class Reference

#include <MuonCalibTool.h>

Inheritance diagram for CP::MuonCalibTool:

Collaboration diagram for CP::MuonCalibTool:

Public Member Functions
	MuonCalibTool (const std::string &name)
virtual	~MuonCalibTool ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
void	callSingleEvent (columnar::MuonRange muons, columnar::EventInfoId event) const
void	callEvents (columnar::EventContextRange events) const override
virtual void	print () const =0
	Print the state of the tool. More...
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Public Attributes
Gaudi::Property< bool >	m_skipResolutionCategory {this, "skipResolutionCategory", false, "whether to skip the resolution category variable"}
std::unique_ptr< MCP::MuonCalibToolAccessors >	m_acc {std::make_unique<MCP::MuonCalibToolAccessors>(*this)}

Protected Member Functions
MCP::MuonObj	convertToMuonObj (columnar::MuonId mu, columnar::EventInfoId evtInfo) const
MCP::MuonObj	convertToMuonObj (const xAOD::TrackParticle &inTrk, const int DetType) const
void	initializeRandNumbers (MCP::MuonObj &obj, columnar::EventInfoId evtInfo) const
	Decorate all information that's needed to ensure reproducibility of the smearing. More...
MCP::DataYear	getPeriod (bool isData, columnar::EventInfoId evtInfo) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Protected Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}
Gaudi::Property< bool >	m_isRun3 {this, "IsRun3Geo", false, "Needed for MuonSelectionTool"}
Gaudi::Property< std::string >	m_release {this, "release", "Recs2025_03_26_Run2Run3", "Release"}
Gaudi::Property< std::string >	m_sysScheme {this, "systematicScheme", "Corr_Scale", "Systematic scheme to be configured"}
Gaudi::Property< bool >	m_validationMode {this, "expert_validationMode", false, "Expert only option. Puts the tool in the validation mode setup"}
Gaudi::Property< bool >	m_expertMode_isData {this, "expertMode_isData", false, "Expert only option. Overwrites the isData Flag"}
Gaudi::Property< int >	m_expertMode_RunNumber {this, "expertMode_RunNumber", 0, "Expert only option. Overwrites RunNumber"}
Gaudi::Property< unsigned long long >	m_expertMode_EvtNumber {this, "expertMode_EvtNumber", 0, "Expert only option. Overwrites EventNumber"}
Gaudi::Property< bool >	m_useRndRun {this, "useRandomRunNumber", false, "To use the random run number for deciding which calibration to apply"}
Gaudi::Property< int >	m_calibMode {this, "calibMode", -1, "Calib mode"}
Gaudi::Property< bool >	m_excludeNSWFromPrecisionLayers {this, "ExcludeNSWFromPrecisionLayers", false, "Cut on the number of precision layers ignores the NSW"}
Gaudi::Property< bool >	m_doDirectCBCalib {this, "doDirectCBCalib", true, "Do direct calibration of CB tracks, otherwise, do ID+MS"}
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_2stations_highpt_smearing {this, "do2StationsHighPt", false, "Extra smearing to be applied if high pT WP is used"}
Gaudi::Property< bool >	m_extra_highpt_smearing {this, "doExtraSmearing", false, "Flag provided to test if analysis are sensitive to high pT calibration. NOT TO BE USED FOR RESULTS. Please see twiki"}
Gaudi::Property< float >	m_HighPtSystThreshold {this, "HighPtSystThr", 300.0, "Thershold for high pT smearing in GeV"}
asg::AnaToolHandle< CP::IMuonSelectionTool >	m_MuonSelectionTool {""}
asg::AnaToolHandle< CP::IMuonCalibIntTool >	m_MuonIntSagittaTool {""}
asg::AnaToolHandle< CP::IMuonCalibIntScaleSmearTool >	m_MuonIntScaleSmearTool {""}
asg::AnaToolHandle< CP::IMuonCalibIntTool >	m_MuonIntHighTSmearTool {""}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual ASG_TOOL_CLASS3(MuonCalibTool, CP::IMuonCalibrationAndSmearingTool, CP::ISystematicsTool, CP::IReentrantSystematicsTool) public CorrectionCode	applyCorrection (xAOD::Muon &mu) const override
	Declare the interface that the class provides. More...
CorrectionCode	applyCorrection (columnar::MuonId mu, columnar::EventInfoId evtInfo) const
virtual CorrectionCode	correctedCopy (const xAOD::Muon &input, xAOD::Muon *&output) const override
	Create a corrected copy from a constant muon. More...
virtual bool	isAffectedBySystematic (const SystematicVariation &systematic) const override
	Declare the interface that this class provides. More...
virtual SystematicSet	affectingSystematics () const override
	the list of all systematics this tool can be affected by More...
virtual SystematicSet	recommendedSystematics () const override
	the list of all systematics this tool recommends to use More...
virtual StatusCode	applySystematicVariation (const SystematicSet &systConfig) override
	effects: configure this tool for the given list of systematic variations. More...
virtual double	expectedResolution (const std::string &DetType, const xAOD::Muon &mu, const bool addMCCorrectionSmearing) const override
	Get the expected pT resolution. More...
virtual double	expectedResolution (const int &DetType, const xAOD::Muon &mu, const bool addMCCorrectionSmearing) const override
	Get the expected pT resolution - int argument is more efficient. More...
double	expectedResolution (const int &DetType, columnar::MuonId mu, columnar::EventInfoId evtInfo, const bool addMCCorrectionSmearing) const
virtual CorrectionCode	applyCorrectionTrkOnly (xAOD::TrackParticle &inTrk, const int DetType) const override
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

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

Detailed Description

Definition at line 36 of file MuonCalibTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MuonCalibTool()

CP::MuonCalibTool::MuonCalibTool

(

const std::string &

name

)

These properties are meant to be expert properties for debugging of the code and shall not touched by the common

Definition at line 21 of file MuonCalibTool.cxx.

                                                      : 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");       
    }

~MuonCalibTool()

virtual CP::MuonCalibTool::~MuonCalibTool ( )

virtualdefault

Member Function Documentation

affectingSystematics()

SystematicSet CP::MuonCalibTool::affectingSystematics ( ) const

overrideprivatevirtual

the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 297 of file MuonCalibTool.cxx.

    {
        SystematicSet result = m_MuonIntSagittaTool->affectingSystematics();
        result.insert(m_MuonIntScaleSmearTool->affectingSystematics());
        if (m_MuonIntHighTSmearToolInitialized) result.insert(m_MuonIntHighTSmearTool->affectingSystematics());
        return result;
    }

applyCorrection() [1/2]

CorrectionCode CP::MuonCalibTool::applyCorrection ( columnar::MuonId  mu, columnar::EventInfoId  evtInfo  ) const

private

Definition at line 144 of file MuonCalibTool.cxx.

    {
        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) 
            {
                CorrectionCode sgCode = m_MuonIntSagittaTool->applyCorrection(muonObj);
                if (sgCode != 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::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 CorrectionCode::Ok;
        }
 
        // Do Scale and Smearing corrections
        CorrectionCode sgCode = m_MuonIntScaleSmearTool->applyCorrection(muonObj);
        if (sgCode != CorrectionCode::Ok) return sgCode;
 
        // Systematics for sagitta correction
        if ((mu(acc.muonTypeAcc) != xAOD::Muon::SiliconAssociatedForwardMuon)) 
        {
            ATH_MSG_VERBOSE("Systematic uncertainties for sagitta bias ");
            // TODO:: something specific for calo tags
            CorrectionCode sgCode = m_MuonIntSagittaTool->applyCorrection(muonObj);
            if (sgCode != 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() & 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() & 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 != 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 == CorrectionCode::OutOfValidityRange) return sgCode;
 
        // Return gracefully:
        return CorrectionCode::Ok;
    }

applyCorrection() [2/2]

CorrectionCode CP::MuonCalibTool::applyCorrection ( xAOD::Muon &  mu ) const

overrideprivatevirtual

Declare the interface that the class provides.

Apply the correction on a modifyable object

Implements CP::IMuonCalibrationAndSmearingTool.

Definition at line 137 of file MuonCalibTool.cxx.

    {
        // Retrieve the event information:
        SG::ReadHandle<xAOD::EventInfo> evtInfo(m_eventInfo);
        return applyCorrection(columnar::MuonId(mu), columnar::EventInfoId(*evtInfo));
    }

applyCorrectionTrkOnly()

CorrectionCode CP::MuonCalibTool::applyCorrectionTrkOnly ( xAOD::TrackParticle &  inTrk, const int  DetType  ) const

overrideprivatevirtual

Implements CP::IMuonCalibrationAndSmearingTool.

Definition at line 251 of file MuonCalibTool.cxx.

    {
        // Convert to the internal object
        MCP::MuonObj muonObj = convertToMuonObj(inTrk, DetType);
 
        // Do Scale and Smearing corrections
        CorrectionCode sgCode = m_MuonIntScaleSmearTool->applyCorrection(muonObj);
        if (sgCode != 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 CorrectionCode::Ok;
    }

applySystematicVariation()

StatusCode CP::MuonCalibTool::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 307 of file MuonCalibTool.cxx.

    {
        // 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;
    }

callEvents()

void CP::MuonCalibTool::callEvents ( columnar::EventContextRange  events ) const

override

Definition at line 664 of file MuonCalibTool.cxx.

                                                                          {
        auto& acc = *m_acc;
        for (columnar::EventContextId event : events)
        {
            auto eventInfo = acc.m_eventInfoCol(event);
            callSingleEvent (acc.m_muons(event), eventInfo);
        }
    }

callSingleEvent()

void CP::MuonCalibTool::callSingleEvent	(	columnar::MuonRange	muons,
		columnar::EventInfoId	event
	)		const

Definition at line 647 of file MuonCalibTool.cxx.

    {
        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");
            }
        }
    }

convertToMuonObj() [1/2]

MCP::MuonObj CP::MuonCalibTool::convertToMuonObj ( columnar::MuonId  mu, columnar::EventInfoId  evtInfo  ) const

protected

Definition at line 418 of file MuonCalibTool.cxx.

    {
        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::AuxElement::Accessor<float> cb_pt("expert_ptcb");
            static const SG::AuxElement::Accessor<float> id_pt("expert_ptid");
            static const SG::AuxElement::Accessor<float> ms_pt("expert_ptms");
            static const SG::AuxElement::Accessor<AmgVector(5)> CBParam("CBParam");
            static const SG::AuxElement::Accessor<AmgSymMatrix(5)> CBCov("CBCov");
            static const SG::AuxElement::Accessor<AmgVector(5)>  IDParam("IDParam");
            static const SG::AuxElement::Accessor<AmgSymMatrix(5)>  IDCov("IDCov");
            static const SG::AuxElement::Accessor<AmgVector(5)> MEParam("MEParam");
            static const SG::AuxElement::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::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;
    }

convertToMuonObj() [2/2]

MCP::MuonObj CP::MuonCalibTool::convertToMuonObj ( const xAOD::TrackParticle &  inTrk, const int  DetType  ) const

protected

Definition at line 494 of file MuonCalibTool.cxx.

    {
        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;
    }

correctedCopy()

CorrectionCode CP::MuonCalibTool::correctedCopy ( const xAOD::Muon &  input, xAOD::Muon *&  output  ) const

overrideprivatevirtual

Create a corrected copy from a constant muon.

Implements CP::IMuonCalibrationAndSmearingTool.

Definition at line 269 of file MuonCalibTool.cxx.

    {
        // 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;
    }

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

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());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

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

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

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() [1/2]

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; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

expectedResolution() [1/3]

double CP::MuonCalibTool::expectedResolution ( const int &  DetType, columnar::MuonId  mu, columnar::EventInfoId  evtInfo, const bool  addMCCorrectionSmearing  ) const

private

Definition at line 344 of file MuonCalibTool.cxx.

    {
        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::AuxElement::Accessor<float> id_pt("expert_ptid");
            static const SG::AuxElement::Accessor<float> ms_pt("expert_ptms");
            static const SG::AuxElement::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.;
 
    }

expectedResolution() [2/3]

double CP::MuonCalibTool::expectedResolution ( const int &  DetType, const xAOD::Muon &  mu, const bool  mc  ) const

overrideprivatevirtual

Get the expected pT resolution - int argument is more efficient.

Implements CP::IMuonCalibrationAndSmearingTool.

Definition at line 338 of file MuonCalibTool.cxx.

    {
        SG::ReadHandle<xAOD::EventInfo> evtInfo(m_eventInfo);
        return expectedResolution(DetType, columnar::MuonId(mu), columnar::EventInfoId(*evtInfo), addMCCorrectionSmearing);
    }

expectedResolution() [3/3]

double CP::MuonCalibTool::expectedResolution ( const std::string &  DetType, const xAOD::Muon &  mu, const bool  mc  ) const

overrideprivatevirtual

Get the expected pT resolution.

Implements CP::IMuonCalibrationAndSmearingTool.

Definition at line 323 of file MuonCalibTool.cxx.

    {
        // 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.;
        }
    }

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

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
   }

getPeriod()

MCP::DataYear CP::MuonCalibTool::getPeriod ( bool  isData, columnar::EventInfoId  evtInfo  ) const

protected

Definition at line 551 of file MuonCalibTool.cxx.

    {
        // 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
        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 = 440614;
        constexpr unsigned int last_run_23 = 456750;
    constexpr unsigned int last_run_24 = 999999;
 
        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};
    static const std::set<int> MCperiods24{470000};
 
        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 (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;
            }
        }
        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 year 24");
            warningPrinted = true;
        }
        return MCP::DataYear::Data24;
    }

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::MuonCalibTool::initialize ( )

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...

Create the high pT tool

Reimplemented from asg::AsgTool.

Definition at line 30 of file MuonCalibTool.cxx.

    {
        // 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 with CB calibration");
            m_doDirectCBCalib = true;
            m_applyCorrectionOnData = true;
 
        } else if (m_calibMode == MuonCalibTool::correctData_IDMS) {
            ATH_MSG_INFO("Data will be corrected for sagitta bias with ID+MS calibration");
        if (m_isRun3.value()) ATH_MSG_WARNING("You are using the ID+MS calibration which is currenlty not recommended from the MCP group in Run3. Please refer to the MCP documentation page");
            m_doDirectCBCalib = false;
            m_applyCorrectionOnData = true;
        
        } else if (m_calibMode == MuonCalibTool::notCorrectData_IDMS) {
        ATH_MSG_INFO("Data will be untouched. Instead an additional systematic will be added with ID+MS calibration");
        if (m_isRun3.value()) ATH_MSG_WARNING("You are using the ID+MS calibration which is currenlty not recommended from the MCP group in Run3. Please refer to the MCP documentation page");
        m_doDirectCBCalib = false;
        m_applyCorrectionOnData = false;
        } 
    else if (m_calibMode == MuonCalibTool::notCorrectData_CB) {
            ATH_MSG_INFO("Data will be untouched. Instead an additional systematic will be added with CB calibration");
            m_doDirectCBCalib = true;
            m_applyCorrectionOnData = false;
    }
        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 << ")");
            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("CP::MuonCalibIntSagittaTool/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("applyCorrectionOnData", m_applyCorrectionOnData.value()));
        ATH_CHECK(m_MuonIntSagittaTool.setProperty("doDirectCBCalib", m_doDirectCBCalib.value()));
            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("CP::MuonCalibIntScaleSmearTool/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("doDirectCBCalib", m_doDirectCBCalib.value()));
            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("CP::MuonCalibIntHighpTSmearTool/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(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;
        }
        ATH_CHECK (initializeColumns());
        // Return gracefully:
        return StatusCode::SUCCESS;
    }

initializeRandNumbers()

void CP::MuonCalibTool::initializeRandNumbers ( MCP::MuonObj &  obj, columnar::EventInfoId  evtInfo  ) const

protected

Decorate all information that's needed to ensure reproducibility of the smearing.

Definition at line 528 of file MuonCalibTool.cxx.

    {
        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);
 
 
    }

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::MuonCalibTool::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 291 of file MuonCalibTool.cxx.

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

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

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

recommendedSystematics()

SystematicSet CP::MuonCalibTool::recommendedSystematics ( ) const

overrideprivatevirtual

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 305 of file MuonCalibTool.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();
  }

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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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_2stations_highpt_smearing

Gaudi::Property<bool> CP::MuonCalibTool::m_2stations_highpt_smearing {this, "do2StationsHighPt", false, "Extra smearing to be applied if high pT WP is used"}

protected

Definition at line 120 of file MuonCalibTool.h.

m_acc

std::unique_ptr<MCP::MuonCalibToolAccessors> CP::MuonCalibTool::m_acc {std::make_unique<MCP::MuonCalibToolAccessors>(*this)}

Definition at line 151 of file MuonCalibTool.h.

m_applyCorrectionOnData

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

protected

Definition at line 115 of file MuonCalibTool.h.

m_calibMode

Gaudi::Property<int> CP::MuonCalibTool::m_calibMode {this, "calibMode", -1, "Calib mode"}

protected

Definition at line 102 of file MuonCalibTool.h.

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::MuonCalibTool::m_doDirectCBCalib {this, "doDirectCBCalib", true, "Do direct calibration of CB tracks, otherwise, do ID+MS"}

protected

Definition at line 110 of file MuonCalibTool.h.

m_doEtaSagittaSys

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

protected

Definition at line 114 of file MuonCalibTool.h.

m_eventInfo

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

protected

Definition at line 87 of file MuonCalibTool.h.

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_excludeNSWFromPrecisionLayers

Gaudi::Property<bool> CP::MuonCalibTool::m_excludeNSWFromPrecisionLayers {this, "ExcludeNSWFromPrecisionLayers", false, "Cut on the number of precision layers ignores the NSW"}

protected

Definition at line 106 of file MuonCalibTool.h.

m_expertMode_EvtNumber

Gaudi::Property<unsigned long long> CP::MuonCalibTool::m_expertMode_EvtNumber {this, "expertMode_EvtNumber", 0, "Expert only option. Overwrites EventNumber"}

protected

Definition at line 99 of file MuonCalibTool.h.

m_expertMode_isData

Gaudi::Property<bool> CP::MuonCalibTool::m_expertMode_isData {this, "expertMode_isData", false, "Expert only option. Overwrites the isData Flag"}

protected

Definition at line 97 of file MuonCalibTool.h.

m_expertMode_RunNumber

Gaudi::Property<int> CP::MuonCalibTool::m_expertMode_RunNumber {this, "expertMode_RunNumber", 0, "Expert only option. Overwrites RunNumber"}

protected

Definition at line 98 of file MuonCalibTool.h.

m_extra_highpt_smearing

Gaudi::Property<bool> CP::MuonCalibTool::m_extra_highpt_smearing {this, "doExtraSmearing", false, "Flag provided to test if analysis are sensitive to high pT calibration. NOT TO BE USED FOR RESULTS. Please see twiki"}

protected

Definition at line 122 of file MuonCalibTool.h.

m_HighPtSystThreshold

Gaudi::Property<float> CP::MuonCalibTool::m_HighPtSystThreshold {this, "HighPtSystThr", 300.0, "Thershold for high pT smearing in GeV"}

protected

Definition at line 123 of file MuonCalibTool.h.

m_isRun3

Gaudi::Property<bool> CP::MuonCalibTool::m_isRun3 {this, "IsRun3Geo", false, "Needed for MuonSelectionTool"}

protected

Definition at line 89 of file MuonCalibTool.h.

m_MuonIntHighTSmearTool

asg::AnaToolHandle<CP::IMuonCalibIntTool> CP::MuonCalibTool::m_MuonIntHighTSmearTool {""}

protected

Definition at line 130 of file MuonCalibTool.h.

m_MuonIntHighTSmearToolInitialized

bool CP::MuonCalibTool::m_MuonIntHighTSmearToolInitialized {false}

private

Definition at line 145 of file MuonCalibTool.h.

m_MuonIntSagittaTool

asg::AnaToolHandle<CP::IMuonCalibIntTool> CP::MuonCalibTool::m_MuonIntSagittaTool {""}

protected

Definition at line 127 of file MuonCalibTool.h.

m_MuonIntScaleSmearTool

asg::AnaToolHandle<CP::IMuonCalibIntScaleSmearTool> CP::MuonCalibTool::m_MuonIntScaleSmearTool {""}

protected

Definition at line 128 of file MuonCalibTool.h.

m_MuonSelectionTool

asg::AnaToolHandle<CP::IMuonSelectionTool> CP::MuonCalibTool::m_MuonSelectionTool {""}

protected

Definition at line 125 of file MuonCalibTool.h.

m_release

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

protected

Definition at line 92 of file MuonCalibTool.h.

m_skipResolutionCategory

Gaudi::Property<bool> CP::MuonCalibTool::m_skipResolutionCategory {this, "skipResolutionCategory", false, "whether to skip the resolution category variable"}

Definition at line 149 of file MuonCalibTool.h.

m_sysScheme

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

protected

Definition at line 94 of file MuonCalibTool.h.

m_useRndRun

Gaudi::Property<bool> CP::MuonCalibTool::m_useRndRun {this, "useRandomRunNumber", false, "To use the random run number for deciding which calibration to apply"}

protected

Definition at line 100 of file MuonCalibTool.h.

m_validationMode

Gaudi::Property<bool> CP::MuonCalibTool::m_validationMode {this, "expert_validationMode", false, "Expert only option. Puts the tool in the validation mode setup"}

protected

Definition at line 96 of file MuonCalibTool.h.

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:

• MuonCalibTool.h
• MuonCalibTool.cxx