traccc/io/read_detector.hpp

0001 /** TRACCC library, part of the ACTS project (R&D line)
0002  *
0003  * (c) 2024 CERN for the benefit of the ACTS project
0004  *
0005  * Mozilla Public License Version 2.0
0006  */
0007
0008 #pragma once
0009
0010 // Project include(s).
0011 #include "traccc/geometry/host_detector.hpp"
0012
0013 // VecMem include(s).
0014 #include <vecmem/memory/memory_resource.hpp>
0015
0016 // System include(s).
0017 #include <string_view>
0018
0019 namespace traccc::io {
0020
0021 /// Construct a "default" / ODD detector geometry from a set of input files
0022 ///
0023 /// It is mostly just a wrapper around Detray's more generic
0024 /// @c detray::io::read_detector code.
0025 ///
0026 /// @param detector The detector object to be set up
0027 /// @param mr The memory resource to be used by the detector object
0028 /// @param geometry_file The file containing the geometry description
0029 /// @param material_file The file containing the material description
0030 /// @param grid_file The file containing the detector grid description
0031 ///
0032 void read_detector(host_detector& detector, vecmem::memory_resource& mr,
0033                    const std::string_view& geometry_file,
0034                    const std::string_view& material_file = "",
0035                    const std::string_view& grid_file = "");
0036
0037 }  // namespace traccc::io