Trk::RungeKuttaPropagator Class Reference

#include <RungeKuttaPropagator.h>

Inheritance diagram for Trk::RungeKuttaPropagator:

Collaboration diagram for Trk::RungeKuttaPropagator:

Classes
struct	Cache

Public Member Functions
	RungeKuttaPropagator (const std::string &, const std::string &, const IInterface *)
virtual StatusCode	initialize () override final
virtual	~RungeKuttaPropagator ()=default
virtual std::unique_ptr< NeutralParameters >	propagate (const NeutralParameters &, const Surface &, PropDirection, const BoundaryCheck &, bool) const override final
	Main propagation method for NeutralParameters. More...
virtual std::unique_ptr< TrackParameters >	propagate (const EventContext &ctx, const TrackParameters &, const Surface &, const PropDirection, const BoundaryCheck &, const MagneticFieldProperties &, ParticleHypothesis, bool, const TrackingVolume *) const override final
	Main propagation method without transport jacobian production. More...
virtual Trk::MultiComponentState	multiStatePropagate (const EventContext &ctx, const MultiComponentState &multiComponentState, const Surface &surface, const MagneticFieldProperties &fieldProperties, const PropDirection direction=Trk::anyDirection, const BoundaryCheck &boundaryCheck=true, const ParticleHypothesis particleHypothesis=nonInteracting) const override final
	Main propagation method for Multi Component state. More...
virtual std::unique_ptr< TrackParameters >	propagate (const EventContext &ctx, const TrackParameters &, const Surface &, const PropDirection, const BoundaryCheck &, const MagneticFieldProperties &, std::optional< TransportJacobian > &, double &, ParticleHypothesis, bool, const TrackingVolume *) const override final
	Main propagation method with transport jacobian production. More...
virtual std::unique_ptr< TrackParameters >	propagate (const EventContext &ctx, const TrackParameters &, std::vector< DestSurf > &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis, std::vector< unsigned int > &, double &, bool, bool, const TrackingVolume *) const override final
	The propagation method finds the closest surface. More...
virtual std::unique_ptr< TrackParameters >	propagateParameters (const EventContext &ctx, const TrackParameters &, const Surface &, const PropDirection, const BoundaryCheck &, const MagneticFieldProperties &, ParticleHypothesis, bool, const TrackingVolume *) const override final
	Main propagation method for parameters only. More...
virtual std::unique_ptr< TrackParameters >	propagateParameters (const EventContext &ctx, const TrackParameters &, const Surface &, const PropDirection, const BoundaryCheck &, const MagneticFieldProperties &, std::optional< TransportJacobian > &, ParticleHypothesis, bool, const TrackingVolume *) const override final
	Main propagation method for parameters only with transport jacobian production. More...
virtual std::optional< Trk::TrackSurfaceIntersection >	intersect (const EventContext &ctx, const TrackParameters &, const Surface &, const MagneticFieldProperties &, ParticleHypothesis, const TrackingVolume *tvol=nullptr) const override final
	Global position together with direction of the trajectory on the surface. More...
virtual void	globalPositions (const EventContext &ctx, std::deque< Amg::Vector3D > &, const TrackParameters &, const MagneticFieldProperties &, const CylinderBounds &, double, ParticleHypothesis, const TrackingVolume *tvol=nullptr) const override final
	GlobalPositions list interface: More...
virtual bool	propagate (const EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis particle=pion) const override final
	Main propagation method. More...
virtual bool	propagate (const EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, double &, ParticleHypothesis particle=pion) const override final
	Main propagation method with step to surface calculation. More...
virtual bool	propagateParameters (const EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis particle=pion) const override final
	Main propagation method for parameters only. More...
virtual bool	propagateParameters (const EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, double &, ParticleHypothesis particle=pion) const override final
	Main propagation method for parameters only with step to surface calculation. More...
virtual void	globalPositions (const EventContext &ctx, const PatternTrackParameters &, std::vector< const Surface * > &, std::vector< std::pair< Amg::Vector3D, double >> &, const MagneticFieldProperties &, ParticleHypothesis particle=pion) const override final
virtual std::unique_ptr< Trk::TrackParameters >	propagateT (const EventContext &, const TrackParameters &, std::vector< DestSurf > &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis, std::vector< unsigned int > &, PathLimit &, TimeLimit &, bool, const Trk::TrackingVolume *, std::vector< Trk::HitInfo > *&) const override final
	unimplemented propagateT More...
virtual std::unique_ptr< Trk::TrackParameters >	propagateM (const EventContext &, const TrackParameters &, std::vector< DestSurf > &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis, std::vector< unsigned int > &, std::vector< const Trk::TrackStateOnSurface * > *&, std::vector< std::pair< std::unique_ptr< Trk::TrackParameters >, int >> *, double &, bool, bool, const Trk::TrackingVolume *, Trk::ExtrapolationCache *) const override final
	unimplemented propagateM More...
virtual std::optional< Trk::TrackSurfaceIntersection >	intersectSurface (const EventContext &, const Surface &, const TrackSurfaceIntersection &, const double, const MagneticFieldProperties &, ParticleHypothesis) const override final
	unimplemented intersectSurface More...
virtual Trk::ExtrapolationCode	propagate (const EventContext &, Trk::ExCellCharged &, Trk::TargetSurfaces &, Trk::TargetSurfaceVector &) const override final
	Propagation method needed for StepEngine. 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
virtual bool	propagate (const ::EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis particle=pion) const =0
	Interfaces WITH EventContext (new) More...
virtual bool	propagate (const ::EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, double &, ParticleHypothesis particle=pion) const =0
	Main propagation method with step to surface calculation. More...
virtual bool	propagateParameters (const ::EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, ParticleHypothesis particle=pion) const =0
	Main propagation method for parameters only. More...
virtual bool	propagateParameters (const ::EventContext &ctx, PatternTrackParameters &, const Surface &, PatternTrackParameters &, PropDirection, const MagneticFieldProperties &, double &, ParticleHypothesis particle=pion) const =0
	Main propagation method for parameters only with step to surface calculation. More...
virtual void	globalPositions (const ::EventContext &ctx, const PatternTrackParameters &, std::vector< const Surface * > &, std::vector< std::pair< Amg::Vector3D, double > > &, const MagneticFieldProperties &, ParticleHypothesis particle=pion) const =0

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool and IAlgTool interface methods. More...
static const InterfaceID &	interfaceID ()
	framework method providing the abstract interface 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...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Cache	getInitializedCache (const EventContext &ctx) const
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
SG::ReadCondHandleKey< AtlasFieldCacheCondObj >	m_fieldCondObjInputKey
DoubleProperty	m_dlt {this, "AccuracyParameter", 0.0002}
DoubleProperty	m_helixStep {this, "MaxHelixStep", 1.}
DoubleProperty	m_straightStep {this, "MaxStraightLineStep", 0.01}
BooleanProperty	m_usegradient
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

Trk::RungeKuttaPropagator is an algorithm for track parameters propagation through magnetic field.

The implementation performs the propagation in global coordinates and uses Jacobian matrices (see RungeKuttaUtils) for the transformations between the global frame and local surface-attached coordinate systems.

One can choose to perform the transport of the parameters only and omit the transport of the associated covariances (propagateParameters).

The algorithm can produce the Jacobian that transports the covariance matrix from one set of track parameters at the initial surface to another set of track parameters at the destination surface. This is useful for Chi2 fitting.

It does NOT include material effects (unlike the STEP propagator). As a result the ParticleHypothesis argument is not really used. It is assumed that in the client code , the propagation, transport of the track parameters and their associated covariances, is decoupled from the actual corrections due to interaction with the detector material.

The algorithm contains three steps :

1.The first step of the algorithm is track parameters transformation from local presentation for given start surface to global Runge Kutta coordinates.

2.The second step is propagation through the magnetic field with or without jacobian.

3.Third step is transformation from global Runge Kutta presentation to local presentation of given output surface.

AtaPlane AtaStraightLine AtaDisc AtaCylinder Perigee | | | | | | | | | |

V V V V V

| Local->Global transformation V Global position (Runge Kutta presentation) | | Propagation to next surface with or without jacobian using Nystroem algorithm (See Handbook Net. Bur. of Standards, procedure 25.5.20) |

V Global->Local transformation

| | | | | | | | | | V V V V V PlaneSurface StraightLineSurface DiscSurface CylinderSurface PerigeeSurface

For propagation using Runge Kutta method we use global coordinates, direction, inverse momentum and Jacobian of transformation. All these parameters we save in an array P[42]

/dL0 /dL1 /dPhi /dThe /dCM X ->P[0] dX / P[ 7] P[14] P[21] P[28] P[35] Y ->P[1] dY / P[ 8] P[15] P[22] P[29] P[36] Z ->P[2] dZ / P[ 9] P[16] P[23] P[30] P[37] Ax ->P[3] dAx/ P[10] P[17] P[24] P[31] P[38] Ay ->P[4] dAy/ P[11] P[18] P[25] P[32] P[39] Az ->P[5] dAz/ P[12] P[19] P[26] P[33] P[40] CM ->P[6] dCM/ P[13] P[20] P[27] P[34] P[41]

where in case of local re-presentation

L0 - first local coordinate (surface dependent) L1 - second local coordinate (surface dependent) Phi - Azimuthal angle The - Polar angle CM - charge/momentum

in case of global re-presentation

X - global x-coordinate = surface dependent Y - global y-coordinate = surface dependent Z - global z-coordinate = sutface dependent Ax - direction cosine to x-axis = Sin(The)*Cos(Phi) Ay - direction cosine to y-axis = Sin(The)*Sin(Phi) Az - direction cosine to z-axis = Cos(The) CM - charge/momentum = local CM

Author

Igor..nosp@m.Gavr.nosp@m.ilenk.nosp@m.o@ce.nosp@m.rn.ch

Authors

RD Schaffer C Anastopoulos AthenaMT modifications

Definition at line 130 of file RungeKuttaPropagator.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

RungeKuttaPropagator()

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

Definition at line 1380 of file RungeKuttaPropagator.cxx.

    : AthAlgTool(p, n, t)
{
  declareInterface<Trk::IPropagator>(this);
  declareInterface<Trk::IPatternParametersPropagator>(this);
}

~RungeKuttaPropagator()

virtual Trk::RungeKuttaPropagator::~RungeKuttaPropagator ( )

virtualdefault

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

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

getInitializedCache()

Cache Trk::RungeKuttaPropagator::getInitializedCache ( const EventContext &  ctx ) const

private

Definition at line 1914 of file RungeKuttaPropagator.cxx.

{
  SG::ReadCondHandle<AtlasFieldCacheCondObj> readHandle{m_fieldCondObjInputKey,
                                                        ctx};
  const AtlasFieldCacheCondObj* fieldCondObj{*readHandle};
  Cache cache{};
  fieldCondObj->getInitializedCache(cache.m_fieldCache);
  cache.m_dlt = m_dlt;
  cache.m_helixStep = m_helixStep;
  cache.m_straightStep = m_straightStep;
  cache.m_usegradient = m_usegradient;
  return cache;
}

globalPositions() [1/3]

virtual void Trk::IPatternParametersPropagator::globalPositions ( const ::EventContext &  ctx, const PatternTrackParameters &  , std::vector< const Surface * > &  , std::vector< std::pair< Amg::Vector3D, double > > &  , const MagneticFieldProperties &  , ParticleHypothesis  particle = pion  ) const

pure virtualinherited

globalPositions() [2/3]

virtual void Trk::RungeKuttaPropagator::globalPositions ( const EventContext &  ctx, const PatternTrackParameters &  , std::vector< const Surface * > &  , std::vector< std::pair< Amg::Vector3D, double >> &  , const MagneticFieldProperties &  , ParticleHypothesis  particle = pion  ) const

finaloverridevirtual

globalPositions() [3/3]

virtual void Trk::RungeKuttaPropagator::globalPositions ( const EventContext &  ctx, std::deque< Amg::Vector3D > &  , const TrackParameters &  , const MagneticFieldProperties &  , const CylinderBounds &  , double  , ParticleHypothesis  , const TrackingVolume *  tvol = nullptr  ) const

finaloverridevirtual

GlobalPositions list interface:

Implements Trk::IPropagator.

initialize()

StatusCode Trk::RungeKuttaPropagator::initialize ( )

finaloverridevirtual

Definition at line 1390 of file RungeKuttaPropagator.cxx.

{
  // Read handle for AtlasFieldCacheCondObj
  ATH_CHECK(m_fieldCondObjInputKey.initialize());
  ATH_MSG_DEBUG("initialize() init key: " << m_fieldCondObjInputKey.key());
  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() [1/2]

const InterfaceID & Trk::IPatternParametersPropagator::interfaceID ( )

inlinestaticinherited

framework method providing the abstract interface

Definition at line 107 of file IPatternParametersPropagator.h.

{
        return IID_IPatternParametersPropagator;
}

interfaceID() [2/2]

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

inlinestaticinherited

AlgTool and IAlgTool interface methods.

Definition at line 61 of file IPropagator.h.

{ return IID_IPropagator; }

intersect()

std::optional< Trk::TrackSurfaceIntersection > Trk::RungeKuttaPropagator::intersect ( const EventContext &  ctx, const TrackParameters &  , const Surface &  , const MagneticFieldProperties &  , ParticleHypothesis  , const TrackingVolume *  tvol = nullptr  ) const

finaloverridevirtual

Global position together with direction of the trajectory on the surface.

Implements Trk::IPropagator.

Definition at line 1796 of file RungeKuttaPropagator.cxx.

{
  bool nJ = false;
  const Trk::Surface* su = &Su;
  Cache cache = getInitializedCache(ctx);
  cache.m_direction = 0.;
  cache.m_needgradient = false;
 
  M.magneticFieldMode() == Trk::FastField ? cache.m_solenoid = true : cache.m_solenoid = false;
  M.magneticFieldMode() != Trk::NoField ? cache.m_mcondition = true : cache.m_mcondition = false;
 
  double P[64];
  if (!Trk::RungeKuttaUtils::transformLocalToGlobal(false, Tp, P)){
    return std::nullopt;
  }
  double Step = 0.;
  if (!propagateWithJacobianSwitch(cache, (*su), nJ, P, Step)) {
    return std::nullopt;
  }
 
  const Amg::Vector3D Glo(P[0], P[1], P[2]);
  const Amg::Vector3D Dir(P[3], P[4], P[5]);
  return std::make_optional<Trk::TrackSurfaceIntersection>(Glo, Dir, Step);
}

intersectSurface()

virtual std::optional<Trk::TrackSurfaceIntersection> Trk::RungeKuttaPropagator::intersectSurface ( const EventContext &  , const Surface &  , const TrackSurfaceIntersection &  , const double  , const MagneticFieldProperties &  , ParticleHypothesis    ) const

inlinefinaloverridevirtual

unimplemented intersectSurface

Implements Trk::IPropagator.

Definition at line 346 of file RungeKuttaPropagator.h.

  {
    ATH_MSG_ERROR("Call to non-implemented intersectSurface");
    return std::nullopt;
  }

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

multiStatePropagate()

Trk::MultiComponentState Trk::RungeKuttaPropagator::multiStatePropagate ( const EventContext &  ctx, const MultiComponentState &  multiComponentState, const Surface &  surface, const MagneticFieldProperties &  fieldProperties, const PropDirection  direction = Trk::anyDirection, const BoundaryCheck &  boundaryCheck = true, const ParticleHypothesis  particleHypothesis = nonInteracting  ) const

finaloverridevirtual

Main propagation method for Multi Component state.

Implements Trk::IPropagator.

Definition at line 1441 of file RungeKuttaPropagator.cxx.

{
  Cache cache = getInitializedCache(ctx);
 
  Trk::MultiComponentState propagatedState{};
  propagatedState.reserve(multiComponentState.size());
  double sumw(0);  // sum of the weights of the propagated parameters
  double J[25];
  Trk::MultiComponentState::const_iterator component =
      multiComponentState.begin();
  for (; component != multiComponentState.end(); ++component) {
    const Trk::TrackParameters* currentParameters = component->params.get();
    if (!currentParameters) {
      continue;
    }
    auto propagatedParameters =
        propagateRungeKutta(cache, true, *currentParameters, surface, direction,
                            boundaryCheck, fieldProperties, J, false);
 
    if (!propagatedParameters) {
      continue;
    }
    sumw += component->weight;
    // Propagation does not affect the weightings of the states
    propagatedState.push_back({std::move(propagatedParameters),
                                 component->weight});
  }
  // Protect low weight propagation
  constexpr double minPropWeight = (1./12.);
  if (sumw < minPropWeight) {
    propagatedState.clear();
  }
  return propagatedState;
}

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.

propagate() [1/9]

virtual bool Trk::IPatternParametersPropagator::propagate ( const ::EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , double &  , ParticleHypothesis  particle = pion  ) const

pure virtualinherited

Main propagation method with step to surface calculation.

propagate() [2/9]

virtual bool Trk::IPatternParametersPropagator::propagate ( const ::EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  particle = pion  ) const

pure virtualinherited

Interfaces WITH EventContext (new)

Main propagation method

propagate() [3/9]

virtual Trk::ExtrapolationCode Trk::RungeKuttaPropagator::propagate ( const EventContext &  ctx, Trk::ExCellCharged &  eCell, Trk::TargetSurfaces &  sfs, Trk::TargetSurfaceVector &  solutions  ) const

inlinefinaloverridevirtual

Propagation method needed for StepEngine.

Implements Trk::IPropagator.

Definition at line 358 of file RungeKuttaPropagator.h.

  {
    return Trk::ExtrapolationCode::FailureConfiguration;
  }

propagate() [4/9]

virtual std::unique_ptr<TrackParameters> Trk::RungeKuttaPropagator::propagate ( const EventContext &  ctx, const TrackParameters &  , const Surface &  , const  PropDirection, const BoundaryCheck &  , const MagneticFieldProperties &  , ParticleHypothesis  , bool  , const TrackingVolume *    ) const

finaloverridevirtual

Main propagation method without transport jacobian production.

Implements Trk::IPropagator.

propagate() [5/9]

virtual std::unique_ptr<TrackParameters> Trk::RungeKuttaPropagator::propagate ( const EventContext &  ctx, const TrackParameters &  , const Surface &  , const  PropDirection, const BoundaryCheck &  , const MagneticFieldProperties &  , std::optional< TransportJacobian > &  , double &  , ParticleHypothesis  , bool  , const TrackingVolume *    ) const

finaloverridevirtual

Main propagation method with transport jacobian production.

Implements Trk::IPropagator.

propagate() [6/9]

virtual std::unique_ptr<TrackParameters> Trk::RungeKuttaPropagator::propagate ( const EventContext &  ctx, const TrackParameters &  , std::vector< DestSurf > &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  , std::vector< unsigned int > &  , double &  , bool  , bool  , const TrackingVolume *    ) const

finaloverridevirtual

The propagation method finds the closest surface.

Implements Trk::IPropagator.

propagate() [7/9]

virtual bool Trk::RungeKuttaPropagator::propagate ( const EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , double &  , ParticleHypothesis  particle = pion  ) const

finaloverridevirtual

Main propagation method with step to surface calculation.

propagate() [8/9]

virtual bool Trk::RungeKuttaPropagator::propagate ( const EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  particle = pion  ) const

finaloverridevirtual

Main propagation method.

propagate() [9/9]

std::unique_ptr< Trk::NeutralParameters > Trk::RungeKuttaPropagator::propagate ( const NeutralParameters &  Tp, const Surface &  Su, Trk::PropDirection  D, const BoundaryCheck &  B, bool  returnCurv  ) const

finaloverridevirtual

Main propagation method for NeutralParameters.

Implements Trk::IPropagator.

Definition at line 1402 of file RungeKuttaPropagator.cxx.

{
  double J[25];
  Cache cache{};
  cache.m_dlt = m_dlt;
  cache.m_helixStep = m_helixStep;
  cache.m_straightStep = m_straightStep;
  cache.m_usegradient = m_usegradient;
  return propagateStraightLine(cache, true, Tp, Su, D, B, J, returnCurv);
}

propagateM()

virtual std::unique_ptr<Trk::TrackParameters> Trk::RungeKuttaPropagator::propagateM ( const EventContext &  , const TrackParameters &  , std::vector< DestSurf > &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  , std::vector< unsigned int > &  , std::vector< const Trk::TrackStateOnSurface * > *&  , std::vector< std::pair< std::unique_ptr< Trk::TrackParameters >, int >> *  , double &  , bool  , bool  , const Trk::TrackingVolume *  , Trk::ExtrapolationCache *    ) const

inlinefinaloverridevirtual

unimplemented propagateM

Implements Trk::IPropagator.

Definition at line 325 of file RungeKuttaPropagator.h.

  {
    ATH_MSG_ERROR("Call to non-implemented propagateM");
    return nullptr;
  }

propagateParameters() [1/6]

virtual bool Trk::IPatternParametersPropagator::propagateParameters ( const ::EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , double &  , ParticleHypothesis  particle = pion  ) const

pure virtualinherited

Main propagation method for parameters only with step to surface calculation.

propagateParameters() [2/6]

virtual bool Trk::IPatternParametersPropagator::propagateParameters ( const ::EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  particle = pion  ) const

pure virtualinherited

Main propagation method for parameters only.

propagateParameters() [3/6]

virtual std::unique_ptr<TrackParameters> Trk::RungeKuttaPropagator::propagateParameters ( const EventContext &  ctx, const TrackParameters &  , const Surface &  , const  PropDirection, const BoundaryCheck &  , const MagneticFieldProperties &  , ParticleHypothesis  , bool  , const TrackingVolume *    ) const

finaloverridevirtual

Main propagation method for parameters only.

Without transport jacobian production

Implements Trk::IPropagator.

propagateParameters() [4/6]

virtual std::unique_ptr<TrackParameters> Trk::RungeKuttaPropagator::propagateParameters ( const EventContext &  ctx, const TrackParameters &  , const Surface &  , const  PropDirection, const BoundaryCheck &  , const MagneticFieldProperties &  , std::optional< TransportJacobian > &  , ParticleHypothesis  , bool  , const TrackingVolume *    ) const

finaloverridevirtual

Main propagation method for parameters only with transport jacobian production.

Implements Trk::IPropagator.

propagateParameters() [5/6]

virtual bool Trk::RungeKuttaPropagator::propagateParameters ( const EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , double &  , ParticleHypothesis  particle = pion  ) const

finaloverridevirtual

Main propagation method for parameters only with step to surface calculation.

propagateParameters() [6/6]

virtual bool Trk::RungeKuttaPropagator::propagateParameters ( const EventContext &  ctx, PatternTrackParameters &  , const Surface &  , PatternTrackParameters &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  particle = pion  ) const

finaloverridevirtual

Main propagation method for parameters only.

propagateT()

virtual std::unique_ptr<Trk::TrackParameters> Trk::RungeKuttaPropagator::propagateT ( const EventContext &  , const TrackParameters &  , std::vector< DestSurf > &  , PropDirection  , const MagneticFieldProperties &  , ParticleHypothesis  , std::vector< unsigned int > &  , PathLimit &  , TimeLimit &  , bool  , const Trk::TrackingVolume *  , std::vector< Trk::HitInfo > *&    ) const

inlinefinaloverridevirtual

unimplemented propagateT

Implements Trk::IPropagator.

Definition at line 306 of file RungeKuttaPropagator.h.

  {
    ATH_MSG_ERROR("Call to non-implemented propagateT");
    return nullptr;
  }

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

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_dlt

DoubleProperty Trk::RungeKuttaPropagator::m_dlt {this, "AccuracyParameter", 0.0002}

private

Definition at line 403 of file RungeKuttaPropagator.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_fieldCondObjInputKey

SG::ReadCondHandleKey<AtlasFieldCacheCondObj> Trk::RungeKuttaPropagator::m_fieldCondObjInputKey

private

Initial value:

{
    this,
    "AtlasFieldCacheCondObj",
    "fieldCondObj",
    "Name of the Magnetic Field conditions object key"
  }

Definition at line 396 of file RungeKuttaPropagator.h.

m_helixStep

DoubleProperty Trk::RungeKuttaPropagator::m_helixStep {this, "MaxHelixStep", 1.}

private

Definition at line 404 of file RungeKuttaPropagator.h.

m_straightStep

DoubleProperty Trk::RungeKuttaPropagator::m_straightStep {this, "MaxStraightLineStep", 0.01}

private

Definition at line 405 of file RungeKuttaPropagator.h.

m_usegradient

BooleanProperty Trk::RungeKuttaPropagator::m_usegradient

private

Initial value:

{this, "IncludeBgradients", false,
    "use magnetic field gradient into the error propagation"}

Definition at line 406 of file RungeKuttaPropagator.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:

• RungeKuttaPropagator.h
• RungeKuttaPropagator.cxx