detray::io::detector_reader_config Struct Reference

config struct for detector reading. More...

#include <detray/io/frontend/detector_reader_config.hpp>

Collaboration diagram for detray::io::detector_reader_config:

Public Member Functions
const std::vector< std::string > &	files () const
	GettersReturn the list of configured detector input files.
const detray::volume_builder_options &	builder_options () const
	Return the volume-builder options used during reconstruction.
bool	deduplicate () const
	Return whether duplicate detector components are removed.
bool	do_check () const
	Return whether detector consistency checks are enabled.
bool	verbose_check () const
	Return whether consistency checks print detailed output.
detector_reader_config &	add_file (const std::string &file_name)
	SettersAdd a detector component file to the input list.
detector_reader_config &	deduplicate (bool toggle)
	Enable or disable deduplication in the volume builder.
detector_reader_config &	do_check (const bool check)
	Enable or disable the post-read detector consistency check.
detector_reader_config &	verbose_check (const bool verbose)
	Enable detailed output from the consistency check.

Public Attributes
detray::volume_builder_options	m_builder_opts {}
	Volume builder options.
bool	m_do_check {true}
	Run detector consistency check after reading.
std::vector< std::string >	m_files
	Input files.
bool	m_verbose {false}
	Verbosity of the detector consistency check.

Detailed Description

config struct for detector reading.

Member Function Documentation

add_file()

detector_reader_config & detray::io::detector_reader_config::add_file

(

const std::string &

file_name

)

SettersAdd a detector component file to the input list.

Parameters

file_name

path to a detector data file

Returns

this configuration for chaining

builder_options()

const detray::volume_builder_options & detray::io::detector_reader_config::builder_options

(

)

const

Return the volume-builder options used during reconstruction.

Returns

configured builder options

deduplicate() [1/2]

bool detray::io::detector_reader_config::deduplicate

(

)

const

Return whether duplicate detector components are removed.

Returns

whether the option is enabled

deduplicate() [2/2]

detector_reader_config & detray::io::detector_reader_config::deduplicate

(

bool

toggle

)

Enable or disable deduplication in the volume builder.

Parameters

toggle

whether duplicate components should be removed

Returns

this configuration for chaining

do_check() [1/2]

bool detray::io::detector_reader_config::do_check

(

)

const

Return whether detector consistency checks are enabled.

Returns

whether the option is enabled

do_check() [2/2]

detector_reader_config & detray::io::detector_reader_config::do_check

(

const bool

check

)

Enable or disable the post-read detector consistency check.

Parameters

check

whether to run the check

Returns

this configuration for chaining

files()

const std::vector< std::string > & detray::io::detector_reader_config::files

(

)

const

GettersReturn the list of configured detector input files.

Returns

configured file paths

verbose_check() [1/2]

bool detray::io::detector_reader_config::verbose_check

(

)

const

Return whether consistency checks print detailed output.

Returns

whether the option is enabled

verbose_check() [2/2]

detector_reader_config & detray::io::detector_reader_config::verbose_check

(

const bool

verbose

)

Enable detailed output from the consistency check.

Enabling verbose output also enables the check.

Parameters

verbose

whether to print detailed check output

Returns

this configuration for chaining