#include <PrimaryVertexRefitter.h>

Inheritance diagram for Analysis::PrimaryVertexRefitter:

Collaboration diagram for Analysis::PrimaryVertexRefitter:

Public Member Functions
	PrimaryVertexRefitter (const std::string &t, const std::string &n, const IInterface *p)
	~PrimaryVertexRefitter ()
StatusCode	initialize ()
xAOD::Vertex *	refitVertex (const xAOD::Vertex vertex, const xAOD::Vertex excludeVertex, bool ReturnCopy=true, int *exitcode=nullptr) const
xAOD::Vertex *	refitVertex (const xAOD::Vertex vertex, const std::vector< const xAOD::TrackParticle > &tps, bool ReturnCopy=true, int *exitcode=nullptr) const
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 ()

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
Gaudi::Property< unsigned int >	m_ntrk_min {this,"MinimumNumberOfTracksInVertex",2}
ToolHandle< Trk::ITrackToVertexIPEstimator >	m_trackToVertexIPEstimator { this, "TrackToVertexIPEstimator", "Trk::TrackToVertexIPEstimator" }
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 26 of file PrimaryVertexRefitter.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

◆ PrimaryVertexRefitter()

Analysis::PrimaryVertexRefitter::PrimaryVertexRefitter	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 31 of file PrimaryVertexRefitter.cxx.

                                                                                                         : 
AthAlgTool(t,n,p)
{
  declareInterface<PrimaryVertexRefitter>(this);
}

◆ ~PrimaryVertexRefitter()

Analysis::PrimaryVertexRefitter::~PrimaryVertexRefitter ( )

Definition at line 37 of file PrimaryVertexRefitter.cxx.

37{ }

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

◆ 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 Analysis::PrimaryVertexRefitter::initialize ( )

Definition at line 21 of file PrimaryVertexRefitter.cxx.

                                             {
 
  CHECK( m_trackToVertexIPEstimator.retrieve() );
 
  ATH_MSG_DEBUG("Initialize 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 & Analysis::PrimaryVertexRefitter::interfaceID ( )

inlinestatic

Definition at line 32 of file PrimaryVertexRefitter.h.

32{ return IID_PrimaryVertexRefitter;};

Analysis::IID_PrimaryVertexRefitter

static const InterfaceID IID_PrimaryVertexRefitter("PrimaryVertexRefitter", 1, 0)

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

◆ refitVertex() [1/2]

xAOD::Vertex * Analysis::PrimaryVertexRefitter::refitVertex	(	const xAOD::Vertex *	vertex,
		const std::vector< const xAOD::TrackParticle * > &	tps,
		bool	ReturnCopy = true,
		int *	exitcode = nullptr ) const

Definition at line 76 of file PrimaryVertexRefitter.cxx.

{
 
  if (vertex == 0) {
    ATH_MSG_DEBUG("Empty original xAOD::Vertex pointer passed: returning 0");
    if(exitcode) *exitcode =-1;
    return 0;
  }
  unsigned int ntrk_pv = vertex->nTrackParticles();
  if (ntrk_pv == 0) {
    ATH_MSG_DEBUG("Input vertex has no associated tracks: returning 0");
    if(exitcode) *exitcode = -2;
    return 0;
  }
  if (ntrk_pv <= m_ntrk_min) {
    ATH_MSG_DEBUG("The number of tracks " << ntrk_pv << " in the original vertex is already <= the allowed minimum number of tracks " << m_ntrk_min << ", returning original vertex");
    if(exitcode) *exitcode = 2;
    return returnCopy ? new xAOD::Vertex(*vertex) : nullptr;
  }
  unsigned int ntrk = tps.size();
  if (ntrk == 0) {
    ATH_MSG_DEBUG("No tracks requested to be removed: returning original vertex");
    if(exitcode) *exitcode = 3;
    return returnCopy ? new xAOD::Vertex(*vertex) : nullptr;
  }
 
  xAOD::Vertex* reducedVertex(0);
  const xAOD::Vertex* tmpVert = vertex;
  std::vector <const xAOD::TrackParticle*>::const_iterator pb = tps.begin();
  std::vector <const xAOD::TrackParticle*>::const_iterator pe = tps.end();
  for (;pb!=pe;++pb) {
    const xAOD::TrackParticle* tp = (*pb);
    reducedVertex = m_trackToVertexIPEstimator->getUnbiasedVertex(tp,tmpVert);
    if (tmpVert != vertex) delete tmpVert;
    if (reducedVertex == 0) {
      ATH_MSG_DEBUG("Refit failed: returning original vertex");
      if(exitcode) *exitcode = -4;
      return returnCopy ? new xAOD::Vertex(*vertex) : nullptr;
    }
    tmpVert = reducedVertex;
    if (tmpVert->nTrackParticles() <= m_ntrk_min-1) {
      ATH_MSG_DEBUG("The number of tracks in the refitted vertex would be less than the allowed minimum number of tracks: " << m_ntrk_min << ", returning original vertex");
      delete reducedVertex;
      if(exitcode) *exitcode = 5;
      return returnCopy ? new xAOD::Vertex(*vertex) : nullptr;
    }
  }
  if(exitcode) *exitcode = 1;
  return reducedVertex;
}

◆ refitVertex() [2/2]

xAOD::Vertex * Analysis::PrimaryVertexRefitter::refitVertex	(	const xAOD::Vertex *	vertex,
		const xAOD::Vertex *	excludeVertex,
		bool	ReturnCopy = true,
		int *	exitcode = nullptr ) const

Definition at line 40 of file PrimaryVertexRefitter.cxx.

{
 
  if (vertex == 0) {
    ATH_MSG_DEBUG("Empty original xAOD::Vertex pointer passed: returning 0");
    if(exitcode) *exitcode = -1;
    return 0;
  }
  unsigned int ntrk_pv = vertex->nTrackParticles();
  if (ntrk_pv == 0) {
    ATH_MSG_DEBUG("Input vertex has no associated tracks: returning 0");
    if(exitcode) *exitcode =-2;
    return 0;
  }
  if (excludeVertex == 0) {
    ATH_MSG_DEBUG("Empty exclude xAOD::Vertex pointer passed: returning original vertex");
    if(exitcode) *exitcode = 10;
    return returnCopy ? new xAOD::Vertex(*vertex) : nullptr;
  }
  std::vector<const xAOD::TrackParticle*> tps; tps.clear();
  unsigned int ntrk = excludeVertex->nTrackParticles();
  if (ntrk == 0) {
    ATH_MSG_DEBUG("Exclude vertex has no associated tracks: returning original vertex");
    if(exitcode) *exitcode = 11;
    return returnCopy ? new xAOD::Vertex(*vertex) : nullptr;
  }
 
  for (unsigned int i = 0; i < ntrk ; ++i) {
    const xAOD::TrackParticle* tp = excludeVertex->trackParticle(i);
    if (tp==0) continue;
    tps.push_back(tp);
  }
  return refitVertex(vertex,tps, returnCopy, exitcode);
}

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

Gaudi::Property<unsigned int> Analysis::PrimaryVertexRefitter::m_ntrk_min {this,"MinimumNumberOfTracksInVertex",2}

private

Definition at line 41 of file PrimaryVertexRefitter.h.

41{this,"MinimumNumberOfTracksInVertex",2};

◆ m_trackToVertexIPEstimator

ToolHandle<Trk::ITrackToVertexIPEstimator> Analysis::PrimaryVertexRefitter::m_trackToVertexIPEstimator { this, "TrackToVertexIPEstimator", "Trk::TrackToVertexIPEstimator" }

private

Definition at line 42 of file PrimaryVertexRefitter.h.

42{ this, "TrackToVertexIPEstimator", "Trk::TrackToVertexIPEstimator" };

◆ 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

◆ PrimaryVertexRefitter()

◆ ~PrimaryVertexRefitter()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ refitVertex() [1/2]

◆ refitVertex() [2/2]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_ntrk_min

◆ m_trackToVertexIPEstimator

◆ m_varHandleArraysDeclared

◆ m_vhka