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

File indexing completed on 2025-10-17 07:58:53

 // 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/EventData/TrackParameters.hpp"
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
 #include "Acts/Utilities/Result.hpp"
 #include "Acts/Vertexing/AdaptiveGridTrackDensity.hpp"
 #include "Acts/Vertexing/DummyVertexFitter.hpp"
 #include "Acts/Vertexing/IVertexFinder.hpp"
 #include "Acts/Vertexing/Vertex.hpp"
 #include "Acts/Vertexing/VertexingOptions.hpp"
 
 #include <unordered_map>
 
 namespace Acts {
 
 /// @class AdaptiveGridDensityVertexFinder
 /// @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 vector) are superimposed and the z-value of the bin
 /// with the highest track density is returned as a vertex candidate.
 /// Unlike the GridDensityVertexFinder, this seeder implements an adaptive
 /// version where the density grid grows bigger with added tracks.
 class AdaptiveGridDensityVertexFinder final : public IVertexFinder {
  public:
   /// Type alias for the density map used in adaptive grid vertex finding
   using DensityMap = AdaptiveGridTrackDensity::DensityMap;
 
   /// @brief The Config struct
   struct Config {
     ///@param gDensity The grid density
     explicit Config(const AdaptiveGridTrackDensity& gDensity)
         : gridDensity(gDensity) {}
 
     // The grid density object
     /// Grid density calculator for track density estimation
     AdaptiveGridTrackDensity 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 of grid state for efficient track removal
     bool cacheGridStateForTrackRemoval = true;
 
     // Maximum d0 impact parameter significance to use a track
     /// Maximum d0 impact parameter significance threshold
     double maxD0TrackSignificance = 3.5;
     // Maximum z0 impact parameter significance to use a track
     /// Maximum z0 impact parameter significance threshold
     double maxZ0TrackSignificance = 12.;
     // The actual corresponding cut values in the algorithm
     /// Squared d0 significance cut value for track selection
     double d0SignificanceCut = maxD0TrackSignificance * maxD0TrackSignificance;
     /// Squared z0 significance cut value for track selection
     double z0SignificanceCut = maxZ0TrackSignificance * maxZ0TrackSignificance;
     /// Flag indicating whether to estimate seed width
     bool estimateSeedWidth = false;
 
     // Function to extract parameters from InputTrack
     /// Function to extract track parameters from InputTrack
     InputTrack::Extractor extractParameters;
   };
 
   /// @brief The State struct
   ///
   /// Only needed if cacheGridStateForTrackRemoval == true
   struct State {
     // Map from the z bin values to the corresponding track density
     /// Main density map storing cumulative track density per z-bin
     DensityMap mainDensityMap;
 
     // Map from input track to corresponding track density map
     /// Map storing individual track density contributions
     std::unordered_map<InputTrack, DensityMap> trackDensities;
 
     // Store tracks that have been removed from track collection. These
     // tracks will be removed from the main grid
     /// Vector of tracks to be removed from density calculation
     std::vector<InputTrack> tracksToRemove;
 
     /// Flag indicating whether 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{State{}};
   }
 
   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 AdaptiveGridDensityVertexFinder(const Config& cfg) : m_cfg(cfg) {}
 
  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