#include <TruthVertexSelectionTool.h>

Inheritance diagram for Trk::TruthVertexSelectionTool:

Collaboration diagram for Trk::TruthVertexSelectionTool:

Public Member Functions
StatusCode	initialize ()
StatusCode	finalize ()
	EndOfInitialize.
	TruthVertexSelectionTool (const std::string &t, const std::string &n, const IInterface *p)
	constructor
virtual	~TruthVertexSelectionTool ()
	destructor
virtual unsigned int	findVertexInContainer (const xAOD::VertexContainer *) const
	Selection method returning the position of selected the PV in the container.
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
SG::ReadHandleKey< McEventCollection >	m_mcEventCollectionKey { this, "mcContainerName", "GEN_AOD", "key to retrieve MC truth" }
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: Kirill Prokofiev, March 2012 A test class, meant to be an example of correct implementation for the veretx selector. Selects the real -= truth associated =- vertex as primary and thus corrects the reconstructuon. So far, the closet vertex to the truth position is selected as the best one.

Changes:

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

EDM Migration to xAOD - replace VxContainer with xAOD::VertexContainer

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

◆ TruthVertexSelectionTool()

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

constructor

Definition at line 15 of file TruthVertexSelectionTool.cxx.

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

◆ ~TruthVertexSelectionTool()

Trk::TruthVertexSelectionTool::~TruthVertexSelectionTool ( )

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::TruthVertexSelectionTool::finalize ( )

EndOfInitialize.

Definition at line 33 of file TruthVertexSelectionTool.cxx.

  {
     return StatusCode::SUCCESS;
  }

◆ findVertexInContainer()

unsigned int Trk::TruthVertexSelectionTool::findVertexInContainer ( const xAOD::VertexContainer * ) const

virtual

Selection method returning the position of selected the PV in the container.

Implements Trk::IVertexSelectionTool.

Definition at line 38 of file TruthVertexSelectionTool.cxx.

  {
    SG::ReadHandle<McEventCollection> mcCollptr( m_mcEventCollectionKey );
 
    if ( !mcCollptr.isValid() ) 
    {
      ATH_MSG_WARNING( "Could not retrieve McEventCollection" );
      return 0;
    }    
    ATH_MSG_DEBUG( "HepMC info loaded" );
  
// taking the first event in the truth collection as the signal one
    McEventCollection::const_iterator itr = mcCollptr->begin();   
  
//and the first vertex in its respective collection
    const HepMC::GenEvent *evt = (*itr);
 
//protection   
    if(!evt) return 0;
   
#ifdef HEPMC3
    auto vitr = evt->vertices().begin();
#else
    HepMC::GenEvent::vertex_const_iterator vitr = evt->vertices_begin();
#endif
//another one  
    if(!*vitr) return 0;
  
//and its position
    HepMC::FourVector vxGenPos =  (*vitr)->position(); 
 
//selecting the container vertex closest in Z to the truth one
    unsigned int res_pos = 0;
  
    if(vertexContainer)
    {
      unsigned int cont_size = vertexContainer->size(); 
      if(cont_size>1)
      {
        float z_sim = vxGenPos.z();
        
        float significance = fabs(z_sim - (*vertexContainer)[0]->position().z());//start with the pv value
        for(unsigned int i = 1; i < cont_size; ++i)
        {
          const xAOD::Vertex * vrt = (*vertexContainer)[i];
          float loc_significance =  fabs(z_sim - vrt->position().z())/Amg::error(vrt->covariancePosition(), Trk::z);
          if(loc_significance < significance)
          {
             significance = loc_significance;
             res_pos = i; 
          }//end of comparison
        } //end of the vertex container loop
   
    }//end of the container size check
   }//end of container check
//nothing happened, return the default primary vertex position  
   return res_pos;
  }

◆ initialize()

StatusCode Trk::TruthVertexSelectionTool::initialize ( )

Definition at line 25 of file TruthVertexSelectionTool.cxx.

  {
    ATH_CHECK( m_mcEventCollectionKey.initialize() );
    msg(MSG::INFO) << "Initialization successful" << endmsg;
     
    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::IVertexSelectionTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 46 of file Tracking/TrkVertexFitter/TrkVertexFitterInterfaces/TrkVertexFitterInterfaces/IVertexSelectionTool.h.

46{ return IID_IVertexSelectionTool; };

Trk::IID_IVertexSelectionTool

static const InterfaceID IID_IVertexSelectionTool("IVertexSelectionTool", 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();
  }

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

SG::ReadHandleKey<McEventCollection> Trk::TruthVertexSelectionTool::m_mcEventCollectionKey { this, "mcContainerName", "GEN_AOD", "key to retrieve MC truth" }

private

Definition at line 59 of file TruthVertexSelectionTool.h.

59{ this, "mcContainerName", "GEN_AOD", "key to retrieve MC truth" };

◆ 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

◆ TruthVertexSelectionTool()

◆ ~TruthVertexSelectionTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ findVertexInContainer()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_mcEventCollectionKey

◆ m_varHandleArraysDeclared

◆ m_vhka