#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

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &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< StoreGateSvc >	StoreGateSvc_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 > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &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::EventInfo >	m_evtInfoKey {this, "EventInfoKey", "EventInfo"}

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

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

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_muKey

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_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

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

TEnv *	m_globalConfig

std::vector< TEnv * >	m_globalTimeDependentConfigs

std::vector< TEnv * >	m_globalInsituCombMassConfig

jetScale	m_jetScale

bool	m_doBcid

bool	m_doJetArea

bool	m_doResidual

bool	m_doOrigin

bool	m_doGSC

bool	m_doDNNCal

std::string	m_gscDepth

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

int	m_smearIndex

bool	m_useOriginVertex

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 32 of file JetCalibrationTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ jetScale

enum JetCalibrationTool::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 27 of file JetCalibrationTool.cxx.

   : asg::AsgTool( name ),
     m_jetAlgo(""), m_config(""), m_calibSeq(""), m_calibAreaTag(""), m_originScale(""), m_devMode(false),
     m_isData(true), m_timeDependentCalib(false), m_dir(""), m_eInfoName(""), m_globalConfig(nullptr),
     m_doBcid(true), m_doJetArea(true), m_doResidual(true), m_doOrigin(true), m_doGSC(true), m_doDNNCal(false), m_gscDepth("auto"), m_smearIndex(-1), m_useOriginVertex(false)
 { 
   declareProperty( "JetCollection", m_jetAlgo = "AntiKt4LCTopo" );
   declareProperty( "ConfigFile", m_config = "" );
   declareProperty( "CalibSequence", m_calibSeq = "JetArea_Offset_AbsoluteEtaJES_Insitu" );
   declareProperty( "IsData", m_isData = true );
   declareProperty( "ConfigDir", m_dir = "JetCalibTools/CalibrationConfigs/" );
   declareProperty( "EventInfoName", m_eInfoName = "EventInfo");
   declareProperty( "DEVmode", m_devMode = false);
   declareProperty( "OriginScale", m_originScale = "JetOriginConstitScaleMomentum");
   declareProperty( "CalibArea", m_calibAreaTag = "00-04-82");
   declareProperty( "GSCDepth", m_gscDepth);
   declareProperty( "useOriginVertex", m_useOriginVertex = false);
 }

◆ ~JetCalibrationTool()

JetCalibrationTool::~JetCalibrationTool ( )

Destructor:

Definition at line 46 of file JetCalibrationTool.cxx.

                                         {
   if(m_globalConfig) delete m_globalConfig;
   for(TEnv* config : m_globalTimeDependentConfigs) delete config;
   for(TEnv* config : m_globalInsituCombMassConfig) delete config;
 }

Member Function Documentation

◆ applyCalibration()

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

overridevirtual

Apply calibration to a jet container.

Implements IJetCalibrationTool.

Definition at line 338 of file JetCalibrationTool.cxx.

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

◆ calibrate()

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

private

Definition at line 561 of file JetCalibrationTool.cxx.

                                                                                        {
  
   //Check for OriginCorrected and PileupCorrected attributes, assume they are false if not found
   int tmp = 0; //temporary int for checking getAttribute
   if ( !jet.getAttribute<int>("OriginCorrected",tmp) )
     jet.setAttribute<int>("OriginCorrected",false);
   if ( !jet.getAttribute<int>("PileupCorrected",tmp) )
     jet.setAttribute<int>("PileupCorrected",false);
  
   ATH_MSG_VERBOSE("Calibrating jet " << jet.index());
   if(m_doSetDetectorEta) {
     xAOD::JetFourMom_t jetconstitP4 = jet.getAttribute<xAOD::JetFourMom_t>("JetConstitScaleMomentum");
     jet.setAttribute<float>("DetectorEta",jetconstitP4.eta()); //saving constituent scale eta for later use
   }
  
   for (unsigned int i=0; i<m_calibSteps.size(); ++i) ATH_CHECK(m_calibSteps[i]->calibrate(jet, jetEventInfo));
  
   return StatusCode::SUCCESS; 
 }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

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

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 245 of file AthCommonDataStore.h.

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

◆ declareProperty() [2/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 221 of file AthCommonDataStore.h.

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

◆ declareProperty() [3/6]

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

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

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

◆ declareProperty() [4/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 333 of file AthCommonDataStore.h.

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

◆ declareProperty() [5/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 352 of file AthCommonDataStore.h.

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

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

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 230 of file JetCalibrationTool.cxx.

                                                                        {
   TString jetAlgo = m_jetAlgo;
   const TString calibPath = "CalibArea-" + m_calibAreaTag + "/";
   if ( calibration.EqualTo("Bcid") ){
     m_globalConfig->SetValue("PileupStartingScale","JetBcidScaleMomentum");
     std::unique_ptr<JetCalibrationStep> bcidCorr = std::make_unique<BcidOffsetCorrection>(this->name()+"_Bcid", m_globalConfig, jetAlgo, calibPath, m_isData);
     ATH_CHECK(bcidCorr->initialize());
     m_calibSteps.push_back(std::move(bcidCorr));
     return StatusCode::SUCCESS;
   }
   else if ( calibration.EqualTo("JetArea") || calibration.EqualTo("Residual") ) {
     std::unique_ptr<JetCalibrationStep> puCorr = std::make_unique<JetPileupCorrection>(this->name()+"_Pileup", m_globalConfig, jetAlgo, calibPath,
                                                    m_doResidual, m_doJetArea, m_doOrigin, m_originScale.c_str(), m_isData, m_devMode);
     puCorr->msg().setLevel( this->msg().level() );
     ATH_CHECK(puCorr->initialize());
     m_calibSteps.push_back(std::move(puCorr));
     return StatusCode::SUCCESS;
   }
   else if ( calibration.EqualTo("EtaJES") || calibration.EqualTo("AbsoluteEtaJES") ) {
     std::unique_ptr<JetCalibrationStep> etaJESCorr = std::make_unique<EtaJESCorrection>(this->name()+"_EtaJES", m_globalConfig, jetAlgo, calibPath, false, m_devMode);
     etaJESCorr->msg().setLevel( this->msg().level() );
     ATH_CHECK(etaJESCorr->initialize());
     m_calibSteps.push_back(std::move(etaJESCorr)); 
     return StatusCode::SUCCESS; 
   }
   else if ( calibration.EqualTo("EtaMassJES") ) {
     std::unique_ptr<JetCalibrationStep> etaJESCorr = std::make_unique<EtaJESCorrection>(this->name()+"_EtaMassJES", m_globalConfig, jetAlgo, calibPath, true, m_devMode);
     etaJESCorr->msg().setLevel( this->msg().level() );
     ATH_CHECK(etaJESCorr->initialize());
     m_calibSteps.push_back(std::move(etaJESCorr)); 
     return StatusCode::SUCCESS; 
   }
   else if ( calibration.EqualTo("GSC") ) {
     std::unique_ptr<JetCalibrationStep> gsc = std::make_unique<GlobalSequentialCorrection>(this->name()+"_GSC", m_globalConfig, jetAlgo, m_gscDepth, calibPath, m_useOriginVertex, m_devMode);
     gsc->msg().setLevel( this->msg().level() );
     ATH_CHECK(gsc->initialize());
     m_calibSteps.push_back(std::move(gsc)); 
     return StatusCode::SUCCESS; 
   }
   else if ( calibration.EqualTo("GNNC") ) {
     std::unique_ptr<JetCalibrationStep> gnnc = std::make_unique<GlobalNNCalibration>(this->name()+"_GNNC",m_globalConfig,jetAlgo,calibPath,m_devMode);
     gnnc->msg().setLevel( this->msg().level() );
     ATH_CHECK(gnnc->initialize());
     m_calibSteps.push_back(std::move(gnnc));
     return StatusCode::SUCCESS;
   }
   else if ( calibration.EqualTo("JMS") ) {
     std::unique_ptr<JetCalibrationStep> jetMassCorr = std::make_unique<JMSCorrection>(this->name()+"_JMS", m_globalConfig, jetAlgo, calibPath, m_devMode);
     jetMassCorr->msg().setLevel( this->msg().level() );
     ATH_CHECK(jetMassCorr->initialize());
     m_calibSteps.push_back(std::move(jetMassCorr));
     return StatusCode::SUCCESS;
   }
   else if ( calibration.EqualTo("InsituCombinedMass") ){
     for(unsigned int i=0;i<m_insituCombMassConfig.size();++i){
       std::unique_ptr<JetCalibrationStep> jetMassCorr = std::make_unique<JMSCorrection>(this->name()+"_InsituCombinedMass", m_globalInsituCombMassConfig.at(i), jetAlgo, calibPath, m_devMode);
       jetMassCorr->msg().setLevel( this->msg().level() );
       ATH_CHECK(jetMassCorr->initialize());
       m_calibSteps.push_back(std::move(jetMassCorr));
     }
     return StatusCode::SUCCESS;
   }
   else if ( calibration.EqualTo("Insitu") ) {
     if(!m_timeDependentCalib){
       std::unique_ptr<JetCalibrationStep> insituDataCorr = std::make_unique<InsituDataCorrection>(this->name()+"_Insitu", m_globalConfig, jetAlgo, calibPath, m_devMode);
       insituDataCorr->msg().setLevel( this->msg().level() );
       ATH_CHECK(insituDataCorr->initialize());
       m_calibSteps.push_back(std::move(insituDataCorr));
       return StatusCode::SUCCESS; 
     }
     else{
       ATH_MSG_INFO("Initializing Time-Dependent Insitu Corrections");
       for(unsigned int i=0;i<m_timeDependentInsituConfigs.size();++i){
         // Add 0.5 before casting to avoid floating-point precision issues
         unsigned int firstRun = static_cast<unsigned int>(m_runBins.at(i)+1.5);
         unsigned int lastRun = static_cast<unsigned int>(m_runBins.at(i+1)+0.5);
         std::unique_ptr<JetCalibrationStep> insituDataCorr = std::make_unique<InsituDataCorrection>(this->name()+"_Insitu_"+std::to_string(i), m_globalTimeDependentConfigs.at(i), jetAlgo,
                                                                                                     calibPath, m_devMode, firstRun, lastRun);
         insituDataCorr->msg().setLevel( this->msg().level() );
         ATH_CHECK(insituDataCorr->initialize());
         m_calibSteps.push_back(std::move(insituDataCorr));
       }
       return StatusCode::SUCCESS; 
     }
   }
   else if ( calibration.EqualTo("Smear") ) {
     if(m_isData){
       ATH_MSG_FATAL("Asked for smearing of data, which is not supported.  Aborting.");
       return StatusCode::FAILURE;
     }
     std::unique_ptr<JetCalibrationStep> jetSmearCorr = std::make_unique<JetSmearingCorrection>(this->name()+"_Smear", m_globalConfig,jetAlgo,calibPath,m_devMode);
     jetSmearCorr->msg().setLevel(this->msg().level());
     ATH_CHECK(jetSmearCorr->initialize());
     m_calibSteps.push_back(std::move(jetSmearCorr));
     m_smearIndex = m_calibSteps.size() - 1;
     return StatusCode::SUCCESS;
   }
   else if ( calibration.EqualTo("LargeRDNN") ) {
     std::unique_ptr<JetCalibrationStep> largeR_dnn = std::make_unique<GlobalLargeRDNNCalibration>(this->name()+"_R10DNN", m_globalConfig,calibPath,m_devMode);
     largeR_dnn->msg().setLevel(this->msg().level());
     ATH_CHECK(largeR_dnn->initialize());
     m_calibSteps.push_back(std::move(largeR_dnn));
     return StatusCode::SUCCESS;
   }
   ATH_MSG_FATAL("Calibration string not recognized: " << calibration << ", aborting.");
   return StatusCode::FAILURE;
 }

◆ getKey()

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

inherited

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

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

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

See also: asg::AsgTool::getName

Parameters

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

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

Definition at line 119 of file AsgTool.cxx.

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

◆ getName()

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

inherited

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

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

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

See also: asg::AsgTool::getKey

Parameters

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

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

Definition at line 106 of file AsgTool.cxx.

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

◆ getNominalResolutionData()

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

overridevirtual

Reimplemented from IJetCalibrationTool.

Definition at line 582 of file JetCalibrationTool.cxx.

                                                                                                    {
  
   if(m_smearIndex < 0){
     ATH_MSG_ERROR("Cannot retrieve the nominal data resolution - smearing was not configured during initialization");
     return StatusCode::FAILURE;
   }
   return m_calibSteps.at(m_smearIndex)->getNominalResolutionData(jet, resolution);
 }

◆ getNominalResolutionMC()

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

overridevirtual

Reimplemented from IJetCalibrationTool.

Definition at line 591 of file JetCalibrationTool.cxx.

                                                                                                  {
   
   if(m_smearIndex < 0){
     ATH_MSG_ERROR("Cannot retrieve the nominal MC resolution - smearing was not configured during initialization");
     return StatusCode::FAILURE;
   }
   return m_calibSteps.at(m_smearIndex)->getNominalResolutionMC(jet, resolution);
 }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ 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 57 of file JetCalibrationTool.cxx.

                                           {
   ATH_MSG_INFO ("Initializing " << name() << " to calibrate " << m_jetAlgo << "jets");
  
   TString jetAlgo = m_jetAlgo;
   TString calibSeq = m_calibSeq;
   std::string dir = m_dir;
  
   //Make sure the necessary properties were set via the constructor or python configuration
   if ( jetAlgo.EqualTo("") || calibSeq.EqualTo("") ) {
     ATH_MSG_FATAL("JetCalibrationTool::initialize : At least one of your constructor arguments is not set. Did you use the copy constructor?");
     return StatusCode::FAILURE;
   }
  
   if ( m_config.empty() ) { ATH_MSG_FATAL("No configuration file specified."); return StatusCode::FAILURE; } 
   // The calibration area tag is a property of the tool
   const std::string calibPath = "CalibArea-" + m_calibAreaTag + "/";
   if(m_devMode){
     ATH_MSG_WARNING("Dev Mode is ON!!!");
     ATH_MSG_WARNING("Dev Mode is NOT RECOMMENDED!!!");
     dir = "JetCalibTools/";
   }
   else{dir.insert(14,calibPath);} // Obtaining the path of the configuration file
   std::string configPath=dir+m_config; // Full path
   TString fn =  PathResolverFindCalibFile(configPath);
  
   ATH_MSG_INFO("Reading global JES settings from: " << m_config);
   ATH_MSG_INFO("resolved in: " << fn);
   
   m_globalConfig = new TEnv();
   int status=m_globalConfig->ReadFile(fn ,EEnvLevel(0));
   if (status!=0) { ATH_MSG_FATAL("Cannot read config file " << fn ); return StatusCode::FAILURE; }
  
   //Make sure that one of the standard jet collections is being used
   if ( calibSeq.Contains("JetArea") ) {
     if ( jetAlgo.Contains("PFlow") ) m_jetScale = PFLOW;
     else if ( jetAlgo.Contains("EM") ) m_jetScale = EM;
     else if ( jetAlgo.Contains("LC") ) m_jetScale = LC;
     else { ATH_MSG_FATAL("jetAlgo " << jetAlgo << " not recognized."); return StatusCode::FAILURE; }
   }
  
   // Settings for R21/2.5.X
   m_originCorrectedClusters = m_globalConfig->GetValue("OriginCorrectedClusters",false);
   m_doSetDetectorEta = m_globalConfig->GetValue("SetDetectorEta",true);
  
   // Rho key specified in the config file?
   std::string rhoKey_config = m_globalConfig->GetValue("RhoKey", "None");
  
   bool requireRhoInput = false;
  
   //Make sure the residual correction is turned on if requested
   if ( !calibSeq.Contains("JetArea") && !calibSeq.Contains("Residual") ) {
     m_doJetArea = false;
     m_doResidual = false;
   } else if ( calibSeq.Contains("JetArea") ) {
     if ( m_rhoKey.key().compare("auto") == 0 && rhoKey_config.compare("None") == 0) {
       if(!m_originCorrectedClusters){
         if ( m_jetScale == EM ) m_rhoKey = "Kt4EMTopoEventShape";
         else if ( m_jetScale == LC ) m_rhoKey = "Kt4LCTopoEventShape";
         else if ( m_jetScale == PFLOW ) m_rhoKey = "Kt4EMPFlowEventShape";
       } else{
         if ( m_jetScale == EM ) m_rhoKey = "Kt4EMTopoOriginEventShape";
         else if ( m_jetScale == LC ) m_rhoKey = "Kt4LCTopoOriginEventShape";
         else if ( m_jetScale == PFLOW ) m_rhoKey = "Kt4EMPFlowEventShape";
       }
     }
     else if(rhoKey_config.compare("None") != 0 && m_rhoKey.key().compare("auto") == 0){
       m_rhoKey = rhoKey_config;
     }
     requireRhoInput = true;
     if ( !calibSeq.Contains("Residual") ) m_doResidual = false;
   } else if ( !calibSeq.Contains("JetArea") && calibSeq.Contains("Residual") ) {
     m_doJetArea = false;
     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.");
   }
   // get nJet threshold and name
   m_useNjetInResidual = m_globalConfig->GetValue("OffsetCorrection.UseNjet", false);
   m_nJetThreshold = m_globalConfig->GetValue("OffsetCorrection.nJetThreshold", 20);
   m_nJetContainerName = m_globalConfig->GetValue("OffsetCorrection.nJetContainerName",
                                                  "HLT_xAOD__JetContainer_a4tcemsubjesISFS");
  
   if ( !calibSeq.Contains("Origin") ) m_doOrigin = false;
   if ( !calibSeq.Contains("GSC") && !calibSeq.Contains("GNNC")) m_doGSC = false;
   if ( !calibSeq.Contains("Bcid") ) m_doBcid = false;
   if ( calibSeq.Contains("DNN") ) m_doDNNCal = true;
  
   //Protect against the in-situ calibration being requested when isData is false
   if ( calibSeq.Contains("Insitu") && !m_isData ) {
     ATH_MSG_FATAL("JetCalibrationTool::initialize : calibSeq string contains Insitu with isData set to false. Can't apply in-situ correction to MC!!");
     return StatusCode::FAILURE;
   }
  
   // Time-Dependent Insitu Calibration
   m_timeDependentCalib = m_globalConfig->GetValue("TimeDependentInsituCalibration",false);
   if(m_timeDependentCalib && calibSeq.Contains("Insitu")){ // Read Insitu Configs
     m_timeDependentInsituConfigs = JetCalibUtils::Vectorize( m_globalConfig->GetValue("InsituTimeDependentConfigs","") );
     if(m_timeDependentInsituConfigs.empty()) ATH_MSG_ERROR("Please check there are at least two insitu configs");
     m_runBins = JetCalibUtils::VectorizeD( m_globalConfig->GetValue("InsituRunBins","") );
     if(m_runBins.size()!=m_timeDependentInsituConfigs.size()+1) ATH_MSG_ERROR("Please check the insitu run bins");
     for(unsigned int i=0;i<m_timeDependentInsituConfigs.size();++i){
  
       std::string configPath_insitu = dir+m_timeDependentInsituConfigs.at(i).Data(); // Full path
       TString fn_insitu =  PathResolverFindCalibFile(configPath_insitu);
  
       ATH_MSG_INFO("Reading time-dependent insitu settings from: " << m_timeDependentInsituConfigs.at(i));
       ATH_MSG_INFO("resolved in: " << fn_insitu);
   
       TEnv *globalConfig_insitu = new TEnv();
       int status = globalConfig_insitu->ReadFile(fn_insitu ,EEnvLevel(0));
       if (status!=0) { ATH_MSG_FATAL("Cannot read config file " << fn_insitu ); return StatusCode::FAILURE; }
       m_globalTimeDependentConfigs.push_back(globalConfig_insitu);
     }
   }
  
   //Combined Mass Calibration:
   m_insituCombMassCalib = m_globalConfig->GetValue("InsituCombinedMassCorrection",false);
   if(m_insituCombMassCalib && calibSeq.Contains("InsituCombinedMass")){ // Read Combination Config
     m_insituCombMassConfig = JetCalibUtils::Vectorize( m_globalConfig->GetValue("InsituCombinedMassCorrectionFile","") );
     if(m_insituCombMassConfig.empty()) ATH_MSG_ERROR("Please check there is a combination config");
     for(unsigned int i=0;i<m_insituCombMassConfig.size();++i){
  
       std::string configPath_comb = dir+m_insituCombMassConfig.at(i).Data(); // Full path
       TString fn_comb =  PathResolverFindCalibFile(configPath_comb);
  
       ATH_MSG_INFO("Reading combination settings from: " << m_insituCombMassConfig.at(i));
       ATH_MSG_INFO("resolved in: " << fn_comb);
  
       TEnv *globalInsituCombMass = new TEnv();
       int status = globalInsituCombMass->ReadFile(fn_comb ,EEnvLevel(0));
       if (status!=0) { ATH_MSG_FATAL("Cannot read config file " << fn_comb ); return StatusCode::FAILURE; }
       m_globalInsituCombMassConfig.push_back(globalInsituCombMass);
     }
   }
  
   //Loop over the request calib sequence
   //Initialize derived classes for applying the requested calibrations and add them to a vector
   std::vector<TString> vecCalibSeq = JetCalibUtils::Vectorize(calibSeq,"_");
   for ( unsigned int i=0; i<vecCalibSeq.size(); ++i) {
     if ( vecCalibSeq[i].EqualTo("Origin") || vecCalibSeq[i].EqualTo("DEV") ) continue;
     if ( vecCalibSeq[i].EqualTo("Residual") && m_doJetArea ) continue;
     ATH_CHECK( getCalibClass(vecCalibSeq[i] ));
   }
  
   // Initialise ReadHandle(s)
   ATH_CHECK( m_evtInfoKey.initialize() );
   ATH_CHECK( m_muKey.initialize() );
   ATH_CHECK( m_actualMuKey.initialize() );
   ATH_CHECK( m_rhoKey.initialize(requireRhoInput) );
   if(m_pvKey.empty()) {
     // No PV key: -- check if it is required
     if(m_doResidual) {
       // May require modification in case of residual that does not require NPV
       ATH_MSG_ERROR("Residual calibration requested but no primary vertex container specified!");
       return StatusCode::FAILURE;
     }
     else if(m_doGSC) {
       if(m_jetAlgo.find("PFlow")!=std::string::npos) {
         ATH_MSG_ERROR("GSC calibration for PFlow requested but no primary vertex container specified!");
         return StatusCode::FAILURE;
       }
       else if((m_gscDepth!="Tile0" && m_gscDepth!="EM3")) {
         ATH_MSG_ERROR("GSC calibration with tracks requested but no primary vertex container specified!");
         return StatusCode::FAILURE;
       }
     }
   } else {
     // Received a PV key, declare the data dependency
     ATH_CHECK( m_pvKey.initialize() );
   }
  
   return StatusCode::SUCCESS;
 }

◆ initializeEvent()

StatusCode JetCalibrationTool::initializeEvent ( JetEventInfo & jetEventInfo ) const

private

Definition at line 350 of file JetCalibrationTool.cxx.

                                                                                {
  
   // Check if the tool was initialized
   if( m_calibSteps.empty() ){
     ATH_MSG_FATAL("   JetCalibrationTool::initializeEvent : The tool was not initialized.");
     return StatusCode::FAILURE;
   }
  
   // static accessor for PV index access
   static const SG::AuxElement::ConstAccessor<int> PVIndexAccessor("PVIndex");
   
   ATH_MSG_VERBOSE("Initializing event.");
  
   if( m_doJetArea ) {
     //Determine the rho value to use for the jet area subtraction
     //Should be determined using EventShape object, use hard coded values if EventShape doesn't exist
     double rho=0;
     const xAOD::EventShape * eventShape = nullptr;
  
     SG::ReadHandle<xAOD::EventShape> rhRhoKey(m_rhoKey);
  
     if ( rhRhoKey.isValid() ) {
       ATH_MSG_VERBOSE("  Found event density container " << m_rhoKey.key());
       eventShape = rhRhoKey.cptr();
       if ( !rhRhoKey.isValid() ) {
         ATH_MSG_VERBOSE("  Event shape container not found.");
         ATH_MSG_FATAL("Could not retrieve the xAOD::EventShape container " << m_rhoKey.key() << " from the input file");
         return StatusCode::FAILURE;
       } else if ( !eventShape->getDensity( xAOD::EventShape::Density, rho ) ) {
         ATH_MSG_VERBOSE("  Event density not found in container.");
         ATH_MSG_FATAL("Could not retrieve the xAOD::EventShape::Density variable from " << m_rhoKey.key());
         return StatusCode::FAILURE;
       } else {
         ATH_MSG_VERBOSE("  Event density retrieved.");
       }
     } else if ( m_doJetArea && !rhRhoKey.isValid() ) {
       ATH_MSG_VERBOSE("  Rho container not found: " << m_rhoKey.key());
       ATH_MSG_FATAL("Could not retrieve xAOD::EventShape container " << m_rhoKey.key() << " from the input file");
       return StatusCode::FAILURE;
     }
     jetEventInfo.setRho(rho);
     ATH_MSG_VERBOSE("  Rho = " << 0.001*rho << " GeV");
  
     // Necessary retrieval and calculation for use of nJetX instead of NPV
     if(m_useNjetInResidual) {
       // retrieve the container
       const xAOD::JetContainer * jets = nullptr;
       if (evtStore()->contains<xAOD::JetContainer>(m_nJetContainerName) ) {
         ATH_MSG_VERBOSE("  Found jet container " << m_nJetContainerName);
         if ( evtStore()->retrieve(jets, m_nJetContainerName).isFailure() || !jets ) {
           ATH_MSG_FATAL("Could not retrieve xAOD::JetContainer " << m_nJetContainerName << " from evtStore");
           return StatusCode::FAILURE;
         }
       } else {
         ATH_MSG_FATAL("Could not find jet container " << m_nJetContainerName << " in the evtStore");
         return StatusCode::FAILURE;
       }
  
       // count jets above threshold
       int nJets = 0;
       for (const auto *jet : *jets) {
         if(jet->pt()/1000. > m_nJetThreshold)
           nJets += 1;
       }
       jetEventInfo.setNjet(nJets);
     }
   }
  
   // Retrieve EventInfo object, which now has multiple uses
   if ( m_doResidual || m_doGSC || m_doBcid || m_timeDependentCalib) {
     const xAOD::EventInfo * eventObj = nullptr;
     static std::atomic<unsigned int> eventInfoWarnings = 0;
     SG::ReadHandle<xAOD::EventInfo> rhEvtInfo(m_evtInfoKey);
     if ( rhEvtInfo.isValid() ) {
       eventObj = rhEvtInfo.cptr();
     } else {
       ++eventInfoWarnings;
       if ( eventInfoWarnings < 20 )
         ATH_MSG_ERROR("   JetCalibrationTool::initializeEvent : Failed to retrieve event information.");
       jetEventInfo.setMu(0); //Hard coded value mu = 0 in case of failure (to prevent seg faults later).
       jetEventInfo.setPVIndex(0);
       return StatusCode::SUCCESS; //error is recoverable, so return SUCCESS
     }
     jetEventInfo.setRunNumber( eventObj->runNumber() );
  
     // If we are applying the reisdual, then store mu
     if (m_doResidual || m_doBcid) {
       SG::ReadDecorHandle<xAOD::EventInfo,float> eventInfoDecor(m_muKey);
       if(!eventInfoDecor.isPresent()) {
         ATH_MSG_ERROR("EventInfo decoration not available!");
         return StatusCode::FAILURE;
       }
       jetEventInfo.setMu( eventInfoDecor(0) );
     }
  
     // If this is GSC, we need EventInfo to determine the PV to use
     // This is support for groups where PV0 is not the vertex of interest (H->gamgam, etc)
     if (m_doGSC)
     {
       // First retrieve the PVIndex if specified
       // Default is to not specify this, so no warning if it doesn't exist
       // However, if specified, it should be a sane value - fail if not
       if ( m_doGSC && PVIndexAccessor.isAvailable(*eventObj) )
         jetEventInfo.setPVIndex( PVIndexAccessor(*eventObj) );
       else{
     if(!m_pvKey.empty()){
       const xAOD::VertexContainer * vertices = nullptr;
       SG::ReadHandle<xAOD::VertexContainer> rhPV(m_pvKey);
       if (rhPV.isValid()) {
         vertices = rhPV.cptr();
         xAOD::VertexContainer::const_iterator vtx_itr = vertices->begin();
         xAOD::VertexContainer::const_iterator vtx_end = vertices->end();
         for ( ; vtx_itr != vtx_end; ++vtx_itr ){
           if ( (*vtx_itr)->vertexType() == xAOD::VxType::PriVtx ){
         jetEventInfo.setPVIndex((*vtx_itr)->index());
         break;
           }
         }
       }
       else{
         jetEventInfo.setPVIndex(0);
       }
     }
     else{
       jetEventInfo.setPVIndex(0);
     }
       }
     }
  
     // Extract the BCID information for the BCID correction
     if (m_doBcid)
     {
       static const SG::ConstAccessor<int> BCIDDistanceFromFrontAcc ("DFCommonJets_BCIDDistanceFromFront");
       static const SG::ConstAccessor<int> BCIDGapBeforeTrainAcc ("DFCommonJets_BCIDGapBeforeTrain");
       static const SG::ConstAccessor<int> BCIDGapBeforeTrainMinus12Acc ("DFCommonJets_BCIDGapBeforeTrainMinus12");
  
       jetEventInfo.setBcidDistanceFromFront( BCIDDistanceFromFrontAcc (*eventObj) );
       jetEventInfo.setBcidGapBeforeTrain( BCIDGapBeforeTrainAcc (*eventObj) );
       jetEventInfo.setBcidGapBeforeTrainMinus12( BCIDGapBeforeTrainMinus12Acc (*eventObj) );
     }
     
     // If PV index is not zero, we need to confirm it's a reasonable value
     // To do this, we need the primary vertices
     // However, other users of the GSC may not have the PV collection (in particular: trigger GSC in 2016)
     // So only retrieve vertices if needed for NPV (residual) or a non-zero PV index was specified (GSC)
     if ((m_doResidual && !m_useNjetInResidual) || (m_doGSC && jetEventInfo.PVIndex()))
     {
       //Retrieve VertexContainer object, use it to obtain NPV for the residual correction or check validity of GSC non-PV0 usage
       const xAOD::VertexContainer * vertices = nullptr;
  
       SG::ReadHandle<xAOD::VertexContainer> rhPV(m_pvKey);
       if (rhPV.isValid()) {
         vertices = rhPV.cptr(); 
       } else {
         ATH_MSG_WARNING("   JetCalibrationTool::initializeEvent : Failed to retrieve primary vertices.");
         jetEventInfo.setNPV(0); //Hard coded value NPV = 0 in case of failure (to prevent seg faults later).
         return StatusCode::SUCCESS; //error is recoverable, so return SUCCESS
       }
  
       // Calculate and set NPV if this is residual
       if (m_doResidual)
       {
         int eventNPV = 0;
     eventNPV = std::count_if(vertices->begin(), vertices->end(), [](const xAOD::Vertex* vtx){ return vtx->vertexType() == xAOD::VxType::PileUp || vtx->vertexType() == xAOD::VxType::PriVtx;});
         jetEventInfo.setNPV(eventNPV);
       }
  
       // Validate value of non-standard PV index usage
       if (m_doGSC && jetEventInfo.PVIndex())
       {
         static std::atomic<unsigned int> vertexIndexWarnings = 0;
         if (jetEventInfo.PVIndex() < 0 || static_cast<size_t>(jetEventInfo.PVIndex()) >= vertices->size())
         {
           ++vertexIndexWarnings;
           if (vertexIndexWarnings < 20)
             ATH_MSG_WARNING("   JetCalibrationTool::initializeEvent : PV index is out of bounds.");
           jetEventInfo.setPVIndex(0); // Hard coded value PVIndex = 0 in case of failure (to prevent seg faults later).
           return StatusCode::SUCCESS; // error is recoverable, so return SUCCESS
         }
       }
     }
   } else if (m_doDNNCal) {
     // retrieve mu and NPV only from eventInfo
     static std::atomic<unsigned int> eventInfoWarningsMu = 0;
     SG::ReadHandle<xAOD::EventInfo> rhEvtInfo(m_evtInfoKey);
     if ( rhEvtInfo.isValid() ) {
       SG::ReadDecorHandle<xAOD::EventInfo,float> eventInfoDecor(m_actualMuKey);
       jetEventInfo.setMu(eventInfoDecor(0));
     } else {
       ++eventInfoWarningsMu;
       if ( eventInfoWarningsMu < 20 ) ATH_MSG_WARNING("   JetCalibrationTool::initializeEvent : Failed to retrieve event information.");
       jetEventInfo.setMu(0); //Hard coded value mu = 0 in case of failure (to prevent seg faults later).
     }
  
     static std::atomic<unsigned int> eventInfoWarningsPV = 0;
     const xAOD::VertexContainer * vertices = nullptr;
     SG::ReadHandle<xAOD::VertexContainer> rhPV(m_pvKey);
     if (rhPV.isValid()) {
       vertices = rhPV.cptr();
       int eventNPV = 0;
       eventNPV = std::count_if(vertices->begin(), vertices->end(), [](const xAOD::Vertex* vtx){ return vtx->vertexType() == xAOD::VxType::PileUp || vtx->vertexType() == xAOD::VxType::PriVtx;});
       jetEventInfo.setNPV(eventNPV);
     } else {
       ++eventInfoWarningsPV;
       if ( eventInfoWarningsPV < 20 ) ATH_MSG_WARNING("   JetCalibrationTool::initializeEvent : Failed to retrieve primary vertices.");
       jetEventInfo.setNPV(0); //Hard coded value NPV = 0 in case of failure (to prevent seg faults later).
     }
   }
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

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

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

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

inherited

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

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

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

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

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

Definition at line 101 of file AsgTool.cxx.

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

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_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 69 of file JetCalibrationTool.h.

◆ m_calibAreaTag

std::string JetCalibrationTool::m_calibAreaTag

private

Definition at line 76 of file JetCalibrationTool.h.

◆ m_calibSeq

std::string JetCalibrationTool::m_calibSeq

private

Definition at line 75 of file JetCalibrationTool.h.

◆ m_calibSteps

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

private

Definition at line 109 of file JetCalibrationTool.h.

◆ m_config

std::string JetCalibrationTool::m_config

private

Definition at line 74 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 78 of file JetCalibrationTool.h.

◆ m_dir

std::string JetCalibrationTool::m_dir

private

Definition at line 85 of file JetCalibrationTool.h.

◆ m_doBcid

bool JetCalibrationTool::m_doBcid

private

Definition at line 100 of file JetCalibrationTool.h.

◆ m_doDNNCal

bool JetCalibrationTool::m_doDNNCal

private

Definition at line 105 of file JetCalibrationTool.h.

◆ m_doGSC

bool JetCalibrationTool::m_doGSC

private

Definition at line 104 of file JetCalibrationTool.h.

◆ m_doJetArea

bool JetCalibrationTool::m_doJetArea

private

Definition at line 101 of file JetCalibrationTool.h.

◆ m_doOrigin

bool JetCalibrationTool::m_doOrigin

private

Definition at line 103 of file JetCalibrationTool.h.

◆ m_doResidual

bool JetCalibrationTool::m_doResidual

private

Definition at line 102 of file JetCalibrationTool.h.

◆ m_doSetDetectorEta

bool JetCalibrationTool::m_doSetDetectorEta

private

Definition at line 89 of file JetCalibrationTool.h.

◆ m_eInfoName

std::string JetCalibrationTool::m_eInfoName

private

Definition at line 86 of file JetCalibrationTool.h.

◆ m_evtInfoKey

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

private

Definition at line 64 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_globalConfig

TEnv* JetCalibrationTool::m_globalConfig

private

Definition at line 94 of file JetCalibrationTool.h.

◆ m_globalInsituCombMassConfig

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

private

Definition at line 96 of file JetCalibrationTool.h.

◆ m_globalTimeDependentConfigs

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

private

Definition at line 95 of file JetCalibrationTool.h.

◆ m_gscDepth

std::string JetCalibrationTool::m_gscDepth

private

Definition at line 107 of file JetCalibrationTool.h.

◆ m_insituCombMassCalib

bool JetCalibrationTool::m_insituCombMassCalib

private

Definition at line 90 of file JetCalibrationTool.h.

◆ m_insituCombMassConfig

std::vector<TString> JetCalibrationTool::m_insituCombMassConfig

private

Definition at line 91 of file JetCalibrationTool.h.

◆ m_isData

bool JetCalibrationTool::m_isData

private

Definition at line 79 of file JetCalibrationTool.h.

◆ m_jetAlgo

std::string JetCalibrationTool::m_jetAlgo

private

Definition at line 73 of file JetCalibrationTool.h.

◆ m_jetScale

jetScale JetCalibrationTool::m_jetScale

private

Definition at line 99 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 67 of file JetCalibrationTool.h.

◆ m_nJetContainerName

std::string JetCalibrationTool::m_nJetContainerName

private

Definition at line 84 of file JetCalibrationTool.h.

◆ m_nJetThreshold

float JetCalibrationTool::m_nJetThreshold

private

Definition at line 83 of file JetCalibrationTool.h.

◆ m_originCorrectedClusters

bool JetCalibrationTool::m_originCorrectedClusters

private

Definition at line 81 of file JetCalibrationTool.h.

◆ m_originScale

std::string JetCalibrationTool::m_originScale

private

Definition at line 77 of file JetCalibrationTool.h.

◆ m_pvKey

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

private

Definition at line 66 of file JetCalibrationTool.h.

◆ m_rhoKey

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

private

Definition at line 65 of file JetCalibrationTool.h.

◆ m_runBins

std::vector<double> JetCalibrationTool::m_runBins

private

Definition at line 88 of file JetCalibrationTool.h.

◆ m_smearIndex

int JetCalibrationTool::m_smearIndex

private

Definition at line 110 of file JetCalibrationTool.h.

◆ m_timeDependentCalib

bool JetCalibrationTool::m_timeDependentCalib

private

Definition at line 80 of file JetCalibrationTool.h.

◆ m_timeDependentInsituConfigs

std::vector<TString> JetCalibrationTool::m_timeDependentInsituConfigs

private

Definition at line 87 of file JetCalibrationTool.h.

◆ m_useNjetInResidual

bool JetCalibrationTool::m_useNjetInResidual

private

Definition at line 82 of file JetCalibrationTool.h.

◆ m_useOriginVertex

bool JetCalibrationTool::m_useOriginVertex

private

Definition at line 113 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:

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ jetScale

Constructor & Destructor Documentation

◆ JetCalibrationTool()

◆ ~JetCalibrationTool()

Member Function Documentation

◆ applyCalibration()

◆ calibrate()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getCalibClass()

◆ getKey()

◆ getName()

◆ getNominalResolutionData()

◆ getNominalResolutionMC()

◆ getProperty()

◆ initialize()

◆ initializeEvent()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_actualMuKey

◆ m_calibAreaTag

◆ m_calibSeq

◆ m_calibSteps

◆ m_config

◆ m_detStore

◆ m_devMode

◆ m_dir

◆ m_doBcid

◆ m_doDNNCal

◆ m_doGSC

◆ m_doJetArea

◆ m_doOrigin

◆ m_doResidual

◆ m_doSetDetectorEta

◆ m_eInfoName

◆ m_evtInfoKey

◆ m_evtStore

◆ m_globalConfig

◆ m_globalInsituCombMassConfig

◆ m_globalTimeDependentConfigs

◆ m_gscDepth

◆ m_insituCombMassCalib

◆ m_insituCombMassConfig

◆ m_isData

◆ m_jetAlgo

◆ m_jetScale