JetConstitFourMomTool Class Reference

Russell Smith May 2015. More...

#include <JetConstitFourMomTool.h>

Inheritance diagram for JetConstitFourMomTool:

Collaboration diagram for JetConstitFourMomTool:

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

Protected Member Functions
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< int >	m_constitScale {this, "ConstitScale", 0, "Cluster signal state to use for the jet constituents"}
Gaudi::Property< std::vector< std::string > >	m_jetScaleNames {this, "JetScaleNames", {}, "The names of the jet scale"}
Gaudi::Property< std::vector< std::string > >	m_altColls {this, "AltConstitColls", {}, "Alternate collections to use (e.g. origin-corrected or not)"}
Gaudi::Property< std::vector< int > >	m_altConstitScales {this, "AltConstitScales", {}, "Scales to use for the alternate constituent collections"}
Gaudi::Property< std::vector< std::string > >	m_altJetScales {this, "AltJetScales", {}, "Existing momentum scales that should just be copied"}
std::vector< bool >	m_isDetectorEtaPhi
SG::ReadHandleKeyArray< xAOD::CaloClusterContainer >	m_altColls_keys {this, "AltConstitCollsKeys", {}, "Do not configure this manually"}
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

Russell Smith May 2015.

Tool to attach the LC constituent level 4-vector to EM Jets

Definition at line 23 of file JetConstitFourMomTool.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

JetConstitFourMomTool()

JetConstitFourMomTool::JetConstitFourMomTool

(

const std::string &

myname

)

Definition at line 14 of file JetConstitFourMomTool.cxx.

  : asg::AsgTool(myname)
{
#ifndef XAOD_STANDALONE
  declareInterface<IJetModifier>(this);
#endif
}

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

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

virtual

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 24 of file JetConstitFourMomTool.cxx.

                                             {
 
  // Workaround because configuring DataHandleKeyArray directly sneakily removes empty strings
  for(const auto& dhn : m_altColls){
    m_altColls_keys.emplace_back(SG::ReadHandleKey<xAOD::CaloClusterContainer>(dhn));
  }
 
  for(auto& dh : m_altColls_keys){ATH_CHECK(dh.initialize(!(dh.key().empty())));}
 
  // Check configuration consistency
  if( m_jetScaleNames.empty() ||
      (m_jetScaleNames.size() != m_altConstitScales.size()) ||
      (m_jetScaleNames.size() != m_altJetScales.size()) ||
      (m_jetScaleNames.size() != m_altColls_keys.size())
      ) {
    ATH_MSG_FATAL("Inconsistency in configuration -- all vector properties must have the same (nonzero) length! Sizes: " 
                  << m_jetScaleNames.size() << " "
                  << m_altConstitScales.size() << " "
                  << m_altJetScales.size() << " "
                  << m_altColls_keys.size());
    return StatusCode::FAILURE;
  }
 
  m_isDetectorEtaPhi.resize(m_jetScaleNames.size());
  for(size_t iScale=0; iScale<m_jetScaleNames.size(); ++iScale) {
    if(m_jetScaleNames[iScale]=="DetectorEtaPhi") {
      m_isDetectorEtaPhi[iScale] = true;
    }
    if(!m_altJetScales[iScale].empty() && !m_altColls_keys[iScale].key().empty()) {
      ATH_MSG_FATAL("Inconsistency in configuration -- Both AltJetScale and AltConstitColl set for scale " 
            << m_jetScaleNames[iScale] << "!");
      return StatusCode::FAILURE;      
    }
  }
 
 
  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()

StatusCode JetConstitFourMomTool::modify ( xAOD::JetContainer & jets ) const

virtual

Method to modify a jet collection.

Implements IJetModifier.

Definition at line 63 of file JetConstitFourMomTool.cxx.

                                                                     {
  if(jets.empty()) return StatusCode::SUCCESS;
 
  const size_t nScales=m_jetScaleNames.size();
  // This only really makes sense for clusters now, as signal states don't exist for other types
  std::vector<const xAOD::CaloClusterContainer*> altCollections(nScales,nullptr);
  // Do some setup that doesn't have to be repeated for each jet
  for(size_t iScale=0; iScale<nScales; ++iScale) {
    if(!m_altColls_keys[iScale].key().empty()) { // retrieve alternate constituent collections
      const xAOD::Jet& leadjet = *jets.front();
      if(isValidConstitType(leadjet.getInputType())) {
 
        auto handle = SG::makeHandle(m_altColls_keys[iScale]);
        if(!handle.isValid()){
          ATH_MSG_WARNING("Failed to retrieve alt cluster collection " 
                          << m_altColls_keys[iScale].key());
          return StatusCode::FAILURE;
        }
 
        altCollections[iScale] = handle.cptr();
      } else {
        ATH_MSG_WARNING("Alt collection " << m_altColls_keys[iScale].key() << " and jet type " << leadjet.getInputType() << " not supported yet!");
        return StatusCode::FAILURE;
      } // check that jet type/alt collection are implemented
    } // have an alt collection for this scale
  }
 
  // Limit ourselves to one loop over the constituents
  for(xAOD::Jet *jet : jets) {
    std::vector<xAOD::JetFourMom_t> constitFourVecs(nScales);
    // Get the constituents of the jet
    const xAOD::JetConstituentVector constituents = jet->getConstituents();
    // Gets the constituent iter at the appropriate scale
    xAOD::JetConstitScale constscale = (xAOD::JetConstitScale)(int(m_constitScale));
    for (auto citer = constituents.begin(constscale);
     citer != constituents.end(constscale); ++citer) {
      for (size_t iScale=0; iScale<nScales; ++iScale) {
    // If altJetScales is set, do nothing in the constituent loop.
    if(m_altJetScales[iScale].empty()) {
      if(altCollections[iScale]) { // get the index-parallel alternative constituent
        const xAOD::CaloCluster* cluster = static_cast<const xAOD::CaloCluster*>((*altCollections[iScale])[(*citer)->rawConstituent()->index()]);
        xAOD::CaloCluster::State currentState= static_cast<xAOD::CaloCluster::State> (m_altConstitScales[iScale]);
        constitFourVecs[iScale] += xAOD::JetFourMom_t( cluster->pt(currentState), cluster->eta(currentState), 
                               cluster->phi(currentState), cluster->m(currentState) );
        ATH_MSG_VERBOSE("Add cluster with pt " << cluster->pt() << " to constit fourvec for scale " << m_jetScaleNames[iScale] );
      } else { // add the constituent 4-mom
        ATH_MSG_VERBOSE("Add raw constituent with pt " << (*citer)->pt() << " to constit fourvec for scale " << m_jetScaleNames[iScale] );
        constitFourVecs[iScale] += **citer;
      }
    }
      } // loop over scales
    } // loop over clusters
 
    // Now we can set the scales from the various four-vecs we have calculated
    ATH_MSG_VERBOSE("Jet has "
         << " pt: " << jet->pt()
         << ", eta: " << jet->eta()
         << ", phi: " << jet->phi());
    for (size_t iScale=0; iScale<nScales; ++iScale) {
      if(!m_altJetScales[iScale].empty()) {
    // Easy case first -- just copy the momentum state
    constitFourVecs[iScale] = jet->jetP4(m_altJetScales[iScale]);
      }
      ATH_MSG_VERBOSE("Scale " << m_jetScaleNames[iScale] << " has "
           << " pt: " << constitFourVecs[iScale].Pt()
           << ", eta: " << constitFourVecs[iScale].Eta()
           << ", phi: " << constitFourVecs[iScale].Phi());
      if(m_isDetectorEtaPhi[iScale]) {
    const static SG::AuxElement::Accessor<float> acc_modEta("DetectorEta");
    const static SG::AuxElement::Accessor<float> acc_modPhi("DetectorPhi");
    const static SG::AuxElement::Accessor<float> acc_modY("DetectorY");
    acc_modEta(*jet) = constitFourVecs[iScale].Eta();
    acc_modPhi(*jet) = constitFourVecs[iScale].Phi();
    acc_modY(*jet) = constitFourVecs[iScale].Rapidity();
      ATH_MSG_VERBOSE("Detector eta: " << constitFourVecs[iScale].Eta()
              << ", phi: " << constitFourVecs[iScale].Phi()
              << ", rapidity: " << constitFourVecs[iScale].Rapidity());
      } else {
    jet->setJetP4(m_jetScaleNames[iScale], constitFourVecs[iScale]);
      }
    } // loop over scales
  } // loop over jets
 
  return StatusCode::SUCCESS;
}

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_altColls

Gaudi::Property<std::vector<std::string> > JetConstitFourMomTool::m_altColls {this, "AltConstitColls", {}, "Alternate collections to use (e.g. origin-corrected or not)"}

private

Definition at line 41 of file JetConstitFourMomTool.h.

{this, "AltConstitColls", {}, "Alternate collections to use (e.g. origin-corrected or not)"};

m_altColls_keys

SG::ReadHandleKeyArray<xAOD::CaloClusterContainer> JetConstitFourMomTool::m_altColls_keys {this, "AltConstitCollsKeys", {}, "Do not configure this manually"}

private

Definition at line 47 of file JetConstitFourMomTool.h.

{this, "AltConstitCollsKeys", {}, "Do not configure this manually"};

m_altConstitScales

Gaudi::Property<std::vector<int> > JetConstitFourMomTool::m_altConstitScales {this, "AltConstitScales", {}, "Scales to use for the alternate constituent collections"}

private

Definition at line 42 of file JetConstitFourMomTool.h.

{this, "AltConstitScales", {}, "Scales to use for the alternate constituent collections"};

m_altJetScales

Gaudi::Property<std::vector<std::string> > JetConstitFourMomTool::m_altJetScales {this, "AltJetScales", {}, "Existing momentum scales that should just be copied"}

private

Definition at line 43 of file JetConstitFourMomTool.h.

{this, "AltJetScales", {}, "Existing momentum scales that should just be copied"};

m_constitScale

Gaudi::Property<int> JetConstitFourMomTool::m_constitScale {this, "ConstitScale", 0, "Cluster signal state to use for the jet constituents"}

private

Definition at line 39 of file JetConstitFourMomTool.h.

{this, "ConstitScale", 0, "Cluster signal state to use for the jet constituents"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_isDetectorEtaPhi

std::vector<bool> JetConstitFourMomTool::m_isDetectorEtaPhi

private

Definition at line 45 of file JetConstitFourMomTool.h.

m_jetScaleNames

Gaudi::Property<std::vector<std::string> > JetConstitFourMomTool::m_jetScaleNames {this, "JetScaleNames", {}, "The names of the jet scale"}

private

Definition at line 40 of file JetConstitFourMomTool.h.

{this, "JetScaleNames", {}, "The names of the jet scale"};

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:

• JetConstitFourMomTool.h
• JetConstitFourMomTool.cxx