refactor: make RNG independent of algorithm order (#1905)

after discussion with paul I though it would be beneficial to remove the dependence of the algorithm order of the RNG in the examples framework. changing the order of reader/writer/algorithms used to result in different outputs which might be unexpected and hard to debug I believe the impact on the randomness in the simulation is negligible and should not result in funny correlations
acts-project · Mar 2, 2023 · 8c93c71 · 8c93c71
1 parent 3847c73
commit 8c93c71
Show file tree

Hide file tree

Showing 22 changed files with 92 additions and 106 deletions.
diff --git a/CI/physmon/reference/performance_ambi_orthogonal.root b/CI/physmon/reference/performance_ambi_orthogonal.root
diff --git a/CI/physmon/reference/performance_ambi_seeded.root b/CI/physmon/reference/performance_ambi_seeded.root
diff --git a/CI/physmon/reference/performance_ckf_orthogonal.root b/CI/physmon/reference/performance_ckf_orthogonal.root
diff --git a/CI/physmon/reference/performance_ckf_seeded.root b/CI/physmon/reference/performance_ckf_seeded.root
diff --git a/CI/physmon/reference/performance_ckf_tracks_seeded.root b/CI/physmon/reference/performance_ckf_tracks_seeded.root
diff --git a/CI/physmon/reference/performance_ckf_tracks_truth_estimated.root b/CI/physmon/reference/performance_ckf_tracks_truth_estimated.root
diff --git a/CI/physmon/reference/performance_ckf_tracks_truth_smeared.root b/CI/physmon/reference/performance_ckf_tracks_truth_smeared.root
diff --git a/CI/physmon/reference/performance_ckf_truth_estimated.root b/CI/physmon/reference/performance_ckf_truth_estimated.root
diff --git a/CI/physmon/reference/performance_ckf_truth_smeared.root b/CI/physmon/reference/performance_ckf_truth_smeared.root
diff --git a/CI/physmon/reference/performance_gsf.root b/CI/physmon/reference/performance_gsf.root
diff --git a/CI/physmon/reference/performance_seeding_hists_orthogonal.root b/CI/physmon/reference/performance_seeding_hists_orthogonal.root
diff --git a/CI/physmon/reference/performance_seeding_hists_seeded.root b/CI/physmon/reference/performance_seeding_hists_seeded.root
diff --git a/CI/physmon/reference/performance_seeding_hists_truth_estimated.root b/CI/physmon/reference/performance_seeding_hists_truth_estimated.root
diff --git a/CI/physmon/reference/performance_truth_tracking.root b/CI/physmon/reference/performance_truth_tracking.root
diff --git a/CI/physmon/reference/performance_vertexing_orthogonal_hist.root b/CI/physmon/reference/performance_vertexing_orthogonal_hist.root
diff --git a/CI/physmon/reference/performance_vertexing_seeded_hist.root b/CI/physmon/reference/performance_vertexing_seeded_hist.root
diff --git a/CI/physmon/reference/performance_vertexing_truth_estimated_hist.root b/CI/physmon/reference/performance_vertexing_truth_estimated_hist.root
diff --git a/CI/physmon/reference/performance_vertexing_truth_smeared_hist.root b/CI/physmon/reference/performance_vertexing_truth_smeared_hist.root
diff --git a/Examples/Algorithms/TrackFinding/src/TrackFindingAlgorithm.cpp b/Examples/Algorithms/TrackFinding/src/TrackFindingAlgorithm.cpp
@@ -59,7 +59,7 @@ ActsExamples::ProcessCode ActsExamples::TrackFindingAlgorithm::execute(
       Acts::Vector3{0., 0., 0.});
 
   Acts::PropagatorPlainOptions pOptions;
-  pOptions.maxSteps = 10000;
+  pOptions.maxSteps = 100000;
 
   MeasurementCalibrator calibrator{measurements};
   Acts::GainMatrixUpdater kfUpdater;

diff --git a/Examples/Framework/src/Framework/RandomNumbers.cpp b/Examples/Framework/src/Framework/RandomNumbers.cpp
@@ -25,11 +25,5 @@ ActsExamples::RandomEngine ActsExamples::RandomNumbers::spawnGenerator(
 
 uint64_t ActsExamples::RandomNumbers::generateSeed(
     const AlgorithmContext& context) const {
-  // use Cantor pairing function to generate a unique generator id from
-  // algorithm and event number to get a consistent seed
-  // see https://en.wikipedia.org/wiki/Pairing_function#Cantor_pairing_function
-  const uint64_t k1 = context.algorithmNumber;
-  const uint64_t k2 = context.eventNumber;
-  const uint64_t id = (k1 + k2) * (k1 + k2 + 1) / 2 + k2;
-  return m_cfg.seed + id;
+  return m_cfg.seed + context.eventNumber;
 }
diff --git a/Examples/Python/tests/root_file_hashes.txt b/Examples/Python/tests/root_file_hashes.txt
diff --git a/Examples/Python/tests/test_examples.py b/Examples/Python/tests/test_examples.py
@@ -273,12 +273,12 @@ def test_seeding_orthogonal(tmp_path, trk_geo, field, assert_root_hash):
         (
             "estimatedparams.root",
             "estimatedparams",
-            309,
+            284,
         ),
         (
             "performance_seeding_trees.root",
             "track_finder_tracks",
-            309,
+            284,
         ),
         (
             "performance_seeding_hists.root",
@@ -922,7 +922,8 @@ def test_digitization_example(trk_geo, tmp_path, assert_root_hash):
     assert len(list(csv_dir.iterdir())) == 3 * s.config.events
     assert all(f.stat().st_size > 50 for f in csv_dir.iterdir())
     assert_entries(root_file, "vol9", 0)
-    for tn in (8, 12, 13, 14, 16, 17, 18):
+    assert_entries(root_file, "vol14", 0)
+    for tn in (8, 12, 13, 16, 17, 18):
         assert_has_entries(root_file, f"vol{tn}")
 
     assert_root_hash(root_file.name, root_file)