#include <JvtEfficiencyToolBase.h>

Inheritance diagram for CP::JvtEfficiencyToolBase:

Collaboration diagram for CP::JvtEfficiencyToolBase:

Public Member Functions
virtual	~JvtEfficiencyToolBase () override=default

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

virtual CorrectionCode	getEfficiencyScaleFactor (const xAOD::Jet &jet, float &sf) const override
	Calculate the efficiency scale factor for the provided jet. More...

virtual CorrectionCode	getInefficiencyScaleFactor (const xAOD::Jet &jet, float &sf) const override
	Calculate the inefficiency scale factor for the provided jet. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MsgStream &	msg () const

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

bool	msgLvl (const MSG::Level lvl) const

virtual bool	isAffectedBySystematic (const SystematicVariation &systematic) const
	returns: whether this tool is affected by the given systematic guarantee: no-fail More...

virtual SystematicSet	affectingSystematics () const
	returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II More...

virtual SystematicSet	recommendedSystematics () const
	returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II More...

const SystematicSet &	appliedSystematics () const
	returns: the list of systematics that have been applied to this tool. More...

std::string	appliedSystematicsString () const
	returns: a string representation of appliedSystematics() guarantee: strong failures: out of memory II rationale: this is meant to be used when printing out the applied systematics for debugging purposes (or when embedding them in a string). More...

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

void	testInvariant () const
	effects: test the invariance of this object guarantee: no-fail More...

Protected Member Functions
StatusCode	initHists (const std::string &file, const std::string &wp)
	Read the input histograms. Passing an empty 'file' string uses dummy SFs. More...

bool	isInRange (const xAOD::Jet &jet) const

CorrectionCode	getEffImpl (float x, float y, float &sf) const

CorrectionCode	getIneffImpl (float x, float y, float &sf) 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...

StatusCode	addAffectingSystematic (const SystematicVariation &systematic, bool recommended)
	effects: add a systematic to the list of registered systematics. More...

StatusCode	addRecommendedSystematic (const SystematicVariation &systematic)
	effects: add a systematic to the list of recommended systematics failures: unsupported systematic More...

void	addAffectingSystematics (const SystematicSet &systematics)
	effects: add a SystematicSet to the registered systematics. More...

StatusCode	addRecommendedSystematics (const SystematicSet &systematics)
	effects: add a SystematicSet to the recommended systematics. More...

virtual StatusCode	sysApplySystematicVariation (const SystematicSet &systConfig)=0
	effects: configure this tool for the given list of systematic variations. More...

Protected Attributes
Gaudi::Property< std::string >	m_jetContainer

Gaudi::Property< bool >	m_doTruthRequirement

SG::ReadDecorHandleKey< xAOD::JetContainer >	m_truthHSLabel

Gaudi::Property< float >	m_minEta

Gaudi::Property< float >	m_maxEta

Gaudi::Property< float >	m_minPtForJvt

Gaudi::Property< float >	m_maxPtForJvt

Gaudi::Property< float >	m_dummySFError

Gaudi::Property< std::string >	m_jetEtaName

std::unique_ptr< TH2 >	m_jvtHist

std::unique_ptr< TH2 >	m_effHist

bool	m_useDummySFs {false}

SG::ConstAccessor< float >	m_etaAcc { m_jetEtaName }

int	m_appliedSysSigma = 0

std::optional< SG::AuxElement::ConstAccessor< char > >	m_accIsHS

SystematicSet	m_affectingSystematics
	description: members directly corresponding to accessors More...

SystematicSet	m_recommendedSystematics

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

SystematicSet *	m_appliedSystematics
	description: pointer to currenty applied systematics More...

std::unordered_map< SystematicSet, SystematicSet >	m_systFilterMap
	map of cached systematics filtering More...

Detailed Description

Definition at line 18 of file JvtEfficiencyToolBase.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~JvtEfficiencyToolBase()

virtual CP::JvtEfficiencyToolBase::~JvtEfficiencyToolBase ( )

overridevirtualdefault

Member Function Documentation

◆ addAffectingSystematic()

StatusCode CP::SystematicsTool::addAffectingSystematic	(	const SystematicVariation &	systematic,
		bool	recommended
	)

protectedinherited

effects: add a systematic to the list of registered systematics.

It will optionally also add this sytematic to the recommended set. side effects: this will add the systematic to the global list of systematics, if not already there guarantee: strong failures: out of memory II

Definition at line 111 of file SystematicsTool.cxx.

                                                                                      {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       reg.registerSystematic( systematic );
       m_affectingSystematics.insert( systematic );
       if( recommended ) {
          if( addRecommendedSystematic(systematic) != StatusCode::SUCCESS ) {
             return StatusCode::FAILURE;
          }
       }
       return StatusCode::SUCCESS;
    }

◆ addAffectingSystematics()

void CP::SystematicsTool::addAffectingSystematics ( const SystematicSet & systematics )

protectedinherited

effects: add a SystematicSet to the registered systematics.

Definition at line 141 of file SystematicsTool.cxx.

                                                                {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       m_affectingSystematics.insert( systematics );
       reg.registerSystematics( systematics );
    }

◆ addRecommendedSystematic()

StatusCode CP::SystematicsTool::addRecommendedSystematic ( const SystematicVariation & systematic )

protectedinherited

effects: add a systematic to the list of recommended systematics failures: unsupported systematic

Definition at line 127 of file SystematicsTool.cxx.

                                                                      {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       m_recommendedSystematics.insert( systematic );
       if( reg.addSystematicToRecommended( systematic ) !=
           StatusCode::SUCCESS ) {
          return StatusCode::FAILURE;
       }
       return StatusCode::SUCCESS;
    }

◆ addRecommendedSystematics()

StatusCode CP::SystematicsTool::addRecommendedSystematics ( const SystematicSet & systematics )

protectedinherited

effects: add a SystematicSet to the recommended systematics.

Definition at line 151 of file SystematicsTool.cxx.

                                                                  {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       m_recommendedSystematics.insert( systematics );
       if( reg.addSystematicsToRecommended( systematics ) !=
           StatusCode::SUCCESS ) {
          return StatusCode::FAILURE;
       }
       return StatusCode::SUCCESS;
    }

◆ affectingSystematics()

SystematicSet CP::SystematicsTool::affectingSystematics ( ) const

virtualinherited

returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II

Implements CP::IReentrantSystematicsTool.

Reimplemented in CP::JetJvtEfficiency, CP::JetQGTagger, and met::METSystematicsTool.

Definition at line 40 of file SystematicsTool.cxx.

                                                {
  
       RCU_READ_INVARIANT( this );
       return m_affectingSystematics;
    }

◆ appliedSystematics()

const SystematicSet & CP::SystematicsTool::appliedSystematics ( ) const

inherited

returns: the list of systematics that have been applied to this tool.

this is not including systematics that were applied, but do not affect this tool guarantee: no-fail

Definition at line 54 of file SystematicsTool.cxx.

                                              {
  
       RCU_READ_INVARIANT( this );
       if(m_appliedSystematics == 0){
          std::cerr << "SystematicsTool::appliedSystematics WARNING: "
                    << "no systematic configuration has been applied yet. "
                    << "Returning NULL" << std::endl;
          static const SystematicSet dummy;
          return dummy;
       }
       return *m_appliedSystematics;
    }

◆ appliedSystematicsString()

std::string CP::SystematicsTool::appliedSystematicsString ( ) const

inherited

returns: a string representation of appliedSystematics() guarantee: strong failures: out of memory II rationale: this is meant to be used when printing out the applied systematics for debugging purposes (or when embedding them in a string).

Definition at line 67 of file SystematicsTool.cxx.

                                                               {
  
       RCU_READ_INVARIANT( this );
       return m_appliedSystematics->name();
    }

◆ applySystematicVariation()

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

virtualinherited

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). guarantee: basic failures: out of memory II 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::ISystematicsTool.

Reimplemented in CP::JetQGTagger, CP::JetJvtEfficiency, and met::METSystematicsTool.

Definition at line 73 of file SystematicsTool.cxx.

                                                                {
  
       RCU_CHANGE_INVARIANT( this );
  
       // First, try to find this input set in the map
       auto itr = m_systFilterMap.find(systConfig);
  
       // This is a new input set, so we need to filter it
       if(itr == m_systFilterMap.end()){
  
          // Filter input systematics with the affecting systematics
          SystematicSet myAppliedSystematics;
          if( SystematicSet::
              filterForAffectingSystematics( systConfig,
                                             m_affectingSystematics,
                                             myAppliedSystematics ) !=
              StatusCode::SUCCESS ) {
             return StatusCode::FAILURE;
          }
  
          // Insert the new filtered set onto our filter map
          itr = m_systFilterMap.insert
            (std::make_pair(systConfig, myAppliedSystematics)).first;
  
       }
  
       // Apply the filtered systematics
       if( sysApplySystematicVariation( itr->second ) !=
           StatusCode::SUCCESS ) {
          return StatusCode::FAILURE;
       }
  
       // Store the filtered systematics
       m_appliedSystematics = &itr->second;
       return StatusCode::SUCCESS;
    }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

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

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 245 of file AthCommonDataStore.h.

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

◆ declareProperty() [2/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 221 of file AthCommonDataStore.h.

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

◆ declareProperty() [3/6]

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

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

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

◆ declareProperty() [4/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 333 of file AthCommonDataStore.h.

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

◆ declareProperty() [5/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 352 of file AthCommonDataStore.h.

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

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getEfficiencyScaleFactor()

CorrectionCode CP::JvtEfficiencyToolBase::getEfficiencyScaleFactor	(	const xAOD::Jet &	jet,
		float &	sf
	)		const

overridevirtual

Calculate the efficiency scale factor for the provided jet.

Parameters

	jet	The jet whose efficiency should be calculated
[out]	sf	The calculated scale factor

Returns: A code signifying the status of the returned scale factor

Implements CP::IJvtEfficiencyTool.

Reimplemented in CP::FJvtEfficiencyTool.

Definition at line 48 of file JvtEfficiencyToolBase.cxx.

                                                                                        {
         if (!isInRange(jet)) {
             sf = -1;
             return CorrectionCode::OutOfValidityRange;
         }
         if (m_doTruthRequirement) {
             if (!m_accIsHS->isAvailable(jet)) {
                 ATH_MSG_ERROR("Truth tagging required but not available");
                 return CorrectionCode::Error;
             }
             if (!(*m_accIsHS)(jet)) {
                 sf = 1;
                 return CorrectionCode::Ok;
             }
         }
         return getEffImpl(jet.pt(), m_etaAcc(jet), sf);
     }

◆ getEffImpl()

CorrectionCode CP::JvtEfficiencyToolBase::getEffImpl	(	float	x,
		float	y,
		float &	sf
	)		const

protected

Definition at line 124 of file JvtEfficiencyToolBase.cxx.

                                                                                       {
         float baseFactor = 1;
         float errorTerm = m_dummySFError;
         if (!m_useDummySFs) {
             if (!getBinContentAndError(*m_jvtHist, x, y, baseFactor, errorTerm)) {
                 sf = -1;
                 return CorrectionCode::OutOfValidityRange;
             }
         }
         sf = baseFactor + m_appliedSysSigma * errorTerm;
         return CorrectionCode::Ok;
     }

◆ getInefficiencyScaleFactor()

CorrectionCode CP::JvtEfficiencyToolBase::getInefficiencyScaleFactor	(	const xAOD::Jet &	jet,
		float &	sf
	)		const

overridevirtual

Calculate the inefficiency scale factor for the provided jet.

Parameters

	jet	The jet whose inefficiency should be calculated
[out]	sf	The calculated scale factor

Returns: A code signifying the status of the returned scale factor

Implements CP::IJvtEfficiencyTool.

Reimplemented in CP::FJvtEfficiencyTool.

Definition at line 67 of file JvtEfficiencyToolBase.cxx.

                                                                                          {
         if (!isInRange(jet)) {
             sf = -1;
             return CorrectionCode::OutOfValidityRange;
         }
         if (m_doTruthRequirement) {
             if (!m_accIsHS->isAvailable(jet)) {
                 ATH_MSG_ERROR("Truth tagging required but not available");
                 return CorrectionCode::Error;
             }
             if (!(*m_accIsHS)(jet)) {
                 sf = 1;
                 return CorrectionCode::Ok;
             }
         }
         return getIneffImpl(jet.pt(), m_etaAcc(jet), sf);
     }

◆ getIneffImpl()

CorrectionCode CP::JvtEfficiencyToolBase::getIneffImpl	(	float	x,
		float	y,
		float &	sf
	)		const

protected

Definition at line 137 of file JvtEfficiencyToolBase.cxx.

                                                                                         {
         if (m_useDummySFs) {
             sf = 1 + m_dummySFError * m_appliedSysSigma;
             return CorrectionCode::Ok;
         }
         float baseFactor, errorTerm, effFactor, errorEffTerm;
         if (!getBinContentAndError(*m_jvtHist, x, y, baseFactor, errorTerm) ||
             !getBinContentAndError(*m_effHist, x, y, effFactor, errorEffTerm)) {
             sf = -1;
             return CorrectionCode::OutOfValidityRange;
         }
         baseFactor += errorTerm * m_appliedSysSigma;
         effFactor += errorEffTerm * m_appliedSysSigma;
  
         sf = (1 - baseFactor * effFactor) / (1 - effFactor);
         return CorrectionCode::Ok;
     }

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

◆ initHists()

StatusCode CP::JvtEfficiencyToolBase::initHists	(	const std::string &	file,
		const std::string &	wp
	)

protected

Read the input histograms. Passing an empty 'file' string uses dummy SFs.

Definition at line 85 of file JvtEfficiencyToolBase.cxx.

                                                                                           {
         if (file.empty()) {
             m_useDummySFs = true;
             ATH_MSG_INFO("No SF file provided, running with dummy SFs of 1 +/- " << m_dummySFError);
             return StatusCode::SUCCESS;
         }
         std::string resolved = PathResolverFindCalibFile(file);
         if (resolved.empty()) {
             ATH_MSG_ERROR("Could not locate file " << file);
             return StatusCode::FAILURE;
         }
         std::unique_ptr<TFile> fIn(TFile::Open(resolved.c_str(), "READ"));
         if (!fIn) {
             ATH_MSG_ERROR("Failed to open file " <<  resolved);
             return StatusCode::FAILURE;
         }
  
         std::string jvtName = "Jvt" + wp;
         m_jvtHist.reset(fIn->Get<TH2>(jvtName.c_str()));
         if (!m_jvtHist) {
             ATH_MSG_ERROR(
                     "Could not open SF histogram "
                     << jvtName << ". Please check the supported working points.");
             return StatusCode::FAILURE;
         }
         m_jvtHist->SetDirectory(nullptr);
         std::string effName = "Eff" + wp;
         m_effHist.reset(fIn->Get<TH2>(effName.c_str()));
         if (!m_effHist) {
             ATH_MSG_ERROR(
                     "Could not open efficiency histogram "
                     << jvtName << ". Please check the supported working points.");
             return StatusCode::FAILURE;
         }
         m_effHist->SetDirectory(nullptr);
  
         return StatusCode::SUCCESS;
     }

◆ initialize()

StatusCode CP::JvtEfficiencyToolBase::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Reimplemented in CP::FJvtEfficiencyTool, CP::JvtEfficiencyTool, and CP::NNJvtEfficiencyTool.

Definition at line 31 of file JvtEfficiencyToolBase.cxx.

                                                  {
         m_etaAcc = SG::ConstAccessor<float>(m_jetEtaName);
         if (!m_doTruthRequirement)
             ATH_MSG_WARNING("No truth requirement will be performed, which is not recommended.");
         m_accIsHS.emplace(m_truthHSLabel.key());
         if (m_jetContainer.empty()) {
             ATH_MSG_WARNING("No JetContainer set. This behaviour is deprecated");
             ATH_CHECK(m_truthHSLabel.initialize(false));
         }
         else {
             m_truthHSLabel = m_jetContainer + "." + m_truthHSLabel.key();
             ATH_CHECK(m_truthHSLabel.initialize(m_doTruthRequirement));
         }
         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.

◆ isAffectedBySystematic()

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

virtualinherited

returns: whether this tool is affected by the given systematic guarantee: no-fail

Implements CP::ISystematicsTool.

Reimplemented in CP::JetQGTagger, CP::JetJvtEfficiency, and met::METSystematicsTool.

Definition at line 31 of file SystematicsTool.cxx.

                                                                          {
  
       RCU_READ_INVARIANT( this );
       return ( m_affectingSystematics.find( systematic ) !=
                m_affectingSystematics.end() );
    }

◆ isInRange()

bool CP::JvtEfficiencyToolBase::isInRange ( const xAOD::Jet & jet ) const

protected

Definition at line 155 of file JvtEfficiencyToolBase.cxx.

                                                                   {
         if (jet.pt() < m_minPtForJvt || jet.pt() > m_maxPtForJvt)
             return false;
         float eta = m_etaAcc(jet);
         return std::abs(eta) >= m_minEta && std::abs(eta) <= m_maxEta;
     }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

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

inherited

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

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

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

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

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

Definition at line 101 of file AsgTool.cxx.

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

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ recommendedSystematics()

SystematicSet CP::SystematicsTool::recommendedSystematics ( ) const

virtualinherited

returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II

Implements CP::IReentrantSystematicsTool.

Reimplemented in CP::JetJvtEfficiency, CP::JetQGTagger, and met::METSystematicsTool.

Definition at line 47 of file SystematicsTool.cxx.

                                                  {
  
       RCU_READ_INVARIANT( this );
       return m_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();
   }

◆ sysApplySystematicVariation()

virtual StatusCode CP::SystematicsTool::sysApplySystematicVariation ( const SystematicSet & systConfig )

protectedpure virtualinherited

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

systConfig is guaranteed to contain only supported systematics. guarantee: basic failures: out of memory II failures: unsupported combination of supported systematics failures: other tool specific errors

Implemented in CP::JetQGTagger, CP::FJvtEfficiencyTool, CP::JvtEfficiencyTool, CP::NNJvtEfficiencyTool, CP::JetJvtEfficiency, and met::METSystematicsTool.

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

◆ testInvariant()

void CP::SystematicsTool::testInvariant ( ) const

inherited

effects: test the invariance of this object guarantee: no-fail

Definition at line 165 of file SystematicsTool.cxx.

                                              {
  
      //RCU_INVARIANT( this != 0 );
    }

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

std::optional<SG::AuxElement::ConstAccessor<char> > CP::JvtEfficiencyToolBase::m_accIsHS

protected

Definition at line 63 of file JvtEfficiencyToolBase.h.

◆ m_affectingSystematics

SystematicSet CP::SystematicsTool::m_affectingSystematics

protectedinherited

description: members directly corresponding to accessors

Definition at line 146 of file SystematicsTool.h.

◆ m_appliedSysSigma

int CP::JvtEfficiencyToolBase::m_appliedSysSigma = 0

protected

Definition at line 61 of file JvtEfficiencyToolBase.h.

◆ m_appliedSystematics

SystematicSet* CP::SystematicsTool::m_appliedSystematics

privateinherited

description: pointer to currenty applied systematics

Definition at line 151 of file SystematicsTool.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_doTruthRequirement

Gaudi::Property<bool> CP::JvtEfficiencyToolBase::m_doTruthRequirement

protected

Initial value:

{
                this, "DoTruthReq", true,
                "Use the truth-matching requirement. **Strongly** recommended"}

Definition at line 37 of file JvtEfficiencyToolBase.h.

◆ m_dummySFError

Gaudi::Property<float> CP::JvtEfficiencyToolBase::m_dummySFError

protected

Initial value:

{

this, "DummySFError", 0.1, "The amount by which to vary the dummy SF"}

Definition at line 50 of file JvtEfficiencyToolBase.h.

◆ m_effHist

std::unique_ptr<TH2> CP::JvtEfficiencyToolBase::m_effHist

protected

Definition at line 56 of file JvtEfficiencyToolBase.h.

◆ m_etaAcc

SG::ConstAccessor<float> CP::JvtEfficiencyToolBase::m_etaAcc { m_jetEtaName }

protected

Definition at line 59 of file JvtEfficiencyToolBase.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_jetContainer

Gaudi::Property<std::string> CP::JvtEfficiencyToolBase::m_jetContainer

protected

Initial value:

{
                this, "JetContainer", "",
                "The name of the jet container, used to correctly initialize the read handles"}

Definition at line 34 of file JvtEfficiencyToolBase.h.

◆ m_jetEtaName

Gaudi::Property<std::string> CP::JvtEfficiencyToolBase::m_jetEtaName

protected

Initial value:

{

SystematicSet CP::SystematicsTool::m_recommendedSystematics

protectedinherited

Definition at line 147 of file SystematicsTool.h.

◆ m_systFilterMap

std::unordered_map<SystematicSet, SystematicSet> CP::SystematicsTool::m_systFilterMap

privateinherited

map of cached systematics filtering

Definition at line 154 of file SystematicsTool.h.

◆ m_truthHSLabel

SG::ReadDecorHandleKey<xAOD::JetContainer> CP::JvtEfficiencyToolBase::m_truthHSLabel

protected

Initial value:

{

this, "TruthHSLabel", "isJvtHS", "Label for truth-matched jets"}

Definition at line 40 of file JvtEfficiencyToolBase.h.

◆ m_useDummySFs

bool CP::JvtEfficiencyToolBase::m_useDummySFs {false}

protected

Definition at line 57 of file JvtEfficiencyToolBase.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

Constructor & Destructor Documentation

◆ ~JvtEfficiencyToolBase()

Member Function Documentation

◆ addAffectingSystematic()

◆ addAffectingSystematics()

◆ addRecommendedSystematic()

◆ addRecommendedSystematics()

◆ affectingSystematics()

◆ appliedSystematics()

◆ appliedSystematicsString()

◆ applySystematicVariation()

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

◆ getEfficiencyScaleFactor()

◆ getEffImpl()

◆ getInefficiencyScaleFactor()

◆ getIneffImpl()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initHists()

◆ initialize()

◆ inputHandles()

◆ isAffectedBySystematic()

◆ isInRange()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ recommendedSystematics()

◆ renounce()

◆ renounceArray()

◆ sysApplySystematicVariation()

◆ sysInitialize()

◆ sysStart()

◆ testInvariant()

◆ updateVHKA()

Member Data Documentation

◆ m_accIsHS

◆ m_affectingSystematics

◆ m_appliedSysSigma

◆ m_appliedSystematics

◆ m_detStore

◆ m_doTruthRequirement

◆ m_dummySFError

◆ m_effHist

◆ m_etaAcc

◆ m_evtStore

◆ m_jetContainer

◆ m_jetEtaName

◆ m_jvtHist

◆ m_maxEta

◆ m_maxPtForJvt

◆ m_minEta

◆ m_minPtForJvt

◆ m_recommendedSystematics

◆ m_systFilterMap