SeedFilter.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file SeedFilter.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/EventData/SpacePointData.hpp"
#include "Acts/Seeding/CandidatesForMiddleSp.hpp"
#include "Acts/Seeding/IExperimentCuts.hpp"
#include "Acts/Seeding/InternalSeed.hpp"
#include "Acts/Seeding/Seed.hpp"
#include "Acts/Seeding/SeedFilterConfig.hpp"

#include <memory>
#include <mutex>
#include <queue>
#include <tuple>
#include <vector>

namespace Acts {
struct SeedFilterState {
  // longitudinal impact parameter as defined by bottom and middle space point
  float zOrigin = 0;
  // number of minimum top SPs in seed confirmation
  size_t nTopSeedConf = 0;
  // radius of bottom component of seed that is used to define the number of
  // compatible top required
  float rMaxSeedConf =
      std::numeric_limits<float>::max();  // Acts::UnitConstants::mm
  // number of high quality seeds in seed confirmation
  std::size_t numQualitySeeds = 0;
  // number of seeds that did not pass the quality confirmation but were still
  // accepted, if quality confirmation is not used this is the total number of
  // seeds
  std::size_t numSeeds = 0;
};

template <typename external_spacepoint_t>
class SeedFilter {
 public:
  SeedFilter(SeedFilterConfig config,
             IExperimentCuts<external_spacepoint_t>* expCuts = nullptr);

  SeedFilter() = delete;
  virtual ~SeedFilter() = default;

  virtual void filterSeeds_2SpFixed(
      Acts::SpacePointData& spacePointData,
      const InternalSpacePoint<external_spacepoint_t>& bottomSP,
      const InternalSpacePoint<external_spacepoint_t>& middleSP,
      const std::vector<const InternalSpacePoint<external_spacepoint_t>*>&
          topSpVec,
      const std::vector<float>& invHelixDiameterVec,
      const std::vector<float>& impactParametersVec,
      SeedFilterState& seedFilterState,
      CandidatesForMiddleSp<const InternalSpacePoint<external_spacepoint_t>>&
          candidates_collector) const;

  virtual void filterSeeds_1SpFixed(
      Acts::SpacePointData& spacePointData,
      CandidatesForMiddleSp<const InternalSpacePoint<external_spacepoint_t>>&
          candidates_collector,
      const std::size_t numQualitySeeds,
      std::back_insert_iterator<std::vector<Seed<external_spacepoint_t>>> outIt)
      const;

  virtual void filterSeeds_1SpFixed(
      Acts::SpacePointData& spacePointData,
      std::vector<typename CandidatesForMiddleSp<
          const InternalSpacePoint<external_spacepoint_t>>::value_type>&
          candidates,
      const std::size_t numQualitySeeds,
      std::back_insert_iterator<std::vector<Seed<external_spacepoint_t>>> outIt)
      const;

  const SeedFilterConfig getSeedFilterConfig() const { return m_cfg; }
  const IExperimentCuts<external_spacepoint_t>* getExperimentCuts() const {
    return m_experimentCuts;
  }

 private:
  const SeedFilterConfig m_cfg;
  const IExperimentCuts<external_spacepoint_t>* m_experimentCuts;
};
}  // namespace Acts
#include "Acts/Seeding/SeedFilter.ipp"