src/csv/read_particles.hpp

0001 /** TRACCC library, part of the ACTS project (R&D line)
0002  *
0003  * (c) 2022-2026 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/edm/measurement_collection.hpp"
0012 #include "traccc/edm/particle.hpp"
0013 #include "traccc/geometry/detector.hpp"
0014 #include "traccc/geometry/detector_conditions_description.hpp"
0015 #include "traccc/geometry/detector_design_description.hpp"
0016 #include "traccc/geometry/host_detector.hpp"
0017
0018 // System include(s).
0019 #include <string_view>
0020
0021 namespace traccc::io::csv {
0022
0023 /// Read (basic) particle information from a specific CSV file
0024 ///
0025 /// @param[out] particles The particle collection to fill
0026 /// @param[in]  filename  The file to read the particle data from
0027 ///
0028 void read_particles(particle_collection_types::host& particles,
0029                     std::string_view filename);
0030
0031 /// Read full truth particle data into memory
0032 ///
0033 /// @param[out] particles     The particle container to fill
0034 /// @param[out] measurements  The measurement collection to fill
0035 /// @param[in]  particles_file The file to read the particle data from
0036 /// @param[in]  hits_file     The file to read the simulated hits from
0037 /// @param[in]  measurements_file The file to read the "Acts measurements" from
0038 /// @param[in]  hit_map_file  The file to read the hit->measurement mapping from
0039 /// @param[in]  detector  detray detector
0040 ///
0041 void read_particles(particle_container_types::host& particles,
0042                     edm::measurement_collection::host& measurements,
0043                     std::string_view particles_file, std::string_view hits_file,
0044                     std::string_view measurements_file,
0045                     std::string_view hit_map_file,
0046                     const traccc::host_detector* detector,
0047                     const traccc::detector_design_description::host*
0048                         detector_design_description = nullptr,
0049                     const traccc::detector_conditions_description::host*
0050                         detector_conditions_description = nullptr,
0051                     const bool sort_measurements = true);
0052
0053 }  // namespace traccc::io::csv