#include <VertexMergingTool.h>

Inheritance diagram for Trk::VertexMergingTool:

Collaboration diagram for Trk::VertexMergingTool:

Public Member Functions
StatusCode	initialize () override
	VertexMergingTool (const std::string &t, const std::string &n, const IInterface *p)
	constructor
virtual	~VertexMergingTool ()
	destructor
virtual std::pair< xAOD::VertexContainer , xAOD::VertexAuxContainer >	mergeVertexContainer (const xAOD::VertexContainer &MyVxCont) const override
	Merging.
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 const InterfaceID &	interfaceID ()
	AlgTool interface methods.

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
bool	checkCompatibility (const xAOD::Vertex vx1, const xAOD::Vertex vx2) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadCondHandleKey< InDet::BeamSpotData >	m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" }
ToolHandle< Trk::IVertexFitter >	m_iVertexFitter
bool	m_useBeamConstraint
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: Maria Ilaria Besana, June 2014

Changes:

David Shope david.nosp@m..ric.nosp@m.hard..nosp@m.shop.nosp@m.e@cer.nosp@m.n.ch (2016-04-26)

EDM Migration to xAOD - remove method using VxCandidate

Definition at line 41 of file Tracking/TrkVertexFitter/TrkVertexTools/TrkVertexTools/VertexMergingTool.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

◆ VertexMergingTool()

Trk::VertexMergingTool::VertexMergingTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

constructor

Definition at line 13 of file Tracking/TrkVertexFitter/TrkVertexTools/src/VertexMergingTool.cxx.

          : AthAlgTool ( t,n,p ),
        m_iVertexFitter("Trk::AdaptiveVertexFitter"),
            m_useBeamConstraint(false)
  {
    declareInterface<IVertexMergingTool> ( this );
    declareProperty("VertexFitterTool", m_iVertexFitter);
    declareProperty("useBeamConstraint",m_useBeamConstraint);
  }

◆ ~VertexMergingTool()

Trk::VertexMergingTool::~VertexMergingTool ( )

virtualdefault

destructor

Member Function Documentation

◆ checkCompatibility()

bool Trk::VertexMergingTool::checkCompatibility	(	const xAOD::Vertex *	vx1,
		const xAOD::Vertex *	vx2 ) const

private

Definition at line 127 of file Tracking/TrkVertexFitter/TrkVertexTools/src/VertexMergingTool.cxx.

                                                                                                   {
 
    double z1 = vx1->z();
    double z2 = vx2->z();
 
    double err2_z1 = vx1->covariancePosition()(Trk::z, Trk::z);
    double err2_z2 = vx2->covariancePosition()(Trk::z, Trk::z);
 
    double sigmaZ = (fabs(z1-z2))/(sqrt(err2_z1+err2_z2));
 
    ATH_MSG_DEBUG("z1 = " << z1 << ", z2 = " << z2 << ", error = " << sqrt( err2_z1+err2_z2 ) );
 
    return sigmaZ<3;
  }

◆ 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

◆ 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

◆ initialize()

StatusCode Trk::VertexMergingTool::initialize ( )

override

Definition at line 27 of file Tracking/TrkVertexFitter/TrkVertexTools/src/VertexMergingTool.cxx.

  {
    
    if ( m_iVertexFitter.retrieve().isFailure() ) {
      msg(MSG::ERROR) << "Failed to retrieve tool " << m_iVertexFitter << endmsg;
      return StatusCode::FAILURE;
    } 
    
     ATH_CHECK(m_beamSpotKey.initialize());
    
     ATH_MSG_DEBUG("Re-merging tool initialization successful");
     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 & Trk::IVertexMergingTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 49 of file Tracking/TrkVertexFitter/TrkVertexFitterInterfaces/TrkVertexFitterInterfaces/IVertexMergingTool.h.

49{ return IID_IVertexMergingTool; };

Trk::IID_IVertexMergingTool

static const InterfaceID IID_IVertexMergingTool("IVertexMergingTool", 1, 0)

◆ mergeVertexContainer()

std::pair< xAOD::VertexContainer *, xAOD::VertexAuxContainer * > Trk::VertexMergingTool::mergeVertexContainer ( const xAOD::VertexContainer & MyVxCont ) const

overridevirtual

Merging.

EndOfInitialize.

Implements Trk::IVertexMergingTool.

Definition at line 42 of file Tracking/TrkVertexFitter/TrkVertexTools/src/VertexMergingTool.cxx.

  {
 
    ATH_MSG_DEBUG("Run vertex remerging");
 
    //if beamspot constraint was requested, get it now
    xAOD::Vertex theconstraint;
    if (m_useBeamConstraint) {
      SG::ReadCondHandle<InDet::BeamSpotData> beamSpotHandle { m_beamSpotKey };
      if(not beamSpotHandle.isValid()) ATH_MSG_ERROR("Cannot Retrieve " << m_beamSpotKey.key() );
      theconstraint = xAOD::Vertex(); // Default constructor creates a private store
      theconstraint.setPosition( beamSpotHandle->beamVtx().position() );
      theconstraint.setCovariancePosition( beamSpotHandle->beamVtx().covariancePosition() );
      theconstraint.setFitQuality( beamSpotHandle->beamVtx().fitQuality().chiSquared(), beamSpotHandle->beamVtx().fitQuality().doubleNumberDoF() );
    }
 
    //new output containers to be filled
    xAOD::VertexContainer *NewContainer = new xAOD::VertexContainer();
    xAOD::VertexAuxContainer* auxNewContainer = new xAOD::VertexAuxContainer();
    NewContainer->setStore( auxNewContainer );
    
    //add remerged flags to all
    std::vector<bool> remerged( MyVxCont.size(), false );    
 
    xAOD::VertexContainer::const_iterator beginIter = MyVxCont.begin();
    xAOD::VertexContainer::const_iterator endIter = MyVxCont.end();
    unsigned int Ni=0;
    for(xAOD::VertexContainer::const_iterator i = beginIter; i!=endIter; ++i) {
      xAOD::Vertex * vx = new xAOD::Vertex( **i );
 
      if( vx->vertexType() == xAOD::VxType::NoVtx ) { //dummy vertex -- just add a copy
        NewContainer->push_back( vx );
      } else if( !remerged[Ni] ) { //skip vertices already merged into another
 
        unsigned int Nj = Ni+1;
        for(xAOD::VertexContainer::const_iterator j=i+1; j!=endIter; ++j ) {
          const xAOD::Vertex * mergeCand = (*j);
          if( mergeCand->vertexType() != xAOD::VxType::NoVtx && !remerged[Nj] ) {
            //not dummy and not already merged into earlier vertex, so consider it as merging candidate
            if( checkCompatibility( vx, mergeCand ) ) {
 
              //get all the track particles to fit
              std::vector<const xAOD::TrackParticle*> combinedTracks;
              for(size_t t=0; t<vx->nTrackParticles(); ++t) {
                combinedTracks.push_back( vx->trackParticle(t) );
              }
              for(size_t t=0; t<mergeCand->nTrackParticles(); ++t) {
                combinedTracks.push_back( mergeCand->trackParticle(t) );
              }
 
              //call the fitter -> using xAOD::TrackParticle it should set the track links for us
              xAOD::Vertex * mergedVtx = nullptr;
              if(m_useBeamConstraint) {
                mergedVtx = m_iVertexFitter->fit( combinedTracks, theconstraint );
              } else { 
                //no interface for no constraint and no starting point, so use starting point of original vertex
                const Amg::Vector3D& start( vx->position() );
                mergedVtx = m_iVertexFitter->fit( combinedTracks, start );
              }
 
              //CHECK MERGING IS GOOD? 
              // flag as remerged
              ATH_MSG_DEBUG("Merge vertices " << Ni << " and " << Nj);
              remerged[Nj] = true;
              remerged[Ni] = true;
              //delete copy of first vertex and then overwrite with merged vertex
              delete vx;
              vx = mergedVtx;
            }            
          }
 
          Nj++;
        } //loop over j
 
        //whether we merged or not, can add vx to the container
        NewContainer->push_back( vx );
 
      } //end if vtx[Ni] is not remerged
      Ni++;
    }
 
    return std::make_pair( NewContainer, auxNewContainer );
 
  }

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

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

SG::ReadCondHandleKey<InDet::BeamSpotData> Trk::VertexMergingTool::m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" }

private

Definition at line 64 of file Tracking/TrkVertexFitter/TrkVertexTools/TrkVertexTools/VertexMergingTool.h.

64{ this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" };

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

ToolHandle< Trk::IVertexFitter > Trk::VertexMergingTool::m_iVertexFitter

private

Definition at line 65 of file Tracking/TrkVertexFitter/TrkVertexTools/TrkVertexTools/VertexMergingTool.h.

◆ m_useBeamConstraint

bool Trk::VertexMergingTool::m_useBeamConstraint

private

Definition at line 66 of file Tracking/TrkVertexFitter/TrkVertexTools/TrkVertexTools/VertexMergingTool.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:

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

◆ VertexMergingTool()

◆ ~VertexMergingTool()

Member Function Documentation

◆ checkCompatibility()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ mergeVertexContainer()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beamSpotKey

◆ m_detStore

◆ m_evtStore

◆ m_iVertexFitter

◆ m_useBeamConstraint

◆ m_varHandleArraysDeclared

◆ m_vhka