Acts::MaterialInteractionAssignment Namespace Reference

Classes
struct	Options
	Options for the material interaction matcher The options are used to specify the vetos for the assignment. More...
struct	Result
	The result struct of the assignment run. More...

Typedefs
using	GlobalVeto
	definition of a global veto for assigning material interactions
using	LocalVeto
	definition of a local veto on a material interaction
using	ReAssignment
	definition of possible re-assignments to next surface, this could e.g.

Functions
Result	assign (const GeometryContext &gctx, const std::vector< MaterialInteraction > &materialInteractions, const std::vector< IAssignmentFinder::SurfaceAssignment > &intersectedSurfaces, const Options &options=Options())
	Match the material interactions to surfaces intersections while respecting eventual vetos for the assignment.

Typedef Documentation

GlobalVeto

using Acts::MaterialInteractionAssignment::GlobalVeto

Initial value:

 
    std::function<bool(const MaterialInteraction& materialInteraction)>

definition of a global veto for assigning material interactions

This can be used to restrict the assignment to a specific volume, or exclude certain materials (if one wants), etc.

Parameters

materialInteraction

is the material interaction to be checked for the veto

It will be globally applied, i.e. every single material interaction will have to go through this veto

LocalVeto

using Acts::MaterialInteractionAssignment::LocalVeto

Initial value:

 std::function<bool(
    const MaterialInteraction&,
    const IAssignmentFinder::SurfaceAssignment& suggestedAssignment)>

definition of a local veto on a material interaction

This can take already the suggested surface assignment into account return true if the assignment should be vetoed. This can be used for having exclusion rules based on surface information.

Parameters

materialInteraction	is the material interaction to be checked for the veto
suggestedAssignment	is the suggested assignment: surface, position, direction

ReAssignment

using Acts::MaterialInteractionAssignment::ReAssignment

Initial value:

 std::function<void(
    MaterialInteraction& materialInteraction,
    const IAssignmentFinder::SurfaceAssignment& suggestedAssignment,
    const IAssignmentFinder::SurfaceAssignment& suggestedReAssignment)>

definition of possible re-assignments to next surface, this could e.g.

be used for respecting pre/post mapping directives that are not fully handled by closest distance matching

The provided parameters are the mutable material interaction, the suggested assignment and the next possible assignment, due to the ordered nature of the material interactions, assignment to previous is excluded

Parameters

materialInteraction	is the material interaction to be checked for the veto
suggestedAssignment	is the suggested assignment: surface, position, direction
suggestedReAssignment	is the suggested assignment: surface, position, direction

Note

this changes the MaterialInteraction if the re-assignment is accepted

Function Documentation

assign()

Result Acts::MaterialInteractionAssignment::assign	(	const GeometryContext &	gctx,
		const std::vector< MaterialInteraction > &	materialInteractions,
		const std::vector< IAssignmentFinder::SurfaceAssignment > &	intersectedSurfaces,
		const Options &	options = Options() )

Match the material interactions to surfaces intersections while respecting eventual vetos for the assignment.

Parameters

gctx	is the geometry context
materialInteractions	is the vector of material interaction
intersectedSurfaces	are the surfac assignment candidates
options	are the options for the assignment

Returns

a pair of vectors of assigned and unassigned material interactions