Trk::GsfExtrapolator Class Reference

#include <GsfExtrapolator.h>

Inheritance diagram for Trk::GsfExtrapolator:

Collaboration diagram for Trk::GsfExtrapolator:

Public Member Functions
	GsfExtrapolator (const std::string &, const std::string &, const IInterface *)
	Constructor with AlgTool parameters.
virtual	~GsfExtrapolator () override final
virtual StatusCode	initialize () override final
virtual MultiComponentState	extrapolate (const EventContext &ctx, Cache &, const MultiComponentState &, const Surface &, PropDirection direction, const BoundaryCheck &boundaryCheck) const override final
	Extrapolation method applying material affects.
virtual MultiComponentState	extrapolateDirectly (const EventContext &ctx, const MultiComponentState &, const Surface &, PropDirection direction, const BoundaryCheck &boundaryCheck) const override final
	Extrapolation method without material effects.
virtual Trk::ParticleHypothesis	particleHypothesis () const override final
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

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

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
MultiComponentState	extrapolateImpl (const EventContext &ctx, Cache &cache, const MultiComponentState &, const Surface &, PropDirection direction, const BoundaryCheck &boundaryCheck) const
	Implementation of main extrapolation method.
MultiComponentState	extrapolateDirectlyImpl (const EventContext &ctx, const MultiComponentState &, const Surface &, PropDirection direction, const BoundaryCheck &boundaryCheck) const
	Implementation of extrapolation without material effects.
void	extrapolateToVolumeBoundary (const EventContext &ctx, Cache &cache, const MultiComponentState &, const Layer *, const TrackingVolume &, PropDirection direction) const
	Two primary private extrapolation methods.
MultiComponentState	extrapolateInsideVolume (const EventContext &ctx, Cache &cache, const MultiComponentState &, const Surface &, const Layer *, const TrackingVolume &, PropDirection direction, const BoundaryCheck &boundaryCheck) const
MultiComponentState	extrapolateFromLayerToLayer (const EventContext &ctx, Cache &cache, const MultiComponentState &, const TrackingVolume &, const Layer *startLayer, const Layer *destinationLayer, PropDirection direction) const
	Layer stepping, stopping at the last layer before destination.
MultiComponentState	extrapolateToIntermediateLayer (const EventContext &ctx, Cache &cache, const MultiComponentState &, const Layer &, const TrackingVolume &, PropDirection direction) const
	Single extrapolation step to an intermediate layer.
MultiComponentState	extrapolateToDestinationLayer (const EventContext &ctx, Cache &cache, const MultiComponentState &, const Surface &, const Layer &, const Layer *, PropDirection direction, const BoundaryCheck &boundaryCheck) const
	Final extrapolation step to a destination layer.
std::unique_ptr< Trk::TrackParameters >	initialiseNavigation (const EventContext &ctx, Cache &cache, const MultiComponentState &initialState, const Surface &surface, const Layer *&associatedLayer, const TrackingVolume *&currentVolume, const TrackingVolume *&destinationVolume, PropDirection &direction) const
	Method to initialise navigation parameters including starting state, layer and volume, and destination volume.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IPropagator >	m_propagator {this, "Propagator", "", ""}
ToolHandle< INavigator >	m_navigator
ToolHandle< IMaterialMixtureConvolution >	m_materialUpdator
BooleanProperty	m_fastField {this, "UseFastField", false}
Trk::MagneticFieldProperties	m_fieldProperties = Trk::FullField
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 50 of file GsfExtrapolator.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

GsfExtrapolator()

Trk::GsfExtrapolator::GsfExtrapolator	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor with AlgTool parameters.

Definition at line 141 of file GsfExtrapolator.cxx.

  : AthAlgTool(type, name, parent)
{
  declareInterface<IMultiStateExtrapolator>(this);
}

~GsfExtrapolator()

Trk::GsfExtrapolator::~GsfExtrapolator ( )

finaloverridevirtualdefault

Member Function Documentation

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

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.

{ 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()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolate ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const Surface & surface, Trk::PropDirection direction, const BoundaryCheck & boundaryCheck ) const

finaloverridevirtual

Extrapolation method applying material affects.

Implements Trk::IMultiStateExtrapolator.

Definition at line 174 of file GsfExtrapolator.cxx.

{
  if (multiComponentState.empty()) {
    return {};
  }
  return extrapolateImpl(ctx,
                         cache,
                         multiComponentState,
                         surface,
                         direction,
                         boundaryCheck);
}

extrapolateDirectly()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateDirectly ( const EventContext & ctx, const MultiComponentState & multiComponentState, const Surface & surface, Trk::PropDirection direction, const BoundaryCheck & boundaryCheck ) const

finaloverridevirtual

Extrapolation method without material effects.

The particle hypothesis used.

Implements Trk::IMultiStateExtrapolator.

Definition at line 197 of file GsfExtrapolator.cxx.

{
  if (multiComponentState.empty()) {
    return {};
  }
 
  const Trk::TrackingVolume* currentVolume = m_navigator->highestVolume(ctx);
  if (!currentVolume) {
    ATH_MSG_WARNING(
      "Current tracking volume could not be determined... returning {}");
    return {};
  }
  return extrapolateDirectlyImpl(ctx,
                                 multiComponentState,
                                 surface,
                                 direction,
                                 boundaryCheck);
}

extrapolateDirectlyImpl()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateDirectlyImpl ( const EventContext & ctx, const MultiComponentState & multiComponentState, const Surface & surface, Trk::PropDirection direction, const BoundaryCheck & boundaryCheck ) const

private

Implementation of extrapolation without material effects.

Definition at line 420 of file GsfExtrapolator.cxx.

{
  return m_propagator->multiStatePropagate(ctx,
                                           multiComponentState,
                                           surface,
                                           m_fieldProperties,
                                           direction,
                                           boundaryCheck,
                                           Trk::nonInteracting);
}

extrapolateFromLayerToLayer()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateFromLayerToLayer ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const TrackingVolume & trackingVolume, const Layer * startLayer, const Layer * destinationLayer, PropDirection direction ) const

private

Layer stepping, stopping at the last layer before destination.

Definition at line 687 of file GsfExtrapolator.cxx.

{
 
  const Trk::Layer* currentLayer = startLayer;
  Trk::MultiComponentState currentState{};
 
  const Trk::TrackParameters* combinedState =
    multiComponentState.begin()->params.get();
  Amg::Vector3D currentPosition = combinedState->position();
  Amg::Vector3D currentDirection = direction * combinedState->momentum().unit();
 
  // No need to extrapolate to start layer, find the next one
  const Trk::Layer* nextLayer =
    currentLayer->nextLayer(currentPosition, currentDirection);
 
  using LayerSet = boost::container::flat_set<
    const Trk::Layer*,
    std::less<const Trk::Layer*>,
    boost::container::small_vector<const Trk::Layer*, 8>>;
  LayerSet layersHit;
 
  layersHit.insert(currentLayer);
 
  // Begin while loop over all intermediate layers
  while (nextLayer && nextLayer != destinationLayer) {
    layersHit.insert(nextLayer);
    // Only extrapolate to an intermediate layer if it requires material
    // update. Otherwise step over it
    if (nextLayer->layerMaterialProperties()) {
      currentState = extrapolateToIntermediateLayer(
          ctx,
          cache,
          !currentState.empty() ? currentState : multiComponentState,
          *nextLayer,
          trackingVolume,
          direction);
    }
 
    if (!currentState.empty()) {
      combinedState = currentState.begin()->params.get();
      currentPosition = combinedState->position();
      currentDirection = direction * combinedState->momentum().unit();
    }
 
    // Find the next layer
    currentLayer = nextLayer;
    nextLayer = currentLayer->nextLayer(currentPosition, currentDirection);
    if (layersHit.find(nextLayer) != layersHit.end()) {
      break;
    }
  }
 
  if (destinationLayer && nextLayer != destinationLayer &&
      !currentState.empty()) {
    currentState.clear();
  }
 
  return currentState;
}

extrapolateImpl()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateImpl ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const Surface & surface, Trk::PropDirection direction, const BoundaryCheck & boundaryCheck ) const

private

Implementation of main extrapolation method.

Definition at line 232 of file GsfExtrapolator.cxx.

{
 
  // Empty the garbage bin
  emptyRecycleBins(cache);
  const Trk::Layer* associatedLayer = nullptr;
  const Trk::TrackingVolume* startVolume = nullptr;
  const Trk::TrackingVolume* destinationVolume = nullptr;
  std::unique_ptr<Trk::TrackParameters> referenceParameters =
      initialiseNavigation(ctx, cache, multiComponentState, surface,
                           associatedLayer, startVolume, destinationVolume,
                           direction);
 
  // Bail to direct extrapolation if the direction cannot be determined
  if (direction == Trk::anyDirection) {
    return extrapolateDirectlyImpl(ctx,
                                   multiComponentState,
                                   surface,
                                   direction,
                                   boundaryCheck);
  }
 
  const Trk::TrackParameters* combinedState =
    multiComponentState.begin()->params.get();
 
  const Trk::MultiComponentState* currentState = &multiComponentState;
 
  /* Define the initial distance between destination and current position.
     Destination should be determined from either
     - reference parameters (prefered if they exist) or
     - destination surface
     */
  const Amg::Vector3D globalSeparation =
    referenceParameters
      ? referenceParameters->position() - combinedState->position()
      : surface.globalReferencePoint() - combinedState->position();
  const double initialDistance = globalSeparation.mag();
  // Clean up memory from combiner. It is no longer needed
  combinedState = nullptr;
 
  /* There are two parts to the extrapolation:
     - Extrapolate from start point to volume boundary
     - Extrapolate from volume boundary to destination surface
     */
  /*
   * Extrapolation to destination volume boundary
   */
  bool foundFinalBoundary(true);
  int fallbackOscillationCounter(0);
  const Trk::TrackingVolume* currentVolume = startVolume;
  const Trk::TrackingVolume* previousVolume = nullptr;
 
  while (currentVolume && currentVolume != destinationVolume) {
    // Extrapolate to volume boundary
    extrapolateToVolumeBoundary(ctx,
                                cache,
                                *currentState,
                                associatedLayer,
                                *currentVolume,
                                direction);
 
    // New current state is the state extrapolated to the tracking volume
    // boundary.
    currentState = cache.m_stateAtBoundary;
    // The volume that the extrapolation is about to enter into is called the
    // nextVolume
    const Trk::TrackingVolume* nextVolume = cache.m_trackingVolume;
    // Break the loop if the next tracking volume is the same as the current one
    if (!nextVolume || nextVolume == currentVolume) {
      foundFinalBoundary = false;
      break;
    }
    // Break the loop if an oscillation is detected
    if (previousVolume == nextVolume) {
      ++fallbackOscillationCounter;
    }
    if (fallbackOscillationCounter > 10) {
      foundFinalBoundary = false;
      break;
    }
    // Break the loop if the distance between the surface and the track
    // parameters has increased
    combinedState = currentState->begin()->params.get();
 
    auto parametersAtDestination =
      m_propagator->propagateParameters(ctx,
                                        *combinedState,
                                        surface,
                                        direction,
                                        false,
                                        m_fieldProperties,
                                        Trk::nonInteracting);
    Amg::Vector3D newDestination;
    if (parametersAtDestination) {
      newDestination = parametersAtDestination->position();
      // delete parametersAtDestination;
    } else {
      newDestination = surface.center();
    }
 
    const double revisedDistance =
        (cache.m_navigationParameters->position() - newDestination).mag();
 
    const double distanceChange = std::abs(revisedDistance - initialDistance);
 
    if (revisedDistance > initialDistance && distanceChange > 0.01) {
      foundFinalBoundary = false;
      break;
    }
 
    combinedState = nullptr;
    // Initialise the oscillation checker
    previousVolume = currentVolume;
    // As the extrapolation is moving into the next volume, the next volume ->
    // current volume
    currentVolume = nextVolume;
    // Associated layer now needs to be reset
    // if(!entryLayerFound)
    associatedLayer = nullptr;
  } // end while loop
 
  // catch failures now
  if (!currentState || (currentVolume != destinationVolume)) {
    currentState = &multiComponentState;
    foundFinalBoundary = false;
  }
 
  if (!foundFinalBoundary) {
    Trk::MultiComponentState bailOutState =
      m_propagator->multiStatePropagate(ctx,
                                        *currentState,
                                        surface,
                                        m_fieldProperties,
                                        Trk::anyDirection,
                                        boundaryCheck,
                                        Trk::nonInteracting);
 
    emptyRecycleBins(cache);
    return bailOutState;
  }
 
  /*
   * Extrapolation from volume boundary to surface
   */
 
  // extrapolate inside destination volume
  Trk::MultiComponentState destinationState =
    extrapolateInsideVolume(ctx,
                            cache,
                            *currentState,
                            surface,
                            associatedLayer,
                            *currentVolume,
                            direction,
                            boundaryCheck);
 
  // FALLBACK POINT: Crisis if extrapolation fails here... As per extrapolation
  // to volume boundary, in emergency revert to extrapolateDirectly
 
  // or we failed to reach the target
  if (!destinationState.empty() &&
      &((*(destinationState.begin())).params->associatedSurface()) != &surface) {
    destinationState.clear();
  }
 
  if (destinationState.empty()) {
    destinationState = m_propagator->multiStatePropagate(ctx,
                                                         *currentState,
                                                         surface,
                                                         m_fieldProperties,
                                                         Trk::anyDirection,
                                                         boundaryCheck,
                                                         Trk::nonInteracting);
  }
  emptyRecycleBins(cache);
  return destinationState;
}

extrapolateInsideVolume()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateInsideVolume ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const Surface & surface, const Layer * layer, const TrackingVolume & trackingVolume, Trk::PropDirection direction, const BoundaryCheck & boundaryCheck ) const

private

Definition at line 569 of file GsfExtrapolator.cxx.

{
  //curent state is a plainn ptr to keep track
  const Trk::MultiComponentState* currentState = &multiComponentState;
 
  // Retrieve the destination layer
  // 1. Association
  const Trk::Layer* destinationLayer = surface.associatedLayer();
 
  // 2. Recall and Global Search
  if (!destinationLayer) {
    destinationLayer =
      (&surface == cache.m_recallSurface)
        ? cache.m_recallLayer
        : trackingVolume.associatedLayer(surface.globalReferencePoint());
  }
 
  // Retrieve the current layer
  // Produce a combined state
  const Trk::TrackParameters* combinedState =
      currentState->begin()->params.get();
 
  const Trk::Layer* associatedLayer = layer;
 
  Trk::MultiComponentState updatedState{};
  if (!associatedLayer) {
    // Get entry layer but do not use it as  it should have already be hit if it
    // was desired
    associatedLayer = trackingVolume.associatedLayer(combinedState->position());
    associatedLayer =
      associatedLayer
        ? associatedLayer
        : trackingVolume.nextLayer(combinedState->position(),
                                   direction * combinedState->momentum().unit(),
                                   associatedLayer);
  }
 
  else if (associatedLayer != destinationLayer &&
           trackingVolume.confinedLayers() &&
           associatedLayer->layerMaterialProperties()) {
 
    updatedState = m_materialUpdator->postUpdate(cache.m_materialEffectsCaches,
                                                 *currentState,
                                                 *associatedLayer,
                                                 direction);
 
    if (!updatedState.empty()) {
      // Refresh the current state pointer
      currentState = &updatedState;
    }
  }
 
  // Reset combined state target
  combinedState = nullptr;
  Trk::MultiComponentState nextState{};
  if (destinationLayer) {
    // If there are intermediate layers then additional extrapolations need to
    // be done
    if (associatedLayer && associatedLayer != destinationLayer) {
      nextState = extrapolateFromLayerToLayer(ctx,
                                              cache,
                                              *currentState,
                                              trackingVolume,
                                              associatedLayer,
                                              destinationLayer,
                                              direction);
 
      // currentState is now the next
      if (!nextState.empty()) {
        // Refresh the current state pointer
        currentState = &nextState;
      }
    }
    // Final extrapolation to destination surface
    Trk::MultiComponentState returnState =
      extrapolateToDestinationLayer(ctx,
                                    cache,
                                    *currentState,
                                    surface,
                                    *destinationLayer,
                                    associatedLayer,
                                    direction,
                                    boundaryCheck);
    // Set the information for the current layer, surface, tracking volume
    setRecallInformation(cache, surface, *destinationLayer, trackingVolume);
    return returnState;
  }
 
  // FALLBACK POINT: If no destination layer is found fall-back and extrapolate
  // directly
  Trk::MultiComponentState returnState =
    m_propagator->multiStatePropagate(ctx,
                                      *currentState,
                                      surface,
                                      m_fieldProperties,
                                      direction,
                                      boundaryCheck,
                                      Trk::nonInteracting);
 
  // No destination layer exists so layer recall method cannot be used and
  // should be reset
  resetRecallInformation(cache);
 
  return returnState;
}

extrapolateToDestinationLayer()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateToDestinationLayer ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const Surface & surface, const Layer & layer, const Layer * startLayer, Trk::PropDirection direction, const BoundaryCheck & boundaryCheck ) const

private

Final extrapolation step to a destination layer.

Definition at line 825 of file GsfExtrapolator.cxx.

{
 
  const Trk::MultiComponentState* initialState = &multiComponentState;
  const Trk::TrackParameters* combinedState = nullptr;
 
  // Propagate over all components
  Trk::MultiComponentState destinationState =
    m_propagator->multiStatePropagate(ctx,
                                      multiComponentState,
                                      surface,
                                      m_fieldProperties,
                                      direction,
                                      boundaryCheck,
                                      Trk::nonInteracting);
 
  // Require a fall-back if the initial state is close to the destination
  // surface then a fall-back solution is required
 
  if (destinationState.empty()) {
    combinedState = initialState->begin()->params.get();
    if (surface.isOnSurface(
          combinedState->position(), true, 0.5 * layer.thickness())) {
      destinationState = m_propagator->multiStatePropagate(ctx,
                                                           *initialState,
                                                           surface,
                                                           m_fieldProperties,
                                                           Trk::anyDirection,
                                                           boundaryCheck,
                                                           Trk::nonInteracting);
    }
    combinedState = nullptr;
    if (destinationState.empty()) {
      return {};
    }
  }
 
  /* ----------------------------------------
     Material effects
     ---------------------------------------- */
 
  Trk::MultiComponentState updatedState{};
  if (startLayer != &layer) {
    updatedState = m_materialUpdator->preUpdate(cache.m_materialEffectsCaches,
                                                destinationState,
                                                layer,
                                                direction);
  }
 
  if (updatedState.empty()) {
    return destinationState;
  }
 
  return updatedState;
}

extrapolateToIntermediateLayer()

Trk::MultiComponentState Trk::GsfExtrapolator::extrapolateToIntermediateLayer ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const Layer & layer, const TrackingVolume & trackingVolume, Trk::PropDirection direction ) const

private

Single extrapolation step to an intermediate layer.

Definition at line 758 of file GsfExtrapolator.cxx.

{
  const Trk::MultiComponentState* initialState = &multiComponentState;
 
  // Propagate over all components
  Trk::MultiComponentState destinationState =
    m_propagator->multiStatePropagate(ctx,
                                      *initialState,
                                      layer.surfaceRepresentation(),
                                      m_fieldProperties,
                                      direction,
                                      true,
                                      Trk::nonInteracting);
 
  if (destinationState.empty()) {
    return {};
  }
 
  // the layer has been intersected
  // ------------------------------------------------------------------------
  // check for radial direction change
  // ---------------------------------------------------------------------
  const int rDirection = radialDirection(multiComponentState, direction);
  const int newrDirection = radialDirection(destinationState, direction);
  if (newrDirection != rDirection) {
    // it is unfortunate that the cancelling could invalidate the material
    // collection
    // reset the nextParameters if the radial change is not allowed
    //  resetting is ok - since the parameters are in the garbage bin already
    if (!radialDirectionCheck(ctx,
                              *m_propagator,
                              multiComponentState,
                              destinationState,
                              trackingVolume,
                              m_fieldProperties,
                              direction)) {
      return {};
    }
  }
 
  /* -------------------------------------
     Material effects
     ------------------------------------- */
 
  Trk::MultiComponentState updatedState =
    m_materialUpdator->update(cache.m_materialEffectsCaches,
                              destinationState,
                              layer,
                              direction);
 
  if (updatedState.empty()) {
    return destinationState;
  }
 
  return updatedState;
}

extrapolateToVolumeBoundary()

void Trk::GsfExtrapolator::extrapolateToVolumeBoundary ( const EventContext & ctx, Cache & cache, const MultiComponentState & multiComponentState, const Layer * layer, const TrackingVolume & trackingVolume, Trk::PropDirection direction ) const

private

Two primary private extrapolation methods.

• extrapolateToVolumeBoundary : extrapolates to the exit of the destination tracking volume The exit layer surface will be hit in this method.
• extrapolateInsideVolume : extrapolates to the destination surface in the final tracking volume

Definition at line 440 of file GsfExtrapolator.cxx.

{
 
  //We 1st point to the input.
  //As we move on we might change to point to the
  //last element held by
  //cache.m_mcsRecycleBin
  cache.m_stateAtBoundary = &multiComponentState;
 
  const Trk::TrackParameters* combinedState =
      cache.m_stateAtBoundary->begin()->params.get();
  const Trk::Layer* associatedLayer = layer;
 
  if (!associatedLayer) {
    // Get entry layer but do not use it as  it should have already be hit if it
    // was desired
    associatedLayer = trackingVolume.associatedLayer(combinedState->position());
    associatedLayer = associatedLayer
                          ? associatedLayer
                          : trackingVolume.nextLayer(
                                combinedState->position(),
                                direction * combinedState->momentum().unit(),
                                associatedLayer);
  }
  // Only loop over layers if they can be found within the tracking volume
  else if (trackingVolume.confinedLayers() &&
           associatedLayer->layerMaterialProperties()) {
    Trk::MultiComponentState updatedState = m_materialUpdator->postUpdate(
        cache.m_materialEffectsCaches,
        *(cache.m_stateAtBoundary),
        *layer,
        direction);
 
    if (!updatedState.empty()) {
      addMultiComponentToCache(cache,std::move(updatedState));
    }
  }
 
  // If an associated surface can be found, extrapolation within the tracking
  // volume is mandatory This will take extrapolate to the last layer in the
  // volume
  if (associatedLayer) {
    Trk::MultiComponentState nextState = extrapolateFromLayerToLayer(
        ctx,
        cache,
        *(cache.m_stateAtBoundary),
        trackingVolume,
        associatedLayer,
        nullptr,
        direction);
    // if we have a next State update the currentState
    if (!nextState.empty()) {
      addMultiComponentToCache(cache,std::move(nextState));
    }
  }
 
  /* =============================================
     Find the boundary surface using the navigator
     ============================================= */
 
  Trk::NavigationCell nextNavigationCell(nullptr, nullptr);
 
  combinedState = cache.m_stateAtBoundary->begin()->params.get();
 
  const Trk::TrackingVolume* nextVolume = nullptr;
  const Trk::TrackParameters* navigationParameters =
    cache.m_navigationParameters
      ? cache.m_navigationParameters.get()
      : combinedState;
 
  nextNavigationCell = m_navigator->nextTrackingVolume(
    ctx, *m_propagator, *navigationParameters, direction, trackingVolume);
 
  nextVolume = nextNavigationCell.nextVolume;
 
  std::unique_ptr<Trk::TrackParameters> nextNavigationParameters =
      std::move(nextNavigationCell.parametersOnBoundary);
 
  if (!nextVolume) {
    // Reset the layer recall
    resetRecallInformation(cache);
  }
 
  if (useBoundaryMaterialUpdate) {
    // Check for two things:
    // 1. If the next volume was found
    // 2. If there is material associated with the boundary layer.
    // If so, apply material effects update.
 
    // Get layer associated with boundary surface.
    const Trk::MaterialLayer * layerAtBoundary =
      (nextNavigationCell.parametersOnBoundary)
        ? (nextNavigationCell.parametersOnBoundary->associatedSurface())
            .materialLayer()
        : nullptr;
    Trk::MultiComponentState matUpdatedState{};
    if (nextVolume && layerAtBoundary) {
      if (layerAtBoundary->layerMaterialProperties()) {
        matUpdatedState = m_materialUpdator->postUpdate(
            cache.m_materialEffectsCaches,
            *(cache.m_stateAtBoundary),
            *layerAtBoundary,
            direction);
      }
    }
 
    // If state has changed due to boundary material, modify state, parameters
    // accordingly.
    if (!matUpdatedState.empty()) {
      addMultiComponentToCache(cache, std::move(matUpdatedState));
      nextNavigationParameters =
          cache.m_stateAtBoundary->begin()->params->uniqueClone();
    }
  }
  // Update the rest of the boundary information in the cache
  cache.m_navigationParameters = std::move(nextNavigationParameters);
  cache.m_trackingVolume = nextVolume;
}

initialiseNavigation()

std::unique_ptr< Trk::TrackParameters > Trk::GsfExtrapolator::initialiseNavigation ( const EventContext & ctx, Cache & cache, const MultiComponentState & initialState, const Surface & surface, const Layer *& associatedLayer, const TrackingVolume *& currentVolume, const TrackingVolume *& destinationVolume, Trk::PropDirection & direction ) const

private

Method to initialise navigation parameters including starting state, layer and volume, and destination volume.

Definition at line 893 of file GsfExtrapolator.cxx.

{
  //Get the highest weight parameters. We will just use those
  const Trk::TrackParameters* combinedState = multiComponentState.begin()->params.get();
  /* =============================================
     Look for current volume
     ============================================= */
  // 1. See if the current layer is associated with a tracking volume
  const Trk::Surface* associatedSurface = &(combinedState->associatedSurface());
  currentLayer = associatedSurface ? associatedSurface->associatedLayer() : currentLayer;
  currentVolume = currentLayer ? currentLayer->enclosingTrackingVolume() : currentVolume;
  // If the association method failed
  if (!currentVolume) {
    //Try the recall in case the associatedSurface is the recall one
    if (associatedSurface == cache.m_recallSurface) {
      currentVolume = cache.m_recallTrackingVolume;
      currentLayer = cache.m_recallLayer;
    }
    // Global search method if this fails
    else {
      // If the recall method fails reset the cache
      resetRecallInformation(cache);
      currentVolume = m_navigator->volume(ctx, combinedState->position());
      currentLayer = currentVolume
              ? currentVolume->associatedLayer(combinedState->position())
              : nullptr;
    }
  }
  /* =============================================
     Determine the resolved direction
     ============================================= */
  std::unique_ptr<Trk::TrackParameters> referenceParameters =
      currentVolume ? m_propagator->propagateParameters(
                          ctx, *combinedState, surface, direction, false,
                          m_fieldProperties, Trk::nonInteracting)
                    : nullptr;
  // Find concrete direction based on reference parameters
  if (direction == Trk::anyDirection && referenceParameters) {
    const Amg::Vector3D surfaceDirection(referenceParameters->position() -
                                         combinedState->position());
    direction = (surfaceDirection.dot(combinedState->momentum()) > 0.)
                    ? Trk::alongMomentum
                    : Trk::oppositeMomentum;
  }
  /* =============================================
     Look for destination volume
     ============================================= */
  // See if the destination layer is associated with a tracking volume
  destinationVolume = surface.associatedLayer()
                          ? surface.associatedLayer()->enclosingTrackingVolume()
                          : nullptr;
  // Association failed
  if (!destinationVolume) {
    // See if the cached recall surface is the destination one
    if (&surface == cache.m_recallSurface) {
      destinationVolume = cache.m_recallTrackingVolume;
    } else {
      // Global search of tracking geometry to find the destination volume
      destinationVolume = m_navigator->volume(
          ctx, referenceParameters ? referenceParameters->position()
                                   : surface.globalReferencePoint());
    }
  }
  return referenceParameters;
}

initialize()

StatusCode Trk::GsfExtrapolator::initialize ( )

finaloverridevirtual

Definition at line 152 of file GsfExtrapolator.cxx.

{
 
  ATH_CHECK(m_propagator.retrieve());
  ATH_CHECK(m_navigator.retrieve());
  ATH_CHECK(m_materialUpdator.retrieve());
  m_fieldProperties = m_fastField
                          ? Trk::MagneticFieldProperties(Trk::FastField)
                          : Trk::MagneticFieldProperties(Trk::FullField);
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

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

inlinestaticinherited

AlgTool interface method.

Definition at line 75 of file IMultiStateExtrapolator.h.

  {
    return IID_IMultiStateExtrapolator;
  };

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

particleHypothesis()

virtual Trk::ParticleHypothesis Trk::GsfExtrapolator::particleHypothesis ( ) const

inlinefinaloverridevirtual

Implements Trk::IMultiStateExtrapolator.

Definition at line 79 of file GsfExtrapolator.h.

                                                                         {
    return m_materialUpdator->particleHypothesis();
  }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_fastField

BooleanProperty Trk::GsfExtrapolator::m_fastField {this, "UseFastField", false}

private

Definition at line 174 of file GsfExtrapolator.h.

{this, "UseFastField", false};

m_fieldProperties

Trk::MagneticFieldProperties Trk::GsfExtrapolator::m_fieldProperties = Trk::FullField

private

Definition at line 176 of file GsfExtrapolator.h.

m_materialUpdator

ToolHandle<IMaterialMixtureConvolution> Trk::GsfExtrapolator::m_materialUpdator

private

Initial value:

{
      this, "GsfMaterialConvolution", "", "Gsf Material effects"}

Definition at line 172 of file GsfExtrapolator.h.

                                                           {
      this, "GsfMaterialConvolution", "", "Gsf Material effects"};

m_navigator

ToolHandle<INavigator> Trk::GsfExtrapolator::m_navigator

private

Initial value:

{this, "Navigator",
                                     "Trk::Navigator/Navigator", ""}

Definition at line 170 of file GsfExtrapolator.h.

                                    {this, "Navigator",
                                     "Trk::Navigator/Navigator", ""};

m_propagator

ToolHandle<IPropagator> Trk::GsfExtrapolator::m_propagator {this, "Propagator", "", ""}

private

Definition at line 169 of file GsfExtrapolator.h.

{this, "Propagator", "", ""};

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:

• GsfExtrapolator.h
• GsfExtrapolator.cxx