Trk::PropagationEngine Class Reference

Wrapper around the IPropagator interface, the neutral propagation is solved by using the surface::straightLineIntersection mehtod. More...

#include <PropagationEngine.h>

Inheritance diagram for Trk::PropagationEngine:

Collaboration diagram for Trk::PropagationEngine:

Public Member Functions
	PropagationEngine (const std::string &, const std::string &, const IInterface *)
	Constructor.
	~PropagationEngine ()
	Destructor.
StatusCode	initialize ()
	AlgTool initialize method.
StatusCode	finalize ()
	AlgTool finalize method.
virtual ExtrapolationCode	propagate (ExCellCharged &ecCell, const Surface &sf, PropDirection dir=alongMomentum, BoundaryCheck bcheck=true, bool returnCurvilinear=true) const
	resolve the boundary situation - for charged particles
virtual ExtrapolationCode	propagate (ExCellNeutral &enCell, const Surface &sf, PropDirection dir=alongMomentum, BoundaryCheck bcheck=true, bool returnCurvilinear=true) const
	resolve the boundary situation - for neutral particles
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 methods.

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

Protected Attributes
ToolHandle< IPropagator >	m_propagator {this, "Propagator", "Trk::RungeKuttaPropagator/AtlasRungeKuttaPropagator"}
DoubleProperty	m_pathLimitTolerance {this, "PathLimitTolerance", 0.01}
StringProperty	m_sopPrefix_prop {this, "OutputPrefix", ""}
StringProperty	m_sopPostfix_prop {this, "OutputPostfix", ""}
std::string	m_sopPrefix
	< SCREEN output formatting (SOP) - unify amongst extrapolation engines
std::string	m_sopPostfix
	prefix for screen output

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
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

Wrapper around the IPropagator interface, the neutral propagation is solved by using the surface::straightLineIntersection mehtod.

Author

Andreas Salzburger -at - cern.ch

Definition at line 36 of file PropagationEngine.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

PropagationEngine()

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

Constructor.

Definition at line 19 of file PropagationEngine.cxx.

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

~PropagationEngine()

Trk::PropagationEngine::~PropagationEngine ( )

default

Destructor.

Member Function Documentation

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

  {
    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

finalize()

StatusCode Trk::PropagationEngine::finalize

(

)

AlgTool finalize method.

Definition at line 47 of file PropagationEngine.cxx.

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

initialize()

StatusCode Trk::PropagationEngine::initialize

(

)

AlgTool initialize method.

Definition at line 31 of file PropagationEngine.cxx.

{
    m_sopPrefix = m_sopPrefix_prop;
    m_sopPostfix = m_sopPostfix_prop;
 
    if (m_propagator.retrieve().isFailure()){
        EX_MSG_FATAL( "", "initialize", "", "failed to retrieve propagator '"<< m_propagator << "'. Aborting." );
        return StatusCode::FAILURE;
    } else
        EX_MSG_DEBUG( "", "initialize", "", "successfully retrieved '" << m_propagator << "'." );
 
    EX_MSG_DEBUG( "", "initialize", "", "successful" );
    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::IPropagationEngine::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 48 of file IPropagationEngine.h.

{ return IID_IPropagationEngine; }

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.

propagate() [1/2]

Trk::ExtrapolationCode Trk::PropagationEngine::propagate ( Trk::ExCellCharged & eCell, const Surface & sf, Trk::PropDirection pDir = alongMomentum, Trk::BoundaryCheck bcheck = true, bool returnCurvilinear = true ) const

virtual

resolve the boundary situation - for charged particles

Implements Trk::IPropagationEngine.

Definition at line 55 of file PropagationEngine.cxx.

{
    EX_MSG_DEBUG(++eCell.navigationStep, "propagate", "char", "propagation engine called with charged parameters with propagation direction " << pDir );
 
    double propLength = -1.;
    if (eCell.checkConfigurationMode(Trk::ExtrapolationMode::StopWithPathLimit)){
        // the path limit
        propLength = eCell.pathLimit > 0 ? (eCell.pathLimit-eCell.pathLength) : eCell.pathLimit;
        EX_MSG_VERBOSE(eCell.navigationStep, "propagate", "char", "available step length for this propagation " << propLength );
    }
    // it is the final propagation if it is the endSurface
    bool finalPropagation = (eCell.endSurface == (&sf));
 
    std::optional<Trk::TransportJacobian> tjac{};
    // we need to first fill the propagation parameters in order to be able to updates & fallbacks
    //release, otherwise need to change the Trk::ExCell code
    auto *pParameters = m_propagator->propagate(
          Gaudi::Hive::currentContext(),
          *eCell.leadParameters,
          sf,
          pDir,
          bcheck,
          eCell.mFieldMode,
          tjac,
          propLength,
          eCell.pHypothesis,
          returnCurvilinear).release();
   // set the return type according to how the propagation went
   if (pParameters){
       // cache the last lead parameters, useful in case a navigation error occured
       eCell.lastLeadParameters = eCell.leadParameters;
       // assign the lead and end parameters
       eCell.leadParameters = pParameters;
       // check what to do with the path Length
       if (eCell.checkConfigurationMode(Trk::ExtrapolationMode::StopWithPathLimit) || propLength > 0){
           // add the new propagation length to the path length
           eCell.pathLength += propLength;
           // check if Limit reached
           if (eCell.pathLimitReached(m_pathLimitTolerance)){
               EX_MSG_VERBOSE(eCell.navigationStep, "propagate", "char", "path limit of " << eCell.pathLimit << " successfully reached -> stopping." );
               return Trk::ExtrapolationCode::SuccessPathLimit;
           }
       }
 
       // check if the propagation was called with directly, then lead parameters become end parameters
       if (eCell.checkConfigurationMode(Trk::ExtrapolationMode::Direct))
         eCell.endParameters = eCell.leadParameters;
 
       // return Success only if it is the final propagation - the extrapolation engine knows that
       return (finalPropagation ? Trk::ExtrapolationCode::SuccessDestination : Trk::ExtrapolationCode::InProgress);
   }
   // return - recovered means that the leadParameters are the input ones
   return (finalPropagation ? Trk::ExtrapolationCode::FailureDestination : Trk::ExtrapolationCode::Recovered) ;
}

propagate() [2/2]

Trk::ExtrapolationCode Trk::PropagationEngine::propagate ( Trk::ExCellNeutral & eCell, const Surface & sf, Trk::PropDirection pDir = alongMomentum, Trk::BoundaryCheck bcheck = true, bool returnCurvilinear = true ) const

virtual

resolve the boundary situation - for neutral particles

Implements Trk::IPropagationEngine.

Definition at line 115 of file PropagationEngine.cxx.

{
    EX_MSG_DEBUG(++eCell.navigationStep, "propagate", "neut", "propagation engine called with neutral parameters with propagation direction " << pDir );
    // leave this for the moment, can re replaced by an appropriate propagator call later
    if (eCell.leadParameters->covariance()){
        EX_MSG_VERBOSE(eCell.navigationStep,"propagate", "neut", "propagation of neutral parameters with covariances requested. This is not supported for the moment.");
    }
    // the pathLimit cache so far
    double cPath = eCell.pathLength;
    // it is the final propagation if it is the endSurface
    bool finalPropagation = (eCell.endSurface == (&sf));
    // intersect the surface
    Trk::Intersection sfIntersection = (pDir!=Trk::anyDirection) ? sf.straightLineIntersection(eCell.leadParameters->position(),
                                                                          pDir*eCell.leadParameters->momentum().unit(),
                                                                          true, bcheck) :
                                              sf.straightLineIntersection(eCell.leadParameters->position(),
                                              eCell.leadParameters->momentum().unit(),
                                              false, bcheck);
    // we have a valid intersection
    if (sfIntersection.valid){
        // fill the transport information - only if the propation direction is not 0 ('anyDirection')
        if (pDir!=Trk::anyDirection){
           double pLength = (sfIntersection.position-eCell.leadParameters->position()).mag();
           EX_MSG_VERBOSE(eCell.navigationStep,"propagate", "neut", "path length of " << pLength << " added to the extrapolation cell (limit = " << eCell.pathLimit << ")" );
           eCell.stepTransport(sf,pLength);
        }
        // now check if it is valud it's further away than the pathLimit
        if (eCell.pathLimitReached(m_pathLimitTolerance)){
                        // cache the last lead parameters
                        eCell.lastLeadParameters = eCell.leadParameters;
                        // create new neutral curvilinear parameters at the path limit reached
            double pDiff = eCell.pathLimit - cPath;
            eCell.leadParameters = new Trk::NeutralCurvilinearParameters(eCell.leadParameters->position()+pDiff*eCell.leadParameters->momentum().unit(),
                                                                         eCell.leadParameters->momentum(),
                                                                         0.);
            EX_MSG_VERBOSE(eCell.navigationStep,"propagate", "neut", "path limit of " << eCell.pathLimit << " reached. Stopping extrapolation.");
            return Trk::ExtrapolationCode::SuccessPathLimit;
        }
                // cache the last lead parameters
                eCell.lastLeadParameters = eCell.leadParameters;
        // now exchange the lead parameters
        // create the new curvilinear paramters at the surface intersection -> if so, trigger the success
        eCell.leadParameters = returnCurvilinear ? new Trk::NeutralCurvilinearParameters(sfIntersection.position, eCell.leadParameters->momentum(), 0.) :
                                                       sf.createUniqueNeutralParameters(sfIntersection.position, eCell.leadParameters->momentum(), 0.).release();
 
        // check if the propagation was called with directly, then lead parameters become end parameters
        if (eCell.checkConfigurationMode(Trk::ExtrapolationMode::Direct))
              eCell.endParameters = eCell.leadParameters;
 
          // return success for the final destination or in progress
        return (finalPropagation ? Trk::ExtrapolationCode::SuccessDestination : Trk::ExtrapolationCode::InProgress);
 
    } else {
        // give some screen output
        EX_MSG_VERBOSE(eCell.navigationStep,"propagate", "neut", "intersection with the surface did not succeed.");
    }
   // return - recovered means that the leadParameters are the input ones
   return (finalPropagation ? Trk::ExtrapolationCode::FailureDestination : Trk::ExtrapolationCode::Recovered) ;
}

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_pathLimitTolerance

DoubleProperty Trk::PropagationEngine::m_pathLimitTolerance {this, "PathLimitTolerance", 0.01}

protected

Definition at line 70 of file PropagationEngine.h.

{this, "PathLimitTolerance", 0.01};

m_propagator

ToolHandle<IPropagator> Trk::PropagationEngine::m_propagator {this, "Propagator", "Trk::RungeKuttaPropagator/AtlasRungeKuttaPropagator"}

protected

Definition at line 69 of file PropagationEngine.h.

{this, "Propagator", "Trk::RungeKuttaPropagator/AtlasRungeKuttaPropagator"};

m_sopPostfix

std::string Trk::IPropagationEngine::m_sopPostfix

protectedinherited

prefix for screen output

Definition at line 79 of file IPropagationEngine.h.

m_sopPostfix_prop

StringProperty Trk::PropagationEngine::m_sopPostfix_prop {this, "OutputPostfix", ""}

protected

Definition at line 72 of file PropagationEngine.h.

{this, "OutputPostfix", ""};

m_sopPrefix

std::string Trk::IPropagationEngine::m_sopPrefix

protectedinherited

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

prefix for screen output

Definition at line 78 of file IPropagationEngine.h.

m_sopPrefix_prop

StringProperty Trk::PropagationEngine::m_sopPrefix_prop {this, "OutputPrefix", ""}

protected

Definition at line 71 of file PropagationEngine.h.

{this, "OutputPrefix", ""};

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:

• PropagationEngine.h
• PropagationEngine.cxx