Acts/Seeding2/ITripletSeedCuts.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 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 https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/EventData/SpacePointContainer2.hpp"
0012 #include "Acts/Seeding2/detail/CandidatesForMiddleSp2.hpp"
0013
0014 namespace Acts::Experimental {
0015
0016 /// @c ITripletSeedCuts can be used to increase or decrease seed weights
0017 /// based on the space points used in a seed. Seed weights are also
0018 /// influenced by the SeedFilter default implementation. This tool is also used
0019 /// to decide if a seed passes a seed weight cut. As the weight is stored in
0020 /// seeds, there are two distinct methods.
0021 class ITripletSeedCuts {
0022  public:
0023   virtual ~ITripletSeedCuts() = default;
0024
0025   /// Returns seed weight bonus/malus depending on detector considerations.
0026   /// @param bottom bottom space point of the current seed
0027   /// @param middle middle space point of the current seed
0028   /// @param top top space point of the current seed
0029   /// @return seed weight to be added to the seed's weight
0030   virtual float seedWeight(const ConstSpacePointProxy2& bottom,
0031                            const ConstSpacePointProxy2& middle,
0032                            const ConstSpacePointProxy2& top) const = 0;
0033
0034   /// @param weight the current seed weight
0035   /// @param bottom bottom space point of the current seed
0036   /// @param middle middle space point of the current seed
0037   /// @param top top space point of the current seed
0038   /// @return true if the seed should be kept, false if the seed should be
0039   /// discarded
0040   virtual bool singleSeedCut(float weight, const ConstSpacePointProxy2& bottom,
0041                              const ConstSpacePointProxy2& middle,
0042                              const ConstSpacePointProxy2& top) const = 0;
0043
0044   /// @param seedCandidates contains collection of seed candidates created for one middle
0045   /// space point in a std::tuple format
0046   /// @return vector of seed candidates that pass the cut
0047   virtual void cutPerMiddleSp(
0048       std::span<TripletCandidate2> seedCandidates) const = 0;
0049 };
0050
0051 }  // namespace Acts::Experimental