HIJetClusterIndexAssociationTool Class Reference

JetModifier that associates HIClusters w/ a jet. Necessary because you may want to know all clusters w/in DR < X rather than just the clusters that are constituents of the jet. Since HI-style clusters derive from towers they have a well-defined index For each jet, this tool associates a set of clusters from a pre-determined indexing. More...

#include <HIJetClusterIndexAssociationTool.h>

Inheritance diagram for HIJetClusterIndexAssociationTool:

Collaboration diagram for HIJetClusterIndexAssociationTool:

Public Member Functions
	HIJetClusterIndexAssociationTool (const std::string &t)
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	modify (xAOD::JetContainer &jets) const override
	Loop over calls to modifyJet.
virtual int	modifyJet (xAOD::Jet &) const override
	Modify a single jet. This is obsolete and set to be removed.
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
	ASG_TOOL_CLASS0 (HIJetClusterIndexAssociationTool)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::IParticleContainer >	m_containerKey { this, "ContainerKey", "", "Name of IParticleContainer w/ particles to associat"}
	name of IParticleContainer w/ particles to associate
Gaudi::Property< std::string >	m_assocName { this, "AssociationName", "", "Name of jet attribute providing link between jets and clusters" }
	Name of jet attribute providing link between jets and clusters.
Gaudi::Property< float >	m_DR { this, "DeltaR", 0.8, "Index passing actually needs to be implemented" }
Gaudi::Property< bool >	m_applyFilter { this, "ApplyFilter", false, "Apply filter boolean" }
Gaudi::Property< float >	m_Emin { this, "FilterMinE", -999., "Filter minimum Energy" }
Gaudi::Property< float >	m_pTmin { this, "FilterMinPt", 0., "Filter minimum Pt" }
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

JetModifier that associates HIClusters w/ a jet. Necessary because you may want to know all clusters w/in DR < X rather than just the clusters that are constituents of the jet. Since HI-style clusters derive from towers they have a well-defined index For each jet, this tool associates a set of clusters from a pre-determined indexing.

Author

Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch

Date

Jan, 2015

Given a DR value and an eta/phi position a set of indices of towers w/in DR of that position can be calculated, and can be done in advance or at initialization time rather than in the event loop. The set of such indices for each eta/phi position (defined by tower grid) is supplied to the tool, which uses this to perform the association.

Definition at line 37 of file HIJetClusterIndexAssociationTool.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

HIJetClusterIndexAssociationTool()

HIJetClusterIndexAssociationTool::HIJetClusterIndexAssociationTool

(

const std::string &

t

)

Definition at line 11 of file HIJetClusterIndexAssociationTool.cxx.

   :  JetModifierBase(n)
{
}

Member Function Documentation

ASG_TOOL_CLASS0()

HIJetClusterIndexAssociationTool::ASG_TOOL_CLASS0 ( HIJetClusterIndexAssociationTool )

private

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

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 18 of file HIJetClusterIndexAssociationTool.cxx.

                                                       {
  ATH_MSG_DEBUG("Initializing HIJetClusterIndexAssociationTool");
  ATH_CHECK( m_containerKey.initialize( !m_containerKey.key().empty() ) );
  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 HIJetClusterIndexAssociationTool::modify ( xAOD::JetContainer & jets ) const

overridevirtual

Loop over calls to modifyJet.

Reimplemented from JetModifierBase.

Definition at line 25 of file HIJetClusterIndexAssociationTool.cxx.

{
 
    const xAOD::IParticleContainer* ppars=0;
 
    ATH_MSG_DEBUG("Retrieving xAOD container " << m_containerKey.key() );
    SG::ReadHandle<xAOD::IParticleContainer>  readHandlePcontainer ( m_containerKey );
    ppars = readHandlePcontainer.get();
 
  for (xAOD::JetContainer::iterator ijet=jets.begin(); ijet!=jets.end(); ++ijet)
  {
    std::vector<const xAOD::IParticle*> ParticleVector;
    xAOD::Jet* theJet=(*ijet);
 
    float eta=HI::TowerBins::getBinCenterEta(HI::TowerBins::findBinEta(theJet->eta()));
    float phi=HI::TowerBins::getBinCenterPhi(HI::TowerBins::findBinPhi(theJet->phi()));
 
    int etabinmin=HI::TowerBins::findBinEta(eta-m_DR);
    int etabinmax=HI::TowerBins::findBinEta(eta+m_DR);
 
    if(etabinmin < 0) etabinmin=0;
    if(static_cast<unsigned int>(etabinmax) > HI::TowerBins::numEtaBins()) etabinmax=HI::TowerBins::numEtaBins();
 
    for(int ieta=etabinmin; ieta<=etabinmax; ieta++)
    {
 
      float ev=HI::TowerBins::getBinCenterEta(ieta);
      float delta_ev2=(ev-eta)*(ev-eta);
      float phimin=phi-std::sqrt( m_DR*m_DR-delta_ev2+1e-4 );
      unsigned int iphi=HI::TowerBins::findBinPhi(phimin);
      float pbc=HI::TowerBins::getBinCenterPhi(iphi);
      float dphi=TVector2::Phi_mpi_pi(phi-pbc);
      float rv2=dphi*dphi+delta_ev2;
 
      if(rv2 > m_DR*m_DR)
      {
    iphi++;
    pbc=HI::TowerBins::getBinCenterPhi(iphi);
    dphi=TVector2::Phi_mpi_pi(phi-pbc);
    rv2=dphi*dphi+delta_ev2;
      }
      while(rv2 < m_DR*m_DR)
      {
    float pv=HI::TowerBins::getBinCenterPhi(iphi);
    unsigned int eta_phi_index=HI::TowerBins::findEtaPhiBin(ev,pv);
    const xAOD::IParticle* ap=(*ppars)[eta_phi_index];
    ParticleVector.push_back( ap );
    //update condition for next iteration in while loop
    iphi++;
    pbc=HI::TowerBins::getBinCenterPhi(iphi);
    dphi=TVector2::Phi_mpi_pi(phi-pbc);
    rv2=dphi*dphi+delta_ev2;
      }
    }
 
    theJet->setAssociatedObjects(m_assocName,ParticleVector);
 
  }
  // return 1;
 
  // msg(MSG::INFO) << std::setw(20) << "ASG_CHECKING ASSOCIATIONS" << endmsg;
  // for (xAOD::JetContainer::iterator ijet=jets.begin(); ijet!=jets.end(); ijet++)
  // {
  //   xAOD::Jet* theJet=(*ijet);
  //   msg(MSG::INFO) << std::setw(20) << "JET"
  //           << std::setw(15) << theJet->e()
  //           << std::setw(15) << theJet->eta()
  //           << std::setw(15) << theJet->phi()
  //           << std::setw(15) << theJet->pt()
  //           << endmsg;
 
  //   std::vector<const xAOD::IParticle*> theParticles=theJet->getAssociatedObjects<xAOD::IParticle>(m_assocName);
  //   unsigned int ip=0;
  //   for(auto pItr=theParticles.begin(); pItr!=theParticles.end(); pItr++, ip++)
  //   {
  //     msg(MSG::INFO) << std::setw(20) << ip
  //             << std::setw(15) << (*pItr)->e()
  //             << std::setw(15) << (*pItr)->eta()
  //             << std::setw(15) << (*pItr)->phi()
  //             << std::setw(15) << (*pItr)->pt()
  //             << endmsg;
  //   }
  // }
  return StatusCode::SUCCESS;
}

modifyJet()

virtual int HIJetClusterIndexAssociationTool::modifyJet ( xAOD::Jet & jet ) const

inlineoverridevirtual

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

Reimplemented from JetModifierBase.

Definition at line 49 of file HIJetClusterIndexAssociationTool.h.

{return 1;};

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_applyFilter

Gaudi::Property< bool > HIJetClusterIndexAssociationTool::m_applyFilter { this, "ApplyFilter", false, "Apply filter boolean" }

private

Definition at line 62 of file HIJetClusterIndexAssociationTool.h.

{ this, "ApplyFilter", false, "Apply filter boolean" };

m_assocName

Gaudi::Property< std::string > HIJetClusterIndexAssociationTool::m_assocName { this, "AssociationName", "", "Name of jet attribute providing link between jets and clusters" }

private

Name of jet attribute providing link between jets and clusters.

Definition at line 57 of file HIJetClusterIndexAssociationTool.h.

{ this, "AssociationName", "", "Name of jet attribute providing link between jets and clusters" };

m_containerKey

SG::ReadHandleKey<xAOD::IParticleContainer> HIJetClusterIndexAssociationTool::m_containerKey { this, "ContainerKey", "", "Name of IParticleContainer w/ particles to associat"}

private

name of IParticleContainer w/ particles to associate

Definition at line 54 of file HIJetClusterIndexAssociationTool.h.

{ this, "ContainerKey", "", "Name of IParticleContainer w/ particles to associat"};

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_DR

Gaudi::Property< float > HIJetClusterIndexAssociationTool::m_DR { this, "DeltaR", 0.8, "Index passing actually needs to be implemented" }

private

Definition at line 61 of file HIJetClusterIndexAssociationTool.h.

{ this, "DeltaR", 0.8, "Index passing actually needs to be implemented" };

m_Emin

Gaudi::Property< float > HIJetClusterIndexAssociationTool::m_Emin { this, "FilterMinE", -999., "Filter minimum Energy" }

private

Definition at line 64 of file HIJetClusterIndexAssociationTool.h.

{ this, "FilterMinE", -999., "Filter minimum Energy" };

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_pTmin

Gaudi::Property< float > HIJetClusterIndexAssociationTool::m_pTmin { this, "FilterMinPt", 0., "Filter minimum Pt" }

private

Definition at line 65 of file HIJetClusterIndexAssociationTool.h.

{ this, "FilterMinPt", 0., "Filter minimum Pt" };

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:

• HIJetClusterIndexAssociationTool.h
• HIJetClusterIndexAssociationTool.cxx