Acts/Seeding/IExperimentCuts.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/Seeding/CandidatesForMiddleSp.hpp"
0012
0013 #include <limits>
0014 #include <memory>
0015
0016 namespace Acts {
0017 /// @c IExperimentCuts can be used to increase or decrease seed weights
0018 /// based on the space points used in a seed. Seed weights are also
0019 /// influenced by the SeedFilter default implementation. This tool is also used
0020 /// to decide if a seed passes a seed weight cut. As the weight is stored in
0021 /// seeds, there are two distinct methods.
0022 template <typename SpacePoint>
0023 class IExperimentCuts {
0024  public:
0025   virtual ~IExperimentCuts() = default;
0026   /// Returns seed weight bonus/malus depending on detector considerations.
0027   /// @param bottom bottom space point of the current seed
0028   /// @param middle middle space point of the current seed
0029   /// @param top top space point of the current seed
0030   /// @return seed weight to be added to the seed's weight
0031   virtual float seedWeight(const SpacePoint& bottom, const SpacePoint& middle,
0032                            const SpacePoint& top) const = 0;
0033   /// @param weight the current seed weight
0034   /// @param bottom bottom space point of the current seed
0035   /// @param middle middle space point of the current seed
0036   /// @param top top space point of the current seed
0037   /// @return true if the seed should be kept, false if the seed should be
0038   /// discarded
0039   virtual bool singleSeedCut(float weight, const SpacePoint& bottom,
0040                              const SpacePoint& middle,
0041                              const SpacePoint& top) const = 0;
0042
0043   /// @param seedCandidates contains collection of seed candidates created for one middle
0044   /// space point in a std::tuple format
0045   /// @return vector of seed candidates that pass the cut
0046   virtual std::vector<
0047       typename CandidatesForMiddleSp<const SpacePoint>::value_type>
0048   cutPerMiddleSP(
0049       std::vector<typename CandidatesForMiddleSp<const SpacePoint>::value_type>
0050           seedCandidates) const = 0;
0051 };
0052 }  // namespace Acts