traccc/seeding/seeding_algorithm.hpp

0001 /** TRACCC library, part of the ACTS project (R&D line)
0002  *
0003  * (c) 2021-2025 CERN for the benefit of the ACTS project
0004  *
0005  * Mozilla Public License Version 2.0
0006  */
0007
0008 #pragma once
0009
0010 // Local include(s).
0011 #include "traccc/edm/seed_collection.hpp"
0012 #include "traccc/edm/spacepoint_collection.hpp"
0013 #include "traccc/seeding/detail/seed_finding.hpp"
0014 #include "traccc/seeding/detail/seeding_config.hpp"
0015 #include "traccc/seeding/detail/spacepoint_binning.hpp"
0016 #include "traccc/utils/algorithm.hpp"
0017 #include "traccc/utils/messaging.hpp"
0018
0019 // VecMem include(s).
0020 #include <vecmem/memory/memory_resource.hpp>
0021
0022 // System include(s).
0023 #include <memory>
0024
0025 namespace traccc::host {
0026
0027 /// Main algorithm for performing the track seeding on the CPU
0028 class seeding_algorithm : public algorithm<edm::seed_collection::host(
0029                               const edm::spacepoint_collection::const_view&)>,
0030                           public messaging {
0031  public:
0032   /// Constructor for the seed finding algorithm
0033   ///
0034   /// @param finder_config The configuration for the seed finder
0035   /// @param grid_config The configuration for the spacepoint grid
0036   /// @param filter_config The configuration for the seed filter
0037   /// @param mr The memory resource to use
0038   ///
0039   seeding_algorithm(
0040       const seedfinder_config& finder_config,
0041       const spacepoint_grid_config& grid_config,
0042       const seedfilter_config& filter_config, vecmem::memory_resource& mr,
0043       std::unique_ptr<const Logger> logger = getDummyLogger().clone());
0044
0045   /// Operator executing the algorithm.
0046   ///
0047   /// @param spacepoints All spacepoints in the event
0048   /// @return The track seeds reconstructed from the spacepoints
0049   ///
0050   output_type operator()(
0051       const edm::spacepoint_collection::const_view& spacepoints) const override;
0052
0053  private:
0054   /// Tool performing the spacepoint binning
0055   details::spacepoint_binning m_binning;
0056   /// Tool performing the seed finding
0057   details::seed_finding m_finding;
0058
0059 };  // class seeding_algorithm
0060
0061 }  // namespace traccc::host