JetConstituentsRetriever Class Reference

#include <JetConstituentsRetriever.h>

Inheritance diagram for JetConstituentsRetriever:

Collaboration diagram for JetConstituentsRetriever:

Public Types
typedef std::vector< fastjet::PseudoJet >	PseudoJetVector
typedef std::vector< std::string >	NameList

Public Member Functions
	JetConstituentsRetriever (const std::string &name)
StatusCode	initialize ()
	Dummy implementation of the initialisation function.
int	constituents (const xAOD::Jet &jet, PseudoJetVector &cons, NameList *pghostlabs=nullptr) const
	Append constituents to the supplied vector.
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
bool	m_usepj
bool	m_usejetcons
ToolHandle< IJetPseudojetRetriever >	m_hpjr
NameList	m_glabs
double	m_gscale
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

Author

David Adams

Date

November 2014

Tool to retrieve the constituents associated with a jet.

Properties:

• UsePseudojet - If true and pseudojet exists, constituents are obtained from it.
• UseJetConstituents - If true, constituents are constructed from the jet constituents.
• PseudojetRetriever - The tool used to retrieve the jet pseudojet.
• GhostLabels - List of IParticle ghosts to include as constituents.
• GhostScale - Scale factor for ghost four-momenta.

Definition at line 28 of file JetConstituentsRetriever.h.

Member Typedef Documentation

NameList

typedef std::vector<std::string> IJetConstituentsRetriever::NameList

inherited

Definition at line 33 of file IJetConstituentsRetriever.h.

PseudoJetVector

typedef std::vector<fastjet::PseudoJet> IJetConstituentsRetriever::PseudoJetVector

inherited

Definition at line 32 of file IJetConstituentsRetriever.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

JetConstituentsRetriever()

JetConstituentsRetriever::JetConstituentsRetriever

(

const std::string &

name

)

Definition at line 26 of file JetConstituentsRetriever.cxx.

  : AsgTool(name), m_hpjr("",this) {
  declareProperty("UsePseudojet", m_usepj =true);
  declareProperty("UseJetConstituents", m_usejetcons =true);
  declareProperty("PseudojetRetriever", m_hpjr);
  declareProperty("GhostLabels", m_glabs);
  declareProperty("GhostScale", m_gscale);
}

Member Function Documentation

constituents()

int JetConstituentsRetriever::constituents ( const xAOD::Jet & jet, PseudoJetVector & cons, NameList * pghostlabs = nullptr ) const

virtual

Append constituents to the supplied vector.

Implements IJetConstituentsRetriever.

Definition at line 48 of file JetConstituentsRetriever.cxx.

                                         {
  // If flag is set, try to retrieve constituents from jet pseudojet.
  if ( m_usepj ) {
    ATH_MSG_VERBOSE("Using pseudojet to search for constituents.");
    if ( m_hpjr.empty() ) {
      ATH_MSG_WARNING("Pseudojet retriever not found.");
    } else {
      const fastjet::PseudoJet* ppj = m_hpjr->pseudojet(jet);
      if ( ppj == nullptr ) {
        ATH_MSG_VERBOSE("Pseudojet not found.");
      } else {
        if ( ! ppj->has_constituents() ) {
          ATH_MSG_WARNING("Jet pseudojet does not have constituents.");
        } else {
          PseudoJetVector pjcons = ppj->constituents();
          constits.insert(constits.end(), pjcons.begin(), pjcons.end());
          return 0;
        } 
      }
    }
  }
  // Remainder requires access to the label index map;
  jet::LabelIndex* pli = nullptr;
  const string liname = "PseudoJetLabelMap";
  if ( evtStore()->contains<jet::LabelIndex>(liname) ) {
    ATH_MSG_DEBUG("Fetching existing pseudojet label map.");
    pli = evtStore()->retrieve<jet::LabelIndex>(liname);
    if ( pli == nullptr ) {
      ATH_MSG_ERROR("Unable to fetch pseudojet label map.");
      return 1;
    }
  } else {
    ATH_MSG_DEBUG("Creating new pseudojet label map.");
    pli = new jet::LabelIndex(liname);
    if ( evtStore()->record(pli, liname).isFailure() ) {
    ATH_MSG_ERROR("Unable to store pseudojet label map.");
      return 2;
    }
  }
  // Add ATLAS jet constituents.
  if ( m_usejetcons ) {
    xAOD::JetInput::Type intype = jet.getInputType();
    string lab = xAOD::JetInput::typeName(intype);
    int labidx = pli->addLabel(lab);
    ATH_MSG_DEBUG("Jet input type is " << lab);
    ATH_MSG_VERBOSE("Looping over " << jet.getConstituents().size()
                    << " real constituents.");
    for ( const auto *const pjetcon : jet.getConstituents() ) {
      if ( pjetcon == nullptr ) {
        ATH_MSG_WARNING("Jet has null constituent");
      } else {
        //fastjet::PseudoJet psj(*pjetcon);
        fastjet::PseudoJet psj(pjetcon->px(), pjetcon->py(), pjetcon->pz(), pjetcon->e());
        const xAOD::IParticle* ppar = pjetcon->rawConstituent();
        jet::IConstituentUserInfo* pcui =
          new jet::IndexedConstituentUserInfo(*ppar, labidx, pli);
        psj.set_user_info(pcui);
        constits.push_back(psj);
        ATH_MSG_VERBOSE("  Real user info: particle=" << pcui->particle()
                        << ", index=" << pcui->index()
                        << ", label=" << pcui->label()
                        << ", isGhost=" << pcui->isGhost());
      }
    }
  }
  // Add ghosts.
  NameList glabs;
  ATH_MSG_VERBOSE("Looping over " << m_glabs.size() << " ghost labels.");
  for ( const std::string& glab : m_glabs ) {
    string gname = "Ghost" + glab;
    double fac = m_gscale;
    if ( glab == "MuonSegment" ) {
      MuonSegmentVector psegs;
      if ( jet.getAssociatedObjects(gname, psegs) ) {
        ATH_MSG_VERBOSE("  Found Muon segment vector " << gname << " with "
                            << psegs.size() << " entries.");
        int labidx = pli->addLabel(glab);
        glabs.push_back(glab);
        unsigned int iseg = 0;
        for ( const MuonSegment* pseg : psegs ) {
          if ( pseg == nullptr ) {
            ATH_MSG_DEBUG("Muon segment not found: " << gname << "[" << iseg << "]");
          } else {
            // Cut and paste from MuonSegmentPseudoJetGetter.
            double pt = 1.0e-20;   // Should be  property?
            double x = pseg->x();
            double y = pseg->y();
            double z = pseg->z();
            double xy = sqrt(x*x + y*y);
            double r = xy*xy + z*z;
            double pfac = pt/xy;
            double px = pfac*x;
            double py = pfac*y;
            double pz = pfac*z;
            double  e = pfac*r;
            fastjet::PseudoJet psj(px, py, pz, e);
            jet::IConstituentUserInfo* pcui =
              new jet::IndexedTConstituentUserInfo<MuonSegment>(*pseg, -labidx, pli);
            psj.set_user_info(pcui);
            constits.push_back(psj);
            ATH_MSG_VERBOSE("    Muon ghost user info: particle=" << pcui->particle()
                            << ", index=" << pcui->index()
                            << ", label=" << pcui->label()
                            << ", isGhost=" << pcui->isGhost());
            ATH_MSG_VERBOSE("    Adding " << gname << "[" << iseg << "]");
          }
          ++iseg;
        }
      } else {
        ATH_MSG_VERBOSE("  Muon segment vector " << gname << " is not found on jet.");
      }
 
    } else {
      IParticleVector ppars;
      if ( jet.getAssociatedObjects(gname, ppars) ) {
        ATH_MSG_VERBOSE("  Found IParticle vector " << gname << " with "
                            << ppars.size() << " entries.");
        int labidx = pli->addLabel(glab);
        glabs.push_back(glab);
        unsigned int ipar = 0;
        for ( const IParticle* ppar : ppars ) {
          if ( ppar == nullptr ) {
            ATH_MSG_DEBUG("IParticle not found: " << gname << "[" << ipar << "]");
          } else {
            auto p4 = ppar->p4();
            fastjet::PseudoJet psj(fac*p4.Px(), fac*p4.Py(), fac*p4.Pz(), fac*p4.E());
            jet::IConstituentUserInfo* pcui =
              new jet::IndexedConstituentUserInfo(*ppar, -labidx, pli);
            psj.set_user_info(pcui);
            constits.push_back(psj);
            ATH_MSG_VERBOSE("    Ghost user info: particle=" << pcui->particle()
                            << ", index=" << pcui->index()
                            << ", label=" << pcui->label()
                            << ", isGhost=" << pcui->isGhost());
            ATH_MSG_VERBOSE("    Adding " << gname << "[" << ipar << "]");
          }
          ++ipar;
        }
      } else {
        ATH_MSG_VERBOSE("  IParticle vector " << gname << " is not found on jet.");
      }
    }
  }
  if ( pghostlabs != nullptr ) {
    pghostlabs->insert(pghostlabs->end(), glabs.begin(), glabs.end());
  }
  return 1;
}

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 JetConstituentsRetriever::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 37 of file JetConstituentsRetriever.cxx.

                                                {
  if ( m_usepj ) {
    if ( m_hpjr.empty() ) {
      ATH_MSG_ERROR("  PseudojetRetriever is missing.");
    }
  }
  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.

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

virtual

Print the state of the tool.

Reimplemented from asg::AsgTool.

Definition at line 201 of file JetConstituentsRetriever.cxx.

                                           {
  ATH_MSG_INFO("JetConstituentsRetriever");
  ATH_MSG_INFO("  UsePseudojet: " << m_usepj);
  if ( m_usepj ) {
    if ( m_hpjr.empty() ) {
      ATH_MSG_INFO("  PseudojetRetriever is missing.");
    } else {
      ATH_MSG_INFO("  PseudojetRetriever: " << m_hpjr->name());
    }
  }
  ATH_MSG_INFO("  UsePseudojet: " << m_usepj);
  if ( m_glabs.empty() ) {
    ATH_MSG_INFO("  GhostLabels:");
    for ( const std::string& glab : m_glabs ) {
      ATH_MSG_INFO("    " << glab);
    }
  }
  ATH_MSG_INFO("  GhostScale: " << m_gscale);
}

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_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_glabs

NameList JetConstituentsRetriever::m_glabs

private

Definition at line 53 of file JetConstituentsRetriever.h.

m_gscale

double JetConstituentsRetriever::m_gscale

private

Definition at line 54 of file JetConstituentsRetriever.h.

m_hpjr

ToolHandle<IJetPseudojetRetriever> JetConstituentsRetriever::m_hpjr

private

Definition at line 52 of file JetConstituentsRetriever.h.

m_usejetcons

bool JetConstituentsRetriever::m_usejetcons

private

Definition at line 51 of file JetConstituentsRetriever.h.

m_usepj

bool JetConstituentsRetriever::m_usepj

private

Definition at line 50 of file JetConstituentsRetriever.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:

• JetConstituentsRetriever.h
• JetConstituentsRetriever.cxx