EnergyCorrelatorTool Class Reference

#include <EnergyCorrelatorTool.h>

Inheritance diagram for EnergyCorrelatorTool:

Collaboration diagram for EnergyCorrelatorTool:

Classes
struct	moments_t
	ECF moments structure. More...

Public Member Functions
	EnergyCorrelatorTool (const std::string &name)
	Constructor. More...
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
StatusCode	modify (xAOD::JetContainer &jets) const override
	Loop over calls to modifyJet. 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, V, H > &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

Protected Member Functions
bool	SetupDecoration (fastjet::PseudoJet &pseudojet, const xAOD::Jet &jet, bool requireJetStructure=false) const
bool	checkForConstituents (const xAOD::Jet &jet) const
fastjet::PseudoJet	buildPseudoJet (const xAOD::Jet &jet, bool requireJetStructure=false) const
fastjet::PseudoJet	buildPseudoJet (const std::vector< const xAOD::IParticle * > &iparticles) const
virtual void	print () const
	Print the state of the tool. More...
virtual int	modifyJet (xAOD::Jet &jet) const
	Modify a single jet. This is obsolete and set to be removed. More...
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
std::string	m_inputContainer
std::string	m_prefix

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> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< std::string >	m_jetContainerName
float	m_Beta
	Configurable as properties. More...
bool	m_doC3
bool	m_doC4
std::vector< float >	m_rawBetaVals
bool	m_doDichroic
	Vector of input values before cleaning. More...
std::vector< std::pair< float, moments_t > >	m_moments
	Map of moment calculators and decorators using beta as the key. More...
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF1_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF2_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF3_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF4_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF5_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF1_ungroomed_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF2_ungroomed_Keys
SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_ECF3_ungroomed_Keys
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

---

The default behavior of this tool is to use beta = 1.0, but multiple values of beta can be used simultaneously. The property BetaList should be passed a list of floats. Values of < 0 or > 10 may result in problematic output variable names and all values will be rounded to the nearest 0.1. No suffix will be added to the outputs for beta = 1.0 and for other values a suffix of _BetaN will be added where N = int(10*beta).

The DoDichroic option adds dichroic energy correlator ratios described

on page 120 in https://arxiv.org/abs/1803.07977

Definition at line 29 of file EnergyCorrelatorTool.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

EnergyCorrelatorTool()

EnergyCorrelatorTool::EnergyCorrelatorTool

(

const std::string &

name

)

Constructor.

Definition at line 9 of file EnergyCorrelatorTool.cxx.

                                                                : 
  JetSubStructureMomentToolsBase(name)
{
  declareProperty("Beta",       m_Beta = 1.0);
  declareProperty("BetaList",   m_rawBetaVals = {});
  declareProperty("DoC3",       m_doC3 = false);
  declareProperty("DoC4",       m_doC4 = false);
  declareProperty("DoDichroic", m_doDichroic = false);
}

Member Function Documentation

buildPseudoJet() [1/2]

fastjet::PseudoJet JetSubStructureMomentToolsBase::buildPseudoJet ( const std::vector< const xAOD::IParticle * > &  iparticles ) const

protectedinherited

Definition at line 59 of file JetSubStructureMomentToolsBase.cxx.

                                                                                                                       {
  std::vector<fastjet::PseudoJet> pjs;
  pjs.reserve(iparticles.size());
  for (const auto *iparticle : iparticles)  
    pjs.emplace_back(iparticle->p4());
  return fastjet::join(pjs);
}

buildPseudoJet() [2/2]

fastjet::PseudoJet JetSubStructureMomentToolsBase::buildPseudoJet ( const xAOD::Jet &  jet, bool  requireJetStructure = false  ) const

protectedinherited

Definition at line 54 of file JetSubStructureMomentToolsBase.cxx.

                                                                                                                    {
  std::vector<fastjet::PseudoJet> constit_pseudojets = jet::JetConstituentFiller::constituentPseudoJets(jet,true,requireJetStructure);
  return fastjet::join(constit_pseudojets);
}

checkForConstituents()

bool JetSubStructureMomentToolsBase::checkForConstituents ( const xAOD::Jet &  jet ) const

inlineprotectedinherited

Definition at line 33 of file JetSubStructureMomentToolsBase.h.

                                                          {
        if(jet.numConstituents() == 0) {
          ATH_MSG_WARNING("Attempting to use a substructure tool on a jet that has no constituent");
          return false;
        } else {
          return true;
        }
      }

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > &  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, 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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > &  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, V, H > &  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, 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() [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.

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

{ 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 EnergyCorrelatorTool::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...

Call base class initialize to fix up m_prefix

Add beta = 1.0 by default

Add beta = m_Beta by default to keep backwards compatibility

Give warning about deprecation

Use m_Beta to not break analysis code

Clean up input list of beta values

Round to the nearest 0.1

Skip negative values of beta

Store value. std::map::emplace prevents duplicate entries

Print out list of beta values to debug stream

If DoC4 is set to true, set DoC3 to true by default since it won't add any additional computational overhead

Reimplemented from asg::AsgTool.

Definition at line 19 of file EnergyCorrelatorTool.cxx.

                                            {
  if(m_jetContainerName.empty()){
    ATH_MSG_ERROR("EnergyCorrelatorTool needs to have its input jet container name configured!");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK( JetSubStructureMomentToolsBase::initialize() );
 
  m_moments.emplace_back( 1.0, moments_t(1.0, m_prefix) );
 
  if( std::abs(m_Beta-1.0) > 1.0e-5 ) {
 
    ATH_MSG_WARNING( "The Beta property is deprecated, please use the BetaList property to provide a list of values");
 
    m_moments.emplace_back( m_Beta, moments_t(m_Beta, m_prefix) );
 
  }
 
  for( float beta : m_rawBetaVals ) {
 
    float betaFix = round( beta * 10.0 ) / 10.0;
    if( std::abs(beta-betaFix) > 1.0e-5 ) ATH_MSG_DEBUG( "beta = " << beta << " has been rounded to " << betaFix );
 
    if( betaFix < 0.0 ) {
      ATH_MSG_WARNING( "beta must be positive. Skipping beta = " << beta );
      continue;
    }
 
    m_moments.emplace_back( betaFix, moments_t(betaFix, m_prefix) );
 
  }
 
  for( auto const& moment : m_moments ) {
    ATH_MSG_DEBUG( "Including beta = " << moment.first );
  }
 
  if( m_doC4 ) m_doC3 = true;
 
  // Initialise WriteDecorHandleKeys
  for( const auto& [beta, moment] : m_moments ) {
    m_ECF1_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                 "ECF1" + moment.suffix);
    m_ECF2_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                 "ECF2" + moment.suffix);
    m_ECF3_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                 "ECF3" + moment.suffix);
    m_ECF4_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                 "ECF4" + moment.suffix);
    m_ECF5_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                 "ECF5" + moment.suffix);
    m_ECF1_ungroomed_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                       "ECF1_ungroomed" + moment.suffix);
    m_ECF2_ungroomed_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                       "ECF2_ungroomed" + moment.suffix);
    m_ECF3_ungroomed_Keys.emplace_back(m_jetContainerName + "." + moment.prefix +
                       "ECF3_ungroomed" + moment.suffix);
  }
 
  ATH_CHECK(m_ECF1_Keys.initialize());
  ATH_CHECK(m_ECF2_Keys.initialize());
  ATH_CHECK(m_ECF3_Keys.initialize());
  ATH_CHECK(m_ECF4_Keys.initialize());
  ATH_CHECK(m_ECF5_Keys.initialize());
  ATH_CHECK(m_ECF1_ungroomed_Keys.initialize());
  ATH_CHECK(m_ECF2_ungroomed_Keys.initialize());
  ATH_CHECK(m_ECF3_ungroomed_Keys.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()

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

overridevirtual

Loop over calls to modifyJet.

Bool to decide whether calculation should be performed

Bool to decide if ungroomed jet moments should be calculated

Get parent jet

Return error is parent element link is broken

Reimplemented from JetModifierBase.

Definition at line 102 of file EnergyCorrelatorTool.cxx.

                                                                    {
 
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF1;
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF2;
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF3;
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF4;
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF5;
 
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF1_ungroomed;
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF2_ungroomed;
  std::vector<SG::WriteDecorHandle<xAOD::JetContainer, float>> wdhs_ECF3_ungroomed;
 
  for(unsigned int i=0; i<m_moments.size(); i++) {
    wdhs_ECF1.emplace_back(m_ECF1_Keys[i]);
    wdhs_ECF2.emplace_back(m_ECF2_Keys[i]);
    wdhs_ECF3.emplace_back(m_ECF3_Keys[i]);
    wdhs_ECF4.emplace_back(m_ECF4_Keys[i]);
    wdhs_ECF5.emplace_back(m_ECF5_Keys[i]);
 
    wdhs_ECF1_ungroomed.emplace_back(m_ECF1_ungroomed_Keys[i]);
    wdhs_ECF2_ungroomed.emplace_back(m_ECF2_ungroomed_Keys[i]);
    wdhs_ECF3_ungroomed.emplace_back(m_ECF3_ungroomed_Keys[i]);
  }
 
  for(const xAOD::Jet* injet : jets){
 
    fastjet::PseudoJet jet;
    fastjet::PseudoJet jet_ungroomed;
 
    bool calculate = SetupDecoration(jet,*injet);
 
    bool calculate_ungroomed = false;
 
    if( m_doDichroic ) {
 
      static const SG::ConstAccessor<ElementLink<xAOD::JetContainer> > ParentAcc ("Parent");
      ElementLink<xAOD::JetContainer> parentLink = ParentAcc (*injet);
 
      if( !parentLink.isValid() ) {
    ATH_MSG_ERROR( "Parent element link is not valid. Aborting" );
    return StatusCode::FAILURE;
      }
 
      const xAOD::Jet* parentJet = *(parentLink);
      calculate_ungroomed = SetupDecoration(jet_ungroomed,*parentJet);
 
    }
 
    for(unsigned int i=0; i<m_moments.size(); i++) {
      float beta = m_moments[i].first;
 
      float ECF1_value = -999;
      float ECF2_value = -999;
      float ECF3_value = -999;
      float ECF4_value = -999;
      float ECF5_value = -999;
 
      float ECF1_ungroomed_value = -999;
      float ECF2_ungroomed_value = -999;
      float ECF3_ungroomed_value = -999;
 
      if( calculate ) {
 
    JetSubStructureUtils::EnergyCorrelator ECF1(1, beta, JetSubStructureUtils::EnergyCorrelator::pt_R);
    JetSubStructureUtils::EnergyCorrelator ECF2(2, beta, JetSubStructureUtils::EnergyCorrelator::pt_R);
    JetSubStructureUtils::EnergyCorrelator ECF3(3, beta, JetSubStructureUtils::EnergyCorrelator::pt_R);
 
    ECF1_value = ECF1.result(jet);
    ECF2_value = ECF2.result(jet);
    ECF3_value = ECF3.result(jet);
 
    if( m_doC3 ) {
      JetSubStructureUtils::EnergyCorrelator ECF4(4, beta, JetSubStructureUtils::EnergyCorrelator::pt_R);
      ECF4_value = ECF4.result(jet);
    }
 
    if( m_doC4 ) {
      JetSubStructureUtils::EnergyCorrelator ECF5(5, beta, JetSubStructureUtils::EnergyCorrelator::pt_R);
      ECF5_value = ECF5.result(jet);
    }
 
    if( calculate_ungroomed ) {
      ECF1_ungroomed_value = ECF1.result(jet_ungroomed);
      ECF2_ungroomed_value = ECF2.result(jet_ungroomed);
      ECF3_ungroomed_value = ECF3.result(jet_ungroomed);
    }
 
      }
 
      wdhs_ECF1[i](*injet) = ECF1_value;
      wdhs_ECF2[i](*injet) = ECF2_value;
      wdhs_ECF3[i](*injet) = ECF3_value;
      wdhs_ECF4[i](*injet) = ECF4_value;
      wdhs_ECF5[i](*injet) = ECF5_value;
 
      wdhs_ECF1_ungroomed[i](*injet) = ECF1_ungroomed_value;
      wdhs_ECF2_ungroomed[i](*injet) = ECF2_ungroomed_value;
      wdhs_ECF3_ungroomed[i](*injet) = ECF3_ungroomed_value;
    }
 
  }
 
  return StatusCode::SUCCESS;
}

modifyJet()

int JetModifierBase::modifyJet ( xAOD::Jet &  jet ) const

protectedvirtualinherited

Modify a single jet. This is obsolete and set to be removed.

Reimplemented in EnergyCorrelatorGeneralizedRatiosTool, EnergyCorrelatorRatiosTool, HIJetConstituentModifierTool, NSubjettinessRatiosTool, JetConstitRemover, EffectiveRTool, SubjetMakerTool, Analysis::JetPartonTruthLabel, JetChargeTool, SubjetFinderTool, BoostedXbbTagTool, ShowerDeconstructionTool, VolatilityTool, MultiplicitiesTool, LundVariablesTool, NSubjettinessTool, QwTool, JetPullTool, KtDeltaRTool, AngularityTool, CenterOfMassShapesTool, DipolarityTool, KtMassDropTool, KTSplittingScaleTool, PlanarFlowTool, SoftDropObservablesTool, HIJetConstituentSubtractionTool, HIJetClusterIndexAssociationTool, HIJetDRAssociationTool, and HIJetDiscriminatorTool.

Definition at line 26 of file JetModifierBase.cxx.

                                            {
  ATH_MSG_WARNING("JetModifierBase::modifyJet() is obsolete, does nothing, and should not be used!");
  return 1;
}

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 JetSubStructureMomentToolsBase::print ( ) const

protectedvirtualinherited

Print the state of the tool.

Reimplemented from asg::AsgTool.

Reimplemented in LundVariablesTool, and KtDeltaRTool.

Definition at line 67 of file JetSubStructureMomentToolsBase.cxx.

                                                 {
  ATH_MSG_INFO("Properties for JetSubStructureMomentTool " << name());
  ATH_MSG_INFO("InputContainer: " << m_inputContainer);
  ATH_MSG_INFO("Prefix: " << m_prefix);
}

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

SetupDecoration()

bool JetSubStructureMomentToolsBase::SetupDecoration ( fastjet::PseudoJet &  pseudojet, const xAOD::Jet &  jet, bool  requireJetStructure = false  ) const

protectedinherited

Definition at line 30 of file JetSubStructureMomentToolsBase.cxx.

                                                                                                                                    {
 
  bool decorate = true;
  
  if (m_inputContainer.empty()) {
    if (!checkForConstituents(jet))
      decorate = false;
    else pseudojet = buildPseudoJet(jet, requireJetStructure);
  }
  else {
    std::vector<const xAOD::IParticle*> AssociatedParticles;
    if (!(jet.getAssociatedObjects(m_inputContainer,AssociatedParticles))){
      ATH_MSG_WARNING("InputContainer " << m_inputContainer << " unknown. Exiting..");
      decorate = false;
    }
    ATH_MSG_VERBOSE("Found " << AssociatedParticles.size() << " associated particles");
    if(AssociatedParticles.empty()) decorate = false; 
    else pseudojet = buildPseudoJet(AssociatedParticles);
  }
 
  return decorate;
}

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_Beta

float EnergyCorrelatorTool::m_Beta

private

Configurable as properties.

Definition at line 72 of file EnergyCorrelatorTool.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_doC3

bool EnergyCorrelatorTool::m_doC3

private

Definition at line 73 of file EnergyCorrelatorTool.h.

m_doC4

bool EnergyCorrelatorTool::m_doC4

private

Definition at line 74 of file EnergyCorrelatorTool.h.

m_doDichroic

bool EnergyCorrelatorTool::m_doDichroic

private

Vector of input values before cleaning.

Definition at line 76 of file EnergyCorrelatorTool.h.

m_ECF1_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF1_Keys

private

Initial value:

{
    this, "ECF1_Keys", {}}

Definition at line 81 of file EnergyCorrelatorTool.h.

m_ECF1_ungroomed_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF1_ungroomed_Keys

private

Initial value:

{
    this, "ECF1_ungroomed_Keys", {}}

Definition at line 92 of file EnergyCorrelatorTool.h.

m_ECF2_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF2_Keys

private

Initial value:

{
    this, "ECF2_Keys", {}}

Definition at line 83 of file EnergyCorrelatorTool.h.

m_ECF2_ungroomed_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF2_ungroomed_Keys

private

Initial value:

{
    this, "ECF2_ungroomed_Keys", {}}

Definition at line 94 of file EnergyCorrelatorTool.h.

m_ECF3_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF3_Keys

private

Initial value:

{
    this, "ECF3_Keys", {}}

Definition at line 85 of file EnergyCorrelatorTool.h.

m_ECF3_ungroomed_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF3_ungroomed_Keys

private

Initial value:

{
    this, "ECF3_ungroomed_Keys", {}}

Definition at line 96 of file EnergyCorrelatorTool.h.

m_ECF4_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF4_Keys

private

Initial value:

{
    this, "ECF4_Keys", {}}

Definition at line 87 of file EnergyCorrelatorTool.h.

m_ECF5_Keys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> EnergyCorrelatorTool::m_ECF5_Keys

private

Initial value:

{
    this, "ECF5_Keys", {}}

Definition at line 89 of file EnergyCorrelatorTool.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_inputContainer

std::string JetSubStructureMomentToolsBase::m_inputContainer

protectedinherited

Definition at line 29 of file JetSubStructureMomentToolsBase.h.

m_jetContainerName

Gaudi::Property<std::string> EnergyCorrelatorTool::m_jetContainerName

private

Initial value:

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

Definition at line 43 of file EnergyCorrelatorTool.h.

m_moments

std::vector<std::pair< float, moments_t > > EnergyCorrelatorTool::m_moments

private

Map of moment calculators and decorators using beta as the key.

Definition at line 79 of file EnergyCorrelatorTool.h.

m_prefix

std::string JetSubStructureMomentToolsBase::m_prefix

protectedinherited

Definition at line 30 of file JetSubStructureMomentToolsBase.h.

m_rawBetaVals

std::vector<float> EnergyCorrelatorTool::m_rawBetaVals

private

Definition at line 75 of file EnergyCorrelatorTool.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:

• EnergyCorrelatorTool.h
• EnergyCorrelatorTool.cxx