ExtrapolationEngine.icc

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
///////////////////////////////////////////////////////////////////
// ExtrapolationEngine.icc, (c) ATLAS Detector software
///////////////////////////////////////////////////////////////////
 
#include "TrkSurfaces/Surface.h"
#include "TrkVolumes/BoundarySurface.h"
#include "TrkGeometry/TrackingGeometry.h"
#include "TrkGeometry/TrackingVolume.h"
#include "TrkGeometry/Layer.h"
#include "TrkGeometry/MaterialLayer.h"
#include "TrkExInterfaces/IPropagationEngine.h"
#include "TrkExInterfaces/INavigationEngine.h"
#include <iostream>
#include <iomanip>
 
template <class T> Trk::ExtrapolationCode Trk::ExtrapolationEngine::extrapolateT(Trk::ExtrapolationCell<T>& eCell,
                                                                                 const Trk::Surface* sf,
                                                                                 Trk::PropDirection dir,
                                                                                 const Trk::BoundaryCheck& bcheck) const
{
                                                              
    EX_MSG_DEBUG(eCell.navigationStep, "extrapolate", "", "starting extrapolation sequence."); 
    // initialize the navigation
    Trk::ExtrapolationCode eCode = initNavigation<T>(eCell,sf,dir);
    EX_MSG_VERBOSE(eCell.navigationStep, "extrapolate", "", "initialize navigation with return code : " << eCode.toString() );
    // main loop over volumes 
    while (eCell.leadVolume && eCode == Trk::ExtrapolationCode::InProgress ){
        // give output that you are in the master volume loop
        EX_MSG_VERBOSE(eCell.navigationStep, "extrapolate", "loop", "processing volume (signature) : " << eCell.leadVolume->volumeName() << " (" << eCell.leadVolume->geometrySignature() << ")");
        // get the appropriate IExtrapolationEngine
        Trk::GeometryType geoType = (eCell.leadVolume->geometrySignature()>2 and eCell.leadVolume->geometrySignature()!=Trk::HGTD) ? Trk::Dense : Trk::Static;
        const Trk::IExtrapolationEngine* iee = m_eeAccessor[geoType];
        eCode = iee ? iee->extrapolate(eCell, sf, bcheck) : Trk::ExtrapolationCode::FailureConfiguration;
        // give a message about what you have
        EX_MSG_VERBOSE(eCell.navigationStep, "extrapolate", "", "returned from volume with return code : " << eCode.toString() <<
      " and geoType:"<< geoType );
    }
    EX_MSG_DEBUG(eCell.navigationStep, "extrapolate", "", "extrapolation finished with return code : " << eCode.toString() );
    // before you return, finalize: sets the leadParameters to endParameters and empties the garbage bin
    eCell.finalize(eCode);
    // return the code                                                               
    return eCode;                                                               
}
                                                          
                                                          
template <class T> Trk::ExtrapolationCode Trk::ExtrapolationEngine::initNavigation(Trk::ExtrapolationCell<T>& eCell,
                                                                                   const Trk::Surface* sf,
                                                                                   Trk::PropDirection dir) const
{
    // initialize the Navigation stream ----------------------------------------------------------------------------------------
    //
    // this is the global initialization, it only associated direct objects
    // detailed navigation search needs to be done by the sub engines (since they know best)
    EX_MSG_DEBUG(++eCell.navigationStep, "navigation", "", "initialize the navigation stream."); 
    // initialization of the navigation requires that leadParameters to be the startParameters
    eCell.leadParameters = eCell.startParameters;
    // now check the tracking geometry and retrieve it if not existing
    const TrackingGeometry &tracking_geometry = trackingGeometry();
    // ---------- START initialization -----------------------------------------------------------------------------------------
    // initialize the start parameters - try association first
    eCell.startLayer  = eCell.startLayer ? eCell.startLayer : eCell.leadParameters->associatedSurface().associatedLayer();
    eCell.startVolume = eCell.startVolume ? eCell.startVolume :
        ( eCell.startLayer ? eCell.startLayer->enclosingTrackingVolume() : 0  );
 
    if (!eCell.startVolume ||  tracking_geometry.atVolumeBoundary(eCell.startParameters->position(),eCell.startVolume,0.001)  ) {
      Trk::ExtrapolationCode eVol = m_navigationEngine->resolvePosition(eCell,dir,true);  
      if (!eVol.isSuccessOrRecovered() && !eVol.inProgress()) return eVol; 
      eCell.startVolume = eCell.leadVolume;
    } else {   
      eCell.leadVolume = eCell.startVolume;
    }
    // bail out of the start volume can not be resolved
    if (!eCell.startVolume) return Trk::ExtrapolationCode::FailureNavigation;
    // screen output
    EX_MSG_VERBOSE( eCell.navigationStep, "navigation", "", "start volume termined as : " << eCell.startVolume->volumeName() );
    // check layer association
    eCell.startLayer     = eCell.startLayer ? eCell.startLayer : eCell.startVolume->associatedLayer(eCell.leadParameters->position());
    if (eCell.startLayer)
       EX_MSG_VERBOSE( eCell.navigationStep, "navigation", "", "start layer termined with index : " << eCell.startLayer->layerIndex());
    eCell.setRadialDirection();      
    // ---------- END initialization -----------------------------------------------------------------------------------------
    if (sf){
      // keep track of the end surface    
      eCell.endSurface = sf;
      // re-evaluate the radial direction if the end surface is given
      // should not happen in FATRAS extrapolation mode
      if ( !eCell.checkConfigurationMode(Trk::ExtrapolationMode::FATRAS) )
          eCell.setRadialDirection();
      // trying association via the layer : associated layer of material layer 
      eCell.endLayer  =  sf->associatedLayer() ? sf->associatedLayer() : sf->materialLayer() ;
      eCell.endVolume = eCell.endLayer ? eCell.endLayer->enclosingTrackingVolume() : 0;
      // check if you found layer and volume
      if (!eCell.endVolume){
          EX_MSG_VERBOSE( eCell.navigationStep, "navigation", "", "end volume needs to be determinded by surface intersection." );
          // use a propagation to find the endVolume and endLayer
          // - @TODO can be opmisied (straiht line for high momentum - use directly )
          Trk::ExtrapolationCell<T> navCell(*eCell.leadParameters, dir);
          navCell.addConfigurationMode(Trk::ExtrapolationMode::Direct);
          // screen output
          Trk::ExtrapolationCode eCode = m_propagationEngine->propagate(navCell,*eCell.endSurface,Trk::anyDirection,false,eCell.navigationCurvilinear);
          // check for sucess to the destination
          CHECK_ECODE_SUCCESS_NODEST(navCell, eCode);
          // screen output 
          EX_MSG_VERBOSE (eCell.navigationStep, "navigation", "", "found endVolume and andLayer through propagation - return code : " << eCode.toString() );
          // take the lead parameters to find end volume and end layer
      eCell.endVolume = tracking_geometry.lowestTrackingVolume(navCell.endParameters->position());
      eCell.endLayer  = tracking_geometry.associatedLayer(navCell.endParameters->position());
      // memory cleanup
          delete navCell.endParameters;
      } 
      // check the final end volume configuraiton - screen output
      if (eCell.endVolume)
          EX_MSG_VERBOSE( eCell.navigationStep, "navigation", "", "end volume termined as : " << eCell.endVolume->volumeName());
      if (eCell.endLayer)
          EX_MSG_VERBOSE( eCell.navigationStep, "navigation", "", "end layer termined with index : " << eCell.endLayer->layerIndex());
    } else 
        EX_MSG_VERBOSE( eCell.navigationStep, "navigation", "", "no destination surface nor end volume provided, extrapolaiton has to stop on other means." );
    // return the progress call
    return Trk::ExtrapolationCode::InProgress;                                                          
                                                              
}