refactor: Accumulated vertexing changes in Examples (acts-project#3121)

These are a few accumulated changes for the vertexing performance studies

Core/src/Vertexing/AdaptiveMultiVertexFinder.cpp

@@ -521,6 +521,7 @@ Result<bool> AdaptiveMultiVertexFinder::isMergedVertex(
         auto sumCovZTInverse = safeInverse(sumCovZT);
         if (!sumCovZTInverse) {
           ACTS_ERROR("Vertex z-t covariance matrix is singular.");
+          ACTS_ERROR("sumCovZT:\n" << sumCovZT);
           return Result<bool>::failure(VertexingError::SingularMatrix);
         }
         significance = std::sqrt(deltaZT.dot(*sumCovZTInverse * deltaZT));
@@ -529,6 +530,7 @@ Result<bool> AdaptiveMultiVertexFinder::isMergedVertex(
         const double sumVarZ = otherCov(eZ, eZ) + candidateCov(eZ, eZ);
         if (sumVarZ <= 0) {
           ACTS_ERROR("Variance of the vertex's z-coordinate is not positive.");
+          ACTS_ERROR("sumVarZ:\n" << sumVarZ);
           return Result<bool>::failure(VertexingError::SingularMatrix);
         }
         // Use only z significance
@@ -542,6 +544,7 @@ Result<bool> AdaptiveMultiVertexFinder::isMergedVertex(
         auto sumCovInverse = safeInverse(sumCov);
         if (!sumCovInverse) {
           ACTS_ERROR("Vertex 4D covariance matrix is singular.");
+          ACTS_ERROR("sumCov:\n" << sumCov);
           return Result<bool>::failure(VertexingError::SingularMatrix);
         }
         significance = std::sqrt(deltaPos.dot(*sumCovInverse * deltaPos));
@@ -553,6 +556,7 @@ Result<bool> AdaptiveMultiVertexFinder::isMergedVertex(
         auto sumCovInverse = safeInverse(sumCov);
         if (!sumCovInverse) {
           ACTS_ERROR("Vertex 3D covariance matrix is singular.");
+          ACTS_ERROR("sumCov:\n" << sumCov);
           return Result<bool>::failure(VertexingError::SingularMatrix);
         }
         significance = std::sqrt(deltaPos.dot(*sumCovInverse * deltaPos));

Examples/Algorithms/Vertexing/include/ActsExamples/Vertexing/VertexFitterAlgorithm.hpp

@@ -24,6 +24,7 @@
 #include "ActsExamples/EventData/ProtoVertex.hpp"
 #include "ActsExamples/EventData/Track.hpp"
 #include "ActsExamples/EventData/Trajectories.hpp"
+#include "ActsExamples/EventData/Vertex.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
 #include "ActsExamples/Framework/IAlgorithm.hpp"
 #include "ActsExamples/Framework/ProcessCode.hpp"
@@ -45,14 +46,6 @@ struct AlgorithmContext;
 
 class VertexFitterAlgorithm final : public IAlgorithm {
  public:
-  using Propagator = Acts::Propagator<Acts::EigenStepper<>>;
-  using PropagatorOptions = Acts::PropagatorOptions<>;
-  using Linearizer = Acts::HelicalTrackLinearizer;
-  using VertexFitter = Acts::FullBilloirVertexFitter;
-  using VertexFitterOptions = Acts::VertexingOptions;
-
-  using VertexCollection = std::vector<Acts::Vertex>;
-
   struct Config {
     /// Optional. Input track parameters collection
     std::string inputTrackParameters;
@@ -95,7 +88,7 @@ class VertexFitterAlgorithm final : public IAlgorithm {
   ReadDataHandle<ProtoVertexContainer> m_inputProtoVertices{
       this, "InputProtoVertices"};
 
-  WriteDataHandle<VertexCollection> m_outputVertices{this, "OutputVertices"};
+  WriteDataHandle<VertexContainer> m_outputVertices{this, "OutputVertices"};
 };
 
 }  // namespace ActsExamples

Examples/Algorithms/Vertexing/src/VertexFitterAlgorithm.cpp

@@ -16,6 +16,7 @@
 #include "Acts/Vertexing/TrackAtVertex.hpp"
 #include "Acts/Vertexing/Vertex.hpp"
 #include "ActsExamples/EventData/ProtoVertex.hpp"
+#include "ActsExamples/EventData/Vertex.hpp"
 #include "ActsExamples/Framework/AlgorithmContext.hpp"
 
 #include <ostream>
@@ -41,6 +42,12 @@ ActsExamples::VertexFitterAlgorithm::VertexFitterAlgorithm(
 
 ActsExamples::ProcessCode ActsExamples::VertexFitterAlgorithm::execute(
     const ActsExamples::AlgorithmContext& ctx) const {
+  using Propagator = Acts::Propagator<Acts::EigenStepper<>>;
+  using PropagatorOptions = Acts::PropagatorOptions<>;
+  using Linearizer = Acts::HelicalTrackLinearizer;
+  using VertexFitter = Acts::FullBilloirVertexFitter;
+  using VertexFitterOptions = Acts::VertexingOptions;
+
   // Set up EigenStepper
   Acts::EigenStepper<> stepper(m_cfg.bField);
 
@@ -74,7 +81,7 @@ ActsExamples::ProcessCode ActsExamples::VertexFitterAlgorithm::execute(
 
   std::vector<Acts::InputTrack> inputTracks;
 
-  VertexCollection fittedVertices;
+  VertexContainer fittedVertices;
 
   for (const auto& protoVertex : protoVertices) {
     // un-constrained fit requires at least two tracks

Examples/Framework/include/ActsExamples/EventData/Vertex.hpp

@@ -0,0 +1,20 @@
+// This file is part of the Acts project.
+//
+// Copyright (C) 2024 CERN for the benefit of the Acts project
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#pragma once
+
+#include "Acts/Vertexing/Vertex.hpp"
+
+#include <vector>
+
+namespace ActsExamples {
+
+/// Container of vertices.
+using VertexContainer = std::vector<Acts::Vertex>;
+
+}  // namespace ActsExamples

Examples/Framework/src/Framework/Sequencer.cpp

@@ -313,7 +313,8 @@ std::pair<std::size_t, std::size_t> Sequencer::determineEventsRange() const {
   // since we use event ranges (and not just num events) they might not
   // overlap
   if (end < beg) {
-    ACTS_ERROR("Available events ranges from readers do not overlap");
+    ACTS_ERROR("Available events ranges from readers do not overlap (beg="
+               << beg << ", end=" << end << ")");
     return kInvalidEventsRange;
   }
   // configured readers without available events makes no sense

Examples/Io/Root/include/ActsExamples/Io/Root/RootVertexReader.hpp

@@ -41,8 +41,6 @@ class RootVertexReader : public IReader {
     std::string treeName = "vertices";
     /// The name of the input file
     std::string filePath;
-    /// Whether the events are ordered or not
-    bool orderedEvents = true;
   };
 
   /// Constructor
@@ -99,12 +97,13 @@ class RootVertexReader : public IReader {
   std::vector<float>* m_vy = new std::vector<float>;
   std::vector<float>* m_vz = new std::vector<float>;
   std::vector<float>* m_vt = new std::vector<float>;
+  std::vector<std::vector<std::uint64_t>>* m_outgoingParticles =
+      new std::vector<std::vector<std::uint64_t>>;
+  // Decoded vertex identifier; see Barcode definition for details.
   std::vector<std::uint32_t>* m_vertexPrimary = new std::vector<std::uint32_t>;
   std::vector<std::uint32_t>* m_vertexSecondary =
       new std::vector<std::uint32_t>;
   std::vector<std::uint32_t>* m_generation = new std::vector<std::uint32_t>;
-  std::vector<std::vector<double>>* m_outgoingParticles =
-      new std::vector<std::vector<double>>;
 };
 
 }  // namespace ActsExamples

Examples/Io/Root/include/ActsExamples/Io/Root/RootVertexWriter.hpp

@@ -88,7 +88,7 @@ class RootVertexWriter final : public WriterT<SimVertexContainer> {
   std::vector<float> m_vz;
   std::vector<float> m_vt;
   /// Outgoing particles from the vertex.
-  std::vector<std::vector<double>> m_outgoingParticles;
+  std::vector<std::vector<std::uint64_t>> m_outgoingParticles;
   // Decoded vertex identifier; see Barcode definition for details.
   std::vector<std::uint32_t> m_vertexPrimary;
   std::vector<std::uint32_t> m_vertexSecondary;

Examples/Io/Root/src/RootVertexReader.cpp

@@ -62,8 +62,8 @@ RootVertexReader::RootVertexReader(const RootVertexReader::Config& config,
   m_events = m_inputChain->GetEntries();
   ACTS_DEBUG("The full chain has " << m_events << " entries.");
 
-  // If the events are not in order, get the entry numbers for ordered events
-  if (!m_cfg.orderedEvents) {
+  // Sort the entry numbers of the events
+  {
     m_entryNumbers.resize(m_events);
     m_inputChain->Draw("event_id", "", "goff");
     // Sort to get the entry numbers of the ordered events
@@ -104,13 +104,10 @@ ProcessCode RootVertexReader::read(const AlgorithmContext& context) {
   SimVertexContainer vertices;
 
   // Read the correct entry
-  auto entry = context.eventNumber;
-  if (!m_cfg.orderedEvents && entry < m_entryNumbers.size()) {
-    entry = m_entryNumbers[entry];
-  }
+  auto entry = m_entryNumbers.at(context.eventNumber);
   m_inputChain->GetEntry(entry);
-  ACTS_INFO("Reading event: " << context.eventNumber
-                              << " stored as entry: " << entry);
+  ACTS_DEBUG("Reading event: " << context.eventNumber
+                               << " stored as entry: " << entry);
 
   unsigned int nVertices = m_vertexId->size();
 
@@ -133,6 +130,9 @@ ProcessCode RootVertexReader::read(const AlgorithmContext& context) {
     vertices.insert(v);
   }
 
+  ACTS_DEBUG("Read " << vertices.size() << " vertices for event "
+                     << context.eventNumber);
+
   // Write the collections to the EventStore
   m_outputVertices(context, std::move(vertices));
 

Examples/Io/Root/src/RootVertexWriter.cpp

@@ -101,9 +101,9 @@ ProcessCode RootVertexWriter::writeT(const AlgorithmContext& ctx,
                                            Acts::UnitConstants::mm));
     // TODO ingoing particles
     // outgoing particles
-    std::vector<double> outgoing;
+    std::vector<std::uint64_t> outgoing;
     for (const auto& particle : vertex.outgoing) {
-      outgoing.push_back(static_cast<double>(particle.value()));
+      outgoing.push_back(particle.value());
     }
     m_outgoingParticles.push_back(std::move(outgoing));
     // decoded barcode components

Examples/Python/src/Input.cpp

@@ -1,6 +1,6 @@
 // This file is part of the Acts project.
 //
-// Copyright (C) 2021-2024 CERN for the benefit of the Acts project
+// Copyright (C) 2021 CERN for the benefit of the Acts project
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -45,7 +45,7 @@ void addInput(Context& ctx) {
 
   ACTS_PYTHON_DECLARE_READER(ActsExamples::RootVertexReader, mex,
                              "RootVertexReader", outputVertices, treeName,
-                             filePath, orderedEvents);
+                             filePath);
 
   ACTS_PYTHON_DECLARE_READER(ActsExamples::RootMaterialTrackReader, mex,
                              "RootMaterialTrackReader", outputMaterialTracks,