ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
Acts::PropagatorOptions< action_list_t, aborter_list_t > Struct Template Reference

Options for propagate() call. More...

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

+ Inheritance diagram for Acts::PropagatorOptions< action_list_t, aborter_list_t >:
+ Collaboration diagram for Acts::PropagatorOptions< action_list_t, aborter_list_t >:

Public Types

using action_list_type = action_list_t
 
using aborter_list_type = aborter_list_t
 

Public Member Functions

 PropagatorOptions ()=delete
 Delete default contructor.
 
 PropagatorOptions (const PropagatorOptions< action_list_t, aborter_list_t > &po)=default
 PropagatorOptions copy constructor.
 
 PropagatorOptions (std::reference_wrapper< const GeometryContext > gctx, std::reference_wrapper< const MagneticFieldContext > mctx)
 PropagatorOptions with context.
 
template<typename extended_aborter_list_t >
PropagatorOptions
< action_list_t,
extended_aborter_list_t > 		extend (extended_aborter_list_t aborters) const
 Expand the Options with extended aborters.
 

Public Attributes

NavigationDirection direction = forward
 Propagation direction.
 
int absPdgCode = 211
 The |pdg| code for (eventual) material integration - pion default.
 
double mass = 139.57018 * UnitConstants::MeV
 The mass for the particle for (eventual) material integration.
 
unsigned int maxSteps = 1000
 Maximum number of steps for one propagate call.
 
unsigned int maxRungeKuttaStepTrials = 10000
 Maximum number of Runge-Kutta steps for the stepper step call.
 
double maxStepSize = std::numeric_limits<double>::max()
 Absolute maximum step size.
 
double pathLimit = std::numeric_limits<double>::max()
 Absolute maximum path length.
 
double targetTolerance = s_onSurfaceTolerance
 Required tolerance to reach target (surface, pathlength)
 
bool loopProtection = true
 Loop protection step, it adapts the pathLimit.
 
double loopFraction = 0.5
 Allowed loop fraction, 1 is a full loop.
 
bool debug = false
 Debug output steering:
 
std::string debugString = ""
 the string to collect msgs
 
size_t debugPfxWidth = 30
 the prefix width
 
size_t debugMsgWidth = 50
 the mesage width
 
double tolerance = 1e-4
 Tolerance for the error of the integration.
 
double stepSizeCutOff = 0.
 Cut-off value for the step size.
 
action_list_t actionList
 List of actions.
 
aborter_list_t abortList
 List of abort conditions.
 
std::reference_wrapper< const
GeometryContext > 		geoContext
 The context object for the geometry.
 
std::reference_wrapper< const
MagneticFieldContext > 		magFieldContext
 The context object for the magnetic field.
 

Detailed Description

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
struct Acts::PropagatorOptions< action_list_t, aborter_list_t >

Options for propagate() call.

Template Parameters
action_list_tList of action types called after each propagation step with the current propagation and stepper state
aborter_list_tList of abort conditions tested after each propagation step using the current propagation and stepper state

Definition at line 69 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 69 of file Propagator.hpp

Member Typedef Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
using Acts::PropagatorOptions< action_list_t, aborter_list_t >::aborter_list_type = aborter_list_t

Definition at line 71 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 71 of file Propagator.hpp

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
using Acts::PropagatorOptions< action_list_t, aborter_list_t >::action_list_type = action_list_t

Definition at line 70 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 70 of file Propagator.hpp

Constructor & Destructor Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
Acts::PropagatorOptions< action_list_t, aborter_list_t >::PropagatorOptions ( )
delete

Delete default contructor.

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
Acts::PropagatorOptions< action_list_t, aborter_list_t >::PropagatorOptions ( const PropagatorOptions< action_list_t, aborter_list_t > &  po)
default

PropagatorOptions copy constructor.

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
Acts::PropagatorOptions< action_list_t, aborter_list_t >::PropagatorOptions ( std::reference_wrapper< const GeometryContext >  gctx,
std::reference_wrapper< const MagneticFieldContext >  mctx 
)
inline

PropagatorOptions with context.

Definition at line 81 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 81 of file Propagator.hpp

Member Function Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
template<typename extended_aborter_list_t >
PropagatorOptions<action_list_t, extended_aborter_list_t> Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend ( extended_aborter_list_t  aborters) const
inline

Expand the Options with extended aborters.

Template Parameters
extended_aborter_list_tType of the new aborter list
Parameters
abortersThe new aborter list to be used (internally)

Definition at line 91 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 91 of file Propagator.hpp

References Acts::PropagatorOptions< action_list_t, aborter_list_t >::abortList, kdfinder::abs(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::absPdgCode, Acts::PropagatorOptions< action_list_t, aborter_list_t >::actionList, Acts::PropagatorOptions< action_list_t, aborter_list_t >::debug, Acts::PropagatorOptions< action_list_t, aborter_list_t >::debugMsgWidth, Acts::PropagatorOptions< action_list_t, aborter_list_t >::debugPfxWidth, Acts::PropagatorOptions< action_list_t, aborter_list_t >::debugString, Acts::PropagatorOptions< action_list_t, aborter_list_t >::direction, Acts::PropagatorOptions< action_list_t, aborter_list_t >::geoContext, Acts::PropagatorOptions< action_list_t, aborter_list_t >::loopFraction, Acts::PropagatorOptions< action_list_t, aborter_list_t >::loopProtection, Acts::PropagatorOptions< action_list_t, aborter_list_t >::magFieldContext, Acts::PropagatorOptions< action_list_t, aborter_list_t >::mass, Acts::PropagatorOptions< action_list_t, aborter_list_t >::maxRungeKuttaStepTrials, Acts::PropagatorOptions< action_list_t, aborter_list_t >::maxSteps, Acts::PropagatorOptions< action_list_t, aborter_list_t >::maxStepSize, Acts::PropagatorOptions< action_list_t, aborter_list_t >::pathLimit, Acts::PropagatorOptions< action_list_t, aborter_list_t >::stepSizeCutOff, Acts::PropagatorOptions< action_list_t, aborter_list_t >::targetTolerance, and Acts::PropagatorOptions< action_list_t, aborter_list_t >::tolerance.

+ Here is the call graph for this function:

Member Data Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
aborter_list_t Acts::PropagatorOptions< action_list_t, aborter_list_t >::abortList

List of abort conditions.

Definition at line 169 of file Propagator.hpp.

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

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
int Acts::PropagatorOptions< action_list_t, aborter_list_t >::absPdgCode = 211

The |pdg| code for (eventual) material integration - pion default.

Definition at line 125 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 125 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
action_list_t Acts::PropagatorOptions< action_list_t, aborter_list_t >::actionList

List of actions.

Definition at line 166 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 166 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::Test::BOOST_DATA_TEST_CASE(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t, input_converter_t, output_converter_t >::findTracks(), and Acts::KalmanFitter< propagator_t, updater_t, smoother_t, outlier_finder_t, calibrator_t, input_converter_t, output_converter_t >::fit().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
bool Acts::PropagatorOptions< action_list_t, aborter_list_t >::debug = false

Debug output steering:

switch debug on

Definition at line 153 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 153 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE(), Acts::Test::BOOST_DATA_TEST_CASE(), Acts::IntegrationTest::constant_field_propagation(), Acts::IntegrationTest::covariance_bound(), Acts::IntegrationTest::covariance_curvilinear(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::IntegrationTest::foward_backward(), Acts::VolumeMaterialMapper::mapMaterialTrack(), Acts::SurfaceMaterialMapper::mapMaterialTrack(), Acts::IntegrationTest::to_cylinder(), and Acts::IntegrationTest::to_surface().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
size_t Acts::PropagatorOptions< action_list_t, aborter_list_t >::debugMsgWidth = 50

the mesage width

Definition at line 156 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 156 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
size_t Acts::PropagatorOptions< action_list_t, aborter_list_t >::debugPfxWidth = 30

the prefix width

Definition at line 155 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 155 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
std::string Acts::PropagatorOptions< action_list_t, aborter_list_t >::debugString = ""

the string to collect msgs

Definition at line 154 of file Propagator.hpp.

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

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
NavigationDirection Acts::PropagatorOptions< action_list_t, aborter_list_t >::direction = forward

Propagation direction.

Definition at line 122 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 122 of file Propagator.hpp

Referenced by FW::TruthVerticesToTracksAlgorithm::execute(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::IntegrationTest::foward_backward().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
std::reference_wrapper<const GeometryContext> Acts::PropagatorOptions< action_list_t, aborter_list_t >::geoContext

The context object for the geometry.

Definition at line 172 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 172 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::loopFraction = 0.5

Allowed loop fraction, 1 is a full loop.

Definition at line 147 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 147 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
bool Acts::PropagatorOptions< action_list_t, aborter_list_t >::loopProtection = true

Loop protection step, it adapts the pathLimit.

Definition at line 146 of file Propagator.hpp.

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

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
std::reference_wrapper<const MagneticFieldContext> Acts::PropagatorOptions< action_list_t, aborter_list_t >::magFieldContext

The context object for the magnetic field.

Definition at line 175 of file Propagator.hpp.

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

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::mass = 139.57018 * UnitConstants::MeV

The mass for the particle for (eventual) material integration.

Definition at line 128 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 128 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
unsigned int Acts::PropagatorOptions< action_list_t, aborter_list_t >::maxRungeKuttaStepTrials = 10000

Maximum number of Runge-Kutta steps for the stepper step call.

Definition at line 134 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 134 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
unsigned int Acts::PropagatorOptions< action_list_t, aborter_list_t >::maxSteps = 1000

Maximum number of steps for one propagate call.

Definition at line 131 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 131 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t, input_converter_t, output_converter_t >::findTracks().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::maxStepSize = std::numeric_limits<double>::max()

Absolute maximum step size.

Definition at line 137 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 137 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::Test::BOOST_DATA_TEST_CASE(), Acts::IntegrationTest::constant_field_propagation(), Acts::IntegrationTest::covariance_bound(), Acts::IntegrationTest::covariance_curvilinear(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::IntegrationTest::foward_backward(), Acts::IntegrationTest::to_cylinder(), and Acts::IntegrationTest::to_surface().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::pathLimit = std::numeric_limits<double>::max()

Absolute maximum path length.

Definition at line 140 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 140 of file Propagator.hpp

Referenced by Acts::Test::BOOST_DATA_TEST_CASE(), BOOST_DATA_TEST_CASE(), Acts::IntegrationTest::constant_field_propagation(), Acts::IntegrationTest::covariance_bound(), Acts::IntegrationTest::covariance_curvilinear(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::IntegrationTest::foward_backward(), main(), Acts::IntegrationTest::to_cylinder(), and Acts::IntegrationTest::to_surface().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::stepSizeCutOff = 0.

Cut-off value for the step size.

Definition at line 163 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 163 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::targetTolerance = s_onSurfaceTolerance

Required tolerance to reach target (surface, pathlength)

Definition at line 143 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 143 of file Propagator.hpp

Referenced by Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
double Acts::PropagatorOptions< action_list_t, aborter_list_t >::tolerance = 1e-4

Tolerance for the error of the integration.

Definition at line 160 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 160 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::IntegrationTest::covariance_curvilinear(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend().

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