Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::DirectNavigator Class Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Propagator/DirectNavigator.hpp>

+ Collaboration diagram for Acts::DirectNavigator:

Classes

struct  State
 

Public Types

using SurfaceSequence = std::vector< const Surface * >
 The sequentially crossed surfaces.
 
using SurfaceIter = std::vector< const Surface * >::iterator
 

Public Member Functions

 DirectNavigator (std::unique_ptr< const Logger > _logger=getDefaultLogger("DirectNavigator", Logging::INFO))
 
State makeState (const Surface *startSurface, const Surface *targetSurface) const
 
void resetState (State &state, const GeometryContext &, const Vector3 &, const Vector3 &, const Surface *ssurface, const Surface *tsurface) const
 
const SurfacecurrentSurface (const State &state) const
 
const TrackingVolumecurrentVolume (const State &state) const
 
const IVolumeMaterialcurrentVolumeMaterial (const State &state) const
 
const SurfacestartSurface (const State &state) const
 
const SurfacetargetSurface (const State &state) const
 
bool targetReached (const State &state) const
 
bool endOfWorldReached (State &state) const
 
bool navigationBreak (const State &state) const
 
void currentSurface (State &state, const Surface *surface) const
 
void targetReached (State &state, bool targetReached) const
 
void navigationBreak (State &state, bool navigationBreak) const
 
template<typename propagator_state_t , typename stepper_t >
void initialize (propagator_state_t &state, const stepper_t &stepper) const
 Initialize call - start of propagation.
 
template<typename propagator_state_t , typename stepper_t >
void preStep (propagator_state_t &state, const stepper_t &stepper) const
 Navigator pre step call.
 
template<typename propagator_state_t , typename stepper_t >
void postStep (propagator_state_t &state, const stepper_t &stepper) const
 Navigator post step call.
 

Private Member Functions

const Loggerlogger () const
 

Private Attributes

std::unique_ptr< const Loggerm_logger
 

Detailed Description

DirectNavigator class

This is a fully guided navigator that progresses through a pre-given sequence of surfaces.

This can either be used as a validation tool, for truth tracking, or track refitting

Definition at line 32 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 32 of file DirectNavigator.hpp

Member Typedef Documentation

using Acts::DirectNavigator::SurfaceIter = std::vector<const Surface*>::iterator

Definition at line 36 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 36 of file DirectNavigator.hpp

using Acts::DirectNavigator::SurfaceSequence = std::vector<const Surface*>

The sequentially crossed surfaces.

Definition at line 35 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 35 of file DirectNavigator.hpp

Constructor & Destructor Documentation

Acts::DirectNavigator::DirectNavigator ( std::unique_ptr< const Logger _logger = getDefaultLogger("DirectNavigator", Logging::INFO))
inline

Definition at line 38 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 38 of file DirectNavigator.hpp

References testing::internal::move().

+ Here is the call graph for this function:

Member Function Documentation

const Surface* Acts::DirectNavigator::currentSurface ( const State state) const
inline

Definition at line 146 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 146 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::currentSurface.

void Acts::DirectNavigator::currentSurface ( State state,
const Surface surface 
) const
inline

Definition at line 179 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 179 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::currentSurface, and writeMapConfig::surface.

const TrackingVolume* Acts::DirectNavigator::currentVolume ( const State state) const
inline

Definition at line 150 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 150 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::currentVolume.

const IVolumeMaterial* Acts::DirectNavigator::currentVolumeMaterial ( const State state) const
inline

Definition at line 154 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 154 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::currentVolume, and Acts::TrackingVolume::volumeMaterial().

+ Here is the call graph for this function:

bool Acts::DirectNavigator::endOfWorldReached ( State state) const
inline

Definition at line 171 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 171 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::currentVolume.

template<typename propagator_state_t , typename stepper_t >
void Acts::DirectNavigator::initialize ( propagator_state_t &  state,
const stepper_t &  stepper 
) const
inline

Initialize call - start of propagation.

Template Parameters
propagator_state_tThe state type of the propagator
stepper_tThe type of stepper used for the propagation
Parameters
[in,out]stateis the propagation state object
[in]stepperStepper in use

Definition at line 199 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 199 of file DirectNavigator.hpp

const Logger& Acts::DirectNavigator::logger ( ) const
inlineprivate

Definition at line 300 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 300 of file DirectNavigator.hpp

References m_logger.

State Acts::DirectNavigator::makeState ( const Surface startSurface,
const Surface targetSurface 
) const
inline

Definition at line 117 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 117 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::startSurface, startSurface(), Acts::DirectNavigator::State::targetSurface, and targetSurface().

+ Here is the call graph for this function:

bool Acts::DirectNavigator::navigationBreak ( const State state) const
inline

Definition at line 175 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 175 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::navigationBreak.

Referenced by navigationBreak().

+ Here is the caller graph for this function:

void Acts::DirectNavigator::navigationBreak ( State state,
bool  navigationBreak 
) const
inline

Definition at line 187 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 187 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::navigationBreak, and navigationBreak().

+ Here is the call graph for this function:

template<typename propagator_state_t , typename stepper_t >
void Acts::DirectNavigator::postStep ( propagator_state_t &  state,
const stepper_t &  stepper 
) const
inline

Navigator post step call.

Template Parameters
propagator_state_tis the type of Propagatgor state
stepper_tis the used type of the Stepper by the Propagator
Parameters
[in,out]stateis the mutable propagator state object
[in]stepperStepper in use

Definition at line 260 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 260 of file DirectNavigator.hpp

References Acts::ACTS_VERBOSE(), distance(), Acts::if(), and m_logger.

+ Here is the call graph for this function:

template<typename propagator_state_t , typename stepper_t >
void Acts::DirectNavigator::preStep ( propagator_state_t &  state,
const stepper_t &  stepper 
) const
inline

Navigator pre step call.

Template Parameters
propagator_state_tis the type of Propagatgor state
stepper_tis the used type of the Stepper by the Propagator
Parameters
[in,out]stateis the mutable propagator state object
[in]stepperStepper in use

Definition at line 212 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 212 of file DirectNavigator.hpp

References Acts::ACTS_VERBOSE(), distance(), and m_logger.

+ Here is the call graph for this function:

void Acts::DirectNavigator::resetState ( State state,
const GeometryContext ,
const Vector3 ,
const Vector3 ,
const Surface ssurface,
const Surface tsurface 
) const
inline

Reset state

Parameters
stateis the state to reset
ssurfaceis the new starting surface
tsurfaceis the target surface

Definition at line 130 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 130 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::currentSurface, Acts::DirectNavigator::State::navSurfaceIter, Acts::DirectNavigator::State::navSurfaces, Acts::DirectNavigator::State::startSurface, and Acts::DirectNavigator::State::targetSurface.

const Surface* Acts::DirectNavigator::startSurface ( const State state) const
inline

Definition at line 161 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 161 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::startSurface.

Referenced by makeState().

+ Here is the caller graph for this function:

bool Acts::DirectNavigator::targetReached ( const State state) const
inline

Definition at line 169 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 169 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::targetReached.

Referenced by targetReached().

+ Here is the caller graph for this function:

void Acts::DirectNavigator::targetReached ( State state,
bool  targetReached 
) const
inline

Definition at line 183 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 183 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::targetReached, and targetReached().

+ Here is the call graph for this function:

const Surface* Acts::DirectNavigator::targetSurface ( const State state) const
inline

Definition at line 165 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 165 of file DirectNavigator.hpp

References Acts::DirectNavigator::State::targetSurface.

Referenced by makeState().

+ Here is the caller graph for this function:

Member Data Documentation

std::unique_ptr<const Logger> Acts::DirectNavigator::m_logger
private

Definition at line 302 of file DirectNavigator.hpp.

View newest version in sPHENIX GitHub at line 302 of file DirectNavigator.hpp

Referenced by logger(), postStep(), and preStep().


The documentation for this class was generated from the following file: