#include <VertexFinder.h>

Inheritance diagram for VertexFinder:

Collaboration diagram for VertexFinder:

Public Member Functions
	VertexFinder (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
virtual	~VertexFinder ()
	Destructor.
virtual StatusCode	initialize () override
	Tool initializer.
virtual StatusCode	execute (DiTauCandidateData *data, const EventContext &ctx) const override
	Execute - called for each Ditau candidate.
ElementLink< xAOD::VertexContainer >	getPV_TJVA (const xAOD::DiTauJet , const xAOD::VertexContainer , float &maxJVF, const EventContext &ctx) const
virtual StatusCode	eventInitialize (DiTauCandidateData *data)
	Event initializer - called at the beginning of each event.
virtual StatusCode	executeObj (xAOD::DiTauJet &xDiTau, const EventContext &ctx) const
	Execute - called for each Ditau jet.
virtual StatusCode	finalize ()
	Finalizer.
template<class T>
bool	retrieveTool (T &tool)
	Convenience functions to handle storegate objects.
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

Static Public Member Functions
static float	getJetVertexFraction (const xAOD::Vertex , const std::vector< const xAOD::TrackParticle > &, const jet::TrackVertexAssociation *)
static const InterfaceID &	interfaceID ()
	InterfaceID implementation needed for ToolHandle.

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
SG::ReadHandleKey< xAOD::VertexContainer >	m_primVtxContainerName { this, "PrimVtxContainerName", "PrimaryVertices", "" }
SG::ReadHandleKey< jet::TrackVertexAssociation >	m_trackVertexAssocName { this, "TrackVertexAssociation", "JetTrackVtxAssoc_forDiTaus", "" }
Gaudi::Property< std::string >	m_assocTracksName {this, "AssociatedTracks", "GhostTrack"}
Gaudi::Property< bool >	m_useTJVA {this, "UseTJVA", true}
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

Definition at line 15 of file VertexFinder.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

◆ VertexFinder()

VertexFinder::VertexFinder	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor.

Definition at line 9 of file VertexFinder.cxx.

                                          :
  DiTauToolBase(type, name, parent)
{
  declareInterface<DiTauToolBase > (this);
}

◆ ~VertexFinder()

VertexFinder::~VertexFinder ( )

virtualdefault

Destructor.

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ eventInitialize()

StatusCode DiTauToolBase::eventInitialize ( DiTauCandidateData * data )

virtualinherited

Event initializer - called at the beginning of each event.

Definition at line 32 of file DiTauToolBase.cxx.

{
  return StatusCode::SUCCESS;
}

◆ 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

◆ execute()

StatusCode VertexFinder::execute	(	DiTauCandidateData *	data,
		const EventContext &	ctx ) const

overridevirtual

Execute - called for each Ditau candidate.

Reimplemented from DiTauToolBase.

Definition at line 30 of file VertexFinder.cxx.

                                                                {
 
  ATH_MSG_DEBUG("execute VertexFinder...");
 
  xAOD::DiTauJet *pDiTau = data->xAODDiTau;
  
  // get the primary vertex container from StoreGate
  //do it here because of tau trigger
  const xAOD::Vertex* vxPrimary = nullptr;
 
  SG::ReadHandle<xAOD::VertexContainer> vxContainer (m_primVtxContainerName, ctx);
 
  // find default PrimaryVertex
  // see https://twiki.cern.ch/twiki/bin/viewauth/AtlasProtected/VertexReselectionOnAOD
  // and https://svnweb.cern.ch/trac/atlasoff/browser/Tracking/TrkEvent/VxVertex/trunk/VxVertex/PrimaryVertexSelector.h
  for (const auto *const vtx : *vxContainer) {
    // the first and only primary vertex candidate is picked
    if ( vtx->vertexType() ==  xAOD::VxType::PriVtx) {
      vxPrimary = vtx;
      break;
    }
  }
 
  if (vxPrimary == nullptr) {
    ATH_MSG_WARNING("Unable to find primary Vertex in VertexContainer." << 
            " Continue without Tau Vertex Association.");
    return StatusCode::SUCCESS;
  }
        
  // associate vertex to tau
  pDiTau->setVertex(vxContainer.get(), vxPrimary);
       
 
  if(m_useTJVA){
    // try to find new PV with TJVA
    ATH_MSG_DEBUG("TJVA enabled -> try to find new PV for the tau candidate");
 
    float maxJVF = -100.;
    ElementLink<xAOD::VertexContainer> newPrimaryVertexLink = getPV_TJVA(pDiTau, vxContainer.get(), maxJVF, ctx);
    if (newPrimaryVertexLink.isValid()) {
      // set new primary vertex
      // will overwrite default one which was set above
      pDiTau->setVertexLink(newPrimaryVertexLink);
      // save highest JVF value
      pDiTau->setDetail(xAOD::DiTauJetParameters::TauJetVtxFraction,static_cast<float>(maxJVF));
      ATH_MSG_DEBUG("TJVA vertex found and set");
    }
    else {
      ATH_MSG_DEBUG("couldn't find new PV for TJVA");
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ executeObj()

StatusCode DiTauToolBase::executeObj	(	xAOD::DiTauJet &	xDiTau,
		const EventContext &	ctx ) const

virtualinherited

Execute - called for each Ditau jet.

Reimplemented in DiTauExtraVarDecorator, DiTauOnnxDiscriminantTool, and DiTauWPDecorator.

Definition at line 44 of file DiTauToolBase.cxx.

{
  return StatusCode::SUCCESS;
}

◆ 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

◆ finalize()

StatusCode DiTauToolBase::finalize ( )

virtualinherited

Finalizer.

Reimplemented in DiTauOnnxDiscriminantTool.

Definition at line 50 of file DiTauToolBase.cxx.

{
  return StatusCode::SUCCESS;
}

◆ getJetVertexFraction()

float VertexFinder::getJetVertexFraction	(	const xAOD::Vertex *	vertex,
		const std::vector< const xAOD::TrackParticle * > &	tracks,
		const jet::TrackVertexAssociation *	tva )

static

Definition at line 132 of file VertexFinder.cxx.

{
  float sumTrackPV = 0.;
  float sumTrackAll = 0.;
  for (size_t iTrack = 0; iTrack < tracks.size(); ++iTrack)
    {
      const xAOD::TrackParticle* track = tracks.at(iTrack);
      const xAOD::Vertex* ptvtx = tva->associatedVertex(track);
      if (ptvtx != nullptr) {
    if (ptvtx->index() == vertex->index()) sumTrackPV += track->pt();
      }
 
      sumTrackAll += track->pt();
    }
 
  return sumTrackAll!=0. ? sumTrackPV/sumTrackAll : 0.;
}

◆ getPV_TJVA()

ElementLink< xAOD::VertexContainer > VertexFinder::getPV_TJVA	(	const xAOD::DiTauJet *	pDiTau,
		const xAOD::VertexContainer *	vertices,
		float &	maxJVF,
		const EventContext &	ctx ) const

Definition at line 87 of file VertexFinder.cxx.

{
  const xAOD::Jet* pJetSeed = (*pDiTau->jetLink());
 
  // the implementation follows closely the example given in modifyJet(...) in https://svnweb.cern.ch/trac/atlasoff/browser/Reconstruction/Jet/JetMomentTools/trunk/Root/JetVertexFractionTool.cxx#15
 
  // Get the tracks associated to the jet
  std::vector<const xAOD::TrackParticle*> assocTracks;
  if (! pJetSeed->getAssociatedObjects(m_assocTracksName, assocTracks)) {
    ATH_MSG_ERROR("Could not retrieve the AssociatedObjects named \""<< m_assocTracksName <<"\" from jet");
    return {};
  }
 
  // Get the TVA object
  SG::ReadHandle<jet::TrackVertexAssociation> tva (m_trackVertexAssocName, ctx);
 
  // Calculate Jet Vertex Fraction
  std::vector<float> jvf;
  jvf.resize(vertices->size());
  for (size_t iVertex = 0; iVertex < vertices->size(); ++iVertex) {
    jvf.at(iVertex) = getJetVertexFraction(vertices->at(iVertex),assocTracks,tva.get());
  }
    
  // Get the highest JVF vertex and store maxJVF for later use
  // Note: the official JetMomentTools/JetVertexFractionTool doesn't provide any possibility to access the JVF value, but just the vertex.
  maxJVF=-100.;
  size_t maxIndex = 0;
  for (size_t iVertex = 0; iVertex < jvf.size(); ++iVertex) {
    if (jvf.at(iVertex) > maxJVF) {
      maxJVF = jvf.at(iVertex);
      maxIndex = iVertex;
    }
  }
 
  // Set the highest JVF vertex
  ElementLink<xAOD::VertexContainer> vtxlink = ElementLink<xAOD::VertexContainer>(*vertices,vertices->at(maxIndex)->index());
 
  return vtxlink;
}

◆ initialize()

StatusCode VertexFinder::initialize ( )

overridevirtual

Tool initializer.

Reimplemented from DiTauToolBase.

Definition at line 21 of file VertexFinder.cxx.

                                    {
 
  ATH_CHECK( m_primVtxContainerName.initialize() );
  ATH_CHECK( m_trackVertexAssocName.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.

◆ interfaceID()

const InterfaceID & DiTauToolBase::interfaceID ( )

staticinherited

InterfaceID implementation needed for ToolHandle.

Definition at line 9 of file DiTauToolBase.cxx.

                                              {
  return DiTauToolBaseID;
}

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

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

◆ retrieveTool()

template<class T>

bool DiTauToolBase::retrieveTool ( T & tool )

inherited

Convenience functions to handle storegate objects.

Definition at line 59 of file DiTauToolBase.cxx.

                                         {
  if (tool.retrieve().isFailure()) {
    ATH_MSG_FATAL("Failed to retrieve tool " << tool);
    return false;
  } else {
    ATH_MSG_VERBOSE("Retrieved tool " << tool);
  }
  return true;
}

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

Gaudi::Property<std::string> VertexFinder::m_assocTracksName {this, "AssociatedTracks", "GhostTrack"}

private

Definition at line 48 of file VertexFinder.h.

48{this, "AssociatedTracks", "GhostTrack"};

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

SG::ReadHandleKey<xAOD::VertexContainer> VertexFinder::m_primVtxContainerName { this, "PrimVtxContainerName", "PrimaryVertices", "" }

private

Definition at line 43 of file VertexFinder.h.

44{ this, "PrimVtxContainerName", "PrimaryVertices", "" };

◆ m_trackVertexAssocName

SG::ReadHandleKey<jet::TrackVertexAssociation> VertexFinder::m_trackVertexAssocName { this, "TrackVertexAssociation", "JetTrackVtxAssoc_forDiTaus", "" }

private

Definition at line 45 of file VertexFinder.h.

46{ this, "TrackVertexAssociation", "JetTrackVtxAssoc_forDiTaus", "" };

◆ m_useTJVA

Gaudi::Property<bool> VertexFinder::m_useTJVA {this, "UseTJVA", true}

private

Definition at line 49 of file VertexFinder.h.

49{this, "UseTJVA", true};

◆ 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 Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ VertexFinder()

◆ ~VertexFinder()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ eventInitialize()

◆ evtStore()

◆ execute()

◆ executeObj()

◆ extraDeps_update_handler()

◆ finalize()

◆ getJetVertexFraction()

◆ getPV_TJVA()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieveTool()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_assocTracksName

◆ m_detStore

◆ m_evtStore

◆ m_primVtxContainerName

◆ m_trackVertexAssocName

◆ m_useTJVA

◆ m_varHandleArraysDeclared

◆ m_vhka