#include <JetOriginCorrectionTool.h>

Inheritance diagram for JetOriginCorrectionTool:

Collaboration diagram for JetOriginCorrectionTool:

Public Member Functions
	JetOriginCorrectionTool (const std::string &myname)
	Constructor from tool name. More...

StatusCode	decorate (const xAOD::JetContainer &jet) const override
	Inherited method to modify a jet container. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MsgStream &	msg () const

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

bool	msgLvl (const MSG::Level lvl) const

virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Protected Attributes
Gaudi::Property< std::string >	m_correctionName {this, "OriginCorrectedName", "JetOriginConstitScaleMomentum", "Origin corrected name"}

Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}

Gaudi::Property< bool >	m_onlyAssignPV {this, "OnlyAssignPV", false, "Only write out PV information"}

Gaudi::Property< bool >	m_forceEMScale {this, "ForceEMScale", false, "Force apply origin correction at EM scale"}

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
SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "Primary vertex container name"}

SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo_key {this, "EventInfoName", "EventInfo", "Event info name"}

Gaudi::Property< std::string >	m_scaleMomentumName {this, "jetScaleMomentName", "JetOriginConstitScaleMomentum", "SG key for JetScaleMomentum components"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_scaleMomentumPtKey {this, "JetScaleMomentumPtName", "pt", "SG suffix for output JetScaleMomentum (pt) decorator"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_scaleMomentumPhiKey {this, "JetScaleMomentumPhiName", "phi", "SG suffix for output JetScaleMomentum (phi) decorator"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_scaleMomentumEtaKey {this, "JetScaleMomentumEtaName", "eta", "SG suffix for output JetScaleMomentum (eta) decorator"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_scaleMomentumMKey {this, "JetScaleMomentumMName", "m", "SG suffix for output JetScaleMomentum (mass) decorator"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_originVertexKey {this, "OriginVertexName", "OriginVertex", "SG key for output OriginVertex decorator"}

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

This tool computes the constituent scale 4-vector of the jet relative to a PV vertex and stores it in as an attribute
of the jet. This tool DOES NOT change the scale of the jet, just adds an attribute.

This tool is a wrapper : it only calls functions defined in JetUtils/JetOriginHelpers.h

Properties:

VertexContainer: Name of the vertex container. The 0th vertex is used to compute the correction
OriginCorrectedName: Name of the output attribute

Definition at line 35 of file JetOriginCorrectionTool.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

◆ JetOriginCorrectionTool()

JetOriginCorrectionTool::JetOriginCorrectionTool ( const std::string & myname )

Constructor from tool name.

Definition at line 17 of file JetOriginCorrectionTool.cxx.

 : asg::AsgTool(myname) { 
  
 }

Member Function Documentation

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

◆ decorate()

StatusCode JetOriginCorrectionTool::decorate ( const xAOD::JetContainer & jet ) const

overridevirtual

Inherited method to modify a jet container.

Compute the origin-corrected momentum and put it in the jets

Implements IJetDecorator.

Definition at line 50 of file JetOriginCorrectionTool.cxx.

                                                                                   {
   SG::WriteDecorHandle<xAOD::JetContainer, float> scaleMomentumPtHandle(m_scaleMomentumPtKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> scaleMomentumPhiHandle(m_scaleMomentumPhiKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> scaleMomentumEtaHandle(m_scaleMomentumEtaKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> scaleMomentumMHandle(m_scaleMomentumMKey);
   SG::WriteDecorHandle<xAOD::JetContainer, ElementLink<xAOD::VertexContainer>> originVertexHandle(m_originVertexKey);
  
   // static accessor for PV index access
   static const SG::AuxElement::ConstAccessor<int> PVIndexAccessor("PVIndex");
  
  
  
   // retrieve the VertexContainer. if fails, fill the jets with null vector
   auto handle = SG::makeHandle (m_vertexContainer_key);
   if (!handle.isValid()){
     ATH_MSG_WARNING("Invalid VertexContainer datahandle: " 
                     <<  m_correctionName
                     << ": filling jet with -1");
     xAOD::JetFourMom_t null;    
     for(const xAOD::Jet * j : jetCont) {
       scaleMomentumPtHandle(*j) = -1;
       scaleMomentumPhiHandle(*j) = -1;
       scaleMomentumEtaHandle(*j) = -1;
       scaleMomentumMHandle(*j) = -1;
     }
     return StatusCode::SUCCESS;
   }
  
   const auto *vxContainer = handle.cptr();
  
  
   // Retrieve EventInfo to check for a PV# specification != PV0
   // No errors if EventInfo or PV index is not specified, 
   // as this is the standard scenario
   // Warn if EventInfo is specified but cannot be retrieved
   // Specifying the PV index is only for special cases
   int PVindex = 0;
   //if (m_eventInfoName.key() != "") {
   if (!m_eventInfo_key.key().empty()) {
     // retrieve the VertexContainer. if fails, fill the jets with null vector
  
     auto eInfo = SG::makeHandle (m_eventInfo_key);
     if (!eInfo.isValid()){
       ATH_MSG_WARNING("Invalid eventInfo datahandle. Defaulting to PV0 for " 
                       <<  m_correctionName);
     } else if (PVIndexAccessor.isAvailable(*(eInfo.cptr()))) {
       PVindex = PVIndexAccessor(*(eInfo.cptr()));
       ATH_MSG_DEBUG("Found PVIndex value of " << PVindex << " for " << m_correctionName);
       
       if (PVindex < 0 || static_cast<size_t>(PVindex) >= vxContainer->size()){
         ATH_MSG_WARNING("Specified PV index of " 
                         << PVindex << " is out of bounds.  Filling jet with -1"
                         <<m_correctionName);
         xAOD::JetFourMom_t null;
         for (const xAOD::Jet* j : jetCont) {
           scaleMomentumPtHandle(*j) = -1;
           scaleMomentumPhiHandle(*j) = -1;
           scaleMomentumEtaHandle(*j) = -1;
           scaleMomentumMHandle(*j) = -1;
         }
         return StatusCode::SUCCESS;
       }
       
     }
   }
  
   // choose PV.
   const xAOD::Vertex *vx = vxContainer->at(PVindex); 
  
   ATH_MSG_DEBUG(" correcting  jets ");
   for(const xAOD::Jet * jet : jetCont){
     ATH_MSG_DEBUG("  ---->  jet "<< jet);
     ATH_MSG_DEBUG("                     jet pT: "<< jet->pt());
  
     if(!m_onlyAssignPV) {
       xAOD::CaloCluster::State state = xAOD::CaloCluster::UNKNOWN;
       if(m_forceEMScale) state = xAOD::CaloCluster::UNCALIBRATED;
       xAOD::JetFourMom_t fv = jet::clusterOriginCorrection(*jet,*vx,state);
       ATH_MSG_DEBUG("  " <<  m_correctionName << " pT: " << fv.pt());
       scaleMomentumPtHandle(*jet) = fv.pt();
       scaleMomentumPhiHandle(*jet) = fv.phi();
       scaleMomentumEtaHandle(*jet) = fv.eta();
       scaleMomentumMHandle(*jet) = fv.M();
     }
     originVertexHandle(*jet) = ElementLink<xAOD::VertexContainer>(*vxContainer, vxContainer->at(PVindex)->index());
  
   }
   return StatusCode::SUCCESS;
 }

◆ 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

◆ 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 JetOriginCorrectionTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

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

Reimplemented from asg::AsgTool.

Definition at line 25 of file JetOriginCorrectionTool.cxx.

                                                {
   ATH_CHECK(m_vertexContainer_key.initialize());
   ATH_CHECK(m_eventInfo_key.initialize());
   if(m_jetContainerName.empty()) {
     ATH_MSG_ERROR("JetOriginCorrectionTool needs to have its input jet container configured!");
     return StatusCode::FAILURE;
   }
  
   m_scaleMomentumPtKey = m_jetContainerName + "." + m_scaleMomentumName + "_" + m_scaleMomentumPtKey.key();
   m_scaleMomentumPhiKey = m_jetContainerName + "." + m_scaleMomentumName + "_" + m_scaleMomentumPhiKey.key();
   m_scaleMomentumEtaKey = m_jetContainerName + "." + m_scaleMomentumName + "_" + m_scaleMomentumEtaKey.key();
   m_scaleMomentumMKey = m_jetContainerName + "." + m_scaleMomentumName + "_" + m_scaleMomentumMKey.key();
   m_originVertexKey = m_jetContainerName + "." + m_originVertexKey.key();
  
   ATH_CHECK(m_scaleMomentumPtKey.initialize());
   ATH_CHECK(m_scaleMomentumPhiKey.initialize());
   ATH_CHECK(m_scaleMomentumEtaKey.initialize());
   ATH_CHECK(m_scaleMomentumMKey.initialize());
   ATH_CHECK(m_originVertexKey.initialize());
  
   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.

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

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

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

Gaudi::Property<std::string> JetOriginCorrectionTool::m_correctionName {this, "OriginCorrectedName", "JetOriginConstitScaleMomentum", "Origin corrected name"}

protected

Definition at line 51 of file JetOriginCorrectionTool.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_eventInfo_key

SG::ReadHandleKey<xAOD::EventInfo> JetOriginCorrectionTool::m_eventInfo_key {this, "EventInfoName", "EventInfo", "Event info name"}

private

Definition at line 59 of file JetOriginCorrectionTool.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_forceEMScale

Gaudi::Property<bool> JetOriginCorrectionTool::m_forceEMScale {this, "ForceEMScale", false, "Force apply origin correction at EM scale"}

protected

Definition at line 54 of file JetOriginCorrectionTool.h.

◆ m_jetContainerName

Gaudi::Property<std::string> JetOriginCorrectionTool::m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}

protected

Definition at line 52 of file JetOriginCorrectionTool.h.

◆ m_onlyAssignPV

Gaudi::Property<bool> JetOriginCorrectionTool::m_onlyAssignPV {this, "OnlyAssignPV", false, "Only write out PV information"}

protected

Definition at line 53 of file JetOriginCorrectionTool.h.

◆ m_originVertexKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetOriginCorrectionTool::m_originVertexKey {this, "OriginVertexName", "OriginVertex", "SG key for output OriginVertex decorator"}

private

Definition at line 66 of file JetOriginCorrectionTool.h.

◆ m_scaleMomentumEtaKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetOriginCorrectionTool::m_scaleMomentumEtaKey {this, "JetScaleMomentumEtaName", "eta", "SG suffix for output JetScaleMomentum (eta) decorator"}

private

Definition at line 64 of file JetOriginCorrectionTool.h.

◆ m_scaleMomentumMKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetOriginCorrectionTool::m_scaleMomentumMKey {this, "JetScaleMomentumMName", "m", "SG suffix for output JetScaleMomentum (mass) decorator"}

private

Definition at line 65 of file JetOriginCorrectionTool.h.

◆ m_scaleMomentumName

Gaudi::Property<std::string> JetOriginCorrectionTool::m_scaleMomentumName {this, "jetScaleMomentName", "JetOriginConstitScaleMomentum", "SG key for JetScaleMomentum components"}

private

Definition at line 61 of file JetOriginCorrectionTool.h.

◆ m_scaleMomentumPhiKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetOriginCorrectionTool::m_scaleMomentumPhiKey {this, "JetScaleMomentumPhiName", "phi", "SG suffix for output JetScaleMomentum (phi) decorator"}

private

Definition at line 63 of file JetOriginCorrectionTool.h.

◆ m_scaleMomentumPtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetOriginCorrectionTool::m_scaleMomentumPtKey {this, "JetScaleMomentumPtName", "pt", "SG suffix for output JetScaleMomentum (pt) decorator"}

private

Definition at line 62 of file JetOriginCorrectionTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> JetOriginCorrectionTool::m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "Primary vertex container name"}

private

Definition at line 58 of file JetOriginCorrectionTool.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

◆ JetOriginCorrectionTool()

Member Function Documentation

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

◆ decorate()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_correctionName

◆ m_detStore

◆ m_eventInfo_key

◆ m_evtStore

◆ m_forceEMScale

◆ m_jetContainerName

◆ m_onlyAssignPV

◆ m_originVertexKey

◆ m_scaleMomentumEtaKey

◆ m_scaleMomentumMKey

◆ m_scaleMomentumName

◆ m_scaleMomentumPhiKey

◆ m_scaleMomentumPtKey

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka