SeedFilterConfig.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file SeedFilterConfig.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2020 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/Definitions/Units.hpp"
#include "Acts/Seeding/SeedConfirmationRangeConfig.hpp"

#include <cstddef>
#include <cstdint>
#include <stdexcept>

namespace Acts {
struct SeedFilterConfig {
  // the allowed delta between two inverted seed radii for them to be considered
  // compatible.
  float deltaInvHelixDiameter = 0.00003 * 1. / Acts::UnitConstants::mm;
  // the transverse impact parameters (d0) is multiplied by this factor and
  // subtracted from weight
  float impactWeightFactor = 1.;
  // the logitudinal impact parameters (z0) is multiplied by this factor and
  // subtracted from weight
  float zOriginWeightFactor = 1.;
  // seed weight increased by this value if a compatible seed has been found.
  float compatSeedWeight = 200.;
  // minimum distance between compatible seeds to be considered for weight boost
  float deltaRMin = 5. * Acts::UnitConstants::mm;
  // in dense environments many seeds may be found per middle space point.
  // only seeds with the highest weight will be kept if this limit is reached.
  unsigned int maxSeedsPerSpM = 10;
  // how often do you want to increase the weight of a seed for finding a
  // compatible seed?
  size_t compatSeedLimit = 2;
  // Tool to apply experiment specific cuts on collected middle space points

  // increment in seed weight if the number of compatible seeds is larger than
  // numSeedIncrement, this is used in case of high occupancy scenarios if we
  // want to increase the weight of the seed by seedWeightIncrement when the
  // number of compatible seeds is higher than a certain value
  float seedWeightIncrement = 0;
  float numSeedIncrement = std::numeric_limits<float>::infinity();

  // seedConfirmation enables seed confirmation cuts - keep seeds if they have
  // specific values of impact parameter, z-origin and number of compatible
  // seeds inside a pre-defined range that also depends on the region of the
  // detector (i.e. forward or central region) defined by SeedConfirmationRange
  bool seedConfirmation = false;
  // contains parameters for central seed confirmation
  SeedConfirmationRangeConfig centralSeedConfirmationRange;
  // contains parameters for forward seed confirmation
  SeedConfirmationRangeConfig forwardSeedConfirmationRange;

  // maximum number of lower quality seeds in seed confirmation
  std::size_t maxSeedsPerSpMConf = std::numeric_limits<std::size_t>::max();
  // maximum number of quality seeds for each middle-bottom SP-dublet in seed
  // confirmation if the limit is reached we check if there is a lower quality
  // seed to be replaced
  std::size_t maxQualitySeedsPerSpMConf =
      std::numeric_limits<std::size_t>::max();

  // use deltaR between top and middle SP instead of top radius to search for
  // compatible SPs
  bool useDeltaRorTopRadius = false;

  bool isInInternalUnits = false;
  SeedFilterConfig toInternalUnits() const {
    if (isInInternalUnits) {
      throw std::runtime_error(
          "Repeated conversion to internal units for SeedFilterConfig");
    }
    using namespace Acts::UnitLiterals;
    SeedFilterConfig config = *this;
    config.isInInternalUnits = true;
    config.deltaRMin /= 1_mm;
    config.deltaInvHelixDiameter /= 1. / 1_mm;

    return config;
  }
};

}  // namespace Acts