JetEMScaleMomTool Class Reference

#include <JetEMScaleMomTool.h>

Inheritance diagram for JetEMScaleMomTool:

Collaboration diagram for JetEMScaleMomTool:

Public Member Functions
	JetEMScaleMomTool (const std::string &t)
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it.
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
virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier.
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
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}
Gaudi::Property< bool >	m_useUncalibConstits {this, "UseUncalibConstits", true, "Toggle for extracting the EMScale momentum from uncalibrated topoclusters"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_emscalePtKey {this, "EMScalePtName", "JetEMScaleMomentum_pt", "SG key for the EMScale pt attribute"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_emscaleEtaKey {this, "EMScaleEtaName", "JetEMScaleMomentum_eta", "SG key for the EMScale eta attribute"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_emscalePhiKey {this, "EMScalePhiName", "JetEMScaleMomentum_phi", "SG key for the EMScale phi attribute"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_emscaleMassKey {this, "EMScaleMassName", "JetEMScaleMomentum_m", "SG key for the EMScale mass attribute"}
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 18 of file JetEMScaleMomTool.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

JetEMScaleMomTool()

JetEMScaleMomTool::JetEMScaleMomTool

(

const std::string &

t

)

Definition at line 49 of file JetEMScaleMomTool.cxx.

: AsgTool(name) { }

Member Function Documentation

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

decorate()

StatusCode JetEMScaleMomTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 75 of file JetEMScaleMomTool.cxx.

                                                                         {
  ATH_MSG_VERBOSE("Begin decorating jets.");
  p4Decorator emscale_decor(m_emscalePtKey, m_emscaleEtaKey, m_emscalePhiKey, m_emscaleMassKey);
 
  for(const xAOD::Jet* jet : jets) {
    if(m_useUncalibConstits) {
      // Need to loop and sum the constituents
      xAOD::JetConstituentVector constits = jet->getConstituents();
      if(! constits.isValid() ) {
    ATH_MSG_WARNING("Jet constituent vector is invalid. Can't set EM scale momentum");
    return StatusCode::FAILURE;
      }
      xAOD::JetFourMom_t em_p4 = getEMScaleP4(constits);
      emscale_decor.decorateP4(*jet,em_p4);
    } else {
      // Simply add the constituent-level p4
      xAOD::JetFourMom_t constit_p4 = jet->jetP4(xAOD::JetConstitScaleMomentum);
      emscale_decor.decorateP4(*jet,constit_p4);
    }
 
  }
 
  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.

{ return m_detStore; }

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.

{ 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 JetEMScaleMomTool::initialize ( void )

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 54 of file JetEMScaleMomTool.cxx.

                                         {
  ATH_MSG_INFO("Initializing JetEMScaleMomTool " << name());
  
  if(m_jetContainerName.empty()){
    ATH_MSG_ERROR("JetEMScaleMomTool needs to have its input jet container configured!");
    return StatusCode::FAILURE;
  }
 
  std::vector<std::reference_wrapper<SG::WriteDecorHandleKey<xAOD::JetContainer> > > keys = {m_emscalePtKey, m_emscaleEtaKey, m_emscalePhiKey, m_emscaleMassKey};
  for(SG::WriteDecorHandleKey<xAOD::JetContainer>& key : keys) {
    key = m_jetContainerName + "." + key.key();
    ATH_CHECK( key.initialize() );
  }
  
  ATH_MSG_DEBUG("Operating on jets with " << (m_useUncalibConstits ? "" : "un") << "calibrated constituents." );
 
  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.

{return decorate(jets);};

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

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

Member Data Documentation

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_emscaleEtaKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetEMScaleMomTool::m_emscaleEtaKey {this, "EMScaleEtaName", "JetEMScaleMomentum_eta", "SG key for the EMScale eta attribute"}

private

Definition at line 35 of file JetEMScaleMomTool.h.

{this,  "EMScaleEtaName",  "JetEMScaleMomentum_eta", "SG key for the EMScale eta attribute"};

m_emscaleMassKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetEMScaleMomTool::m_emscaleMassKey {this, "EMScaleMassName", "JetEMScaleMomentum_m", "SG key for the EMScale mass attribute"}

private

Definition at line 37 of file JetEMScaleMomTool.h.

{this, "EMScaleMassName", "JetEMScaleMomentum_m",   "SG key for the EMScale mass attribute"};

m_emscalePhiKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetEMScaleMomTool::m_emscalePhiKey {this, "EMScalePhiName", "JetEMScaleMomentum_phi", "SG key for the EMScale phi attribute"}

private

Definition at line 36 of file JetEMScaleMomTool.h.

{this,  "EMScalePhiName",  "JetEMScaleMomentum_phi", "SG key for the EMScale phi attribute"};

m_emscalePtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetEMScaleMomTool::m_emscalePtKey {this, "EMScalePtName", "JetEMScaleMomentum_pt", "SG key for the EMScale pt attribute"}

private

Definition at line 34 of file JetEMScaleMomTool.h.

{this,   "EMScalePtName",   "JetEMScaleMomentum_pt",  "SG key for the EMScale pt attribute"};

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_jetContainerName

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

private

Definition at line 29 of file JetEMScaleMomTool.h.

{this, "JetContainer", "", "SG key for the input jet container"};

m_useUncalibConstits

Gaudi::Property<bool> JetEMScaleMomTool::m_useUncalibConstits {this, "UseUncalibConstits", true, "Toggle for extracting the EMScale momentum from uncalibrated topoclusters"}

private

Definition at line 32 of file JetEMScaleMomTool.h.

{this, "UseUncalibConstits", true, "Toggle for extracting the EMScale momentum from uncalibrated topoclusters"};

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:

• JetEMScaleMomTool.h
• JetEMScaleMomTool.cxx