#include <InDetTrackSystematicsTool.h>

Inheritance diagram for InDet::InDetTrackSystematicsTool:

Collaboration diagram for InDet::InDetTrackSystematicsTool:

Public Member Functions
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
std::unique_ptr< TFile >	getFile (const std::string &) const
	open and return a file with the given name.
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
bool	isActive (TrackSystematic) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

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 ASG_TOOL_CLASS2(InDetTrackSystematicsTool, CP::ISystematicsTool, CP::IReentrantSystematicsTool) public	~InDetTrackSystematicsTool ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual bool	isAffectedBySystematic (const CP::SystematicVariation &) const override
	returns: whether the tool is affected by the systematic
virtual CP::SystematicSet	affectingSystematics () const override=0
	returns: list of systematics this tool can be affected by
virtual CP::SystematicSet	recommendedSystematics () const override
	returns: list of recommended systematics to use with this tool
virtual StatusCode	applySystematicVariation (const CP::SystematicSet &) override
	configure the tool to apply a given list of systematic variations
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 22 of file InDetTrackSystematicsTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ affectingSystematics()

virtual CP::SystematicSet InDet::InDetTrackSystematicsTool::affectingSystematics ( ) const

overrideprivatepure virtual

returns: list of systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Implemented in InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackTruthFilterTool, and InDet::JetTrackFilterTool.

◆ applySystematicVariation()

StatusCode InDet::InDetTrackSystematicsTool::applySystematicVariation ( const CP::SystematicSet & systematics )

overrideprivatevirtual

configure the tool to apply a given list of systematic variations

Implements CP::ISystematicsTool.

Reimplemented in InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackTruthFilterTool, and InDet::JetTrackFilterTool.

Definition at line 42 of file InDetTrackSystematicsTool.cxx.

  {
 
    // first check if we already know this systematic configuration
    // look for it in our filter map
    auto sysMapItr = m_sysFilterMap.find(systematics);
 
    if (sysMapItr == m_sysFilterMap.end()) {
 
      // filter the input systematic with the affecting systematics
      const CP::SystematicSet affectingSysts = affectingSystematics();
      CP::SystematicSet filteredSysts;
      if ( CP::SystematicSet::filterForAffectingSystematics
          (systematics, affectingSysts, filteredSysts) != StatusCode::SUCCESS ) {
        ATH_MSG_ERROR( "Recieved unsupported systematics: " << systematics.name() );
        return StatusCode::FAILURE;
      }
 
      // check in here for incompatible systematics
      auto isIn = [&](InDet::TrackSystematic syst) {
        // helper function to check if a systematic exists in the filtered set
        return filteredSysts.find( InDet::TrackSystematicMap.at( syst ) ) != filteredSysts.end();
      };
      bool isSetTrkLoose = isIn( TRK_FAKE_RATE_LOOSE )
                        || isIn( TRK_EFF_LOOSE_GLOBAL )
                        || isIn( TRK_EFF_LOOSE_IBL )
                        || isIn( TRK_EFF_LOOSE_PP0 )
                        || isIn( TRK_EFF_LOOSE_PHYSMODEL );
      bool isSetTrkTight = isIn( TRK_FAKE_RATE_TIGHT )
                        || isIn( TRK_EFF_TIGHT_GLOBAL )
                        || isIn( TRK_EFF_TIGHT_IBL )
                        || isIn( TRK_EFF_TIGHT_PP0 )
                        || isIn( TRK_EFF_TIGHT_PHYSMODEL );
      if ( isSetTrkLoose && isSetTrkTight) {
        ATH_MSG_ERROR( "Both Loose and TightPrimary versions of systematics are simultaneously active." );
        return StatusCode::FAILURE;
      }
 
      // if the systematics set looks supported, then insert it into the map for future use
      sysMapItr = m_sysFilterMap.insert(std::make_pair(systematics, filteredSysts)).first;
    }
 
    m_activeSysts = &sysMapItr->second;
 
    return StatusCode::SUCCESS;
  }

◆ declareGaudiProperty()

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

◆ declareProperty()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

protected

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.

◆ initialize()

StatusCode InDet::InDetTrackSystematicsTool::initialize ( void )

overrideprivatevirtual

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, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackTruthFilterTool, and InDet::JetTrackFilterTool.

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

protected

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

protected

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::InDetTrackSystematicsTool::isAffectedBySystematic ( const CP::SystematicVariation & systematic ) const

overrideprivatevirtual

returns: whether the tool is affected by the systematic

Implements CP::ISystematicsTool.

Reimplemented in InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackTruthFilterTool, and InDet::JetTrackFilterTool.

Definition at line 30 of file InDetTrackSystematicsTool.cxx.

  {
    auto affSysts = affectingSystematics();
    return ( affSysts.find(systematic) != affSysts.end() );
  }

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

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

inherited

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

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

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

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

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

Definition at line 101 of file AsgTool.cxx.

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

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ recommendedSystematics()

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

overrideprivatevirtual

returns: list of recommended systematics to use with this tool

Implements CP::IReentrantSystematicsTool.

Reimplemented in InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackTruthFilterTool, and InDet::JetTrackFilterTool.

Definition at line 36 of file InDetTrackSystematicsTool.cxx.

  {
    // it's probably a good idea to change this behavior to return a more intelligently thought-out list
    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();
  }

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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

◆ ~InDetTrackSystematicsTool()

virtual ASG_TOOL_CLASS2(InDetTrackSystematicsTool, CP::ISystematicsTool, CP::IReentrantSystematicsTool) public InDet::InDetTrackSystematicsTool::~InDetTrackSystematicsTool ( )

privatevirtualdefault

Member Data Documentation

◆ m_activeSysts

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

protected

Definition at line 53 of file InDetTrackSystematicsTool.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_sysFilterMap

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

protected

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 Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ affectingSystematics()

◆ applySystematicVariation()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getFile()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ initObject()

◆ inputHandles()

◆ isActive()

◆ isAffectedBySystematic()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ recommendedSystematics()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ ~InDetTrackSystematicsTool()

Member Data Documentation

◆ m_activeSysts

◆ m_detStore

◆ m_evtStore

◆ m_sysFilterMap

◆ m_varHandleArraysDeclared

◆ m_vhka