Acts/SpacePointFormation/SpacePointBuilder.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2018-2022 CERN for the benefit of the Acts project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/Definitions/TrackParametrization.hpp"
0012 #include "Acts/Digitization/CartesianSegmentation.hpp"
0013 #include "Acts/Digitization/DigitizationModule.hpp"
0014 #include "Acts/Digitization/Segmentation.hpp"
0015 #include "Acts/EventData/SourceLink.hpp"
0016 #include "Acts/Geometry/GeometryContext.hpp"
0017 #include "Acts/Geometry/TrackingGeometry.hpp"
0018 #include "Acts/SpacePointFormation/SpacePointBuilderConfig.hpp"
0019 #include "Acts/SpacePointFormation/SpacePointBuilderOptions.hpp"
0020 #include "Acts/Surfaces/Surface.hpp"
0021 #include "Acts/Utilities/Logger.hpp"
0022 #include "Acts/Utilities/SpacePointUtility.hpp"
0023
0024 #include <boost/container/static_vector.hpp>
0025
0026 namespace Acts {
0027
0028 /// @class SpacePointBuilder
0029 ///
0030 /// After the particle interaction with surfaces are recorded and digitized
0031 /// measurements on the pixel or strip detectors need further treatment. This
0032 /// class takes the SouceLinks and provides the corresponding space points.
0033 ///
0034 template <typename spacepoint_t>
0035 class SpacePointBuilder {
0036  public:
0037   using BuilderFunction = std::function<spacepoint_t(
0038       Acts::Vector3, std::optional<double>, Acts::Vector2,
0039       std::optional<double>, boost::container::static_vector<SourceLink, 2>)>;
0040
0041   // Constructor
0042   /// @param cfg The configuration for the space point builder
0043   /// @param func The function that provides user's SP constructor with global pos, global cov, and sourceLinks.
0044   /// @param logger The logging instance
0045   SpacePointBuilder(const SpacePointBuilderConfig& cfg, BuilderFunction func,
0046                     std::unique_ptr<const Logger> logger =
0047                         getDefaultLogger("SpacePointBuilder", Logging::INFO));
0048
0049   // Default constructor
0050   SpacePointBuilder() = default;
0051
0052   /// @brief Calculates the space points out of a given collection of SourceLinks
0053   /// and stores the results
0054   ///
0055   /// @param gctx The current geometry context object, e.g. alignment
0056   /// @param sourceLinks vector of Sourcelink
0057   /// @param opt option for the space point building. It contains the ends of the strips for strip SP building
0058   /// @param spacePointIt Output iterator for the space point
0059   template <template <typename...> typename container_t>
0060   void buildSpacePoint(
0061       const GeometryContext& gctx, const std::vector<SourceLink>& sourceLinks,
0062       const SpacePointBuilderOptions& opt,
0063       std::back_insert_iterator<container_t<spacepoint_t>> spacePointIt) const;
0064
0065   /// @brief Searches possible combinations of two SourceLinks on different
0066   /// surfaces that may come from the same particles
0067   ///
0068   /// @param gctx The current geometry context object, e.g. alignment
0069   /// @param slinksFront vector of Sourcelinks on a surface
0070   /// @param slinksBack vector of SoruceLinks on another surface
0071   /// @param slinkPairs storage of the SouceLink pairs
0072   /// @param pairOpt pair maker option with paramCovAccessor
0073   void makeSourceLinkPairs(
0074       const GeometryContext& gctx, const std::vector<SourceLink>& slinksFront,
0075       const std::vector<SourceLink>& slinksBack,
0076       std::vector<std::pair<SourceLink, SourceLink>>& slinkPairs,
0077       const StripPairOptions& pairOpt) const;
0078
0079  protected:
0080   // configuration of the single hit space point builder
0081   SpacePointBuilderConfig m_config;
0082
0083   /// @brief Function to create external space point
0084   /// The constructor of spacepoint_t with Vector3 global pos, Vector2 global
0085   /// cov, and vector of source link pointers.
0086   BuilderFunction m_spConstructor;
0087
0088   /// the logging instance
0089   std::unique_ptr<const Acts::Logger> m_logger;
0090
0091   std::shared_ptr<const SpacePointUtility> m_spUtility;
0092
0093   const Logger& logger() const { return *m_logger; }
0094 };
0095
0096 }  // namespace Acts
0097
0098 #include "Acts/SpacePointFormation/detail/SpacePointBuilder.ipp"