#include <InDetTrackSmearingTool.h>

Inheritance diagram for InDet::InDetTrackSmearingTool:

Collaboration diagram for InDet::InDetTrackSmearingTool:

Public Types
typedef xAOD::TrackParticleContainer	xAODContainerType
	description: the type of xAOD container used More...

typedef xAODContainerType::base_value_type	xAODObjectType
	description: the type of xAOD object used More...

Public Member Functions
virtual void	print () const =0
	Print the state of the tool. 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, V, H > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

virtual CorrectionCode	applyCorrection (xAODObjectType &inputObject)=0
	effects: apply the correction and store the output in the object returns: success More...

CorrectionCode	correctedCopy (const xAODObjectType &inputObject, xAODObjectType *&outputObject)
	effects: make a clone of the input object, apply the correction to it and store the output in the object returns: success rationale: the interface class provides a default implementation in terms of applyCorrection, that the derived classes can override for efficiency More...

CorrectionCode	applyContainerCorrection (xAODContainerType &inputContainer)
	effects: apply the correction to all the members of the container returns: overall success rationale: this will apply the correction to every single member (even if some members fail) rationale: the interface class provides a default implementation in terms of applyCorrection, that the derived classes can override for efficiency More...

Protected Member Functions
std::unique_ptr< TFile >	getFile (const std::string &) const
	open and return a file with the given name. More...

template<class T >
StatusCode	initObject (std::unique_ptr< T > &obj, const std::string &rootFileName, const std::string &objName) const
	a function to initialize an object from a root file More...

bool	isActive (TrackSystematic) const

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

Protected Attributes
std::unordered_map< CP::SystematicSet, CP::SystematicSet >	m_sysFilterMap

const CP::SystematicSet *	m_activeSysts = nullptr

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual CP::CorrectionCode	applyCorrection (xAOD::TrackParticle &ID) override
	Smearing method. More...

virtual CP::CorrectionCode	correctedCopy (const xAOD::TrackParticle &in, xAOD::TrackParticle *&out) override

virtual CP::CorrectionCode	applyContainerCorrection (xAOD::TrackParticleContainer &cont) override

virtual bool	isAffectedBySystematic (const CP::SystematicVariation &) const override
	returns: whether the tool is affected by the systematic More...

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

virtual CP::SystematicSet	recommendedSystematics () const override
	returns: list of recommended systematics to use with this tool More...

virtual StatusCode	applySystematicVariation (const CP::SystematicSet &) override
	configure the tool to apply a given list of systematic variations More...

float	GetSmearD0Sigma (const xAOD::TrackParticle &) const
	Get smearing widths to add to IPs. More...

float	GetSmearZ0Sigma (const xAOD::TrackParticle &) const

float	readHistogram (const TH2 *, float pt, float eta) const

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

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

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< int >	m_seed {this, "Seed", 0}

std::unique_ptr< TRandom3 >	m_rnd

std::unique_ptr< TH2 >	m_smearD0 = nullptr

std::unique_ptr< TH2 >	m_smearZ0 = nullptr

Gaudi::Property< std::string >	m_calibFileIP_CTIDE {this, "calibFileIP_CTIDE", ""}

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

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

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

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 29 of file InDetTrackSmearingTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ xAODContainerType

typedef xAOD::TrackParticleContainer CP::CorrectionTool< xAOD::TrackParticleContainer >::xAODContainerType

inherited

description: the type of xAOD container used

Definition at line 46 of file CorrectionTool.h.

◆ xAODObjectType

typedef xAODContainerType::base_value_type CP::CorrectionTool< xAOD::TrackParticleContainer >::xAODObjectType

inherited

description: the type of xAOD object used

Definition at line 48 of file CorrectionTool.h.

Member Function Documentation

◆ affectingSystematics()

CP::SystematicSet InDet::InDetTrackSmearingTool::affectingSystematics ( ) const

overrideprivatevirtual

returns: list of systematics this tool can be affected by

Implements InDet::IInDetTrackSmearingTool.

Definition at line 158 of file InDetTrackSmearingTool.cxx.

   {
     return RecommendedSystematics;
   }

◆ applyContainerCorrection() [1/2]

CP::CorrectionCode InDet::InDetTrackSmearingTool::applyContainerCorrection ( xAOD::TrackParticleContainer & cont )

overrideprivatevirtual

Implements InDet::IInDetTrackSmearingTool.

Definition at line 148 of file InDetTrackSmearingTool.cxx.

   {
     return TrackCorrTool_t::applyContainerCorrection(cont);
   }

◆ applyContainerCorrection() [2/2]

CorrectionCode CP::CorrectionTool< xAOD::TrackParticleContainer >::applyContainerCorrection ( xAODContainerType & inputContainer )

inherited

effects: apply the correction to all the members of the container returns: overall success rationale: this will apply the correction to every single member (even if some members fail) rationale: the interface class provides a default implementation in terms of applyCorrection, that the derived classes can override for efficiency

◆ applyCorrection() [1/2]

CP::CorrectionCode InDet::InDetTrackSmearingTool::applyCorrection ( xAOD::TrackParticle & ID )

overrideprivatevirtual

Smearing method.

Implements InDet::IInDetTrackSmearingTool.

Definition at line 127 of file InDetTrackSmearingTool.cxx.

                                                                                    {
  
     float sigmaD0 = GetSmearD0Sigma( track );
     float sigmaZ0 = GetSmearZ0Sigma( track );
  
     static const SG::AuxElement::Accessor< float > accD0( "d0" );
     static const SG::AuxElement::Accessor< float > accZ0( "z0" );
  
     //NB: only call the RNG if the widths are greater than 0
     if ( sigmaD0 > 0. ) accD0( track ) = m_rnd->Gaus( track.d0(), sigmaD0 );
     if ( sigmaZ0 > 0. ) accZ0( track ) = m_rnd->Gaus( track.z0(), sigmaZ0 );
  
     return CP::CorrectionCode::Ok;
   }

◆ applyCorrection() [2/2]

virtual CorrectionCode CP::CorrectionTool< xAOD::TrackParticleContainer >::applyCorrection ( xAODObjectType & inputObject )

pure virtualinherited

effects: apply the correction and store the output in the object returns: success

◆ applySystematicVariation()

StatusCode InDet::InDetTrackSmearingTool::applySystematicVariation ( const CP::SystematicSet & systs )

overrideprivatevirtual

configure the tool to apply a given list of systematic variations

Implements InDet::IInDetTrackSmearingTool.

Definition at line 169 of file InDetTrackSmearingTool.cxx.

   {
     // should do check in here and return StatusCode::FAILURE if LOOSE and TIGHT versions are set simultaneously
     return InDetTrackSystematicsTool::applySystematicVariation(systs);
   }

◆ correctedCopy() [1/2]

CP::CorrectionCode InDet::InDetTrackSmearingTool::correctedCopy	(	const xAOD::TrackParticle &	in,
		xAOD::TrackParticle *&	out
	)

overrideprivatevirtual

Implements InDet::IInDetTrackSmearingTool.

Definition at line 142 of file InDetTrackSmearingTool.cxx.

   {
     return TrackCorrTool_t::correctedCopy(in, out);
   }

◆ correctedCopy() [2/2]

CorrectionCode CP::CorrectionTool< xAOD::TrackParticleContainer >::correctedCopy	(	const xAODObjectType &	inputObject,
		xAODObjectType *&	outputObject
	)

inherited

effects: make a clone of the input object, apply the correction to it and store the output in the object returns: success rationale: the interface class provides a default implementation in terms of applyCorrection, that the derived classes can override for efficiency

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

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

Definition at line 199 of file AthCommonDataStore.h.

   {
     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, V, H > & 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

◆ getFile()

std::unique_ptr< TFile > InDet::InDetTrackSystematicsTool::getFile ( const std::string & filename ) const

protectedinherited

open and return a file with the given name.

Definition at line 99 of file InDetTrackSystematicsTool.cxx.

   {
     // now the files are stored in the calibration area
     // filename is configurable in each tool and should include the path starting from the package name
     // but defaults to recommendation for current release
     std::string filenameWithFullPath = PathResolverFindCalibFile(filename);
  
     return std::unique_ptr<TFile>(TFile::Open(filenameWithFullPath.data(), "READ"));;
   }

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

◆ GetSmearD0Sigma()

float InDet::InDetTrackSmearingTool::GetSmearD0Sigma ( const xAOD::TrackParticle & track ) const

private

Get smearing widths to add to IPs.

Definition at line 68 of file InDetTrackSmearingTool.cxx.

                                                                                     {
     float pt = 1.e-3*track.pt(); // need to convert pt to GeV
     float eta = track.eta();
     float sigma_D0 = 0.f;
  
     bool isActiveD0Meas = isActive(TRK_RES_D0_MEAS);
  
     if (isActiveD0Meas == 0) {
       // pass-through D0Meas, return sigma_D0 early
       return std::sqrt(sigma_D0);
     }
  
     TH2* d0hist = m_smearD0.get();
  
     if (d0hist == nullptr) ATH_MSG_ERROR( "d0 histogram is null!" );
  
     float d0Smear = readHistogram(d0hist, pt, eta);
  
     // Apply a minimum smearing in the case where there is an empty bin
     // TODO: Remove for next round of recommendations
     if (d0Smear == 0) {
       d0Smear = 0.002;
     }
  
     sigma_D0 += d0Smear*d0Smear;
  
     return std::sqrt(sigma_D0);
   }

◆ GetSmearZ0Sigma()

float InDet::InDetTrackSmearingTool::GetSmearZ0Sigma ( const xAOD::TrackParticle & track ) const

private

Definition at line 98 of file InDetTrackSmearingTool.cxx.

                                                                                     {
     float pt = 1.e-3*track.pt(); // need to convert pt to GeV
     float eta = track.eta();
     float sigma_Z0 = 0.f;
  
     bool isActiveZ0Meas = isActive(TRK_RES_Z0_MEAS);
  
     if (isActiveZ0Meas == 0) {
       // pass-through Z0Meas, return sigma_Z0 early
       return std::sqrt(sigma_Z0);
     }
  
     TH2* z0hist = m_smearZ0.get();
  
     if (z0hist == nullptr) ATH_MSG_ERROR( "z0 histogram is null!" );
  
     float z0Smear = readHistogram(z0hist, pt, eta);
  
     // Apply a minimum smearing in the case where there is an empty bin
     // TODO: Remove for next round of recommendations
     if (z0Smear == 0) {
       z0Smear = 0.03;
     }
  
     sigma_Z0 += z0Smear*z0Smear;
  
     return std::sqrt(sigma_Z0);
   }

◆ initialize()

StatusCode InDet::InDetTrackSystematicsTool::initialize ( )

overrideprivatevirtualinherited

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.

Reimplemented in InDet::InclusiveTrackFilterTool, and InDet::InDetTrackBiasingTool.

Definition at line 17 of file InDetTrackSystematicsTool.cxx.

   {
     
     // add the affecting systematics to the registry
     auto& registry = CP::SystematicRegistry::getInstance();
     if (registry.registerSystematics(*this) != StatusCode::SUCCESS) {
       ATH_MSG_ERROR( "Unable to register systematics" );
       return StatusCode::FAILURE;
     }
  
     return StatusCode::SUCCESS;
   }

◆ initObject()

template<class T >

StatusCode InDet::InDetTrackSystematicsTool::initObject	(	std::unique_ptr< T > &	obj,
		const std::string &	rootFileName,
		const std::string &	objName
	)		const

protectedinherited

a function to initialize an object from a root file

Definition at line 63 of file InDetTrackSystematicsTool.h.

 {
   if (obj != nullptr) ATH_MSG_WARNING( obj->GetName() << " is not null, yet we are now attempting to initialize from " << rootFileName );
   std::unique_ptr<TFile> F = getFile(rootFileName);
   if(!F || F->IsZombie()) {
     ATH_MSG_ERROR( "Could not open file " << rootFileName );
     return StatusCode::FAILURE;
   }
   T* tempObj = nullptr;
   F->GetObject(objName.data(), tempObj);
   if(tempObj==nullptr) {
     ATH_MSG_ERROR( "Could not retrieve " << objName << " from file " << rootFileName );
     return StatusCode::FAILURE;
   }
   obj = std::unique_ptr<T>(static_cast<T*>(tempObj->Clone()));
   obj->SetDirectory(0);
   F->Clear();
   F->Close();
   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.

◆ isActive()

bool InDet::InDetTrackSystematicsTool::isActive ( TrackSystematic syst ) const

protectedinherited

Definition at line 89 of file InDetTrackSystematicsTool.cxx.

   {
     if (m_activeSysts == nullptr) {
       ATH_MSG_DEBUG( "applySystematicsVariation() has not been successfully called." );
       return false;
     }
     const auto it_syst = m_activeSysts->find(InDet::TrackSystematicMap.at(syst));
     return it_syst != m_activeSysts->end();
   }

◆ isAffectedBySystematic()

bool InDet::InDetTrackSmearingTool::isAffectedBySystematic ( const CP::SystematicVariation & syst ) const

overrideprivatevirtual

returns: whether the tool is affected by the systematic

Implements InDet::IInDetTrackSmearingTool.

Definition at line 153 of file InDetTrackSmearingTool.cxx.

   {
     return InDetTrackSystematicsTool::isAffectedBySystematic( syst );
   }

◆ 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() [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, LundVariablesTool, 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, LundVariablesTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

◆ readHistogram()

float InDet::InDetTrackSmearingTool::readHistogram	(	const TH2 *	histogram,
		float	pt,
		float	eta
	)		const

private

Definition at line 175 of file InDetTrackSmearingTool.cxx.

                                                                                              {
     // safety measure:
     if( eta>2.499 )  eta= 2.499;
     if( eta<-2.499 ) eta=-2.499;
     if ( pt < histogram->GetXaxis()->GetXmin() ) {
       pt = histogram->GetXaxis()->GetXmin() + 0.01;
     }
     if ( pt >= histogram->GetXaxis()->GetXmax() ) {
       pt = histogram->GetXaxis()->GetXmax() - 0.01;
     }
  
     int bin = histogram->FindFixBin(pt, eta);
     float val = histogram->GetBinContent(bin);
     return val;
   }

◆ recommendedSystematics()

CP::SystematicSet InDet::InDetTrackSmearingTool::recommendedSystematics ( ) const

overrideprivatevirtual

returns: list of recommended systematics to use with this tool

Implements InDet::IInDetTrackSmearingTool.

Definition at line 163 of file InDetTrackSmearingTool.cxx.

   {
     //    return InDetTrackSystematicsTool::recommendedSystematics();
     return RecommendedSystematics;
   }

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

const CP::SystematicSet* InDet::InDetTrackSystematicsTool::m_activeSysts = nullptr

protectedinherited

Definition at line 53 of file InDetTrackSystematicsTool.h.

◆ m_calibFileIP_CTIDE

Gaudi::Property<std::string> InDet::InDetTrackSmearingTool::m_calibFileIP_CTIDE {this, "calibFileIP_CTIDE", ""}

private

Definition at line 84 of file InDetTrackSmearingTool.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_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_rnd

std::unique_ptr<TRandom3> InDet::InDetTrackSmearingTool::m_rnd

private

Definition at line 71 of file InDetTrackSmearingTool.h.

◆ m_seed

Gaudi::Property<int> InDet::InDetTrackSmearingTool::m_seed {this, "Seed", 0}

private

Definition at line 70 of file InDetTrackSmearingTool.h.

◆ m_smearD0

std::unique_ptr<TH2> InDet::InDetTrackSmearingTool::m_smearD0 = nullptr

private

Definition at line 80 of file InDetTrackSmearingTool.h.

◆ m_smearZ0

std::unique_ptr<TH2> InDet::InDetTrackSmearingTool::m_smearZ0 = nullptr

private

Definition at line 81 of file InDetTrackSmearingTool.h.

◆ m_sysFilterMap

std::unordered_map< CP::SystematicSet, CP::SystematicSet > InDet::InDetTrackSystematicsTool::m_sysFilterMap

protectedinherited

Definition at line 51 of file InDetTrackSystematicsTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

◆ xAODContainerType

◆ xAODObjectType

Member Function Documentation

◆ affectingSystematics()

◆ applyContainerCorrection() [1/2]

◆ applyContainerCorrection() [2/2]

◆ applyCorrection() [1/2]

◆ applyCorrection() [2/2]

◆ applySystematicVariation()

◆ correctedCopy() [1/2]

◆ correctedCopy() [2/2]

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

◆ getFile()

◆ getKey()

◆ getName()

◆ getProperty()

◆ GetSmearD0Sigma()

◆ GetSmearZ0Sigma()

◆ initialize()

◆ initObject()

◆ inputHandles()

◆ isActive()

◆ isAffectedBySystematic()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ readHistogram()

◆ recommendedSystematics()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_activeSysts

◆ m_calibFileIP_CTIDE

◆ m_detStore

◆ m_evtStore

◆ m_rnd

◆ m_seed

◆ m_smearD0

◆ m_smearZ0

◆ m_sysFilterMap

◆ m_varHandleArraysDeclared

◆ m_vhka