Acts::Navigator::Options Struct Reference

The navigator options. More...

#include <Acts/Propagator/Navigator.hpp>

Inheritance diagram for Acts::Navigator::Options:

Collaboration diagram for Acts::Navigator::Options:

Public Types
using	FreeSurfaceSelctor_t
	Delegate to decide whether free surfaces are appended to the navigation stream given the current volume and the track coordinates.

Public Member Functions
	Options (const GeometryContext &gctx)
	Constructor with geometry context.
void	insertExternalSurface (const Surface &surface)
	Insert an external surface to be considered during navigation.
void	setPlainOptions (const NavigatorPlainOptions &options)
	Set the plain navigation options.
Public Member Functions inherited from Acts::NavigatorPlainOptions
	NavigatorPlainOptions (const GeometryContext &gctx)
	NavigatorPlainOptions with context.

Public Attributes
ExternalSurfaces	externalSurfaces = {}
	Externally provided surfaces - these are tried to be hit.
double	farLimit = std::numeric_limits<double>::max()
	The far limit to resolve surfaces.
std::vector< const Surface * >	freeSurfaces = {}
	Surfaces that are not part of the tracking geometry.
FreeSurfaceSelctor_t	freeSurfaceSelector {}
double	nearLimit = s_onSurfaceTolerance
	The near limit to resolve surfaces.
double	surfaceTolerance = s_onSurfaceTolerance
	The surface tolerance.
Public Attributes inherited from Acts::NavigatorPlainOptions
std::reference_wrapper< const GeometryContext >	geoContext
	Context object for the geometry.
const Surface *	startSurface {}
const Surface *	targetSurface {}

Detailed Description

The navigator options.

Member Typedef Documentation

FreeSurfaceSelctor_t

using Acts::Navigator::Options::FreeSurfaceSelctor_t

Initial value:

 Delegate<bool(
        const GeometryContext& gctx, const TrackingVolume& currentVol,
        const Vector3& pos, const Vector3& dir, const Surface& candidate)>

Delegate to decide whether free surfaces are appended to the navigation stream given the current volume and the track coordinates.

If the delegate is set, it is called in each candidate resolution step for each surface that has not been marked as reached yet.

Parameters

gctx	Current geometry context carrying the alignment information
currentVol	The current tracking volume in which the propagator resides
pos	Position of the track in global coordinates
dir	Direction vector of the track
surface	Free surface candidate to test

Constructor & Destructor Documentation

Options()

Acts::Navigator::Options::Options ( const GeometryContext & gctx )

explicit

Constructor with geometry context.

Parameters

gctx	The geometry context for the navigation

Member Function Documentation

insertExternalSurface()

void Acts::Navigator::Options::insertExternalSurface

(

const Surface &

surface

)

Insert an external surface to be considered during navigation.

Parameters

surface

The surface to add to the list

setPlainOptions()

void Acts::Navigator::Options::setPlainOptions

(

const NavigatorPlainOptions &

options

)

Set the plain navigation options.

Parameters

options

The plain navigator options to set

Member Data Documentation

externalSurfaces

ExternalSurfaces Acts::Navigator::Options::externalSurfaces = {}

Externally provided surfaces - these are tried to be hit.

farLimit

double Acts::Navigator::Options::farLimit = std::numeric_limits<double>::max()

The far limit to resolve surfaces.

freeSurfaces

std::vector<const Surface*> Acts::Navigator::Options::freeSurfaces = {}

Surfaces that are not part of the tracking geometry.

freeSurfaceSelector

FreeSurfaceSelctor_t Acts::Navigator::Options::freeSurfaceSelector {}

nearLimit

double Acts::Navigator::Options::nearLimit = s_onSurfaceTolerance

The near limit to resolve surfaces.

surfaceTolerance

double Acts::Navigator::Options::surfaceTolerance = s_onSurfaceTolerance

The surface tolerance.