ATLAS Offline Software
Loading...
Searching...
No Matches
CP::EgammaCalibrationAndSmearingTool Class Referenceabstract

#include <EgammaCalibrationAndSmearingTool.h>

Inheritance diagram for CP::EgammaCalibrationAndSmearingTool:

Classes

struct  EtaCaloPredicate
struct  AbsEtaCaloPredicate
struct  DoubleOrAbsEtaCaloPredicate
struct  SysInfo
struct  Accessors

Public Types

Definition of the StoreGate-like object's definition
typedef ServiceHandle< StoreGateSvcMetaStore_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< boolm_onlyElectrons {this, "onlyElectrons", false, "the tool will only be applied to electrons"}
Gaudi::Property< boolm_onlyPhotons {this, "onlyPhotons", false, "the tool will only be applied to photons"}
std::unique_ptr< Accessorsm_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< StoreGateSvcStoreGateSvc_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< EgammaPredicateAbsEtaCaloPredicatesFactory (const std::vector< std::pair< double, double > > &edges) const
const std::vector< EgammaPredicateAbsEtaCaloPredicatesFactory (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< boolm_fixForMissingCells
Gaudi::Property< boolm_doFwdCalib
Gaudi::Property< std::string > m_pVtxKey
ServiceHandle< IegammaMVASvcm_MVACalibSvc
std::unique_ptr< egGain::GainUncertaintym_gain_tool_run2
std::shared_ptr< LinearityADCm_ADCLinearity_tool
egGain::GainToolm_gain_tool = nullptr
egammaLayerRecalibToolm_layer_recalibration_tool = nullptr
std::string m_layer_recalibration_tune
std::unique_ptr< AtlasRoot::egammaEnergyCorrectionToolm_rootTool
std::string m_MVAfolder
std::map< CP::SystematicVariation, SysInfom_syst_description
std::map< CP::SystematicVariation, egEnergyCorr::Resolution::Variationm_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

◆ IdFunction

◆ MetaStore_t

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ RandomNumber

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ ResolutionDecorrelation

Enumerator
FULL 
ONENP 

Definition at line 198 of file EgammaCalibrationAndSmearingTool.h.

Constructor & Destructor Documentation

◆ EgammaCalibrationAndSmearingTool()

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

Definition at line 290 of file EgammaCalibrationAndSmearingTool.cxx.

292 : asg::AsgMetadataTool(name),
301 columnar::EgammaId egamma,
303 const Accessors& acc = *tool.m_accessors;
304 // avoid 0 as result, see
305 // https://root.cern.ch/root/html/TRandom3.html#TRandom3:SetSeed
306 auto cluster = acc.caloClusterAcc(egamma)[0].value();
307 return 1 + static_cast<RandomNumber>(
308 std::abs(acc.clusterPhiAcc(cluster)) * 1E6 +
309 std::abs(acc.clusterEtaAcc(cluster)) * 1E3 +
310 acc.eventNumberAcc(ei));
311 }),
312 m_accessors(std::make_unique<Accessors>(*this)) {
313
314 declareProperty("ESModel", m_ESModel = "");
315 declareProperty("decorrelationModel", m_decorrelation_model_name = "");
316 declareProperty("decorrelationModelScale",
318 declareProperty("decorrelationModelResolution",
320 declareProperty("ResolutionType", m_ResolutionType = "SigmaEff90");
321 declareProperty("varSF", m_varSF = 1.0);
322 declareProperty("doScaleCorrection", m_doScaleCorrection = AUTO);
323 declareProperty("doSmearing", m_doSmearing = AUTO);
324 declareProperty("useLayerCorrection", m_useLayerCorrection = AUTO);
325 declareProperty("usePSCorrection", m_usePSCorrection = AUTO);
326 declareProperty("useS12Correction", m_useS12Correction = AUTO);
327 declareProperty("useSaccCorrection", m_useSaccCorrection = AUTO);
328 declareProperty("useIntermoduleCorrection",
330 declareProperty("usePhiUniformCorrection", m_usePhiUniformCorrection = AUTO);
331 declareProperty("useCaloDistPhiUnifCorrection",
333 declareProperty("useGainCorrection", m_useGainCorrection = AUTO);
334 declareProperty("useGainInterpolation", m_useGainInterpolation = AUTO);
335 declareProperty("doADCLinearityCorrection",
337 declareProperty("doLeakageCorrection", m_doLeakageCorrection = AUTO);
338 declareProperty("MVAfolder", m_MVAfolder = "");
339 declareProperty("layerRecalibrationTune", m_layer_recalibration_tune = "");
340 declareProperty("useEPCombination", m_use_ep_combination = false);
341 declareProperty("useMVACalibration", m_use_mva_calibration = AUTO);
342 declareProperty("use_full_statistical_error",
344 declareProperty("use_temp_correction201215",
346 declareProperty("use_uA2MeV_2015_first2weeks_correction",
348 declareProperty("randomRunNumber", m_user_random_run_number = 0);
349 // this is the user input, it is never changed by the tool. The tool uses
350 // m_simulation.
351 declareProperty("useFastSim", m_useFastSim = -1,
352 "This should be explicitly set by the user depending on the "
353 "data type (int)0=full sim, (int)1=fast sim");
355 "useAFII", m_use_AFII = -1,
356 "This is now deprecated. Kept for explicit error message for now");
357 declareProperty("decorateEmva", m_decorateEmva = false, "whether to decorate the eMVA value");
358}
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
egEnergyCorr::Resolution::Variation m_currentResolutionVariation_MC
egEnergyCorr::Scale::Variation m_currentScaleVariation_data
egEnergyCorr::Scale::Variation m_currentScaleVariation_MC
egEnergyCorr::Resolution::resolutionType m_TResolutionType
egEnergyCorr::Resolution::Variation m_currentResolutionVariation_data
ObjectId< EgammaDef > EgammaId
Definition EgammaDef.h:47
ObjectId< EventInfoDef > EventInfoId
static const SG::AuxElement::Accessor< ElementLink< IParticleContainer > > acc("originalObjectLink")
Object used for setting/getting the dynamic decoration in question.

◆ ~EgammaCalibrationAndSmearingTool()

CP::EgammaCalibrationAndSmearingTool::~EgammaCalibrationAndSmearingTool ( )
private

Definition at line 360 of file EgammaCalibrationAndSmearingTool.cxx.

360 {
361 ATH_MSG_DEBUG("destructor");
363 delete m_gain_tool;
364}
#define ATH_MSG_DEBUG(x)

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.

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

◆ AbsEtaCaloPredicateFactory() [2/2]

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

Definition at line 349 of file EgammaCalibrationAndSmearingTool.h.

350 {
351 return AbsEtaCaloPredicateFactory(edges.first, edges.second);
352 }
const EgammaPredicate AbsEtaCaloPredicateFactory(double eta_min, double eta_max) const

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

365 {
366 std::vector<EgammaPredicate> result;
367 result.reserve(edges.size() - 1);
368 auto it2 = edges.begin();
369 auto it = it2++;
370 for (; it2 != edges.end(); ++it, ++it2) {
371 result.push_back(AbsEtaCaloPredicateFactory(*it, *it2));
372 }
373 return result;
374 }

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

355 {
356 std::vector<EgammaPredicate> result;
357 result.reserve(edges.size());
358 for (const auto& it : edges) {
359 result.push_back(AbsEtaCaloPredicateFactory(it.first, it.second));
360 }
361 return result;
362 }

◆ 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 1324 of file EgammaCalibrationAndSmearingTool.cxx.

1325 {
1326 CP::SystematicSet affecting_systematics;
1327 for (const auto& it : m_syst_description) {
1328 affecting_systematics.insert(it.first);
1329 }
1330 for (const auto& it : m_syst_description_resolution) {
1331 affecting_systematics.insert(it.first);
1332 }
1333
1334 return affecting_systematics;
1335}
std::map< CP::SystematicVariation, SysInfo > m_syst_description
std::map< CP::SystematicVariation, egEnergyCorr::Resolution::Variation > m_syst_description_resolution
void insert(const SystematicVariation &systematic)
description: insert a systematic into the set

◆ applyCorrection() [1/2]

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

Definition at line 1009 of file EgammaCalibrationAndSmearingTool.cxx.

1010 {
1011 const Accessors& acc = *m_accessors;
1012
1013 // only used in simulation (for the smearing)
1014 RandomNumber seed = m_set_seed_function(*this, input, event_info);
1015
1016 columnar::ClusterId inputCluster = acc.caloClusterAcc (input)[0].value();
1017
1018 if (m_layer_recalibration_tool && acc.authorAcc (input) !=
1020 ATH_MSG_DEBUG("applying energy recalibration before E0|E1|E2|E3 = "
1021 << acc.energyBEAcc (inputCluster, 0) << "|"
1022 << acc.energyBEAcc (inputCluster, 1) << "|"
1023 << acc.energyBEAcc (inputCluster, 2) << "|"
1024 << acc.energyBEAcc (inputCluster, 3));
1025 // for now just go back to the xAOD object to access the subtool
1026 const CP::CorrectionCode status_layer_recalibration = m_layer_recalibration_tool->applyCorrection(input.getXAODObject(), event_info.getXAODObject());
1027 if (status_layer_recalibration == CP::CorrectionCode::Error) { return CP::CorrectionCode::Error; }
1028 ATH_MSG_DEBUG("eta|phi = " << acc.etaAcc (input) << "|" << acc.phiAcc (input));
1029 if (status_layer_recalibration == CP::CorrectionCode::Ok) {
1030 ATH_MSG_DEBUG("decoration E0|E1|E2|E3 = "
1031 << acc.Es0Acc(inputCluster) << "|"
1032 << acc.Es1Acc(inputCluster) << "|"
1033 << acc.Es2Acc(inputCluster) << "|"
1034 << acc.Es3Acc(inputCluster) << "|");
1035 if (acc.Es2Acc(inputCluster) == 0 and acc.Es1Acc(inputCluster) == 0 and
1036 acc.Es3Acc(inputCluster) == 0 and acc.Es0Acc(inputCluster) == 0 and
1037 (std::abs(acc.etaAcc (input)) < 1.37 or (std::abs(acc.etaAcc (input)) > 1.55 and std::abs(acc.etaAcc (input)) < 2.47)))
1038 {
1039 ATH_MSG_WARNING("all layer energies are zero");
1040 }
1041 }
1042 }
1043
1044 double energy = acc.momAcc.e (input);
1045 // apply MVA calibration
1046 if (!m_MVACalibSvc.empty()) {
1047 egammaMVACalib::GlobalEventInfo gei;
1048 if (acc.authorAcc (input) ==
1050 const xAOD::VertexContainer* pVtxCont = nullptr;
1051 if (evtStore()->retrieve(pVtxCont, m_pVtxKey).isFailure()) {
1052 ATH_MSG_ERROR("No primary vertex container " << m_pVtxKey << " could be retrieved");
1054 }
1055 unsigned int npv(0);
1056 for (const auto *vtx : *pVtxCont) {
1057 if (vtx->vertexType() == xAOD::VxType::PriVtx ||
1058 vtx->vertexType() == xAOD::VxType::PileUp) { ++npv; }
1059 }
1060 gei.nPV = npv;
1061 gei.acmu = acc.actIntPerXingAcc(event_info);
1062 ATH_MSG_DEBUG("Retrieved nPV = " << gei.nPV << " and mu = " << gei.acmu);
1063 }
1064 if (acc.authorAcc (input) !=
1066 if (m_MVACalibSvc->getEnergy(inputCluster.getXAODObject(), input.getXAODObject(), energy, gei)
1067 .isFailure()) {
1068 ATH_MSG_ERROR("Failure in MVACalib service");
1070 }
1071 ATH_MSG_DEBUG("energy after MVA calibration = " << std::format("{:.2f}", energy));
1072 }
1073 }
1075 // for now assume the input has already the layer calibration applied
1076 // and just take the decorated gnn_energy
1077 if (!acc.gnn_energy_Acc.isAvailable(input)) {
1078 ATH_MSG_ERROR("GNN energy requested but decoration TransformerEnergy not found");
1080 }
1081 energy = acc.gnn_energy_Acc(input);
1082 ATH_MSG_DEBUG("energy after GNN calibration = " << std::format("{:.2f}", energy));
1083
1084 }
1085 if (m_decorateEmva)
1086 {
1087 acc.decEmva(input) = energy;
1088 }
1089
1090 // For the time being, it is just the MVA calib
1091 if (acc.authorAcc (input) ==
1093 setPt(input, energy);
1095 }
1096
1098 // Crack calibation correction for es2011c (calibration hits calibration)
1099 const auto ptype = xAOD2ptype(input);
1100 const double etaden =
1102 ? static_cast<const xAOD::Electron&>(input.getXAODObject()).trackParticle()->eta()
1103 : acc.clusterEtaAcc(inputCluster);
1104 energy *= m_rootTool->applyMCCalibration(acc.clusterEtaAcc(inputCluster),
1105 energy / cosh(etaden), ptype);
1106 ATH_MSG_DEBUG("energy after crack calibration es2011c = "
1107 << std::format("{:.2f}", energy));
1108 }
1109
1110 /*
1111 * Here we check for each event the kind of data DATA vs FullSim
1112 * The m_simulation flavour has already been configured
1113 */
1115 (acc.eventTypeAcc(event_info,xAOD::EventInfo::IS_SIMULATION))
1116 ? m_simulation
1118
1119 unsigned int runNumber_for_tool = 0;
1120
1121 // apply uniformity corrections to data
1122 if (dataType == PATCore::ParticleDataType::Data) {
1123 // Get run number
1124 runNumber_for_tool = acc.runNumberAcc(event_info);
1125 // Get etaCalo, phiCalo
1126 const auto cl_eta = acc.clusterEtaAcc(inputCluster);
1127 double etaCalo = 0, phiCalo = 0;
1129 etaCalo = acc.etaCaloAcc(inputCluster, acc.authorAcc(input), false);
1131 phiCalo =
1132 acc.phiCaloAcc(inputCluster, acc.authorAcc(input), false);
1133 }
1134 }
1135
1136 // Intermodule
1138 energy =
1139 intermodule_correction(energy, acc.clusterPhiAcc(inputCluster), cl_eta);
1140 ATH_MSG_DEBUG("energy after intermodule correction = "
1141 << std::format("{:.2f}", energy));
1142 }
1143
1144 // Calo distortion
1150 double etaC = acc.clusterEtaAcc(inputCluster);
1151 double phiC = acc.clusterPhiAcc(inputCluster);
1152 int ieta = m_caloDistPhiUnifCorr->GetXaxis()->FindBin(etaC);
1153 ieta = ieta == 0 ? 1
1154 : (ieta > m_caloDistPhiUnifCorr->GetNbinsX()
1155 ? m_caloDistPhiUnifCorr->GetNbinsX()
1156 : ieta);
1157 int iphi = m_caloDistPhiUnifCorr->GetYaxis()->FindBin(phiC);
1158 iphi = iphi == 0 ? 1
1159 : (iphi > m_caloDistPhiUnifCorr->GetNbinsY()
1160 ? m_caloDistPhiUnifCorr->GetNbinsY()
1161 : iphi);
1162 energy *= m_caloDistPhiUnifCorr->GetBinContent(ieta, iphi);
1164 "energy after phi uniformity correction (for calo distortion) = "
1165 << std::format("{:.2f}", energy));
1166 }
1167
1168 // Phi
1170 energy *= correction_phi_unif(etaCalo, phiCalo);
1171 ATH_MSG_DEBUG("energy after uniformity correction = "
1172 << std::format("{:.2f}", energy));
1173 }
1174
1175 // ADC
1176 if (m_ADCLinearity_tool) {
1177 double et = energy / std::cosh(cl_eta);
1178 double corr =
1179 m_ADCLinearity_tool->getCorr(etaCalo, et, xAOD2ptype(input));
1180 energy *= corr;
1181 ATH_MSG_DEBUG("energy after ADC linearity correction = "
1182 << std::format("{:.2f}", energy));
1183 }
1184
1185 // Gain
1186 if (m_gain_tool) {
1187 const auto es2 = acc.Es2Acc.isAvailable(inputCluster)
1188 ? acc.Es2Acc(inputCluster)
1189 : acc.energyBEAcc (inputCluster,2);
1190 if (!(std::abs(cl_eta) < 1.52 and std::abs(cl_eta) > 1.37) and
1191 std::abs(cl_eta) < 2.4)
1192 energy = m_gain_tool->CorrectionGainTool(
1193 cl_eta, energy / GeV, es2 / GeV,
1194 xAOD2ptype(input)); // cl_eta ok, TODO: check corrected E2
1195 } else if (m_gain_tool_run2) {
1196 double et = energy / std::cosh(cl_eta);
1197 double corr = m_gain_tool_run2->getUncertainty(etaCalo, et,
1198 xAOD2ptype(input), true);
1199 energy /= (1 + corr);
1200 }
1201 ATH_MSG_DEBUG("energy after gain correction = " << std::format("{:.2f}", energy));
1202 } else {
1203 if (m_user_random_run_number == 0) {
1204 if (acc.randomrunnumber_getter.isAvailable(event_info)) {
1205 runNumber_for_tool = acc.randomrunnumber_getter(event_info);
1206 } else {
1208 "Pileup tool not run before using "
1209 "ElectronPhotonFourMomentumCorrection! Assuming it is 2016. If you "
1210 "want to force a specific period set the property randomRunNumber "
1211 "of the tool, e.g. in the job option: "
1212 "tool.randomRunNumber = 123456 or "
1213 "tool.randomRunNumber = "
1214 "EgammaCalibrationAndSmearingToolRunNumbersExample.run_2016");
1216 }
1217 } else {
1218 runNumber_for_tool = m_user_random_run_number;
1219 }
1220 }
1221
1222 const double eraw = ((acc.Es0Acc.isAvailable(inputCluster)
1223 ? acc.Es0Acc(inputCluster)
1224 : acc.energyBEAcc(inputCluster,0)) +
1225 (acc.Es1Acc.isAvailable(inputCluster)
1226 ? acc.Es1Acc(inputCluster)
1227 : acc.energyBEAcc(inputCluster,1)) +
1228 (acc.Es2Acc.isAvailable(inputCluster)
1229 ? acc.Es2Acc(inputCluster)
1230 : acc.energyBEAcc(inputCluster,2)) +
1231 (acc.Es3Acc.isAvailable(inputCluster)
1232 ? acc.Es3Acc(inputCluster)
1233 : acc.energyBEAcc(inputCluster,3)));
1234
1235
1236 if (dataType == PATCore::ParticleDataType::Fast)
1237 ATH_MSG_DEBUG("is fast");
1238 else if (dataType == PATCore::ParticleDataType::Full)
1239 ATH_MSG_DEBUG("is full");
1240 else if (dataType == PATCore::ParticleDataType::Data)
1241 ATH_MSG_DEBUG("is data");
1242
1243 // apply scale factors or systematics
1244 energy = m_rootTool->getCorrectedEnergy(
1245 runNumber_for_tool, dataType, xAOD2ptype(input),
1246 inputCluster(acc.clusterEtaAcc),
1247 inputCluster(acc.clusterEtaBEAcc,2),
1248 acc.etaCaloAcc(inputCluster, acc.authorAcc (input), false), energy,
1249 acc.Es2Acc.isAvailable(inputCluster)
1250 ? acc.Es2Acc(inputCluster)
1251 : inputCluster(acc.energyBEAcc,2),
1252 eraw, seed, oldtool_scale_flag_this_event(input, event_info),
1254 m_varSF);
1255
1256 ATH_MSG_DEBUG("energy after scale/systematic correction = " << std::format("{:.2f}", energy));
1257
1258 // TODO: this check should be done before systematics variations
1259 setPt(input, energy);
1261}
#define ATH_MSG_ERROR(x)
#define ATH_MSG_WARNING(x)
ServiceHandle< StoreGateSvc > & evtStore()
@ Error
Some error happened during the object correction.
@ Ok
The correction was done successfully.
PATCore::ParticleDataType::DataType m_simulation
void setPt(columnar::MutableEgammaId input, double energy) const
double intermodule_correction(double Ecl, double phi, double eta) const
egEnergyCorr::Scale::Variation oldtool_scale_flag_this_event(columnar::EgammaId p, columnar::EventInfoId event_info) const
std::unique_ptr< egGain::GainUncertainty > m_gain_tool_run2
PATCore::ParticleType::Type xAOD2ptype(columnar::EgammaId particle) const
double correction_phi_unif(double eta, double phi) const
egEnergyCorr::Resolution::Variation oldtool_resolution_flag_this_event(columnar::EgammaId p, columnar::EventInfoId event_info) const
std::unique_ptr< AtlasRoot::egammaEnergyCorrectionTool > m_rootTool
const xAOD::TrackParticle * trackParticle(size_t index=0) const
Pointer to the xAOD::TrackParticle/s that match the electron candidate.
@ IS_SIMULATION
true: simulation, false: data
virtual double eta() const override final
The pseudorapidity ( ) of the particle.
ObjectId< ClusterDef > ClusterId
Definition ClusterDef.h:23
const uint16_t AuthorFwdElectron
Electron reconstructed by the Forward cluster-based algorithm.
Definition EgammaDefs.h:30
@ PileUp
Pile-up vertex.
@ PriVtx
Primary vertex.
VertexContainer_v1 VertexContainer
Definition of the current "Vertex container version".
Electron_v1 Electron
Definition of the current "egamma version".

◆ applyCorrection() [2/2]

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

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 954 of file EgammaCalibrationAndSmearingTool.cxx.

955 {
956 // Retrieve the event information:
957 const xAOD::EventInfo* event_info = nullptr;
958 if (evtStore()->retrieve(event_info, "EventInfo").isFailure()) {
959 ATH_MSG_ERROR("No EventInfo object could be retrieved");
961 }
962 return applyCorrection(input, *event_info);
963}
virtual CP::CorrectionCode applyCorrection(xAOD::Egamma &) const override
EventInfo_v1 EventInfo
Definition of the latest event info version.

◆ 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 2175 of file EgammaCalibrationAndSmearingTool.cxx.

2176 {
2177
2178 // set the nominal one (no systematics)
2188
2189 if (systConfig.empty())
2190 return StatusCode::SUCCESS;
2191
2192 // the following code allows only ONE systematic variation at a time (1 for
2193 // scale, 1 for resolution)
2194
2195 bool first_scale = true;
2196 bool first_resolution = true;
2197 for (const auto& it : systConfig) {
2198 const auto found_scale = m_syst_description.find(it);
2199 if (found_scale != m_syst_description.end()) {
2200 if (not first_scale) {
2201 ATH_MSG_ERROR("multiple scale variations not supported");
2202 throw std::runtime_error("multiple scale variations not supported");
2203 }
2204 first_scale = false;
2205 m_currentScaleVariation_MC = found_scale->second.effect;
2206 m_currentScalePredicate = found_scale->second.predicate;
2207 }
2208
2209 const auto found_resolution = m_syst_description_resolution.find(it);
2210 if (found_resolution != m_syst_description_resolution.end()) {
2211 if (not first_resolution) {
2212 ATH_MSG_ERROR("multiple resolution variations not supported");
2213 throw std::runtime_error(
2214 "multiple resolution variations not supported");
2215 }
2216 first_resolution = false;
2217 m_currentResolutionVariation_MC = found_resolution->second;
2218 }
2219 }
2220
2221 return StatusCode::SUCCESS;
2222}
bool empty() const
returns: whether the set is empty

◆ beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )
protectedvirtualinherited

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

185 {
186
187 // Return gracefully:
188 return StatusCode::SUCCESS;
189 }

◆ callEvents()

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

Definition at line 2588 of file EgammaCalibrationAndSmearingTool.cxx.

2590{
2591 const Accessors& acc = *m_accessors;
2592 for (auto event : events) {
2593 auto eventInfo = acc.m_eventHandle(event);
2594 callSingleEvent (acc.m_egammaHandle(event), eventInfo);
2595 }
2596}
void callSingleEvent(columnar::MutableEgammaRange egammas, columnar::EventInfoId event) const

◆ callSingleEvent()

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

Definition at line 2579 of file EgammaCalibrationAndSmearingTool.cxx.

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

◆ correctedCopy() [1/2]

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

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 965 of file EgammaCalibrationAndSmearingTool.cxx.

966 {
967 // A sanity check:
968 if (output)
970 "Non-null pointer received. "
971 "There's a possible memory leak!");
972
973 output = new xAOD::Electron();
974 output->makePrivateStore(input);
975 return applyCorrection(*output);
976}
output
Definition merge.py:16

◆ correctedCopy() [2/2]

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

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 978 of file EgammaCalibrationAndSmearingTool.cxx.

979 {
980 // A sanity check:
981 if (output)
983 "Non-null pointer received. "
984 "There's a possible memory leak!");
985
986 output = new xAOD::Photon();
987 output->makePrivateStore(input);
988 return applyCorrection(*output);
989}
Photon_v1 Photon
Definition of the current "egamma version".

◆ correction_phi_unif()

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

Definition at line 2414 of file EgammaCalibrationAndSmearingTool.cxx.

2415 {
2416 constexpr double PI = M_PI;
2417 double Fcorr = 1.0;
2418
2420 // wrong mapping HV -> sectors in run1
2421 if (eta < -0.4 && eta > -0.6) {
2422 if (phi < (14 * PI / 32.) && phi > (13 * PI / 32.)) {
2423 Fcorr += 0.035;
2424 } else if (phi < (13 * PI / 32.) && phi > (12 * PI / 32.)) {
2425 Fcorr -= 0.035;
2426 }
2427 }
2428 }
2429
2443
2444 if (eta < 0.2 && eta > 0.) {
2445 if (phi < (-7 * 2 * PI / 32.) && phi > (-8 * 2 * PI / 32.)) {
2446 Fcorr = 1.016314;
2447 }
2448 }
2449
2450 else if (eta < 0.6 && eta > 0.4) {
2451 if (phi < 0 && phi > (-2 * PI / 32.)) {
2452 Fcorr = 1.041591;
2453 } else if (phi < (-4 * 2 * PI / 32.) && phi > (-5 * 2 * PI / 32.)) {
2454 Fcorr = 1.067346;
2455 }
2456 }
2457
2458 else if (eta < 0.8 && eta > 0.6) {
2459 if (phi < (7 * 2 * PI / 32.) && phi > (6 * 2 * PI / 32.)) {
2460 Fcorr = 1.027980;
2461 }
2462 }
2463
2464 else if (eta < 1.4 && eta > 1.2) {
2465 if (phi < (-9 * 2 * PI / 32.) && phi > (-10 * 2 * PI / 32.)) {
2466 Fcorr = 1.020299;
2467 } else if (phi < (-11 * 2 * PI / 32.) && phi > (-12 * 2 * PI / 32.)) {
2468 Fcorr = 1.051426;
2469 }
2470 }
2471
2472 else if (eta < 2.3 && eta > 2.1) {
2473 if (phi < (-12 * 2 * PI / 32.) && phi > (-13 * 2 * PI / 32.)) {
2474 Fcorr = 1.071695;
2475 }
2476 }
2477
2478 else if (eta < 0. && eta > -0.2) {
2479 if (phi < (-12 * 2 * PI / 32.) && phi > (-13 * 2 * PI / 32.)) {
2480 Fcorr = 1.008227;
2481 } else if (phi < (-8 * 2 * PI / 32.) && phi > (-9 * 2 * PI / 32.)) {
2482 Fcorr = 1.013929;
2483 }
2484 }
2485
2486 else if (eta < -0.2 && eta > -0.4) {
2487 if (phi < (-9 * 2 * PI / 32.) && phi > (-10 * 2 * PI / 32.)) {
2488 Fcorr = 1.015749;
2489 }
2490 }
2491
2492 else if (eta < -1.2 && eta > -1.4) {
2493 if (phi < (-6 * 2 * PI / 32.) && phi > (-7 * 2 * PI / 32.)) {
2494 Fcorr = 1.064954;
2495 }
2496 }
2497
2498 else if (eta < -1.6 && eta > -1.8) {
2499 if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
2500 Fcorr = 1.027448;
2501 }
2502 }
2503
2504 else if (eta < -2.3 && eta > -2.5) {
2505 if (phi < (-8 * 2 * PI / 32.) && phi > (-9 * 2 * PI / 32.)) {
2506 Fcorr = 1.025882;
2507 } else if (phi < (5 * 2 * PI / 32.) && phi > (4 * 2 * PI / 32.)) {
2508 Fcorr = 1.036616;
2509 } else if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
2510 Fcorr = 1.053838;
2511 } else if (phi < (10 * 2 * PI / 32.) && phi > (9 * 2 * PI / 32.)) {
2512 Fcorr = 1.026856;
2513 } else if (phi < (11 * 2 * PI / 32.) && phi > (10 * 2 * PI / 32.)) {
2514 Fcorr = 0.994382;
2515 }
2516 }
2517
2518 } // es2017_summer_improved end
2519
2520 else {
2521 if (eta < 0.6 && eta > 0.4) {
2522 if (phi < 0 && phi > (-2 * PI / 32.)) {
2523 Fcorr = 1.028;
2524 } else if (phi < (-4 * 2 * PI / 32.) && phi > (-5 * 2 * PI / 32.)) {
2525 Fcorr = 1.044;
2526 }
2527 }
2528
2529 else if (eta < 0.8 && eta > 0.6) {
2530 if (phi < (7 * 2 * PI / 32.) && phi > (6 * 2 * PI / 32.)) {
2531 Fcorr = 1.022;
2532 }
2533 }
2534
2535 else if (eta < 1.4 && eta > 1.2) {
2536 if (phi < (-11 * 2 * PI / 32.) && phi > (-12 * 2 * PI / 32.)) {
2537 Fcorr = 1.038;
2538 }
2539 }
2540
2541 else if (eta < 2.0 && eta > 1.9) {
2542 if (phi < (10 * 2 * PI / 32.) && phi > (9 * 2 * PI / 32.)) {
2543 Fcorr = 1.029;
2544 }
2545 }
2546
2547 else if (eta < -1.2 && eta > -1.4) {
2548 if (phi < (-4 * 2 * PI / 32.) && phi > (-5 * 2 * PI / 32.)) {
2549 Fcorr = 1.048;
2550 } else if (phi < (-6 * 2 * PI / 32.) && phi > (-7 * 2 * PI / 32.)) {
2551 Fcorr = 1.048;
2552 }
2553 }
2554
2555 else if (eta < -1.6 && eta > -1.8) {
2556 if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
2557 Fcorr = 1.024;
2558 }
2559 }
2560
2561 else if (eta < -2.3 && eta > -2.5) {
2562 if (phi < (-8 * 2 * PI / 32.) && phi > (-9 * 2 * PI / 32.)) {
2563 Fcorr = 1.037;
2564 } else if (phi < (5 * 2 * PI / 32.) && phi > (4 * 2 * PI / 32.)) {
2565 Fcorr = 1.031;
2566 } else if (phi < (9 * 2 * PI / 32.) && phi > (8 * 2 * PI / 32.)) {
2567 Fcorr = 1.040;
2568 } else if (phi < (10 * 2 * PI / 32.) && phi > (9 * 2 * PI / 32.)) {
2569 Fcorr = 1.030;
2570 } else if (phi < (11 * 2 * PI / 32.) && phi > (10 * 2 * PI / 32.)) {
2571 Fcorr = 1.020;
2572 }
2573 }
2574 }
2575
2576 return Fcorr;
2577}
#define M_PI
Scalar eta() const
pseudorapidity method
const float PI

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

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }

◆ declareProperty()

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

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

◆ DoubleOrAbsEtaCaloPredicateFactory()

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

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

193 {
194
195 // Return gracefully:
196 return StatusCode::SUCCESS;
197 }

◆ EtaCaloPredicateFactory()

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

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

◆ 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 1300 of file EgammaCalibrationAndSmearingTool.cxx.

1301 {
1304 ? m_simulation
1306
1307 const xAOD::TrackParticle* eTrack = el->trackParticle();
1308
1309 // track momentum and eta
1310 const float el_tracketa = eTrack->eta();
1311 const float el_trackmomentum = eTrack->pt() * cosh(el->eta());
1312
1313 return m_rootTool->getCorrectedMomentum(
1314 dataType, PATCore::ParticleType::Electron, el_trackmomentum, el_tracketa,
1315 oldtool_scale_flag_this_event(*el, *event_info), m_varSF);
1316}
bool eventType(EventType type) const
Check for one particular bitmask value.
virtual double pt() const override final
The transverse momentum ( ) of the particle.
TrackParticle_v1 TrackParticle
Reference the current persistent version:

◆ getEnergy() [1/3]

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

Definition at line 1000 of file EgammaCalibrationAndSmearingTool.cxx.

1001 {
1002 xAOD::Electron* new_particle = nullptr;
1003 ANA_CHECK_THROW(correctedCopy(input, new_particle));
1004 const double e = new_particle->e();
1005 delete new_particle;
1006 return e;
1007}
#define ANA_CHECK_THROW(EXP)
check whether the given expression was successful, throwing an exception on failure
virtual CP::CorrectionCode correctedCopy(const xAOD::Electron &, xAOD::Electron *&) const override
virtual double e() const override
The total energy of the particle.
Definition Egamma_v1.cxx:86

◆ getEnergy() [2/3]

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

Definition at line 991 of file EgammaCalibrationAndSmearingTool.cxx.

992 {
993 xAOD::Photon* new_particle = nullptr;
994 ANA_CHECK_THROW(correctedCopy(input, new_particle));
995 const double e = new_particle->e();
996 delete new_particle;
997 return e;
998}
virtual double e() const override final
The total energy of the particle.
Definition Photon_v1.cxx:46

◆ getEnergy() [3/3]

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

Definition at line 1272 of file EgammaCalibrationAndSmearingTool.cxx.

1273 {
1274 ANA_CHECK_THROW(applyCorrection(*p, *event_info));
1275 ATH_MSG_DEBUG("returning " << p->e());
1276 return p->e();
1277}

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

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

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

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

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

241{ 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 936 of file EgammaCalibrationAndSmearingTool.cxx.

937 {
938 const auto ptype = xAOD2ptype(particle);
939 const auto cl_etaCalo =
940 xAOD::get_eta_calo(*particle.caloCluster(), particle.author());
941
942 return m_rootTool->resolution(particle.e(), particle.caloCluster()->eta(),
943 cl_etaCalo, ptype, withCT,
944 false); // TODO: always for full simulation
945}
constexpr ParticleHypothesis particle[PARTICLEHYPOTHESES]
the array of masses
float get_eta_calo(const xAOD::CaloCluster &cluster, int author, bool do_throw=false)

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

135 {
136
137 // Tell the user what's happening:
138 ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
139
140 // Call the appropriate member function:
141 if( inc.type() == IncidentType::BeginInputFile ) {
143 if( beginInputFile().isFailure() ) {
144 ATH_MSG_FATAL( "Failed to call beginInputFile()" );
145 throw std::runtime_error( "Couldn't call beginInputFile()" );
146 }
147 } else if( inc.type() == IncidentType::EndInputFile ) {
148 if( endInputFile().isFailure() ) {
149 ATH_MSG_FATAL( "Failed to call endInputFile()" );
150 throw std::runtime_error( "Couldn't call endInputFile()" );
151 }
152 } else if( inc.type() == IncidentType::BeginEvent ) {
153 // If the tool didn't catch the begin input file incident for the
154 // first input file of the job, then call the appropriate function
155 // now.
156 if( ! m_beginInputFileCalled ) {
158 if( beginInputFile().isFailure() ) {
159 ATH_MSG_FATAL( "Failed to call beginInputFile()" );
160 throw std::runtime_error( "Couldn't call beginInputFile()" );
161 }
162 }
163 if( beginEvent().isFailure() ) {
164 ATH_MSG_FATAL( "Failed to call beginEvent()" );
165 throw std::runtime_error( "Couldn't call beginEvent()" );
166 }
167
168 #ifdef XAOD_STANDALONE
169 } else if( inc.type() == IncidentType::MetaDataStop ) {
170 if( metaDataStop().isFailure() ) {
171 ATH_MSG_FATAL( "Failed to call metaDataStop()" );
172 throw std::runtime_error( "Couldn't call metaDataStop()" );
173 }
174
175 #endif // XAOD_STANDALONE
176 } else {
177 ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
178 }
179
180 return;
181 }
#define ATH_MSG_FATAL(x)
#define ATH_MSG_VERBOSE(x)
virtual StatusCode beginInputFile()
Function called when a new input file is opened.
virtual StatusCode beginEvent()
Function called when a new events is loaded.
bool m_beginInputFileCalled
Flag helping to discover when the tool misses the opening of the first input file.
virtual StatusCode endInputFile()
Function called when the currently open input file got completely processed.
virtual StatusCode metaDataStop()
Function called when the tool should write out its metadata.

◆ initialize()

StatusCode CP::EgammaCalibrationAndSmearingTool::initialize ( void )
overrideprivatevirtual

Implements CP::IEgammaCalibrationAndSmearingTool.

Definition at line 366 of file EgammaCalibrationAndSmearingTool.cxx.

366 {
367 ATH_MSG_INFO("Initialization");
368
369 if (m_ESModel == "es2015XX") {
370 ATH_MSG_ERROR("es2015XX is deprecated. Use es2015PRE");
371 }
372
373 if (m_ESModel == "es2010") {
375 } // legacy
376 else if (m_ESModel == "es2011c") {
378 } // mc11c : faulty G4; old geometry
379 else if (m_ESModel == "es2011d") {
381 } // mc11d : corrected G4; new geometry == final Run1 scheme
382 else if (m_ESModel == "es2012a") {
384 } // mc12a : "crude" G4 fix; old geometry
385 else if (m_ESModel == "es2012c") {
387 } // mc12c : corrected G4; new geometry == final Run1 scheme
388 else if (m_ESModel == "es2012XX") {
390 } else if (m_ESModel == "es2015PRE") {
392 } else if (m_ESModel == "es2015PRE_res_improved") {
394 } else if (m_ESModel == "es2015cPRE") {
396 } else if (m_ESModel == "es2015cPRE_res_improved") {
398 } else if (m_ESModel == "es2015c_summer") {
400 } else if (m_ESModel == "es2016PRE") {
402 } else if (m_ESModel == "es2016data_mc15c") {
404 } else if (m_ESModel == "es2016data_mc15c_summer") {
406 } else if (m_ESModel == "es2016data_mc15c_summer_improved") {
408 } else if (m_ESModel == "es2016data_mc15c_final") {
410 } else if (m_ESModel == "es2015_5TeV") {
412 } else if (m_ESModel == "es2017_R21_PRE") {
414 } else if (m_ESModel == "es2017_R21_v0") {
416 } else if (m_ESModel == "es2017_R21_v1") {
418 } else if (m_ESModel == "es2017_R21_ofc0_v1") {
420 } else if (m_ESModel == "es2018_R21_v0") {
422 } else if (m_ESModel == "es2018_R21_v1") {
424 } else if (m_ESModel == "es2022_R22_PRE") {
426 } else if (m_ESModel == "es2023_R22_Run2_v0") {
428 } else if (m_ESModel == "es2023_R22_Run2_v1") {
430 } else if (m_ESModel == "es2024_Run3_ofc0_v0") {
432 } else if (m_ESModel == "es2024_Run3_v0") {
434 } else if (m_ESModel == "es2025_Run3_GNN_v0") {
436 } else if (m_ESModel.empty()) {
437 ATH_MSG_ERROR("you must set ESModel property");
438 return StatusCode::FAILURE;
439 } else {
440 ATH_MSG_ERROR("Cannot understand model " << m_ESModel);
441 return StatusCode::FAILURE;
442 }
443
444 if (m_ResolutionType == "Gaussian") {
446 } else if (m_ResolutionType == "SigmaEff80") {
448 } else if (m_ResolutionType == "SigmaEff90") {
450 } else {
451 ATH_MSG_ERROR("Cannot understand resolution " << m_ResolutionType);
452 return StatusCode::FAILURE;
453 }
454
455 if (m_use_AFII != -1) {
457 "Property useAFII is deprecated. It is now replaced with useFastSim, "
458 "which should be explicitly configured");
459 return StatusCode::FAILURE;
460 }
461
462 if (m_useFastSim == 1) {
464 } else if (m_useFastSim == 0) {
466 } else {
467 ATH_MSG_ERROR("Property useFastSim should be explicitly configured");
468 return StatusCode::FAILURE;
469 }
470
474 "Sample is FastSim but no AF3 calibration is supported with "
475 "MC23 pre-recommendations (es2022_R22_PRE and es2024_Run3_ofc0_v0). "
476 "Please swtich to Run3 consolidated recommendations (es2024_Run3_v0), "
477 "or get in touch with the EGamma CP group in case you are using this");
478 return StatusCode::FAILURE;
479 }
480
481 // configure decorrelation model, translate string property to internal class
482 // enum
483 /* S R SR
484 0. 0 0 0 WARNING Full, Full (this is the default without configuration)
485 1. 0 0 1 SR
486 2. 0 1 0 FATAL
487 3. 0 1 1 WARNING SR then R
488 4. 1 0 0 FATAL
489 5. 1 0 1 WARNING SR then S
490 6. 1 1 0 S, R
491 7. 1 1 1 FATAL
492 */
493 if (m_decorrelation_model_name.empty() and
496 // case 0
497 ATH_MSG_WARNING("no decorrelation model specified, assuming full model");
498 m_decorrelation_model_scale = ScaleDecorrelation::FULL;
500 m_decorrelation_model_name = "FULL_v1";
501 } else if (not m_decorrelation_model_name.empty() and
504 // case 7
505 ATH_MSG_FATAL("too many flags for the decorrelation model");
506 return StatusCode::FAILURE;
507 } else {
508 // set scale decorrelation model
509 if (not m_decorrelation_model_scale_name.empty()) { // case 4, 5, 6, (7)
510 if (not m_decorrelation_model_name.empty()) {
512 "flag decorrelation model ignored for scale decorrelation model");
513 } // case 5
514 if (m_decorrelation_model_scale_name == "1NP_v1")
515 m_decorrelation_model_scale = ScaleDecorrelation::ONENP;
516 else if (m_decorrelation_model_scale_name == "FULL_ETACORRELATED_v1")
517 m_decorrelation_model_scale = ScaleDecorrelation::FULL_ETA_CORRELATED;
518 else if (m_decorrelation_model_scale_name == "1NPCOR_PLUS_UNCOR")
519 m_decorrelation_model_scale = ScaleDecorrelation::ONENP_PLUS_UNCONR;
520 else if (m_decorrelation_model_scale_name == "FULL_v1")
521 m_decorrelation_model_scale = ScaleDecorrelation::FULL;
522 else {
523 ATH_MSG_FATAL("cannot understand the scale decorrelation model '"
524 << m_decorrelation_model_scale_name << "'(typo?)");
525 return StatusCode::FAILURE;
526 }
527 } else if (not m_decorrelation_model_name.empty()) { // case 1, 3
528 if (m_decorrelation_model_name == "1NP_v1")
529 m_decorrelation_model_scale = ScaleDecorrelation::ONENP;
530 else if (m_decorrelation_model_name == "FULL_ETACORRELATED_v1")
531 m_decorrelation_model_scale = ScaleDecorrelation::FULL_ETA_CORRELATED;
532 else if (m_decorrelation_model_name == "1NPCOR_PLUS_UNCOR")
533 m_decorrelation_model_scale = ScaleDecorrelation::ONENP_PLUS_UNCONR;
534 else if (m_decorrelation_model_name == "FULL_v1")
535 m_decorrelation_model_scale = ScaleDecorrelation::FULL;
536 else {
537 ATH_MSG_FATAL("cannot understand the decorrelation model '"
538 << m_decorrelation_model_name << "'(typo?)");
539 return StatusCode::FAILURE;
540 }
541 } else { // case 2, (7)
543 "not information how to initialize the scale decorrelation model");
544 return StatusCode::FAILURE;
545 }
546
547 // set resolution decorralation model
549 .empty()) { // case 2, 3, 6, (7)
550 if (not m_decorrelation_model_name.empty()) {
552 "flag decorrelation model ignored for resolution decorrelation "
553 "model");
554 } // case 3
557 else if (m_decorrelation_model_resolution_name == "FULL_v1")
559 else {
560 ATH_MSG_FATAL("cannot understand the resolution decorrelation model '"
562 return StatusCode::FAILURE;
563 }
564 } else if (not m_decorrelation_model_name.empty()) { // case 1, 5
565 if (m_decorrelation_model_name == "1NP_v1")
567 else if (m_decorrelation_model_name == "FULL_ETACORRELATED_v1")
569 else if (m_decorrelation_model_name == "1NPCOR_PLUS_UNCOR")
571 else if (m_decorrelation_model_name == "FULL_v1")
573 else {
574 ATH_MSG_FATAL("cannot understand the decorrelation model '"
575 << m_decorrelation_model_name << "'(typo?)");
576 return StatusCode::FAILURE;
577 }
578 }
579 }
580
581 // create correction tool
582 ATH_MSG_DEBUG("creating internal correction tool");
583 m_rootTool = std::make_unique<AtlasRoot::egammaEnergyCorrectionTool>();
584 if (!m_rootTool) {
585 ATH_MSG_ERROR("Cannot initialize underlying tool");
586 return StatusCode::FAILURE;
587 }
588 m_rootTool->setESModel(m_TESModel);
589
595 "Using linear interpolation in the gain tool (uncertainties only)");
597 m_rootTool->setApplyL2GainInterpolation();
598 }
599 m_rootTool->msg().setLevel(this->msg().level());
600 m_rootTool->initialize();
601
602 // configure MVA calibration
603 if (m_use_mva_calibration != 0) {
604 ATH_MSG_DEBUG("creating MVA calibration tool (if needed)");
605 if (m_MVAfolder.empty()) { // automatically configure MVA tool
607 }
608
609 if (not m_MVAfolder.empty()) {
610
611 // electron MVA tool
612 asg::AsgToolConfig config_mva_electron(
613 "egammaMVACalibTool/tool_mva_electron");
614 config_mva_electron.setPropertyFromString("folder", m_MVAfolder);
615 ATH_CHECK(config_mva_electron.setProperty("use_layer_corrected", true));
616 ATH_CHECK(config_mva_electron.setProperty(
617 "ParticleType", xAOD::EgammaParameters::electron));
618
619 // unconverted photon MVA tool
620 asg::AsgToolConfig config_mva_unconverted(
621 "egammaMVACalibTool/tool_mva_unconverted");
622 config_mva_unconverted.setPropertyFromString("folder", m_MVAfolder);
623 ATH_CHECK(
624 config_mva_unconverted.setProperty("use_layer_corrected", true));
625 ATH_CHECK(config_mva_unconverted.setProperty(
627 ATH_CHECK(config_mva_unconverted.setProperty("OutputLevel",
628 this->msg().level()));
629
630 // converted photon MVA tool
631 asg::AsgToolConfig config_mva_converted(
632 "egammaMVACalibTool/tool_mva_converted");
633 config_mva_converted.setPropertyFromString("folder", m_MVAfolder);
634 ATH_CHECK(config_mva_converted.setProperty("use_layer_corrected", true));
635 ATH_CHECK(config_mva_converted.setProperty(
637 ATH_CHECK(config_mva_converted.setProperty("OutputLevel",
638 this->msg().level()));
639
640 // initialize the ServiceHandler egammaMVASvc
641 // make the name unique
642 std::ostringstream mva_service_name;
643 mva_service_name << "egammaMVASvc/service_mva_egamma_id"
644 << (void const*)this;
645 asg::AsgServiceConfig config_mva_service(mva_service_name.str());
646 ATH_CHECK(config_mva_service.addPrivateTool("ElectronTool",
647 config_mva_electron));
648 ATH_CHECK(config_mva_service.addPrivateTool("UnconvertedPhotonTool",
649 config_mva_unconverted));
650 ATH_CHECK(config_mva_service.addPrivateTool("ConvertedPhotonTool",
651 config_mva_converted));
652 // fwd electron MVA tool
653 if (m_doFwdCalib) {
654 asg::AsgToolConfig config_mva_fwdelectron(
655 "egammaMVACalibTool/tool_mva_fwdelectron");
656 config_mva_fwdelectron.setPropertyFromString("folder", m_MVAfolder);
657 ATH_CHECK(config_mva_fwdelectron.setProperty(
659 ATH_CHECK(config_mva_fwdelectron.setProperty("ShiftType", 0));
660 ATH_CHECK(config_mva_fwdelectron.setProperty("OutputLevel", this->msg().level()));
661 ATH_CHECK(config_mva_service.addPrivateTool("FwdElectronTool",
662 config_mva_fwdelectron));
663 }
664 config_mva_service.setPropertyFromString("folder", m_MVAfolder);
665 ATH_CHECK(
666 config_mva_service.setProperty("OutputLevel", this->msg().level()));
667 ATH_CHECK(config_mva_service.makeService(m_MVACalibSvc));
670 "WIP: testing GNN based calibration for Run3,"
671 "requring decorated GNN energy (gnn_energy) from input,"
672 "which should already have the layer calibration applied");
673 } else {
674 m_use_mva_calibration = false;
675 }
676 }
677
678 // configure layer recalibration tool
679 // For now: layer recalibration not applied to PRE release 21 (using run 1
680 // based calibration applied at reco level)
681 // for following R21 recommendations, need to apply the run2/run1 layer
682 // calibration ratio
683 if (m_ESModel == "es2017_R21_PRE") {
684 ATH_MSG_INFO("Layer recalibration already applied at cell level");
685 m_useLayerCorrection = false;
686 } else if (!m_useLayerCorrection) {
687 ATH_MSG_INFO("Layer corrections disabled!");
688 } else {
689 ATH_MSG_DEBUG("initializing layer recalibration tool (if needed)");
691 .empty()) { // automatically configure layer recalibration tool
694 .release();
696 ATH_MSG_INFO("not using layer recalibration");
697 }
698 } else {
700 new egammaLayerRecalibTool(m_layer_recalibration_tune, m_useSaccCorrection);
701 }
703 m_layer_recalibration_tool->msg().setLevel(this->msg().level());
705 if (!m_usePSCorrection) {
706 ATH_MSG_INFO("PS corrections disabled!");
707 m_layer_recalibration_tool->disable_PSCorrections();
708 }
709 if (!m_useS12Correction) {
710 ATH_MSG_INFO("S12 corrections disabled!");
711 m_layer_recalibration_tool->disable_S12Corrections();
712 }
713 if (!m_useSaccCorrection) {
714 ATH_MSG_INFO("Sacc corrections disabled!");
715 m_layer_recalibration_tool->disable_SaccCorrections();
716 }
717 }
718 }
719
721 m_rootTool->use_temp_correction201215(m_use_temp_correction201215);
723 m_rootTool->use_uA2MeV_2015_first2weeks_correction(
726 m_decorrelation_model_scale == ScaleDecorrelation::FULL) {
727 m_rootTool->useStatErrorScaling(true);
728 }
729
731 ATH_MSG_ERROR("ep combination not supported yet");
732 throw std::runtime_error("ep combination not supported yet");
733 }
734
737 }
740 }
742
743 if (m_useGainCorrection == AUTO) {
748 }
749 else {
750 ATH_MSG_DEBUG("initializing gain tool");
753 }
754 }
755 else if (m_useGainCorrection == 1) {
761 "cannot instantiate gain tool for this model (you can only disable "
762 "the gain tool, but not enable it)");
763 }
764 else {
766 "initializing gain tool for run2 final precision recommendations");
768 "Gain corrections required but Zee scales are derived without Gain, "
769 "will cause inconsistency!");
770 std::string gain_tool_run_2_filename = PathResolverFindCalibFile(
771 "ElectronPhotonFourMomentumCorrection/v29/"
772 "gain_uncertainty_specialRun.root");
773 m_gain_tool_run2 = std::make_unique<egGain::GainUncertainty>(
774 gain_tool_run_2_filename, false, "GainCorrection",
776 m_gain_tool_run2->msg().setLevel(this->msg().level());
777 }
778 }
779
784 // ADC non linearity correction
787 std::string adcLinearityCorr_filename = PathResolverFindCalibFile(
788 "ElectronPhotonFourMomentumCorrection/v25/linearity_ADC.root");
789 m_ADCLinearity_tool = std::make_shared<LinearityADC>(adcLinearityCorr_filename);
790 m_ADCLinearity_tool->msg().setLevel(this->msg().level());
791 m_rootTool->setADCTool(m_ADCLinearity_tool);
792 } else {
794 m_ESModel + " recommendations use ADC corrections for scale "
795 "derivation. Disabling the ADCLinearity flag will create "
796 "inconsistency!");
797 }
798
801 m_rootTool->setApplyLeakageCorrection(true);
802 }
803
804 // Calo distortion phi unif correction
808 std::string phiUnifCorrfileName = PathResolverFindCalibFile(
809 "ElectronPhotonFourMomentumCorrection/v33/"
810 "egammaEnergyCorrectionData.root");
811 std::unique_ptr<TFile> fCorr(
812 TFile::Open(phiUnifCorrfileName.c_str(), "READ"));
814 dynamic_cast<TH2*>(fCorr->Get("CaloDistortionPhiUniformityCorrection/"
815 "es2023_R22_Run2_v0/h2DcorrPhiUnif")));
816 m_caloDistPhiUnifCorr->SetDirectory(nullptr);
817 } else {
819 m_ESModel + " recommendations use CaloDistPhiUnif for scale "
820 "derivation. Disabling the CaloDistPhiUnif flag will create "
821 "inconsistency!");
822 }
823 }
824
825 // No scale correction for release 21 ==> obsolete
826 /*if (m_ESModel == "es2017_R21_PRE"){
827 m_doScaleCorrection = 0;
828 }
829 */
830
831 ATH_MSG_INFO("ESModel: " << m_ESModel);
832 ATH_MSG_INFO("ResolutionType: " << m_ResolutionType);
833 ATH_MSG_INFO("decorrelation Model: " << m_decorrelation_model_name);
834 ATH_MSG_DEBUG("layer correction = " << m_useLayerCorrection);
835 ATH_MSG_DEBUG("PS correction = " << m_usePSCorrection);
836 ATH_MSG_DEBUG("S12 correction = " << m_useS12Correction);
837 ATH_MSG_DEBUG("Sacc correction = " << m_useSaccCorrection);
838 ATH_MSG_DEBUG("intermodule correction = " << m_useIntermoduleCorrection);
839 ATH_MSG_DEBUG("phi uniformity correction = " << m_usePhiUniformCorrection);
840 ATH_MSG_DEBUG("distorted calo phi uniformity correction = "
842 ATH_MSG_DEBUG("gain correction = " << m_useGainCorrection);
843 ATH_MSG_DEBUG("ADC non-linearity correction = " << m_doADCLinearityCorrection);
844 ATH_MSG_DEBUG("leakage correction for photons = " << m_doLeakageCorrection);
845 ATH_MSG_DEBUG("smearing = " << m_doSmearing);
846 ATH_MSG_DEBUG("insitu scales = " << m_doScaleCorrection);
847 ATH_MSG_DEBUG("ep combination = " << m_use_ep_combination);
848 ATH_MSG_DEBUG("use MVA calibration = " << m_use_mva_calibration);
850 "use temperature correction 2015 = " << m_use_temp_correction201215);
851 ATH_MSG_DEBUG("use uA2MeV correction 2015 1/2 week = "
853
855
856 applySystematicVariation(CP::SystematicSet())
857 .ignore(); // this set the flags for the internal tool without
858 // systematics
859 CP::SystematicRegistry& registry = CP::SystematicRegistry::getInstance();
860 if (registry.registerSystematics(*this) != StatusCode::SUCCESS)
861 return StatusCode::FAILURE;
862
863 // For columnar, it is important only to set this accessor if it is
864 // needed, as it creates a hard data dependency on the column, which
865 // is not present in older PHYSLITE files, causing the tool to fail.
866 // An alternative would be to mark the column with `isOptional`, but
867 // since it is always required for the GNN calibration (and never
868 // otherwise), declaring it only for the GNN calibration seemed
869 // cleaner.
871 resetAccessor (m_accessors->gnn_energy_Acc, *this, "TransformerEnergy");
872 }
873 if (m_onlyElectrons.value() && m_onlyPhotons.value()) {
874 ATH_MSG_ERROR("Cannot select both onlyElectrons and onlyPhotons");
875 return StatusCode::FAILURE;
876 }
877 if (m_onlyElectrons.value()) {
880 resetAccessor (m_accessors->electronTrackAcc, *this, "trackParticleLinks");
881 }
882 }
883 if (m_onlyPhotons.value()) {
885 resetAccessor (m_accessors->photonVertexAcc, *this, "vertexLinks");
886 }
887 if (m_decorateEmva)
888 resetAccessor (m_accessors->decEmva, *this, "E_mva_only");
889
890 ANA_CHECK (initializeColumns ());
891
892 return StatusCode::SUCCESS;
893}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_INFO(x)
#define ANA_CHECK(EXP)
check whether the given expression was successful
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
static const Attributes_t empty
virtual StatusCode applySystematicVariation(const CP::SystematicSet &systConfig) override
effects: configure this tool for the given list of systematic variations.
static SystematicRegistry & getInstance()
Get the singleton instance of the registry for the curren thread.
StatusCode registerSystematics(const IReentrantSystematicsTool &tool)
effects: register all the systematics from the tool
std::unique_ptr< egGain::GainTool > gainToolFactory(egEnergyCorr::ESModel model)
std::string egammaMVAToolFolder(egEnergyCorr::ESModel model)
bool is_after_run1(egEnergyCorr::ESModel model)
bool use_intermodule_correction(egEnergyCorr::ESModel model)
std::unique_ptr< egammaLayerRecalibTool > egammaLayerRecalibToolFactory(egEnergyCorr::ESModel model, int enableSacc)
bool use_phi_uniform_correction(egEnergyCorr::ESModel model)
void resetElectron(MomentumAccessors< CI, CM > &accessors, ColumnarTool< CM > &columnarTool)
void resetPhoton(MomentumAccessors< CI, CM > &accessors, ColumnarTool< CM > &columnarTool)
void resetAccessor(AccessorTemplate< CI, CT, CAM, CM > &accessor, ColumnarTool< CM > &columnBase, const std::string &name, ColumnAccessorOptions &&options={})
reset a column accessor to point to a new column
setBGCode setTAP setLVL2ErrorBits bool
MsgStream & msg
Definition testRead.cxx:32

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

93 {
94
95#ifdef XAOD_STANDALONE
96 return &m_inputMetaStore;
97#else // XAOD_STANDALONE
98 return m_inputMetaStore;
99#endif // XAOD_STANDALONE
100 }
MetaStore_t m_inputMetaStore
Object accessing the input metadata store.

◆ intermodule_correction()

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

Definition at line 2224 of file EgammaCalibrationAndSmearingTool.cxx.

2225 {
2226
2227 // Intermodule Widening Correction: E_corr = E / (a' - b' * ((1 / (1 +
2228 // exp((phi_mod - 2 * pi / 32) * c))) * (1 / (1 + exp((phi_mod - 2 * pi / 32)
2229 // * (d)))))) (phi_min, phi_max) : [a' = a / a, b' = b / a, c, d]
2230
2231 double Ecl_corr = 0.;
2232 int DivInt = 0;
2233 double pi = M_PI;
2234
2248
2249 double phi_mod = 0;
2250 if (phi < 0)
2251 phi_mod = fmod(phi, 2 * pi / 16.) + pi / 8.;
2252 else
2253 phi_mod = fmod(phi, 2 * pi / 16.);
2254
2255 // The correction concerns only the barrel
2256 if (std::abs(eta) <= 1.37) {
2257
2258 if (phi < (-7 * pi / 8) && phi > (-1 * pi))
2259 Ecl_corr =
2260 Ecl /
2261 (1 - 0.1086 *
2262 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 175.2759))) *
2263 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-189.3612))))));
2264 if (phi < (-6 * pi / 8) && phi > (-7 * pi / 8))
2265 Ecl_corr =
2266 Ecl /
2267 (1 - 0.0596 *
2268 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 170.8305))) *
2269 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-233.3782))))));
2270 if (phi < (-5 * pi / 8) && phi > (-6 * pi / 8))
2271 Ecl_corr =
2272 Ecl /
2273 (1 - 0.0596 *
2274 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 147.1451))) *
2275 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-139.3386))))));
2276 if (phi < (-4 * pi / 8) && phi > (-5 * pi / 8))
2277 Ecl_corr =
2278 Ecl /
2279 (1 - 0.0583 *
2280 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 168.4644))) *
2281 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-246.2897))))));
2282 if (phi < (-3 * pi / 8) && phi > (-4 * pi / 8))
2283 Ecl_corr =
2284 Ecl /
2285 (1 - 0.0530 *
2286 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 177.6703))) *
2287 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-198.3227))))));
2288 if (phi < (-2 * pi / 8) && phi > (-3 * pi / 8))
2289 Ecl_corr =
2290 Ecl /
2291 (1 - 0.0672 *
2292 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 145.0693))) *
2293 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-242.1771))))));
2294 if (phi < (-1 * pi / 8) && phi > (-2 * pi / 8))
2295 Ecl_corr =
2296 Ecl /
2297 (1 - 0.0871 *
2298 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 132.3303))) *
2299 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-166.1833))))));
2300 if (phi < (0 * pi / 8) && phi > (-1 * pi / 8))
2301 Ecl_corr =
2302 Ecl /
2303 (1 - 0.0948 *
2304 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 127.6780))) *
2305 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-150.0700))))));
2306 if (phi < (1 * pi / 8) && phi > (0 * pi / 8))
2307 Ecl_corr =
2308 Ecl /
2309 (1 - 0.1166 *
2310 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 172.0679))) *
2311 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-235.3293))))));
2312 if (phi < (2 * pi / 8) && phi > (1 * pi / 8))
2313 Ecl_corr =
2314 Ecl /
2315 (1 - 0.1172 *
2316 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 190.3524))) *
2317 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-198.9400))))));
2318 if (phi < (3 * pi / 8) && phi > (2 * pi / 8))
2319 Ecl_corr =
2320 Ecl /
2321 (1 - 0.1292 *
2322 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 158.0540))) *
2323 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-165.3893))))));
2324 if (phi < (4 * pi / 8) && phi > (3 * pi / 8))
2325 Ecl_corr =
2326 Ecl /
2327 (1 - 0.1557 *
2328 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 162.2793))) *
2329 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-133.5131))))));
2330 if (phi < (5 * pi / 8) && phi > (4 * pi / 8))
2331 Ecl_corr =
2332 Ecl /
2333 (1 - 0.1659 *
2334 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 180.5270))) *
2335 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-168.5074))))));
2336 if (phi < (6 * pi / 8) && phi > (5 * pi / 8))
2337 Ecl_corr =
2338 Ecl /
2339 (1 - 0.1123 *
2340 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 128.2277))) *
2341 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-154.4455))))));
2342 if (phi < (7 * pi / 8) && phi > (6 * pi / 8))
2343 Ecl_corr =
2344 Ecl /
2345 (1 - 0.1394 *
2346 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 192.1216))) *
2347 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-198.0727))))));
2348 if (phi < (8 * pi / 8) && phi > (7 * pi / 8))
2349 Ecl_corr =
2350 Ecl /
2351 (1 - 0.1001 *
2352 ((1 / (1 + exp((phi_mod - 2 * pi / 32.) * 199.1735))) *
2353 (1 / (1 + exp((phi_mod - 2 * pi / 32.) * (-176.4056))))));
2354 }
2355
2356 // No correction for the EC
2357 else {
2358 Ecl_corr = Ecl;
2359 }
2360
2361 }
2362
2363 else {
2364
2365 // Definitions of module folding into four quarters (top, left, bottom and
2366 // right)
2367
2368 DivInt = (int)(phi / ((2 * pi) / 16.));
2369 double phi_mod = phi - DivInt * (2 * pi / 16.);
2370
2371 // Centring on the intermodule --> phi_mod will now be in [0,0.4]
2372 if (phi_mod < 0)
2373 phi_mod += pi / 8.;
2374
2375 // The correction concerns only the barrel
2376 if (std::abs(eta) <= 1.4) {
2377
2378 // Top quarter
2379 if (phi < (3 * pi) / 4. && phi >= pi / 4.) {
2380 Ecl_corr =
2381 Ecl / (1 - 0.131 * ((1 / (1 + exp((phi_mod - 0.2) * 199.08))) *
2382 (1 / (1 + exp((phi_mod - 0.2) * (-130.36))))));
2383 }
2384
2385 // Right quarter
2386 if (phi < pi / 4. && phi >= -pi / 4.) {
2387 Ecl_corr =
2388 Ecl / (1 - 0.0879 * ((1 / (1 + exp((phi_mod - 0.2) * 221.01))) *
2389 (1 / (1 + exp((phi_mod - 0.2) * (-149.51))))));
2390 }
2391 // Bottom quarter
2392 if (phi < -pi / 4. && phi >= (-3 * pi) / 4.) {
2393 Ecl_corr =
2394 Ecl / (1 - 0.0605 * ((1 / (1 + exp((phi_mod - 0.2) * 281.37))) *
2395 (1 / (1 + exp((phi_mod - 0.2) * (-170.29))))));
2396 }
2397 // Left quarter
2398 if ((phi < (-3 * pi) / 4.) || (phi >= (3 * pi) / 4.)) {
2399 Ecl_corr =
2400 Ecl / (1 - 0.102 * ((1 / (1 + exp((phi_mod - 0.2) * 235.37))) *
2401 (1 / (1 + exp((phi_mod - 0.2) * (-219.04))))));
2402 }
2403 }
2404
2405 // No correction for the EC
2406 else {
2407 Ecl_corr = Ecl;
2408 }
2409 }
2410
2411 return Ecl_corr;
2412}
#define pi
setRawEt setRawPhi int

◆ 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 1318 of file EgammaCalibrationAndSmearingTool.cxx.

1319 {
1320 CP::SystematicSet sys = affectingSystematics();
1321 return sys.find(systematic) != sys.end();
1322}
virtual CP::SystematicSet affectingSystematics() const override
the list of all systematics this tool can be affected by

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

209 {
210
211 // Return gracefully:
212 return StatusCode::SUCCESS;
213 }

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

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

101 {
102
103 return MSG::name( msg().level() );
104 }
MsgStream & msg() const
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition MsgLevel.cxx:19

◆ msgLvl()

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

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ 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 1292 of file EgammaCalibrationAndSmearingTool.cxx.

1293 {
1294 const Accessors& acc = *m_accessors;
1295 return acc.eventTypeAcc (event_info, xAOD::EventInfo::IS_SIMULATION)
1298}

◆ 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 1280 of file EgammaCalibrationAndSmearingTool.cxx.

1281 {
1282 const Accessors& acc = *m_accessors;
1283 if (!acc.eventTypeAcc (event_info, xAOD::EventInfo::IS_SIMULATION))
1285 if (m_currentScalePredicate(*this,p))
1287 else
1289}

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

102 {
103
104#ifdef XAOD_STANDALONE
105 return &m_outputMetaStore;
106#else // XAOD_STANDALONE
107 return m_outputMetaStore;
108#endif // XAOD_STANDALONE
109 }
MetaStore_t m_outputMetaStore
Object accessing the output metadata store.

◆ print() [1/2]

◆ print() [2/2]

◆ recommendedSystematics()

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

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 2170 of file EgammaCalibrationAndSmearingTool.cxx.

2171 {
2172 return affectingSystematics();
2173}

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

381 {
382 h.renounce();
384 }
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)

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

364 {
366 }

◆ 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 947 of file EgammaCalibrationAndSmearingTool.cxx.

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

◆ setPt()

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

Definition at line 1263 of file EgammaCalibrationAndSmearingTool.cxx.

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

◆ setRandomSeedFunction()

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

Definition at line 238 of file EgammaCalibrationAndSmearingTool.h.

238 {
239 m_set_seed_function = function;
240 }

◆ setupSystematics()

void CP::EgammaCalibrationAndSmearingTool::setupSystematics ( )
private

Definition at line 1337 of file EgammaCalibrationAndSmearingTool.cxx.

1337 {
1338 const EgammaPredicate always = [](const EgammaCalibrationAndSmearingTool&, columnar::EgammaId) { return true; };
1339
1340 // Try to simplify a bit for the ones that are fully correlate in eta,
1341 // whatever the model and that are not included in the macros including
1342 // - ADC non linearity
1343 // - L2Gain
1344 // - Leakage
1345 // - Conversion related
1346 // - TopoCluster threshold
1347 // - AF2
1348 // - PS_BARREL_B12
1349 // - S12EXTRALASTETABINRUN2
1350 // - ZEESTAT
1351 // - Run3 pre OFC + EXTRA
1352 if (m_decorrelation_model_scale == ScaleDecorrelation::FULL_ETA_CORRELATED ||
1353 m_decorrelation_model_scale == ScaleDecorrelation::FULL) {
1354 // Electron leakage, ADCLin, convReco only in final run2 recommendations
1358 // systematic related to ADC non linearity correction. Before 2022, there
1359 // was not correction, nor related systematic
1361 m_syst_description[CP::SystematicVariation("EG_SCALE_ADCLIN", +1)] =
1363 m_syst_description[CP::SystematicVariation("EG_SCALE_ADCLIN", -1)] =
1365 }
1366 // Gain splitted uncertainty
1367 m_syst_description[CP::SystematicVariation("EG_SCALE_L2MEDIUMGAIN", +1)] =
1369 m_syst_description[CP::SystematicVariation("EG_SCALE_L2MEDIUMGAIN", -1)] =
1371 m_syst_description[CP::SystematicVariation("EG_SCALE_L2LOWGAIN", +1)] =
1373 m_syst_description[CP::SystematicVariation("EG_SCALE_L2LOWGAIN", -1)] =
1375
1376 // Electron leakage
1377 m_syst_description[CP::SystematicVariation("EG_SCALE_LEAKAGEELEC", +1)] =
1379 m_syst_description[CP::SystematicVariation("EG_SCALE_LEAKAGEELEC", -1)] =
1381
1382 // Conversion related
1383 m_syst_description[CP::SystematicVariation("PH_SCALE_CONVRECO", +1)] =
1385 m_syst_description[CP::SystematicVariation("PH_SCALE_CONVRECO", -1)] =
1387 }
1388 // The equivalent of convReco (convefficiency and convfakerate) for other
1389 // models
1390 else {
1391 m_syst_description[CP::SystematicVariation("PH_SCALE_CONVEFFICIENCY",
1392 +1)] =
1394 m_syst_description[CP::SystematicVariation("PH_SCALE_CONVEFFICIENCY",
1395 -1)] =
1397 m_syst_description[CP::SystematicVariation("PH_SCALE_CONVFAKERATE", +1)] =
1399 m_syst_description[CP::SystematicVariation("PH_SCALE_CONVFAKERATE", -1)] =
1401 }
1402
1403 // additional systematics for R22 OFC and MC21 pre and bulk
1405 m_syst_description[CP::SystematicVariation("EG_SCALE_OFC", +1)] =
1407 m_syst_description[CP::SystematicVariation("EG_SCALE_OFC", -1)] =
1409
1410 m_syst_description[CP::SystematicVariation("EG_SCALE_EXTRARUN3PRE", +1)] =
1412 m_syst_description[CP::SystematicVariation("EG_SCALE_EXTRARUN3PRE", -1)] =
1414 }
1415
1426
1427 // topo clustr threshold systematics aded to release 21 recommendations
1428 m_syst_description[CP::SystematicVariation("EG_SCALE_TOPOCLUSTER_THRES",
1429 +1)] =
1431 m_syst_description[CP::SystematicVariation("EG_SCALE_TOPOCLUSTER_THRES",
1432 -1)] =
1434
1435 // AF3 for run3 models: es2022_R22_PRE and esmodel >= es2023_R22_Run2_v1
1436 // although we prevent AF for es2022_R22_PRE and es2024_Run3_ofc0_v0
1437 // AF3 are still technically added in the tool
1438 // but normally uncertainty will be 0
1440 m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", +1)] =
1442 m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", -1)] =
1444 }
1445 else {
1446 // and extra AF2 systematics for release 21 recommendations - Moriond 2018
1447 // - pending proper AF2 to FullSim correction with release 21
1448 m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", +1)] =
1450 m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", -1)] =
1452 }
1453 }
1454
1455 // PS correlated barrel uncertainty
1464 m_syst_description[CP::SystematicVariation("EG_SCALE_PS_BARREL_B12",
1465 +1)] =
1467 m_syst_description[CP::SystematicVariation("EG_SCALE_PS_BARREL_B12",
1468 -1)] =
1470 }
1471
1472 // additional systematic for S12 last eta bin run2
1477 m_syst_description[CP::SystematicVariation(
1478 "EG_SCALE_S12EXTRALASTETABINRUN2", +1)] =
1480 m_syst_description[CP::SystematicVariation(
1481 "EG_SCALE_S12EXTRALASTETABINRUN2", -1)] =
1483 }
1484
1485 // Zee stat, if for FULL we do not ask for m_use_full_statistical_error
1487 ScaleDecorrelation::FULL_ETA_CORRELATED or
1489 // return 1 variation only, fully correlated in eta, equal to the correct
1490 // value but scaled by sqrt(number of bins) the scaling is done by the old
1491 // tool
1492 m_syst_description[CP::SystematicVariation("EG_SCALE_ZEESTAT", +1)] =
1494 m_syst_description[CP::SystematicVariation("EG_SCALE_ZEESTAT", -1)] =
1496 }
1497 }
1498 if (m_decorrelation_model_scale == ScaleDecorrelation::ONENP) {
1499 // TODO: independet implementation of ALL UP looping on all the variations
1500 m_syst_description[CP::SystematicVariation("EG_SCALE_ALL", +1)] =
1502 m_syst_description[CP::SystematicVariation("EG_SCALE_ALL", -1)] =
1504
1505 // to be consistent with other schemes, we add
1506 // extra AF systematics in addition to the 1NP
1513 m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", +1)] =
1515 m_syst_description[CP::SystematicVariation("EG_SCALE_AF2", -1)] =
1517 }
1519 m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", +1)] =
1521 m_syst_description[CP::SystematicVariation("EG_SCALE_AF3", -1)] =
1523 }
1524 }
1525 else if (m_decorrelation_model_scale ==
1526 ScaleDecorrelation::FULL_ETA_CORRELATED) {
1527// all the physical effects separately, considered as fully correlated in eta
1529#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1530 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1531 SysInfo{always, flagup}; \
1532 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1533 SysInfo{always, flagdown};
1534#include "ElectronPhotonFourMomentumCorrection/systematics_es2024_Run3_v0.def"
1535#undef SYSMACRO
1536 }
1537 else {
1538// common systematics for all the esmodels
1539#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1540 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1541 SysInfo{always, flagup}; \
1542 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1543 SysInfo{always, flagdown};
1544#include "ElectronPhotonFourMomentumCorrection/systematics_S12_2022.def"
1545#undef SYSMACRO
1546 }
1547
1551 m_syst_description[CP::SystematicVariation("EG_SCALE_LARCALIB", +1)] =
1553 m_syst_description[CP::SystematicVariation("EG_SCALE_LARCALIB", -1)] =
1555 m_syst_description[CP::SystematicVariation("EG_SCALE_L2GAIN", +1)] =
1557 m_syst_description[CP::SystematicVariation("EG_SCALE_L2GAIN", -1)] =
1559 }
1560
1561 // additional systematics for S12 run2
1571 m_syst_description[CP::SystematicVariation(
1572 "EG_SCALE_LARCALIB_EXTRA2015PRE", +1)] =
1574 m_syst_description[CP::SystematicVariation(
1575 "EG_SCALE_LARCALIB_EXTRA2015PRE", -1)] =
1577 }
1578
1579 // additional systematics for temperature run1->run2
1585 m_syst_description[CP::SystematicVariation(
1586 "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE", +1)] =
1588 m_syst_description[CP::SystematicVariation(
1589 "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE", -1)] =
1591 }
1592
1593 // additional systematic for temperature 2015->2016
1595 m_syst_description[CP::SystematicVariation(
1596 "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE", +1)] =
1598 m_syst_description[CP::SystematicVariation(
1599 "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE", -1)] =
1601 }
1602
1603 // additional systematic for PP0 region
1619 m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0", +1)] =
1621 m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0", -1)] =
1623 }
1624
1625 // systematic related to wtots1
1641 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", +1)] =
1643 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", -1)] =
1645 }
1646
1647 // systematic for the scintillators
1666 // scintillator systematics
1667 m_syst_description[CP::SystematicVariation("EG_SCALE_E4SCINTILLATOR",
1668 +1)] =
1670 m_syst_description[CP::SystematicVariation("EG_SCALE_E4SCINTILLATOR",
1671 -1)] =
1673 }
1674
1675 } else if (m_decorrelation_model_scale ==
1676 ScaleDecorrelation::ONENP_PLUS_UNCONR) {
1677// qsum of all variations correlated 8/13 TeV + uncorrelated (additional
1678// systematics for 2015PRE or 2016) all the physical effects separately,
1679// considered as fully correlated in eta
1680// TODO: fix for es2017
1681#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1682 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1683 SysInfo{always, flagup}; \
1684 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1685 SysInfo{always, flagdown};
1686#include "ElectronPhotonFourMomentumCorrection/systematics_1NPCOR_PLUS_UNCOR.def"
1687#undef SYSMACRO
1688
1689 // additional systematic for S12 last eta bin run2 - not needed anymore for
1690 // last 20.7 model since it is part of bin per bin E1/E2 uncertainty in root
1691 // file
1695 m_syst_description[CP::SystematicVariation(
1696 "EG_SCALE_S12EXTRALASTETABINRUN2", +1)] =
1698 m_syst_description[CP::SystematicVariation(
1699 "EG_SCALE_S12EXTRALASTETABINRUN2", -1)] =
1701 }
1702
1703 } else if (m_decorrelation_model_scale == ScaleDecorrelation::FULL) {
1704 using pairvector = std::vector<std::pair<double, double>>;
1705 const pairvector decorrelation_bins_BE = {{0., 1.45}, {1.52, 2.5}};
1706 const std::vector<double> decorrelation_edges_TWELVE = {
1707 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};
1708 std::vector<double> decorrelation_edges_MODULE = {
1709 0., 0.2, 0.4, 0.6, 0.8, 1.0, 1.2, 1.37, 1.52, 1.8};
1710 const std::vector<double> decorrelation_edges_MATERIAL = {0.0, 1.1, 1.5,
1711 2.1, 2.5};
1712 std::vector<double> decorrelation_edges_S12_EXTRARUN3 = {
1713 0., 0.8, 1.5, 2.5};
1714
1715 std::vector<double> decorrelation_edges_S12;
1716 // for es2018_R21_v1 : 4 eta bins for muon E1/E2 uncertainty correlation
1718 decorrelation_edges_S12.resize(5);
1719 decorrelation_edges_S12 = {0., 1.35, 1.5, 2.4, 2.5};
1723 decorrelation_edges_S12.resize(8);
1724 decorrelation_edges_S12 = {0., 0.6, 1.0, 1.35, 1.5, 1.8, 2.4, 2.5};
1725 //
1726 // PS scale from muons, so "crack" is a bit different
1727 decorrelation_edges_MODULE[7] = 1.4;
1728 decorrelation_edges_MODULE[8] = 1.5;
1729 }
1730 // for previous run 2 muon calibration with 20.7, 5 eta bins for E1/E2
1731 // uncertainty correlation
1732 else {
1733 decorrelation_edges_S12.resize(6);
1734 decorrelation_edges_S12 = {0., 0.6, 1.4, 1.5, 2.4, 2.5};
1735 }
1736
1748#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1749 if (bool(fullcorrelated)) { \
1750 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1751 SysInfo{always, flagup}; \
1752 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1753 SysInfo{always, flagdown}; \
1754 } else { \
1755 int i = 0; \
1756 for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) { \
1757 m_syst_description[CP::SystematicVariation( \
1758 #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup}; \
1759 m_syst_description[CP::SystematicVariation( \
1760 #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
1761 i += 1; \
1762 } \
1763 }
1764#include "ElectronPhotonFourMomentumCorrection/systematics.def"
1765#undef SYSMACRO
1768#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1769 if (bool(fullcorrelated)) { \
1770 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1771 SysInfo{always, flagup}; \
1772 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1773 SysInfo{always, flagdown}; \
1774 } else { \
1775 int i = 0; \
1776 for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) { \
1777 m_syst_description[CP::SystematicVariation( \
1778 #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup}; \
1779 m_syst_description[CP::SystematicVariation( \
1780 #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
1781 i += 1; \
1782 } \
1783 }
1784#include "ElectronPhotonFourMomentumCorrection/systematics_S12_2022.def"
1785#undef SYSMACRO
1787#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1788 if (bool(fullcorrelated)) { \
1789 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1790 SysInfo{always, flagup}; \
1791 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1792 SysInfo{always, flagdown}; \
1793 } else { \
1794 int i = 0; \
1795 for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) { \
1796 m_syst_description[CP::SystematicVariation( \
1797 #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup}; \
1798 m_syst_description[CP::SystematicVariation( \
1799 #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
1800 i += 1; \
1801 } \
1802 }
1803#include "ElectronPhotonFourMomentumCorrection/systematics_es2024_Run3_v0.def"
1804#undef SYSMACRO
1805 } else {
1806#define SYSMACRO(name, fullcorrelated, decorrelation, flagup, flagdown) \
1807 if (bool(fullcorrelated)) { \
1808 m_syst_description[CP::SystematicVariation(#name, +1)] = \
1809 SysInfo{always, flagup}; \
1810 m_syst_description[CP::SystematicVariation(#name, -1)] = \
1811 SysInfo{always, flagdown}; \
1812 } else { \
1813 int i = 0; \
1814 for (const auto& p : AbsEtaCaloPredicatesFactory(decorrelation)) { \
1815 m_syst_description[CP::SystematicVariation( \
1816 #name "__ETABIN" + std::to_string(i), +1)] = SysInfo{p, flagup}; \
1817 m_syst_description[CP::SystematicVariation( \
1818 #name "__ETABIN" + std::to_string(i), -1)] = SysInfo{p, flagdown}; \
1819 i += 1; \
1820 } \
1821 }
1822#include "ElectronPhotonFourMomentumCorrection/systematics_S12.def"
1823#undef SYSMACRO
1824 } // else
1825
1827 // statistical error, decorrelate in *all* the bins
1828 int i = 0;
1829 const TAxis& axis_statistical_error(m_rootTool->get_ZeeStat_eta_axis());
1830 for (int ibin = 1; ibin <= axis_statistical_error.GetNbins(); ++ibin) {
1832 axis_statistical_error.GetBinLowEdge(ibin),
1833 axis_statistical_error.GetBinLowEdge(ibin + 1));
1834 m_syst_description[CP::SystematicVariation(
1835 "EG_SCALE_ZEESTAT__ETABIN" + std::to_string(i), +1)] =
1837 m_syst_description[CP::SystematicVariation(
1838 "EG_SCALE_ZEESTAT__ETABIN" + std::to_string(i), -1)] =
1840 ++i;
1841 }
1842 }
1843
1844 // additional systematics for S12 run2
1854 m_syst_description[CP::SystematicVariation(
1855 "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN0", +1)] =
1858 m_syst_description[CP::SystematicVariation(
1859 "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN0", -1)] =
1862 m_syst_description[CP::SystematicVariation(
1863 "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN1", +1)] =
1864 SysInfo{AbsEtaCaloPredicateFactory({1.45, 2.47}),
1866 m_syst_description[CP::SystematicVariation(
1867 "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN1", -1)] =
1868 SysInfo{AbsEtaCaloPredicateFactory({1.45, 2.47}),
1870 m_syst_description[CP::SystematicVariation(
1871 "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN2", +1)] =
1874 m_syst_description[CP::SystematicVariation(
1875 "EG_SCALE_LARCALIB_EXTRA2015PRE__ETABIN2", -1)] =
1878 }
1879
1880 // additional systematics for temperature run1->run2
1886 m_syst_description[CP::SystematicVariation(
1887 "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN0", +1)] =
1888 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
1890 m_syst_description[CP::SystematicVariation(
1891 "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN0", -1)] =
1892 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
1894 m_syst_description[CP::SystematicVariation(
1895 "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN1", +1)] =
1896 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
1898 m_syst_description[CP::SystematicVariation(
1899 "EG_SCALE_LARTEMPERATURE_EXTRA2015PRE__ETABIN1", -1)] =
1900 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
1902 }
1903
1904 // additional systematic for temperature 2015->2016
1906 m_syst_description[CP::SystematicVariation(
1907 "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN0", +1)] =
1908 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
1910 m_syst_description[CP::SystematicVariation(
1911 "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN1", +1)] =
1912 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
1914 m_syst_description[CP::SystematicVariation(
1915 "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN0", -1)] =
1916 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[0]),
1918 m_syst_description[CP::SystematicVariation(
1919 "EG_SCALE_LARTEMPERATURE_EXTRA2016PRE__ETABIN1", -1)] =
1920 SysInfo{AbsEtaCaloPredicateFactory(decorrelation_bins_BE[1]),
1922 }
1923
1924 // additional systematic for PP0 region
1940 m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN0",
1941 +1)] = SysInfo{
1943 m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN1",
1944 +1)] = SysInfo{
1946 m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN0",
1947 -1)] = SysInfo{
1949 m_syst_description[CP::SystematicVariation("EG_SCALE_MATPP0__ETABIN1",
1950 -1)] =
1953 }
1954
1955 // systematic related to wtots1
1968 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", +1)] =
1970 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1", -1)] =
1972 }
1973
1974 // systematic related to wtots1, decorrelate eta bin [1.52,1.82] from rest
1978 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN0",
1979 +1)] =
1980 SysInfo{DoubleOrAbsEtaCaloPredicate(0, 1.52, 1.82, 2.47),
1982 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN0",
1983 -1)] =
1984 SysInfo{DoubleOrAbsEtaCaloPredicate(0, 1.52, 1.82, 2.47),
1986 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN1",
1987 +1)] =
1988 SysInfo{AbsEtaCaloPredicateFactory({1.52, 1.82}),
1990 m_syst_description[CP::SystematicVariation("EG_SCALE_WTOTS1__ETABIN1",
1991 -1)] =
1992 SysInfo{AbsEtaCaloPredicateFactory({1.52, 1.82}),
1994 }
1995
1996 // systematic for the scintillators
2015 m_syst_description[CP::SystematicVariation(
2016 "EG_SCALE_E4SCINTILLATOR__ETABIN0", +1)] =
2019 m_syst_description[CP::SystematicVariation(
2020 "EG_SCALE_E4SCINTILLATOR__ETABIN1", +1)] =
2023 m_syst_description[CP::SystematicVariation(
2024 "EG_SCALE_E4SCINTILLATOR__ETABIN2", +1)] =
2027 m_syst_description[CP::SystematicVariation(
2028 "EG_SCALE_E4SCINTILLATOR__ETABIN0", -1)] =
2031 m_syst_description[CP::SystematicVariation(
2032 "EG_SCALE_E4SCINTILLATOR__ETABIN1", -1)] =
2035 m_syst_description[CP::SystematicVariation(
2036 "EG_SCALE_E4SCINTILLATOR__ETABIN2", -1)] =
2039 if (m_TESModel == egEnergyCorr::es2024_Run3_v0) { // extended E4 in Run 3
2040 m_syst_description[CP::SystematicVariation(
2041 "EG_SCALE_E4SCINTILLATOR__ETABIN3", +1)] =
2044 m_syst_description[CP::SystematicVariation(
2045 "EG_SCALE_E4SCINTILLATOR__ETABIN3", -1)] =
2048 }
2049 }
2050 } else {
2051 ATH_MSG_FATAL("scale decorrelation model invalid");
2052 }
2053
2054 // resolution systematics
2056 // ALL will not include AF2/AF3 systematic
2057 // individual AF NP is always provided
2058 // linghua.guo@cern.ch 2025-04-23
2059 m_syst_description_resolution[CP::SystematicVariation(
2060 "EG_RESOLUTION_ALL", +1)] = egEnergyCorr::Resolution::AllUp;
2061 m_syst_description_resolution[CP::SystematicVariation(
2062 "EG_RESOLUTION_ALL", -1)] = egEnergyCorr::Resolution::AllDown;
2065 m_syst_description_resolution[CP::SystematicVariation(
2066 "EG_RESOLUTION_ZSMEARING", +1)] = egEnergyCorr::Resolution::ZSmearingUp;
2067 m_syst_description_resolution[CP::SystematicVariation(
2068 "EG_RESOLUTION_ZSMEARING", -1)] =
2070 m_syst_description_resolution[CP::SystematicVariation(
2071 "EG_RESOLUTION_SAMPLINGTERM", +1)] =
2073 m_syst_description_resolution[CP::SystematicVariation(
2074 "EG_RESOLUTION_SAMPLINGTERM", -1)] =
2076 m_syst_description_resolution[CP::SystematicVariation(
2077 "EG_RESOLUTION_MATERIALID", +1)] =
2079 m_syst_description_resolution[CP::SystematicVariation(
2080 "EG_RESOLUTION_MATERIALID", -1)] =
2082 m_syst_description_resolution[CP::SystematicVariation(
2083 "EG_RESOLUTION_MATERIALCALO", +1)] =
2085 m_syst_description_resolution[CP::SystematicVariation(
2086 "EG_RESOLUTION_MATERIALCALO", -1)] =
2088 m_syst_description_resolution[CP::SystematicVariation(
2089 "EG_RESOLUTION_MATERIALGAP", +1)] =
2091 m_syst_description_resolution[CP::SystematicVariation(
2092 "EG_RESOLUTION_MATERIALGAP", -1)] =
2094 m_syst_description_resolution[CP::SystematicVariation(
2095 "EG_RESOLUTION_MATERIALCRYO", +1)] =
2097 m_syst_description_resolution[CP::SystematicVariation(
2098 "EG_RESOLUTION_MATERIALCRYO", -1)] =
2100 m_syst_description_resolution[CP::SystematicVariation(
2101 "EG_RESOLUTION_PILEUP", +1)] = egEnergyCorr::Resolution::PileUpUp;
2102 m_syst_description_resolution[CP::SystematicVariation(
2103 "EG_RESOLUTION_PILEUP", -1)] = egEnergyCorr::Resolution::PileUpDown;
2119 m_syst_description_resolution[CP::SystematicVariation(
2120 "EG_RESOLUTION_MATERIALIBL", +1)] =
2122 m_syst_description_resolution[CP::SystematicVariation(
2123 "EG_RESOLUTION_MATERIALIBL", -1)] =
2125 m_syst_description_resolution[CP::SystematicVariation(
2126 "EG_RESOLUTION_MATERIALPP0", +1)] =
2128 m_syst_description_resolution[CP::SystematicVariation(
2129 "EG_RESOLUTION_MATERIALPP0", -1)] =
2131
2132 if (m_TESModel == egEnergyCorr::es2022_R22_PRE) { // exta sys. for Run-3
2133 // pre-recommendations
2134 m_syst_description_resolution[CP::SystematicVariation(
2135 "EG_RESOLUTION_OFC", +1)] = egEnergyCorr::Resolution::OFCUp;
2136 m_syst_description_resolution[CP::SystematicVariation(
2137 "EG_RESOLUTION_OFC", -1)] = egEnergyCorr::Resolution::OFCDown;
2138 }
2139 }
2140 } else {
2141 ATH_MSG_FATAL("resolution decorrelation model invalid");
2142 }
2143
2144 // Always use individual AF2/AF3 systematics for resolution
2149 m_syst_description_resolution[CP::SystematicVariation(
2150 "EG_RESOLUTION_AF2", +1)] = egEnergyCorr::Resolution::afUp;
2151 m_syst_description_resolution[CP::SystematicVariation(
2152 "EG_RESOLUTION_AF2", -1)] = egEnergyCorr::Resolution::afDown;
2153 }
2155 m_syst_description_resolution[CP::SystematicVariation(
2156 "EG_RESOLUTION_AF3", +1)] = egEnergyCorr::Resolution::afUp;
2157 m_syst_description_resolution[CP::SystematicVariation(
2158 "EG_RESOLUTION_AF3", -1)] = egEnergyCorr::Resolution::afDown;
2159 }
2160
2161 // ep combination systematics
2163 m_syst_description[CP::SystematicVariation("EL_SCALE_MOMENTUM", +1)] =
2165 m_syst_description[CP::SystematicVariation("EL_SCALE_MOMENTUM", -1)] =
2167 }
2168}
const EgammaPredicate EtaCaloPredicateFactory(double eta_min, double eta_max) const
std::function< bool(const EgammaCalibrationAndSmearingTool &, columnar::EgammaId)> EgammaPredicate

◆ setUseIncidents()

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

Definition at line 132 of file AsgMetadataTool.h.

133 {
135 }
bool flag
Definition master.py:29

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

115 {
116
117#ifndef XAOD_STANDALONE
118 if (m_useIncidents) {
119 // Connect to the IncidentSvc:
120 ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
121 ATH_CHECK( incSvc.retrieve() );
122
123 // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
124 incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
125 }
126 // Let the base class do its thing:
127 ATH_CHECK( AlgTool::sysInitialize() );
128
129#endif // not XAOD_STANDALONE
130
131 // Return gracefully:
132 return StatusCode::SUCCESS;
133 }

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

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }
std::vector< SG::VarHandleKeyArray * > m_vhka

◆ xAOD2ptype()

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

Definition at line 896 of file EgammaCalibrationAndSmearingTool.cxx.

897{
898 const Accessors& acc = *m_accessors;
899
900 // this is departing from the logic below, as we are now requiring the
901 // user to specify at configuration time whether we run on electrons
902 // or photons. this is necessary to configure the columns we need
903 // correctly.
904 if (m_onlyElectrons.value())
905 {
907 }
908 if (m_onlyPhotons.value())
909 {
910 if (acc.photonVertexAcc(particle).size() > 0)
911 {
913 }
914 else
915 {
917 }
918 }
919
920 // this is the old logic and should not be visited in columnar mode
921 // (disabled by turning on onlyElectrons or onlyPhotons)
923 //no ForwardElectron ptype: consider them as Electron
925 else if (xAOD::EgammaHelpers::isPhoton(&particle.getXAODObject())) {
928 }
929 else {
930 ATH_MSG_ERROR("particle is not electron of photon");
931 throw std::runtime_error("particle is not electron or photon");
932 }
933 return ptype;
934}
bool isConvertedPhoton(const xAOD::Egamma *eg, bool excludeTRT=false)
is the object a converted photon
bool isElectron(const xAOD::Egamma *eg)
is the object an electron (not Fwd)
bool isPhoton(const xAOD::Egamma *eg)
is the object a photon

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 489 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:

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.

297 {
298 this, "DoFwdElectronCalibration", false,
299 "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.

293 {
294 this, "FixForMissingCells", true,
295 "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.

414 {this, "MVACalibSvc", "",
415 "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.

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

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

301 {
302 this, "PrimaryVerticesKey", "PrimaryVertices",
303 "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:

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: