ATLAS Offline Software
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
JetCalibrationTool Class Reference

#include <JetCalibrationTool.h>

Inheritance diagram for JetCalibrationTool:
Collaboration diagram for JetCalibrationTool:

Public Types

enum  jetScale { EM, LC, PFLOW }
 

Public Member Functions

 JetCalibrationTool (const std::string &name="JetCalibrationTool")
 Constructor with parameters: More...
 
 ~JetCalibrationTool ()
 Destructor: More...
 
StatusCode initialize () override
 Dummy implementation of the initialisation function. More...
 
StatusCode applyCalibration (xAOD::JetContainer &) const override
 Apply calibration to a jet container. More...
 
StatusCode getNominalResolutionData (const xAOD::Jet &jet, double &resolution) const override
 
StatusCode getNominalResolutionMC (const xAOD::Jet &jet, double &resolution) const override
 
StatusCode getNominalResolutionHist (const xAOD::Jet &jet, double &resolution, const TH2D *histo) const
 
virtual StatusCode sysInitialize ()
 Function initialising the tool in the correct way in Athena. More...
 
virtual void print () const
 Print the state of the tool. More...
 
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & evtStore () const
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
 
virtual StatusCode sysStart () override
 Handle START transition. More...
 
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles. More...
 
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles. More...
 
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T, V, H > &t)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc="none")
 Declare a new Gaudi property. More...
 
void updateVHKA (Gaudi::Details::PropertyBase &)
 
MsgStream & msg () const
 
MsgStream & msg (const MSG::Level lvl) const
 
bool msgLvl (const MSG::Level lvl) const
 
virtual StatusCode modify (xAOD::JetContainer &jets) const override final
 Apply calibration to a jet container (for IJetModifier interface). More...
 

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce (T &h)
 
void extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
 Add StoreName to extra input/output deps as needed. More...
 

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

StatusCode calibrate (xAOD::Jet &jet, JetEventInfo &jetEventInfo) const
 
StatusCode initializeEvent (JetEventInfo &jetEventInfo) const
 
StatusCode getCalibClass (const TString &calibration)
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

SG::ReadHandleKey< xAOD::EventInfom_evtInfoKey {this, "EventInfoKey", "EventInfo"}
 
SG::ReadHandleKey< xAOD::EventShapem_rhoKey {this, "RhoKey", "auto"}
 
SG::ReadHandleKey< xAOD::VertexContainerm_pvKey {this, "PrimaryVerticesContainerName", "PrimaryVertices"}
 
SG::ReadDecorHandleKey< xAOD::EventInfom_muKey
 
SG::ReadDecorHandleKey< xAOD::EventInfom_actualMuKey
 
std::string m_jetAlgo
 
std::string m_config
 
std::string m_calibSeq
 
std::string m_calibAreaTag
 
std::string m_originScale
 
bool m_devMode {}
 
bool m_isData {true}
 
std::string m_forceCampaign {}
 
bool m_timeDependentCalib {}
 
bool m_originCorrectedClusters {}
 
bool m_useNjetInResidual {}
 
float m_nJetThreshold {}
 
std::string m_nJetContainerName
 
std::string m_dir
 
std::string m_eInfoName
 
std::vector< TString > m_timeDependentInsituConfigs
 
std::vector< double > m_runBins
 
bool m_doSetDetectorEta {}
 
bool m_insituCombMassCalib {}
 
std::vector< TString > m_insituCombMassConfig
 
std::string m_forceCalibFile_PtResidual {}
 
std::string m_forceCalibFile_FastSim {}
 
std::string m_forceCalibFile_MC2MC {}
 
TEnv * m_globalConfig {}
 
std::vector< TEnv * > m_globalTimeDependentConfigs
 
std::vector< TEnv * > m_globalInsituCombMassConfig
 
jetScale m_jetScale = jetScale::EM
 
bool m_doBcid {true}
 
bool m_doJetArea {true}
 
bool m_doResidual {true}
 
bool m_doOrigin {true}
 
bool m_doGSC {true}
 
bool m_doDNNCal {}
 
std::string m_gscDepth {"auto"}
 
std::vector< std::unique_ptr< JetCalibrationStep > > m_calibSteps
 
int m_smearIndex {-1}
 
bool m_useOriginVertex {}
 
MetaStore_t m_inputMetaStore
 Object accessing the input metadata store. More...
 
MetaStore_t m_outputMetaStore
 Object accessing the output metadata store. More...
 
bool m_beginInputFileCalled
 Flag helping to discover when the tool misses the opening of the first input file. More...
 
bool m_useIncidents
 
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
std::vector< SG::VarHandleKeyArray * > m_vhka
 
bool m_varHandleArraysDeclared
 

Callback functions helping in metadata reading/writing

void setUseIncidents (const bool flag)
 
virtual void handle (const Incident &inc)
 Function receiving incidents from IncidentSvc/TEvent. More...
 
virtual StatusCode beginInputFile ()
 Function called when a new input file is opened. More...
 
virtual StatusCode endInputFile ()
 Function called when the currently open input file got completely processed. More...
 
virtual StatusCode beginEvent ()
 Function called when a new events is loaded. More...
 
virtual StatusCode metaDataStop ()
 Function called when the tool should write out its metadata. More...
 

Detailed Description

Definition at line 32 of file JetCalibrationTool.h.

Member Typedef Documentation

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

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ jetScale

Enumerator
EM 
LC 
PFLOW 

Definition at line 45 of file JetCalibrationTool.h.

45 { EM, LC, PFLOW };

Constructor & Destructor Documentation

◆ JetCalibrationTool()

JetCalibrationTool::JetCalibrationTool ( const std::string &  name = "JetCalibrationTool")

Constructor with parameters:

Definition at line 31 of file JetCalibrationTool.cxx.

33 {
34  declareProperty( "JetCollection", m_jetAlgo = "AntiKt4LCTopo" );
35  declareProperty( "ConfigFile", m_config = "" );
36  declareProperty( "CalibSequence", m_calibSeq = "JetArea_Offset_AbsoluteEtaJES_Insitu" );
37  declareProperty( "IsData", m_isData = true );
38  declareProperty( "ForceCampaign", m_forceCampaign = "");
39  declareProperty( "ConfigDir", m_dir = "JetCalibTools/CalibrationConfigs/" );
40  declareProperty( "EventInfoName", m_eInfoName = "EventInfo");
41  declareProperty( "DEVmode", m_devMode = false);
42  declareProperty( "OriginScale", m_originScale = "JetOriginConstitScaleMomentum");
43  declareProperty( "CalibArea", m_calibAreaTag = "00-04-82");
44  declareProperty( "GSCDepth", m_gscDepth);
45  declareProperty( "useOriginVertex", m_useOriginVertex = false);
46  // Options to force files for metadata-dependent calibration in case metadata is not available
47  declareProperty( "ForceCalibFilePtResidual", m_forceCalibFile_PtResidual = "");
48  declareProperty( "ForceCalibFileFastSim", m_forceCalibFile_FastSim = "");
49  declareProperty( "ForceCalibFileMC2MC", m_forceCalibFile_MC2MC = "");
50 }

◆ ~JetCalibrationTool()

JetCalibrationTool::~JetCalibrationTool ( )

Destructor:

Definition at line 52 of file JetCalibrationTool.cxx.

52  {
53  if(m_globalConfig) delete m_globalConfig;
54  for(TEnv* config : m_globalTimeDependentConfigs) delete config;
55  for(TEnv* config : m_globalInsituCombMassConfig) delete config;
56 }

Member Function Documentation

◆ applyCalibration()

StatusCode JetCalibrationTool::applyCalibration ( xAOD::JetContainer jets) const
overridevirtual

Apply calibration to a jet container.

Implements IJetCalibrationTool.

Definition at line 441 of file JetCalibrationTool.cxx.

441  {
442  //Grab necessary event info for pile up correction and store it in a JetEventInfo class object
443  ATH_MSG_VERBOSE("Modifying jet collection.");
444  JetEventInfo jetEventInfo;
445  ATH_CHECK( initializeEvent(jetEventInfo) );
446  for (xAOD::Jet* jet : jets) ATH_CHECK( calibrate(*jet, jetEventInfo) );
447  return StatusCode::SUCCESS;
448 }

◆ beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )
protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

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

Definition at line 201 of file AsgMetadataTool.cxx.

201  {
202 
203  // Return gracefully:
204  return StatusCode::SUCCESS;
205  }

◆ 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, TrigConf::xAODConfigTool, PMGTools::PMGTruthWeightTool, BookkeeperTool, BookkeeperDumperTool, Trig::TrigDecisionTool, xAODMaker::TriggerMenuMetaDataTool, xAODMaker::TruthMetaDataTool, Trig::xAODBunchCrossingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, and TauAnalysisTools::TauSmearingTool.

Definition at line 185 of file AsgMetadataTool.cxx.

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

◆ calibrate()

StatusCode JetCalibrationTool::calibrate ( xAOD::Jet jet,
JetEventInfo jetEventInfo 
) const
private

Definition at line 664 of file JetCalibrationTool.cxx.

664  {
665 
666  //Check for OriginCorrected and PileupCorrected attributes, assume they are false if not found
667  int tmp = 0; //temporary int for checking getAttribute
668  if ( !jet.getAttribute<int>("OriginCorrected",tmp) )
669  jet.setAttribute<int>("OriginCorrected",false);
670  if ( !jet.getAttribute<int>("PileupCorrected",tmp) )
671  jet.setAttribute<int>("PileupCorrected",false);
672 
673  ATH_MSG_VERBOSE("Calibrating jet " << jet.index());
674  if(m_doSetDetectorEta) {
675  xAOD::JetFourMom_t jetconstitP4 = jet.getAttribute<xAOD::JetFourMom_t>("JetConstitScaleMomentum");
676  jet.setAttribute<float>("DetectorEta",jetconstitP4.eta()); //saving constituent scale eta for later use
677  }
678 
679  for (unsigned int i=0; i<m_calibSteps.size(); ++i) ATH_CHECK(m_calibSteps[i]->calibrate(jet, jetEventInfo));
680 
681  return StatusCode::SUCCESS;
682 }

◆ declareGaudiProperty() [1/4]

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

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

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

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

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

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

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

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

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

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

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

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

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

Definition at line 245 of file AthCommonDataStore.h.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

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

Definition at line 221 of file AthCommonDataStore.h.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

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

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

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

Definition at line 333 of file AthCommonDataStore.h.

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

◆ declareProperty() [5/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

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

Definition at line 352 of file AthCommonDataStore.h.

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

◆ declareProperty() [6/6]

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

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

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

95 { return m_detStore; }

◆ 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 BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

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

◆ evtStore() [1/2]

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

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

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

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

Add StoreName to extra input/output deps as needed.

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

◆ getCalibClass()

StatusCode JetCalibrationTool::getCalibClass ( const TString &  calibration)
private

Definition at line 238 of file JetCalibrationTool.cxx.

238  {
239  TString jetAlgo = m_jetAlgo;
240  const TString calibPath = "CalibArea-" + m_calibAreaTag + "/";
241 
242  // Metadata needed to configure some corrections
243  TString generatorsInfo{};
244  TString simFlavour{};
245  float mcDSID{-1.0};
246  TString mcCampaign{};
247  if ( inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData") ) {
248  const xAOD::FileMetaData *fmd = nullptr;
249  ATH_CHECK(inputMetaStore()->retrieve(fmd,"FileMetaData") );
250 
251  if(m_isData){
252  UInt_t dataYear = 0;
253  fmd->value(xAOD::FileMetaData::dataYear, dataYear);
254  if (dataYear >= 2015 && dataYear <= 2018) {
255  mcCampaign = "MC20";
256  } else if (dataYear >= 2022 && dataYear <= 2024) {
257  mcCampaign = "MC23";
258  } else {
259  ATH_MSG_WARNING("Data year " << dataYear << " not recognized from file metadata. The corresponding mcCampaign will not be known.");
260  }
261 
262  } else { // is MC
263  std::string str_generatorsInfo;
264  fmd->value(xAOD::FileMetaData::generatorsInfo, str_generatorsInfo);
265  generatorsInfo = str_generatorsInfo;
266 
267  std::string str_simFlavour;
268  fmd->value(xAOD::FileMetaData::simFlavour, str_simFlavour);
269  simFlavour = str_simFlavour;
270 
271  fmd->value(xAOD::FileMetaData::mcProcID, mcDSID);
272 
273  std::string str_mcCampaign;
274  fmd->value(xAOD::FileMetaData::mcCampaign, str_mcCampaign);
275  str_mcCampaign.resize(4); //Only keep top-level of campaign (e.g. mc20 or mc23)
276  mcCampaign = str_mcCampaign;
277  mcCampaign.ToUpper();
278 
279  ATH_MSG_INFO("Have loaded metadata mcDSID:" << mcDSID << ", generatorsInfo: " << generatorsInfo << ", mcCampaign: " << mcCampaign << ", simFlavour: " << simFlavour);
280  }
281  }
282  // Force the MCCamapign (or data equivalent) for missing Metadata or tests
283  if( m_forceCampaign != "" ){
285  }
286 
287  if ( calibration.EqualTo("Bcid") ){
288  m_globalConfig->SetValue("PileupStartingScale","JetBcidScaleMomentum");
289  std::unique_ptr<JetCalibrationStep> bcidCorr = std::make_unique<BcidOffsetCorrection>(this->name()+"_Bcid", m_globalConfig, jetAlgo, calibPath, m_isData);
290  ATH_CHECK(bcidCorr->initialize());
291  m_calibSteps.push_back(std::move(bcidCorr));
292  return StatusCode::SUCCESS;
293  }
294  else if ( calibration.EqualTo("JetArea") || calibration.EqualTo("Residual") ) {
295  std::unique_ptr<JetCalibrationStep> puCorr = std::make_unique<JetPileupCorrection>(this->name()+"_Pileup", m_globalConfig, jetAlgo, calibPath,
297  puCorr->msg().setLevel( this->msg().level() );
298  ATH_CHECK(puCorr->initialize());
299  m_calibSteps.push_back(std::move(puCorr));
300  return StatusCode::SUCCESS;
301  }
302  else if ( calibration.EqualTo("EtaJES") || calibration.EqualTo("AbsoluteEtaJES") ) {
303  std::unique_ptr<JetCalibrationStep> etaJESCorr = std::make_unique<EtaJESCorrection>(this->name()+"_EtaJES", m_globalConfig, jetAlgo, calibPath, false, m_devMode);
304  etaJESCorr->msg().setLevel( this->msg().level() );
305  ATH_CHECK(etaJESCorr->initialize());
306  m_calibSteps.push_back(std::move(etaJESCorr));
307  return StatusCode::SUCCESS;
308  }
309  else if ( calibration.EqualTo("EtaMassJES") ) {
310  std::unique_ptr<JetCalibrationStep> etaJESCorr = std::make_unique<EtaJESCorrection>(this->name()+"_EtaMassJES", m_globalConfig, jetAlgo, calibPath, true, m_devMode);
311  etaJESCorr->msg().setLevel( this->msg().level() );
312  ATH_CHECK(etaJESCorr->initialize());
313  m_calibSteps.push_back(std::move(etaJESCorr));
314  return StatusCode::SUCCESS;
315  }
316  else if ( calibration.EqualTo("GSC") ) {
317  std::unique_ptr<JetCalibrationStep> gsc = std::make_unique<GlobalSequentialCorrection>(this->name()+"_GSC", m_globalConfig, jetAlgo, m_gscDepth, calibPath, m_useOriginVertex, m_devMode);
318  gsc->msg().setLevel( this->msg().level() );
319  ATH_CHECK(gsc->initialize());
320  m_calibSteps.push_back(std::move(gsc));
321 
322  // Set devMode paths for the following corrections
323  TString actualCalibPath;
324  if(m_devMode){
325  actualCalibPath = "JetCalibTools/";
326  } else {
327  actualCalibPath = "JetCalibTool/CalibArea-" + m_calibAreaTag + "/";
328  }
329  // Additional FastSim and PtResidual patches happen after GSC
330  bool do_FastSim = m_globalConfig->GetValue("JPS_FastSim.doCalibration", false) || (m_forceCalibFile_FastSim != "");
331  if(m_isData and do_FastSim){
332  ATH_MSG_WARNING("JPS_FastSim.doCalibration is set in JetCalibrationTool config but isData is set to true. Will turn off FastSim calibration.");
333  do_FastSim = false;
334  }
335  if(do_FastSim){
336  if ( (m_forceCalibFile_FastSim == "") && !inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData") ) {
337  ATH_MSG_FATAL("JPS_FastSim.doCalibration is set in JetCalibrationTool config but file has no FileMetaData. Please fix the sample or configuration.");
338  return StatusCode::FAILURE;
339  }
340  std::unique_ptr<JetCalibrationStep> JPS_FastSim = std::make_unique<Generic4VecCorrection>(this->name()+"_FastSim", m_globalConfig, jetAlgo, actualCalibPath, m_forceCalibFile_FastSim, Generic4VecCorrection::JET_CORRTYPE::FASTSIM, mcCampaign, simFlavour);
341  JPS_FastSim->msg().setLevel( this->msg().level() );
342  ATH_CHECK(JPS_FastSim->initialize());
343  m_calibSteps.push_back(std::move(JPS_FastSim));
344  }
345  bool do_PtResidual = m_globalConfig->GetValue("JPS_PtResidual.doCalibration", false) || (m_forceCalibFile_PtResidual != "");
346  if(do_PtResidual){
347  std::unique_ptr<JetCalibrationStep> JPS_PtResidual = std::make_unique<Generic4VecCorrection>(this->name()+"_PtResidual", m_globalConfig, jetAlgo, actualCalibPath, m_forceCalibFile_PtResidual, Generic4VecCorrection::JET_CORRTYPE::PTRESIDUAL, mcCampaign);
348  JPS_PtResidual->msg().setLevel( this->msg().level() );
349  ATH_CHECK(JPS_PtResidual->initialize());
350  m_calibSteps.push_back(std::move(JPS_PtResidual));
351  }
352  return StatusCode::SUCCESS;
353  }
354  else if ( calibration.EqualTo("GNNC") ) {
355  std::unique_ptr<JetCalibrationStep> gnnc = std::make_unique<GlobalNNCalibration>(this->name()+"_GNNC",m_globalConfig,jetAlgo,calibPath,m_devMode);
356  gnnc->msg().setLevel( this->msg().level() );
357  ATH_CHECK(gnnc->initialize());
358  m_calibSteps.push_back(std::move(gnnc));
359  return StatusCode::SUCCESS;
360  }
361  else if ( calibration.EqualTo("MC2MC") ) {
362  // Set devMode paths for this correction
363  TString actualCalibPath;
364  if(m_devMode){
365  actualCalibPath = "JetCalibTools/";
366  } else {
367  actualCalibPath = "JetCalibTool/CalibArea-" + m_calibAreaTag + "/";
368  }
369  if ( !inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData") && (m_forceCalibFile_MC2MC == "") ) {
370  ATH_MSG_FATAL("MC2MC step of jet calibration is requested but file has no FileMetaData. Please fix the sample or configuration.");
371  return StatusCode::FAILURE;
372  }
373  std::unique_ptr<JetCalibrationStep> JPS_MC2MC = std::make_unique<Generic4VecCorrection>(this->name()+"_MC2MC", m_globalConfig, jetAlgo, actualCalibPath, m_forceCalibFile_MC2MC, Generic4VecCorrection::JET_CORRTYPE::MC2MC, mcCampaign, simFlavour, (int) mcDSID, generatorsInfo);
374  JPS_MC2MC->msg().setLevel( this->msg().level() );
375  ATH_CHECK(JPS_MC2MC->initialize());
376  m_calibSteps.push_back(std::move(JPS_MC2MC));
377  return StatusCode::SUCCESS;
378  }
379  else if ( calibration.EqualTo("JMS") ) {
380  std::unique_ptr<JetCalibrationStep> jetMassCorr = std::make_unique<JMSCorrection>(this->name()+"_JMS", m_globalConfig, jetAlgo, calibPath, m_devMode);
381  jetMassCorr->msg().setLevel( this->msg().level() );
382  ATH_CHECK(jetMassCorr->initialize());
383  m_calibSteps.push_back(std::move(jetMassCorr));
384  return StatusCode::SUCCESS;
385  }
386  else if ( calibration.EqualTo("InsituCombinedMass") ){
387  for(unsigned int i=0;i<m_insituCombMassConfig.size();++i){
388  std::unique_ptr<JetCalibrationStep> jetMassCorr = std::make_unique<JMSCorrection>(this->name()+"_InsituCombinedMass", m_globalInsituCombMassConfig.at(i), jetAlgo, calibPath, m_devMode);
389  jetMassCorr->msg().setLevel( this->msg().level() );
390  ATH_CHECK(jetMassCorr->initialize());
391  m_calibSteps.push_back(std::move(jetMassCorr));
392  }
393  return StatusCode::SUCCESS;
394  }
395  else if ( calibration.EqualTo("Insitu") ) {
397  std::unique_ptr<JetCalibrationStep> insituDataCorr = std::make_unique<InsituDataCorrection>(this->name()+"_Insitu", m_globalConfig, jetAlgo, calibPath, m_devMode);
398  insituDataCorr->msg().setLevel( this->msg().level() );
399  ATH_CHECK(insituDataCorr->initialize());
400  m_calibSteps.push_back(std::move(insituDataCorr));
401  return StatusCode::SUCCESS;
402  }
403  else{
404  ATH_MSG_INFO("Initializing Time-Dependent Insitu Corrections");
405  for(unsigned int i=0;i<m_timeDependentInsituConfigs.size();++i){
406  // Add 0.5 before casting to avoid floating-point precision issues
407  unsigned int firstRun = static_cast<unsigned int>(m_runBins.at(i)+1.5);
408  unsigned int lastRun = static_cast<unsigned int>(m_runBins.at(i+1)+0.5);
409  std::unique_ptr<JetCalibrationStep> insituDataCorr = std::make_unique<InsituDataCorrection>(this->name()+"_Insitu_"+std::to_string(i), m_globalTimeDependentConfigs.at(i), jetAlgo,
410  calibPath, m_devMode, firstRun, lastRun);
411  insituDataCorr->msg().setLevel( this->msg().level() );
412  ATH_CHECK(insituDataCorr->initialize());
413  m_calibSteps.push_back(std::move(insituDataCorr));
414  }
415  return StatusCode::SUCCESS;
416  }
417  }
418  else if ( calibration.EqualTo("Smear") ) {
419  if(m_isData){
420  ATH_MSG_FATAL("Asked for smearing of data, which is not supported. Aborting.");
421  return StatusCode::FAILURE;
422  }
423  std::unique_ptr<JetCalibrationStep> jetSmearCorr = std::make_unique<JetSmearingCorrection>(this->name()+"_Smear", m_globalConfig,jetAlgo,calibPath,m_devMode);
424  jetSmearCorr->msg().setLevel(this->msg().level());
425  ATH_CHECK(jetSmearCorr->initialize());
426  m_calibSteps.push_back(std::move(jetSmearCorr));
427  m_smearIndex = m_calibSteps.size() - 1;
428  return StatusCode::SUCCESS;
429  }
430  else if ( calibration.EqualTo("LargeRDNN") ) {
431  std::unique_ptr<JetCalibrationStep> largeR_dnn = std::make_unique<GlobalLargeRDNNCalibration>(this->name()+"_R10DNN", m_globalConfig,calibPath,m_devMode);
432  largeR_dnn->msg().setLevel(this->msg().level());
433  ATH_CHECK(largeR_dnn->initialize());
434  m_calibSteps.push_back(std::move(largeR_dnn));
435  return StatusCode::SUCCESS;
436  }
437  ATH_MSG_FATAL("Calibration string not recognized: " << calibration << ", aborting.");
438  return StatusCode::FAILURE;
439 }

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

◆ getNominalResolutionData()

StatusCode JetCalibrationTool::getNominalResolutionData ( const xAOD::Jet jet,
double &  resolution 
) const
overridevirtual

Reimplemented from IJetCalibrationTool.

Definition at line 685 of file JetCalibrationTool.cxx.

685  {
686 
687  if(m_smearIndex < 0){
688  ATH_MSG_ERROR("Requested jet resolution without a smearing step in the CalibSequence!");
689  return StatusCode::FAILURE;
690  }
691  return m_calibSteps.at(m_smearIndex)->getNominalResolutionData(jet, resolution);
692 }

◆ getNominalResolutionHist()

StatusCode JetCalibrationTool::getNominalResolutionHist ( const xAOD::Jet jet,
double &  resolution,
const TH2D *  histo 
) const

◆ getNominalResolutionMC()

StatusCode JetCalibrationTool::getNominalResolutionMC ( const xAOD::Jet jet,
double &  resolution 
) const
overridevirtual

Reimplemented from IJetCalibrationTool.

Definition at line 694 of file JetCalibrationTool.cxx.

694  {
695 
696  if(m_smearIndex < 0){
697  ATH_MSG_ERROR("Requested jet resolution without a smearing step in the CalibSequence!");
698  return StatusCode::FAILURE;
699  }
700  return m_calibSteps.at(m_smearIndex)->getNominalResolutionMC(jet, resolution);
701 }

◆ getProperty()

template<class T >
const T* asg::AsgTool::getProperty ( const std::string &  name) const
inherited

Get one of the tool's properties.

◆ 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 ) {
142  m_beginInputFileCalled = true;
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 ) {
157  m_beginInputFileCalled = true;
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  }

◆ initialize()

StatusCode JetCalibrationTool::initialize ( )
overridevirtual

Dummy implementation of the initialisation function.

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

Reimplemented from asg::AsgTool.

Definition at line 63 of file JetCalibrationTool.cxx.

63  {
64  ATH_MSG_INFO ("Initializing " << name() << " to calibrate " << m_jetAlgo << " jets. ");
65 
66  TString jetAlgo = m_jetAlgo;
67  TString calibSeq = m_calibSeq;
68  std::string dir = m_dir;
69 
70  //Make sure the necessary properties were set via the constructor or python configuration
71  if ( jetAlgo.EqualTo("") || calibSeq.EqualTo("") ) {
72  ATH_MSG_FATAL("JetCalibrationTool::initialize : At least one of your constructor arguments is not set. Did you use the copy constructor?");
73  return StatusCode::FAILURE;
74  }
75 
76  if ( m_config.empty() ) { ATH_MSG_FATAL("No configuration file specified."); return StatusCode::FAILURE; }
77  // The calibration area tag is a property of the tool
78  const std::string calibPath = "CalibArea-" + m_calibAreaTag + "/";
79  if(m_devMode){
80  ATH_MSG_WARNING("Dev Mode is ON!!!");
81  ATH_MSG_WARNING("Dev Mode is NOT RECOMMENDED!!!");
82  dir = "JetCalibTools/";
83  }
84  else{dir.insert(14,calibPath);} // Obtaining the path of the configuration file
85  std::string configPath=dir+m_config; // Full path
86  TString fn = PathResolverFindCalibFile(configPath);
87  if(fn=="") {
88  ATH_MSG_FATAL( "Couldn't find ConfigFile " << configPath ); return StatusCode::FAILURE;
89  } else {
90  ATH_MSG_INFO("Reading global JES settings from: " << configPath);
91  ATH_MSG_INFO("resolved in: " << fn);
92  }
93 
94  m_globalConfig = new TEnv();
95  int status=m_globalConfig->ReadFile(fn ,EEnvLevel(0));
96  if (status!=0) { ATH_MSG_FATAL("Cannot read config file " << fn ); return StatusCode::FAILURE; }
97 
98  //Make sure that one of the standard jet collections is being used
99  if ( calibSeq.Contains("JetArea") ) {
100  if ( jetAlgo.Contains("PFlow") ) m_jetScale = PFLOW;
101  else if ( jetAlgo.Contains("EM") ) m_jetScale = EM;
102  else if ( jetAlgo.Contains("LC") ) m_jetScale = LC;
103  else { ATH_MSG_FATAL("jetAlgo " << jetAlgo << " not recognized."); return StatusCode::FAILURE; }
104  }
105 
106  // Settings for R21/2.5.X
107  m_originCorrectedClusters = m_globalConfig->GetValue("OriginCorrectedClusters",false);
108  m_doSetDetectorEta = m_globalConfig->GetValue("SetDetectorEta",true);
109 
110  // Rho key specified in the config file?
111  std::string rhoKey_config = m_globalConfig->GetValue("RhoKey", "None");
112 
113  bool requireRhoInput = false;
114 
115  //Make sure the residual correction is turned on if requested
116  if ( !calibSeq.Contains("JetArea") && !calibSeq.Contains("Residual") ) {
117  m_doJetArea = false;
118  m_doResidual = false;
119  } else if ( calibSeq.Contains("JetArea") ) {
120  if ( m_rhoKey.key().compare("auto") == 0 && rhoKey_config.compare("None") == 0) {
122  if ( m_jetScale == EM ) m_rhoKey = "Kt4EMTopoEventShape";
123  else if ( m_jetScale == LC ) m_rhoKey = "Kt4LCTopoEventShape";
124  else if ( m_jetScale == PFLOW ) m_rhoKey = "Kt4EMPFlowEventShape";
125  } else{
126  if ( m_jetScale == EM ) m_rhoKey = "Kt4EMTopoOriginEventShape";
127  else if ( m_jetScale == LC ) m_rhoKey = "Kt4LCTopoOriginEventShape";
128  else if ( m_jetScale == PFLOW ) m_rhoKey = "Kt4EMPFlowEventShape";
129  }
130  }
131  else if(rhoKey_config.compare("None") != 0 && m_rhoKey.key().compare("auto") == 0){
132  m_rhoKey = rhoKey_config;
133  }
134  requireRhoInput = true;
135  if ( !calibSeq.Contains("Residual") ) m_doResidual = false;
136  } else if ( !calibSeq.Contains("JetArea") && calibSeq.Contains("Residual") ) {
137  m_doJetArea = false;
138  ATH_MSG_INFO("ApplyOnlyResidual should be true if only Residual pile up correction wants to be applied. Need to specify pile up starting scale in the configuration file.");
139  }
140  // get nJet threshold and name
141  m_useNjetInResidual = m_globalConfig->GetValue("OffsetCorrection.UseNjet", false);
142  m_nJetThreshold = m_globalConfig->GetValue("OffsetCorrection.nJetThreshold", 20);
143  m_nJetContainerName = m_globalConfig->GetValue("OffsetCorrection.nJetContainerName",
144  "HLT_xAOD__JetContainer_a4tcemsubjesISFS");
145 
146  if ( !calibSeq.Contains("Origin") ) m_doOrigin = false;
147  if ( !calibSeq.Contains("GSC") && !calibSeq.Contains("GNNC")) m_doGSC = false;
148  if ( !calibSeq.Contains("Bcid") ) m_doBcid = false;
149  if ( calibSeq.Contains("DNN") ) m_doDNNCal = true;
150 
151  //Protect against the in-situ calibration being requested when isData is false
152  if ( calibSeq.Contains("Insitu") && !m_isData ) {
153  ATH_MSG_FATAL("JetCalibrationTool::initialize : calibSeq string contains Insitu with isData set to false. Can't apply in-situ correction to MC!!");
154  return StatusCode::FAILURE;
155  }
156 
157  // Time-Dependent Insitu Calibration
158  m_timeDependentCalib = m_globalConfig->GetValue("TimeDependentInsituCalibration",false);
159  if(m_timeDependentCalib && calibSeq.Contains("Insitu")){ // Read Insitu Configs
160  m_timeDependentInsituConfigs = JetCalibUtils::Vectorize( m_globalConfig->GetValue("InsituTimeDependentConfigs","") );
161  if(m_timeDependentInsituConfigs.empty()) ATH_MSG_ERROR("Please check there are at least two insitu configs");
162  m_runBins = JetCalibUtils::VectorizeD( m_globalConfig->GetValue("InsituRunBins","") );
163  if(m_runBins.size()!=m_timeDependentInsituConfigs.size()+1) ATH_MSG_ERROR("Please check the insitu run bins");
164  for(unsigned int i=0;i<m_timeDependentInsituConfigs.size();++i){
165 
166  std::string configPath_insitu = dir+m_timeDependentInsituConfigs.at(i).Data(); // Full path
167  TString fn_insitu = PathResolverFindCalibFile(configPath_insitu);
168 
169  ATH_MSG_INFO("Reading time-dependent insitu settings from: " << m_timeDependentInsituConfigs.at(i));
170  ATH_MSG_INFO("resolved in: " << fn_insitu);
171 
172  TEnv *globalConfig_insitu = new TEnv();
173  int status = globalConfig_insitu->ReadFile(fn_insitu ,EEnvLevel(0));
174  if (status!=0) { ATH_MSG_FATAL("Cannot read config file " << fn_insitu ); return StatusCode::FAILURE; }
175  m_globalTimeDependentConfigs.push_back(globalConfig_insitu);
176  }
177  }
178 
179  //Combined Mass Calibration:
180  m_insituCombMassCalib = m_globalConfig->GetValue("InsituCombinedMassCorrection",false);
181  if(m_insituCombMassCalib && calibSeq.Contains("InsituCombinedMass")){ // Read Combination Config
182  m_insituCombMassConfig = JetCalibUtils::Vectorize( m_globalConfig->GetValue("InsituCombinedMassCorrectionFile","") );
183  if(m_insituCombMassConfig.empty()) ATH_MSG_ERROR("Please check there is a combination config");
184  for(unsigned int i=0;i<m_insituCombMassConfig.size();++i){
185 
186  std::string configPath_comb = dir+m_insituCombMassConfig.at(i).Data(); // Full path
187  TString fn_comb = PathResolverFindCalibFile(configPath_comb);
188 
189  ATH_MSG_INFO("Reading combination settings from: " << m_insituCombMassConfig.at(i));
190  ATH_MSG_INFO("resolved in: " << fn_comb);
191 
192  TEnv *globalInsituCombMass = new TEnv();
193  int status = globalInsituCombMass->ReadFile(fn_comb ,EEnvLevel(0));
194  if (status!=0) { ATH_MSG_FATAL("Cannot read config file " << fn_comb ); return StatusCode::FAILURE; }
195  m_globalInsituCombMassConfig.push_back(globalInsituCombMass);
196  }
197  }
198 
199  //Loop over the request calib sequence
200  //Initialize derived classes for applying the requested calibrations and add them to a vector
201  std::vector<TString> vecCalibSeq = JetCalibUtils::Vectorize(calibSeq,"_");
202  for ( unsigned int i=0; i<vecCalibSeq.size(); ++i) {
203  if ( vecCalibSeq[i].EqualTo("Origin") || vecCalibSeq[i].EqualTo("DEV") ) continue;
204  if ( vecCalibSeq[i].EqualTo("Residual") && m_doJetArea ) continue;
205  ATH_CHECK( getCalibClass(vecCalibSeq[i] ));
206  }
207 
208  // Initialise ReadHandle(s)
210  ATH_CHECK( m_muKey.initialize() );
211  ATH_CHECK( m_actualMuKey.initialize() );
212  ATH_CHECK( m_rhoKey.initialize(requireRhoInput) );
213  if(m_pvKey.empty()) {
214  // No PV key: -- check if it is required
215  if(m_doResidual) {
216  // May require modification in case of residual that does not require NPV
217  ATH_MSG_ERROR("Residual calibration requested but no primary vertex container specified!");
218  return StatusCode::FAILURE;
219  }
220  else if(m_doGSC) {
221  if(m_jetAlgo.find("PFlow")!=std::string::npos) {
222  ATH_MSG_ERROR("GSC calibration for PFlow requested but no primary vertex container specified!");
223  return StatusCode::FAILURE;
224  }
225  else if((m_gscDepth!="Tile0" && m_gscDepth!="EM3")) {
226  ATH_MSG_ERROR("GSC calibration with tracks requested but no primary vertex container specified!");
227  return StatusCode::FAILURE;
228  }
229  }
230  } else {
231  // Received a PV key, declare the data dependency
232  ATH_CHECK( m_pvKey.initialize() );
233  }
234  return StatusCode::SUCCESS;
235 }

◆ initializeEvent()

StatusCode JetCalibrationTool::initializeEvent ( JetEventInfo jetEventInfo) const
private

Definition at line 453 of file JetCalibrationTool.cxx.

453  {
454 
455  // Check if the tool was initialized
456  if( m_calibSteps.empty() ){
457  ATH_MSG_FATAL(" JetCalibrationTool::initializeEvent : The tool was not initialized.");
458  return StatusCode::FAILURE;
459  }
460 
461  // static accessor for PV index access
462  static const SG::AuxElement::ConstAccessor<int> PVIndexAccessor("PVIndex");
463 
464  ATH_MSG_VERBOSE("Initializing event.");
465 
466  if( m_doJetArea ) {
467  //Determine the rho value to use for the jet area subtraction
468  //Should be determined using EventShape object, use hard coded values if EventShape doesn't exist
469  double rho=0;
470  const xAOD::EventShape * eventShape = nullptr;
471 
473 
474  if ( rhRhoKey.isValid() ) {
475  ATH_MSG_VERBOSE(" Found event density container " << m_rhoKey.key());
476  eventShape = rhRhoKey.cptr();
477  if ( !rhRhoKey.isValid() ) {
478  ATH_MSG_VERBOSE(" Event shape container not found.");
479  ATH_MSG_FATAL("Could not retrieve the xAOD::EventShape container " << m_rhoKey.key() << " from the input file");
480  return StatusCode::FAILURE;
481  } else if ( !eventShape->getDensity( xAOD::EventShape::Density, rho ) ) {
482  ATH_MSG_VERBOSE(" Event density not found in container.");
483  ATH_MSG_FATAL("Could not retrieve the xAOD::EventShape::Density variable from " << m_rhoKey.key());
484  return StatusCode::FAILURE;
485  } else {
486  ATH_MSG_VERBOSE(" Event density retrieved.");
487  }
488  } else if ( m_doJetArea && !rhRhoKey.isValid() ) {
489  ATH_MSG_VERBOSE(" Rho container not found: " << m_rhoKey.key());
490  ATH_MSG_FATAL("Could not retrieve xAOD::EventShape container " << m_rhoKey.key() << " from the input file");
491  return StatusCode::FAILURE;
492  }
493  jetEventInfo.setRho(rho);
494  ATH_MSG_VERBOSE(" Rho = " << 0.001*rho << " GeV");
495 
496  // Necessary retrieval and calculation for use of nJetX instead of NPV
497  if(m_useNjetInResidual) {
498  // retrieve the container
499  const xAOD::JetContainer * jets = nullptr;
500  if (evtStore()->contains<xAOD::JetContainer>(m_nJetContainerName) ) {
501  ATH_MSG_VERBOSE(" Found jet container " << m_nJetContainerName);
502  if ( evtStore()->retrieve(jets, m_nJetContainerName).isFailure() || !jets ) {
503  ATH_MSG_FATAL("Could not retrieve xAOD::JetContainer " << m_nJetContainerName << " from evtStore");
504  return StatusCode::FAILURE;
505  }
506  } else {
507  ATH_MSG_FATAL("Could not find jet container " << m_nJetContainerName << " in the evtStore");
508  return StatusCode::FAILURE;
509  }
510 
511  // count jets above threshold
512  int nJets = 0;
513  for (const auto *jet : *jets) {
514  if(jet->pt()/1000. > m_nJetThreshold)
515  nJets += 1;
516  }
517  jetEventInfo.setNjet(nJets);
518  }
519  }
520 
521  // Retrieve EventInfo object, which now has multiple uses
523  const xAOD::EventInfo * eventObj = nullptr;
524  static std::atomic<unsigned int> eventInfoWarnings = 0;
526  if ( rhEvtInfo.isValid() ) {
527  eventObj = rhEvtInfo.cptr();
528  } else {
529  ++eventInfoWarnings;
530  if ( eventInfoWarnings < 20 )
531  ATH_MSG_ERROR(" JetCalibrationTool::initializeEvent : Failed to retrieve event information.");
532  jetEventInfo.setMu(0); //Hard coded value mu = 0 in case of failure (to prevent seg faults later).
533  jetEventInfo.setPVIndex(0);
534  return StatusCode::SUCCESS; //error is recoverable, so return SUCCESS
535  }
536  jetEventInfo.setRunNumber( eventObj->runNumber() );
537 
538  // If we are applying the reisdual, then store mu
539  if (m_doResidual || m_doBcid) {
541  if(!eventInfoDecor.isPresent()) {
542  ATH_MSG_ERROR("EventInfo decoration not available!");
543  return StatusCode::FAILURE;
544  }
545  jetEventInfo.setMu( eventInfoDecor(0) );
546  }
547 
548  // If this is GSC, we need EventInfo to determine the PV to use
549  // This is support for groups where PV0 is not the vertex of interest (H->gamgam, etc)
550  if (m_doGSC)
551  {
552  // First retrieve the PVIndex if specified
553  // Default is to not specify this, so no warning if it doesn't exist
554  // However, if specified, it should be a sane value - fail if not
555  if ( m_doGSC && PVIndexAccessor.isAvailable(*eventObj) )
556  jetEventInfo.setPVIndex( PVIndexAccessor(*eventObj) );
557  else{
558  if(!m_pvKey.empty()){
559  const xAOD::VertexContainer * vertices = nullptr;
561  if (rhPV.isValid()) {
562  vertices = rhPV.cptr();
563  xAOD::VertexContainer::const_iterator vtx_itr = vertices->begin();
564  xAOD::VertexContainer::const_iterator vtx_end = vertices->end();
565  for ( ; vtx_itr != vtx_end; ++vtx_itr ){
566  if ( (*vtx_itr)->vertexType() == xAOD::VxType::PriVtx ){
567  jetEventInfo.setPVIndex((*vtx_itr)->index());
568  break;
569  }
570  }
571  }
572  else{
573  jetEventInfo.setPVIndex(0);
574  }
575  }
576  else{
577  jetEventInfo.setPVIndex(0);
578  }
579  }
580  }
581 
582  // Extract the BCID information for the BCID correction
583  if (m_doBcid)
584  {
585  static const SG::ConstAccessor<int> BCIDDistanceFromFrontAcc ("DFCommonJets_BCIDDistanceFromFront");
586  static const SG::ConstAccessor<int> BCIDGapBeforeTrainAcc ("DFCommonJets_BCIDGapBeforeTrain");
587  static const SG::ConstAccessor<int> BCIDGapBeforeTrainMinus12Acc ("DFCommonJets_BCIDGapBeforeTrainMinus12");
588 
589  jetEventInfo.setBcidDistanceFromFront( BCIDDistanceFromFrontAcc (*eventObj) );
590  jetEventInfo.setBcidGapBeforeTrain( BCIDGapBeforeTrainAcc (*eventObj) );
591  jetEventInfo.setBcidGapBeforeTrainMinus12( BCIDGapBeforeTrainMinus12Acc (*eventObj) );
592  }
593 
594  // If PV index is not zero, we need to confirm it's a reasonable value
595  // To do this, we need the primary vertices
596  // However, other users of the GSC may not have the PV collection (in particular: trigger GSC in 2016)
597  // So only retrieve vertices if needed for NPV (residual) or a non-zero PV index was specified (GSC)
598  if ((m_doResidual && !m_useNjetInResidual) || (m_doGSC && jetEventInfo.PVIndex()))
599  {
600  //Retrieve VertexContainer object, use it to obtain NPV for the residual correction or check validity of GSC non-PV0 usage
601  const xAOD::VertexContainer * vertices = nullptr;
602 
604  if (rhPV.isValid()) {
605  vertices = rhPV.cptr();
606  } else {
607  ATH_MSG_WARNING(" JetCalibrationTool::initializeEvent : Failed to retrieve primary vertices.");
608  jetEventInfo.setNPV(0); //Hard coded value NPV = 0 in case of failure (to prevent seg faults later).
609  return StatusCode::SUCCESS; //error is recoverable, so return SUCCESS
610  }
611 
612  // Calculate and set NPV if this is residual
613  if (m_doResidual)
614  {
615  int eventNPV = 0;
616  eventNPV = std::count_if(vertices->begin(), vertices->end(), [](const xAOD::Vertex* vtx){ return vtx->vertexType() == xAOD::VxType::PileUp || vtx->vertexType() == xAOD::VxType::PriVtx;});
617  jetEventInfo.setNPV(eventNPV);
618  }
619 
620  // Validate value of non-standard PV index usage
621  if (m_doGSC && jetEventInfo.PVIndex())
622  {
623  static std::atomic<unsigned int> vertexIndexWarnings = 0;
624  if (jetEventInfo.PVIndex() < 0 || static_cast<size_t>(jetEventInfo.PVIndex()) >= vertices->size())
625  {
626  ++vertexIndexWarnings;
627  if (vertexIndexWarnings < 20)
628  ATH_MSG_WARNING(" JetCalibrationTool::initializeEvent : PV index is out of bounds.");
629  jetEventInfo.setPVIndex(0); // Hard coded value PVIndex = 0 in case of failure (to prevent seg faults later).
630  return StatusCode::SUCCESS; // error is recoverable, so return SUCCESS
631  }
632  }
633  }
634  } else if (m_doDNNCal) {
635  // retrieve mu and NPV only from eventInfo
636  static std::atomic<unsigned int> eventInfoWarningsMu = 0;
638  if ( rhEvtInfo.isValid() ) {
640  jetEventInfo.setMu(eventInfoDecor(0));
641  } else {
642  ++eventInfoWarningsMu;
643  if ( eventInfoWarningsMu < 20 ) ATH_MSG_WARNING(" JetCalibrationTool::initializeEvent : Failed to retrieve event information.");
644  jetEventInfo.setMu(0); //Hard coded value mu = 0 in case of failure (to prevent seg faults later).
645  }
646 
647  static std::atomic<unsigned int> eventInfoWarningsPV = 0;
648  const xAOD::VertexContainer * vertices = nullptr;
650  if (rhPV.isValid()) {
651  vertices = rhPV.cptr();
652  int eventNPV = 0;
653  eventNPV = std::count_if(vertices->begin(), vertices->end(), [](const xAOD::Vertex* vtx){ return vtx->vertexType() == xAOD::VxType::PileUp || vtx->vertexType() == xAOD::VxType::PriVtx;});
654  jetEventInfo.setNPV(eventNPV);
655  } else {
656  ++eventInfoWarningsPV;
657  if ( eventInfoWarningsPV < 20 ) ATH_MSG_WARNING(" JetCalibrationTool::initializeEvent : Failed to retrieve primary vertices.");
658  jetEventInfo.setNPV(0); //Hard coded value NPV = 0 in case of failure (to prevent seg faults later).
659  }
660  }
661  return StatusCode::SUCCESS;
662 }

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

◆ 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 BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

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

◆ modify()

virtual StatusCode IJetCalibrationTool::modify ( xAOD::JetContainer jets) const
inlinefinaloverridevirtualinherited

Apply calibration to a jet container (for IJetModifier interface).

Implements IJetModifier.

Definition at line 33 of file IJetCalibrationTool.h.

33 {return applyCalibration(jets);}

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

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

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

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

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

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

◆ print()

void asg::AsgTool::print ( ) const
virtualinherited

◆ 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();
383  PBASE::renounce (h);
384  }

◆ 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  {
365  handlesArray.renounce();
366  }

◆ setUseIncidents()

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

Definition at line 132 of file AsgMetadataTool.h.

133  {
135  }

◆ 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) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_actualMuKey

SG::ReadDecorHandleKey<xAOD::EventInfo> JetCalibrationTool::m_actualMuKey
private
Initial value:
{this, "actualInteractionsPerCrossing",
"EventInfo.actualInteractionsPerCrossing","Decoration for Actual Number of Interactions Per Crossing"}

Definition at line 70 of file JetCalibrationTool.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_calibAreaTag

std::string JetCalibrationTool::m_calibAreaTag
private

Definition at line 77 of file JetCalibrationTool.h.

◆ m_calibSeq

std::string JetCalibrationTool::m_calibSeq
private

Definition at line 76 of file JetCalibrationTool.h.

◆ m_calibSteps

std::vector<std::unique_ptr<JetCalibrationStep> > JetCalibrationTool::m_calibSteps
private

Definition at line 114 of file JetCalibrationTool.h.

◆ m_config

std::string JetCalibrationTool::m_config
private

Definition at line 75 of file JetCalibrationTool.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_devMode

bool JetCalibrationTool::m_devMode {}
private

Definition at line 79 of file JetCalibrationTool.h.

◆ m_dir

std::string JetCalibrationTool::m_dir
private

Definition at line 87 of file JetCalibrationTool.h.

◆ m_doBcid

bool JetCalibrationTool::m_doBcid {true}
private

Definition at line 105 of file JetCalibrationTool.h.

◆ m_doDNNCal

bool JetCalibrationTool::m_doDNNCal {}
private

Definition at line 110 of file JetCalibrationTool.h.

◆ m_doGSC

bool JetCalibrationTool::m_doGSC {true}
private

Definition at line 109 of file JetCalibrationTool.h.

◆ m_doJetArea

bool JetCalibrationTool::m_doJetArea {true}
private

Definition at line 106 of file JetCalibrationTool.h.

◆ m_doOrigin

bool JetCalibrationTool::m_doOrigin {true}
private

Definition at line 108 of file JetCalibrationTool.h.

◆ m_doResidual

bool JetCalibrationTool::m_doResidual {true}
private

Definition at line 107 of file JetCalibrationTool.h.

◆ m_doSetDetectorEta

bool JetCalibrationTool::m_doSetDetectorEta {}
private

Definition at line 91 of file JetCalibrationTool.h.

◆ m_eInfoName

std::string JetCalibrationTool::m_eInfoName
private

Definition at line 88 of file JetCalibrationTool.h.

◆ m_evtInfoKey

SG::ReadHandleKey<xAOD::EventInfo> JetCalibrationTool::m_evtInfoKey {this, "EventInfoKey", "EventInfo"}
private

Definition at line 65 of file JetCalibrationTool.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_forceCalibFile_FastSim

std::string JetCalibrationTool::m_forceCalibFile_FastSim {}
private

Definition at line 95 of file JetCalibrationTool.h.

◆ m_forceCalibFile_MC2MC

std::string JetCalibrationTool::m_forceCalibFile_MC2MC {}
private

Definition at line 96 of file JetCalibrationTool.h.

◆ m_forceCalibFile_PtResidual

std::string JetCalibrationTool::m_forceCalibFile_PtResidual {}
private

Definition at line 94 of file JetCalibrationTool.h.

◆ m_forceCampaign

std::string JetCalibrationTool::m_forceCampaign {}
private

Definition at line 81 of file JetCalibrationTool.h.

◆ m_globalConfig

TEnv* JetCalibrationTool::m_globalConfig {}
private

Definition at line 99 of file JetCalibrationTool.h.

◆ m_globalInsituCombMassConfig

std::vector<TEnv*> JetCalibrationTool::m_globalInsituCombMassConfig
private

Definition at line 101 of file JetCalibrationTool.h.

◆ m_globalTimeDependentConfigs

std::vector<TEnv*> JetCalibrationTool::m_globalTimeDependentConfigs
private

Definition at line 100 of file JetCalibrationTool.h.

◆ m_gscDepth

std::string JetCalibrationTool::m_gscDepth {"auto"}
private

Definition at line 112 of file JetCalibrationTool.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_insituCombMassCalib

bool JetCalibrationTool::m_insituCombMassCalib {}
private

Definition at line 92 of file JetCalibrationTool.h.

◆ m_insituCombMassConfig

std::vector<TString> JetCalibrationTool::m_insituCombMassConfig
private

Definition at line 93 of file JetCalibrationTool.h.

◆ m_isData

bool JetCalibrationTool::m_isData {true}
private

Definition at line 80 of file JetCalibrationTool.h.

◆ m_jetAlgo

std::string JetCalibrationTool::m_jetAlgo
private

Definition at line 74 of file JetCalibrationTool.h.

◆ m_jetScale

jetScale JetCalibrationTool::m_jetScale = jetScale::EM
private

Definition at line 104 of file JetCalibrationTool.h.

◆ m_muKey

SG::ReadDecorHandleKey<xAOD::EventInfo> JetCalibrationTool::m_muKey
private
Initial value:
{this, "averageInteractionsPerCrossingKey",
"EventInfo.averageInteractionsPerCrossing","Decoration for Average Interaction Per Crossing"}

Definition at line 68 of file JetCalibrationTool.h.

◆ m_nJetContainerName

std::string JetCalibrationTool::m_nJetContainerName
private

Definition at line 86 of file JetCalibrationTool.h.

◆ m_nJetThreshold

float JetCalibrationTool::m_nJetThreshold {}
private

Definition at line 85 of file JetCalibrationTool.h.

◆ m_originCorrectedClusters

bool JetCalibrationTool::m_originCorrectedClusters {}
private

Definition at line 83 of file JetCalibrationTool.h.

◆ m_originScale

std::string JetCalibrationTool::m_originScale
private

Definition at line 78 of file JetCalibrationTool.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore
privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_pvKey

SG::ReadHandleKey<xAOD::VertexContainer> JetCalibrationTool::m_pvKey {this, "PrimaryVerticesContainerName", "PrimaryVertices"}
private

Definition at line 67 of file JetCalibrationTool.h.

◆ m_rhoKey

SG::ReadHandleKey<xAOD::EventShape> JetCalibrationTool::m_rhoKey {this, "RhoKey", "auto"}
private

Definition at line 66 of file JetCalibrationTool.h.

◆ m_runBins

std::vector<double> JetCalibrationTool::m_runBins
private

Definition at line 90 of file JetCalibrationTool.h.

◆ m_smearIndex

int JetCalibrationTool::m_smearIndex {-1}
private

Definition at line 115 of file JetCalibrationTool.h.

◆ m_timeDependentCalib

bool JetCalibrationTool::m_timeDependentCalib {}
private

Definition at line 82 of file JetCalibrationTool.h.

◆ m_timeDependentInsituConfigs

std::vector<TString> JetCalibrationTool::m_timeDependentInsituConfigs
private

Definition at line 89 of file JetCalibrationTool.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents
privateinherited

Definition at line 128 of file AsgMetadataTool.h.

◆ m_useNjetInResidual

bool JetCalibrationTool::m_useNjetInResidual {}
private

Definition at line 84 of file JetCalibrationTool.h.

◆ m_useOriginVertex

bool JetCalibrationTool::m_useOriginVertex {}
private

Definition at line 118 of file JetCalibrationTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
xAOD::EventShape_v1::getDensity
bool getDensity(EventDensityID id, double &v) const
Get a density variable from the object.
Definition: EventShape_v1.cxx:135
JetEventInfo::setBcidDistanceFromFront
void setBcidDistanceFromFront(Int_t BcidDistanceFromFront)
Definition: JetEventInfo.h:21
JetCalibrationTool::m_doResidual
bool m_doResidual
Definition: JetCalibrationTool.h:107
ATH_MSG_FATAL
#define ATH_MSG_FATAL(x)
Definition: AthMsgStreamMacros.h:34
DataModel_detail::const_iterator
Const iterator class for DataVector/DataList.
Definition: DVLIterator.h:82
JetCalibrationTool::m_smearIndex
int m_smearIndex
Definition: JetCalibrationTool.h:115
JetCalibrationTool::m_originCorrectedClusters
bool m_originCorrectedClusters
Definition: JetCalibrationTool.h:83
asg::AsgMetadataTool::beginEvent
virtual StatusCode beginEvent()
Function called when a new events is loaded.
Definition: AsgMetadataTool.cxx:201
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:407
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
JetEventInfo::PVIndex
int PVIndex()
Definition: JetEventInfo.h:30
JetCalibrationTool::m_jetAlgo
std::string m_jetAlgo
Definition: JetCalibrationTool.h:74
JetCalibrationTool::LC
@ LC
Definition: JetCalibrationTool.h:45
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:67
JetCalibrationTool::m_timeDependentInsituConfigs
std::vector< TString > m_timeDependentInsituConfigs
Definition: JetCalibrationTool.h:89
JetCalibrationTool::m_muKey
SG::ReadDecorHandleKey< xAOD::EventInfo > m_muKey
Definition: JetCalibrationTool.h:68
JetCalibrationTool::m_isData
bool m_isData
Definition: JetCalibrationTool.h:80
python.base_data.config
config
Definition: base_data.py:20
JetCalibrationTool::EM
@ EM
Definition: JetCalibrationTool.h:45
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
defineDB.jets
jets
Definition: JetTagCalibration/share/defineDB.py:24
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
JetEventInfo::setRho
void setRho(double rho)
Definition: JetEventInfo.h:15
asg::AsgMetadataTool::inputMetaStore
MetaStorePtr_t inputMetaStore() const
Accessor for the input metadata store.
Definition: AsgMetadataTool.cxx:93
JetCalibrationTool::m_gscDepth
std::string m_gscDepth
Definition: JetCalibrationTool.h:112
JetCalibrationTool::getCalibClass
StatusCode getCalibClass(const TString &calibration)
Definition: JetCalibrationTool.cxx:238
JetCalibrationTool::m_forceCampaign
std::string m_forceCampaign
Definition: JetCalibrationTool.h:81
JetCalibrationTool::m_rhoKey
SG::ReadHandleKey< xAOD::EventShape > m_rhoKey
Definition: JetCalibrationTool.h:66
JetCalibrationTool::calibrate
StatusCode calibrate(xAOD::Jet &jet, JetEventInfo &jetEventInfo) const
Definition: JetCalibrationTool.cxx:664
JetCalibrationTool::m_devMode
bool m_devMode
Definition: JetCalibrationTool.h:79
asg::AsgMetadataTool::m_beginInputFileCalled
bool m_beginInputFileCalled
Flag helping to discover when the tool misses the opening of the first input file.
Definition: AsgMetadataTool.h:126
SG::ConstAccessor
Helper class to provide constant type-safe access to aux data.
Definition: ConstAccessor.h:55
asg::AsgMetadataTool::endInputFile
virtual StatusCode endInputFile()
Function called when the currently open input file got completely processed.
Definition: AsgMetadataTool.cxx:193
asg::AsgMetadataTool::m_outputMetaStore
MetaStore_t m_outputMetaStore
Object accessing the output metadata store.
Definition: AsgMetadataTool.h:121
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
JetEventInfo::setBcidGapBeforeTrain
void setBcidGapBeforeTrain(Int_t BcidGapBeforeTrain)
Definition: JetEventInfo.h:22
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
dbg::ptr
void * ptr(T *p)
Definition: SGImplSvc.cxx:74
MuonR4::to_string
std::string to_string(const SectorProjector proj)
Definition: MsTrackSeeder.cxx:66
Dedxcorrection::resolution
double resolution[nGasTypes][nParametersResolution]
Definition: TRT_ToT_Corrections.h:46
JetCalibrationTool::m_runBins
std::vector< double > m_runBins
Definition: JetCalibrationTool.h:90
JetCalibUtils::Vectorize
StrV Vectorize(const TString &str, const TString &sep=" ")
Definition: JetCalibUtils.cxx:14
xAOD::EventInfo_v1::runNumber
uint32_t runNumber() const
The current event's run number.
config
Definition: PhysicsAnalysis/AnalysisCommon/AssociationUtils/python/config.py:1
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
JetCalibrationTool::m_doJetArea
bool m_doJetArea
Definition: JetCalibrationTool.h:106
JetCalibrationStep::initialize
virtual StatusCode initialize()=0
xAOD::FileMetaData_v1::value
bool value(MetaDataType type, std::string &val) const
Get a pre-defined string value out of the object.
Definition: FileMetaData_v1.cxx:195
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
JetCalibrationTool::m_pvKey
SG::ReadHandleKey< xAOD::VertexContainer > m_pvKey
Definition: JetCalibrationTool.h:67
xAOD::FileMetaData_v1::simFlavour
@ simFlavour
Fast or Full sim [string].
Definition: FileMetaData_v1.h:76
JetEventInfo::setBcidGapBeforeTrainMinus12
void setBcidGapBeforeTrainMinus12(Int_t BcidGapBeforeTrainMinus12)
Definition: JetEventInfo.h:23
JetCalibrationTool::initializeEvent
StatusCode initializeEvent(JetEventInfo &jetEventInfo) const
Definition: JetCalibrationTool.cxx:453
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
JetCalibrationTool::m_globalConfig
TEnv * m_globalConfig
Definition: JetCalibrationTool.h:99
JetCalibrationTool::m_insituCombMassConfig
std::vector< TString > m_insituCombMassConfig
Definition: JetCalibrationTool.h:93
xAOD::EventShape_v1::Density
@ Density
Definition: EventShape_v1.h:47
JetEventInfo::setNjet
void setNjet(double nJet)
Definition: JetEventInfo.h:18
JetEventInfo
Definition: JetEventInfo.h:8
xAOD::FileMetaData_v1::mcCampaign
@ mcCampaign
MC campaign [string].
Definition: FileMetaData_v1.h:80
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
JetCalibrationTool::PFLOW
@ PFLOW
Definition: JetCalibrationTool.h:45
JetCalibrationTool::m_nJetThreshold
float m_nJetThreshold
Definition: JetCalibrationTool.h:85
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:209
jet
Definition: JetCalibTools_PlotJESFactors.cxx:23
python.getCurrentFolderTag.fn
fn
Definition: getCurrentFolderTag.py:79
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
SG::ReadDecorHandle
Handle class for reading a decoration on an object.
Definition: StoreGate/StoreGate/ReadDecorHandle.h:94
JetCalibrationTool::m_dir
std::string m_dir
Definition: JetCalibrationTool.h:87
lumiFormat.i
int i
Definition: lumiFormat.py:85
JetCalibrationTool::m_calibAreaTag
std::string m_calibAreaTag
Definition: JetCalibrationTool.h:77
JetCalibrationTool::m_forceCalibFile_FastSim
std::string m_forceCalibFile_FastSim
Definition: JetCalibrationTool.h:95
JetCalibrationTool::m_eInfoName
std::string m_eInfoName
Definition: JetCalibrationTool.h:88
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
Definition: AthCommonDataStore.h:145
TestSUSYToolsAlg.mcCampaign
mcCampaign
Definition: TestSUSYToolsAlg.py:134
asg::AsgMetadataTool::beginInputFile
virtual StatusCode beginInputFile()
Function called when a new input file is opened.
Definition: AsgMetadataTool.cxx:185
JetCalibrationTool::m_nJetContainerName
std::string m_nJetContainerName
Definition: JetCalibrationTool.h:86
master.flag
bool flag
Definition: master.py:29
xAOD::VxType::PriVtx
@ PriVtx
Primary vertex.
Definition: TrackingPrimitives.h:572
CalibDbCompareRT.dummy
dummy
Definition: CalibDbCompareRT.py:59
asg::AsgMessaging::msg
MsgStream & msg() const
The standard message stream.
Definition: AsgMessaging.cxx:49
asg::AsgMetadataTool::metaDataStop
virtual StatusCode metaDataStop()
Function called when the tool should write out its metadata.
Definition: AsgMetadataTool.cxx:209
JetCalibrationTool::m_evtInfoKey
SG::ReadHandleKey< xAOD::EventInfo > m_evtInfoKey
Definition: JetCalibrationTool.h:65
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
JetCalibrationTool::m_doSetDetectorEta
bool m_doSetDetectorEta
Definition: JetCalibrationTool.h:91
JetCalibrationTool::m_originScale
std::string m_originScale
Definition: JetCalibrationTool.h:78
xAOD::FileMetaData_v1::mcProcID
@ mcProcID
Same as mc_channel_number [float].
Definition: FileMetaData_v1.h:74
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
SG::VarHandleKey::initialize
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:103
DeMoUpdate.tmp
string tmp
Definition: DeMoUpdate.py:1167
JetEventInfo::setNPV
void setNPV(double NPV)
Definition: JetEventInfo.h:17
DataVector
Derived DataVector<T>.
Definition: DataVector.h:795
JetCalibrationTool::m_forceCalibFile_MC2MC
std::string m_forceCalibFile_MC2MC
Definition: JetCalibrationTool.h:96
xAOD::FileMetaData_v1
Class holding file-level metadata about an xAOD file.
Definition: FileMetaData_v1.h:34
xAOD::EventShape_v1
Data class for event shapes.
Definition: EventShape_v1.h:28
beamspotman.dir
string dir
Definition: beamspotman.py:619
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
xAOD::JetFourMom_t
ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > JetFourMom_t
Base 4 Momentum type for Jet.
Definition: JetTypes.h:17
JetEventInfo::setPVIndex
void setPVIndex(int PVindex)
Definition: JetEventInfo.h:19
JetCalibrationTool::m_actualMuKey
SG::ReadDecorHandleKey< xAOD::EventInfo > m_actualMuKey
Definition: JetCalibrationTool.h:70
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
asg::AsgMetadataTool::m_inputMetaStore
MetaStore_t m_inputMetaStore
Object accessing the input metadata store.
Definition: AsgMetadataTool.h:119
JetCalibrationTool::m_jetScale
jetScale m_jetScale
Definition: JetCalibrationTool.h:104
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
JetCalibrationTool::m_config
std::string m_config
Definition: JetCalibrationTool.h:75
JetCalibrationTool::m_globalTimeDependentConfigs
std::vector< TEnv * > m_globalTimeDependentConfigs
Definition: JetCalibrationTool.h:100
xAOD::EventInfo_v1
Class describing the basic event information.
Definition: EventInfo_v1.h:43
PathResolverFindCalibFile
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
Definition: PathResolver.cxx:321
DataVector::end
const_iterator end() const noexcept
Return a const_iterator pointing past the end of the collection.
xAOD::Jet_v1
Class describing a jet.
Definition: Jet_v1.h:57
a
TList * a
Definition: liststreamerinfos.cxx:10
h
xAOD::Vertex_v1
Class describing a Vertex.
Definition: Vertex_v1.h:42
asg::AsgMetadataTool
Base class for dual-use tools that provide file metadata access.
Definition: AsgMetadataTool.h:48
JetCalibrationTool::m_globalInsituCombMassConfig
std::vector< TEnv * > m_globalInsituCombMassConfig
Definition: JetCalibrationTool.h:101
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
JetCalibrationTool::m_doGSC
bool m_doGSC
Definition: JetCalibrationTool.h:109
xAOD::FileMetaData_v1::generatorsInfo
@ generatorsInfo
Generators information [string].
Definition: FileMetaData_v1.h:82
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
IJetCalibrationTool::applyCalibration
virtual StatusCode applyCalibration(xAOD::JetContainer &jets) const =0
Apply calibration to a jet container.
JetCalibrationTool::m_doBcid
bool m_doBcid
Definition: JetCalibrationTool.h:105
JetCalibrationTool::m_timeDependentCalib
bool m_timeDependentCalib
Definition: JetCalibrationTool.h:82
ReadBchFromCool.lastRun
lastRun
Definition: ReadBchFromCool.py:278
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:629
JetCalibrationTool::m_calibSeq
std::string m_calibSeq
Definition: JetCalibrationTool.h:76
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:801
merge.status
status
Definition: merge.py:16
JetCalibUtils::VectorizeD
VecD VectorizeD(const TString &str, const TString &sep=" ")
Definition: JetCalibUtils.cxx:25
JetEventInfo::setRunNumber
void setRunNumber(UInt_t RunNumber)
Definition: JetEventInfo.h:20
xAOD::FileMetaData_v1::dataYear
@ dataYear
Data year [uint32_t].
Definition: FileMetaData_v1.h:84
JetCalibrationTool::m_useNjetInResidual
bool m_useNjetInResidual
Definition: JetCalibrationTool.h:84
JetCalibrationTool::m_useOriginVertex
bool m_useOriginVertex
Definition: JetCalibrationTool.h:118
SG::DataProxy
Definition: DataProxy.h:45
JetCalibrationTool::m_doDNNCal
bool m_doDNNCal
Definition: JetCalibrationTool.h:110
JetCalibrationTool::m_forceCalibFile_PtResidual
std::string m_forceCalibFile_PtResidual
Definition: JetCalibrationTool.h:94
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
JetCalibrationTool::m_doOrigin
bool m_doOrigin
Definition: JetCalibrationTool.h:108
JetEventInfo::setMu
void setMu(double mu)
Definition: JetEventInfo.h:16
fitman.rho
rho
Definition: fitman.py:532
DataVector::begin
const_iterator begin() const noexcept
Return a const_iterator pointing at the beginning of the collection.
fitman.k
k
Definition: fitman.py:528
JetCalibrationTool::m_calibSteps
std::vector< std::unique_ptr< JetCalibrationStep > > m_calibSteps
Definition: JetCalibrationTool.h:114
ServiceHandle< IIncidentSvc >
JetCalibrationTool::m_insituCombMassCalib
bool m_insituCombMassCalib
Definition: JetCalibrationTool.h:92
asg::AsgMetadataTool::m_useIncidents
bool m_useIncidents
Definition: AsgMetadataTool.h:128