detray::endcap_generator_config< scalar_t > Struct Template Reference

configuration for the barrel module generator More...

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

Collaboration diagram for detray::endcap_generator_config< scalar_t >:

Public Member Functions
constexpr endcap_generator_config &	side (const int s)
	Setters.
constexpr endcap_generator_config &	center (const scalar_t z)
	Set the center.
constexpr endcap_generator_config &	inner_radius (const scalar_t r)
	Set the inner radius.
constexpr endcap_generator_config &	outer_radius (const scalar_t r)
	Set the outer radius.
endcap_generator_config &	module_bounds (const std::vector< std::vector< scalar_t > > &bnds)
	Set the module bounds.
constexpr endcap_generator_config &	ring_stagger (const scalar_t rs)
	Set the ring stagger.
constexpr endcap_generator_config &	phi_stagger (const std::vector< scalar_t > &ps)
	Set the phi stagger.
constexpr endcap_generator_config &	phi_sub_stagger (const std::vector< scalar_t > &ps)
	Set the phi sub stagger.
constexpr endcap_generator_config &	module_tilt (const std::vector< scalar_t > &t)
	Set the module tilt.
constexpr endcap_generator_config &	binning (const std::vector< unsigned int > &b)
	Set the binning.
constexpr int	side () const
	Getters.
constexpr scalar_t	center () const
	Return the center.
constexpr scalar_t	inner_radius () const
	Return the inner radius.
constexpr scalar_t	outer_radius () const
	Return the outer radius.
const auto &	module_bounds () const
	Return the module bounds.
constexpr scalar_t	ring_stagger () const
	Return the ring stagger.
constexpr const auto &	phi_stagger () const
	Return the phi stagger.
constexpr const auto &	phi_sub_stagger () const
	Return the phi sub stagger.
constexpr const auto &	module_tilt () const
	Return the module tilt.
constexpr const auto &	binning () const
	Return the binning.

Public Attributes
std::vector< unsigned int >	m_binning = {40u, 68u}
	Number of modules in phi (per ring).
scalar_t	m_center_z {0.f}
	Center position (|z|).
scalar_t	m_inner_radius {25.f * unit<scalar_t>::mm}
	Inner layer radius.
std::vector< std::vector< scalar_t > >	m_mask_values
	Boundary values for the module masks (per ring).
scalar_t	m_outer_radius {180.f * unit<scalar_t>::mm}
	Outer layer radius.
std::vector< scalar_t >	m_phi_stagger
	Stagger in phi (per ring).
std::vector< scalar_t >	m_phi_sub_stagger
	Substagger in phi (per ring).
scalar_t	m_ring_stagger {2.f * unit<scalar_t>::mm}
	Stagger between the two rings.
int	m_side {-1}
	Construct positive or negative endcap.
std::vector< scalar_t >	m_tilt = {0.f, 0.f}
	Module tilt (per ring).

Detailed Description

template<concepts::scalar scalar_t>
struct detray::endcap_generator_config< scalar_t >

configuration for the barrel module generator

The default values correspond to the toy detector inner pixel layer

Member Function Documentation

binning() [1/2]

template<concepts::scalar scalar_t>

const auto & detray::endcap_generator_config< scalar_t >::binning ( ) const

constexpr

Return the binning.

Returns

configured binning

binning() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::binning ( const std::vector< unsigned int > & b )

constexpr

Set the binning.

Parameters

b	number of modules in phi for each ring

Returns

reference to the updated configuration

center() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::endcap_generator_config< scalar_t >::center ( ) const

constexpr

Return the center.

Returns

configured center

center() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::center ( const scalar_t z )

constexpr

Set the center.

Parameters

z	center position along z

Returns

reference to the updated configuration

inner_radius() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::endcap_generator_config< scalar_t >::inner_radius ( ) const

constexpr

Return the inner radius.

Returns

configured inner radius

inner_radius() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::inner_radius ( const scalar_t r )

constexpr

Set the inner radius.

Parameters

r	inner radius

Returns

reference to the updated configuration

module_bounds() [1/2]

template<concepts::scalar scalar_t>

const auto & detray::endcap_generator_config< scalar_t >::module_bounds

(

)

const

Return the module bounds.

Returns

configured module bounds

module_bounds() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::module_bounds

(

const std::vector< std::vector< scalar_t > > &

bnds

)

Set the module bounds.

Parameters

bnds	module mask boundaries for each ring

Returns

reference to the updated configuration

module_tilt() [1/2]

template<concepts::scalar scalar_t>

const auto & detray::endcap_generator_config< scalar_t >::module_tilt ( ) const

constexpr

Return the module tilt.

Returns

configured module tilt

module_tilt() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::module_tilt ( const std::vector< scalar_t > & t )

constexpr

Set the module tilt.

Parameters

t	module tilt values

Returns

reference to the updated configuration

outer_radius() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::endcap_generator_config< scalar_t >::outer_radius ( ) const

constexpr

Return the outer radius.

Returns

configured outer radius

outer_radius() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::outer_radius ( const scalar_t r )

constexpr

Set the outer radius.

Parameters

r	outer radius

Returns

reference to the updated configuration

phi_stagger() [1/2]

template<concepts::scalar scalar_t>

const auto & detray::endcap_generator_config< scalar_t >::phi_stagger ( ) const

constexpr

Return the phi stagger.

Returns

configured phi stagger

phi_stagger() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::phi_stagger ( const std::vector< scalar_t > & ps )

constexpr

Set the phi stagger.

Parameters

ps	stagger values in phi

Returns

reference to the updated configuration

phi_sub_stagger() [1/2]

template<concepts::scalar scalar_t>

const auto & detray::endcap_generator_config< scalar_t >::phi_sub_stagger ( ) const

constexpr

Return the phi sub stagger.

Returns

configured phi sub stagger

phi_sub_stagger() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::phi_sub_stagger ( const std::vector< scalar_t > & ps )

constexpr

Set the phi sub stagger.

Parameters

ps	sub-stagger values in phi

Returns

reference to the updated configuration

ring_stagger() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::endcap_generator_config< scalar_t >::ring_stagger ( ) const

constexpr

Return the ring stagger.

Returns

configured ring stagger

ring_stagger() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::ring_stagger ( const scalar_t rs )

constexpr

Set the ring stagger.

Parameters

rs	stagger between rings

Returns

reference to the updated configuration

side() [1/2]

template<concepts::scalar scalar_t>

int detray::endcap_generator_config< scalar_t >::side ( ) const

constexpr

Getters.

Return the side.

Returns

configured side

side() [2/2]

template<concepts::scalar scalar_t>

endcap_generator_config & detray::endcap_generator_config< scalar_t >::side ( const int s )

constexpr

Setters.

Set the side.

Parameters

s	endcap side

Returns

reference to the updated configuration

Member Data Documentation

m_mask_values

template<concepts::scalar scalar_t>

std::vector<std::vector<scalar_t> > detray::endcap_generator_config< scalar_t >::m_mask_values

Initial value:

{
      {3.f * unit<scalar_t>::mm, 9.5f * unit<scalar_t>::mm,
       39.f * unit<scalar_t>::mm},
      {6.f * unit<scalar_t>::mm, 10.f * unit<scalar_t>::mm,
       39.f * unit<scalar_t>::mm}}

Boundary values for the module masks (per ring).

m_phi_stagger

template<concepts::scalar scalar_t>

std::vector<scalar_t> detray::endcap_generator_config< scalar_t >::m_phi_stagger

Initial value:

= {4.f * unit<scalar_t>::mm,
                                         4.f * unit<scalar_t>::mm}

Stagger in phi (per ring).

m_phi_sub_stagger

template<concepts::scalar scalar_t>

std::vector<scalar_t> detray::endcap_generator_config< scalar_t >::m_phi_sub_stagger

Initial value:

= {0.5f * unit<scalar_t>::mm,
                                             0.5f * unit<scalar_t>::mm}

Substagger in phi (per ring).