#include <VertexCollectionSortingTool.h>

Inheritance diagram for Trk::VertexCollectionSortingTool:

Collaboration diagram for Trk::VertexCollectionSortingTool:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
	EndOfInitialize.
	VertexCollectionSortingTool (const std::string &t, const std::string &n, const IInterface *p)
	constructor
virtual	~VertexCollectionSortingTool ()=default
	destructor
virtual std::pair< xAOD::VertexContainer , xAOD::VertexAuxContainer >	sortVertexContainer (const xAOD::VertexContainer &MyVxCont) const override
	Sort.
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< Trk::IVertexWeightCalculator >	m_iVertexWeightCalculator
Gaudi::Property< std::string >	m_decorationName
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: Johanna Bronner, April 2009

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 37 of file VertexCollectionSortingTool.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

◆ VertexCollectionSortingTool()

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

constructor

Definition at line 27 of file VertexCollectionSortingTool.cxx.

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

◆ ~VertexCollectionSortingTool()

virtual Trk::VertexCollectionSortingTool::~VertexCollectionSortingTool ( )

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

◆ 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

◆ finalize()

StatusCode Trk::VertexCollectionSortingTool::finalize ( )

overridevirtual

EndOfInitialize.

Definition at line 49 of file VertexCollectionSortingTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::VertexCollectionSortingTool::initialize ( )

overridevirtual

Definition at line 37 of file VertexCollectionSortingTool.cxx.

{
  if (m_iVertexWeightCalculator.retrieve().isFailure()) {
    ATH_MSG_FATAL("Failed to retrieve tool " << m_iVertexWeightCalculator);
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("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::IVertexCollectionSortingTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 51 of file IVertexCollectionSortingTool.h.

51{ return IID_IVertexCollectionSortingTool; };

Trk::IID_IVertexCollectionSortingTool

static const InterfaceID IID_IVertexCollectionSortingTool("IVertexCollectionSortingTool", 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.

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

◆ sortVertexContainer()

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

overridevirtual

Sort.

Implements Trk::IVertexCollectionSortingTool.

Definition at line 55 of file VertexCollectionSortingTool.cxx.

{
  std::vector<Vertex_pair> MyVertex_pairs;
 
  xAOD::VertexContainer* NewContainer = new xAOD::VertexContainer();
  xAOD::VertexAuxContainer* auxNewContainer = new xAOD::VertexAuxContainer();
  NewContainer->setStore(auxNewContainer);
  SG::AuxElement::Accessor<float> sigWeightDec(m_decorationName);
 
  if(MyVxCont.size()<=1){
    xAOD::Vertex* dummyVxCandidate = new xAOD::Vertex();
    NewContainer->push_back(dummyVxCandidate);
    if(MyVxCont.size()==1){
      const xAOD::Vertex* existVtx = MyVxCont.back();
      dummyVxCandidate->setPosition(existVtx->position());
      dummyVxCandidate->setCovariancePosition(existVtx->covariancePosition());
    }else{
      dummyVxCandidate->setPosition(Amg::Vector3D(0.,0.,0.));
      AmgSymMatrix(3) tmpCovar; tmpCovar.setIdentity();
      dummyVxCandidate->setCovariancePosition(tmpCovar);
    }
    dummyVxCandidate->setVertexType(xAOD::VxType::NoVtx);
    sigWeightDec(*dummyVxCandidate) = 0.;
    return std::make_pair(NewContainer, auxNewContainer);
  }
 
  xAOD::VertexContainer::const_iterator beginIter = MyVxCont.begin();
  xAOD::VertexContainer::const_iterator endIter = MyVxCont.end();
 
  for (xAOD::VertexContainer::const_iterator i = beginIter; i != endIter; ++i) {
    // do not weight dummy!!! (do not delete it either! it is deleted when the
    // original MyVxContainer is deleted in InDetPriVxFinder.cxx)
    if ((*i)->vertexType() != xAOD::VxType::NoVtx) {
      double Weight =
        m_iVertexWeightCalculator->estimateSignalCompatibility(**i);
      MyVertex_pairs.emplace_back(Weight, (*i));
      ATH_MSG_DEBUG("Weight before sorting: " << Weight);
    }
  }
 
  if (!MyVertex_pairs.empty()) {
    std::sort(MyVertex_pairs.begin(), MyVertex_pairs.end());
  }
 
  unsigned int vtxCount(1);
  for (auto MyVertex_pair : MyVertex_pairs) {
    ATH_MSG_DEBUG("Weight after sorting: " << MyVertex_pair.first);
    xAOD::Vertex* vxCand = new xAOD::Vertex(
      *(MyVertex_pair.second)); // use copy-constructor, creates a private store
    NewContainer->push_back(
      vxCand); // private store is now copied to the container store
    if (vtxCount == 1) {
      vxCand->setVertexType(xAOD::VxType::PriVtx);
    } else {
      vxCand->setVertexType(xAOD::VxType::PileUp);
    }
    sigWeightDec(*vxCand) = MyVertex_pair.first;
    vtxCount++;
  }
 
  // add dummy at position of first vertex
  xAOD::Vertex* primaryVtx = NewContainer->front();
  xAOD::Vertex* dummyVxCandidate = new xAOD::Vertex();
  NewContainer->push_back(dummyVxCandidate);
  dummyVxCandidate->setPosition(primaryVtx->position());
  dummyVxCandidate->setCovariancePosition(primaryVtx->covariancePosition());
  dummyVxCandidate->setVertexType(xAOD::VxType::NoVtx);
  sigWeightDec(*dummyVxCandidate) = 0.;
 
  return std::make_pair(NewContainer, auxNewContainer);
}

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

Gaudi::Property<std::string> Trk::VertexCollectionSortingTool::m_decorationName

private

Initial value:

{
    this,
    "decorationName",
    "sumPt2",
    "Name to use for the decoration"
  }

Definition at line 64 of file VertexCollectionSortingTool.h.

                                           {
    this,
    "decorationName",
    "sumPt2",
    "Name to use for the 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_iVertexWeightCalculator

ToolHandle<Trk::IVertexWeightCalculator> Trk::VertexCollectionSortingTool::m_iVertexWeightCalculator

private

Initial value:

{
    this,
    "VertexWeightCalculator",
    "Trk::IVertexWeightCalculator"
  }

Definition at line 59 of file VertexCollectionSortingTool.h.

                                                                  {
    this,
    "VertexWeightCalculator",
    "Trk::IVertexWeightCalculator"
  };

◆ 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

◆ VertexCollectionSortingTool()

◆ ~VertexCollectionSortingTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sortVertexContainer()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decorationName

◆ m_detStore

◆ m_evtStore

◆ m_iVertexWeightCalculator

◆ m_varHandleArraysDeclared

◆ m_vhka