#include <IsolationCorrectionTool.h>

Inheritance diagram for CP::IsolationCorrectionTool:

Collaboration diagram for CP::IsolationCorrectionTool:

Public Member Functions
virtual void	print () const =0
	Print the state of the tool. More...

virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena. More...

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

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

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

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

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

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

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

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &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

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
virtual ASG_TOOL_CLASS3(IsolationCorrectionTool, IIsolationCorrectionTool, CP::ISystematicsTool, CP::IReentrantSystematicsTool) public	~IsolationCorrectionTool ()

virtual StatusCode	initialize () override final

virtual CP::CorrectionCode	applyCorrection (xAOD::Egamma &) override final

virtual CP::CorrectionCode	CorrectLeakage (xAOD::Egamma &) override final

virtual CP::CorrectionCode	correctedCopy (const xAOD::Egamma &, xAOD::Egamma *&) override final

virtual CP::SystematicSet	affectingSystematics () const override final
	the list of all systematics this tool can be affected by More...

virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const override final
	Declare the interface that this class provides. More...

virtual CP::SystematicSet	recommendedSystematics () const override final
	the list of all systematics this tool recommends to use More...

virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systConfig) override final
	effects: configure this tool for the given list of systematic variations. More...

virtual float	GetPtCorrectedIsolation (const xAOD::Egamma &, xAOD::Iso::IsolationType) override

virtual float	GetPtCorrection (const xAOD::Egamma &, xAOD::Iso::IsolationType) const override final

virtual float	GetDDCorrection (const xAOD::Egamma &, xAOD::Iso::IsolationType) override final

void	Print ()

float	GetEtaPointing (const xAOD::Egamma *input)

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_eventInfoKey

SG::ReadHandleKey< xAOD::EventShape >	m_centralEventShapeKey

SG::ReadHandleKey< xAOD::EventShape >	m_forwardEventShapeKey

std::string	m_corr_file

std::string	m_corr_ddshift_file

std::string	m_corr_ddsmearing_file

IsolationCorrection *	m_isol_corr

std::string	m_tool_ver_str

std::string	m_corr_etaEDParPU_file

std::string	m_corr_etaEDPar_mc_corr_file

std::map< xAOD::Iso::IsolationType, std::unique_ptr< TGraph > >	m_map_isotype_zetaPU

std::map< xAOD::Iso::IsolationType, std::unique_ptr< TGraph > >	m_map_isotype_zeta_mc_corr

std::string	m_ddVersion

bool	m_apply_SC_leak_corr

bool	m_apply_etaEDParPU_corr

bool	m_apply_etaEDParPU_mc_corr

bool	m_is_mc

bool	m_AFII_corr

bool	m_apply_dd {}

bool	m_apply_ddDefault

bool	m_correct_etcone

bool	m_trouble_categories

bool	m_useLogLogFit

bool	m_forcePartType

CP::SystematicVariation	m_systDDonoff

MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store. More...

MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store. More...

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

bool	m_useIncidents

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

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

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

bool	m_varHandleArraysDeclared

Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)

virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent. More...

virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened. More...

virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed. More...

virtual StatusCode	beginEvent ()
	Function called when a new events is loaded. More...

virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata. More...

Detailed Description

Definition at line 24 of file IsolationCorrectionTool.h.

Member Typedef Documentation

◆ MetaStore_t

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

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

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

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~IsolationCorrectionTool()

CP::IsolationCorrectionTool::~IsolationCorrectionTool ( )

privatevirtual

Definition at line 390 of file IsolationCorrectionTool.cxx.

                                                     {
     delete m_isol_corr;
   }

Member Function Documentation

◆ affectingSystematics()

CP::SystematicSet CP::IsolationCorrectionTool::affectingSystematics ( ) const

finaloverrideprivatevirtual

the list of all systematics this tool can be affected by

Implements CP::IIsolationCorrectionTool.

Definition at line 377 of file IsolationCorrectionTool.cxx.

                                                                       {
     CP::SystematicSet result;
     return result;
   }

◆ applyCorrection()

CP::CorrectionCode CP::IsolationCorrectionTool::applyCorrection ( xAOD::Egamma & eg )

finaloverrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 209 of file IsolationCorrectionTool.cxx.

                                                                           {
  
     static const SG::AuxElement::Accessor<float> decDDcor20("topoetcone20_DDcorr");
     static const SG::AuxElement::Accessor<float> decDDcor40("topoetcone40_DDcorr");
  
     float SCsub = 0;
     if(m_apply_SC_leak_corr){
       float topoetconecoreConeEnergyCorrection = 0;
       if(!eg.isolationCaloCorrection(topoetconecoreConeEnergyCorrection, xAOD::Iso::topoetcone, xAOD::Iso::coreCone, xAOD::Iso::coreEnergy)){
           ATH_MSG_WARNING("Could not find SC based core");
       }
       float core57cells = 0.;
       if(!eg.isolationCaloCorrection(core57cells, xAOD::Iso::topoetcone, xAOD::Iso::core57cells, xAOD::Iso::coreEnergy)){
           ATH_MSG_WARNING("Could not find core57cells to apply SC based core correction");
       }
       ATH_MSG_VERBOSE("Old core correction value: " << core57cells);
       ATH_MSG_VERBOSE("SC based core correction value: " << topoetconecoreConeEnergyCorrection);
       SCsub = - topoetconecoreConeEnergyCorrection + core57cells;
     }
  
     float centralDensity = 0.;
     float forwardDensity = 0.;
     if(m_apply_etaEDParPU_corr){
       SG::ReadHandle<xAOD::EventShape> shapeCentral (m_centralEventShapeKey);
       SG::ReadHandle<xAOD::EventShape> shapeForward (m_forwardEventShapeKey);
       const xAOD::EventShape* evtShapeCentral = shapeCentral.ptr();
       const xAOD::EventShape* evtShapeForward = shapeForward.ptr();
       centralDensity = evtShapeCentral->getDensity(xAOD::EventShape::Density);
       forwardDensity = evtShapeForward->getDensity(xAOD::EventShape::Density);
     }
  
     static const std::vector<xAOD::Iso::IsolationType> topoisolation_types = {xAOD::Iso::topoetcone20,
                                                                                                 xAOD::Iso::topoetcone30,
                                                                                                 xAOD::Iso::topoetcone40};
     for (auto type : topoisolation_types) {
       float oldleak = 0.;
       if (!eg.isolationCaloCorrection(oldleak, type, xAOD::Iso::ptCorrection)) {
           ATH_MSG_DEBUG("leakage correction not stored for isolation type " << xAOD::Iso::toCString(type) << ". Nothing done");
           continue;
       }
       float oldiso  = 0;
       bool gotIso   = eg.isolationValue(oldiso,type);
       if (!gotIso) continue;
  
       // Use the Random Run Number from the Event Info to check which year's DD-Corrections to use
       // If the RandomRunNo can't be obtained, then default to what is set by either the default choice or by the AuxData check
       unsigned int theRunNumber = 0 ;
       SG::ReadHandle<xAOD::EventInfo> evtInfo (m_eventInfoKey);
       const xAOD::EventInfo* eventInfo = evtInfo.ptr();
       if (eventInfo) {
           static const SG::AuxElement::Accessor<unsigned int> randomrunnumber("RandomRunNumber");
           if (randomrunnumber.isAvailable(*eventInfo)){
             theRunNumber = randomrunnumber(*(eventInfo)) ;
         }
       } else{
           ATH_MSG_WARNING("Could not retrieve EventInfo object");
       }
       if (theRunNumber >= 320000)
           m_ddVersion = "2017" ;      // RunNo found, and is in 2017 range
       else if (theRunNumber > 0)
           m_ddVersion = "2015_2016" ; // RunNo found, but less than 2017 range
       // otherwise, stick with default (m_ddVersion is already assigned)
  
       // Don't use DD Corrections for AFII if not rel21 ? (I do not know what was done for rel20.7 !!!)
       if (m_tool_ver_str != "REL21" && m_AFII_corr) m_apply_dd = false;
  
       float iso     = oldiso;
       float newleak = 0.;
       if(m_apply_SC_leak_corr){
         ATH_MSG_VERBOSE("Iso before SC correction: " << iso);
         iso += (SCsub + oldleak);
         ATH_MSG_VERBOSE("Iso after SC correction: " << iso);
       }
       else {
         newleak = this->GetPtCorrection(eg,type);
         iso += (oldleak - newleak);
       }
       float ddcorr  = 0;
  
       // this correction is derived purly from data, but can also be applied to mc
       if(m_apply_etaEDParPU_corr){
         float abseta = fabs(eg.caloCluster()->etaBE(2));
         float densityOldCorrection = 0.;
         if(abseta <= 1.5){
           densityOldCorrection = centralDensity;
         }
         else{
           densityOldCorrection = forwardDensity;
         }
         float dR = xAOD::Iso::coneSize(type);
         static const float a_core = 5*7*0.025*TMath::Pi()/128;
         float area = TMath::Pi()*dR*dR-a_core;
         float oldpu_corr = densityOldCorrection*area;
         float newpu_corr = m_map_isotype_zetaPU[type]->Eval(abseta)*centralDensity*area;
         float pu_mc_corr = 0.;
         if(m_apply_etaEDParPU_mc_corr && m_is_mc){
           pu_mc_corr += m_map_isotype_zeta_mc_corr[type]->Eval(abseta)*centralDensity*area;
         }
         iso = iso + oldpu_corr - newpu_corr + pu_mc_corr;
         ATH_MSG_VERBOSE("Applying parametrized pileup correction to " << eg.type() << " with |eta|="<< abseta);
         ATH_MSG_VERBOSE("Old parametrized pileup correction for "<<xAOD::Iso::toCString(type)<< ": "<<oldpu_corr);
         ATH_MSG_VERBOSE("New parametrized pileup correction for "<<xAOD::Iso::toCString(type)<< ": "<<newpu_corr);
         ATH_MSG_VERBOSE("Parametrized mc correction for "<<xAOD::Iso::toCString(type)<< ": "<<pu_mc_corr);
         ATH_MSG_VERBOSE("Isolation after new correction for "<<xAOD::Iso::toCString(type)<< ": "<<iso);
         ATH_MSG_VERBOSE("Isolation after old correction for "<<xAOD::Iso::toCString(type)<< ": "<<iso+newpu_corr-oldpu_corr-pu_mc_corr);
         eg.setIsolationCaloCorrection(newpu_corr, type, xAOD::Iso::pileupCorrection);
       }
  
       if (m_is_mc && m_apply_dd && type != xAOD::Iso::topoetcone30 && eg.type() == xAOD::Type::Photon) {
           ddcorr = this->GetDDCorrection(eg,type);
           if (type == xAOD::Iso::topoetcone20)
             decDDcor20(eg) = ddcorr;
           else if (type == xAOD::Iso::topoetcone40)
             decDDcor40(eg) = ddcorr;
           iso += ddcorr;
       }
       bool setIso = eg.setIsolationValue(iso,type);
       setIso = (setIso && eg.setIsolationCaloCorrection(newleak-ddcorr,type,xAOD::Iso::ptCorrection));
       ATH_MSG_VERBOSE("oldeak = " << oldleak << " ddcor = " << ddcorr << " leak param = " << newleak
               << " stored correction " << eg.isolationCaloCorrection(type,xAOD::Iso::ptCorrection));
  
       if (!setIso) {
         ATH_MSG_WARNING("Can't correct leakage for " << xAOD::Iso::toCString(type));
         return CP::CorrectionCode::Error;
       }
     }
     return CP::CorrectionCode::Ok;
   }

◆ applySystematicVariation()

StatusCode CP::IsolationCorrectionTool::applySystematicVariation ( const CP::SystematicSet & systConfig )

finaloverrideprivatevirtual

effects: configure this tool for the given list of systematic variations.

any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). failures: systematic unknown failures: requesting multiple variations on the same systematic (e.g. up & down) failures: requesting an unsupported variation on an otherwise supported systematic (e.g. a 2 sigma variation and the tool only supports 1 sigma variations) failures: unsupported combination of supported systematic failures: other tool specific errors

Implements CP::IIsolationCorrectionTool.

Definition at line 386 of file IsolationCorrectionTool.cxx.

                                                                                        {
     return StatusCode::SUCCESS;
   }

◆ beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )

protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

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

Definition at line 196 of file AsgMetadataTool.cxx.

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

◆ beginInputFile()

StatusCode asg::AsgMetadataTool::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

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

Definition at line 180 of file AsgMetadataTool.cxx.

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

◆ correctedCopy()

CP::CorrectionCode CP::IsolationCorrectionTool::correctedCopy	(	const xAOD::Egamma &	input,
		xAOD::Egamma *&	output
	)

finaloverrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 350 of file IsolationCorrectionTool.cxx.

                                                                                                        {
     // A sanity check:
     if( output ) ATH_MSG_WARNING( "Non-null pointer received. There's a possible memory leak!" );
  
     if ( input.type() == xAOD::Type::Electron ) {
       output = new xAOD::Electron();
       output->makePrivateStore( static_cast<const xAOD::Electron&>(input) );
       return applyCorrection( *output );
     }
     else if ( input.type() == xAOD::Type::Photon ) {
       output = new xAOD::Photon();
       output->makePrivateStore( static_cast<const xAOD::Photon&>(input) );
       return applyCorrection( *output );
     }
     else {
       ATH_MSG_WARNING("Didn't get an electron or photon");
       return CP::CorrectionCode::Error;
     }
  
   }

◆ CorrectLeakage()

CP::CorrectionCode CP::IsolationCorrectionTool::CorrectLeakage ( xAOD::Egamma & eg )

finaloverrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 167 of file IsolationCorrectionTool.cxx.

                                                                           {
  
     static const std::vector<xAOD::Iso::IsolationType> topoisolation_types = {xAOD::Iso::topoetcone20,
                                                                                           xAOD::Iso::topoetcone40};
  
     for (auto type : topoisolation_types) {
       float oldleak = 0.;
       if (eg.isolationCaloCorrection(oldleak, type, xAOD::Iso::ptCorrection)) {
           ATH_MSG_DEBUG("leakage correction not stored for isolation type " << xAOD::Iso::toCString(type) << ". Nothing done.");
           continue;
       }
       float newleak = this->GetPtCorrection(eg,type);
       float iso     = 0;
       if (!eg.isolationValue(iso,type)) {
           ATH_MSG_WARNING("Isolation variable " << xAOD::Iso::toCString(type) << " not stored. Nothing done.");
           continue;
       }
       iso += (oldleak-newleak);
       bool setIso = eg.setIsolationValue(iso,type);
       setIso = (setIso && eg.setIsolationCaloCorrection(newleak,type,xAOD::Iso::ptCorrection));
       if (!setIso) {
           ATH_MSG_WARNING("Can't correct leakage for " << xAOD::Iso::toCString(type));
           return CP::CorrectionCode::Error;
       }
     }
  
     if (m_correct_etcone){
       // this is supposed to correct an uncorrected etcone
       static const std::vector<xAOD::Iso::IsolationType> isolation_types = {xAOD::Iso::etcone20,
                                                                                       xAOD::Iso::etcone30,
                                                                                       xAOD::Iso::etcone40};
  
       ATH_MSG_VERBOSE( "Correcting etconeXX isolation..." );
       for(auto type : topoisolation_types){
         float Etcone_value_corr = m_isol_corr->GetPtCorrectedIsolation(eg,type);
         eg.setIsolationValue(Etcone_value_corr,type);
       }
     }
  
     return CP::CorrectionCode::Ok;
   }

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

◆ endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

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

Dummy implementation that can be overridden by the derived tool.

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

Definition at line 188 of file AsgMetadataTool.cxx.

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

◆ 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

◆ GetDDCorrection()

float CP::IsolationCorrectionTool::GetDDCorrection	(	const xAOD::Egamma &	input,
		xAOD::Iso::IsolationType	isol
	)

finaloverrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 346 of file IsolationCorrectionTool.cxx.

                                                                                                   {
     return m_isol_corr->GetDDCorrection(input, isol, m_ddVersion);
   }

◆ GetEtaPointing()

float CP::IsolationCorrectionTool::GetEtaPointing ( const xAOD::Egamma * input )

inlineprivate

Definition at line 71 of file IsolationCorrectionTool.h.

   {
     return m_isol_corr->GetEtaPointing(input);
   };

◆ getKey()

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

inherited

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

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

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

See also: asg::AsgTool::getName

Parameters

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

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

Definition at line 119 of file AsgTool.cxx.

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

◆ getName()

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

inherited

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

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

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

See also: asg::AsgTool::getKey

Parameters

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

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

Definition at line 106 of file AsgTool.cxx.

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

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ GetPtCorrectedIsolation()

float CP::IsolationCorrectionTool::GetPtCorrectedIsolation	(	const xAOD::Egamma &	input,
		xAOD::Iso::IsolationType	isol
	)

overrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 338 of file IsolationCorrectionTool.cxx.

                                                                                                           {
     return m_isol_corr->GetPtCorrectedIsolation(input, isol);
   }

◆ GetPtCorrection()

float CP::IsolationCorrectionTool::GetPtCorrection	(	const xAOD::Egamma &	input,
		xAOD::Iso::IsolationType	isol
	)		const

finaloverrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 342 of file IsolationCorrectionTool.cxx.

                                                                                                          {
     return m_isol_corr->GetPtCorrection(input, isol);
   }

◆ handle()

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

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 130 of file AsgMetadataTool.cxx.

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

◆ initialize()

StatusCode CP::IsolationCorrectionTool::initialize ( )

finaloverrideprivatevirtual

Implements CP::IIsolationCorrectionTool.

Definition at line 46 of file IsolationCorrectionTool.cxx.

                                                  {
     ATH_MSG_INFO( "in initialize of " << name() << "..." );
  
     //ReadHandles
     ATH_CHECK(m_eventInfoKey.initialize());
     ATH_CHECK(m_centralEventShapeKey.initialize(m_apply_etaEDParPU_corr));
     ATH_CHECK(m_forwardEventShapeKey.initialize(m_apply_etaEDParPU_corr));
  
     //
     m_isol_corr->msg().setLevel(this->msg().level());
     //
     // Resolve the paths to the input files
     std::vector < std::string > corrFileNameList;
     corrFileNameList.push_back(m_corr_file);
     corrFileNameList.push_back(m_corr_ddshift_file);
     corrFileNameList.push_back(m_corr_ddsmearing_file);
  
     for ( unsigned int i=0; i<corrFileNameList.size(); ++i ){
  
       //First try the PathResolver
       std::string filename = PathResolverFindCalibFile( corrFileNameList.at(i) );
       if (filename.empty()){
           ATH_MSG_ERROR ( "Could NOT resolve file name " << corrFileNameList.at(i) );
           return StatusCode::FAILURE ;
       } else{
           ATH_MSG_INFO(" Path found = "<<filename);
       }
       corrFileNameList.at(i) = filename;
     }
     //
  
     CP::IsolationCorrection::Version tool_ver;
  
     if      (m_tool_ver_str == "REL22")   tool_ver = CP::IsolationCorrection::REL22;
     else if (m_tool_ver_str == "REL21")   tool_ver = CP::IsolationCorrection::REL21;
     else if (m_tool_ver_str == "REL20_2") tool_ver = CP::IsolationCorrection::REL20_2;
     else if (m_tool_ver_str == "REL17_2") tool_ver = CP::IsolationCorrection::REL17_2;
     else {
       ATH_MSG_WARNING("Tool version not recognized: "<<m_tool_ver_str<<"\nAllowed versions: REL22, REL21, REL20_2, REL17_2");
       return StatusCode::FAILURE;
     }
  
     if(TString(corrFileNameList[0]).Contains("isolation_ptcorrections_rel17_2.root") && m_tool_ver_str != "REL17_2"){
       ATH_MSG_WARNING("The specified correction file is not for "<<m_tool_ver_str<<" please use proper correction file");
       return StatusCode::FAILURE;
     }
  
     if (TString(corrFileNameList[0]).Contains("isolation_ptcorrections_rel20_2.root") && !( m_tool_ver_str == "REL20_2" || m_tool_ver_str == "REL21" ) ){
       ATH_MSG_WARNING("The specified correction file is not for "<<m_tool_ver_str<<" please use proper correction file");
       return StatusCode::FAILURE;
     }
     if (TString(corrFileNameList[0]).Contains("isolation_ptcorrections_rel22_") &&  m_tool_ver_str != "REL22" ){
       ATH_MSG_WARNING("The specified correction file is not for "<<m_tool_ver_str<<" please use proper correction file");
       return StatusCode::FAILURE;
     }
  
     m_isol_corr->SetCorrectionFile(m_corr_file, m_corr_ddshift_file, m_corr_ddsmearing_file);
     m_isol_corr->SetToolVer(tool_ver);
     m_isol_corr->SetTroubleCategories(m_trouble_categories);
     m_isol_corr->FitType(m_useLogLogFit);
     m_isol_corr->ForcePartType(m_forcePartType);
  
     // Note that systematics in Rel 21 are NOT done with the DD-Corr ON/OFF method!
     if (m_apply_ddDefault) {
       if (m_ddVersion == "2015" || m_ddVersion == "2015_2016" || m_ddVersion == "2017") {
         //if not REL21, register ourselves with the systematic registry!
           if (m_tool_ver_str!="REL21") {
             CP::SystematicRegistry& registry = CP::SystematicRegistry::getInstance();
             if( registry.registerSystematics( *this ) != StatusCode::SUCCESS ) return StatusCode::FAILURE;
           }
           m_apply_dd = true;
       } else {
           ATH_MSG_WARNING("Unknown data driven correction");
           m_apply_dd = false;
       }
     } else{
       m_apply_dd = false;
     }
  
     // Don't use DD Corrections for AFII if not rel21 (I do not know what was done in rel20.7 !)
     if (m_tool_ver_str != "REL21" && m_AFII_corr) m_apply_dd = false;
  
     m_isol_corr->SetAFII(m_AFII_corr);
     m_isol_corr->SetDataMC(m_is_mc);
  
     if(m_apply_etaEDParPU_corr){
       std::string filename = PathResolverFindCalibFile( m_corr_etaEDParPU_file );
       if (filename.empty()){
         ATH_MSG_ERROR ( "Could NOT resolve file name " << m_corr_etaEDParPU_file );
         return StatusCode::FAILURE ;
       }
       ATH_MSG_INFO(" Path found = "<<filename);
       std::unique_ptr<TFile> f(TFile::Open(filename.c_str(), "READ"));
  
       m_map_isotype_zetaPU[xAOD::Iso::topoetcone20] = std::unique_ptr<TGraph>((TGraph*)f->Get("topoetcone20"));
       m_map_isotype_zetaPU[xAOD::Iso::topoetcone30] = std::unique_ptr<TGraph>((TGraph*)f->Get("topoetcone30"));
       m_map_isotype_zetaPU[xAOD::Iso::topoetcone40] = std::unique_ptr<TGraph>((TGraph*)f->Get("topoetcone40"));
       f->Close();
  
       if(m_apply_etaEDParPU_mc_corr){
         std::string filename = PathResolverFindCalibFile( m_corr_etaEDPar_mc_corr_file );
         if (filename.empty()){
           ATH_MSG_ERROR ( "Could NOT resolve file name " << m_corr_etaEDPar_mc_corr_file );
           return StatusCode::FAILURE ;
         }
         ATH_MSG_INFO(" Path found = "<<filename);
         std::unique_ptr<TFile> f_corr(TFile::Open(filename.c_str(), "READ"));
  
         m_map_isotype_zeta_mc_corr[xAOD::Iso::topoetcone20] = std::unique_ptr<TGraph>((TGraph*)f_corr->Get("topoetcone20"));
         m_map_isotype_zeta_mc_corr[xAOD::Iso::topoetcone30] = std::unique_ptr<TGraph>((TGraph*)f_corr->Get("topoetcone30"));
         m_map_isotype_zeta_mc_corr[xAOD::Iso::topoetcone40] = std::unique_ptr<TGraph>((TGraph*)f_corr->Get("topoetcone40"));
         f_corr->Close();
       }
     }
  
     return m_isol_corr->initialize();
   }

◆ inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

◆ inputMetaStore()

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

inherited

Accessor for the input metadata store.

Definition at line 88 of file AsgMetadataTool.cxx.

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

◆ isAffectedBySystematic()

bool CP::IsolationCorrectionTool::isAffectedBySystematic ( const CP::SystematicVariation & systematic ) const

finaloverrideprivatevirtual

Declare the interface that this class provides.

returns: whether this tool is affected by the given systematics

Implements CP::IIsolationCorrectionTool.

Definition at line 372 of file IsolationCorrectionTool.cxx.

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

◆ metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

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

Definition at line 204 of file AsgMetadataTool.cxx.

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

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

◆ outputMetaStore()

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

inherited

Accessor for the output metadata store.

Definition at line 97 of file AsgMetadataTool.cxx.

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

◆ Print()

void CP::IsolationCorrectionTool::Print ( )

inlineprivate

Definition at line 68 of file IsolationCorrectionTool.h.

68 { m_isol_corr->Print(); };

◆ print() [1/2]

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

◆ print() [2/2]

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

pure virtualinherited

Print the state of the tool.

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

◆ recommendedSystematics()

CP::SystematicSet CP::IsolationCorrectionTool::recommendedSystematics ( ) const

finaloverrideprivatevirtual

the list of all systematics this tool recommends to use

Implements CP::IIsolationCorrectionTool.

Definition at line 382 of file IsolationCorrectionTool.cxx.

                                                                         {
     return affectingSystematics();
   }

◆ renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setUseIncidents()

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

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

    {
       m_useIncidents = flag;
    }

◆ sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

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

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 110 of file AsgMetadataTool.cxx.

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_AFII_corr

bool CP::IsolationCorrectionTool::m_AFII_corr

private

Definition at line 111 of file IsolationCorrectionTool.h.

◆ m_apply_dd

bool CP::IsolationCorrectionTool::m_apply_dd {}

private

Definition at line 112 of file IsolationCorrectionTool.h.

◆ m_apply_ddDefault

bool CP::IsolationCorrectionTool::m_apply_ddDefault

private

Definition at line 112 of file IsolationCorrectionTool.h.

◆ m_apply_etaEDParPU_corr

bool CP::IsolationCorrectionTool::m_apply_etaEDParPU_corr

private

Definition at line 108 of file IsolationCorrectionTool.h.

◆ m_apply_etaEDParPU_mc_corr

bool CP::IsolationCorrectionTool::m_apply_etaEDParPU_mc_corr

private

Definition at line 109 of file IsolationCorrectionTool.h.

◆ m_apply_SC_leak_corr

bool CP::IsolationCorrectionTool::m_apply_SC_leak_corr

private

Definition at line 107 of file IsolationCorrectionTool.h.

◆ m_beginInputFileCalled

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

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

Definition at line 126 of file AsgMetadataTool.h.

◆ m_centralEventShapeKey

SG::ReadHandleKey<xAOD::EventShape> CP::IsolationCorrectionTool::m_centralEventShapeKey

private

Initial value:

{
    this,
    "CentralEventShapeKey",
    "TopoClusterIsoCentralEventShape",
    ""
  }

Definition at line 80 of file IsolationCorrectionTool.h.

◆ m_corr_ddshift_file

std::string CP::IsolationCorrectionTool::m_corr_ddshift_file

private

Definition at line 95 of file IsolationCorrectionTool.h.

◆ m_corr_ddsmearing_file

std::string CP::IsolationCorrectionTool::m_corr_ddsmearing_file

private

Definition at line 96 of file IsolationCorrectionTool.h.

◆ m_corr_etaEDPar_mc_corr_file

std::string CP::IsolationCorrectionTool::m_corr_etaEDPar_mc_corr_file

private

Definition at line 101 of file IsolationCorrectionTool.h.

◆ m_corr_etaEDParPU_file

std::string CP::IsolationCorrectionTool::m_corr_etaEDParPU_file

private

Definition at line 100 of file IsolationCorrectionTool.h.

◆ m_corr_file

std::string CP::IsolationCorrectionTool::m_corr_file

private

Definition at line 94 of file IsolationCorrectionTool.h.

◆ m_correct_etcone

bool CP::IsolationCorrectionTool::m_correct_etcone

private

Definition at line 113 of file IsolationCorrectionTool.h.

◆ m_ddVersion

std::string CP::IsolationCorrectionTool::m_ddVersion

private

Definition at line 106 of file IsolationCorrectionTool.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_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> CP::IsolationCorrectionTool::m_eventInfoKey

private

Initial value:

{ this,
                                                     "EventInfoKey",
                                                     "EventInfo",
                                                     "" }

Definition at line 76 of file IsolationCorrectionTool.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_forcePartType

bool CP::IsolationCorrectionTool::m_forcePartType

private

Definition at line 116 of file IsolationCorrectionTool.h.

◆ m_forwardEventShapeKey

SG::ReadHandleKey<xAOD::EventShape> CP::IsolationCorrectionTool::m_forwardEventShapeKey

private

Initial value:

{
    this,
    "ForwardEventShape",
    "TopoClusterIsoForwardEventShape",
    ""
  }

Definition at line 87 of file IsolationCorrectionTool.h.

◆ m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

◆ m_is_mc

bool CP::IsolationCorrectionTool::m_is_mc

private

Definition at line 110 of file IsolationCorrectionTool.h.

◆ m_isol_corr

IsolationCorrection* CP::IsolationCorrectionTool::m_isol_corr

private

Definition at line 97 of file IsolationCorrectionTool.h.

◆ m_map_isotype_zeta_mc_corr

std::map<xAOD::Iso::IsolationType, std::unique_ptr<TGraph> > CP::IsolationCorrectionTool::m_map_isotype_zeta_mc_corr

private

Definition at line 105 of file IsolationCorrectionTool.h.

◆ m_map_isotype_zetaPU

std::map<xAOD::Iso::IsolationType, std::unique_ptr<TGraph> > CP::IsolationCorrectionTool::m_map_isotype_zetaPU

private

Definition at line 103 of file IsolationCorrectionTool.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_systDDonoff

CP::SystematicVariation CP::IsolationCorrectionTool::m_systDDonoff

private

Definition at line 119 of file IsolationCorrectionTool.h.

◆ m_tool_ver_str

std::string CP::IsolationCorrectionTool::m_tool_ver_str

private

Definition at line 98 of file IsolationCorrectionTool.h.

◆ m_trouble_categories

bool CP::IsolationCorrectionTool::m_trouble_categories

private

Definition at line 114 of file IsolationCorrectionTool.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.h.

◆ m_useLogLogFit

bool CP::IsolationCorrectionTool::m_useLogLogFit

private

Definition at line 115 of file IsolationCorrectionTool.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 Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Callback functions helping in metadata reading/writing

Detailed Description

Member Typedef Documentation

◆ MetaStore_t

◆ MetaStorePtr_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~IsolationCorrectionTool()

Member Function Documentation

◆ affectingSystematics()

◆ applyCorrection()

◆ applySystematicVariation()

◆ beginEvent()

◆ beginInputFile()

◆ correctedCopy()

◆ CorrectLeakage()

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

◆ endInputFile()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ GetDDCorrection()

◆ GetEtaPointing()

◆ getKey()

◆ getName()

◆ getProperty()

◆ GetPtCorrectedIsolation()

◆ GetPtCorrection()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ inputMetaStore()

◆ isAffectedBySystematic()

◆ metaDataStop()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ outputMetaStore()

◆ Print()

◆ print() [1/2]

◆ print() [2/2]

◆ recommendedSystematics()

◆ renounce()

◆ renounceArray()

◆ setUseIncidents()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_AFII_corr

◆ m_apply_dd

◆ m_apply_ddDefault

◆ m_apply_etaEDParPU_corr

◆ m_apply_etaEDParPU_mc_corr

◆ m_apply_SC_leak_corr

◆ m_beginInputFileCalled

◆ m_centralEventShapeKey

◆ m_corr_ddshift_file

◆ m_corr_ddsmearing_file

◆ m_corr_etaEDPar_mc_corr_file

◆ m_corr_etaEDParPU_file

◆ m_corr_file

◆ m_correct_etcone