CP::EgammaCalibrationAndSmearingTool Class Reference

#include <EgammaCalibrationAndSmearingTool.h>

Inheritance diagram for CP::EgammaCalibrationAndSmearingTool:

Classes
struct	AbsEtaCaloPredicate
struct	Accessors
struct	DoubleOrAbsEtaCaloPredicate
struct	EtaCaloPredicate
struct	SysInfo

Public Types
Definition of the StoreGate-like object's definition
typedef ServiceHandle< StoreGateSvc >	MetaStore_t
	Type of the metadata store object in Athena.
typedef const ServiceHandle< StoreGateSvc > &	MetaStorePtr_t
	Type of the metadata store pointer in standalone mode.

Public Member Functions
virtual double	getEnergy (xAOD::Egamma *, const xAOD::EventInfo *)
virtual double	getElectronMomentum (const xAOD::Electron *, const xAOD::EventInfo *)
double	getResolution (const xAOD::Egamma &particle, bool withCT=true) const override
double	intermodule_correction (double Ecl, double phi, double eta) const
double	correction_phi_unif (double eta, double phi) const
void	callSingleEvent (columnar::MutableEgammaRange egammas, columnar::EventInfoId event) const
void	callEvents (columnar::EventContextRange events) const override
virtual void	print () const =0
	Print the state of the tool.
virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena.
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	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
Functions providing access to the input/output metadata
MetaStorePtr_t	inputMetaStore () const
	Accessor for the input metadata store.
MetaStorePtr_t	outputMetaStore () const
	Accessor for the output metadata store.
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.

Public Attributes
Gaudi::Property< bool >	m_onlyElectrons {this, "onlyElectrons", false, "the tool will only be applied to electrons"}
Gaudi::Property< bool >	m_onlyPhotons {this, "onlyPhotons", false, "the tool will only be applied to photons"}
std::unique_ptr< Accessors >	m_accessors

Protected Member Functions
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.
Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)
virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent.
virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened.
virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed.
virtual StatusCode	beginEvent ()
	Function called when a new events is loaded.
virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata.

Private Types
enum class	ResolutionDecorrelation { FULL , ONENP }
typedef unsigned int	RandomNumber
typedef std::function< int(const EgammaCalibrationAndSmearingTool &, columnar::EgammaId, columnar::EventInfoId)>	IdFunction
typedef std::function< bool(const EgammaCalibrationAndSmearingTool &, columnar::EgammaId)>	EgammaPredicate
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	EgammaCalibrationAndSmearingTool (const std::string &name)
	~EgammaCalibrationAndSmearingTool ()
StatusCode	initialize () override
virtual CP::CorrectionCode	applyCorrection (xAOD::Egamma &) const override
CP::CorrectionCode	applyCorrection (columnar::MutableEgammaId input, columnar::EventInfoId event_info) const
void	setPt (columnar::MutableEgammaId input, double energy) const
virtual CP::CorrectionCode	correctedCopy (const xAOD::Electron &, xAOD::Electron *&) const override
virtual CP::CorrectionCode	correctedCopy (const xAOD::Photon &, xAOD::Photon *&) const override
double	getEnergy (const xAOD::Photon &) const
double	getEnergy (const xAOD::Electron &) const
virtual CP::SystematicSet	affectingSystematics () const override
	the list of all systematics this tool can be affected by
virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const override
	Declare the interface that this class provides.
virtual CP::SystematicSet	recommendedSystematics () const override
	the list of all systematics this tool recommends to use
virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systConfig) override
	effects: configure this tool for the given list of systematic variations.
virtual void	setRandomSeedFunction (const IdFunction &&function)
const IdFunction	getRandomSeedFunction () const
virtual double	resolution (double energy, double cl_eta, double cl_etaCalo, PATCore::ParticleType::Type ptype=PATCore::ParticleType::Electron, bool withCT=false) const override
void	setupSystematics ()
const EgammaPredicate	EtaCaloPredicateFactory (double eta_min, double eta_max) const
const EgammaPredicate	AbsEtaCaloPredicateFactory (double eta_min, double eta_max) const
const EgammaPredicate	AbsEtaCaloPredicateFactory (std::pair< double, double > edges) const
const std::vector< EgammaPredicate >	AbsEtaCaloPredicatesFactory (const std::vector< std::pair< double, double > > &edges) const
const std::vector< EgammaPredicate >	AbsEtaCaloPredicatesFactory (const std::vector< double > &edges) const
const EgammaPredicate	DoubleOrAbsEtaCaloPredicateFactory (double eta1_min, double eta1_max, double eta2_min, double eta2_max) const
PATCore::ParticleType::Type	xAOD2ptype (columnar::EgammaId particle) const
egEnergyCorr::Scale::Variation	oldtool_scale_flag_this_event (columnar::EgammaId p, columnar::EventInfoId event_info) const
egEnergyCorr::Resolution::Variation	oldtool_resolution_flag_this_event (columnar::EgammaId p, columnar::EventInfoId event_info) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_ESModel
std::string	m_decorrelation_model_name
std::string	m_decorrelation_model_scale_name
std::string	m_decorrelation_model_resolution_name
ScaleDecorrelation	m_decorrelation_model_scale = ScaleDecorrelation::FULL
ResolutionDecorrelation	m_decorrelation_model_resolution
egEnergyCorr::ESModel	m_TESModel
int	m_doScaleCorrection
int	m_doSmearing
double	m_varSF
std::string	m_ResolutionType
egEnergyCorr::Resolution::resolutionType	m_TResolutionType
int	m_useFastSim
int	m_use_AFII
PATCore::ParticleDataType::DataType	m_simulation
int	m_useIntermoduleCorrection
int	m_usePhiUniformCorrection
int	m_useCaloDistPhiUnifCorrection
int	m_useGainCorrection
int	m_doADCLinearityCorrection
int	m_doLeakageCorrection
bool	m_use_ep_combination
int	m_use_mva_calibration
bool	m_use_full_statistical_error
int	m_use_temp_correction201215
int	m_use_uA2MeV_2015_first2weeks_correction
bool	m_use_mapping_correction
int	m_user_random_run_number
int	m_useGainInterpolation
int	m_useLayerCorrection
int	m_usePSCorrection
int	m_useS12Correction
int	m_useSaccCorrection
bool	m_decorateEmva
std::unique_ptr< TH2 >	m_caloDistPhiUnifCorr
Gaudi::Property< bool >	m_fixForMissingCells
Gaudi::Property< bool >	m_doFwdCalib
Gaudi::Property< std::string >	m_pVtxKey
ServiceHandle< IegammaMVASvc >	m_MVACalibSvc
std::unique_ptr< egGain::GainUncertainty >	m_gain_tool_run2
std::shared_ptr< LinearityADC >	m_ADCLinearity_tool
egGain::GainTool *	m_gain_tool = nullptr
egammaLayerRecalibTool *	m_layer_recalibration_tool = nullptr
std::string	m_layer_recalibration_tune
std::unique_ptr< AtlasRoot::egammaEnergyCorrectionTool >	m_rootTool
std::string	m_MVAfolder
std::map< CP::SystematicVariation, SysInfo >	m_syst_description
std::map< CP::SystematicVariation, egEnergyCorr::Resolution::Variation >	m_syst_description_resolution
egEnergyCorr::Scale::Variation	m_currentScaleVariation_MC
egEnergyCorr::Scale::Variation	m_currentScaleVariation_data
egEnergyCorr::Resolution::Variation	m_currentResolutionVariation_MC
egEnergyCorr::Resolution::Variation	m_currentResolutionVariation_data
EgammaPredicate	m_currentScalePredicate
IdFunction	m_set_seed_function
MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store.
MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store.
bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file.
bool	m_useIncidents
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

Static Private Attributes
static const int	AUTO = 2
static const unsigned int	m_Run2Run3runNumberTransition = 400000

Detailed Description

Definition at line 183 of file EgammaCalibrationAndSmearingTool.h.

Member Typedef Documentation

EgammaPredicate

typedef std::function<bool(const EgammaCalibrationAndSmearingTool&, columnar::EgammaId)> CP::EgammaCalibrationAndSmearingTool::EgammaPredicate

private

Definition at line 205 of file EgammaCalibrationAndSmearingTool.h.

IdFunction

typedef std::function<int(const EgammaCalibrationAndSmearingTool&, columnar::EgammaId, columnar::EventInfoId)> CP::EgammaCalibrationAndSmearingTool::IdFunction

private

Definition at line 204 of file EgammaCalibrationAndSmearingTool.h.

MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

RandomNumber

typedef unsigned int CP::EgammaCalibrationAndSmearingTool::RandomNumber

private

Definition at line 201 of file EgammaCalibrationAndSmearingTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

ResolutionDecorrelation

enum class CP::EgammaCalibrationAndSmearingTool::ResolutionDecorrelation

strongprivate

Enumerator
FULL
ONENP

Definition at line 198 of file EgammaCalibrationAndSmearingTool.h.

{ FULL, ONENP };

Constructor & Destructor Documentation

EgammaCalibrationAndSmearingTool()

CP::EgammaCalibrationAndSmearingTool::EgammaCalibrationAndSmearingTool ( const std::string & name )

private

Definition at line 288 of file EgammaCalibrationAndSmearingTool.cxx.

    : asg::AsgMetadataTool(name),
      m_TESModel(egEnergyCorr::UNDEFINED),
      m_TResolutionType(egEnergyCorr::Resolution::SigmaEff90),
      m_use_mapping_correction(false),
      m_currentScaleVariation_MC(egEnergyCorr::Scale::None),
      m_currentScaleVariation_data(egEnergyCorr::Scale::Nominal),
      m_currentResolutionVariation_MC(egEnergyCorr::Resolution::Nominal),
      m_currentResolutionVariation_data(egEnergyCorr::Resolution::None),
      m_set_seed_function([](const EgammaCalibrationAndSmearingTool& tool,
                             columnar::EgammaId egamma,
                             columnar::EventInfoId ei) {
        const Accessors& acc = *tool.m_accessors;
        // avoid 0 as result, see
        // https://root.cern.ch/root/html/TRandom3.html#TRandom3:SetSeed
        auto cluster = acc.caloClusterAcc(egamma)[0].value();
        return 1 + static_cast<RandomNumber>(
                       std::abs(acc.clusterPhiAcc(cluster)) * 1E6 +
                       std::abs(acc.clusterEtaAcc(cluster)) * 1E3 +
                       acc.eventNumberAcc(ei));
      }),
      m_accessors(std::make_unique<Accessors>(*this)) {
 
  declareProperty("ESModel", m_ESModel = "");
  declareProperty("decorrelationModel", m_decorrelation_model_name = "");
  declareProperty("decorrelationModelScale",
                  m_decorrelation_model_scale_name = "");
  declareProperty("decorrelationModelResolution",
                  m_decorrelation_model_resolution_name = "");
  declareProperty("ResolutionType", m_ResolutionType = "SigmaEff90");
  declareProperty("varSF", m_varSF = 1.0);
  declareProperty("doScaleCorrection", m_doScaleCorrection = AUTO);
  declareProperty("doSmearing", m_doSmearing = AUTO);
  declareProperty("useLayerCorrection", m_useLayerCorrection = AUTO);
  declareProperty("usePSCorrection", m_usePSCorrection = AUTO);
  declareProperty("useS12Correction", m_useS12Correction = AUTO);
  declareProperty("useSaccCorrection", m_useSaccCorrection = AUTO);
  declareProperty("useIntermoduleCorrection",
                  m_useIntermoduleCorrection = AUTO);
  declareProperty("usePhiUniformCorrection", m_usePhiUniformCorrection = AUTO);
  declareProperty("useCaloDistPhiUnifCorrection",
                  m_useCaloDistPhiUnifCorrection = AUTO);
  declareProperty("useGainCorrection", m_useGainCorrection = AUTO);
  declareProperty("useGainInterpolation", m_useGainInterpolation = AUTO);
  declareProperty("doADCLinearityCorrection",
                  m_doADCLinearityCorrection = AUTO);
  declareProperty("doLeakageCorrection", m_doLeakageCorrection = AUTO);
  declareProperty("MVAfolder", m_MVAfolder = "");
  declareProperty("layerRecalibrationTune", m_layer_recalibration_tune = "");
  declareProperty("useEPCombination", m_use_ep_combination = false);
  declareProperty("useMVACalibration", m_use_mva_calibration = AUTO);
  declareProperty("use_full_statistical_error",
                  m_use_full_statistical_error = false);
  declareProperty("use_temp_correction201215",
                  m_use_temp_correction201215 = AUTO);
  declareProperty("use_uA2MeV_2015_first2weeks_correction",
                  m_use_uA2MeV_2015_first2weeks_correction = AUTO);
  declareProperty("randomRunNumber", m_user_random_run_number = 0);
  // this is the user input, it is never changed by the tool. The tool uses
  // m_simulation.
  declareProperty("useFastSim", m_useFastSim = -1,
                  "This should be explicitly set by the user depending on the "
                  "data type (int)0=full sim, (int)1=fast sim");
  declareProperty(
      "useAFII", m_use_AFII = -1,
      "This is now deprecated. Kept for explicit error message for now");
  declareProperty("decorateEmva", m_decorateEmva = false, "whether to decorate the eMVA value");
}

~EgammaCalibrationAndSmearingTool()

CP::EgammaCalibrationAndSmearingTool::~EgammaCalibrationAndSmearingTool ( )

private

Definition at line 358 of file EgammaCalibrationAndSmearingTool.cxx.

                                                                    {
  ATH_MSG_DEBUG("destructor");
  delete m_layer_recalibration_tool;
  delete m_gain_tool;
}

Member Function Documentation

AbsEtaCaloPredicateFactory() [1/2]

const EgammaPredicate CP::EgammaCalibrationAndSmearingTool::AbsEtaCaloPredicateFactory ( double eta_min, double eta_max ) const

inlineprivate

Definition at line 341 of file EgammaCalibrationAndSmearingTool.h.

                                                                         {
    /*return [eta_min, eta_max](const xAOD::Egamma& p) {
      const double aeta = std::abs(xAOD::get_eta_calo(*p.caloCluster()));
      return (aeta >= eta_min and aeta < eta_max); };*/
    return AbsEtaCaloPredicate(eta_min, eta_max);
  }

AbsEtaCaloPredicateFactory() [2/2]

const EgammaPredicate CP::EgammaCalibrationAndSmearingTool::AbsEtaCaloPredicateFactory ( std::pair< double, double > edges ) const

inlineprivate

Definition at line 349 of file EgammaCalibrationAndSmearingTool.h.

                                           {
    return AbsEtaCaloPredicateFactory(edges.first, edges.second);
  }

AbsEtaCaloPredicatesFactory() [1/2]

const std::vector< EgammaPredicate > CP::EgammaCalibrationAndSmearingTool::AbsEtaCaloPredicatesFactory ( const std::vector< double > & edges ) const

inlineprivate

Definition at line 364 of file EgammaCalibrationAndSmearingTool.h.

                                            {
    std::vector<EgammaPredicate> result;
    result.reserve(edges.size() - 1);
    auto it2 = edges.begin();
    auto it = it2++;
    for (; it2 != edges.end(); ++it, ++it2) {
      result.push_back(AbsEtaCaloPredicateFactory(*it, *it2));
    }
    return result;
  }

AbsEtaCaloPredicatesFactory() [2/2]

const std::vector< EgammaPredicate > CP::EgammaCalibrationAndSmearingTool::AbsEtaCaloPredicatesFactory ( const std::vector< std::pair< double, double > > & edges ) const

inlineprivate

Definition at line 354 of file EgammaCalibrationAndSmearingTool.h.

                                                             {
    std::vector<EgammaPredicate> result;
    result.reserve(edges.size());
    for (const auto& it : edges) {
      result.push_back(AbsEtaCaloPredicateFactory(it.first, it.second));
    }
    return result;
  }

affectingSystematics()

CP::SystematicSet CP::EgammaCalibrationAndSmearingTool::affectingSystematics ( ) const

overrideprivatevirtual

the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 1292 of file EgammaCalibrationAndSmearingTool.cxx.

          {
  CP::SystematicSet affecting_systematics;
  for (const auto& it : m_syst_description) {
    affecting_systematics.insert(it.first);
  }
  for (const auto& it : m_syst_description_resolution) {
    affecting_systematics.insert(it.first);
  }
 
  return affecting_systematics;
}

applyCorrection() [1/2]

CP::CorrectionCode CP::EgammaCalibrationAndSmearingTool::applyCorrection ( columnar::MutableEgammaId input, columnar::EventInfoId event_info ) const

private

Definition at line 989 of file EgammaCalibrationAndSmearingTool.cxx.

                                                                         {
  const Accessors& acc = *m_accessors;
 
  // only used in simulation (for the smearing)
  RandomNumber seed = m_set_seed_function(*this, input, event_info);
 
  columnar::ClusterId inputCluster = acc.caloClusterAcc (input)[0].value();
 
  if (m_layer_recalibration_tool && acc.authorAcc (input) !=
    xAOD::EgammaParameters::AuthorFwdElectron) {
    ATH_MSG_DEBUG("applying energy recalibration before E0|E1|E2|E3 = "
                  << acc.energyBEAcc (inputCluster, 0) << "|"
                  << acc.energyBEAcc (inputCluster, 1) << "|"
                  << acc.energyBEAcc (inputCluster, 2) << "|"
                  << acc.energyBEAcc (inputCluster, 3));
    // for now just go back to the xAOD object to access the subtool
    const CP::CorrectionCode status_layer_recalibration = m_layer_recalibration_tool->applyCorrection(input.getXAODObject(), event_info.getXAODObject());
    if (status_layer_recalibration == CP::CorrectionCode::Error) { return CP::CorrectionCode::Error; }
    ATH_MSG_DEBUG("eta|phi = " << acc.etaAcc (input) << "|" << acc.phiAcc (input));
    if (status_layer_recalibration == CP::CorrectionCode::Ok) {
      ATH_MSG_DEBUG("decoration E0|E1|E2|E3 = "
                    << acc.Es0Acc(inputCluster) << "|"
                    << acc.Es1Acc(inputCluster) << "|"
                    << acc.Es2Acc(inputCluster) << "|"
                    << acc.Es3Acc(inputCluster) << "|");
      if (acc.Es2Acc(inputCluster) == 0 and acc.Es1Acc(inputCluster) == 0 and
          acc.Es3Acc(inputCluster) == 0 and acc.Es0Acc(inputCluster) == 0 and
          (std::abs(acc.etaAcc (input)) < 1.37 or (std::abs(acc.etaAcc (input)) > 1.55 and std::abs(acc.etaAcc (input)) < 2.47)))
      {
        ATH_MSG_WARNING("all layer energies are zero");
      }
    }
  }
 
  double energy = acc.momAcc.e (input);
  // apply MVA calibration
  if (!m_MVACalibSvc.empty()) {
    egammaMVACalib::GlobalEventInfo gei;
    if (acc.authorAcc (input) ==
    xAOD::EgammaParameters::AuthorFwdElectron && m_doFwdCalib) {
      const xAOD::VertexContainer* pVtxCont = nullptr;
      if (evtStore()->retrieve(pVtxCont, m_pVtxKey).isFailure()) {
    ATH_MSG_ERROR("No primary vertex container " << m_pVtxKey << " could be retrieved");
    return CP::CorrectionCode::Error;
      }
      unsigned int npv(0);
      for (const auto *vtx : *pVtxCont) {
    if (vtx->vertexType() == xAOD::VxType::PriVtx ||
        vtx->vertexType() == xAOD::VxType::PileUp) { ++npv; }
      }
      gei.nPV = npv;
      gei.acmu = acc.actIntPerXingAcc(event_info);
      ATH_MSG_DEBUG("Retrieved nPV = " << gei.nPV << " and mu = " << gei.acmu);
    }
    if (acc.authorAcc (input) !=
    xAOD::EgammaParameters::AuthorFwdElectron || m_doFwdCalib) {
      if (m_MVACalibSvc->getEnergy(inputCluster.getXAODObject(), input.getXAODObject(), energy, gei)
      .isFailure()) {
    ATH_MSG_ERROR("Failure in MVACalib service");
    return CP::CorrectionCode::Error;
      }
      ATH_MSG_DEBUG("energy after MVA calibration = " << std::format("{:.2f}", energy));
    }
  }
  if (m_decorateEmva)
  {
    acc.decEmva(input) = energy;
  }
 
  // For the time being, it is just the MVA calib
  if (acc.authorAcc (input) ==
    xAOD::EgammaParameters::AuthorFwdElectron) {
    setPt(input, energy);
    return CP::CorrectionCode::Ok;
  }
 
  if (m_TESModel == egEnergyCorr::es2011c) {
    // Crack calibation correction for es2011c (calibration hits calibration)
    const auto ptype = xAOD2ptype(input);
    const double etaden =
        ptype == PATCore::ParticleType::Electron
            ? static_cast<const xAOD::Electron&>(input.getXAODObject()).trackParticle()->eta()
            : acc.clusterEtaAcc(inputCluster);
    energy *= m_rootTool->applyMCCalibration(acc.clusterEtaAcc(inputCluster),
                                             energy / cosh(etaden), ptype);
    ATH_MSG_DEBUG("energy after crack calibration es2011c = "
                  << std::format("{:.2f}", energy));
  }
 
  /*
   * Here we check for each event the kind of data DATA vs FullSim
   * The m_simulation flavour has already been configured
   */
  PATCore::ParticleDataType::DataType dataType =
      (acc.eventTypeAcc(event_info,xAOD::EventInfo::IS_SIMULATION))
          ? m_simulation
          : PATCore::ParticleDataType::Data;
 
  unsigned int runNumber_for_tool = 0;
 
  // apply uniformity corrections to data
  if (dataType == PATCore::ParticleDataType::Data) {
    // Get run number
    runNumber_for_tool = acc.runNumberAcc(event_info);
    // Get etaCalo, phiCalo
    const auto cl_eta = acc.clusterEtaAcc(inputCluster);
    double etaCalo = 0, phiCalo = 0;
    if (m_ADCLinearity_tool || m_gain_tool_run2 || m_usePhiUniformCorrection) {
      etaCalo = acc.etaCaloAcc(inputCluster, acc.authorAcc(input), false);
      if (m_usePhiUniformCorrection) {
        phiCalo =
            acc.phiCaloAcc(inputCluster, acc.authorAcc(input), false);
      }
    }
 
    // Intermodule
    if (m_useIntermoduleCorrection) {
      energy =
          intermodule_correction(energy, acc.clusterPhiAcc(inputCluster), cl_eta);
      ATH_MSG_DEBUG("energy after intermodule correction = "
                    << std::format("{:.2f}", energy));
    }
 
    // Calo distortion
    if ( (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 || 
          m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 || 
          m_TESModel == egEnergyCorr::es2024_Run3_v0) &&
        m_useCaloDistPhiUnifCorrection) {
      double etaC = acc.clusterEtaAcc(inputCluster);
      double phiC = acc.clusterPhiAcc(inputCluster);
      int ieta = m_caloDistPhiUnifCorr->GetXaxis()->FindBin(etaC);
      ieta = ieta == 0 ? 1
                       : (ieta > m_caloDistPhiUnifCorr->GetNbinsX()
                              ? m_caloDistPhiUnifCorr->GetNbinsX()
                              : ieta);
      int iphi = m_caloDistPhiUnifCorr->GetYaxis()->FindBin(phiC);
      iphi = iphi == 0 ? 1
                       : (iphi > m_caloDistPhiUnifCorr->GetNbinsY()
                              ? m_caloDistPhiUnifCorr->GetNbinsY()
                              : iphi);
      energy *= m_caloDistPhiUnifCorr->GetBinContent(ieta, iphi);
      ATH_MSG_DEBUG(
          "energy after phi uniformity correction (for calo distortion) = "
          << std::format("{:.2f}", energy));
    }
 
    // Phi
    if (m_usePhiUniformCorrection) {
      energy *= correction_phi_unif(etaCalo, phiCalo);
      ATH_MSG_DEBUG("energy after uniformity correction = "
                    << std::format("{:.2f}", energy));
    }
 
    // ADC
    if (m_ADCLinearity_tool) {
      double et = energy / std::cosh(cl_eta);
      double corr =
          m_ADCLinearity_tool->getCorr(etaCalo, et, xAOD2ptype(input));
      energy *= corr;
      ATH_MSG_DEBUG("energy after ADC linearity correction = "
                    << std::format("{:.2f}", energy));
    }
 
    // Gain
    if (m_gain_tool) {
      const auto es2 = acc.Es2Acc.isAvailable(inputCluster)
                           ? acc.Es2Acc(inputCluster)
                           : acc.energyBEAcc (inputCluster,2);
      if (!(std::abs(cl_eta) < 1.52 and std::abs(cl_eta) > 1.37) and
          std::abs(cl_eta) < 2.4)
        energy = m_gain_tool->CorrectionGainTool(
            cl_eta, energy / GeV, es2 / GeV,
            xAOD2ptype(input));  // cl_eta ok, TODO: check corrected E2
    } else if (m_gain_tool_run2) {
      double et = energy / std::cosh(cl_eta);
      double corr = m_gain_tool_run2->getUncertainty(etaCalo, et,
                                                     xAOD2ptype(input), true);
      energy /= (1 + corr);
    }
    ATH_MSG_DEBUG("energy after gain correction = " << std::format("{:.2f}", energy));
  } else {
    if (m_user_random_run_number == 0) {
      if (acc.randomrunnumber_getter.isAvailable(event_info)) {
        runNumber_for_tool = acc.randomrunnumber_getter(event_info);
      } else {
        ATH_MSG_ERROR(
            "Pileup tool not run before using "
            "ElectronPhotonFourMomentumCorrection! Assuming it is 2016. If you "
            "want to force a specific period set the property randomRunNumber "
            "of the tool, e.g. in the job option: "
            "tool.randomRunNumber = 123456 or "
            "tool.randomRunNumber = "
            "EgammaCalibrationAndSmearingToolRunNumbersExample.run_2016");
        runNumber_for_tool = EgammaCalibPeriodRunNumbersExample::run_2016;
      }
    } else {
      runNumber_for_tool = m_user_random_run_number;
    }
  }
 
  const double eraw = ((acc.Es0Acc.isAvailable(inputCluster)
                            ? acc.Es0Acc(inputCluster)
                            : acc.energyBEAcc(inputCluster,0)) +
                       (acc.Es1Acc.isAvailable(inputCluster)
                            ? acc.Es1Acc(inputCluster)
                            : acc.energyBEAcc(inputCluster,1)) +
                       (acc.Es2Acc.isAvailable(inputCluster)
                            ? acc.Es2Acc(inputCluster)
                            : acc.energyBEAcc(inputCluster,2)) +
                       (acc.Es3Acc.isAvailable(inputCluster)
                            ? acc.Es3Acc(inputCluster)
                            : acc.energyBEAcc(inputCluster,3)));
 
 
  if (dataType == PATCore::ParticleDataType::Fast)
    ATH_MSG_DEBUG("is fast");
  else if (dataType == PATCore::ParticleDataType::Full)
    ATH_MSG_DEBUG("is full");
  else if (dataType == PATCore::ParticleDataType::Data)
    ATH_MSG_DEBUG("is data");
 
  // apply scale factors or systematics
  energy = m_rootTool->getCorrectedEnergy(
      runNumber_for_tool, dataType, xAOD2ptype(input),
      inputCluster(acc.clusterEtaAcc),
      inputCluster(acc.clusterEtaBEAcc,2),
      acc.etaCaloAcc(inputCluster, acc.authorAcc (input), false), energy,
      acc.Es2Acc.isAvailable(inputCluster)
          ? acc.Es2Acc(inputCluster)
          : inputCluster(acc.energyBEAcc,2),
      eraw, seed, oldtool_scale_flag_this_event(input, event_info),
      oldtool_resolution_flag_this_event(input, event_info), m_TResolutionType,
      m_varSF);
 
  ATH_MSG_DEBUG("energy after scale/systematic correction = " << std::format("{:.2f}", energy));
 
  // TODO: this check should be done before systematics variations
  setPt(input, energy);
  return CP::CorrectionCode::Ok;
}

applyCorrection() [2/2]

CP::CorrectionCode CP::EgammaCalibrationAndSmearingTool::applyCorrection ( xAOD::Egamma & input ) const

overrideprivatevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 934 of file EgammaCalibrationAndSmearingTool.cxx.

                             {
  // Retrieve the event information:
  const xAOD::EventInfo* event_info = nullptr;
  if (evtStore()->retrieve(event_info, "EventInfo").isFailure()) {
    ATH_MSG_ERROR("No EventInfo object could be retrieved");
    return CP::CorrectionCode::Error;
  }
  return applyCorrection(input, *event_info);
}

applySystematicVariation()

StatusCode CP::EgammaCalibrationAndSmearingTool::applySystematicVariation ( const CP::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 2143 of file EgammaCalibrationAndSmearingTool.cxx.

                                       {
 
  // set the nominal one (no systematics)
  m_currentScaleVariation_MC = egEnergyCorr::Scale::None;
  m_currentScaleVariation_data = m_doScaleCorrection
                                     ? egEnergyCorr::Scale::Nominal
                                     : egEnergyCorr::Scale::None;
  m_currentResolutionVariation_MC = m_doSmearing
                                        ? egEnergyCorr::Resolution::Nominal
                                        : egEnergyCorr::Resolution::None;
  m_currentResolutionVariation_data = egEnergyCorr::Resolution::None;
  m_currentScalePredicate = [](const EgammaCalibrationAndSmearingTool&, columnar::EgammaId) { return true; };
 
  if (systConfig.empty())
    return StatusCode::SUCCESS;
 
  // the following code allows only ONE systematic variation at a time (1 for
  // scale, 1 for resolution)
 
  bool first_scale = true;
  bool first_resolution = true;
  for (const auto& it : systConfig) {
    const auto found_scale = m_syst_description.find(it);
    if (found_scale != m_syst_description.end()) {
      if (not first_scale) {
        ATH_MSG_ERROR("multiple scale variations not supported");
        throw std::runtime_error("multiple scale variations not supported");
      }
      first_scale = false;
      m_currentScaleVariation_MC = found_scale->second.effect;
      m_currentScalePredicate = found_scale->second.predicate;
    }
 
    const auto found_resolution = m_syst_description_resolution.find(it);
    if (found_resolution != m_syst_description_resolution.end()) {
      if (not first_resolution) {
        ATH_MSG_ERROR("multiple resolution variations not supported");
        throw std::runtime_error(
            "multiple resolution variations not supported");
      }
      first_resolution = false;
      m_currentResolutionVariation_MC = found_resolution->second;
    }
  }
 
  return StatusCode::SUCCESS;
}

beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )

protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauSelectionTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSelectionTool, Trig::TrigConfBunchCrossingTool, Trig::TrigDecisionTool, Trig::xAODBunchCrossingTool, TrigConf::xAODConfigTool, and xAODMaker::TriggerMenuMetaDataTool.

Definition at line 201 of file AsgMetadataTool.cxx.

                                          {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

beginInputFile()

StatusCode asg::AsgMetadataTool::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, BookkeeperDumperTool, BookkeeperTool, PMGTools::PMGTruthWeightTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, Trig::TrigDecisionTool, Trig::xAODBunchCrossingTool, TrigConf::xAODConfigTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 185 of file AsgMetadataTool.cxx.

                                              {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

callEvents()

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

override

Definition at line 2554 of file EgammaCalibrationAndSmearingTool.cxx.

{
  const Accessors& acc = *m_accessors;
  for (auto event : events) {
    auto eventInfo = acc.m_eventHandle(event);
    callSingleEvent (acc.m_egammaHandle(event), eventInfo);
  }
}

callSingleEvent()

void CP::EgammaCalibrationAndSmearingTool::callSingleEvent	(	columnar::MutableEgammaRange	egammas,
		columnar::EventInfoId	event ) const

Definition at line 2545 of file EgammaCalibrationAndSmearingTool.cxx.

{
  for (auto egamma : egammas) {
    if (applyCorrection (egamma, event) != CP::CorrectionCode::Ok)
      throw std::runtime_error ("EgammaCalibrationAndSmearingTool::callEvents: apply failed");
  }
}

correctedCopy() [1/2]

CP::CorrectionCode CP::EgammaCalibrationAndSmearingTool::correctedCopy ( const xAOD::Electron & input, xAOD::Electron *& output ) const

overrideprivatevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 945 of file EgammaCalibrationAndSmearingTool.cxx.

                                                            {
  // A sanity check:
  if (output)
    ATH_MSG_WARNING(
        "Non-null pointer received. "
        "There's a possible memory leak!");
 
  output = new xAOD::Electron();
  output->makePrivateStore(input);
  return applyCorrection(*output);
}

correctedCopy() [2/2]

CP::CorrectionCode CP::EgammaCalibrationAndSmearingTool::correctedCopy ( const xAOD::Photon & input, xAOD::Photon *& output ) const

overrideprivatevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 958 of file EgammaCalibrationAndSmearingTool.cxx.

                                                        {
  // A sanity check:
  if (output)
    ATH_MSG_WARNING(
        "Non-null pointer received. "
        "There's a possible memory leak!");
 
  output = new xAOD::Photon();
  output->makePrivateStore(input);
  return applyCorrection(*output);
}

correction_phi_unif()

double CP::EgammaCalibrationAndSmearingTool::correction_phi_unif	(	double	eta,
		double	phi ) const

Definition at line 2381 of file EgammaCalibrationAndSmearingTool.cxx.

                                                                               {
  constexpr double PI = M_PI;
  double Fcorr = 1.0;
 
  if (m_use_mapping_correction) {
    // wrong mapping HV -> sectors in run1
    if (eta < -0.4 && eta > -0.6) {
      if (phi < (14 * PI / 32.) && phi > (13 * PI / 32.)) {
        Fcorr += 0.035;
      } else if (phi < (13 * PI / 32.) && phi > (12 * PI / 32.)) {
        Fcorr -= 0.035;
      }
    }
  }
 
  if (m_TESModel == egEnergyCorr::es2017_summer_improved ||
      m_TESModel == egEnergyCorr::es2017_summer_final ||
      m_TESModel == egEnergyCorr::es2017_R21_v0 ||
      m_TESModel == egEnergyCorr::es2017_R21_v1 or
      m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 ||
      m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 ||
      m_TESModel == egEnergyCorr::es2018_R21_v0 ||
      m_TESModel == egEnergyCorr::es2018_R21_v1 ||
      m_TESModel == egEnergyCorr::es2022_R22_PRE ||
      m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 ||
      m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 ||
      m_TESModel == egEnergyCorr::es2024_Run3_v0) {
 
    if (eta < 0.2 && eta > 0.) {
      if (phi < (-7 * 2 * PI / 32.) && phi > (-8 * 2 * PI / 32.)) {
        Fcorr = 1.016314;
      }
    }
 
    else if (eta < 0.6 && eta > 0.4) {
      if (phi < 0 && phi > (-2 * PI / 32.)) {
        Fcorr = 1.041591;
      } else if (phi < (-4 * 2 * PI / 32.) && phi > (-5 * 2 * PI / 32.)) {
        Fcorr = 1.067346;
      }
    }
 
    else if (eta < 0.8 && eta > 0.6) {
      if (phi < (7 * 2 * PI / 32.) && phi > (6 * 2 * PI / 32.)) {
        Fcorr = 1.027980;
      }
    }
 
    else if (eta < 1.4 && eta > 1.2) {
      if (phi < (-9 * 2 * PI / 32.) && phi > (-10 * 2 * PI / 32.)) {
        Fcorr = 1.020299;
      } else if (phi < (-11 * 2 * PI / 32.) && phi > (-12 * 2 * PI / 32.)) {
        Fcorr = 1.051426;
      }
    }
 
    else if (eta < 2.3 && eta > 2.1) {
      if (phi < (-12 * 2 * PI / 32.) && phi > (-13 * 2 * PI / 32.)) {
        Fcorr = 1.071695;
      }
    }
 
    else if (eta < 0. && eta > -0.2) {
      if (phi < (-12 * 2 * PI / 32.) && phi > (-13 * 2 * PI / 32.)) {
        Fcorr = 1.008227;
      } else if (phi < (-8 * 2 * PI / 32.) && phi > (-9 * 2 * PI / 32.)) {
        Fcorr = 1.013929;
      }
    }
 
    else if (eta < -0.2 && eta > -0.4) {
      if (phi < (-9 * 2 * PI / 32.) && phi > (-10 * 2 * PI / 32.)) {
        Fcorr = 1.015749;
      }
    }
 
    else if (eta < -1.2 && eta > -1.4) {
      if (phi < (-6 * 2 * PI / 32.) && phi > (-7 * 2 * PI / 32.)) {
        Fcorr = 1.064954;
      }
    }
 
    else if (eta < -1.6 && eta > -1.8) {
      if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
        Fcorr = 1.027448;
      }
    }
 
    else if (eta < -2.3 && eta > -2.5) {
      if (phi < (-8 * 2 * PI / 32.) && phi > (-9 * 2 * PI / 32.)) {
        Fcorr = 1.025882;
      } else if (phi < (5 * 2 * PI / 32.) && phi > (4 * 2 * PI / 32.)) {
        Fcorr = 1.036616;
      } else if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
        Fcorr = 1.053838;
      } else if (phi < (10 * 2 * PI / 32.) && phi > (9 * 2 * PI / 32.)) {
        Fcorr = 1.026856;
      } else if (phi < (11 * 2 * PI / 32.) && phi > (10 * 2 * PI / 32.)) {
        Fcorr = 0.994382;
      }
    }
 
  }  // es2017_summer_improved end
 
  else {
    if (eta < 0.6 && eta > 0.4) {
      if (phi < 0 && phi > (-2 * PI / 32.)) {
        Fcorr = 1.028;
      } else if (phi < (-4 * 2 * PI / 32.) && phi > (-5 * 2 * PI / 32.)) {
        Fcorr = 1.044;
      }
    }
 
    else if (eta < 0.8 && eta > 0.6) {
      if (phi < (7 * 2 * PI / 32.) && phi > (6 * 2 * PI / 32.)) {
        Fcorr = 1.022;
      }
    }
 
    else if (eta < 1.4 && eta > 1.2) {
      if (phi < (-11 * 2 * PI / 32.) && phi > (-12 * 2 * PI / 32.)) {
        Fcorr = 1.038;
      }
    }
 
    else if (eta < 2.0 && eta > 1.9) {
      if (phi < (10 * 2 * PI / 32.) && phi > (9 * 2 * PI / 32.)) {
        Fcorr = 1.029;
      }
    }
 
    else if (eta < -1.2 && eta > -1.4) {
      if (phi < (-4 * 2 * PI / 32.) && phi > (-5 * 2 * PI / 32.)) {
        Fcorr = 1.048;
      } else if (phi < (-6 * 2 * PI / 32.) && phi > (-7 * 2 * PI / 32.)) {
        Fcorr = 1.048;
      }
    }
 
    else if (eta < -1.6 && eta > -1.8) {
      if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
        Fcorr = 1.024;
      }
    }
 
    else if (eta < -2.3 && eta > -2.5) {
      if (phi < (-8 * 2 * PI / 32.) && phi > (-9 * 2 * PI / 32.)) {
        Fcorr = 1.037;
      } else if (phi < (5 * 2 * PI / 32.) && phi > (4 * 2 * PI / 32.)) {
        Fcorr = 1.031;
      } else if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
        Fcorr = 1.040;
      } else if (phi < (10 * 2 * PI / 32.) && phi > (9 * 2 * PI / 32.)) {
        Fcorr = 1.030;
      } else if (phi < (11 * 2 * PI / 32.) && phi > (10 * 2 * PI / 32.)) {
        Fcorr = 1.020;
      }
    }
  }
 
  return Fcorr;
}

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

DoubleOrAbsEtaCaloPredicateFactory()

const EgammaPredicate CP::EgammaCalibrationAndSmearingTool::DoubleOrAbsEtaCaloPredicateFactory ( double eta1_min, double eta1_max, double eta2_min, double eta2_max ) const

inlineprivate

Definition at line 396 of file EgammaCalibrationAndSmearingTool.h.

                             {
    return DoubleOrAbsEtaCaloPredicate(eta1_min, eta1_max, eta2_min, eta2_max);
  }

endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

EtaCaloPredicateFactory()

const EgammaPredicate CP::EgammaCalibrationAndSmearingTool::EtaCaloPredicateFactory ( double eta_min, double eta_max ) const

inlineprivate

Definition at line 320 of file EgammaCalibrationAndSmearingTool.h.

  {
    return EtaCaloPredicate(eta_min, eta_max);
  }

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

getElectronMomentum()

double CP::EgammaCalibrationAndSmearingTool::getElectronMomentum ( const xAOD::Electron * el, const xAOD::EventInfo * event_info )

virtual

Definition at line 1268 of file EgammaCalibrationAndSmearingTool.cxx.

                                                             {
  PATCore::ParticleDataType::DataType dataType =
      (event_info->eventType(xAOD::EventInfo::IS_SIMULATION))
          ? m_simulation
          : PATCore::ParticleDataType::Data;
 
  const xAOD::TrackParticle* eTrack = el->trackParticle();
 
  // track momentum and eta
  const float el_tracketa = eTrack->eta();
  const float el_trackmomentum = eTrack->pt() * cosh(el->eta());
 
  return m_rootTool->getCorrectedMomentum(
      dataType, PATCore::ParticleType::Electron, el_trackmomentum, el_tracketa,
      oldtool_scale_flag_this_event(*el, *event_info), m_varSF);
}

getEnergy() [1/3]

double CP::EgammaCalibrationAndSmearingTool::getEnergy ( const xAOD::Electron & input ) const

private

Definition at line 980 of file EgammaCalibrationAndSmearingTool.cxx.

                                     {
  xAOD::Electron* new_particle = nullptr;
  ANA_CHECK_THROW(correctedCopy(input, new_particle));
  const double e = new_particle->e();
  delete new_particle;
  return e;
}

getEnergy() [2/3]

double CP::EgammaCalibrationAndSmearingTool::getEnergy ( const xAOD::Photon & input ) const

private

Definition at line 971 of file EgammaCalibrationAndSmearingTool.cxx.

                                   {
  xAOD::Photon* new_particle = nullptr;
  ANA_CHECK_THROW(correctedCopy(input, new_particle));
  const double e = new_particle->e();
  delete new_particle;
  return e;
}

getEnergy() [3/3]

double CP::EgammaCalibrationAndSmearingTool::getEnergy ( xAOD::Egamma * p, const xAOD::EventInfo * event_info )

virtual

Definition at line 1240 of file EgammaCalibrationAndSmearingTool.cxx.

                                                    {
  ANA_CHECK_THROW(applyCorrection(*p, *event_info));
  ATH_MSG_DEBUG("returning " << p->e());
  return p->e();
}

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.

getRandomSeedFunction()

const IdFunction CP::EgammaCalibrationAndSmearingTool::getRandomSeedFunction ( ) const

inlineprivate

Definition at line 241 of file EgammaCalibrationAndSmearingTool.h.

{ return m_set_seed_function; }

getResolution()

double CP::EgammaCalibrationAndSmearingTool::getResolution ( const xAOD::Egamma & particle, bool withCT = true ) const

overridevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 916 of file EgammaCalibrationAndSmearingTool.cxx.

                                                   {
  const auto ptype = xAOD2ptype(particle);
  const auto cl_etaCalo =
      xAOD::get_eta_calo(*particle.caloCluster(), particle.author());
 
  return m_rootTool->resolution(particle.e(), particle.caloCluster()->eta(),
                                cl_etaCalo, ptype, withCT,
                                false);  // TODO: always for full simulation
}

handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 135 of file AsgMetadataTool.cxx.

                                                     {
 
      // Tell the user what's happening:
      ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
 
      // Call the appropriate member function:
      if( inc.type() == IncidentType::BeginInputFile ) {
        m_beginInputFileCalled = true;
        if( beginInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call beginInputFile()" );
          throw std::runtime_error( "Couldn't call beginInputFile()" );
         }
      } else if( inc.type() == IncidentType::EndInputFile ) {
        if( endInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call endInputFile()" );
          throw std::runtime_error( "Couldn't call endInputFile()" );
         }
      } else if( inc.type() == IncidentType::BeginEvent ) {
         // If the tool didn't catch the begin input file incident for the
         // first input file of the job, then call the appropriate function
         // now.
         if( ! m_beginInputFileCalled ) {
            m_beginInputFileCalled = true;
            if( beginInputFile().isFailure() ) {
               ATH_MSG_FATAL( "Failed to call beginInputFile()" );
               throw std::runtime_error( "Couldn't call beginInputFile()" );
            }
         }
         if( beginEvent().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call beginEvent()" );
            throw std::runtime_error( "Couldn't call beginEvent()" );
         }
 
     #ifdef XAOD_STANDALONE
      } else if( inc.type() == IncidentType::MetaDataStop ) {
         if( metaDataStop().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call metaDataStop()" );
            throw std::runtime_error( "Couldn't call metaDataStop()" );
         }
         
     #endif // XAOD_STANDALONE
      } else {
         ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
      }
 
      return;
   }

initialize()

StatusCode CP::EgammaCalibrationAndSmearingTool::initialize ( void )

overrideprivatevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 364 of file EgammaCalibrationAndSmearingTool.cxx.

                                                        {
  ATH_MSG_INFO("Initialization");
 
  if (m_ESModel == "es2015XX") {
    ATH_MSG_ERROR("es2015XX is deprecated. Use es2015PRE");
  }
 
  if (m_ESModel == "es2010") {
    m_TESModel = egEnergyCorr::es2010;
  }  // legacy
  else if (m_ESModel == "es2011c") {
    m_TESModel = egEnergyCorr::es2011c;
  }  // mc11c : faulty G4; old geometry
  else if (m_ESModel == "es2011d") {
    m_TESModel = egEnergyCorr::es2011d;
  }  // mc11d : corrected G4; new geometry == final Run1 scheme
  else if (m_ESModel == "es2012a") {
    m_TESModel = egEnergyCorr::es2012a;
  }  // mc12a : "crude" G4 fix; old geometry
  else if (m_ESModel == "es2012c") {
    m_TESModel = egEnergyCorr::es2012c;
  }  // mc12c : corrected G4; new geometry == final Run1 scheme
  else if (m_ESModel == "es2012XX") {
    m_TESModel = egEnergyCorr::es2012XX;
  } else if (m_ESModel == "es2015PRE") {
    m_TESModel = egEnergyCorr::es2015PRE;
  } else if (m_ESModel == "es2015PRE_res_improved") {
    m_TESModel = egEnergyCorr::es2015PRE_res_improved;
  } else if (m_ESModel == "es2015cPRE") {
    m_TESModel = egEnergyCorr::es2015cPRE;
  } else if (m_ESModel == "es2015cPRE_res_improved") {
    m_TESModel = egEnergyCorr::es2015cPRE_res_improved;
  } else if (m_ESModel == "es2015c_summer") {
    m_TESModel = egEnergyCorr::es2015c_summer;
  } else if (m_ESModel == "es2016PRE") {
    m_TESModel = egEnergyCorr::es2016PRE;
  } else if (m_ESModel == "es2016data_mc15c") {
    m_TESModel = egEnergyCorr::es2017;
  } else if (m_ESModel == "es2016data_mc15c_summer") {
    m_TESModel = egEnergyCorr::es2017_summer;
  } else if (m_ESModel == "es2016data_mc15c_summer_improved") {
    m_TESModel = egEnergyCorr::es2017_summer_improved;
  } else if (m_ESModel == "es2016data_mc15c_final") {
    m_TESModel = egEnergyCorr::es2017_summer_final;
  } else if (m_ESModel == "es2015_5TeV") {
    m_TESModel = egEnergyCorr::es2015_5TeV;
  } else if (m_ESModel == "es2017_R21_PRE") {
    m_TESModel = egEnergyCorr::es2017_R21_PRE;
  } else if (m_ESModel == "es2017_R21_v0") {
    m_TESModel = egEnergyCorr::es2017_R21_v0;
  } else if (m_ESModel == "es2017_R21_v1") {
    m_TESModel = egEnergyCorr::es2017_R21_v1;
  } else if (m_ESModel == "es2017_R21_ofc0_v1") {
    m_TESModel = egEnergyCorr::es2017_R21_ofc0_v1;
  } else if (m_ESModel == "es2018_R21_v0") {
    m_TESModel = egEnergyCorr::es2018_R21_v0;
  } else if (m_ESModel == "es2018_R21_v1") {
    m_TESModel = egEnergyCorr::es2018_R21_v1;
  } else if (m_ESModel == "es2022_R22_PRE") {
    m_TESModel = egEnergyCorr::es2022_R22_PRE;
  } else if (m_ESModel == "es2023_R22_Run2_v0") {
    m_TESModel = egEnergyCorr::es2023_R22_Run2_v0;
  } else if (m_ESModel == "es2023_R22_Run2_v1") {
    m_TESModel = egEnergyCorr::es2023_R22_Run2_v1;
  } else if (m_ESModel == "es2024_Run3_ofc0_v0") {
    m_TESModel = egEnergyCorr::es2024_Run3_ofc0_v0;
  } else if (m_ESModel == "es2024_Run3_v0") {
    m_TESModel = egEnergyCorr::es2024_Run3_v0;
  } else if (m_ESModel.empty()) {
    ATH_MSG_ERROR("you must set ESModel property");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_ERROR("Cannot understand model " << m_ESModel);
    return StatusCode::FAILURE;
  }
 
  if (m_ResolutionType == "Gaussian") {
    m_TResolutionType = egEnergyCorr::Resolution::Gaussian;
  } else if (m_ResolutionType == "SigmaEff80") {
    m_TResolutionType = egEnergyCorr::Resolution::SigmaEff80;
  } else if (m_ResolutionType == "SigmaEff90") {
    m_TResolutionType = egEnergyCorr::Resolution::SigmaEff90;
  } else {
    ATH_MSG_ERROR("Cannot understand resolution " << m_ResolutionType);
    return StatusCode::FAILURE;
  }
 
  if (m_use_AFII != -1) {
    ATH_MSG_ERROR(
        "Property useAFII is deprecated. It is now replaced with useFastSim, "
        "which should be explicitly configured");
    return StatusCode::FAILURE;
  }
 
  if (m_useFastSim == 1) {
    m_simulation = PATCore::ParticleDataType::Fast;
  } else if (m_useFastSim == 0) {
    m_simulation = PATCore::ParticleDataType::Full;
  } else {
    ATH_MSG_ERROR("Property useFastSim should be explicitly configured");
    return StatusCode::FAILURE;
  }
 
  if ( (m_TESModel == egEnergyCorr::es2022_R22_PRE || m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0) &&
      m_simulation == PATCore::ParticleDataType::Fast) {
    ATH_MSG_ERROR(
        "Sample is FastSim but no AF3 calibration is supported with "
        "MC23 pre-recommendations (es2022_R22_PRE and es2024_Run3_ofc0_v0). "
        "Please swtich to Run3 consolidated recommendations (es2024_Run3_v0), " 
        "or get in touch with the EGamma CP group in case you are using this");
    return StatusCode::FAILURE;
  }
 
  // configure decorrelation model, translate string property to internal class
  // enum
  /*    S R SR
    0.  0 0 0     WARNING Full, Full (this is the default without configuration)
    1.  0 0 1     SR
    2.  0 1 0     FATAL
    3.  0 1 1     WARNING SR then R
    4.  1 0 0     FATAL
    5.  1 0 1     WARNING SR then S
    6.  1 1 0     S, R
    7.  1 1 1     FATAL
  */
  if (m_decorrelation_model_name.empty() and
      m_decorrelation_model_scale_name.empty() and
      m_decorrelation_model_resolution_name.empty()) {
    // case 0
    ATH_MSG_WARNING("no decorrelation model specified, assuming full model");
    m_decorrelation_model_scale = ScaleDecorrelation::FULL;
    m_decorrelation_model_resolution = ResolutionDecorrelation::FULL;
    m_decorrelation_model_name = "FULL_v1";
  } else if (not m_decorrelation_model_name.empty() and
             not m_decorrelation_model_scale_name.empty() and
             not m_decorrelation_model_resolution_name.empty()) {
    // case 7
    ATH_MSG_FATAL("too many flags for the decorrelation model");
    return StatusCode::FAILURE;
  } else {
    // set scale decorrelation model
    if (not m_decorrelation_model_scale_name.empty()) {  // case 4, 5, 6, (7)
      if (not m_decorrelation_model_name.empty()) {
        ATH_MSG_WARNING(
            "flag decorrelation model ignored for scale decorrelation model");
      }  // case 5
      if (m_decorrelation_model_scale_name == "1NP_v1")
        m_decorrelation_model_scale = ScaleDecorrelation::ONENP;
      else if (m_decorrelation_model_scale_name == "FULL_ETACORRELATED_v1")
        m_decorrelation_model_scale = ScaleDecorrelation::FULL_ETA_CORRELATED;
      else if (m_decorrelation_model_scale_name == "1NPCOR_PLUS_UNCOR")
        m_decorrelation_model_scale = ScaleDecorrelation::ONENP_PLUS_UNCONR;
      else if (m_decorrelation_model_scale_name == "FULL_v1")
        m_decorrelation_model_scale = ScaleDecorrelation::FULL;
      else {
        ATH_MSG_FATAL("cannot understand the scale decorrelation model '"
                      << m_decorrelation_model_scale_name << "'(typo?)");
        return StatusCode::FAILURE;
      }
    } else if (not m_decorrelation_model_name.empty()) {  // case 1, 3
      if (m_decorrelation_model_name == "1NP_v1")
        m_decorrelation_model_scale = ScaleDecorrelation::ONENP;
      else if (m_decorrelation_model_name == "FULL_ETACORRELATED_v1")
        m_decorrelation_model_scale = ScaleDecorrelation::FULL_ETA_CORRELATED;
      else if (m_decorrelation_model_name == "1NPCOR_PLUS_UNCOR")
        m_decorrelation_model_scale = ScaleDecorrelation::ONENP_PLUS_UNCONR;
      else if (m_decorrelation_model_name == "FULL_v1")
        m_decorrelation_model_scale = ScaleDecorrelation::FULL;
      else {
        ATH_MSG_FATAL("cannot understand the decorrelation model '"
                      << m_decorrelation_model_name << "'(typo?)");
        return StatusCode::FAILURE;
      }
    } else {  // case 2, (7)
      ATH_MSG_FATAL(
          "not information how to initialize the scale decorrelation model");
      return StatusCode::FAILURE;
    }
 
    // set resolution decorralation model
    if (not m_decorrelation_model_resolution_name
                .empty()) {  // case 2, 3, 6, (7)
      if (not m_decorrelation_model_name.empty()) {
        ATH_MSG_WARNING(
            "flag decorrelation model ignored for resolution decorrelation "
            "model");
      }  // case 3
      if (m_decorrelation_model_resolution_name == "1NP_v1")
        m_decorrelation_model_resolution = ResolutionDecorrelation::ONENP;
      else if (m_decorrelation_model_resolution_name == "FULL_v1")
        m_decorrelation_model_resolution = ResolutionDecorrelation::FULL;
      else {
        ATH_MSG_FATAL("cannot understand the resolution decorrelation model '"
                      << m_decorrelation_model_resolution_name << "'(typo?)");
        return StatusCode::FAILURE;
      }
    } else if (not m_decorrelation_model_name.empty()) {  // case 1, 5
      if (m_decorrelation_model_name == "1NP_v1")
        m_decorrelation_model_resolution = ResolutionDecorrelation::ONENP;
      else if (m_decorrelation_model_name == "FULL_ETACORRELATED_v1")
        m_decorrelation_model_resolution = ResolutionDecorrelation::FULL;
      else if (m_decorrelation_model_name == "1NPCOR_PLUS_UNCOR")
        m_decorrelation_model_resolution = ResolutionDecorrelation::ONENP;
      else if (m_decorrelation_model_name == "FULL_v1")
        m_decorrelation_model_resolution = ResolutionDecorrelation::FULL;
      else {
        ATH_MSG_FATAL("cannot understand the decorrelation model '"
                      << m_decorrelation_model_name << "'(typo?)");
        return StatusCode::FAILURE;
      }
    }
  }
 
  // create correction tool
  ATH_MSG_DEBUG("creating internal correction tool");
  m_rootTool = std::make_unique<AtlasRoot::egammaEnergyCorrectionTool>();
  if (!m_rootTool) {
    ATH_MSG_ERROR("Cannot initialize underlying tool");
    return StatusCode::FAILURE;
  }
  m_rootTool->setESModel(m_TESModel);
 
  if ( (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 ||  
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 || 
        m_TESModel == egEnergyCorr::es2024_Run3_v0) &&
      (m_useGainInterpolation == AUTO || m_useGainInterpolation == 1)) {
    ATH_MSG_DEBUG(
        "Using linear interpolation in the gain tool (uncertainties only)");
    m_useGainInterpolation = 1;
    m_rootTool->setApplyL2GainInterpolation();
  }
  m_rootTool->msg().setLevel(this->msg().level());
  m_rootTool->initialize();
 
  // configure MVA calibration
  if (m_use_mva_calibration != 0) {
    ATH_MSG_DEBUG("creating MVA calibration tool (if needed)");
    if (m_MVAfolder.empty()) {  // automatically configure MVA tool
      m_MVAfolder = egammaMVAToolFolder(m_TESModel);
    }
 
    if (not m_MVAfolder.empty()) {
 
      // electron MVA tool
      asg::AsgToolConfig config_mva_electron(
          "egammaMVACalibTool/tool_mva_electron");
      config_mva_electron.setPropertyFromString("folder", m_MVAfolder);
      ATH_CHECK(config_mva_electron.setProperty("use_layer_corrected", true));
      ATH_CHECK(config_mva_electron.setProperty(
          "ParticleType", xAOD::EgammaParameters::electron));
 
      // unconverted photon MVA tool
      asg::AsgToolConfig config_mva_unconverted(
          "egammaMVACalibTool/tool_mva_unconverted");
      config_mva_unconverted.setPropertyFromString("folder", m_MVAfolder);
      ATH_CHECK(
          config_mva_unconverted.setProperty("use_layer_corrected", true));
      ATH_CHECK(config_mva_unconverted.setProperty(
          "ParticleType", xAOD::EgammaParameters::unconvertedPhoton));
      ATH_CHECK(config_mva_unconverted.setProperty("OutputLevel",
                           this->msg().level()));
 
      // converted photon MVA tool
      asg::AsgToolConfig config_mva_converted(
          "egammaMVACalibTool/tool_mva_converted");
      config_mva_converted.setPropertyFromString("folder", m_MVAfolder);
      ATH_CHECK(config_mva_converted.setProperty("use_layer_corrected", true));
      ATH_CHECK(config_mva_converted.setProperty(
          "ParticleType", xAOD::EgammaParameters::convertedPhoton));
      ATH_CHECK(config_mva_converted.setProperty("OutputLevel",
                         this->msg().level()));
 
      // initialize the ServiceHandler egammaMVASvc
      // make the name unique
      std::ostringstream mva_service_name;
      mva_service_name << "egammaMVASvc/service_mva_egamma_id"
                       << (void const*)this;
      asg::AsgServiceConfig config_mva_service(mva_service_name.str());
      ATH_CHECK(config_mva_service.addPrivateTool("ElectronTool",
                                                  config_mva_electron));
      ATH_CHECK(config_mva_service.addPrivateTool("UnconvertedPhotonTool",
                                                  config_mva_unconverted));
      ATH_CHECK(config_mva_service.addPrivateTool("ConvertedPhotonTool",
                                                  config_mva_converted));
      // fwd electron MVA tool
      if (m_doFwdCalib) {
    asg::AsgToolConfig config_mva_fwdelectron(
        "egammaMVACalibTool/tool_mva_fwdelectron");
    config_mva_fwdelectron.setPropertyFromString("folder", m_MVAfolder);
    ATH_CHECK(config_mva_fwdelectron.setProperty(
        "ParticleType", xAOD::EgammaParameters::AuthorFwdElectron));
    ATH_CHECK(config_mva_fwdelectron.setProperty("ShiftType", 0));
    ATH_CHECK(config_mva_fwdelectron.setProperty("OutputLevel", this->msg().level()));
    ATH_CHECK(config_mva_service.addPrivateTool("FwdElectronTool",
                            config_mva_fwdelectron));
      }
      config_mva_service.setPropertyFromString("folder", m_MVAfolder);
      ATH_CHECK(
          config_mva_service.setProperty("OutputLevel", this->msg().level()));
      ATH_CHECK(config_mva_service.makeService(m_MVACalibSvc));
    } else {
      m_use_mva_calibration = false;
    }
  }
 
  // configure layer recalibration tool
  // For now: layer recalibration not applied to PRE release 21 (using run 1
  // based calibration applied at reco level)
  //  for following R21 recommendations, need to apply the run2/run1 layer
  //  calibration ratio
  if (m_ESModel == "es2017_R21_PRE") {
    ATH_MSG_INFO("Layer recalibration already applied at cell level");
    m_useLayerCorrection = false;
  } else if (!m_useLayerCorrection) {
    ATH_MSG_INFO("Layer corrections disabled!");
  } else {
    ATH_MSG_DEBUG("initializing layer recalibration tool (if needed)");
    if (m_layer_recalibration_tune
            .empty()) {  // automatically configure layer recalibration tool
      m_layer_recalibration_tool =
          egammaLayerRecalibToolFactory(m_TESModel, m_useSaccCorrection)
              .release();
      if (!m_layer_recalibration_tool) {
        ATH_MSG_INFO("not using layer recalibration");
      }
    } else {
      m_layer_recalibration_tool =
          new egammaLayerRecalibTool(m_layer_recalibration_tune);
    }
    if (m_layer_recalibration_tool) {
      m_layer_recalibration_tool->msg().setLevel(this->msg().level());
      m_layer_recalibration_tool->fixForMissingCells(m_fixForMissingCells);
      if (!m_usePSCorrection) {
    ATH_MSG_INFO("PS corrections disabled!");
    m_layer_recalibration_tool->disable_PSCorrections();
      }
      if (!m_useS12Correction) {
    ATH_MSG_INFO("S12 corrections disabled!");
    m_layer_recalibration_tool->disable_S12Corrections();
      }
      if (!m_useSaccCorrection) {
    ATH_MSG_INFO("Sacc corrections disabled!");
    m_layer_recalibration_tool->disable_SaccCorrections();
      }
    }
  }
 
  if (m_use_temp_correction201215 != AUTO)
    m_rootTool->use_temp_correction201215(m_use_temp_correction201215);
  if (m_use_uA2MeV_2015_first2weeks_correction != AUTO)
    m_rootTool->use_uA2MeV_2015_first2weeks_correction(
        m_use_uA2MeV_2015_first2weeks_correction);
  if (not m_use_full_statistical_error and
      m_decorrelation_model_scale == ScaleDecorrelation::FULL) {
    m_rootTool->useStatErrorScaling(true);
  }
 
  if (m_use_ep_combination) {
    ATH_MSG_ERROR("ep combination not supported yet");
    throw std::runtime_error("ep combination not supported yet");
  }
 
  if (m_useIntermoduleCorrection == AUTO) {
    m_useIntermoduleCorrection = use_intermodule_correction(m_TESModel);
  }
  if (m_usePhiUniformCorrection == AUTO) {
    m_usePhiUniformCorrection = use_phi_uniform_correction(m_TESModel);
  }
  m_use_mapping_correction = not is_after_run1(m_TESModel);
 
  if (m_useGainCorrection == AUTO) {
    if (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 ||
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 ||
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_useGainCorrection = 0;
    } 
    else {
      ATH_MSG_DEBUG("initializing gain tool");
      m_gain_tool = gainToolFactory(m_TESModel).release();
      m_useGainCorrection = bool(m_gain_tool);      
    }
  }
  else if (m_useGainCorrection == 1) {
    if (m_TESModel != egEnergyCorr::es2023_R22_Run2_v0 &&
        m_TESModel != egEnergyCorr::es2023_R22_Run2_v1 &&
        m_TESModel != egEnergyCorr::es2024_Run3_v0) {
      m_useGainCorrection = 0;
      ATH_MSG_ERROR(
          "cannot instantiate gain tool for this model (you can only disable "
          "the gain tool, but not enable it)");
    } 
    else {
      ATH_MSG_INFO(
          "initializing gain tool for run2 final precision recommendations");
      ATH_MSG_WARNING(
          "Gain corrections required but Zee scales are derived without Gain, "
          "will cause inconsistency!");
      std::string gain_tool_run_2_filename = PathResolverFindCalibFile(
          "ElectronPhotonFourMomentumCorrection/v29/"
          "gain_uncertainty_specialRun.root");
      m_gain_tool_run2 = std::make_unique<egGain::GainUncertainty>(
          gain_tool_run_2_filename, false, "GainCorrection",
          m_useGainInterpolation);
      m_gain_tool_run2->msg().setLevel(this->msg().level());
    }
  }
 
  if (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 ||
      m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 ||
      m_TESModel == egEnergyCorr::es2024_Run3_v0) {
    // ADC non linearity correction
    if (m_doADCLinearityCorrection == AUTO || m_doADCLinearityCorrection == 1) {
      m_doADCLinearityCorrection = 1;
      std::string adcLinearityCorr_filename = PathResolverFindCalibFile(
          "ElectronPhotonFourMomentumCorrection/v25/linearity_ADC.root");
      m_ADCLinearity_tool = std::make_shared<LinearityADC>(adcLinearityCorr_filename);
      m_ADCLinearity_tool->msg().setLevel(this->msg().level());
      m_rootTool->setADCTool(m_ADCLinearity_tool);
    } else {
      ATH_MSG_WARNING(
          m_ESModel + " recommendations use ADC corrections for scale "
          "derivation. Disabling the ADCLinearity flag will create "
          "inconsistency!");
    }
 
    if (m_doLeakageCorrection == AUTO || m_doLeakageCorrection == 1) {
      m_doLeakageCorrection = 1;
      m_rootTool->setApplyLeakageCorrection(true);
    }
 
    // Calo distortion phi unif correction
    if (m_useCaloDistPhiUnifCorrection == AUTO ||
        m_useCaloDistPhiUnifCorrection == 1) {
      m_useCaloDistPhiUnifCorrection = 1;
      std::string phiUnifCorrfileName = PathResolverFindCalibFile(
          "ElectronPhotonFourMomentumCorrection/v33/"
          "egammaEnergyCorrectionData.root");
      std::unique_ptr<TFile> fCorr(
          TFile::Open(phiUnifCorrfileName.c_str(), "READ"));
      m_caloDistPhiUnifCorr.reset(
          dynamic_cast<TH2*>(fCorr->Get("CaloDistortionPhiUniformityCorrection/"
                                        "es2023_R22_Run2_v0/h2DcorrPhiUnif")));
      m_caloDistPhiUnifCorr->SetDirectory(nullptr);
    } else {
      ATH_MSG_WARNING(
          m_ESModel + " recommendations use CaloDistPhiUnif for scale "
          "derivation. Disabling the CaloDistPhiUnif flag will create "
          "inconsistency!");
    }
  }
 
  // No scale correction for release 21 ==> obsolete
  /*if (m_ESModel == "es2017_R21_PRE"){
    m_doScaleCorrection = 0;
  }
  */
 
  ATH_MSG_INFO("ESModel: " << m_ESModel);
  ATH_MSG_INFO("ResolutionType: " << m_ResolutionType);
  ATH_MSG_INFO("decorrelation Model: " << m_decorrelation_model_name);
  ATH_MSG_DEBUG("layer correction = " << m_useLayerCorrection);
  ATH_MSG_DEBUG("PS correction = " << m_usePSCorrection);
  ATH_MSG_DEBUG("S12 correction = " << m_useS12Correction);
  ATH_MSG_DEBUG("Sacc correction = " << m_useSaccCorrection);
  ATH_MSG_DEBUG("intermodule correction = " << m_useIntermoduleCorrection);
  ATH_MSG_DEBUG("phi uniformity correction = " << m_usePhiUniformCorrection);
  ATH_MSG_DEBUG("distorted calo phi uniformity correction = "
               << m_useCaloDistPhiUnifCorrection);
  ATH_MSG_DEBUG("gain correction = " << m_useGainCorrection);
  ATH_MSG_DEBUG("ADC non-linearity correction = " << m_doADCLinearityCorrection);
  ATH_MSG_DEBUG("leakage correction for photons = " << m_doLeakageCorrection);
  ATH_MSG_DEBUG("smearing = " << m_doSmearing);
  ATH_MSG_DEBUG("insitu scales = " << m_doScaleCorrection);
  ATH_MSG_DEBUG("ep combination = " << m_use_ep_combination);
  ATH_MSG_DEBUG("use MVA calibration = " << m_use_mva_calibration);
  ATH_MSG_DEBUG(
      "use temperature correction 2015 = " << m_use_temp_correction201215);
  ATH_MSG_DEBUG("use uA2MeV correction 2015 1/2 week = "
               << m_use_uA2MeV_2015_first2weeks_correction);
 
  setupSystematics();
 
  applySystematicVariation(CP::SystematicSet())
      .ignore();  // this set the flags for the internal tool without
                  // systematics
  CP::SystematicRegistry& registry = CP::SystematicRegistry::getInstance();
  if (registry.registerSystematics(*this) != StatusCode::SUCCESS)
    return StatusCode::FAILURE;
 
  if (m_onlyElectrons.value() && m_onlyPhotons.value()) {
    ATH_MSG_ERROR("Cannot select both onlyElectrons and onlyPhotons");
    return StatusCode::FAILURE;
  }
  if (m_onlyElectrons.value()) {
    resetElectron (m_accessors->momAcc, *m_accessors);
    if (m_TESModel == egEnergyCorr::es2011c) {
      resetAccessor (m_accessors->electronTrackAcc, *this, "trackParticleLinks");
    }
  }
  if (m_onlyPhotons.value()) {
    resetPhoton (m_accessors->momAcc, *m_accessors);
    resetAccessor (m_accessors->photonVertexAcc, *this, "vertexLinks");
  }
  if (m_decorateEmva)
    resetAccessor (m_accessors->decEmva, *this, "E_mva_only");
 
  ANA_CHECK (initializeColumns ());
 
  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.

inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 93 of file AsgMetadataTool.cxx.

                                                                       {
 
#ifdef XAOD_STANDALONE
      return &m_inputMetaStore;
#else // XAOD_STANDALONE
      return m_inputMetaStore;
#endif // XAOD_STANDALONE
   }

intermodule_correction()

double CP::EgammaCalibrationAndSmearingTool::intermodule_correction	(	double	Ecl,
		double	phi,
		double	eta ) const

Definition at line 2192 of file EgammaCalibrationAndSmearingTool.cxx.

                                              {
 
  // Intermodule Widening Correction: E_corr = E / (a' - b' * ((1 / (1 +
  // exp((phi_mod - 2 * pi / 32) * c))) * (1 / (1 + exp((phi_mod - 2 * pi / 32)
  // * (d)))))) (phi_min, phi_max) : [a' = a / a, b' = b / a, c, d]
 
  double Ecl_corr = 0.;
  int DivInt = 0;
  double pi = M_PI;
 
  if (m_TESModel == egEnergyCorr::es2017_summer_improved ||
      m_TESModel == egEnergyCorr::es2017_summer_final ||
      m_TESModel == egEnergyCorr::es2017_R21_v0 ||
      m_TESModel == egEnergyCorr::es2017_R21_v1 ||
      m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 ||
      m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 ||
      m_TESModel == egEnergyCorr::es2018_R21_v0 ||
      m_TESModel == egEnergyCorr::es2018_R21_v1 ||
      m_TESModel == egEnergyCorr::es2022_R22_PRE ||
      m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 ||
      m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 ||
      m_TESModel == egEnergyCorr::es2024_Run3_v0) {
 
    double phi_mod = 0;
    if (phi < 0)
      phi_mod = fmod(phi, 2 * pi / 16.) + pi / 8.;
    else
      phi_mod = fmod(phi, 2 * pi / 16.);
 
    //  The correction concerns only the barrel
    if (std::abs(eta) <= 1.37) {
 
      if (phi < (-7 * pi / 8) && phi > (-1 * pi))
        Ecl_corr =
            Ecl /
            (1 - 0.1086 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 175.2759))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-189.3612))))));
      if (phi < (-6 * pi / 8) && phi > (-7 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0596 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 170.8305))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-233.3782))))));
      if (phi < (-5 * pi / 8) && phi > (-6 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0596 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 147.1451))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-139.3386))))));
      if (phi < (-4 * pi / 8) && phi > (-5 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0583 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 168.4644))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-246.2897))))));
      if (phi < (-3 * pi / 8) && phi > (-4 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0530 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 177.6703))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-198.3227))))));
      if (phi < (-2 * pi / 8) && phi > (-3 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0672 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 145.0693))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-242.1771))))));
      if (phi < (-1 * pi / 8) && phi > (-2 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0871 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 132.3303))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-166.1833))))));
      if (phi < (0 * pi / 8) && phi > (-1 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.0948 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 127.6780))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-150.0700))))));
      if (phi < (1 * pi / 8) && phi > (0 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1166 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 172.0679))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-235.3293))))));
      if (phi < (2 * pi / 8) && phi > (1 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1172 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 190.3524))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-198.9400))))));
      if (phi < (3 * pi / 8) && phi > (2 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1292 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 158.0540))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-165.3893))))));
      if (phi < (4 * pi / 8) && phi > (3 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1557 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 162.2793))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-133.5131))))));
      if (phi < (5 * pi / 8) && phi > (4 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1659 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 180.5270))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-168.5074))))));
      if (phi < (6 * pi / 8) && phi > (5 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1123 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 128.2277))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-154.4455))))));
      if (phi < (7 * pi / 8) && phi > (6 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1394 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 192.1216))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-198.0727))))));
      if (phi < (8 * pi / 8) && phi > (7 * pi / 8))
        Ecl_corr =
            Ecl /
            (1 - 0.1001 *
                     ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 199.1735))) *
                      (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-176.4056))))));
    }
 
    //  No correction for the EC
    else {
      Ecl_corr = Ecl;
    }
 
  }
 
  else {
 
    //  Definitions of module folding into four quarters (top, left, bottom and
    //  right)
 
    DivInt = (int)(phi / ((2 * pi) / 16.));
    double phi_mod = phi - DivInt * (2 * pi / 16.);
 
    //  Centring on the intermodule --> phi_mod will now be in [0,0.4]
    if (phi_mod < 0)
      phi_mod += pi / 8.;
 
    //  The correction concerns only the barrel
    if (std::abs(eta) <= 1.4) {
 
      //  Top quarter
      if (phi < (3 * pi) / 4. && phi >= pi / 4.) {
        Ecl_corr =
            Ecl / (1 - 0.131 * ((1 / (1 + exp((phi_mod - 0.2) * 199.08))) *
                                (1 / (1 + exp((phi_mod - 0.2) * (-130.36))))));
      }
 
      //  Right quarter
      if (phi < pi / 4. && phi >= -pi / 4.) {
        Ecl_corr =
            Ecl / (1 - 0.0879 * ((1 / (1 + exp((phi_mod - 0.2) * 221.01))) *
                                 (1 / (1 + exp((phi_mod - 0.2) * (-149.51))))));
      }
      //  Bottom quarter
      if (phi < -pi / 4. && phi >= (-3 * pi) / 4.) {
        Ecl_corr =
            Ecl / (1 - 0.0605 * ((1 / (1 + exp((phi_mod - 0.2) * 281.37))) *
                                 (1 / (1 + exp((phi_mod - 0.2) * (-170.29))))));
      }
      //  Left quarter
      if ((phi < (-3 * pi) / 4.) || (phi >= (3 * pi) / 4.)) {
        Ecl_corr =
            Ecl / (1 - 0.102 * ((1 / (1 + exp((phi_mod - 0.2) * 235.37))) *
                                (1 / (1 + exp((phi_mod - 0.2) * (-219.04))))));
      }
    }
 
    //  No correction for the EC
    else {
      Ecl_corr = Ecl;
    }
  }
 
  return Ecl_corr;
}

isAffectedBySystematic()

bool CP::EgammaCalibrationAndSmearingTool::isAffectedBySystematic ( const CP::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 1286 of file EgammaCalibrationAndSmearingTool.cxx.

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

metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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

oldtool_resolution_flag_this_event()

egEnergyCorr::Resolution::Variation CP::EgammaCalibrationAndSmearingTool::oldtool_resolution_flag_this_event ( columnar::EgammaId p, columnar::EventInfoId event_info ) const

inlineprivate

Definition at line 1260 of file EgammaCalibrationAndSmearingTool.cxx.

                                                            {
  const Accessors& acc = *m_accessors;
  return acc.eventTypeAcc (event_info, xAOD::EventInfo::IS_SIMULATION)
             ? m_currentResolutionVariation_MC
             : m_currentResolutionVariation_data;
}

oldtool_scale_flag_this_event()

egEnergyCorr::Scale::Variation CP::EgammaCalibrationAndSmearingTool::oldtool_scale_flag_this_event ( columnar::EgammaId p, columnar::EventInfoId event_info ) const

inlineprivate

Definition at line 1248 of file EgammaCalibrationAndSmearingTool.cxx.

                                                              {
  const Accessors& acc = *m_accessors;
  if (!acc.eventTypeAcc (event_info, xAOD::EventInfo::IS_SIMULATION))
    return m_currentScaleVariation_data;
  if (m_currentScalePredicate(*this,p))
    return m_currentScaleVariation_MC;
  else
    return egEnergyCorr::Scale::None;
}

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.

outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 102 of file AsgMetadataTool.cxx.

                                                                        {
 
#ifdef XAOD_STANDALONE
      return &m_outputMetaStore;
#else // XAOD_STANDALONE
      return m_outputMetaStore;
#endif // XAOD_STANDALONE
   }

print() [1/2]

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

print() [2/2]

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

pure virtualinherited

Print the state of the tool.

Implemented in asg::AsgTool, 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.

recommendedSystematics()

CP::SystematicSet CP::EgammaCalibrationAndSmearingTool::recommendedSystematics ( ) const

overrideprivatevirtual

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

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

resolution()

double CP::EgammaCalibrationAndSmearingTool::resolution ( double energy, double cl_eta, double cl_etaCalo, PATCore::ParticleType::Type ptype = PATCore::ParticleType::Electron, bool withCT = false ) const

overrideprivatevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 927 of file EgammaCalibrationAndSmearingTool.cxx.

                                                      {
  return m_rootTool->resolution(energy, cl_eta, cl_etaCalo, ptype, withCT,
                                false);
}

setPt()

void CP::EgammaCalibrationAndSmearingTool::setPt ( columnar::MutableEgammaId input, double energy ) const

private

Definition at line 1231 of file EgammaCalibrationAndSmearingTool.cxx.

                                                                                               {
  const double new_energy2 = energy * energy;
  const double m = m_accessors->momAcc.m (input);
  const double m2 = m * m;
  const double p2 = new_energy2 > m2 ? new_energy2 - m2 : 0.;
  m_accessors->ptOutDec (input) = sqrt(p2) / cosh(m_accessors->etaAcc (input));
  ATH_MSG_DEBUG("after setting pt, energy = " << m_accessors->momAcc.e (input));
}

setRandomSeedFunction()

virtual void CP::EgammaCalibrationAndSmearingTool::setRandomSeedFunction ( const IdFunction && function )

inlineprivatevirtual

Definition at line 238 of file EgammaCalibrationAndSmearingTool.h.

                                                                  {
    m_set_seed_function = function;
  }

setupSystematics()

void CP::EgammaCalibrationAndSmearingTool::setupSystematics ( )

private

Definition at line 1305 of file EgammaCalibrationAndSmearingTool.cxx.

                                                        {
  const EgammaPredicate always = [](const EgammaCalibrationAndSmearingTool&, columnar::EgammaId) { return true; };
 
  // Try to simplify a bit for the ones that are fully correlate in eta,
  // whatever the model and that are not included in the macros including
  // - ADC non linearity
  // - L2Gain
  // - Leakage
  // - Conversion related
  // - TopoCluster threshold
  // - AF2
  // - PS_BARREL_B12
  // - S12EXTRALASTETABINRUN2
  // - ZEESTAT
  // - Run3 pre OFC + EXTRA
  if (m_decorrelation_model_scale == ScaleDecorrelation::FULL_ETA_CORRELATED ||
      m_decorrelation_model_scale == ScaleDecorrelation::FULL) {
    // Electron leakage, ADCLin, convReco only in final run2 recommendations
    if (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 ||
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 ||
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      // systematic related to ADC non linearity correction. Before 2022, there
      // was not correction, nor related systematic
      if (m_doADCLinearityCorrection) {
        m_syst_description[CP::SystematicVariation("EG_SCALE_ADCLIN", +1)] =
            SysInfo{always, egEnergyCorr::Scale::ADCLinUp};
        m_syst_description[CP::SystematicVariation("EG_SCALE_ADCLIN", -1)] =
            SysInfo{always, egEnergyCorr::Scale::ADCLinDown};
      }
      // Gain splitted uncertainty
      m_syst_description[CP::SystematicVariation("EG_SCALE_L2MEDIUMGAIN", +1)] =
          SysInfo{always, egEnergyCorr::Scale::L2MediumGainUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_L2MEDIUMGAIN", -1)] =
          SysInfo{always, egEnergyCorr::Scale::L2MediumGainDown};
      m_syst_description[CP::SystematicVariation("EG_SCALE_L2LOWGAIN", +1)] =
          SysInfo{always, egEnergyCorr::Scale::L2LowGainUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_L2LOWGAIN", -1)] =
          SysInfo{always, egEnergyCorr::Scale::L2LowGainDown};
 
      // Electron leakage
      m_syst_description[CP::SystematicVariation("EG_SCALE_LEAKAGEELEC", +1)] =
          SysInfo{always, egEnergyCorr::Scale::LeakageElecUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_LEAKAGEELEC", -1)] =
          SysInfo{always, egEnergyCorr::Scale::LeakageElecDown};
 
      // Conversion related
      m_syst_description[CP::SystematicVariation("PH_SCALE_CONVRECO", +1)] =
          SysInfo{always, egEnergyCorr::Scale::ConvRecoUp};
      m_syst_description[CP::SystematicVariation("PH_SCALE_CONVRECO", -1)] =
          SysInfo{always, egEnergyCorr::Scale::ConvRecoDown};
    }
    // The equivalent of convReco (convefficiency and convfakerate) for other
    // models
    else {
      m_syst_description[CP::SystematicVariation("PH_SCALE_CONVEFFICIENCY",
                                                 +1)] =
          SysInfo{always, egEnergyCorr::Scale::ConvEfficiencyUp};
      m_syst_description[CP::SystematicVariation("PH_SCALE_CONVEFFICIENCY",
                                                 -1)] =
          SysInfo{always, egEnergyCorr::Scale::ConvEfficiencyDown};
      m_syst_description[CP::SystematicVariation("PH_SCALE_CONVFAKERATE", +1)] =
          SysInfo{always, egEnergyCorr::Scale::ConvFakeRateUp};
      m_syst_description[CP::SystematicVariation("PH_SCALE_CONVFAKERATE", -1)] =
          SysInfo{always, egEnergyCorr::Scale::ConvFakeRateDown};
    }
 
    // additional systematics for R22 OFC and MC21 pre and bulk
    if (m_TESModel == egEnergyCorr::es2022_R22_PRE) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_OFC", +1)] =
          SysInfo{always, egEnergyCorr::Scale::OFCUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_OFC", -1)] =
          SysInfo{always, egEnergyCorr::Scale::OFCDown};
 
      m_syst_description[CP::SystematicVariation("EG_SCALE_EXTRARUN3PRE", +1)] =
          SysInfo{always, egEnergyCorr::Scale::EXTRARUN3PREUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_EXTRARUN3PRE", -1)] =
          SysInfo{always, egEnergyCorr::Scale::EXTRARUN3PREDown};
    }
 
    if (m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
 
      // topo clustr threshold systematics aded to release 21 recommendations
      m_syst_description[CP::SystematicVariation("EG_SCALE_TOPOCLUSTER_THRES",
                                                 +1)] =
          SysInfo{always, egEnergyCorr::Scale::topoClusterThresUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_TOPOCLUSTER_THRES",
                                                 -1)] =
          SysInfo{always, egEnergyCorr::Scale::topoClusterThresDown};
 
      // AF3 for run3 models: es2022_R22_PRE and esmodel >= es2023_R22_Run2_v1
      // although we prevent AF for es2022_R22_PRE and es2024_Run3_ofc0_v0
      // AF3 are still technically added in the tool
      // but normally uncertainty will be 0
      if (m_TESModel >= egEnergyCorr::es2022_R22_PRE) {
        m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", +1)] =
            SysInfo{always, egEnergyCorr::Scale::afUp};
        m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", -1)] =
            SysInfo{always, egEnergyCorr::Scale::afDown};
      }
      else {
      // and extra AF2 systematics for release 21 recommendations - Moriond 2018
      // - pending proper AF2 to FullSim correction with release 21
      m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", +1)] =
          SysInfo{always, egEnergyCorr::Scale::afUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", -1)] =
          SysInfo{always, egEnergyCorr::Scale::afDown};
      }
    }
 
    // PS correlated barrel uncertainty
    if (m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_PS_BARREL_B12",
                                                 +1)] =
          SysInfo{always, egEnergyCorr::Scale::PSb12Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_PS_BARREL_B12",
                                                 -1)] =
          SysInfo{always, egEnergyCorr::Scale::PSb12Down};
    }
 
    // additional systematic for S12 last eta bin run2
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2015_5TeV) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_S12EXTRALASTETABINRUN2", +1)] =
          SysInfo{always, egEnergyCorr::Scale::S12ExtraLastEtaBinRun2Up};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_S12EXTRALASTETABINRUN2", -1)] =
          SysInfo{always, egEnergyCorr::Scale::S12ExtraLastEtaBinRun2Down};
    }
 
    // Zee stat, if for FULL we do not ask for m_use_full_statistical_error
    if (m_decorrelation_model_scale ==
            ScaleDecorrelation::FULL_ETA_CORRELATED or
        !m_use_full_statistical_error) {
      // return 1 variation only, fully correlated in eta, equal to the correct
      // value but scaled by sqrt(number of bins) the scaling is done by the old
      // tool
      m_syst_description[CP::SystematicVariation("EG_SCALE_ZEESTAT", +1)] =
          SysInfo{always, egEnergyCorr::Scale::ZeeStatUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_ZEESTAT", -1)] =
          SysInfo{always, egEnergyCorr::Scale::ZeeStatDown};
    }
  }
  if (m_decorrelation_model_scale == ScaleDecorrelation::ONENP) {
    // TODO: independet implementation of ALL UP looping on all the variations
    m_syst_description[CP::SystematicVariation("EG_SCALE_ALL", +1)] =
        SysInfo{always, egEnergyCorr::Scale::AllUp};
    m_syst_description[CP::SystematicVariation("EG_SCALE_ALL", -1)] =
        SysInfo{always, egEnergyCorr::Scale::AllDown};
 
    // to be consistent with other schemes, we add
    // extra AF systematics in addition to the 1NP
    if (m_TESModel == egEnergyCorr::es2017_R21_v0 ||
        m_TESModel == egEnergyCorr::es2017_R21_v1 ||
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 ||
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 || 
        m_TESModel == egEnergyCorr::es2018_R21_v0 ||
        m_TESModel == egEnergyCorr::es2018_R21_v1) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", +1)] =
          SysInfo{always, egEnergyCorr::Scale::afUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", -1)] =
          SysInfo{always, egEnergyCorr::Scale::afDown};
    }
    else if (m_TESModel >= egEnergyCorr::es2022_R22_PRE) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", +1)] =
          SysInfo{always, egEnergyCorr::Scale::afUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", -1)] =
          SysInfo{always, egEnergyCorr::Scale::afDown};
    }
  } 
  else if (m_decorrelation_model_scale ==
             ScaleDecorrelation::FULL_ETA_CORRELATED) {
// all the physical effects separately, considered as fully correlated in eta
  if (m_TESModel == egEnergyCorr::es2024_Run3_v0) {
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
  m_syst_description[CP::SystematicVariation(#name, +1)] =              \
      SysInfo{always, flagup};                                          \
  m_syst_description[CP::SystematicVariation(#name, -1)] =              \
      SysInfo{always, flagdown};
#include "ElectronPhotonFourMomentumCorrection/systematics_es2024_Run3_v0.def"
#undef SYSMACRO
  }
  else {
// common systematics for all the esmodels
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
  m_syst_description[CP::SystematicVariation(#name, +1)] =              \
      SysInfo{always, flagup};                                          \
  m_syst_description[CP::SystematicVariation(#name, -1)] =              \
      SysInfo{always, flagdown};
#include "ElectronPhotonFourMomentumCorrection/systematics_S12_2022.def"
#undef SYSMACRO
  }
 
    if (m_TESModel != egEnergyCorr::es2023_R22_Run2_v0 &&
        m_TESModel != egEnergyCorr::es2023_R22_Run2_v1 &&
        m_TESModel != egEnergyCorr::es2024_Run3_v0) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_LARCALIB", +1)] =
          SysInfo{always, egEnergyCorr::Scale::LArCalibUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_LARCALIB", -1)] =
          SysInfo{always, egEnergyCorr::Scale::LArCalibDown};
      m_syst_description[CP::SystematicVariation("EG_SCALE_L2GAIN", +1)] =
          SysInfo{always, egEnergyCorr::Scale::L2GainUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_L2GAIN", -1)] =
          SysInfo{always, egEnergyCorr::Scale::L2GainDown};
    }
 
    // additional systematics for S12 run2
    if (m_TESModel == egEnergyCorr::es2015PRE_res_improved or
        m_TESModel == egEnergyCorr::es2015PRE or
        m_TESModel == egEnergyCorr::es2015cPRE or
        m_TESModel == egEnergyCorr::es2015c_summer or
        m_TESModel == egEnergyCorr::es2016PRE or
        m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2015_5TeV) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE", +1)] =
          SysInfo{always, egEnergyCorr::Scale::LArCalibExtra2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE", -1)] =
          SysInfo{always, egEnergyCorr::Scale::LArCalibExtra2015PreDown};
    }
 
    // additional systematics for temperature run1->run2
    if (m_TESModel == egEnergyCorr::es2015PRE_res_improved or
        m_TESModel == egEnergyCorr::es2015PRE or
        m_TESModel == egEnergyCorr::es2015cPRE or
        m_TESModel == egEnergyCorr::es2015c_summer or
        m_TESModel == egEnergyCorr::es2016PRE) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE", +1)] =
          SysInfo{always, egEnergyCorr::Scale::LArTemperature2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE", -1)] =
          SysInfo{always, egEnergyCorr::Scale::LArTemperature2015PreDown};
    }
 
    // additional systematic for temperature 2015->2016
    if (m_TESModel == egEnergyCorr::es2016PRE) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE", +1)] =
          SysInfo{always, egEnergyCorr::Scale::LArTemperature2016PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE", -1)] =
          SysInfo{always, egEnergyCorr::Scale::LArTemperature2016PreDown};
    }
 
    // additional systematic for PP0 region
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0", +1)] =
          SysInfo{always, egEnergyCorr::Scale::MatPP0Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0", -1)] =
          SysInfo{always, egEnergyCorr::Scale::MatPP0Down};
    }
 
    // systematic related to wtots1
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", +1)] =
          SysInfo{always, egEnergyCorr::Scale::Wtots1Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", -1)] =
          SysInfo{always, egEnergyCorr::Scale::Wtots1Down};
    }
 
    // systematic for the scintillators
    if (m_TESModel == egEnergyCorr::es2015cPRE or
        m_TESModel == egEnergyCorr::es2015c_summer or
        m_TESModel == egEnergyCorr::es2016PRE or
        m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      // scintillator systematics
      m_syst_description[CP::SystematicVariation("EG_SCALE_E4SCINTILLATOR",
                                                 +1)] =
          SysInfo{always, egEnergyCorr::Scale::E4ScintillatorUp};
      m_syst_description[CP::SystematicVariation("EG_SCALE_E4SCINTILLATOR",
                                                 -1)] =
          SysInfo{always, egEnergyCorr::Scale::E4ScintillatorDown};
    }
 
  } else if (m_decorrelation_model_scale ==
             ScaleDecorrelation::ONENP_PLUS_UNCONR) {
// qsum of all variations correlated 8/13 TeV + uncorrelated (additional
// systematics for 2015PRE or 2016) all the physical effects separately,
// considered as fully correlated in eta
// TODO: fix for es2017
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
  m_syst_description[CP::SystematicVariation(#name, +1)] =              \
      SysInfo{always, flagup};                                          \
  m_syst_description[CP::SystematicVariation(#name, -1)] =              \
      SysInfo{always, flagdown};
#include "ElectronPhotonFourMomentumCorrection/systematics_1NPCOR_PLUS_UNCOR.def"
#undef SYSMACRO
 
    // additional systematic for S12 last eta bin run2 - not needed anymore for
    // last 20.7 model since it is part of bin per bin E1/E2 uncertainty in root
    // file
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_S12EXTRALASTETABINRUN2", +1)] =
          SysInfo{always, egEnergyCorr::Scale::S12ExtraLastEtaBinRun2Up};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_S12EXTRALASTETABINRUN2", -1)] =
          SysInfo{always, egEnergyCorr::Scale::S12ExtraLastEtaBinRun2Down};
    }
 
  } else if (m_decorrelation_model_scale == ScaleDecorrelation::FULL) {
    using pairvector = std::vector<std::pair<double, double>>;
    const pairvector decorrelation_bins_BE = {{0., 1.45}, {1.52, 2.5}};
    const std::vector<double> decorrelation_edges_TWELVE = {
        0., 0.2, 0.4, 0.6, 0.8, 1.0, 1.2, 1.4, 1.6, 1.8, 2.0, 2.2, 2.4};
    std::vector<double> decorrelation_edges_MODULE = {
        0., 0.2, 0.4, 0.6, 0.8, 1.0, 1.2, 1.37, 1.52, 1.8};
    const std::vector<double> decorrelation_edges_MATERIAL = {0.0, 1.1, 1.5,
                                                              2.1, 2.5};
    std::vector<double> decorrelation_edges_S12_EXTRARUN3 = {
        0., 0.8, 1.5, 2.5};
 
    std::vector<double> decorrelation_edges_S12;
    // for es2018_R21_v1 : 4 eta bins for muon E1/E2 uncertainty correlation
    if (m_TESModel == egEnergyCorr::es2018_R21_v1) {
      decorrelation_edges_S12.resize(5);
      decorrelation_edges_S12 = {0., 1.35, 1.5, 2.4, 2.5};
    } else if (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
               m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
               m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      decorrelation_edges_S12.resize(8);
      decorrelation_edges_S12 = {0., 0.6, 1.0, 1.35, 1.5, 1.8, 2.4, 2.5};
      //
      // PS scale from muons, so "crack" is a bit different
      decorrelation_edges_MODULE[7] = 1.4;
      decorrelation_edges_MODULE[8] = 1.5;
    }
    // for previous run 2 muon calibration with 20.7, 5 eta bins for E1/E2
    // uncertainty correlation
    else {
      decorrelation_edges_S12.resize(6);
      decorrelation_edges_S12 = {0., 0.6, 1.4, 1.5, 2.4, 2.5};
    }
 
    if (m_TESModel != egEnergyCorr::es2017_summer_final and
        m_TESModel != egEnergyCorr::es2017_R21_v0 and
        m_TESModel != egEnergyCorr::es2017_R21_v1 and
        m_TESModel != egEnergyCorr::es2017_R21_ofc0_v1 and
        m_TESModel != egEnergyCorr::es2024_Run3_ofc0_v0 and 
        m_TESModel != egEnergyCorr::es2018_R21_v0 and
        m_TESModel != egEnergyCorr::es2018_R21_v1 and
        m_TESModel != egEnergyCorr::es2022_R22_PRE and
        m_TESModel != egEnergyCorr::es2023_R22_Run2_v0 and
        m_TESModel != egEnergyCorr::es2023_R22_Run2_v1 and
        m_TESModel != egEnergyCorr::es2024_Run3_v0) {
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown)      \
  if (bool(fullcorrelated)) {                                                \
    m_syst_description[CP::SystematicVariation(#name, +1)] =                 \
        SysInfo{always, flagup};                                             \
    m_syst_description[CP::SystematicVariation(#name, -1)] =                 \
        SysInfo{always, flagdown};                                           \
  } else {                                                                   \
    int i = 0;                                                               \
    for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) {       \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup};   \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
      i += 1;                                                                \
    }                                                                        \
  }
#include "ElectronPhotonFourMomentumCorrection/systematics.def"
#undef SYSMACRO
    } else if (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
               m_TESModel == egEnergyCorr::es2023_R22_Run2_v1) {
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown)      \
  if (bool(fullcorrelated)) {                                                \
    m_syst_description[CP::SystematicVariation(#name, +1)] =                 \
        SysInfo{always, flagup};                                             \
    m_syst_description[CP::SystematicVariation(#name, -1)] =                 \
        SysInfo{always, flagdown};                                           \
  } else {                                                                   \
    int i = 0;                                                               \
    for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) {       \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup};   \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
      i += 1;                                                                \
    }                                                                        \
  }
#include "ElectronPhotonFourMomentumCorrection/systematics_S12_2022.def"
#undef SYSMACRO
    } else if (m_TESModel == egEnergyCorr::es2024_Run3_v0) {
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown)      \
  if (bool(fullcorrelated)) {                                                \
    m_syst_description[CP::SystematicVariation(#name, +1)] =                 \
        SysInfo{always, flagup};                                             \
    m_syst_description[CP::SystematicVariation(#name, -1)] =                 \
        SysInfo{always, flagdown};                                           \
  } else {                                                                   \
    int i = 0;                                                               \
    for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) {       \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup};   \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
      i += 1;                                                                \
    }                                                                        \
  }
#include "ElectronPhotonFourMomentumCorrection/systematics_es2024_Run3_v0.def"
#undef SYSMACRO
    } else {
#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown)      \
  if (bool(fullcorrelated)) {                                                \
    m_syst_description[CP::SystematicVariation(#name, +1)] =                 \
        SysInfo{always, flagup};                                             \
    m_syst_description[CP::SystematicVariation(#name, -1)] =                 \
        SysInfo{always, flagdown};                                           \
  } else {                                                                   \
    int i = 0;                                                               \
    for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) {       \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup};   \
      m_syst_description[CP::SystematicVariation(                            \
          #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
      i += 1;                                                                \
    }                                                                        \
  }
#include "ElectronPhotonFourMomentumCorrection/systematics_S12.def"
#undef SYSMACRO
    }  // else
 
    if (m_use_full_statistical_error) {
      // statistical error, decorrelate in *all* the bins
      int i = 0;
      const TAxis& axis_statistical_error(m_rootTool->get_ZeeStat_eta_axis());
      for (int ibin = 1; ibin <= axis_statistical_error.GetNbins(); ++ibin) {
        auto p = EtaCaloPredicateFactory(
            axis_statistical_error.GetBinLowEdge(ibin),
            axis_statistical_error.GetBinLowEdge(ibin + 1));
        m_syst_description[CP::SystematicVariation(
            "EG_SCALE_ZEESTAT__ETABIN" + std::to_string(i), +1)] =
            SysInfo{p, egEnergyCorr::Scale::ZeeStatUp};
        m_syst_description[CP::SystematicVariation(
            "EG_SCALE_ZEESTAT__ETABIN" + std::to_string(i), -1)] =
            SysInfo{p, egEnergyCorr::Scale::ZeeStatDown};
        ++i;
      }
    }
 
    // additional systematics for S12 run2
    if (m_TESModel == egEnergyCorr::es2015PRE_res_improved or
        m_TESModel == egEnergyCorr::es2015PRE or
        m_TESModel == egEnergyCorr::es2015cPRE or
        m_TESModel == egEnergyCorr::es2015c_summer or
        m_TESModel == egEnergyCorr::es2016PRE or
        m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2015_5TeV) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN0", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory({0, 1.45}),
                  egEnergyCorr::Scale::LArCalibExtra2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN0", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory({0, 1.45}),
                  egEnergyCorr::Scale::LArCalibExtra2015PreDown};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN1", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory({1.45, 2.47}),
                  egEnergyCorr::Scale::LArCalibExtra2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN1", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory({1.45, 2.47}),
                  egEnergyCorr::Scale::LArCalibExtra2015PreDown};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN2", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory({2.47, 3.2}),
                  egEnergyCorr::Scale::LArCalibExtra2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN2", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory({2.47, 3.2}),
                  egEnergyCorr::Scale::LArCalibExtra2015PreDown};
    }
 
    // additional systematics for temperature run1->run2
    if (m_TESModel == egEnergyCorr::es2015PRE_res_improved or
        m_TESModel == egEnergyCorr::es2015PRE or
        m_TESModel == egEnergyCorr::es2015cPRE or
        m_TESModel == egEnergyCorr::es2015c_summer or
        m_TESModel == egEnergyCorr::es2016PRE) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN0", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
                  egEnergyCorr::Scale::LArTemperature2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN0", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
                  egEnergyCorr::Scale::LArTemperature2015PreDown};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN1", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
                  egEnergyCorr::Scale::LArTemperature2015PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN1", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
                  egEnergyCorr::Scale::LArTemperature2015PreDown};
    }
 
    // additional systematic for temperature 2015->2016
    if (m_TESModel == egEnergyCorr::es2016PRE) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN0", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
                  egEnergyCorr::Scale::LArTemperature2016PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN1", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
                  egEnergyCorr::Scale::LArTemperature2016PreUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN0", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
                  egEnergyCorr::Scale::LArTemperature2016PreDown};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN1", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
                  egEnergyCorr::Scale::LArTemperature2016PreDown};
    }
 
    // additional systematic for PP0 region
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN0",
                                                 +1)] = SysInfo{
          AbsEtaCaloPredicateFactory(0, 1.5), egEnergyCorr::Scale::MatPP0Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN1",
                                                 +1)] = SysInfo{
          AbsEtaCaloPredicateFactory(1.5, 2.5), egEnergyCorr::Scale::MatPP0Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN0",
                                                 -1)] = SysInfo{
          AbsEtaCaloPredicateFactory(0, 1.5), egEnergyCorr::Scale::MatPP0Down};
      m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN1",
                                                 -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.5, 2.5),
                  egEnergyCorr::Scale::MatPP0Down};
    }
 
    // systematic related to wtots1
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", +1)] =
          SysInfo{always, egEnergyCorr::Scale::Wtots1Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", -1)] =
          SysInfo{always, egEnergyCorr::Scale::Wtots1Down};
    }
 
    // systematic related to wtots1, decorrelate eta bin [1.52,1.82] from rest
    if (m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN0",
                                                 +1)] =
          SysInfo{DoubleOrAbsEtaCaloPredicate(0, 1.52, 1.82, 2.47),
                  egEnergyCorr::Scale::Wtots1Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN0",
                                                 -1)] =
          SysInfo{DoubleOrAbsEtaCaloPredicate(0, 1.52, 1.82, 2.47),
                  egEnergyCorr::Scale::Wtots1Down};
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN1",
                                                 +1)] =
          SysInfo{AbsEtaCaloPredicateFactory({1.52, 1.82}),
                  egEnergyCorr::Scale::Wtots1Up};
      m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN1",
                                                 -1)] =
          SysInfo{AbsEtaCaloPredicateFactory({1.52, 1.82}),
                  egEnergyCorr::Scale::Wtots1Down};
    }
 
    // systematic for the scintillators
    if (m_TESModel == egEnergyCorr::es2015cPRE or
        m_TESModel == egEnergyCorr::es2015c_summer or
        m_TESModel == egEnergyCorr::es2016PRE or
        m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN0", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.4, 1.46),
                  egEnergyCorr::Scale::E4ScintillatorUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN1", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.46, 1.52),
                  egEnergyCorr::Scale::E4ScintillatorUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN2", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.52, 1.6),
                  egEnergyCorr::Scale::E4ScintillatorUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN0", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.4, 1.46),
                  egEnergyCorr::Scale::E4ScintillatorDown};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN1", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.46, 1.52),
                  egEnergyCorr::Scale::E4ScintillatorDown};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN2", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.52, 1.6),
                  egEnergyCorr::Scale::E4ScintillatorDown};
      if (m_TESModel == egEnergyCorr::es2024_Run3_v0) { // extended E4 in Run 3
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN3", +1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.6, 1.72),
                  egEnergyCorr::Scale::E4ScintillatorUp};
      m_syst_description[CP::SystematicVariation(
          "EG_SCALE_E4SCINTILLATOR__ETABIN3", -1)] =
          SysInfo{AbsEtaCaloPredicateFactory(1.6, 1.72),
                  egEnergyCorr::Scale::E4ScintillatorDown};
      }
    }
  } else {
    ATH_MSG_FATAL("scale decorrelation model invalid");
  }
 
  // resolution systematics
  if (m_decorrelation_model_resolution == ResolutionDecorrelation::ONENP) {
    // ALL will not include AF2/AF3 systematic
    // individual AF NP is always provided
    // linghua.guo@cern.ch 2025-04-23
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_ALL", +1)] = egEnergyCorr::Resolution::AllUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_ALL", -1)] = egEnergyCorr::Resolution::AllDown;
  } else if (m_decorrelation_model_resolution ==
             ResolutionDecorrelation::FULL) {
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_ZSMEARING", +1)] = egEnergyCorr::Resolution::ZSmearingUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_ZSMEARING", -1)] =
        egEnergyCorr::Resolution::ZSmearingDown;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_SAMPLINGTERM", +1)] =
        egEnergyCorr::Resolution::SamplingTermUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_SAMPLINGTERM", -1)] =
        egEnergyCorr::Resolution::SamplingTermDown;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALID", +1)] =
        egEnergyCorr::Resolution::MaterialIDUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALID", -1)] =
        egEnergyCorr::Resolution::MaterialIDDown;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALCALO", +1)] =
        egEnergyCorr::Resolution::MaterialCaloUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALCALO", -1)] =
        egEnergyCorr::Resolution::MaterialCaloDown;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALGAP", +1)] =
        egEnergyCorr::Resolution::MaterialGapUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALGAP", -1)] =
        egEnergyCorr::Resolution::MaterialGapDown;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALCRYO", +1)] =
        egEnergyCorr::Resolution::MaterialCryoUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_MATERIALCRYO", -1)] =
        egEnergyCorr::Resolution::MaterialCryoDown;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_PILEUP", +1)] = egEnergyCorr::Resolution::PileUpUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_PILEUP", -1)] = egEnergyCorr::Resolution::PileUpDown;
    if (m_TESModel == egEnergyCorr::es2017 or
        m_TESModel == egEnergyCorr::es2017_summer or
        m_TESModel == egEnergyCorr::es2017_summer_improved or
        m_TESModel == egEnergyCorr::es2017_summer_final or
        m_TESModel == egEnergyCorr::es2015_5TeV or
        m_TESModel == egEnergyCorr::es2017_R21_v0 or
        m_TESModel == egEnergyCorr::es2017_R21_v1 or
        m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_ofc0_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v0 or
        m_TESModel == egEnergyCorr::es2018_R21_v1 or
        m_TESModel == egEnergyCorr::es2022_R22_PRE or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v0 or
        m_TESModel == egEnergyCorr::es2023_R22_Run2_v1 or
        m_TESModel == egEnergyCorr::es2024_Run3_v0) {
      m_syst_description_resolution[CP::SystematicVariation(
          "EG_RESOLUTION_MATERIALIBL", +1)] =
          egEnergyCorr::Resolution::MaterialIBLUp;
      m_syst_description_resolution[CP::SystematicVariation(
          "EG_RESOLUTION_MATERIALIBL", -1)] =
          egEnergyCorr::Resolution::MaterialIBLDown;
      m_syst_description_resolution[CP::SystematicVariation(
          "EG_RESOLUTION_MATERIALPP0", +1)] =
          egEnergyCorr::Resolution::MaterialPP0Up;
      m_syst_description_resolution[CP::SystematicVariation(
          "EG_RESOLUTION_MATERIALPP0", -1)] =
          egEnergyCorr::Resolution::MaterialPP0Down;
      
      if (m_TESModel == egEnergyCorr::es2022_R22_PRE) {  // exta sys. for Run-3
                                                         // pre-recommendations
        m_syst_description_resolution[CP::SystematicVariation(
            "EG_RESOLUTION_OFC", +1)] = egEnergyCorr::Resolution::OFCUp;
        m_syst_description_resolution[CP::SystematicVariation(
            "EG_RESOLUTION_OFC", -1)] = egEnergyCorr::Resolution::OFCDown;
      }
    }
  } else {
    ATH_MSG_FATAL("resolution decorrelation model invalid");
  }
 
  // Always use individual AF2/AF3 systematics for resolution
  if (m_TESModel == egEnergyCorr::es2017_R21_v1 ||
      m_TESModel == egEnergyCorr::es2017_R21_ofc0_v1 ||
      m_TESModel == egEnergyCorr::es2018_R21_v0 ||
      m_TESModel == egEnergyCorr::es2018_R21_v1) {
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_AF2", +1)] = egEnergyCorr::Resolution::afUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_AF2", -1)] = egEnergyCorr::Resolution::afDown;
  }
  else if (m_TESModel >= egEnergyCorr::es2022_R22_PRE){
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_AF3", +1)] = egEnergyCorr::Resolution::afUp;
    m_syst_description_resolution[CP::SystematicVariation(
        "EG_RESOLUTION_AF3", -1)] = egEnergyCorr::Resolution::afDown;        
  }
 
  // ep combination systematics
  if (m_use_ep_combination) {
    m_syst_description[CP::SystematicVariation("EL_SCALE_MOMENTUM", +1)] =
        SysInfo{always, egEnergyCorr::Scale::MomentumUp};
    m_syst_description[CP::SystematicVariation("EL_SCALE_MOMENTUM", -1)] =
        SysInfo{always, egEnergyCorr::Scale::MomentumDown};
  }
}

setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

   {
      m_useIncidents = flag;
   }

sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 115 of file AsgMetadataTool.cxx.

                                             {
 
#ifndef XAOD_STANDALONE
      if (m_useIncidents) {
         // Connect to the IncidentSvc:
         ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
         ATH_CHECK( incSvc.retrieve() );
 
         // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
         incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
      }
      // Let the base class do its thing:
      ATH_CHECK( AlgTool::sysInitialize() );
 
#endif // not XAOD_STANDALONE
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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

xAOD2ptype()

PATCore::ParticleType::Type CP::EgammaCalibrationAndSmearingTool::xAOD2ptype ( columnar::EgammaId particle ) const

private

Definition at line 876 of file EgammaCalibrationAndSmearingTool.cxx.

{
  const Accessors& acc = *m_accessors;
 
  // this is departing from the logic below, as we are now requiring the
  // user to specify at configuration time whether we run on electrons
  // or photons.  this is necessary to configure the columns we need
  // correctly.
  if (m_onlyElectrons.value())
  {
    return PATCore::ParticleType::Electron;
  }
  if (m_onlyPhotons.value())
  {
    if (acc.photonVertexAcc(particle).size() > 0)
    {
      return PATCore::ParticleType::ConvertedPhoton;
    }
    else
    {
      return PATCore::ParticleType::UnconvertedPhoton;
    }
  }
 
  // this is the old logic and should not be visited in columnar mode
  // (disabled by turning on onlyElectrons or onlyPhotons)
  auto ptype = PATCore::ParticleType::Electron;
  //no ForwardElectron ptype: consider them as Electron
  if (xAOD::EgammaHelpers::isElectron(&particle.getXAODObject()) || acc.authorAcc (particle) == xAOD::EgammaParameters::AuthorFwdElectron) { ptype = PATCore::ParticleType::Electron; }
  else if (xAOD::EgammaHelpers::isPhoton(&particle.getXAODObject())) {
    if (xAOD::EgammaHelpers::isConvertedPhoton(&particle.getXAODObject())) { ptype = PATCore::ParticleType::ConvertedPhoton; }
    else { ptype = PATCore::ParticleType::UnconvertedPhoton; }
  }
  else {
    ATH_MSG_ERROR("particle is not electron of photon");
    throw std::runtime_error("particle is not electron or photon");
  }
  return ptype;
}

Member Data Documentation

AUTO

const int CP::EgammaCalibrationAndSmearingTool::AUTO = 2

staticprivate

Definition at line 199 of file EgammaCalibrationAndSmearingTool.h.

m_accessors

std::unique_ptr<Accessors> CP::EgammaCalibrationAndSmearingTool::m_accessors

Definition at line 487 of file EgammaCalibrationAndSmearingTool.h.

m_ADCLinearity_tool

std::shared_ptr<LinearityADC> CP::EgammaCalibrationAndSmearingTool::m_ADCLinearity_tool

private

Definition at line 417 of file EgammaCalibrationAndSmearingTool.h.

m_beginInputFileCalled

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

m_caloDistPhiUnifCorr

std::unique_ptr<TH2> CP::EgammaCalibrationAndSmearingTool::m_caloDistPhiUnifCorr

private

Definition at line 291 of file EgammaCalibrationAndSmearingTool.h.

m_currentResolutionVariation_data

egEnergyCorr::Resolution::Variation CP::EgammaCalibrationAndSmearingTool::m_currentResolutionVariation_data

private

Definition at line 439 of file EgammaCalibrationAndSmearingTool.h.

m_currentResolutionVariation_MC

egEnergyCorr::Resolution::Variation CP::EgammaCalibrationAndSmearingTool::m_currentResolutionVariation_MC

private

Definition at line 438 of file EgammaCalibrationAndSmearingTool.h.

m_currentScalePredicate

EgammaPredicate CP::EgammaCalibrationAndSmearingTool::m_currentScalePredicate

private

Definition at line 441 of file EgammaCalibrationAndSmearingTool.h.

m_currentScaleVariation_data

egEnergyCorr::Scale::Variation CP::EgammaCalibrationAndSmearingTool::m_currentScaleVariation_data

private

Definition at line 437 of file EgammaCalibrationAndSmearingTool.h.

m_currentScaleVariation_MC

egEnergyCorr::Scale::Variation CP::EgammaCalibrationAndSmearingTool::m_currentScaleVariation_MC

private

Definition at line 436 of file EgammaCalibrationAndSmearingTool.h.

m_decorateEmva

bool CP::EgammaCalibrationAndSmearingTool::m_decorateEmva

private

Definition at line 287 of file EgammaCalibrationAndSmearingTool.h.

m_decorrelation_model_name

std::string CP::EgammaCalibrationAndSmearingTool::m_decorrelation_model_name

private

Definition at line 252 of file EgammaCalibrationAndSmearingTool.h.

m_decorrelation_model_resolution

ResolutionDecorrelation CP::EgammaCalibrationAndSmearingTool::m_decorrelation_model_resolution

private

Initial value:

=
      ResolutionDecorrelation::FULL

Definition at line 256 of file EgammaCalibrationAndSmearingTool.h.

m_decorrelation_model_resolution_name

std::string CP::EgammaCalibrationAndSmearingTool::m_decorrelation_model_resolution_name

private

Definition at line 254 of file EgammaCalibrationAndSmearingTool.h.

m_decorrelation_model_scale

ScaleDecorrelation CP::EgammaCalibrationAndSmearingTool::m_decorrelation_model_scale = ScaleDecorrelation::FULL

private

Definition at line 255 of file EgammaCalibrationAndSmearingTool.h.

m_decorrelation_model_scale_name

std::string CP::EgammaCalibrationAndSmearingTool::m_decorrelation_model_scale_name

private

Definition at line 253 of file EgammaCalibrationAndSmearingTool.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_doADCLinearityCorrection

int CP::EgammaCalibrationAndSmearingTool::m_doADCLinearityCorrection

private

Definition at line 273 of file EgammaCalibrationAndSmearingTool.h.

m_doFwdCalib

Gaudi::Property<bool> CP::EgammaCalibrationAndSmearingTool::m_doFwdCalib

private

Initial value:

{
    this, "DoFwdElectronCalibration", false,
      "MVA calibration of the forward electron"}

Definition at line 297 of file EgammaCalibrationAndSmearingTool.h.

                                  {
    this, "DoFwdElectronCalibration", false,
      "MVA calibration of the forward electron"};

m_doLeakageCorrection

int CP::EgammaCalibrationAndSmearingTool::m_doLeakageCorrection

private

Definition at line 274 of file EgammaCalibrationAndSmearingTool.h.

m_doScaleCorrection

int CP::EgammaCalibrationAndSmearingTool::m_doScaleCorrection

private

Definition at line 259 of file EgammaCalibrationAndSmearingTool.h.

m_doSmearing

int CP::EgammaCalibrationAndSmearingTool::m_doSmearing

private

Definition at line 260 of file EgammaCalibrationAndSmearingTool.h.

m_ESModel

std::string CP::EgammaCalibrationAndSmearingTool::m_ESModel

private

Definition at line 251 of file EgammaCalibrationAndSmearingTool.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_fixForMissingCells

Gaudi::Property<bool> CP::EgammaCalibrationAndSmearingTool::m_fixForMissingCells

private

Initial value:

{
    this, "FixForMissingCells", true,
      "AOD fix for cell recovery in core egamma cluster"}

Definition at line 293 of file EgammaCalibrationAndSmearingTool.h.

                                          {
    this, "FixForMissingCells", true,
      "AOD fix for cell recovery in core egamma cluster"};

m_gain_tool

egGain::GainTool* CP::EgammaCalibrationAndSmearingTool::m_gain_tool = nullptr

private

Definition at line 418 of file EgammaCalibrationAndSmearingTool.h.

m_gain_tool_run2

std::unique_ptr<egGain::GainUncertainty> CP::EgammaCalibrationAndSmearingTool::m_gain_tool_run2

private

Definition at line 416 of file EgammaCalibrationAndSmearingTool.h.

m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

m_layer_recalibration_tool

egammaLayerRecalibTool* CP::EgammaCalibrationAndSmearingTool::m_layer_recalibration_tool = nullptr

private

Definition at line 419 of file EgammaCalibrationAndSmearingTool.h.

m_layer_recalibration_tune

std::string CP::EgammaCalibrationAndSmearingTool::m_layer_recalibration_tune

private

Definition at line 420 of file EgammaCalibrationAndSmearingTool.h.

m_MVACalibSvc

ServiceHandle<IegammaMVASvc> CP::EgammaCalibrationAndSmearingTool::m_MVACalibSvc

private

Initial value:

{this, "MVACalibSvc", "",
                                             "calibration service"}

Definition at line 414 of file EgammaCalibrationAndSmearingTool.h.

                                            {this, "MVACalibSvc", "",
                                             "calibration service"};

m_MVAfolder

std::string CP::EgammaCalibrationAndSmearingTool::m_MVAfolder

private

Definition at line 424 of file EgammaCalibrationAndSmearingTool.h.

m_onlyElectrons

Gaudi::Property<bool> CP::EgammaCalibrationAndSmearingTool::m_onlyElectrons {this, "onlyElectrons", false, "the tool will only be applied to electrons"}

Definition at line 452 of file EgammaCalibrationAndSmearingTool.h.

{this, "onlyElectrons", false, "the tool will only be applied to electrons"};

m_onlyPhotons

Gaudi::Property<bool> CP::EgammaCalibrationAndSmearingTool::m_onlyPhotons {this, "onlyPhotons", false, "the tool will only be applied to photons"}

Definition at line 453 of file EgammaCalibrationAndSmearingTool.h.

{this, "onlyPhotons", false, "the tool will only be applied to photons"};

m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

m_pVtxKey

Gaudi::Property<std::string> CP::EgammaCalibrationAndSmearingTool::m_pVtxKey

private

Initial value:

{
    this, "PrimaryVerticesKey", "PrimaryVertices",
      "Name of the primary vertex container"}

Definition at line 301 of file EgammaCalibrationAndSmearingTool.h.

                                    {
    this, "PrimaryVerticesKey", "PrimaryVertices",
      "Name of the primary vertex container"};

m_ResolutionType

std::string CP::EgammaCalibrationAndSmearingTool::m_ResolutionType

private

Definition at line 262 of file EgammaCalibrationAndSmearingTool.h.

m_rootTool

std::unique_ptr<AtlasRoot::egammaEnergyCorrectionTool> CP::EgammaCalibrationAndSmearingTool::m_rootTool

private

Definition at line 423 of file EgammaCalibrationAndSmearingTool.h.

m_Run2Run3runNumberTransition

const unsigned int CP::EgammaCalibrationAndSmearingTool::m_Run2Run3runNumberTransition = 400000

staticprivate

Definition at line 249 of file EgammaCalibrationAndSmearingTool.h.

m_set_seed_function

IdFunction CP::EgammaCalibrationAndSmearingTool::m_set_seed_function

private

Definition at line 443 of file EgammaCalibrationAndSmearingTool.h.

m_simulation

PATCore::ParticleDataType::DataType CP::EgammaCalibrationAndSmearingTool::m_simulation

private

Initial value:

=
      PATCore::ParticleDataType::Full

Definition at line 266 of file EgammaCalibrationAndSmearingTool.h.

m_syst_description

std::map<CP::SystematicVariation, SysInfo> CP::EgammaCalibrationAndSmearingTool::m_syst_description

private

Definition at line 431 of file EgammaCalibrationAndSmearingTool.h.

m_syst_description_resolution

std::map<CP::SystematicVariation, egEnergyCorr::Resolution::Variation> CP::EgammaCalibrationAndSmearingTool::m_syst_description_resolution

private

Definition at line 433 of file EgammaCalibrationAndSmearingTool.h.

m_TESModel

egEnergyCorr::ESModel CP::EgammaCalibrationAndSmearingTool::m_TESModel

private

Definition at line 258 of file EgammaCalibrationAndSmearingTool.h.

m_TResolutionType

egEnergyCorr::Resolution::resolutionType CP::EgammaCalibrationAndSmearingTool::m_TResolutionType

private

Definition at line 263 of file EgammaCalibrationAndSmearingTool.h.

m_use_AFII

int CP::EgammaCalibrationAndSmearingTool::m_use_AFII

private

Definition at line 265 of file EgammaCalibrationAndSmearingTool.h.

m_use_ep_combination

bool CP::EgammaCalibrationAndSmearingTool::m_use_ep_combination

private

Definition at line 275 of file EgammaCalibrationAndSmearingTool.h.

m_use_full_statistical_error

bool CP::EgammaCalibrationAndSmearingTool::m_use_full_statistical_error

private

Definition at line 277 of file EgammaCalibrationAndSmearingTool.h.

m_use_mapping_correction

bool CP::EgammaCalibrationAndSmearingTool::m_use_mapping_correction

private

Definition at line 280 of file EgammaCalibrationAndSmearingTool.h.

m_use_mva_calibration

int CP::EgammaCalibrationAndSmearingTool::m_use_mva_calibration

private

Definition at line 276 of file EgammaCalibrationAndSmearingTool.h.

m_use_temp_correction201215

int CP::EgammaCalibrationAndSmearingTool::m_use_temp_correction201215

private

Definition at line 278 of file EgammaCalibrationAndSmearingTool.h.

m_use_uA2MeV_2015_first2weeks_correction

int CP::EgammaCalibrationAndSmearingTool::m_use_uA2MeV_2015_first2weeks_correction

private

Definition at line 279 of file EgammaCalibrationAndSmearingTool.h.

m_useCaloDistPhiUnifCorrection

int CP::EgammaCalibrationAndSmearingTool::m_useCaloDistPhiUnifCorrection

private

Definition at line 271 of file EgammaCalibrationAndSmearingTool.h.

m_useFastSim

int CP::EgammaCalibrationAndSmearingTool::m_useFastSim

private

Definition at line 264 of file EgammaCalibrationAndSmearingTool.h.

m_useGainCorrection

int CP::EgammaCalibrationAndSmearingTool::m_useGainCorrection

private

Definition at line 272 of file EgammaCalibrationAndSmearingTool.h.

m_useGainInterpolation

int CP::EgammaCalibrationAndSmearingTool::m_useGainInterpolation

private

Definition at line 282 of file EgammaCalibrationAndSmearingTool.h.

m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.h.

m_useIntermoduleCorrection

int CP::EgammaCalibrationAndSmearingTool::m_useIntermoduleCorrection

private

Definition at line 269 of file EgammaCalibrationAndSmearingTool.h.

m_useLayerCorrection

int CP::EgammaCalibrationAndSmearingTool::m_useLayerCorrection

private

Definition at line 283 of file EgammaCalibrationAndSmearingTool.h.

m_usePhiUniformCorrection

int CP::EgammaCalibrationAndSmearingTool::m_usePhiUniformCorrection

private

Definition at line 270 of file EgammaCalibrationAndSmearingTool.h.

m_usePSCorrection

int CP::EgammaCalibrationAndSmearingTool::m_usePSCorrection

private

Definition at line 284 of file EgammaCalibrationAndSmearingTool.h.

m_user_random_run_number

int CP::EgammaCalibrationAndSmearingTool::m_user_random_run_number

private

Definition at line 281 of file EgammaCalibrationAndSmearingTool.h.

m_useS12Correction

int CP::EgammaCalibrationAndSmearingTool::m_useS12Correction

private

Definition at line 285 of file EgammaCalibrationAndSmearingTool.h.

m_useSaccCorrection

int CP::EgammaCalibrationAndSmearingTool::m_useSaccCorrection

private

Definition at line 286 of file EgammaCalibrationAndSmearingTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_varSF

double CP::EgammaCalibrationAndSmearingTool::m_varSF

private

Definition at line 261 of file EgammaCalibrationAndSmearingTool.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:

• EgammaCalibrationAndSmearingTool.h
• EgammaCalibrationAndSmearingTool.cxx