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

File indexing completed on 2025-12-15 09:42:31

 // 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/Algebra.hpp"
 #include "Acts/EventData/TrackParameters.hpp"
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
 #include "Acts/Utilities/Result.hpp"
 #include "Acts/Vertexing/DummyVertexFitter.hpp"
 #include "Acts/Vertexing/GaussianGridTrackDensity.hpp"
 #include "Acts/Vertexing/IVertexFinder.hpp"
 #include "Acts/Vertexing/Vertex.hpp"
 #include "Acts/Vertexing/VertexingOptions.hpp"
 
 #include <map>
 
 namespace Acts {
 
 /// @class GridDensityVertexFinder
 /// @brief Vertex finder that makes use of a track density grid.
 /// Each single track is modelled as a 2(!)-dim Gaussian distribution grid
 /// in the d0-z0 plane, but only the overlap with the z-axis (i.e. a 1-dim
 /// density vector) needs to be calculated. All track contributions along the
 /// beam axis (main density grid) a superimposed and the z-value of the bin
 /// with the highest track density is returned as a vertex candidate.
 class GridDensityVertexFinder final : public IVertexFinder {
  public:
   /// Type alias for main grid vector used in density calculations
   using MainGridVector = GaussianGridTrackDensity::MainGridVector;
   /// Type alias for track grid vector used for individual track density
   using TrackGridVector = GaussianGridTrackDensity::TrackGridVector;
 
   /// @brief The Config struct
   struct Config {
     ///@param gDensity The grid density
     explicit Config(GaussianGridTrackDensity gDensity)
         : gridDensity(gDensity) {}
 
     /// The grid density object for track density calculations
     GaussianGridTrackDensity gridDensity;
 
     // Cache the main grid and the density contributions (trackGrid and z-bin)
     // for every single track.
     // This option enables the possibility to calculate the entire main grid
     // only once in the first iteration. If tracks are removed from the track
     // collection, the individual track density contributions to the main grid
     // can just be removed without calculating the entire grid from scratch.
     /// Flag to enable caching grid state for efficient track removal
     bool cacheGridStateForTrackRemoval = true;
 
     /// Maximum d0 impact parameter significance to use a track
     double maxD0TrackSignificance = 3.5;
     /// Maximum z0 impact parameter significance to use a track
     double maxZ0TrackSignificance = 12.;
     /// The actual corresponding cut values in the algorithm for d0
     double d0SignificanceCut = maxD0TrackSignificance * maxD0TrackSignificance;
     /// The actual corresponding cut values in the algorithm for z0
     double z0SignificanceCut = maxZ0TrackSignificance * maxZ0TrackSignificance;
     /// Flag to enable seed width estimation from track density
     bool estimateSeedWidth = false;
 
     /// Function to extract parameters from InputTrack
     InputTrack::Extractor extractParameters;
   };
 
   /// @brief The State struct
   ///
   /// Only needed if cacheGridStateForTrackRemoval == true
   struct State {
     /// Constructor with main grid vector
     /// @param mainGrid_ The main density grid for vertex finding
     explicit State(MainGridVector mainGrid_) : mainGrid(std::move(mainGrid_)) {}
 
     /// The main density grid for vertex finding
     MainGridVector mainGrid;
     /// Map to store z-bin and track grid (i.e. the density contribution of
     /// a single track to the main grid) for every single track
     std::map<InputTrack, std::pair<int, TrackGridVector>> binAndTrackGridMap;
 
     /// Map to store bool if track has passed track selection or not
     std::map<InputTrack, bool> trackSelectionMap;
 
     /// Store tracks that have been removed from track collection. These
     /// track will be removed from the main grid
     std::vector<InputTrack> tracksToRemove;
 
     /// Flag indicating if the state has been initialized
     bool isInitialized = false;
   };
 
   /// @brief Function that finds single vertex candidate
   ///
   /// @param trackVector Input track collection
   /// @param vertexingOptions Vertexing options
   /// @param anyState The state object to cache the density grid
   /// and density contributions of each track, to be used
   /// if cacheGridStateForTrackRemoval == true
   ///
   /// @return Vector of vertices, filled with a single
   ///         vertex (for consistent interfaces)
   Result<std::vector<Vertex>> find(
       const std::vector<InputTrack>& trackVector,
       const VertexingOptions& vertexingOptions,
       IVertexFinder::State& anyState) const override;
 
   IVertexFinder::State makeState(
       const Acts::MagneticFieldContext& /*mctx*/) const override {
     return IVertexFinder::State{
         std::in_place_type<State>,
         MainGridVector{m_cfg.gridDensity.config().mainGridSize}};
   }
 
   void setTracksToRemove(
       IVertexFinder::State& anyState,
       const std::vector<InputTrack>& removedTracks) const override {
     auto& state = anyState.template as<State>();
     state.tracksToRemove = removedTracks;
   }
 
   /// @brief Constructor for user-defined InputTrack type
   ///
   /// @param cfg Configuration object
   explicit GridDensityVertexFinder(const Config& cfg) : m_cfg(cfg) {
     if (!m_cfg.extractParameters.connected()) {
       throw std::invalid_argument(
           "GridDensityVertexFinder: "
           "No track parameter extractor provided.");
     }
   }
 
  private:
   /// @brief Checks if a track passes the selection criteria for seeding
   ///
   /// @param trk The track
   ///
   /// @return Bool track passes selection
   bool doesPassTrackSelection(const BoundTrackParameters& trk) const;
 
   // The configuration object
   const Config m_cfg;
 };
 
 }  // namespace Acts

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