detray::wire_layer_generator< detector_t, mask_shape_t > Class Template Reference

Generates a number of drift cells or straw tubes for a barrel layer. More...

#include <detray/test/common/factories/wire_layer_generator.hpp>

Inheritance diagram for detray::wire_layer_generator< detector_t, mask_shape_t >:

Collaboration diagram for detray::wire_layer_generator< detector_t, mask_shape_t >:

Public Member Functions
	wire_layer_generator (const wire_layer_generator_config< scalar_t > &cfg)
	Build a wire chamber/straw tube layer according to the parameters given in.
auto	operator() (typename detector_t::volume_type &volume, typename detector_t::surface_lookup_container &surfaces, typename detector_t::transform_container &transforms, typename detector_t::mask_container &masks, typename detector_t::geometry_context ctx={}) -> dindex_range override
	Create a wire chamber barrel layer.
auto	size () const -> dindex override
void	clear () override
	This is a surface generator, no external surface data needed.
void	push_back (surface_data< detector_t > &&) override
	Add data to the factory.
auto	push_back (std::vector< surface_data< detector_t > > &&) -> void override
	Ignore supplied surface data because this factory generates its own.
Public Member Functions inherited from detray::surface_factory_interface< detector_t >
virtual dindex	size () const =0
virtual void	push_back (std::vector< surface_data< detector_t > > &&data)=0

Additional Inherited Members
Public Types inherited from detray::surface_factory_interface< detector_t >
using	navigation_link = typename detector_t::surface_type::navigation_link
	Navigation link type used by surfaces produced by the factory.
Protected Member Functions inherited from detray::surface_factory_interface< detector_t >
template<typename container_t, typename... Args>
dindex	insert_in_container (container_t &cont, const typename container_t::value_type value, const dindex idx, Args &&...args) const
	Insert a value in a container at a specific index.

Detailed Description

template<concepts::detector detector_t, typename mask_shape_t = line_square>
class detray::wire_layer_generator< detector_t, mask_shape_t >

Generates a number of drift cells or straw tubes for a barrel layer.

Template Parameters

detector_t	the type of detector the layer should be added to
mask_shape_t	the shape for the drift cells or straw tubes

Constructor & Destructor Documentation

wire_layer_generator()

template<concepts::detector detector_t, typename mask_shape_t = line_square>

detray::wire_layer_generator< detector_t, mask_shape_t >::wire_layer_generator ( const wire_layer_generator_config< scalar_t > & cfg )

explicit

Build a wire chamber/straw tube layer according to the parameters given in.

Parameters

cfg

Member Function Documentation

clear()

template<concepts::detector detector_t, typename mask_shape_t = line_square>

void detray::wire_layer_generator< detector_t, mask_shape_t >::clear ( )

overridevirtual

This is a surface generator, no external surface data needed.

Implements detray::surface_factory_interface< detector_t >.

operator()()

template<concepts::detector detector_t, typename mask_shape_t = line_square>

auto detray::wire_layer_generator< detector_t, mask_shape_t >::operator() ( typename detector_t::volume_type & volume, typename detector_t::surface_lookup_container & surfaces, typename detector_t::transform_container & transforms, typename detector_t::mask_container & masks, typename detector_t::geometry_context ctx = {} )->dindex_range

overridevirtual

Create a wire chamber barrel layer.

Parameters

volume	the volume the portals need to be added to.
surfaces	the surface collection to wrap and to add the portals to
transforms	the transforms of the surfaces.
masks	the masks of the surfaces.
ctx	the geometry context (not needed for portals).

Returns

range of generated surfaces

Implements detray::surface_factory_interface< detector_t >.

push_back()

template<concepts::detector detector_t, typename mask_shape_t = line_square>

void detray::wire_layer_generator< detector_t, mask_shape_t >::push_back ( surface_data< detector_t > && data )

overridevirtual

Add data to the factory.

Parameters

data	Surface record to append.

Implements detray::surface_factory_interface< detector_t >.

size()

template<concepts::detector detector_t, typename mask_shape_t = line_square>

auto detray::wire_layer_generator< detector_t, mask_shape_t >::size ( ) const->dindex

override

Returns

the number of wires this factory will produce