The vertex mapper transforms vertices from global coordinates into the local coordinate frame of the closest sensitive surface. More...

#include <VertexMapper.h>

Inheritance diagram for Trk::VertexMapper:

Collaboration diagram for Trk::VertexMapper:

Public Member Functions
	VertexMapper (const std::string &, const std::string &, const IInterface *)
	AlgTool like constructor.
virtual	~VertexMapper ()
	Virtual destructor.
StatusCode	initialize ()
	AlgTool initialize method.
StatusCode	finalize ()
	AlgTool finalize method.
MappedVertex	mapToLocal (const Amg::Vector3D &vertex) const
	Record the vertex into the local frame of the closest module.
void	handle (const Incident &inc)
	Handle the incident from the incident service.
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
	DeclareInterfaceID (IVertexMapper, 1, 0)
	Creates the InterfaceID and interfaceID() method.

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
StatusCode	updateTrackingGeometry () const
	< retrieve TrackingGeometry
const TrackingGeometry &	trackingGeometry () const
	retrieve the tracking geometry
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const TrackingGeometry *	m_trackingGeometry
	the tracking geometry owned by the navigator
std::string	m_trackingGeometryName
	Name of the TrackingGeometry as given in Detector Store.
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

The vertex mapper transforms vertices from global coordinates into the local coordinate frame of the closest sensitive surface.

Todo: add option to also map onto non-sensitive layers

Author: Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 41 of file VertexMapper.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

◆ VertexMapper()

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

AlgTool like constructor.

Definition at line 16 of file VertexMapper.cxx.

: AthAlgTool(t,n,p),
  m_trackingGeometry(nullptr),
  m_trackingGeometryName("AtlasTrackingGeometry")
{
    declareInterface<IVertexMapper>(this);
 
    // The TrackingGeometry
    declareProperty("TrackingGeometry"                      , m_trackingGeometryName);
 
 
}

◆ ~VertexMapper()

Trk::VertexMapper::~VertexMapper ( )

virtualdefault

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

◆ DeclareInterfaceID()

Trk::IVertexMapper::DeclareInterfaceID	(	IVertexMapper	,
		1	,
		0	)

inherited

Creates the InterfaceID and interfaceID() method.

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

AlgTool finalize method.

Definition at line 43 of file VertexMapper.cxx.

{
    ATH_MSG_INFO(  "finalize() successful" );
    return StatusCode::SUCCESS;
}

◆ handle()

void Trk::VertexMapper::handle ( const Incident & inc )

Handle the incident from the incident service.

◆ initialize()

StatusCode Trk::VertexMapper::initialize ( )

AlgTool initialize method.

Definition at line 35 of file VertexMapper.cxx.

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

◆ mapToLocal()

Trk::MappedVertex Trk::VertexMapper::mapToLocal ( const Amg::Vector3D & vertex ) const

virtual

Record the vertex into the local frame of the closest module.

Implements Trk::IVertexMapper.

Definition at line 60 of file VertexMapper.cxx.

                                                                           {
 
    // first find the volume where you are in
    const Trk::TrackingVolume* mVolume = trackingGeometry().lowestTrackingVolume(vertex);
    // we have a volume, so go on
    if (mVolume){
        // from the volume, get all the layers
        const Trk::LayerArray* mLayerArray = mVolume->confinedLayers();
        // and check if we have confined layers
        if (mLayerArray){
            // extract all the layers with sensitive surfaces
          std::span<Trk::Layer const * const> mLayerObjects = mLayerArray->arrayObjects();
          std::vector<const Trk::Layer*> mSensitiveLayers;
            // loop over for the extraction - and check if they have a sub surface array
            for (const auto & mLayer : mLayerObjects){
                if (mLayer->surfaceArray()){
                    // remember this layer
                    mSensitiveLayers.push_back(mLayer);
                }
            }
            // now find out the closest - if you have layers to test
            if (!mSensitiveLayers.empty()){
                // prepare the book keepint
                double        mDistance    = 10e10;
                const Layer*  mLayer       = nullptr;
                Amg::Vector3D mPosition(0.,0.,0.);
                Amg::Vector3D mDirection(0.,0.,0.);
                // loop over the test layers
                for (auto& sLayer : mSensitiveLayers) {
                    // find out the optimal association :
                    // - for cylinders we want to radially hit the layer
                    // - for disks we want to move along z
                    mDirection = Amg::Vector3D(
                                   (sLayer->surfaceRepresentation().type() ==
                                    Trk::SurfaceType::Cylinder)
                                     ? Amg::Vector3D(vertex.x(), vertex.y(), 0.)
                                     : Amg::Vector3D(0., 0., 1.))
                                   .unit();
                    // now intersect the layer
                    Intersection sIntersection = sLayer->surfaceRepresentation().straightLineIntersection(vertex,mDirection,false,false);
                    // check if valid
                    if (sIntersection.valid){
                        // record the new closest distance and remember the layer
                        double currentDistance = fabs(sIntersection.pathLength);
                        if ( currentDistance < mDistance ){
                            // assign the new closest distance
                            mDistance = currentDistance;
                            mLayer    = sLayer;
                            mPosition = sIntersection.position;
                        }
                    }
                } // loop over layers done
 
                // continue if you have found a good layer
                if (mLayer) {
                    // let's find the assoicated surfaces using the overlap descriptor
                    std::vector<SurfaceIntersection> testSurfaces;
                    // get the main target surface
                    const Surface* mSurface = mLayer->subSurface(mPosition);
                    // we have more than one test surface
                    if (mSurface && mLayer->overlapDescriptor()){
                        // get the reachable surfaces, the target surface will be added
                        mLayer->overlapDescriptor()->reachableSurfaces(testSurfaces, *mSurface, vertex, mDirection);
                        // let's loop over the provided surfaces, intersect them and take the closest
                        mDistance = 10e10;
                        for (auto& tSurface : testSurfaces){
                             // intersect
                             Intersection tsfInter = tSurface.object->straightLineIntersection(vertex,mDirection,false,false);
                             // check if the intersection is valid and the maxPathLength has not been exceeded
                             if (tsfInter.valid && tsfInter.pathLength < mDistance ){
                                 // change the mDistance and remember the surface
                                 mDistance = tsfInter.pathLength;
                                 mSurface  = tSurface.object;
                             }
                        }
                    }
                    // now collect all the other surfaces from the compatible surface call
                    if (mSurface){
                        // we have a surface, do the final transformation into the surface frame
                        Amg::Vector3D mLocPosition = mSurface->transform().inverse()*vertex;
                        // everything is set -> return
                        return Trk::MappedVertex(mLocPosition,*mSurface,*mLayer,*mVolume);
                    }
                }
            }
        }
    }
    // did not succeed return an invalid solution
    return {};
}

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

◆ trackingGeometry()

const Trk::TrackingGeometry & Trk::VertexMapper::trackingGeometry ( ) const

inlineprivate

retrieve the tracking geometry

Definition at line 79 of file VertexMapper.h.

                                                                           {
        if (!m_trackingGeometry && updateTrackingGeometry().isFailure()){
            ATH_MSG_FATAL("Could not load TrackingGeometry with name '" << m_trackingGeometryName << "'. Aborting." );
            throw GaudiException("VertexMapper", "Problem with TrackingGeometry loading.", StatusCode::FAILURE);
        }
        return (*m_trackingGeometry);
    }

◆ updateTrackingGeometry()

StatusCode Trk::VertexMapper::updateTrackingGeometry ( ) const

private

< retrieve TrackingGeometry

update the tracking geometry return and retrieve

Definition at line 50 of file VertexMapper.cxx.

                                                         {
    // retrieve the TrackingGeometry from the detector store
    if (detStore()->retrieve(m_trackingGeometry, m_trackingGeometryName).isFailure()){
        ATH_MSG_ERROR("Could not retrieve the tracking geometry. Bailing out.");
        return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
}

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

const TrackingGeometry* Trk::VertexMapper::m_trackingGeometry

mutableprivate

the tracking geometry owned by the navigator

Definition at line 74 of file VertexMapper.h.

◆ m_trackingGeometryName

std::string Trk::VertexMapper::m_trackingGeometryName

private

Name of the TrackingGeometry as given in Detector Store.

Definition at line 75 of file VertexMapper.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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ VertexMapper()

◆ ~VertexMapper()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ mapToLocal()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ trackingGeometry()

◆ updateTrackingGeometry()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_trackingGeometry

◆ m_trackingGeometryName

◆ m_varHandleArraysDeclared

◆ m_vhka