David Adams
April 2014. More...

#include <JetPtAssociationTool.h>

Inheritance diagram for JetPtAssociationTool:

Collaboration diagram for JetPtAssociationTool:

Public Types
typedef std::vector< const xAOD::IParticle * >	APVector
typedef std::vector< unsigned >	IndexVector
typedef std::vector< float >	FloatVector

Public Member Functions
	JetPtAssociationTool (const std::string &myname)
	Constructor from tool name.
virtual StatusCode	initialize () override
	Initialization.
virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Inherited method to modify a jet.
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
int	ptfrac (const APVector &aps, const xAOD::JetContainer &jets, FloatVector &ptsums) const
	Return the matched pT sum for each jet in a collection.
int	match (const APVector &aps, const xAOD::Jet &jet, APVector &apvs, double &ptsum_constituents) const
	Return the vector of AP's that appear as constituents of the given jet.
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_aname {this, "AssociationName", "", "Key for association vector"}
	Properties.
Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "Input jet container"}
SG::ReadHandleKey< xAOD::JetContainer >	m_matchingContainerName {this, "MatchingJetContainer", "", "Jet container to match to"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_assocFracKey {this, "AssociationFractionName", "AssociationFraction", "SG key for output AssociationFraction decoration"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_assocLinkKey {this, "AssociationLinkName", "AssociationLink", "SG key for output AssociationLink decoration"}
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

David Adams
April 2014.

Tool to associate jets using the fraction of AP (associated particle) pT shared with the constituents of jets in a matching container. Properties: AssociationName - Name of the association InputContainer - Name of the matching jet container

Definition at line 26 of file JetPtAssociationTool.h.

Member Typedef Documentation

◆ APVector

typedef std::vector<const xAOD::IParticle*> JetPtAssociationTool::APVector

Definition at line 32 of file JetPtAssociationTool.h.

◆ FloatVector

typedef std::vector<float> JetPtAssociationTool::FloatVector

Definition at line 34 of file JetPtAssociationTool.h.

◆ IndexVector

typedef std::vector<unsigned> JetPtAssociationTool::IndexVector

Definition at line 33 of file JetPtAssociationTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ JetPtAssociationTool()

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

Constructor from tool name.

Definition at line 21 of file JetPtAssociationTool.cxx.

  : asg::AsgTool(myname) {
 
}

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 JetPtAssociationTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Inherited method to modify a jet.

Extract and record the element link and pT fraction for the jet with the highest such fraction.

Implements IJetDecorator.

Definition at line 48 of file JetPtAssociationTool.cxx.

                                                                            {
 
  SG::WriteDecorHandle<xAOD::JetContainer, float> assocFracHandle(m_assocFracKey);
  SG::WriteDecorHandle<xAOD::JetContainer, ElementLink<JetContainer>> assocLinkHandle(m_assocLinkKey);
  
  for(const xAOD::Jet* jet : jets) {
    ATH_MSG_DEBUG("Processing jet " << jet->index());
    APVector apins;
 
    // Retrieve the association vector.
    if ( ! jet->getAssociatedObjects(m_aname, apins) ) {
      ATH_MSG_WARNING("Jet does not have association vector " << m_aname);
      return StatusCode::FAILURE;
    }
 
    // Retrieve the container of jets to be matched.
    SG::ReadHandle<xAOD::JetContainer> handle (m_matchingContainerName);
    if (!handle.isValid()){
      ATH_MSG_WARNING("Matching jet container not found: "
                      << m_matchingContainerName); 
      return StatusCode::FAILURE;
    }
 
    const auto *pjets = handle.cptr();
 
    // Match associated particle to jets.
    FloatVector ptfs;
    if ( ptfrac(apins, *pjets, ptfs) ) {
      ATH_MSG_WARNING("Match of association vector to jets failed");
      return StatusCode::FAILURE;
    }
    // Find the best match.
    float frac = 0.0;
    unsigned int ijet_matched = ptfs.size();
    for ( unsigned int ijet=0; ijet<ptfs.size(); ++ijet ) {
      ATH_MSG_VERBOSE("  Pt fraction[" << ijet << "]: " << ptfs[ijet]);
      if ( ptfs[ijet] > frac ) {
        frac = ptfs[ijet];
        ijet_matched = ijet;
      }
    }
    ElementLink<JetContainer> el;
    if ( ijet_matched < ptfs.size() ) {
      el = ElementLink<JetContainer>(*pjets, ijet_matched);
    }
    string sfrac = m_aname + "AssociationFraction";
    string slink = m_aname + "AssociationLink";
    ATH_MSG_DEBUG("  Setting " << sfrac << " = " << frac);
    assocFracHandle(*jet) = frac;
    ATH_MSG_DEBUG("  Setting " << slink << " = "
                  << el.dataID() << "[" << el.index() << "]");
    assocLinkHandle(*jet) = el;
  }
  return StatusCode::SUCCESS;
}

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

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

overridevirtual

Initialization.

Reimplemented from asg::AsgTool.

Definition at line 28 of file JetPtAssociationTool.cxx.

                                            {
 
  if(m_jetContainerName.empty()) {
    ATH_MSG_ERROR("JetPtAssociationTool needs to have its input jet container configured!");
    return StatusCode::FAILURE;
  }
  m_assocFracKey = m_jetContainerName + "." + m_aname + m_assocFracKey.key();
  m_assocLinkKey = m_jetContainerName + "." + m_aname + m_assocLinkKey.key();
 
  ATH_CHECK(m_assocFracKey.initialize());
  ATH_CHECK(m_assocLinkKey.initialize());
 
  ATH_CHECK(m_matchingContainerName.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.

◆ match()

int JetPtAssociationTool::match	(	const APVector &	aps,
		const xAOD::Jet &	jet,
		APVector &	apvs,
		double &	ptsum_constituents ) const

private

Return the vector of AP's that appear as constituents of the given jet.

aps - input AP vector jet - Jet to be matched apvs - output vector of matched AP indices ptsum - sum of jet constituent pts

Definition at line 129 of file JetPtAssociationTool.cxx.

                                                                                                 {
  ptsum_constituents = 0.;
  apvs.clear();
  const JetConstituentVector cons = jet.getConstituents();
  for ( const JetConstituent* pcon : cons ) {
    const IParticle* pparcon = pcon->rawConstituent();
    ptsum_constituents+=pparcon->pt();
    for ( const IParticle* pparap : aps ) {
      if ( pparap == pparcon ) {
        apvs.push_back(pparcon);
        break;
      }
    }
  }
  return 0;
}

◆ modify()

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

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32{return decorate(jets);};

IJetDecorator::decorate

virtual StatusCode decorate(const xAOD::JetContainer &jets) const =0

Decorate a jet collection without otherwise modifying it.

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

◆ ptfrac()

int JetPtAssociationTool::ptfrac	(	const APVector &	aps,
		const xAOD::JetContainer &	jets,
		FloatVector &	ptsums ) const

private

Return the matched pT sum for each jet in a collection.

The matching is done with match(). aps - input AP vector jet - Jet to be matched ptsums - output vector with matched pT fraction for each jet

Definition at line 106 of file JetPtAssociationTool.cxx.

                                                                                     {
  ptfs.clear();
  ptfs.resize(jets.size(), 0.0);
  ATH_MSG_DEBUG("Match jet count: " << jets.size());
  for ( unsigned int ijet=0; ijet<jets.size(); ++ijet ) {
    const Jet* pjet = jets[ijet];
    if ( pjet == nullptr ) return -3;
    APVector apouts;
    double ptsum_target = 0.;
    match(apins, *pjet, apouts, ptsum_target);
    double ptsum = 0.0;
    for ( const IParticle* ppar : apouts ) {
      if ( ppar == nullptr ) return -4;
      ptsum += ppar->pt();
    }
    ptfs[ijet] = ptsum/ptsum_target;
  }
  return 0;
}

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

Gaudi::Property<std::string> JetPtAssociationTool::m_aname {this, "AssociationName", "", "Key for association vector"}

private

Properties.

Definition at line 67 of file JetPtAssociationTool.h.

67{this, "AssociationName", "", "Key for association vector"};

◆ m_assocFracKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPtAssociationTool::m_assocFracKey {this, "AssociationFractionName", "AssociationFraction", "SG key for output AssociationFraction decoration"}

private

Definition at line 71 of file JetPtAssociationTool.h.

71{this, "AssociationFractionName", "AssociationFraction", "SG key for output AssociationFraction decoration"};

◆ m_assocLinkKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPtAssociationTool::m_assocLinkKey {this, "AssociationLinkName", "AssociationLink", "SG key for output AssociationLink decoration"}

private

Definition at line 72 of file JetPtAssociationTool.h.

72{this, "AssociationLinkName", "AssociationLink", "SG key for output AssociationLink decoration"};

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

Gaudi::Property<std::string> JetPtAssociationTool::m_jetContainerName {this, "JetContainer", "", "Input jet container"}

private

Definition at line 68 of file JetPtAssociationTool.h.

68{this, "JetContainer", "", "Input jet container"};

◆ m_matchingContainerName

SG::ReadHandleKey<xAOD::JetContainer> JetPtAssociationTool::m_matchingContainerName {this, "MatchingJetContainer", "", "Jet container to match to"}

private

Definition at line 69 of file JetPtAssociationTool.h.

69{this, "MatchingJetContainer", "", "Jet container to match to"};

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ APVector

◆ FloatVector

◆ IndexVector

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetPtAssociationTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ decorate()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ match()

◆ modify()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ ptfrac()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_aname

◆ m_assocFracKey

◆ m_assocLinkKey

◆ m_detStore

◆ m_evtStore

◆ m_jetContainerName

◆ m_matchingContainerName

◆ m_varHandleArraysDeclared

◆ m_vhka