detray::actor::pointwise_material_interactor< algebra_t > Struct Template Reference

Apply energy-loss and multiple-scattering effects at material surfaces. More...

#include <detray/propagator/actors/pointwise_material_interactor.hpp>

Inheritance diagram for detray::actor::pointwise_material_interactor< algebra_t >:

Collaboration diagram for detray::actor::pointwise_material_interactor< algebra_t >:

Classes
struct	kernel
	Material store visitor. More...
struct	state
	Per-surface material effects and their application settings. More...

Public Types
using	algebra_type = algebra_t
	Algebra backend type.
using	bound_matrix_type = bound_matrix<algebra_t>
	Bound covariance matrix type.
using	bound_param_vector_type = bound_parameters_vector<algebra_t>
	Bound track-parameter vector type.
using	interaction_type = interaction<scalar_type>
	Material interaction calculator type.
using	scalar_type = dscalar<algebra_t>
	Scalar type used for material calculations.
using	transform3_type = dtransform3D<algebra_t>
	Three-dimensional transform type.
using	vector3_type = dvector3D<algebra_t>
	Three-dimensional vector type.

Public Member Functions
template<typename propagator_state_t>
void	operator() (state &interactor_state, propagator_state_t &prop_state, parameter_transporter_result< algebra_t > &res) const
	Apply material effects after parameter transport reaches a surface.
template<typename context_t, typename surface_t>
bool	update (const context_t gctx, const pdg_particle< scalar_type > &ptc, bound_track_parameters< algebra_t > &bound_params, state &interactor_state, const int nav_dir, const surface_t &sf) const
	Update the bound track parameter.
void	update_angle_variance (bound_matrix_type &covariance, const vector3_type &dir, const scalar_type projected_scattering_angle) const
	Update the variance of phi and theta of bound track parameter.
void	update_qop (bound_param_vector_type &vector, const pdg_particle< scalar_type > &ptc, const scalar_type e_loss, const int sign) const
	Update the q over p of bound track parameter.
void	update_qop_variance (bound_matrix_type &covariance, const scalar_type sigma_qop) const
	Update the variance of q over p of bound track parameter.

Detailed Description

template<concepts::algebra algebra_t>
struct detray::actor::pointwise_material_interactor< algebra_t >

Apply energy-loss and multiple-scattering effects at material surfaces.

Template Parameters

algebra_t

Algebra backend used by the track parameters.

Member Function Documentation

operator()()

template<concepts::algebra algebra_t>

template<typename propagator_state_t>

void detray::actor::pointwise_material_interactor< algebra_t >::operator()	(	state &	interactor_state,
		propagator_state_t &	prop_state,
		parameter_transporter_result< algebra_t > &	res ) const

Apply material effects after parameter transport reaches a surface.

Template Parameters

propagator_state_t

Propagator state type.

Parameters

interactor_state	State receiving the evaluated effects.
prop_state	Current propagation state.
res	Transport result containing destination parameters.

update()

template<concepts::algebra algebra_t>

template<typename context_t, typename surface_t>

bool detray::actor::pointwise_material_interactor< algebra_t >::update	(	const context_t	gctx,
		const pdg_particle< scalar_type > &	ptc,
		bound_track_parameters< algebra_t > &	bound_params,
		state &	interactor_state,
		const int	nav_dir,
		const surface_t &	sf ) const

Update the bound track parameter.

Parameters

	gctx	Geometry context used for surface transforms.
	ptc	Particle hypothesis used to evaluate interactions.
[out]	bound_params	bound track parameter
[out]	interactor_state	actor state
[in]	nav_dir	navigation direction
[in]	sf	the surface

Returns

Whether material effects were evaluated and applied.

update_angle_variance()

template<concepts::algebra algebra_t>

void detray::actor::pointwise_material_interactor< algebra_t >::update_angle_variance	(	bound_matrix_type &	covariance,
		const vector3_type &	dir,
		const scalar_type	projected_scattering_angle ) const

Update the variance of phi and theta of bound track parameter.

Parameters

[out]	covariance	covariance matrix of bound track parameter
[in]	dir	direction of track
[in]	projected_scattering_angle	projected scattering angle

update_qop()

template<concepts::algebra algebra_t>

void detray::actor::pointwise_material_interactor< algebra_t >::update_qop	(	bound_param_vector_type &	vector,
		const pdg_particle< scalar_type > &	ptc,
		const scalar_type	e_loss,
		const int	sign ) const

Update the q over p of bound track parameter.

Parameters

[out]	vector	vector of bound track parameter
[in]	ptc	Particle hypothesis supplying charge and mass.
[in]	e_loss	energy loss
[in]	sign	navigation direction

update_qop_variance()

template<concepts::algebra algebra_t>

void detray::actor::pointwise_material_interactor< algebra_t >::update_qop_variance	(	bound_matrix_type &	covariance,
		const scalar_type	sigma_qop ) const

Update the variance of q over p of bound track parameter.

Parameters

[out]	covariance	covariance matrix of bound track parameter
[in]	sigma_qop	variance of q over p