ATLAS Offline Software
Loading...
Searching...
No Matches
Trk::ExtrapolationEngine Class Reference

Master extrapolation engine for extrapolation through the TrackingGeometry, it delegates the extrapolation to optimised engines, handing over the ExtrapolationCell as internal cache. More...

#include <ExtrapolationEngine.h>

Inheritance diagram for Trk::ExtrapolationEngine:
Collaboration diagram for Trk::ExtrapolationEngine:

Public Member Functions

 ExtrapolationEngine (const std::string &, const std::string &, const IInterface *)
 Constructor.
 ~ExtrapolationEngine ()
 Destructor.
StatusCode initialize ()
 AlgTool initialize method.
StatusCode finalize ()
 AlgTool finalize method.
virtual ExtrapolationCode extrapolate (ExCellCharged &ecCharged, const Surface *sf=0, const BoundaryCheck &bcheck=true) const
 charged extrapolation - public interface
virtual ExtrapolationCode extrapolate (ExCellNeutral &ecNeutral, const Surface *sf=0, const BoundaryCheck &bcheck=true) const
 neutral extrapolation - public interface
GeometryType geometryType () const
 define for which GeometrySignature this extrapolator is valid - this is GLOBAL
virtual StatusCode sysInitialize () override
 Perform system initialization for the component.
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 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.

Protected Attributes

std::string m_sopPrefix
 < SCREEN output formatting (SOP) - unify amongst extrapolation engines
std::string m_sopPostfix
 prefix for screen output

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t

Private Member Functions

template<class T>
ExtrapolationCode extrapolateT (ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum, const BoundaryCheck &bcheck=true) const
 main loop extrapolation method
template<class T>
ExtrapolationCode initNavigation (ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum) const
 initialization method
const TrackingGeometrytrackingGeometry () const
void throwFailedToGetTrackingGeomtry () const
const TrackingGeometryretrieveTrackingGeometry (const EventContext &ctx) const
StatusCode isConfigured ()
 Check if component is configured in JobOptionsSvc.
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

SG::ReadCondHandleKey< TrackingGeometrym_trackingGeometryReadKey {this, "TrackingGeometryReadKey", "", "Key of the TrackingGeometry conditions data."}
 the tool handle array for static / dense / detached
ToolHandleArray< IExtrapolationEnginem_extrapolationEngines { this, "ExtrapolationEngines", {} }
ToolHandle< IPropagationEnginem_propagationEngine {this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"}
 the used propagation engine for navigation initialization
ToolHandle< INavigationEnginem_navigationEngine {this, "NavigationEngine", "Trk::StaticNavigationEngine/AtlasStaticNavigation"}
 access to tracking geometry (unique?)
std::vector< const IExtrapolationEngine * > m_eeAccessor
 the extrapolation engines for
BooleanProperty m_forceSearchInit {this, "ForceSearchAtInit", false}
StringProperty m_sopPrefix_prop {this, "OutputPrefix", ""}
StringProperty m_sopPostfix_prop {this, "OutputPostfix", ""}
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

Friends

class NavigationInitTest

Detailed Description

Master extrapolation engine for extrapolation through the TrackingGeometry, it delegates the extrapolation to optimised engines, handing over the ExtrapolationCell as internal cache.

There are identical interfaces for charged and neutral track parameters. Providing a destination surface is optional, if no destination surface is given the extrapolation process can be stopped by other directives, e.g. stopping at a certain path limit, material limit or with a change of detector signature.

Author
Andreas.Salzburger -at- cern.ch

Definition at line 49 of file ExtrapolationEngine.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

◆ ExtrapolationEngine()

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

Constructor.

Definition at line 16 of file ExtrapolationEngine.cxx.

17: AthCheckedComponent<AthAlgTool>(t,n,p)
18{
19 declareInterface<Trk::IExtrapolationEngine>(this);
20}

◆ ~ExtrapolationEngine()

Trk::ExtrapolationEngine::~ExtrapolationEngine ( )
default

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.

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

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

◆ 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

◆ extrapolate() [1/2]

Trk::ExtrapolationCode Trk::ExtrapolationEngine::extrapolate ( ExCellCharged & ecCharged,
const Surface * sf = 0,
const BoundaryCheck & bcheck = true ) const
virtual

charged extrapolation - public interface

charged extrapolation

Implements Trk::IExtrapolationEngine.

Definition at line 74 of file ExtrapolationEngine.cxx.

77{ return extrapolateT<TrackParameters>(ecCharged,sf,ecCharged.propDirection,bcheck); }
ExtrapolationCode extrapolateT(ExtrapolationCell< T > &eCell, const Surface *sf=0, PropDirection dir=alongMomentum, const BoundaryCheck &bcheck=true) const
main loop extrapolation method

◆ extrapolate() [2/2]

Trk::ExtrapolationCode Trk::ExtrapolationEngine::extrapolate ( ExCellNeutral & ecNeutral,
const Surface * sf = 0,
const BoundaryCheck & bcheck = true ) const
virtual

neutral extrapolation - public interface

neutral extrapolation

Implements Trk::IExtrapolationEngine.

Definition at line 81 of file ExtrapolationEngine.cxx.

84{ return extrapolateT<NeutralParameters>(ecNeutral,sf,ecNeutral.propDirection,bcheck); }

◆ extrapolateT()

template<class T>
ExtrapolationCode Trk::ExtrapolationEngine::extrapolateT ( ExtrapolationCell< T > & eCell,
const Surface * sf = 0,
PropDirection dir = alongMomentum,
const BoundaryCheck & bcheck = true ) const
private

main loop extrapolation method

◆ finalize()

StatusCode Trk::ExtrapolationEngine::finalize ( )

AlgTool finalize method.

Definition at line 66 of file ExtrapolationEngine.cxx.

67{
68 EX_MSG_DEBUG( "", "finalize", "", "successful" );
69 return StatusCode::SUCCESS;
70}
#define EX_MSG_DEBUG(navstep, step, idx, x)

◆ geometryType()

GeometryType Trk::ExtrapolationEngine::geometryType ( ) const
inlinevirtual

define for which GeometrySignature this extrapolator is valid - this is GLOBAL

Implements Trk::IExtrapolationEngine.

Definition at line 126 of file ExtrapolationEngine.h.

127 { return Trk::Master; }

◆ initialize()

StatusCode Trk::ExtrapolationEngine::initialize ( )

AlgTool initialize method.

Definition at line 28 of file ExtrapolationEngine.cxx.

29{
30 EX_MSG_DEBUG( "", "initialize", "", "starting initialize()" );
31
34
35 // get the TrackingGeometrySvc
37
38 // retrieve the ExtrapolationEngines
39 if (m_extrapolationEngines.retrieve().isFailure()){
40
41 } else {
42 EX_MSG_DEBUG( "", "initialize", "", "Successfully retrieved " << m_extrapolationEngines.size() << " ExtrapolationEngines. Ordering them now." );
43 m_eeAccessor = std::vector<const Trk::IExtrapolationEngine*>(int(Trk::NumberOfGeometryTypes), (const Trk::IExtrapolationEngine*)nullptr);
44 for (auto& ee : m_extrapolationEngines){
45 EX_MSG_DEBUG( "", "initialize", "", "Registering " << ee->name() << " - for GeometryType : " << ee->geometryType() );
46 m_eeAccessor[ee->geometryType()] = (&*ee);
47 }
48 }
49
50 if (m_propagationEngine.retrieve().isFailure()){
51 EX_MSG_FATAL("", "initialize", "", "failed to retrieve propagation engine '"<< m_propagationEngine << "'. Aborting." );
52 return StatusCode::FAILURE;
53 } else
54 EX_MSG_DEBUG("", "initialize", "", "successfully propagation engine '" << m_propagationEngine << "'." );
55
56 if (m_navigationEngine.retrieve().isFailure()){
57 EX_MSG_FATAL("", "initialize", "", "failed to retrieve navigation engine '"<< m_navigationEngine << "'. Aborting." );
58 return StatusCode::FAILURE;
59 } else
60 EX_MSG_DEBUG("", "initialize", "", "successfully retrieved '" << m_navigationEngine << "'." );
61
62 return StatusCode::SUCCESS;
63}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define EX_MSG_FATAL(navstep, step, idx, x)
ToolHandle< IPropagationEngine > m_propagationEngine
the used propagation engine for navigation initialization
SG::ReadCondHandleKey< TrackingGeometry > m_trackingGeometryReadKey
the tool handle array for static / dense / detached
ToolHandle< INavigationEngine > m_navigationEngine
access to tracking geometry (unique?)
ToolHandleArray< IExtrapolationEngine > m_extrapolationEngines
std::vector< const IExtrapolationEngine * > m_eeAccessor
the extrapolation engines for
std::string m_sopPrefix
< SCREEN output formatting (SOP) - unify amongst extrapolation engines
std::string m_sopPostfix
prefix for screen output
@ NumberOfGeometryTypes

◆ initNavigation()

template<class T>
ExtrapolationCode Trk::ExtrapolationEngine::initNavigation ( ExtrapolationCell< T > & eCell,
const Surface * sf = 0,
PropDirection dir = alongMomentum ) const
private

initialization method

return and retrieve

◆ 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::IExtrapolationEngine::interfaceID ( )
inlinestaticinherited

AlgTool interface methods.

Definition at line 43 of file IExtrapolationEngine.h.

static const InterfaceID IID_IExtrapolationEngine("IExtrapolationEngine", 1, 0)

◆ isConfigured()

StatusCode AthCheckedComponent< AthAlgTool >::isConfigured ( )
privateinherited

Check if component is configured in JobOptionsSvc.

Checks if at least one property of the component is configured in the JobOptionsSvc. Can be used to detect if a component is missing its python configuration.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

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

381 {
382 h.renounce();
384 }
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)

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

364 {
366 }

◆ retrieveTrackingGeometry()

const TrackingGeometry * Trk::ExtrapolationEngine::retrieveTrackingGeometry ( const EventContext & ctx) const
inlineprivate

Definition at line 99 of file ExtrapolationEngine.h.

99 {
100 SG::ReadCondHandle<TrackingGeometry> handle(m_trackingGeometryReadKey,ctx);
101 if (!handle.isValid()) {
102 EX_MSG_FATAL("", "updateGeo", "", "Could not load TrackingGeometry with name '" << m_trackingGeometryReadKey.key() << "'. Aborting." );
104 }
105 return handle.cptr();
106 }

◆ sysInitialize()

virtual StatusCode AthCheckedComponent< AthAlgTool >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for the component.

We overwrite this to call the additional checkers below.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

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

◆ throwFailedToGetTrackingGeomtry()

void Trk::ExtrapolationEngine::throwFailedToGetTrackingGeomtry ( ) const
private

Definition at line 86 of file ExtrapolationEngine.cxx.

86 {
87 std::stringstream msg;
88 msg << "Failed to get conditions data " << m_trackingGeometryReadKey.key() << ".";
89 throw std::runtime_error(msg.str());
90}
MsgStream & msg() const

◆ trackingGeometry()

const Trk::TrackingGeometry & Trk::ExtrapolationEngine::trackingGeometry ( ) const
inlineprivate

Definition at line 130 of file ExtrapolationEngine.h.

130 {
131 const Trk::TrackingGeometry *tracking_geometry = retrieveTrackingGeometry(Gaudi::Hive::currentContext());
132 if (!tracking_geometry){
133 EX_MSG_FATAL("", "updateGeo", "", "Did not get valid TrackingGeometry. Aborting." );
134 throw GaudiException("ExtrapolationEngine", "Problem with TrackingGeometry loading.", StatusCode::FAILURE);
135 }
136 return *tracking_geometry;
137 }
const TrackingGeometry * retrieveTrackingGeometry(const EventContext &ctx) const

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }
std::vector< SG::VarHandleKeyArray * > m_vhka

◆ NavigationInitTest

friend class NavigationInitTest
friend

Definition at line 51 of file ExtrapolationEngine.h.

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_eeAccessor

std::vector<const IExtrapolationEngine*> Trk::ExtrapolationEngine::m_eeAccessor
private

the extrapolation engines for

forces a global search for the initialization, allows to switch TrackingGeometries in one job

Definition at line 115 of file ExtrapolationEngine.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_extrapolationEngines

ToolHandleArray<IExtrapolationEngine> Trk::ExtrapolationEngine::m_extrapolationEngines { this, "ExtrapolationEngines", {} }
private

Definition at line 112 of file ExtrapolationEngine.h.

112{ this, "ExtrapolationEngines", {} };

◆ m_forceSearchInit

BooleanProperty Trk::ExtrapolationEngine::m_forceSearchInit {this, "ForceSearchAtInit", false}
private

Definition at line 119 of file ExtrapolationEngine.h.

119{this, "ForceSearchAtInit", false};

◆ m_navigationEngine

ToolHandle<INavigationEngine> Trk::ExtrapolationEngine::m_navigationEngine {this, "NavigationEngine", "Trk::StaticNavigationEngine/AtlasStaticNavigation"}
private

access to tracking geometry (unique?)

Definition at line 114 of file ExtrapolationEngine.h.

114{this, "NavigationEngine", "Trk::StaticNavigationEngine/AtlasStaticNavigation"};

◆ m_propagationEngine

ToolHandle<IPropagationEngine> Trk::ExtrapolationEngine::m_propagationEngine {this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"}
private

the used propagation engine for navigation initialization

Definition at line 113 of file ExtrapolationEngine.h.

113{this, "PropagationEngine", "Trk::PropagationEngine/AtlasStaticPropagation"};

◆ m_sopPostfix

std::string Trk::IExtrapolationEngine::m_sopPostfix
protectedinherited

prefix for screen output

Definition at line 64 of file IExtrapolationEngine.h.

◆ m_sopPostfix_prop

StringProperty Trk::ExtrapolationEngine::m_sopPostfix_prop {this, "OutputPostfix", ""}
private

Definition at line 122 of file ExtrapolationEngine.h.

122{this, "OutputPostfix", ""};

◆ m_sopPrefix

std::string Trk::IExtrapolationEngine::m_sopPrefix
protectedinherited

< SCREEN output formatting (SOP) - unify amongst extrapolation engines

prefix for screen output

Definition at line 63 of file IExtrapolationEngine.h.

◆ m_sopPrefix_prop

StringProperty Trk::ExtrapolationEngine::m_sopPrefix_prop {this, "OutputPrefix", ""}
private

Definition at line 121 of file ExtrapolationEngine.h.

121{this, "OutputPrefix", ""};

◆ m_trackingGeometryReadKey

SG::ReadCondHandleKey<TrackingGeometry> Trk::ExtrapolationEngine::m_trackingGeometryReadKey {this, "TrackingGeometryReadKey", "", "Key of the TrackingGeometry conditions data."}
private

the tool handle array for static / dense / detached

Definition at line 108 of file ExtrapolationEngine.h.

109{this, "TrackingGeometryReadKey", "", "Key of the TrackingGeometry conditions data."};

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