obdeect-stream 0.9.2__tar.gz → 0.10.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/PKG-INFO +1 -1
  2. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/photons.hpp +12 -0
  3. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/simtel.hpp +19 -9
  4. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_simtel.cpp +71 -0
  5. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tools/ps2simtel.cpp +6 -1
  6. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/CMakeLists.txt +0 -0
  7. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/README.md +0 -0
  8. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cmake/obdeect_stream-config.cmake.in +0 -0
  9. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cmake/version.hpp.in +0 -0
  10. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/bench/bench_stream.cpp +0 -0
  11. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/bench/gen_corsika.cpp +0 -0
  12. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/bindings/core.cpp +0 -0
  13. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/capi/obdeect_stream_c.cpp +0 -0
  14. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/atmprof.hpp +0 -0
  15. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/cli.hpp +0 -0
  16. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/constants.hpp +0 -0
  17. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/corsika.hpp +0 -0
  18. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/eventio.hpp +0 -0
  19. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/format.hpp +0 -0
  20. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/grisu.hpp +0 -0
  21. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/obdeect_stream.h +0 -0
  22. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/parse.hpp +0 -0
  23. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/random.hpp +0 -0
  24. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/stages.hpp +0 -0
  25. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/stdin_buffer.hpp +0 -0
  26. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/stream.hpp +0 -0
  27. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/telpos.hpp +0 -0
  28. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/vec3.hpp +0 -0
  29. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/include/obdeect/stream/wavelength.hpp +0 -0
  30. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/check.hpp +0 -0
  31. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/consumer/CMakeLists.txt +0 -0
  32. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/consumer/main.cpp +0 -0
  33. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/consumer/main_c.c +0 -0
  34. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/bad_magic.pst +0 -0
  35. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/expected.json +0 -0
  36. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/make_conformance.py +0 -0
  37. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/too_many_rows.pst +0 -0
  38. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/truncated_chunk.pst +0 -0
  39. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/unknown_major.pst +0 -0
  40. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/data/conformance/valid.pst +0 -0
  41. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_capi.c +0 -0
  42. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_capi_cpp.cpp +0 -0
  43. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_cli.cpp +0 -0
  44. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_corsika.cpp +0 -0
  45. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_eventio.cpp +0 -0
  46. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_format.cpp +0 -0
  47. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_grisu.cpp +0 -0
  48. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_parse.cpp +0 -0
  49. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_stages.cpp +0 -0
  50. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_stream.cpp +0 -0
  51. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_version.cpp +0 -0
  52. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tests/test_wavelength.cpp +0 -0
  53. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tools/corsika2ps.cpp +0 -0
  54. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tools/ps2grisu.cpp +0 -0
  55. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tools/ps_cat.cpp +0 -0
  56. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tools/ps_tee.cpp +0 -0
  57. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/cpp/tools/tool_version.hpp +0 -0
  58. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/pyproject.toml +0 -0
  59. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/__init__.py +0 -0
  60. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/__main__.py +0 -0
  61. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/_package.py +0 -0
  62. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/cli.py +0 -0
  63. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/convert.py +0 -0
  64. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/stage.py +0 -0
  65. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/obdeect/stream/stream.py +0 -0
  66. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_cli.py +0 -0
  67. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_cmake_package.py +0 -0
  68. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_constants.py +0 -0
  69. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_convert.py +0 -0
  70. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_grisu.py +0 -0
  71. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_import.py +0 -0
  72. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_stage.py +0 -0
  73. {obdeect_stream-0.9.2 → obdeect_stream-0.10.0}/python/tests/test_stream.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: obdeect-stream
3
- Version: 0.9.2
3
+ Version: 0.10.0
4
4
  Summary: Photon-stream format and I/O for Cherenkov-telescope simulation chains
5
5
  Author: obdeect contributors
6
6
  License-Expression: BSD-3-Clause
@@ -3,6 +3,7 @@
3
3
  #include "obdeect/stream/format.hpp"
4
4
 
5
5
  #include <array>
6
+ #include <cmath>
6
7
  #include <cstddef>
7
8
  #include <cstdint>
8
9
  #include <map>
@@ -85,6 +86,17 @@ private:
85
86
  std::size_t rows_{};
86
87
  };
87
88
 
89
+ // Largest allowed |cz^2 - (1 - cx^2 - cy^2)| for a stored direction. Float32 columns hold a unit
90
+ // vector to about 1e-7; the squared form keeps that rounding from failing nearly horizontal
91
+ // photons, for which an error in cz of the same size is amplified by 1 / (2 |cz|).
92
+ inline constexpr double direction_norm_tolerance = 1e-5;
93
+
94
+ // True if cz points downwards (cz < 0) and (cx, cy, cz) is a unit vector within the tolerance.
95
+ // False for upwards or horizontal photons (cz >= 0) and for any NaN input.
96
+ [[nodiscard]] inline bool cz_matches_direction(double cz, double cx, double cy) {
97
+ return cz < 0.0 && std::abs(cz * cz - (1.0 - cx * cx - cy * cy)) <= direction_norm_tolerance;
98
+ }
99
+
88
100
  // One decoded record. `metadata` is used by all metadata records, `chunk` by
89
101
  // photons, `blob_*` by blob records.
90
102
  struct Record {
@@ -21,7 +21,9 @@
21
21
  // receiving run needs Bypass_Optics=1. The camera rotation is not used.
22
22
  //
23
23
  // Telescopes with C photons get z = 0 in TELPOS (1201), because their photons
24
- // are already at the camera. Ground-frame telescopes keep their height.
24
+ // are already at the camera. Ground-frame telescopes keep their height. With
25
+ // keep_telpos_height (obdeect stream to-simtel --keep-telpos-height) the TELPOS block is
26
+ // written unchanged, for array runs where sim_telarray needs the real heights.
25
27
  //
26
28
  // A telescope is either listed in the camera map (camera-frame or telescope-frame
27
29
  // photons) or ground-frame (not listed). Mixing ground frame with the others, or camera
@@ -554,7 +556,8 @@ struct SimtelOptions {
554
556
  std::optional<AtmosphereTable> atmprof; // atmospheric table (ATMPROF block), see the file comment
555
557
  std::ostream *warnings{nullptr}; // reports synthesised headers; null: silent
556
558
  std::set<std::string> allow_pending; // efficiency_status factors accepted as they are
557
- std::set<std::string> scaled; // efficiency_status factors whose camera table holds f/f_env
559
+ std::set<std::string> scaled; // efficiency_status factors whose camera table holds f/f_env
560
+ bool keep_telpos_height{false}; // TELPOS z of camera-map telescopes kept (not set to 0)
558
561
  };
559
562
 
560
563
  // Writes a photon stream as sim_telarray input (EventIO, normal mode: one 1204
@@ -568,7 +571,7 @@ public:
568
571
  PsToSimtel(std::ostream &out, SimtelOptions options)
569
572
  : writer_{out}, camera_{std::move(options.camera)}, atmprof_{std::move(options.atmprof)},
570
573
  warnings_{options.warnings}, allow_pending_{std::move(options.allow_pending)},
571
- scaled_{std::move(options.scaled)} {
574
+ scaled_{std::move(options.scaled)}, keep_telpos_height_{options.keep_telpos_height} {
572
575
  for (const auto &[id, telescope] : camera_) {
573
576
  if (id == 0) {
574
577
  throw std::invalid_argument("camera map telescope id must be at least 1");
@@ -719,12 +722,16 @@ private:
719
722
  throw std::runtime_error("camera map telescope " + std::to_string(entry.first) +
720
723
  " is not in the TELPOS block");
721
724
  }
722
- pos.z[entry.first - 1] = 0.0;
725
+ if (!keep_telpos_height_) {
726
+ pos.z[entry.first - 1] = 0.0;
727
+ }
728
+ }
729
+ if (!keep_telpos_height_) {
730
+ Record zeroed = record;
731
+ zeroed.blob = simtel_detail::block_bytes(make_telpos_block(pos));
732
+ write_telpos(zeroed);
733
+ return;
723
734
  }
724
- Record zeroed = record;
725
- zeroed.blob = simtel_detail::block_bytes(make_telpos_block(pos));
726
- write_telpos(zeroed);
727
- return;
728
735
  }
729
736
  write_telpos(record);
730
737
  return;
@@ -1011,7 +1018,9 @@ private:
1011
1018
  throw std::runtime_error("camera map telescope " + std::to_string(entry.first) +
1012
1019
  " is not in the run metadata");
1013
1020
  }
1014
- pos.z[entry.first - 1] = 0.0;
1021
+ if (!keep_telpos_height_) {
1022
+ pos.z[entry.first - 1] = 0.0;
1023
+ }
1015
1024
  }
1016
1025
  return make_telpos_block(pos);
1017
1026
  }
@@ -1100,6 +1109,7 @@ private:
1100
1109
  bool have_evte_{};
1101
1110
  std::set<std::string> allow_pending_;
1102
1111
  std::set<std::string> scaled_;
1112
+ bool keep_telpos_height_{};
1103
1113
  std::vector<Metadata> run_efficiency_statuses_;
1104
1114
  std::vector<Metadata> telescope_efficiency_statuses_;
1105
1115
  bool telescope_open_{};
@@ -405,6 +405,75 @@ std::string run_adapter_with(const std::vector<Record> &records, SimtelOptions o
405
405
  return out.str();
406
406
  }
407
407
 
408
+ // keep_telpos_height (--keep-telpos-height): TELPOS written unchanged, the check stays.
409
+ void test_telpos_height_kept_with_option() {
410
+ const CameraMap camera{{1, CameraTelescope{1, 0.0}}};
411
+ const std::vector<Record> records = {
412
+ record_of(RecordType::run, light_source_run()),
413
+ blob_of(telpos_block({2000.0, 2100.0})),
414
+ record_of(RecordType::event, Metadata{{"event_number", std::int64_t{1}}}),
415
+ record_of(RecordType::telescope,
416
+ Metadata{{"telescope_id", std::int64_t{1}}, {"array_index", std::int64_t{0}}}),
417
+ photons_of(chunk_of(1, Frame::camera, {0.5}, {0.2}, {0.1}, {-0.2})),
418
+ record_of(RecordType::telescope_end, Metadata{{"telescope_id", std::int64_t{1}}}),
419
+ record_of(RecordType::event_end),
420
+ record_of(RecordType::run_end),
421
+ };
422
+ SimtelOptions options;
423
+ options.camera = camera;
424
+ options.keep_telpos_height = true;
425
+ const std::vector<EventioBlock> blocks = read_blocks(run_adapter_with(records, options));
426
+ bool checked = false;
427
+ for (const EventioBlock &block : blocks) {
428
+ if (block.type == iact::telpos) {
429
+ const TelPos pos = decode_telpos(block);
430
+ CHECK(pos.z.size() == 2);
431
+ if (pos.z.size() == 2) {
432
+ CHECK_NEAR(pos.z[0], 2000.0, 1e-3); // camera-frame telescope 1 keeps its height
433
+ CHECK_NEAR(pos.z[1], 2100.0, 1e-3);
434
+ }
435
+ checked = true;
436
+ break;
437
+ }
438
+ }
439
+ CHECK(checked);
440
+
441
+ // A camera-map telescope missing from the TELPOS block is still an error.
442
+ SimtelOptions missing_options;
443
+ missing_options.camera = CameraMap{{3, CameraTelescope{1, 0.0}}};
444
+ missing_options.keep_telpos_height = true;
445
+ const std::vector<Record> missing = {
446
+ record_of(RecordType::run, light_source_run()),
447
+ blob_of(telpos_block({2000.0, 2100.0})),
448
+ };
449
+ CHECK(throws_error([&] { run_adapter_with(missing, missing_options); }));
450
+ }
451
+
452
+ void test_synthesised_telpos_heights() {
453
+ Metadata run = light_source_run();
454
+ run["telescope_z_m"] = std::vector<double>{20.0, 21.0};
455
+ const std::vector<Record> records{record_of(RecordType::run, run),
456
+ record_of(RecordType::run_end)};
457
+ for (bool keep : {false, true}) {
458
+ SimtelOptions options;
459
+ options.camera = {{1, CameraTelescope{1, 0.0}}};
460
+ options.keep_telpos_height = keep;
461
+ bool checked = false;
462
+ for (const EventioBlock &block : read_blocks(run_adapter_with(records, options))) {
463
+ if (block.type == iact::telpos) {
464
+ const TelPos pos = decode_telpos(block);
465
+ CHECK(pos.z.size() == 2);
466
+ if (pos.z.size() == 2) {
467
+ CHECK_NEAR(pos.z[0], keep ? 2000.0 : 0.0, 1e-3);
468
+ CHECK_NEAR(pos.z[1], 2100.0, 1e-3);
469
+ }
470
+ checked = true;
471
+ }
472
+ }
473
+ CHECK(checked);
474
+ }
475
+ }
476
+
408
477
  // Telescope-frame chunk: emission points x y z [m], direction cx cy (cz below, or none),
409
478
  // times t [ns]; w = 1.
410
479
  PhotonChunk telescope_chunk(std::uint32_t telescope, const std::vector<double> &x,
@@ -1253,6 +1322,8 @@ int main() {
1253
1322
  test_camera_conversion();
1254
1323
  test_camera_frame_through_adapter();
1255
1324
  test_telpos_zeroed_for_camera_only();
1325
+ test_telpos_height_kept_with_option();
1326
+ test_synthesised_telpos_heights();
1256
1327
  test_telescope_frame_through_adapter();
1257
1328
  test_telescope_frame_report_and_telpos();
1258
1329
  test_telescope_frame_rejected();
@@ -20,7 +20,8 @@ constexpr std::size_t buffer_size = std::size_t{1} << 20;
20
20
  void usage() {
21
21
  std::fprintf(stderr, "usage: obdeect stream to-simtel [--camera-map FILE] [--atmprof FILE] "
22
22
  "[--allow-pending FACTOR]... [--allow-pending-atmosphere] "
23
- "[--scaled-factor FACTOR]... [-o FILE|-] [input|-]\n");
23
+ "[--scaled-factor FACTOR]... [--keep-telpos-height] "
24
+ "[-o FILE|-] [input|-]\n");
24
25
  }
25
26
 
26
27
  } // namespace
@@ -35,6 +36,7 @@ int main(int argc, char **argv) {
35
36
  std::string atmprof_path;
36
37
  std::set<std::string> allow_pending;
37
38
  std::set<std::string> scaled;
39
+ bool keep_telpos_height = false;
38
40
  bool have_input = false;
39
41
  std::string arg;
40
42
  while (args.next(arg)) {
@@ -50,6 +52,8 @@ int main(int argc, char **argv) {
50
52
  allow_pending.insert("atmosphere");
51
53
  } else if (arg == "--scaled-factor") {
52
54
  scaled.insert(args.value(arg));
55
+ } else if (arg == "--keep-telpos-height") {
56
+ keep_telpos_height = true;
53
57
  } else if (arg == "--atmprof") {
54
58
  atmprof_path = args.value(arg);
55
59
  } else if (arg == "--camera-map") {
@@ -68,6 +72,7 @@ int main(int argc, char **argv) {
68
72
  options.warnings = &std::cerr;
69
73
  options.allow_pending = std::move(allow_pending);
70
74
  options.scaled = std::move(scaled);
75
+ options.keep_telpos_height = keep_telpos_height;
71
76
  if (!camera_path.empty()) {
72
77
  std::ifstream map_file(camera_path);
73
78
  if (!map_file) {