#include <JESCalibStep.h>

Inheritance diagram for EtaMassJESCalibStep:

Collaboration diagram for EtaMassJESCalibStep:

Public Member Functions
	EtaMassJESCalibStep (const std::string &name="EtaMassJESCalibStep")

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	calibrate (xAOD::JetContainer &) const override
	Apply calibration to a jet container. More...

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

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

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

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

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

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

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

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

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &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	getNominalResolutionData (const xAOD::Jet &, const JetHelper::JetContext &, double &) const

virtual StatusCode	getNominalResolutionMC (const xAOD::Jet &, const JetHelper::JetContext &, double &) const

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
double	getLogPolN (const double *factors, double x) const

double	getLogPolNSlope (const double *factors, double x) const

int	getEtaBin (double eta_det) const

bool	readMCJESFromText ()

bool	readMCJESFromHists ()

void	loadSplineHists (const std::string &fileName, const std::string &etajes_name)

double	getJES (const double X, const double Y=0, const double Emax=-1) const
	return MCJES calibration factor More...

double	getEtaCorr (double X, double Y=0) const
	return Eta correction More...

double	getEmaxJES (const double Y) const
	return Emax More...

double	getLowPtJES (double E_uncorr, double eta_det) const
	deal with low pt jets More...

double	getSplineCorr (const int etaBin, double E) const

double	getSplineSlope (const int ieta, const double minE) const

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
Gaudi::Property< std::string >	m_constantFileName { this, "CalibConstantFile", "/afs/cern.ch/work/s/stapiaar/JetDev4/athena/JetToolHelpers/data/file_JES.config", "text file containing constants" }
	name of the text file More...

Gaudi::Property< std::string >	m_jetAlgo { this, "JetAlgo", "AntiKt4EMPFlow", "jet collection" }
	jet collection to be calibrated More...

Gaudi::Property< float >	m_minPt_JES = {this, "MinPtForETAJES",15, "min pT"}

Gaudi::Property< bool >	m_freezeJESatHighE = {this, "FreezeJEScorrectionatHighE",false, " freeze at high e"}

Gaudi::Property< float >	m_lowPtExtrap = {this, "LowPtJESExtrapolationMethod", 0, " low pt etrap"}

Gaudi::Property< float >	m_lowPtMinR = {this, "LowPtJESExtrapolationMinimumResponse", 0.25, " low pt etrap min"}

Gaudi::Property< float >	m_minPt_EtaCorr = {this, "MinPtForEtaCorr" ,8. , ""}

Gaudi::Property< float >	m_maxE_EtaCorr = {this, "MaxEForEtaCorr" ,2500. , ""}

Gaudi::Property< std::string >	m_histoFileName { this, "HistoFile", "none", "root file containing histos for spline calib" }

Gaudi::Property< bool >	m_useSpline = {this, "UseSpline",false, " use spline"}

ToolHandle< JetHelper::IVarTool >	m_vartoolE {this, "VarToolE", "VarTool", "InputVariable instance E (or pT?)" }

ToolHandle< JetHelper::IVarTool >	m_vartoolEta {this, "VarToolEta", "VarTool", "InputVariable instance eta (or rapididty?)" }
	interface for xAOD::jet variable to be defined by user, this must correspond to jet Eta in currect version of jet calibration files More...

unsigned int	m_nPar {}

double	m_JESFactors [s_nEtaBins][s_nParMax] {}

double	m_etaCorrFactors [s_nEtaBins][s_nParMax] {}

double	m_energyFreezeJES [s_nEtaBins] {}

double	m_JES_MinPt_Slopes [s_nEtaBins] ={}

double	m_JES_MinPt_E [s_nEtaBins] ={}

double	m_JES_MinPt_R [s_nEtaBins] ={}

TAxis *	m_etaBinAxis {}

std::vector< std::unique_ptr< TH1 > >	m_etajesFactors

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

Static Private Attributes
static const unsigned int	s_nEtaBins = 90

static const unsigned int	s_nParMax = 9

Detailed Description

Definition at line 31 of file JESCalibStep.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ EtaMassJESCalibStep()

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

Definition at line 19 of file JESCalibStep.cxx.

20 : asg::AsgTool( name ){ }

Member Function Documentation

◆ calibrate()

StatusCode EtaMassJESCalibStep::calibrate ( xAOD::JetContainer & jets ) const

overridevirtual

Apply calibration to a jet container.

Implements IJetCalibStep.

Definition at line 44 of file JESCalibStep.cxx.

                                                                       {
   ATH_MSG_DEBUG("Calibrating jet collection.");
  
  
   // Change this to EtaMassJES? Or only if Mass is applied?
   const xAOD::JetAttributeAccessor::AccessorWrapper<xAOD::JetFourMom_t> jesScaleMomAcc("JetEtaJESScaleMomentum"); 
  
   for(xAOD::Jet* jet: jets){
       
     const xAOD::JetFourMom_t jetStartP4 = jet->jetP4();
       
     // Extract the maximum energy, and store in the context
     JetHelper::JetContext jc;
     double varE {m_vartoolE->getValue(*jet,jc)};
     double varEta {m_vartoolEta->getValue(*jet,jc)};
     double Emax = getEmaxJES(varEta);
  
     // Extract JES from the text handling tool
     double jesCorrection = getJES(varE, varEta, Emax);
     int ieta=getEtaBin(varEta);
  
  
     xAOD::JetFourMom_t calibP4 = jetStartP4 * jesCorrection;
  
  
     const float etaCorr = calibP4.eta() + getEtaCorr(jesCorrection*varE, varEta) ; //m_textTool_Eta->getValue(*jet, jc);
     ATH_MSG_DEBUG("eta = "<<etaCorr);
  
     // Apply the eta correction, use TLV from ROOT to do some math for us
     TLorentzVector TLVjet;
     TLVjet.SetPtEtaPhiM( calibP4.P()/cosh(etaCorr), etaCorr, calibP4.phi(), calibP4.M() );
     calibP4.SetPxPyPzE( TLVjet.Px(), TLVjet.Py(), TLVjet.Pz(), TLVjet.E() );
     ATH_MSG_DEBUG("JES = "<<jesCorrection << "  e="<<varE << "  eta="<<jetStartP4.Eta()<< " ieta="<<  ieta << "    post_pt= ="<< calibP4.Pt() <<  " etaCorr="<< etaCorr);
  
     // Set the decorations of this scale
     jesScaleMomAcc.setAttribute(*jet, calibP4);
     jet->setJetP4(calibP4);
   }
  
   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

◆ getEmaxJES()

double EtaMassJESCalibStep::getEmaxJES ( const double Y ) const

private

return Emax

Definition at line 282 of file JESCalibStep.cxx.

 {
   int binEta = getEtaBin(Y);
   double emaxJES = m_energyFreezeJES[binEta];
  
   return emaxJES;
 }

◆ getEtaBin()

int EtaMassJESCalibStep::getEtaBin ( double eta_det ) const

private

Definition at line 300 of file JESCalibStep.cxx.

 {
   int bin = std::as_const(m_etaBinAxis)->FindBin(eta_det);
   if (bin<=0) return 0;
   if (bin>m_etaBinAxis->GetNbins()) return bin-2; // overflow
   return bin-1;
 }

◆ getEtaCorr()

double EtaMassJESCalibStep::getEtaCorr	(	double	X,
		double	Y = `0`
	)		const

private

return Eta correction

Definition at line 268 of file JESCalibStep.cxx.

 {
   int binEta = getEtaBin(Y);
   const double *factors = m_etaCorrFactors[binEta];
  
   if ( X < m_minPt_EtaCorr*cosh(Y) ) 
     X = m_minPt_EtaCorr*cosh(Y);
   if ( X>m_maxE_EtaCorr ) X=m_maxE_EtaCorr;
     
   double eta_corr = getLogPolN(factors,X);
  
   return -eta_corr;
 }

◆ getJES()

double EtaMassJESCalibStep::getJES	(	const double	X,
		const double	Y = `0`,
		const double	Emax = `-1`
	)		const

private

return MCJES calibration factor

Definition at line 215 of file JESCalibStep.cxx.

 {
  
   if ( X/cosh(Y) < m_minPt_JES ) { // WARNING !! Won't work if X is actually pT
     double R = getLowPtJES(X,Y);
     return 1.0/R;
   }
   
   double JES_R;
   int binEta = getEtaBin(Y);
   const double *factors = m_JESFactors[binEta];
  
   
   double E = X;
   if( m_freezeJESatHighE && (E>Emax) && (Emax!=-1)) {
     E = Emax;
   }
  
   double R = 1.;
  
   if(m_useSpline){
     R = getSplineCorr(binEta, E);
     return 1.0/R;
   } else { 
     R = getLogPolN(factors,E);
   }
   
   JES_R = 1/R;
   
   return JES_R;
 }

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

◆ getLogPolN()

double EtaMassJESCalibStep::getLogPolN	(	const double *	factors,
		double	x
	)		const

private

Definition at line 290 of file JESCalibStep.cxx.

 {
   double y=0;
   for ( uint i=0; i<m_nPar; ++i )
     y += factors[i]*TMath::Power(log(x),Int_t(i));
   return y;
 }

◆ getLogPolNSlope()

double EtaMassJESCalibStep::getLogPolNSlope	(	const double *	factors,
		double	x
	)		const

private

Definition at line 308 of file JESCalibStep.cxx.

                                                                                  {
   double y=0;
   const double inv_x = 1. / x;
   for ( uint i=0; i<m_nPar; ++i )
     y += i*factors[i]*TMath::Power(log(x),Int_t(i-1))*inv_x;
   return y;
 }

◆ getLowPtJES()

double EtaMassJESCalibStep::getLowPtJES	(	double	E_uncorr,
		double	eta_det
	)		const

private

deal with low pt jets

Definition at line 248 of file JESCalibStep.cxx.

                                                                              {
   int ieta = getEtaBin(eta_det);
   double R=1;
   // This correspond to  m_lowPtExtrap == 0 in the old EtaJESCorrection tool. Not supporting other cases yet.
   if (m_lowPtExtrap == 0) {
     const double *factors = m_JESFactors[ieta];
     double E = m_minPt_JES*cosh(eta_det);
     R= getLogPolN(factors,E);
   } if (m_lowPtExtrap == 1) {
     double Ecutoff = m_JES_MinPt_E[ieta];
     double Rcutoff = m_JES_MinPt_R[ieta];
     double slope = m_JES_MinPt_Slopes[ieta];
     R = slope*(E_uncorr-Ecutoff)+Rcutoff;
   }
   else ATH_MSG_WARNING("Incorrect specification of low Pt JES extrapolation, please check the value of the LowPtJESExtrapolationMethod config flag.");
  
   return R;
 }

◆ 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()

virtual StatusCode IJetCalibStep::getNominalResolutionData	(	const xAOD::Jet &	,
		const JetHelper::JetContext &	,
		double &
	)		const

inlinevirtualinherited

Reimplemented in SmearingCalibStep.

Definition at line 38 of file IJetCalibStep.h.

38 { return StatusCode::FAILURE; }

◆ getNominalResolutionMC()

virtual StatusCode IJetCalibStep::getNominalResolutionMC	(	const xAOD::Jet &	,
		const JetHelper::JetContext &	,
		double &
	)		const

inlinevirtualinherited

Reimplemented in SmearingCalibStep.

Definition at line 39 of file IJetCalibStep.h.

39 { return StatusCode::FAILURE; }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ getSplineCorr()

double EtaMassJESCalibStep::getSplineCorr	(	const int	etaBin,
		double	E
	)		const

private

Definition at line 350 of file JESCalibStep.cxx.

                                                                           {
   double R = m_etajesFactors[ etaBin ]->Interpolate(E);
   return R;
 }

◆ getSplineSlope()

double EtaMassJESCalibStep::getSplineSlope	(	const int	ieta,
		const double	minE
	)		const

private

Definition at line 337 of file JESCalibStep.cxx.

                                                                                   {
   // Don't want to use interpolation here, so instead just use the values at the bin centers near the cutoff
   int minBin = m_etajesFactors[ieta]->FindBin(minE);
  
   double rFirst = m_etajesFactors[ ieta ]->GetBinContent(minBin);
   double rSecond = m_etajesFactors[ ieta ]->GetBinContent(minBin+1);
   double binWidth = m_etajesFactors[ ieta ]->GetBinCenter(minBin+1) - m_etajesFactors[ ieta ]->GetBinCenter(minBin);
   double slope = (rSecond - rFirst) / binWidth;
  
   return slope;
 }

◆ initialize()

StatusCode EtaMassJESCalibStep::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 23 of file JESCalibStep.cxx.

                                           {
   ATH_MSG_DEBUG ("Initializing " << name() << " Use spline="<<m_useSpline);
  
   if(! m_useSpline){
     if(!readMCJESFromText()) {
       ATH_MSG_ERROR("Problem when reading constant file : "<< m_constantFileName);
       return StatusCode::FAILURE;
     }
   } else { // use spline 
     if(!readMCJESFromHists()) {
       ATH_MSG_ERROR("Problem when reading constant file : "<< m_histoFileName);
       return StatusCode::FAILURE;
     }
   }
     
   ATH_CHECK( m_vartoolE.retrieve() ); 
   ATH_CHECK( m_vartoolEta.retrieve() );
  
   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.

◆ loadSplineHists()

void EtaMassJESCalibStep::loadSplineHists	(	const std::string &	fileName,
		const std::string &	etajes_name
	)

private

Definition at line 317 of file JESCalibStep.cxx.

 {
   std::unique_ptr<TFile> tmpF(TFile::Open( fileName.c_str() ));
   TList *etajes_l = static_cast<TList*>( tmpF->Get(etajes_name.c_str()));
  
   m_etajesFactors.resize( etajes_l->GetSize() );
   if(etajes_l->GetSize() != m_etaBinAxis->GetNbins()+1){
     ATH_MSG_WARNING("Do not have the correct number of eta bins for " << fileName << "\t" << etajes_name << "\t" << etajes_l->GetSize() );
   }
  
   for(int i=0 ; i<m_etaBinAxis->GetNbins(); i++){
     auto *pTH1 = dynamic_cast<TH1*>(etajes_l->At(i));
     if (not pTH1) continue;
     m_etajesFactors[i].reset(pTH1);
     m_etajesFactors[i]->SetDirectory(nullptr);
   }
   tmpF->Close();
 }

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

◆ readMCJESFromHists()

bool EtaMassJESCalibStep::readMCJESFromHists ( )

private

Definition at line 155 of file JESCalibStep.cxx.

 { 
   // Open the input file
   std::string local_path=static_cast<std::string> (m_constantFileName);
   std::string fileName = PathResolverFindCalibFile(m_constantFileName);
  
   TEnv config(fileName.c_str());
   if(fileName=="") return false;
  
   std::string jetAlgo=static_cast<std::string> (m_jetAlgo);
  
   std::vector<double> etaBins = VectorizeD(config.GetValue("JES.EtaBins","")," ");
   if (etaBins.size()==0){ // default binning
     for (int i=0;i<=90; i++) 
       etaBins.push_back(0.1*i-4.5);
   }
  
   ATH_MSG_DEBUG("Number eta bins: " << etaBins.size());
  
   m_etaBinAxis = new TAxis(etaBins.size()-1,&etaBins[0]);// this is to search for eta bin
  
   std::string calibHistFile = PathResolverFindCalibFile(m_histoFileName);
   loadSplineHists(calibHistFile, "etaJes");
  
   //Protections for high order extrapolation methods at low Et (Et < _minPt_JES)
   if(m_lowPtExtrap != 1) {
     ATH_MSG_ERROR("Only linear extrapolations are supported for p-splines currently. Please change the config file to reflect this");
     return false;
   }
  
   for (uint ieta=0;ieta<etaBins.size()-1;++ieta) {
     //Calculate the slope of the response curve at the minPt for each eta bin
     //Used in the GetLowPtJES method when Pt < minPt
     double Ecutoff= m_minPt_JES*cosh(etaBins[ieta]);
     const double Rcutoff = getSplineCorr(ieta, Ecutoff);
     const double Slope = getSplineSlope(ieta, Ecutoff);
     if(Slope > Rcutoff/Ecutoff) ATH_MSG_WARNING("Slope of calibration curve at minimum ET is too steep for the JES factors of etabin " << ieta << ", eta = " << etaBins[ieta] );
       
     m_JES_MinPt_E[ieta] = Ecutoff;
     m_JES_MinPt_R[ieta] = Rcutoff;
     m_JES_MinPt_Slopes[ieta] = Slope;
  
     TString key=Form("EmaxJES.%s_Bin%d",jetAlgo.c_str(),ieta);
     ATH_MSG_VERBOSE("reading: " << key << " = "<< config.GetValue(key,""));
     std::vector<double> params = VectorizeD(config.GetValue(key,"")," ");
     m_energyFreezeJES[ieta] = params[0];
     
     key=Form("EtaCorr.%s_Bin%d",jetAlgo.c_str(),ieta);
     ATH_MSG_VERBOSE("reading: " << key << " = "<< config.GetValue(key,""));
     params = VectorizeD(config.GetValue(key,"")," ");
     m_nPar = params.size(); 
     ATH_MSG_VERBOSE("Number of parameters: " << m_nPar);            
     for (uint ipar=0;ipar<m_nPar;++ipar) m_etaCorrFactors[ieta][ipar] = params[ipar];
  
     
   }
   return true;
 }

◆ readMCJESFromText()

bool EtaMassJESCalibStep::readMCJESFromText ( )

private

Definition at line 87 of file JESCalibStep.cxx.

 {
   // Open the input file
   std::string local_path=static_cast<std::string> (m_constantFileName);
   std::string fileName = PathResolverFindCalibFile(m_constantFileName);
   if(fileName=="") return false;
     
   TEnv config(fileName.c_str());
  
   std::string jetAlgo=static_cast<std::string> (m_jetAlgo);
  
   std::vector<double> etaBins = VectorizeD(config.GetValue("JES.EtaBins","")," ");
   if (etaBins.size()==0){ // default binning
     for (int i=0;i<=90; i++) 
       etaBins.push_back(0.1*i-4.5);
   }
  
   ATH_MSG_DEBUG("Number eta bins: " << etaBins.size());
  
   m_etaBinAxis = new TAxis(etaBins.size()-1,&etaBins[0]);// this is to search for eta bin
  
   for (uint ieta=0; ieta<etaBins.size()-1; ++ieta)
     {
       TString key=Form("JES.%s_Bin%d",jetAlgo.c_str(),ieta);
       ATH_MSG_VERBOSE("reading: " << key << " = "<< config.GetValue(key,""));
       std::vector<double> params = VectorizeD(config.GetValue(key,"")," ");
       m_nPar = params.size();   
       ATH_MSG_VERBOSE("Number of parameters: " << m_nPar);      
       for (uint ipar=0;ipar<m_nPar;++ipar) m_JESFactors[ieta][ipar] = params[ipar];
       if(m_lowPtExtrap > 0) {
     //Calculate the slope of the response curve at the minPt for each eta bin
     //Used in the GetLowPtJES method when Pt < minPt
     const double *factors = m_JESFactors[ieta];
     double Ecutoff = m_minPt_JES*cosh(etaBins[ieta]);
     const double Rcutoff = getLogPolN(factors,Ecutoff);
     const double Slope = getLogPolNSlope(factors,Ecutoff);
     if(Slope > Rcutoff/Ecutoff) ATH_MSG_FATAL("Slope of calibration curve at minimum ET is too steep for the JES factors of etabin " << ieta << ", eta = " << etaBins[ieta] );
  
     m_JES_MinPt_E[ieta] = Ecutoff;
     m_JES_MinPt_R[ieta] = Rcutoff;
     m_JES_MinPt_Slopes[ieta] = Slope;
     
     //Calculate the parameters for a 2nd order polynomial extension to the calibration curve below minimum ET
     //Used in the GetLowPtJES method when Pt < minPt
     if(m_lowPtExtrap == 2) {
       ATH_MSG_ERROR("LowPtJESExtrapolationMethod==2 not supported yet");
       return false;
     }
       }
  
       
       key=Form("EtaCorr.%s_Bin%d",jetAlgo.c_str(),ieta);
       ATH_MSG_VERBOSE("reading: " << key << " = "<< config.GetValue(key,""));
       params = VectorizeD(config.GetValue(key,"")," ");
       m_nPar = params.size();   
       ATH_MSG_VERBOSE("Number of parameters: " << m_nPar);            
       for (uint ipar=0;ipar<m_nPar;++ipar) m_etaCorrFactors[ieta][ipar] = params[ipar];
       
       key=Form("EmaxJES.%s_Bin%d",jetAlgo.c_str(),ieta);
       ATH_MSG_VERBOSE("reading: " << key << " = "<< config.GetValue(key,""));
       params = VectorizeD(config.GetValue(key,"")," ");
       m_energyFreezeJES[ieta] = params[0];
     }
   return true;
 }

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

Gaudi::Property< std::string > EtaMassJESCalibStep::m_constantFileName { this, "CalibConstantFile", "/afs/cern.ch/work/s/stapiaar/JetDev4/athena/JetToolHelpers/data/file_JES.config", "text file containing constants" }

private

name of the text file

Definition at line 65 of file JESCalibStep.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_energyFreezeJES

double EtaMassJESCalibStep::m_energyFreezeJES[s_nEtaBins] {}

private

Definition at line 90 of file JESCalibStep.h.

◆ m_etaBinAxis

TAxis* EtaMassJESCalibStep::m_etaBinAxis {}

private

Definition at line 96 of file JESCalibStep.h.

◆ m_etaCorrFactors

double EtaMassJESCalibStep::m_etaCorrFactors[s_nEtaBins][s_nParMax] {}

private

Definition at line 89 of file JESCalibStep.h.

◆ m_etajesFactors

std::vector<std::unique_ptr<TH1> > EtaMassJESCalibStep::m_etajesFactors

private

Definition at line 98 of file JESCalibStep.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_freezeJESatHighE

Gaudi::Property< bool > EtaMassJESCalibStep::m_freezeJESatHighE = {this, "FreezeJEScorrectionatHighE",false, " freeze at high e"}

private

Definition at line 69 of file JESCalibStep.h.

◆ m_histoFileName

Gaudi::Property< std::string > EtaMassJESCalibStep::m_histoFileName { this, "HistoFile", "none", "root file containing histos for spline calib" }

private

Definition at line 76 of file JESCalibStep.h.

◆ m_JES_MinPt_E

double EtaMassJESCalibStep::m_JES_MinPt_E[s_nEtaBins] ={}

private

Definition at line 92 of file JESCalibStep.h.

◆ m_JES_MinPt_R

double EtaMassJESCalibStep::m_JES_MinPt_R[s_nEtaBins] ={}

private

Definition at line 93 of file JESCalibStep.h.

◆ m_JES_MinPt_Slopes

double EtaMassJESCalibStep::m_JES_MinPt_Slopes[s_nEtaBins] ={}

private

Definition at line 91 of file JESCalibStep.h.

◆ m_JESFactors

double EtaMassJESCalibStep::m_JESFactors[s_nEtaBins][s_nParMax] {}

private

Definition at line 88 of file JESCalibStep.h.

◆ m_jetAlgo

Gaudi::Property< std::string > EtaMassJESCalibStep::m_jetAlgo { this, "JetAlgo", "AntiKt4EMPFlow", "jet collection" }

private

jet collection to be calibrated

Definition at line 67 of file JESCalibStep.h.

◆ m_lowPtExtrap

Gaudi::Property< float > EtaMassJESCalibStep::m_lowPtExtrap = {this, "LowPtJESExtrapolationMethod", 0, " low pt etrap"}

private

Definition at line 70 of file JESCalibStep.h.

◆ m_lowPtMinR

Gaudi::Property< float > EtaMassJESCalibStep::m_lowPtMinR = {this, "LowPtJESExtrapolationMinimumResponse", 0.25, " low pt etrap min"}

private

Definition at line 71 of file JESCalibStep.h.

◆ m_maxE_EtaCorr

Gaudi::Property< float > EtaMassJESCalibStep::m_maxE_EtaCorr = {this, "MaxEForEtaCorr" ,2500. , ""}

private

Definition at line 74 of file JESCalibStep.h.

◆ m_minPt_EtaCorr

Gaudi::Property< float > EtaMassJESCalibStep::m_minPt_EtaCorr = {this, "MinPtForEtaCorr" ,8. , ""}

private

Definition at line 73 of file JESCalibStep.h.

◆ m_minPt_JES

Gaudi::Property< float > EtaMassJESCalibStep::m_minPt_JES = {this, "MinPtForETAJES",15, "min pT"}

private

Definition at line 68 of file JESCalibStep.h.

◆ m_nPar

unsigned int EtaMassJESCalibStep::m_nPar {}

private

Definition at line 85 of file JESCalibStep.h.

◆ m_useSpline

Gaudi::Property< bool > EtaMassJESCalibStep::m_useSpline = {this, "UseSpline",false, " use spline"}

private

Definition at line 77 of file JESCalibStep.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vartoolE

ToolHandle<JetHelper::IVarTool> EtaMassJESCalibStep::m_vartoolE {this, "VarToolE", "VarTool", "InputVariable instance E (or pT?)" }

private

Definition at line 80 of file JESCalibStep.h.

◆ m_vartoolEta

ToolHandle<JetHelper::IVarTool> EtaMassJESCalibStep::m_vartoolEta {this, "VarToolEta", "VarTool", "InputVariable instance eta (or rapididty?)" }

private

interface for xAOD::jet variable to be defined by user, this must correspond to jet Eta in currect version of jet calibration files

Definition at line 82 of file JESCalibStep.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ s_nEtaBins

const unsigned int EtaMassJESCalibStep::s_nEtaBins = 90

staticprivate

Definition at line 86 of file JESCalibStep.h.

◆ s_nParMax

const unsigned int EtaMassJESCalibStep::s_nParMax = 9

staticprivate

Definition at line 87 of file JESCalibStep.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EtaMassJESCalibStep()

Member Function Documentation

◆ 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()

◆ getEmaxJES()

◆ getEtaBin()

◆ getEtaCorr()

◆ getJES()

◆ getKey()

◆ getLogPolN()

◆ getLogPolNSlope()

◆ getLowPtJES()

◆ getName()

◆ getNominalResolutionData()

◆ getNominalResolutionMC()

◆ getProperty()

◆ getSplineCorr()

◆ getSplineSlope()

◆ initialize()

◆ inputHandles()

◆ loadSplineHists()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ readMCJESFromHists()

◆ readMCJESFromText()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_constantFileName

◆ m_detStore

◆ m_energyFreezeJES

◆ m_etaBinAxis

◆ m_etaCorrFactors

◆ m_etajesFactors

◆ m_evtStore

◆ m_freezeJESatHighE

◆ m_histoFileName

◆ m_JES_MinPt_E

◆ m_JES_MinPt_R

◆ m_JES_MinPt_Slopes

◆ m_JESFactors

◆ m_jetAlgo

◆ m_lowPtExtrap

◆ m_lowPtMinR

◆ m_maxE_EtaCorr

◆ m_minPt_EtaCorr

◆ m_minPt_JES

◆ m_nPar

◆ m_useSpline

◆ m_varHandleArraysDeclared