traccc/io/read_magnetic_field.hpp

0001 /** TRACCC library, part of the ACTS project (R&D line)
0002  *
0003  * (c) 2025 CERN for the benefit of the ACTS project
0004  *
0005  * Mozilla Public License Version 2.0
0006  */
0007
0008 #pragma once
0009
0010 // Local include(s).
0011 #include "traccc/io/data_format.hpp"
0012
0013 // Project include(s).
0014 #include "traccc/bfield/magnetic_field.hpp"
0015 #include "traccc/definitions/common.hpp"
0016 #include "traccc/utils/logging.hpp"
0017
0018 // System include(s).
0019 #include <string_view>
0020
0021 namespace traccc::io {
0022
0023 /// Read a magnetic field from a file
0024 ///
0025 /// @param[out] bfield     The field to fill
0026 /// @param[in]  filename   The name of the file to read
0027 /// @param[in]  format     The data format of the input file
0028 /// @param[in]  logger     Logger to use for output messages
0029 ///
0030 void read_magnetic_field(
0031     magnetic_field& bfield, std::string_view filename,
0032     data_format format = data_format::binary,
0033     std::unique_ptr<const Logger> logger = getDummyLogger().clone());
0034
0035 }  // namespace traccc::io