SeedFinder.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2023 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/Units.hpp"
#include "Acts/EventData/SpacePointData.hpp"
#include "Acts/Geometry/Extent.hpp"
#include "Acts/Seeding/CandidatesForMiddleSp.hpp"
#include "Acts/Seeding/InternalSeed.hpp"
#include "Acts/Seeding/InternalSpacePoint.hpp"
#include "Acts/Seeding/Neighbour.hpp"
#include "Acts/Seeding/SeedFilter.hpp"
#include "Acts/Seeding/SeedFinderConfig.hpp"
#include "Acts/Seeding/SeedFinderUtils.hpp"
#include "Acts/Seeding/SpacePointGrid.hpp"

#include <array>
#include <limits>
#include <list>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>

namespace Acts {

enum class SpacePointCandidateType : short { eBottom, eTop };

enum class DetectorMeasurementInfo : short { eDefault, eDetailed };

template <typename external_spacepoint_t, typename platform_t = void*>
class SeedFinder {
  // Public methods:

 public:
  struct SeedingState {
    // bottom space point
    std::vector<InternalSpacePoint<external_spacepoint_t>*> compatBottomSP;
    std::vector<InternalSpacePoint<external_spacepoint_t>*> compatTopSP;
    // contains parameters required to calculate circle with linear equation
    // ...for bottom-middle
    std::vector<LinCircle> linCircleBottom;
    // ...for middle-top
    std::vector<LinCircle> linCircleTop;

    // create vectors here to avoid reallocation in each loop
    std::vector<const InternalSpacePoint<external_spacepoint_t>*> topSpVec;
    std::vector<float> curvatures;
    std::vector<float> impactParameters;

    // managing seed candidates for SpM
    CandidatesForMiddleSp<const InternalSpacePoint<external_spacepoint_t>>
        candidates_collector;

    // managing doublet candidates
    boost::container::small_vector<Acts::Neighbour<external_spacepoint_t>, 9>
        bottomNeighbours;
    boost::container::small_vector<Acts::Neighbour<external_spacepoint_t>, 9>
        topNeighbours;

    // Adding space point info
    Acts::SpacePointData spacePointData;
  };

  SeedFinder(const Acts::SeedFinderConfig<external_spacepoint_t>& config);
  ~SeedFinder() = default;
  SeedFinder() = default;
  SeedFinder(const SeedFinder<external_spacepoint_t, platform_t>&) = delete;
  SeedFinder<external_spacepoint_t, platform_t>& operator=(
      const SeedFinder<external_spacepoint_t, platform_t>&) = default;

  template <template <typename...> typename container_t, typename sp_range_t>
  void createSeedsForGroup(
      const Acts::SeedFinderOptions& options, SeedingState& state,
      const Acts::SpacePointGrid<external_spacepoint_t>& grid,
      std::back_insert_iterator<container_t<Seed<external_spacepoint_t>>> outIt,
      const sp_range_t& bottomSPs, const std::size_t middleSPs,
      const sp_range_t& topSPs,
      const Acts::Range1D<float>& rMiddleSPRange) const;

  template <typename sp_range_t>
  std::vector<Seed<external_spacepoint_t>> createSeedsForGroup(
      const Acts::SeedFinderOptions& options,
      const Acts::SpacePointGrid<external_spacepoint_t>& grid,
      const sp_range_t& bottomSPs, const std::size_t middleSPs,
      const sp_range_t& topSPs) const;

 private:
  template <Acts::SpacePointCandidateType candidateType, typename out_range_t>
  void getCompatibleDoublets(
      Acts::SpacePointData& spacePointData,
      const Acts::SeedFinderOptions& options,
      const Acts::SpacePointGrid<external_spacepoint_t>& grid,
      boost::container::small_vector<Neighbour<external_spacepoint_t>, 9>&
          otherSPsNeighbours,
      const InternalSpacePoint<external_spacepoint_t>& mediumSP,
      std::vector<LinCircle>& linCircleVec, out_range_t& outVec,
      const float deltaRMinSP, const float deltaRMaxSP, const float uIP,
      const float uIP2, const float cosPhiM, const float sinPhiM) const;

  template <Acts::DetectorMeasurementInfo detailedMeasurement>
  void filterCandidates(Acts::SpacePointData& spacePointData,
                        const InternalSpacePoint<external_spacepoint_t>& SpM,
                        const Acts::SeedFinderOptions& options,
                        SeedFilterState& seedFilterState,
                        SeedingState& state) const;

 private:
  Acts::SeedFinderConfig<external_spacepoint_t> m_config;
};

}  // namespace Acts

#ifndef DOXYGEN
#include "Acts/Seeding/SeedFinder.ipp"
#endif