Trajectories.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
// Copyright (C) 2022 Whitney Armstrong
 
#ifndef JugTrack_Trajectories_HH
#define JugTrack_Trajectories_HH
 
#include "Acts/EventData/MultiTrajectory.hpp"
#include "JugTrack/IndexSourceLink.hpp"
#include "JugTrack/Track.hpp"
 
#include <algorithm>
#include <unordered_map>
#include <vector>
 
namespace Jug {
 
/// Store reconstructed trajectories from track finding/fitting.
///
/// It contains a MultiTrajectory with a vector of entry indices for
/// individual trajectories, and a map of fitted parameters indexed by the
/// entry index. In case of track fitting, there is at most one trajectory
/// in the MultiTrajectory; In case of track finding, there could be
/// multiple trajectories in the MultiTrajectory.
struct Trajectories final {
 public:
  /// (Reconstructed) trajectory with multiple states.
  using MultiTrajectory = ::Acts::MultiTrajectory;
  /// Fitted parameters identified by indices in the multi trajectory.
  using IndexedParameters = std::unordered_map<size_t, TrackParameters>;
 
  /// Default construct an empty object. Required for container compatibility
  /// and to signal an error.
  Trajectories() = default;
  /// Construct from fitted multi trajectory and parameters.
  ///
  /// @param multiTraj The multi trajectory
  /// @param tTips Tip indices that identify valid trajectories
  /// @param parameters Fitted track parameters indexed by trajectory index
  Trajectories(const MultiTrajectory& multiTraj,
               const std::vector<size_t>& tTips,
               const IndexedParameters& parameters)
      : m_multiTrajectory(multiTraj),
        m_trackTips(tTips),
        m_trackParameters(parameters) {}
 
  /// Return true if there exists no valid trajectory.
  bool empty() const { return m_trackTips.empty(); }
 
  /// Access the underlying multi trajectory.
  const MultiTrajectory& multiTrajectory() const { return m_multiTrajectory; }
 
  /// Access the tip indices that identify valid trajectories.
  const std::vector<size_t>& tips() const { return m_trackTips; }
 
  /// Check if a trajectory exists for the given index.
  ///
  /// @param entryIndex The trajectory entry index
  /// @return Whether there is trajectory with provided entry index
  bool hasTrajectory(size_t entryIndex) const {
    return (0 < std::count(m_trackTips.begin(), m_trackTips.end(), entryIndex));
  }
 
  /// Check if fitted track parameters exists for the given index.
  ///
  /// @param entryIndex The trajectory entry index
  /// @return Whether having fitted track parameters or not
  bool hasTrackParameters(size_t entryIndex) const {
    return (0 < m_trackParameters.count(entryIndex));
  }
 
  /// Access the fitted track parameters for the given index.
  ///
  /// @param entryIndex The trajectory entry index
  /// @return The fitted track parameters of the trajectory
  const TrackParameters& trackParameters(size_t entryIndex) const {
    auto it = m_trackParameters.find(entryIndex);
    if (it == m_trackParameters.end()) {
      throw std::runtime_error(
          "No fitted track parameters for trajectory with entry index = " +
          std::to_string(entryIndex));
    }
    return it->second;
  }
 
 private:
  // The multiTrajectory
  MultiTrajectory m_multiTrajectory;
  // The entry indices of trajectories stored in multiTrajectory
  std::vector<size_t> m_trackTips = {};
  // The fitted parameters at the provided surface for individual trajectories
  IndexedParameters m_trackParameters = {};
};
 
/// Container for multiple trajectories.
using TrajectoriesContainer = std::vector<Trajectories>;
 
} // namespace Jug
#endif