GaussianGridTrackDensity.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file GaussianGridTrackDensity.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2020 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/Definitions/Algebra.hpp"
#include "Acts/EventData/TrackParameters.hpp"
#include "Acts/Utilities/Result.hpp"

namespace Acts {
template <int mainGridSize = 2000, int trkGridSize = 15>
class GaussianGridTrackDensity {
  // Assert odd trkGridSize
  static_assert(trkGridSize % 2);
  // Assert bigger main grid than track grid
  static_assert(mainGridSize > trkGridSize);

 public:
  using MainGridVector = Eigen::Matrix<float, mainGridSize, 1>;
  using TrackGridVector = Eigen::Matrix<float, trkGridSize, 1>;

  struct Config {
    Config(float zMinMax_ = 100) : zMinMax(zMinMax_) {
      binSize = 2. * zMinMax / mainGridSize;
    }
    // Min and max z value of big grid
    float zMinMax;  // mm

    // Z size of one single bin in grid
    float binSize;  // mm

    // Do NOT use just the z-bin with the highest
    // track density, but instead check the (up to)
    // first three density maxima (only those that have
    // a maximum relative deviation of 'relativeDensityDev'
    // from the main maximum) and take the z-bin of the
    // maximum with the highest surrounding density sum
    bool useHighestSumZPosition = false;

    // The maximum relative density deviation from the main
    // maximum to consider the second and third maximum for
    // the highest-sum approach from above
    float maxRelativeDensityDev = 0.01;
  };

  GaussianGridTrackDensity(const Config& cfg) : m_cfg(cfg) {}

  Result<float> getMaxZPosition(MainGridVector& mainGrid) const;

  Result<std::pair<float, float>> getMaxZPositionAndWidth(
      MainGridVector& mainGrid) const;

  std::pair<int, TrackGridVector> addTrack(const BoundTrackParameters& trk,
                                           MainGridVector& mainGrid) const;

  void removeTrackGridFromMainGrid(int zBin, const TrackGridVector& trkGrid,
                                   MainGridVector& mainGrid) const;

 private:
  void addTrackGridToMainGrid(int zBin, const TrackGridVector& trkGrid,
                              MainGridVector& mainGrid) const;

  void modifyMainGridWithTrackGrid(int zBin, const TrackGridVector& trkGrid,
                                   MainGridVector& mainGrid,
                                   int modifyModeSign) const;

  TrackGridVector createTrackGrid(float d0, float distCtrZ,
                                  const Acts::SquareMatrix2& cov) const;

  Result<float> estimateSeedWidth(MainGridVector& mainGrid, float maxZ) const;

  float normal2D(float d, float z, const SquareMatrix2& cov) const;

  int getHighestSumZPosition(MainGridVector& mainGrid) const;

  double getDensitySum(const MainGridVector& mainGrid, int pos) const;

  Config m_cfg;
};

}  // namespace Acts

#include "Acts/Vertexing/GaussianGridTrackDensity.ipp"