PropagationAlgorithm.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2017 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 <cmath>
#include <limits>
#include <memory>
#include <optional>

#include "ACTFW/Framework/BareAlgorithm.hpp"
#include "ACTFW/Framework/ProcessCode.hpp"
#include "ACTFW/Framework/RandomNumbers.hpp"
#include "ACTFW/Framework/WhiteBoard.hpp"
#include "Acts/EventData/NeutralParameters.hpp"
#include "Acts/EventData/TrackParameters.hpp"
#include "Acts/Propagator/AbortList.hpp"
#include "Acts/Propagator/ActionList.hpp"
#include "Acts/Propagator/DebugOutputActor.hpp"
#include "Acts/Propagator/MaterialInteractor.hpp"
#include "Acts/Propagator/Navigator.hpp"
#include "Acts/Propagator/Propagator.hpp"
#include "Acts/Propagator/StandardAborters.hpp"
#include "Acts/Propagator/detail/SteppingLogger.hpp"
#include "Acts/Surfaces/PerigeeSurface.hpp"
#include "Acts/Utilities/Definitions.hpp"
#include "Acts/Utilities/Helpers.hpp"
#include "Acts/Utilities/Units.hpp"

using namespace Acts::UnitLiterals;

namespace FW {

using RecordedMaterial = Acts::MaterialInteractor::result_type;

using RecordedMaterialTrack =
    std::pair<std::pair<Acts::Vector3D, Acts::Vector3D>, RecordedMaterial>;

using PropagationOutput =
    std::pair<std::vector<Acts::detail::Step>, RecordedMaterial>;

template <typename propagator_t>
class PropagationAlgorithm : public BareAlgorithm {
 public:
  struct Config {
    // create a config object with the propagator
    Config(propagator_t prop) : propagator(std::move(prop)) {}

    propagator_t propagator;

    std::shared_ptr<RandomNumbers> randomNumberSvc = nullptr;

    int mode = 0;
    bool debugOutput = false;
    bool energyLoss = false;
    bool multipleScattering = false;
    bool recordMaterialInteractions = false;

    size_t ntests = 100;
    double d0Sigma = 15_um;
    double z0Sigma = 55_mm;
    double phiSigma = 0.0001;
    double thetaSigma = 0.0001;
    double qpSigma = 0.00001 / 1_GeV;
    double tSigma = 1_ns;
    std::pair<double, double> phiRange = {-M_PI, M_PI};
    std::pair<double, double> etaRange = {-4., 4.};
    std::pair<double, double> ptRange = {100_MeV, 100_GeV};
    double ptLoopers = 300_MeV;

    double maxStepSize = 3_m;

    std::string propagationStepCollection = "PropagationSteps";

    std::string propagationMaterialCollection = "RecordedMaterialTracks";

    bool covarianceTransport = false;

    Acts::BoundVector covariances = Acts::BoundVector::Zero();

    Acts::BoundSymMatrix correlations = Acts::BoundSymMatrix::Identity();
  };

  PropagationAlgorithm(const Config& cnf, Acts::Logging::Level loglevel);

  FW::ProcessCode execute(const AlgorithmContext& context) const final override;

 private:
  Config m_cfg;  

  std::optional<Acts::BoundSymMatrix> generateCovariance(
      FW::RandomEngine& rnd, std::normal_distribution<double>& gauss) const;

  // @tparam parameters_t type of the parameters objects (charged/neutra;)
  template <typename parameters_t>
  PropagationOutput executeTest(
      const AlgorithmContext& context, const parameters_t& startParameters,
      double pathLength = std::numeric_limits<double>::max()) const;
};

#include "PropagationAlgorithm.ipp"

}  // namespace FW