Acts::MaterialInteractor Struct Reference

Material interactor propagator action. More...

#include <Acts/Propagator/MaterialInteractor.hpp>

Public Types
using	result_type = RecordedMaterial
	Type alias for material interaction result.

Public Member Functions
template<typename propagator_state_t, typename stepper_t, typename navigator_t>
Result< void >	act (propagator_state_t &state, const stepper_t &stepper, const navigator_t &navigator, result_type &result, const Logger &logger) const
	Interaction with detector material for the ActionList of the Propagator.

Public Attributes
bool	energyLoss = true
	Whether to consider energy loss.
bool	multipleScattering = true
	Whether to consider multiple scattering.
NoiseUpdateMode	noiseUpdateMode = NoiseUpdateMode::addNoise
	Whether to add or remove noise.
bool	recordInteractions = false
	Whether to record all material interactions.

Detailed Description

Material interactor propagator action.

Apply material interactions at a surface and update the track state.

Member Typedef Documentation

result_type

using Acts::MaterialInteractor::result_type = RecordedMaterial

Type alias for material interaction result.

Member Function Documentation

act()

template<typename propagator_state_t, typename stepper_t, typename navigator_t>

Result< void > Acts::MaterialInteractor::act	(	propagator_state_t &	state,
		const stepper_t &	stepper,
		const navigator_t &	navigator,
		result_type &	result,
		const Logger &	logger ) const

Interaction with detector material for the ActionList of the Propagator.

It checks if the state has a current surface, in which case the action is performed: the covariance is transported to the position, multiple scattering and energy loss is applied according to the configuration.

Template Parameters

propagator_state_t	is the type of Propagator state
stepper_t	Type of the stepper of the propagation
navigator_t	Type of the navigator of the propagation

Parameters

state	is the mutable propagator state object
stepper	The stepper in use
navigator	The navigator in use
result	is the mutable result state object
logger	a logger instance

Member Data Documentation

energyLoss

bool Acts::MaterialInteractor::energyLoss = true

Whether to consider energy loss.

multipleScattering

bool Acts::MaterialInteractor::multipleScattering = true

Whether to consider multiple scattering.

noiseUpdateMode

NoiseUpdateMode Acts::MaterialInteractor::noiseUpdateMode = NoiseUpdateMode::addNoise

Whether to add or remove noise.

recordInteractions

bool Acts::MaterialInteractor::recordInteractions = false

Whether to record all material interactions.