chore: Centrally typedef truth info in Examples (#5254)

- centrally typedef `MeasurementParticlesMap = IndexMultimap<SimBarcode>`
- centrally typedef `MeasurementSimHitsMap = IndexMultimap<Index>`
- centrally typedef `ParticleMeasurementsMap = InverseMultimap<SimBarcode>`
- centrally typedef `SimHitMeasurementsMap = InverseMultimap<Index>`
- use `SimBarcode` over `ActsFatras::Barcode` in Examples
- move `ParticleHitCount` to `TruthMatching.hpp`
- add typedefs for `VertexTruthMatching` and `TruthVertexMatching`
- include cleanups

Author: andiwand

Examples/Algorithms/Digitization/include/ActsExamples/Digitization/DigitizationAlgorithm.hpp

@@ -15,7 +15,7 @@
 #include "ActsExamples/EventData/Cluster.hpp"
 #include "ActsExamples/EventData/Measurement.hpp"
 #include "ActsExamples/EventData/SimHit.hpp"
-#include "ActsExamples/EventData/SimParticle.hpp"
+#include "ActsExamples/EventData/TruthMatching.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
 #include "ActsExamples/Framework/IAlgorithm.hpp"
 #include "ActsExamples/Framework/ProcessCode.hpp"
@@ -144,14 +144,14 @@ class DigitizationAlgorithm final : public IAlgorithm {
   WriteDataHandle<CellsMap> m_outputCells{this, "OutputCells"};
   WriteDataHandle<ClusterContainer> m_outputClusters{this, "OutputClusters"};
 
-  WriteDataHandle<IndexMultimap<SimBarcode>> m_outputMeasurementParticlesMap{
+  WriteDataHandle<MeasurementParticlesMap> m_outputMeasurementParticlesMap{
       this, "OutputMeasurementParticlesMap"};
-  WriteDataHandle<IndexMultimap<Index>> m_outputMeasurementSimHitsMap{
+  WriteDataHandle<MeasurementSimHitsMap> m_outputMeasurementSimHitsMap{
       this, "OutputMeasurementSimHitsMap"};
 
-  WriteDataHandle<InverseMultimap<SimBarcode>> m_outputParticleMeasurementsMap{
+  WriteDataHandle<ParticleMeasurementsMap> m_outputParticleMeasurementsMap{
       this, "OutputParticleMeasurementsMap"};
-  WriteDataHandle<InverseMultimap<Index>> m_outputSimHitMeasurementsMap{
+  WriteDataHandle<SimHitMeasurementsMap> m_outputSimHitMeasurementsMap{
       this, "OutputSimHitMeasurementsMap"};
 
   /// Construct a fixed-size smearer from a configuration.

Examples/Algorithms/Digitization/include/ActsExamples/Digitization/ModuleClusters.hpp

@@ -29,14 +29,12 @@ struct ModuleValue {
   std::vector<double> paramValues = {};
   std::vector<double> paramVariances = {};
   std::variant<Cluster, Cluster::Cell> value;
-  std::set<SimHitContainer::size_type> sources = {};
+  std::set<SimHitIndex> sources = {};
   Acts::Ccl::Label label = {Acts::Ccl::NO_LABEL};
 };
 
 class ModuleClusters {
  public:
-  using simhit_t = SimHitContainer::size_type;
-
   ModuleClusters(Acts::BinUtility segmentation,
                  std::vector<Acts::BoundIndices> geoIndices, bool merge,
                  double nsigma, bool commonCorner)
@@ -46,8 +44,8 @@ class ModuleClusters {
         m_nsigma(nsigma),
         m_commonCorner(commonCorner) {}
 
-  void add(DigitizedParameters params, simhit_t simhit);
-  std::vector<std::pair<DigitizedParameters, std::set<simhit_t>>>
+  void add(DigitizedParameters params, SimHitIndex simhit);
+  std::vector<std::pair<DigitizedParameters, std::set<SimHitIndex>>>
   digitizedParameters();
 
  private:

Examples/Algorithms/Digitization/include/ActsExamples/Digitization/MuonSpacePointDigitizer.hpp

@@ -10,12 +10,12 @@
 
 #include "Acts/Geometry/TrackingGeometry.hpp"
 #include "Acts/Utilities/Logger.hpp"
-#include "Acts/Utilities/RangeXD.hpp"
 #include "ActsExamples/EventData/Measurement.hpp"
 #include "ActsExamples/EventData/MuonSpacePoint.hpp"
 #include "ActsExamples/EventData/MuonSpacePointCalibrator.hpp"
 #include "ActsExamples/EventData/SimHit.hpp"
 #include "ActsExamples/EventData/SimParticle.hpp"
+#include "ActsExamples/EventData/TruthMatching.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
 #include "ActsExamples/Framework/IAlgorithm.hpp"
 #include "ActsExamples/Framework/ProcessCode.hpp"
@@ -101,14 +101,14 @@ class MuonSpacePointDigitizer final : public IAlgorithm {
   WriteDataHandle<MeasurementContainer> m_outputMeasurements{
       this, "OutputMeasurements"};
 
-  WriteDataHandle<IndexMultimap<SimBarcode>> m_outputMeasurementParticlesMap{
+  WriteDataHandle<MeasurementParticlesMap> m_outputMeasurementParticlesMap{
       this, "OutputMeasurementParticlesMap"};
-  WriteDataHandle<IndexMultimap<Index>> m_outputMeasurementSimHitsMap{
+  WriteDataHandle<MeasurementSimHitsMap> m_outputMeasurementSimHitsMap{
       this, "OutputMeasurementSimHitsMap"};
 
-  WriteDataHandle<InverseMultimap<SimBarcode>> m_outputParticleMeasurementsMap{
+  WriteDataHandle<ParticleMeasurementsMap> m_outputParticleMeasurementsMap{
       this, "OutputParticleMeasurementsMap"};
-  WriteDataHandle<InverseMultimap<Index>> m_outputSimHitMeasurementsMap{
+  WriteDataHandle<SimHitMeasurementsMap> m_outputSimHitMeasurementsMap{
       this, "OutputSimHitMeasurementsMap"};
 };
 }  // namespace ActsExamples

Examples/Algorithms/Digitization/src/DigitizationAlgorithm.cpp

@@ -112,7 +112,7 @@ DigitizationAlgorithm::DigitizationAlgorithm(
 
     auto dup = std::adjacent_find(indices.begin(), indices.end());
     if (dup != indices.end()) {
-      std::invalid_argument(
+      throw std::invalid_argument(
           "Digitization configuration contains duplicate parameter indices");
     }
 
@@ -150,8 +150,8 @@ ProcessCode DigitizationAlgorithm::execute(const AlgorithmContext& ctx) const {
   MeasurementContainer measurements;
   ClusterContainer clusters;
 
-  IndexMultimap<SimBarcode> measurementParticlesMap;
-  IndexMultimap<Index> measurementSimHitsMap;
+  MeasurementParticlesMap measurementParticlesMap;
+  MeasurementSimHitsMap measurementSimHitsMap;
   measurements.reserve(simHits.size());
   measurementParticlesMap.reserve(simHits.size());
   measurementSimHitsMap.reserve(simHits.size());

Examples/Algorithms/Digitization/src/ModuleClusters.cpp

@@ -11,6 +11,7 @@
 #include "Acts/Clusterization/Clusterization.hpp"
 #include "Acts/Utilities/Helpers.hpp"
 #include "ActsExamples/Digitization/MeasurementCreation.hpp"
+#include "ActsExamples/EventData/SimHit.hpp"
 
 #include <array>
 #include <cmath>
@@ -21,7 +22,7 @@
 
 namespace ActsExamples {
 
-void ModuleClusters::add(DigitizedParameters params, simhit_t simhit) {
+void ModuleClusters::add(DigitizedParameters params, SimHitIndex simhit) {
   ModuleValue mval;
   mval.paramIndices = std::move(params.indices);
   mval.paramValues = std::move(params.values);
@@ -42,12 +43,12 @@ void ModuleClusters::add(DigitizedParameters params, simhit_t simhit) {
   }
 }
 
-std::vector<std::pair<DigitizedParameters, std::set<ModuleClusters::simhit_t>>>
+std::vector<std::pair<DigitizedParameters, std::set<SimHitIndex>>>
 ModuleClusters::digitizedParameters() {
   if (m_merge) {  // (re-)build the clusters
     merge();
   }
-  std::vector<std::pair<DigitizedParameters, std::set<simhit_t>>> retv;
+  std::vector<std::pair<DigitizedParameters, std::set<SimHitIndex>>> retv;
   for (ModuleValue& mval : m_moduleValues) {
     if (std::holds_alternative<Cluster::Cell>(mval.value)) {
       // Should never happen! Either the cluster should have

Examples/Algorithms/Digitization/src/MuonSpacePointDigitizer.cpp

@@ -160,8 +160,8 @@ ProcessCode MuonSpacePointDigitizer::execute(
   // need list here for stable addresses
   MeasurementContainer measurements;
 
-  IndexMultimap<SimBarcode> measurementParticlesMap;
-  IndexMultimap<Index> measurementSimHitsMap;
+  MeasurementParticlesMap measurementParticlesMap;
+  MeasurementSimHitsMap measurementSimHitsMap;
   measurements.reserve(gotSimHits.size());
   measurementParticlesMap.reserve(gotSimHits.size());
   measurementSimHitsMap.reserve(gotSimHits.size());

Examples/Algorithms/Geant4/src/ParticleKillAction.cpp

@@ -60,7 +60,7 @@ void ParticleKillAction::UserSteppingAction(const G4Step* step) {
   // check if we have a particle assigned to track
   if (trackIt != eventStore().trackIdMapping.end()) {
     // set the outcome of the particle
-    const ActsFatras::Barcode particleId = trackIt->second;
+    const SimBarcode particleId = trackIt->second;
     if (outOfVolume) {
       eventStore().particleOutcome[particleId] =
           ActsFatras::ParticleOutcome::KilledVolumeExit;

Examples/Algorithms/Geant4/src/SensitiveSteppingAction.cpp

@@ -13,7 +13,7 @@
 #include "Acts/Geometry/GeometryIdentifier.hpp"
 #include "Acts/Propagator/detail/SteppingLogger.hpp"
 #include "Acts/Surfaces/Surface.hpp"
-#include "Acts/Utilities/MultiIndex.hpp"
+#include "ActsExamples/EventData/SimParticle.hpp"
 #include "ActsExamples/Geant4/AlgebraConverters.hpp"
 #include "ActsExamples/Geant4/EventStore.hpp"
 #include "ActsExamples/Geant4/SensitiveSurfaceMapper.hpp"
@@ -67,7 +67,8 @@ std::array<Acts::Vector4, 4u> kinematicsOfStep(const G4Step* step) {
   return {preStepPosition, preStepMomentum, postStepPosition, postStepMomentum};
 }
 
-ActsFatras::Hit hitFromStep(const G4Step* step, ActsFatras::Barcode particleId,
+ActsFatras::Hit hitFromStep(const G4Step* step,
+                            ActsExamples::SimBarcode particleId,
                             Acts::GeometryIdentifier geoId,
                             std::int32_t index) {
   auto [preStepPosition, preStepMomentum, postStepPosition, postStepMomentum] =

Examples/Algorithms/GeneratorsPythia8/ActsExamples/Generators/Pythia8ProcessGenerator.cpp

@@ -8,17 +8,10 @@
 
 #include "ActsExamples/Generators/Pythia8ProcessGenerator.hpp"
 
-#include "Acts/Utilities/MathHelpers.hpp"
-#include "ActsExamples/EventData/SimVertex.hpp"
-#include "ActsFatras/EventData/Barcode.hpp"
-#include "ActsFatras/EventData/Particle.hpp"
 #include "ActsPlugins/FpeMonitoring/FpeMonitor.hpp"
 
-#include <algorithm>
-#include <iterator>
 #include <ostream>
 #include <random>
-#include <utility>
 
 #include <HepMC3/WriterAscii.h>
 #include <Pythia8/Pythia.h>

Examples/Algorithms/TrackFindingGnn/include/ActsExamples/TrackFindingGnn/TruthGraphBuilder.hpp

@@ -9,10 +9,10 @@
 #pragma once
 
 #include "ActsExamples/EventData/Graph.hpp"
-#include "ActsExamples/EventData/Index.hpp"
 #include "ActsExamples/EventData/SimHit.hpp"
 #include "ActsExamples/EventData/SimParticle.hpp"
 #include "ActsExamples/EventData/SpacePoint.hpp"
+#include "ActsExamples/EventData/TruthMatching.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
 #include "ActsExamples/Framework/IAlgorithm.hpp"
 
@@ -60,20 +60,20 @@ class TruthGraphBuilder final : public IAlgorithm {
   std::vector<std::int64_t> buildFromMeasurements(
       const SpacePointContainer& spacePoints,
       const SimParticleContainer& particles,
-      const IndexMultimap<ActsFatras::Barcode>& measPartMap) const;
+      const MeasurementParticlesMap& measPartMap) const;
 
   std::vector<std::int64_t> buildFromSimhits(
       const SpacePointContainer& spacePoints,
-      const IndexMultimap<Index>& measHitMap, const SimHitContainer& simhits,
+      const MeasurementSimHitsMap& measHitMap, const SimHitContainer& simhits,
       const SimParticleContainer& particles) const;
 
   ReadDataHandle<SpacePointContainer> m_inputSpacePoints{this,
                                                          "InputSpacePoints"};
   ReadDataHandle<SimParticleContainer> m_inputParticles{this, "InputParticles"};
-  ReadDataHandle<IndexMultimap<ActsFatras::Barcode>> m_inputMeasParticlesMap{
+  ReadDataHandle<MeasurementParticlesMap> m_inputMeasParticlesMap{
       this, "InputMeasParticlesMap"};
   ReadDataHandle<SimHitContainer> m_inputSimhits{this, "InputSimhits"};
-  ReadDataHandle<IndexMultimap<Index>> m_inputMeasSimhitMap{
+  ReadDataHandle<MeasurementSimHitsMap> m_inputMeasSimhitMap{
       this, "InputMeasSimhitMap"};
 
   WriteDataHandle<Graph> m_outputGraph{this, "OutputGraph"};