detray::barrel_generator_config< scalar_t > Struct Template Reference

configuration for the barrel module generator More...

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

Collaboration diagram for detray::barrel_generator_config< scalar_t >:

Public Member Functions
constexpr barrel_generator_config &	half_length (const scalar_t hz)
	Setters.
barrel_generator_config &	module_bounds (const std::vector< scalar_t > &bnds)
	Set the module bounds.
constexpr barrel_generator_config &	tilt_phi (const scalar_t tilt)
	Set the tilt phi.
constexpr barrel_generator_config &	radius (const scalar_t r)
	Set the radius.
constexpr barrel_generator_config &	radial_stagger (const scalar_t r_st)
	Set the radial stagger.
constexpr barrel_generator_config &	z_overlap (const scalar_t zo)
	Set the z overlap.
constexpr barrel_generator_config &	binning (const unsigned int n_phi, const unsigned int n_z)
	Set the binning.
constexpr barrel_generator_config &	binning (const std::pair< unsigned int, const unsigned int > &binning)
	Set the binning.
constexpr scalar_t	half_length () const
	Getters.
const std::vector< scalar_t > &	module_bounds () const
	Return the module bounds.
constexpr scalar_t	tilt_phi () const
	Return the tilt phi.
constexpr scalar_t	radius () const
	Return the radius.
constexpr scalar_t	radial_stagger () const
	Return the radial stagger.
constexpr scalar_t	z_overlap () const
	Return the z overlap.
constexpr const auto &	binning () const
	Return the binning.

Public Attributes
std::pair< unsigned int, unsigned int >	m_binning = {16u, 14u}
	Number of modules in phi and z.
scalar_t	m_half_z {500.f * unit<scalar_t>::mm}
	Half length of the barrel (z).
std::vector< scalar_t >	m_mask_values
	Boundary values for the module masks.
scalar_t	m_radial_stagger {0.5f * unit<scalar_t>::mm}
	Radial module stagger.
scalar_t	m_radius {32.f * unit<scalar_t>::mm}
	Layer radius.
scalar_t	m_tilt_phi {0.14f}
	Phi tilt for modules.
scalar_t	m_z_overlap {2.f * unit<scalar_t>::mm}
	Module overlap in z.

Detailed Description

template<concepts::scalar scalar_t>
struct detray::barrel_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/3]

template<concepts::scalar scalar_t>

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

constexpr

Return the binning.

Returns

configured binning

binning() [2/3]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::binning ( const std::pair< unsigned int, const unsigned int > & binning )

constexpr

Set the binning.

Parameters

binning

number of bins in phi and z

Returns

reference to the updated configuration

binning() [3/3]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::binning ( const unsigned int n_phi, const unsigned int n_z )

constexpr

Set the binning.

Parameters

n_phi	number of bins in phi
n_z	number of bins in z

Returns

reference to the updated configuration

half_length() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::barrel_generator_config< scalar_t >::half_length ( ) const

constexpr

Getters.

Return the half length.

Returns

configured half length

half_length() [2/2]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::half_length ( const scalar_t hz )

constexpr

Setters.

Set the half length.

Parameters

hz	half length along z

Returns

reference to the updated configuration

module_bounds() [1/2]

template<concepts::scalar scalar_t>

const std::vector< scalar_t > & detray::barrel_generator_config< scalar_t >::module_bounds

(

)

const

Return the module bounds.

Returns

configured module bounds

module_bounds() [2/2]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::module_bounds

(

const std::vector< scalar_t > &

bnds

)

Set the module bounds.

Parameters

bnds	module mask boundary values

Returns

reference to the updated configuration

radial_stagger() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::barrel_generator_config< scalar_t >::radial_stagger ( ) const

constexpr

Return the radial stagger.

Returns

configured radial stagger

radial_stagger() [2/2]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::radial_stagger ( const scalar_t r_st )

constexpr

Set the radial stagger.

Parameters

r_st	radial stagger

Returns

reference to the updated configuration

radius() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::barrel_generator_config< scalar_t >::radius ( ) const

constexpr

Return the radius.

Returns

configured radius

radius() [2/2]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::radius ( const scalar_t r )

constexpr

Set the radius.

Parameters

r	barrel radius

Returns

reference to the updated configuration

tilt_phi() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::barrel_generator_config< scalar_t >::tilt_phi ( ) const

constexpr

Return the tilt phi.

Returns

configured tilt phi

tilt_phi() [2/2]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::tilt_phi ( const scalar_t tilt )

constexpr

Set the tilt phi.

Parameters

tilt	module tilt angle

Returns

reference to the updated configuration

z_overlap() [1/2]

template<concepts::scalar scalar_t>

scalar_t detray::barrel_generator_config< scalar_t >::z_overlap ( ) const

constexpr

Return the z overlap.

Returns

configured z overlap

z_overlap() [2/2]

template<concepts::scalar scalar_t>

barrel_generator_config & detray::barrel_generator_config< scalar_t >::z_overlap ( const scalar_t zo )

constexpr

Set the z overlap.

Parameters

zo	overlap in z

Returns

reference to the updated configuration

Member Data Documentation

m_mask_values

template<concepts::scalar scalar_t>

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

Initial value:

{8.4f * unit<scalar_t>::mm,
                                      36.f * unit<scalar_t>::mm}

Boundary values for the module masks.