EIC code displayed by LXR master/​acts/​Core/​include/​Acts/​AmbiguityResolution/​ScoreBasedAmbiguityResolution.hpp	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-07-15 08:11:44

 // This file is part of the ACTS project.
 //
 // Copyright (C) 2016 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 https://mozilla.org/MPL/2.0/.
 
 #pragma once
 
 #include "Acts/Definitions/Units.hpp"
 #include "Acts/EventData/TrackContainer.hpp"
 #include "Acts/EventData/TrackContainerFrontendConcept.hpp"
 #include "Acts/EventData/TrackProxyConcept.hpp"
 #include "Acts/EventData/TrackStateProxy.hpp"
 #include "Acts/Utilities/Delegate.hpp"
 #include "Acts/Utilities/Logger.hpp"
 
 #include <cstddef>
 #include <map>
 #include <memory>
 #include <numbers>
 #include <string>
 #include <tuple>
 #include <vector>
 
 #include <boost/container/flat_map.hpp>
 #include <boost/container/flat_set.hpp>
 
 namespace Acts {
 
 /// Generic implementation of the score based ambiguity resolution.
 /// The alhorithm is based on the following steps:
 /// 1) Compute the initial state of the tracks
 /// 2) Compute the score of each track
 /// 3) Removes hits that are not good enough for each track
 /// 4) Remove tracks that have a score below a certain threshold or not have
 /// enough hits
 /// 5) Remove tracks that are not good enough based on cuts Contains method for
 /// data preparations
 
 class ScoreBasedAmbiguityResolution {
  public:
   /// @brief Detector configuration struct : contains the configuration for each detector
   ///
   /// The configuration can be saved in a json file and loaded from there.
   ///
   struct DetectorConfig {
     int hitsScoreWeight = 0;
     int holesScoreWeight = 0;
     int outliersScoreWeight = 0;
     int otherScoreWeight = 0;
 
     // the eta bins for the detector
     std::vector<double> etaBins = {-5, 5};
 
     // the minimum number of hits for each eta bin
     std::vector<std::size_t> minHitsPerEta = {0};
 
     // the maximum number of holes for each eta bin
     std::vector<std::size_t> maxHolesPerEta = {0};
 
     // the maximum number of outliers for each eta bin
     std::vector<std::size_t> maxOutliersPerEta = {0};
 
     // the maximum number of shared hits for each eta bin
     std::vector<std::size_t> maxSharedHitsPerEta = {0};
 
     std::size_t maxHits = 0;
     std::size_t maxHoles = 0;
 
     /// if true, the shared hits are considered as bad hits for this detector
     bool sharedHitsFlag = false;
 
     std::size_t detectorId = 0;
 
     /// a list of values from  0 to 1, the higher number of hits, higher value
     /// in the list is multiplied to ambuiguity score applied only if
     /// useAmbiguityScoring is true
     std::vector<double> factorHits = {1.0};
 
     /// a list of values from  0 to 1, the higher number of holes, lower value
     /// in the list is multiplied to ambuiguity score applied only if
     /// useAmbiguityScoring is true
     std::vector<double> factorHoles = {1.0};
   };
 
   /// @brief  TrackFeatures struct : contains the features that are counted for each track.
   ///
   /// The trackFeatures is used to compute the score of each track
   struct TrackFeatures {
     std::size_t nHits = 0;
     std::size_t nHoles = 0;
     std::size_t nOutliers = 0;
     std::size_t nSharedHits = 0;
   };
 
   enum class TrackStateTypes : std::uint8_t {
     // A measurement not yet used in any other track
     UnsharedHit,
     // A measurement shared with another track
     SharedHit,
     // A hit that needs to be removed from the track
     RejectedHit,
     // An outlier, to be copied in case
     Outlier,
     // Other trackstate types to be copied in case
     OtherTrackStateType
   };
 
   /// @brief Configuration struct : contains the configuration for the ambiguity resolution.
   struct Config {
     std::map<std::size_t, std::size_t> volumeMap = {{0, 0}};
     std::vector<DetectorConfig> detectorConfigs;
     /// minimum score for any track
     double minScore = 0;
     /// minimum score for shared tracks
     double minScoreSharedTracks = 0;
     /// maximum number of shared tracks per measurement
     std::size_t maxSharedTracksPerMeasurement = 10;
     /// maximum number of shared hit per track
     std::size_t maxShared = 5;
     /// minimum number of unshared hits per track
     std::size_t minUnshared = 5;
 
     // if true, the ambiguity score is computed based on a different function.
     bool useAmbiguityScoring = false;
   };
 
   /// @brief Optionals struct: contains the optional cuts, weights and score to be applied.
   ///
   /// The default cuts and scoring has only a basic set of cuts and
   /// score-modifiers. For more flexibility users can define custom cuts and
   /// scores using this structure.
   template <TrackProxyConcept track_proxy_t>
   struct Optionals {
     using OptionalCuts = std::function<bool(const track_proxy_t&)>;
 
     using OptionalScoreModifier =
         std::function<void(const track_proxy_t&, double&)>;
 
     using OptionalHitSelection = std::function<void(
         const track_proxy_t&,
         const typename track_proxy_t::ConstTrackStateProxy&, TrackStateTypes&)>;
 
     std::vector<OptionalCuts> cuts = {};
     std::vector<OptionalScoreModifier> weights = {};
 
     /// applied only if useAmbiguityScoring is true
     std::vector<OptionalScoreModifier> scores = {};
     std::vector<OptionalHitSelection> hitSelections = {};
   };
 
   explicit ScoreBasedAmbiguityResolution(
       const Config& cfg,
       std::unique_ptr<const Logger> logger =
           getDefaultLogger("ScoreBasedAmbiguityResolution", Logging::INFO))
       : m_cfg{cfg}, m_logger{std::move(logger)} {}
 
   /// Compute the initial state of the tracks.
   ///
   /// @param tracks is the input track container
   /// @return trackFeaturesVectors is the trackFeatures map from detector ID to trackFeatures
   template <TrackContainerFrontend track_container_t>
   std::vector<std::vector<TrackFeatures>> computeInitialState(
       const track_container_t& tracks) const;
 
   /// Compute the score of each track.
   ///
   /// @param tracks is the input track container
   /// @param trackFeaturesVectors is the trackFeatures map from detector ID to trackFeatures
   /// @param optionals is the user defined optional cuts to be applied.
   /// @return a vector of scores for each track
   template <TrackContainerFrontend track_container_t>
   std::vector<double> simpleScore(
       const track_container_t& tracks,
       const std::vector<std::vector<TrackFeatures>>& trackFeaturesVectors,
       const Optionals<typename track_container_t::ConstTrackProxy>& optionals =
           {}) const;
 
   /// Compute the score of each track based on the ambiguity function.
   ///
   /// @param tracks is the input track container
   /// @param trackFeaturesVectors is the trackFeatures map from detector ID to trackFeatures
   /// @param optionals is the user defined optional cuts to be applied.
   /// @return a vector of scores for each track
   template <TrackContainerFrontend track_container_t>
   std::vector<double> ambiguityScore(
       const track_container_t& tracks,
       const std::vector<std::vector<TrackFeatures>>& trackFeaturesVectors,
       const Optionals<typename track_container_t::ConstTrackProxy>& optionals =
           {}) const;
 
   /// Rejects Tracks based on eta dependent cuts.
   ///
   /// @param detector is the detector configuration object
   /// @param trackFeatures is the trackFeatures object for a specific detector
   /// @param eta is the eta of the track
   /// @return true if the track is rejected, false otherwise
   bool etaBasedCuts(const DetectorConfig& detector,
                     const TrackFeatures& trackFeatures,
                     const double& eta) const;
 
   /// Remove hits that are not good enough for each track and removes tracks
   /// that have a score below a certain threshold or not enough hits.
   ///
   /// @brief Remove tracks that are not good enough based on cuts
   /// @param track is the input track
   /// @param trackScore is the score of each track
   /// @param measurementsPerTrack is the list of measurements for each track
   /// @param nTracksPerMeasurement is the number of tracks per measurement
   /// @param optionalHitSelections is the optional hit selections to be applied
   /// @return a vector of IDs of the tracks we want to keep
   template <TrackProxyConcept track_proxy_t>
   bool getCleanedOutTracks(
       const track_proxy_t& track, const double& trackScore,
       const std::vector<std::size_t>& measurementsPerTrack,
       const std::map<std::size_t, std::size_t>& nTracksPerMeasurement,
       const std::vector<std::function<
           void(const track_proxy_t&,
                const typename track_proxy_t::ConstTrackStateProxy&,
                TrackStateTypes&)>>& optionalHitSelections = {}) const;
 
   /// Remove tracks that are bad based on cuts and weighted scores.
   ///
   /// @brief Remove tracks that are not good enough
   /// @param tracks is the input track container
   /// @param sourceLinkHash is the  source links
   /// @param sourceLinkEquality is the equality function for the source links
   /// @param optionals are the optional cuts and score modifiers to be applied
   /// @return a vector of IDs of the tracks we want to keep
   template <TrackContainerFrontend track_container_t,
             typename source_link_hash_t, typename source_link_equality_t>
   std::vector<int> solveAmbiguity(
       const track_container_t& tracks, source_link_hash_t sourceLinkHash,
       source_link_equality_t sourceLinkEquality,
       const Optionals<typename track_container_t::ConstTrackProxy>& optionals =
           {}) const;
 
  private:
   Config m_cfg;
 
   /// Logging instance
   std::unique_ptr<const Logger> m_logger = nullptr;
 
   /// Private access to logging instance
   const Logger& logger() const;
 };
 
 }  // namespace Acts
 
 #include "Acts/AmbiguityResolution/ScoreBasedAmbiguityResolution.ipp"

This page was automatically generated by the 2.3.7 LXR engine. The LXR team