Trk::StepEngine Class Reference

#include <StepEngine.h>

Inheritance diagram for Trk::StepEngine:

Collaboration diagram for Trk::StepEngine:

Public Types
enum	ResolveLayerType {   StartLayer = 0, NavigationLayer = 1, PassThroughLayer = 2, SubStructureLayer = 3,   DestinationLayer = 4, StartAndDestinationLayer = 6, UndefinedLayer = 5 }

Public Member Functions
	StepEngine (const std::string &, const std::string &, const IInterface *)
	Constructor. More...
virtual	~StepEngine ()
	Destructor. More...
virtual StatusCode	initialize () override
	AlgTool initialize method. More...
virtual StatusCode	finalize () override
	AlgTool finalize method. More...
virtual ExtrapolationCode	extrapolate (ExCellCharged &ecCharged, const Surface *sf=0, const BoundaryCheck &bcheck=true) const override
	charged extrapolation - public interface More...
virtual ExtrapolationCode	extrapolate (ExCellNeutral &ecNeutral, const Surface *sf=0, const BoundaryCheck &bcheck=true) const override
	neutral extrapolation - public interface More...
virtual GeometryType	geometryType () const override
	define for which GeometrySignature this extrapolator is valid - this is GLOBAL More...
virtual ExtrapolationCode	extrapolate (ExCellCharged &ecCharged, const Surface *sf=0, const BoundaryCheck &bcheck=true) const=0
	charged extrapolation More...
virtual ExtrapolationCode	extrapolate (ExCellNeutral &ecNeutral, const Surface *sf=0, const BoundaryCheck &bcheck=true) const=0
	neutral extrapolation More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
template<class T >
Trk::ExtrapolationCode	targetSurfacesT (ExtrapolationCell< T > &eCell, Trk::TargetSurfaceVector &ts, bool trueOrderedIntersections, const Surface *sf=0, const BoundaryCheck &bcheck=true) const
	main loop extrapolation method More...
template<class T >
Trk::ExtrapolationCode	resolveFrameBoundaryT (ExtrapolationCell< T > &eCell, Amg::Vector3D position, unsigned int index) const
void	evaluateDistance (Trk::TargetSurface &tt, const Amg::Vector3D &pos, const Amg::Vector3D &mom, Trk::TargetSurfaceVector &ts, bool trueOrdered) const
	distance calculations More...
Trk::ExtrapolationCode	handleIntersection (ExCellCharged &ecCharged, Trk::TargetSurfaceVector &solutions) const
	handle extrapolation step More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
ToolHandle< IPropagator >	m_propagator
	the used propagation engine More...
ToolHandle< IMaterialEffectsEngine >	m_materialEffectsEngine
	the material effects updated More...
ToolHandle< INavigationEngine >	m_navigationEngine
	access to tracking geometry More...
double	m_tolerance
TargetSurfaces	m_targetSurfaces
bool	m_debugAndFix
bool	m_debugCall
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Extrapolation engine for arbitrary tracking geometry environment. Intended as primary choice for Calo/MS.

Author

sarka.todorova -at- cern.ch

Definition at line 43 of file StepEngine.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

ResolveLayerType

enum Trk::StepEngine::ResolveLayerType

• use for code readability

Enumerator
StartLayer
NavigationLayer
PassThroughLayer
SubStructureLayer
DestinationLayer
StartAndDestinationLayer
UndefinedLayer

Definition at line 50 of file StepEngine.h.

                              {
          StartLayer                = 0,
          NavigationLayer           = 1,
          PassThroughLayer          = 2,
          SubStructureLayer         = 3,
          DestinationLayer          = 4,
          StartAndDestinationLayer  = 6,
          UndefinedLayer            = 5
        };          

Constructor & Destructor Documentation

StepEngine()

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

Constructor.

Definition at line 15 of file StepEngine.cxx.

: AthAlgTool(t,n,p),
  m_propagator(""),          
  m_materialEffectsEngine(""),
  m_navigationEngine(""),    
  m_tolerance(0.01),
  m_debugAndFix(true),
  m_debugCall(false)  
{
    declareInterface<Trk::IExtrapolationEngine>(this);
    // The Tools needed
    declareProperty("Propagator"                        , m_propagator);
    declareProperty("MaterialEffectsEngine"                 , m_materialEffectsEngine);
    declareProperty("NavigationEngine"                      , m_navigationEngine);
    // steering of the screen outoput (SOP)
    declareProperty("OutputPrefix"                          , m_sopPrefix);
    declareProperty("OutputPostfix"                         , m_sopPostfix);
    declareProperty("DebugAndFixMode"                       , m_debugAndFix);
}

~StepEngine()

Trk::StepEngine::~StepEngine ( )

virtualdefault

Destructor.

Member Function Documentation

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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.

{ return m_detStore; }

evaluateDistance()

void Trk::StepEngine::evaluateDistance ( Trk::TargetSurface &  tt, const Amg::Vector3D &  pos, const Amg::Vector3D &  mom, Trk::TargetSurfaceVector &  ts, bool  trueOrdered  ) const

private

distance calculations

Definition at line 268 of file StepEngine.cxx.

{
    Trk::DistanceSolution distSol = tt.surf->straightLineDistanceEstimate(pos,mom);
 
    double dist = distSol.first();
    Amg::Vector3D posi =  pos + dist*mom;
    // skip trivial solutions
    if (distSol.numberOfSolutions()>1 && dist<m_tolerance && distSol.second()>m_tolerance) {
      dist = distSol.second();
      posi =  pos + dist*mom;
      if (trueOrdered && !tt.surf->isOnSurface(posi,tt.bcheck,m_tolerance,m_tolerance) ) return;
      double dAbs = distSol.currentDistance(true);
      tt.setDistance(dist,fabs(dAbs),distSol.signedDistance() && dAbs!=0. ?  dAbs/fabs(dAbs)  : 0.);
      tt.setPosition(posi);
      ts.push_back(tt);
      return;
    } 
    // save closest solution
    if (!trueOrdered || dist>m_tolerance ) {
      double dAbs = distSol.currentDistance(true);
      tt.setDistance(dist,fabs(dAbs),distSol.signedDistance() && dAbs!=0. ?  dAbs/fabs(dAbs)  : 0.);
      tt.setPosition(posi);
      ts.push_back(tt);
    } 
 
    // save multiple intersection for neutral transport
    if (distSol.numberOfSolutions()>1 && distSol.second()>m_tolerance && trueOrdered) {
       dist = distSol.second();
       posi =  pos + dist*mom;
       if ( tt.surf->isOnSurface(posi,tt.bcheck,m_tolerance,m_tolerance) ) {
        double dAbs = distSol.currentDistance(true);
        tt.setDistance(dist,fabs(dAbs),distSol.signedDistance() && dAbs!=0. ?  dAbs/fabs(dAbs)  : 0.);
        tt.setPosition(posi);
        ts.push_back(tt);
       }
    }
 
    }  

evtStore() [1/2]

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.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

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/4]

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

overridevirtual

charged extrapolation - public interface

charged extrapolation

Implements Trk::IExtrapolationEngine.

Definition at line 77 of file StepEngine.cxx.

{
  // check the input
  if (!ecCharged.leadParameters) return Trk::ExtrapolationCode::FailureConfiguration;   
  if (!ecCharged.leadVolume) {  // should not happen : try to recover anyway
    Trk::ExtrapolationCode eVol = m_navigationEngine->resolvePosition(ecCharged,ecCharged.propDirection,false);  
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol; 
  }  
 
  // cache the last lead parameters, useful in case a navigation error occured
  ecCharged.lastLeadParameters = ecCharged.leadParameters;
  // new extrapolation call : find possible target surfaces
  //Trk::TargetSurfaceVector ts;
  //Trk::ExtrapolationCode eCode = targetSurfacesT(ecCharged,ts,false,sf,bcheck);
 
  // test new class
  Trk::ExtrapolationCode exC = m_targetSurfaces.setOnInput(ecCharged,sf,bcheck);
 
  // catch an infinite loop in frame navigation
  if (exC==Trk::ExtrapolationCode::FailureLoop) {  // should not happen : try to recover once
     
    EX_MSG_WARNING("", "extrapolate", "", "frame navigation recovery attempt for:"<< ecCharged.leadVolume->volumeName());
 
    Trk::ExtrapolationCode eVol = m_navigationEngine->resolvePosition(ecCharged,ecCharged.propDirection,true);  
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol; 
    //ts.clear();
    //eVol = targetSurfacesT(ecCharged,ts,false,sf,bcheck);
    exC = m_targetSurfaces.setOnInput(ecCharged,sf,bcheck);
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol;   
  }  
 
  // build PathLimit from eCell info
  Trk::PathLimit pathLim(ecCharged.materialLimitX0-ecCharged.materialX0, ecCharged.materialProcess);  
  // build TimeLimit from eCell info
  //Trk::TimeLimit timeLim(ecCharged.timeLimit,ecCharged.time,201);      // Fatras decay code
  Trk::TimeLimit timeLim(-1.,ecCharged.time,201);      // temporary till time limit absent in eCell
 
  // loop over intersections
  // std::vector<unsigned int> solutions;
  Trk::TargetSurfaceVector solutions;
  while (ecCharged.leadParameters ) {
    solutions.clear();
    // TODO pass TargetSurfaces directly to the propagator
 
    EX_MSG_VERBOSE(ecCharged.navigationStep, "propagate", "loop", "starting propagation at position : " << ecCharged.leadParameters->position()<<","<<ecCharged.leadParameters->momentum() );
    if (m_debugCall) EX_MSG_DEBUG(ecCharged.navigationStep, "propagate", "debug loop", "starting propagation at position : " << ecCharged.leadParameters->position()<<","<<ecCharged.leadParameters->momentum() );
    //const Trk::TrackParameters* nextPar = m_propagator->propagateT(*ecCharged.leadParameters,m_targetSurfaces,ecCharged.propDirection,
    //                               ecCharged.mFieldMode, ecCharged.pHypothesis, solutions,
    //                               pathLim,timeLim,ecCharged.navigationCurvilinear,hitVector);  
    // cache the last lead parameters, useful in case a navigation error occured
    //ecCharged.lastLeadParameters = ecCharged.leadParameters;
 
    Trk::ExtrapolationCode eCode = m_propagator->propagate(
      Gaudi::Hive::currentContext(),
      ecCharged,
      m_targetSurfaces,
      solutions);
 
    // enforced debugging
    if (eCode==Trk::ExtrapolationCode::FailureNavigation && m_debugAndFix) {
      if (m_debugCall) {
    EX_MSG_INFO(ecCharged.navigationStep, "extrapolate", "loop:debug mode:"," stopping execution for further debugging");
    exit(0);
      } else {
    // repeat the call with printout && stop the execution 
    EX_MSG_INFO(ecCharged.navigationStep, "extrapolate", "loop:debug mode:","rerun last extrapolation call"<<ecCharged.lastLeadParameters->position());
    ecCharged.leadParameters = ecCharged.lastLeadParameters;
        ecCharged.leadVolume = nullptr;
        m_debugCall = true;
        m_targetSurfaces.setDebugModeOn();
    eCode = extrapolate(ecCharged,sf,bcheck);
    exit(0);
      }
    }
 
    const Trk::TrackParameters* nextPar = (eCode.isSuccess() || eCode.inProgress()) ? ecCharged.leadParameters : nullptr ;    
    if (!nextPar)    EX_MSG_VERBOSE(ecCharged.navigationStep, "propagate", "loop", "propagation failed ");
    else   EX_MSG_VERBOSE(ecCharged.navigationStep, "propagate", "loop", "propagated to :"<< nextPar->position());
 
    if (!nextPar) return ( sf ? Trk::ExtrapolationCode::FailureDestination : eCode ) ;
 
    EX_MSG_VERBOSE(ecCharged.navigationStep, "propagate", "loop", "propagation arrived at position : " << ecCharged.leadParameters->position() );
    if (m_debugCall) EX_MSG_DEBUG(ecCharged.navigationStep, "propagate", "loop", "propagation arrived at position : " << ecCharged.leadParameters->position() );
 
    // record the parameters as sensitive or passive depending on the surface
    //Trk::ExtrapolationMode::eMode emode =  csf.object->isActive() ? Trk::ExtrapolationMode::CollectSensitive : Trk::ExtrapolationMode::CollectPassive;
    // fill the corresponding parameters, the material effects updator can attach material to them
    // ecCharged.stepParameters(ecCharged.leadParameters, Trk::ExtrapolationMode::CollectPassive);
 
    // handle extrapolation step
    Trk::ExtrapolationCode eStep = handleIntersection(ecCharged,solutions);
 
    if (eStep != Trk::ExtrapolationCode::InProgress ) return eStep;
  }
 
  return Trk::ExtrapolationCode::FailureConfiguration;
 }

extrapolate() [2/4]

virtual ExtrapolationCode Trk::IExtrapolationEngine::extrapolate

charged extrapolation

extrapolate() [3/4]

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

overridevirtual

neutral extrapolation - public interface

neutral extrapolation

Implements Trk::IExtrapolationEngine.

Definition at line 179 of file StepEngine.cxx.

{
  // check the input
 
  if (!ecNeutral.leadParameters) return Trk::ExtrapolationCode::FailureConfiguration;   
  if (!ecNeutral.leadVolume) {  // should not happen : try to recover anyway
    Trk::ExtrapolationCode eVol = m_navigationEngine->resolvePosition(ecNeutral,ecNeutral.propDirection,false);  
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol; 
  }  
 
  // new extrapolation call : find valid intersections
  Trk::TargetSurfaceVector ts; ts.clear();
  Trk::ExtrapolationCode eCode = targetSurfacesT(ecNeutral,ts,true,sf,bcheck);
 
  CHECK_ECODE_SUCCESS(ecNeutral, eCode);
 
  // catch an infinite loop in frame navigation
  if (eCode==Trk::ExtrapolationCode::FailureLoop) {  // should not happen : try to recover once
    Trk::ExtrapolationCode eVol = m_navigationEngine->resolvePosition(ecNeutral,ecNeutral.propDirection,true);  
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol; 
    ts.clear();
    eVol = targetSurfacesT(ecNeutral,ts,true,sf,bcheck);
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol;   
  }  
 
  // catch an infinite loop in frame navigation
  if (!ecNeutral.leadVolume) {  // should not happen : try to recover once
    Trk::ExtrapolationCode eVol = m_navigationEngine->resolvePosition(ecNeutral,ecNeutral.propDirection);  
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol; 
 
    eVol = targetSurfacesT(ecNeutral,ts,true,sf,bcheck);
    if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol;   
 
  }  
 
  // loop over intersections
  for (auto & t : ts) {
 
  
    if ( t.sfType == Trk::SurfNavigType::BoundaryFrame ) {  
      const auto &bounds = ecNeutral.leadVolume->boundarySurfaces();
      const Trk::TrackingVolume* nextVolume = bounds[t.index]->attachedVolume(t.intersection, 
                                                ecNeutral.leadParameters->momentum(), 
                                                ecNeutral.propDirection);  
 
      if (!nextVolume) return Trk::ExtrapolationCode::SuccessBoundaryReached;
 
      ecNeutral.leadParameters = new Trk::NeutralCurvilinearParameters(t.intersection,ecNeutral.leadParameters->momentum(),0.); 
 
      // - geometrySignature change and configuration to stop then triggers a Success 
      bool stopAtThisBoundary = ecNeutral.checkConfigurationMode(Trk::ExtrapolationMode::StopAtBoundary) 
                                  && (nextVolume->geometrySignature() != ecNeutral.leadVolume->geometrySignature());        
      // fill the boundary into the cache if successfully hit boundary surface
      // - only cache if those are not the final parameters caused by a StopAtBoundary
      if (!stopAtThisBoundary)
    ecNeutral.stepParameters(ecNeutral.leadParameters, Trk::ExtrapolationMode::CollectBoundary);
      // loop protection - relaxed for the cases where you start from the boundary
      if (ecNeutral.leadVolume == nextVolume ) {
    // the start parameters where on the boundary already give a relaxed return code
        //  if (&bSurface == eCell.lastBoundarySurface) return Trk::ExtrapolationCode::Unset;
        // give some screen output as of why this happens
        EX_MSG_VERBOSE(ecNeutral.navigationStep, "navigation", "", "loop detected while trying to leave TrackingVolume '" << nextVolume->volumeName() << ".");
        // return a loop failure, parameter deletion will be done by cache
        return Trk::ExtrapolationCode::FailureLoop;
      }
      // break if configured to break at volume boundary and signature change
      if (stopAtThisBoundary){
    EX_MSG_VERBOSE(ecNeutral.navigationStep, "navigation", "", "geometry signature change from " <<
               ecNeutral.leadVolume->geometrySignature()  << " to " << nextVolume->geometrySignature());
    ecNeutral.nextGeometrySignature = nextVolume->geometrySignature();
    // return the boundary reached     
    return Trk::ExtrapolationCode::SuccessBoundaryReached;
      } 
      // remember the last boundary surface for loop protection
      // ecNeutral.lastBoundarySurface             = &bounds[index];
      ecNeutral.lastBoundaryParameters          = ecNeutral.leadParameters;
      // set next volume 
      ecNeutral.leadVolume                      = nextVolume;    
      return  Trk::ExtrapolationCode::InProgress;
    } 
  }
 
  return Trk::ExtrapolationCode::FailureConfiguration;
 }

extrapolate() [4/4]

virtual ExtrapolationCode Trk::IExtrapolationEngine::extrapolate

neutral extrapolation

finalize()

StatusCode Trk::StepEngine::finalize ( )

overridevirtual

AlgTool finalize method.

Definition at line 69 of file StepEngine.cxx.

{    
    EX_MSG_DEBUG("", "finalize", "", "successful." );
    return StatusCode::SUCCESS;
}

geometryType()

GeometryType Trk::StepEngine::geometryType ( ) const

inlineoverridevirtual

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

Implements Trk::IExtrapolationEngine.

Definition at line 123 of file StepEngine.h.

      { return Trk::Dense; }

handleIntersection()

Trk::ExtrapolationCode Trk::StepEngine::handleIntersection ( ExCellCharged &  ecCharged, Trk::TargetSurfaceVector &  solutions  ) const

private

handle extrapolation step

Definition at line 309 of file StepEngine.cxx.

{ 
  for (const auto & thisSurface : solutions){
    // destination
    if ( thisSurface.sfType == Trk::SurfNavigType::Target ){
      return Trk::ExtrapolationCode::SuccessDestination;
    } 
    // frame boundary : update of target surfaces
    if ( thisSurface.sfType == Trk::SurfNavigType::BoundaryFrame ) {
      return resolveFrameBoundaryT(ecCharged,ecCharged.leadParameters->position(),
                                   thisSurface.index);  
    }                       
  }
  return Trk::ExtrapolationCode::InProgress;   
}

initialize()

StatusCode Trk::StepEngine::initialize ( )

overridevirtual

AlgTool initialize method.

Definition at line 41 of file StepEngine.cxx.

{
    if (m_propagator.retrieve().isFailure()){
        EX_MSG_FATAL("", "initialize", "", "failed to retrieve propagator '"<< m_propagator << "'. Aborting." );
        return StatusCode::FAILURE;
    } else 
        EX_MSG_DEBUG("", "initialize", "", "successfully retrieved '" << m_propagator << "'." );
            
    if (m_materialEffectsEngine.retrieve().isFailure()){
        EX_MSG_FATAL("", "initialize", "", "failed to retrieve material effect engine '"<< m_materialEffectsEngine << "'. Aborting." );
        return StatusCode::FAILURE;
    } else 
        EX_MSG_DEBUG("", "initialize", "", "successfully retrieved '" << m_materialEffectsEngine << "'." );
    
    if (m_navigationEngine.retrieve().isFailure()){
        EX_MSG_FATAL("", "initialize", "", "failed to retrieve navigation engine '"<< m_navigationEngine << "'. Aborting." );
        return StatusCode::FAILURE;
    } else 
        EX_MSG_DEBUG("", "initialize", "", "successfully retrieved '" << m_navigationEngine << "'." );
    
    EX_MSG_DEBUG("", "initialize", "", "successful." );
 
    m_targetSurfaces.setDebugModeOff();
 
    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()

static const InterfaceID& Trk::IExtrapolationEngine::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 43 of file IExtrapolationEngine.h.

{ return IID_IExtrapolationEngine; }

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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

resolveFrameBoundaryT()

template<class T >

Trk::ExtrapolationCode Trk::StepEngine::resolveFrameBoundaryT ( ExtrapolationCell< T > &  eCell, Amg::Vector3D  position, unsigned int  index  ) const

private

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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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.

targetSurfacesT()

template<class T >

Trk::ExtrapolationCode Trk::StepEngine::targetSurfacesT ( ExtrapolationCell< T > &  eCell, Trk::TargetSurfaceVector &  ts, bool  trueOrderedIntersections, const Surface *  sf = 0, const BoundaryCheck &  bcheck = true  ) const

private

main loop extrapolation method

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_debugAndFix

bool Trk::StepEngine::m_debugAndFix

private

Definition at line 118 of file StepEngine.h.

m_debugCall

bool Trk::StepEngine::m_debugCall

mutableprivate

Definition at line 119 of file StepEngine.h.

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_materialEffectsEngine

ToolHandle<IMaterialEffectsEngine> Trk::StepEngine::m_materialEffectsEngine

private

the material effects updated

Definition at line 108 of file StepEngine.h.

m_navigationEngine

ToolHandle<INavigationEngine> Trk::StepEngine::m_navigationEngine

private

access to tracking geometry

Definition at line 109 of file StepEngine.h.

m_propagator

ToolHandle<IPropagator> Trk::StepEngine::m_propagator

private

the used propagation engine

Definition at line 107 of file StepEngine.h.

m_sopPostfix

std::string Trk::IExtrapolationEngine::m_sopPostfix

protectedinherited

prefix for screen output

Definition at line 64 of file IExtrapolationEngine.h.

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_targetSurfaces

TargetSurfaces Trk::StepEngine::m_targetSurfaces

mutableprivate

Definition at line 115 of file StepEngine.h.

m_tolerance

double Trk::StepEngine::m_tolerance

private

Definition at line 112 of file StepEngine.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:

• StepEngine.h
• StepEngine.cxx