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 "Acts/Definitions/Algebra.hpp"
#include "Acts/Definitions/TrackParametrization.hpp"
#include "Acts/Definitions/Units.hpp"
#include "Acts/EventData/ParticleHypothesis.hpp"
#include "Acts/EventData/TrackParameters.hpp"
#include "Acts/Material/MaterialInteraction.hpp"
#include "Acts/Propagator/AbortList.hpp"
#include "Acts/Propagator/ActionList.hpp"
#include "Acts/Propagator/DenseEnvironmentExtension.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/Helpers.hpp"
#include "Acts/Utilities/Logger.hpp"
#include "ActsExamples/Framework/DataHandle.hpp"
#include "ActsExamples/Framework/IAlgorithm.hpp"
#include "ActsExamples/Framework/ProcessCode.hpp"
#include "ActsExamples/Framework/RandomNumbers.hpp"
#include "ActsExamples/Framework/WhiteBoard.hpp"

#include <algorithm>
#include <cmath>
#include <cstddef>
#include <limits>
#include <memory>
#include <optional>
#include <random>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>

namespace ActsExamples {

class PropagatorInterface;
struct AlgorithmContext;

using RecordedMaterial = Acts::MaterialInteractor::result_type;

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

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

class PropagationAlgorithm : public IAlgorithm {
 public:
  struct Config {
    std::shared_ptr<PropagatorInterface> propagatorImpl = nullptr;

    std::shared_ptr<RandomNumbers> randomNumberSvc = nullptr;
    int mode = 0;
    bool sterileLogger = false;
    bool debugOutput = false;
    bool energyLoss = true;
    bool multipleScattering = true;
    bool recordMaterialInteractions = true;

    size_t ntests = 100;
    double d0Sigma = 15 * Acts::UnitConstants::um;
    double z0Sigma = 55 * Acts::UnitConstants::mm;
    double phiSigma = 0.001;
    double thetaSigma = 0.001;
    double qpSigma = 0.0001 / 1 * Acts::UnitConstants::GeV;
    double tSigma = 1 * Acts::UnitConstants::ns;
    std::pair<double, double> phiRange = {-M_PI, M_PI};
    std::pair<double, double> etaRange = {-4., 4.};
    std::pair<double, double> ptRange = {100 * Acts::UnitConstants::MeV,
                                         100 * Acts::UnitConstants::GeV};
    Acts::ParticleHypothesis particleHypothesis =
        Acts::ParticleHypothesis::pion();
    double ptLoopers = 500 * Acts::UnitConstants::MeV;

    double maxStepSize = 3 * Acts::UnitConstants::m;

    std::string propagationStepCollection = "PropagationSteps";

    std::string propagationMaterialCollection = "RecordedMaterialTracks";

    bool covarianceTransport = false;

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

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

  PropagationAlgorithm(const Config& config, Acts::Logging::Level level);

  ActsExamples::ProcessCode execute(
      const AlgorithmContext& context) const override;

  const Config& config() const { return m_cfg; }

 private:
  Config m_cfg;  

  WriteDataHandle<std::vector<std::vector<Acts::detail::Step>>>
      m_outpoutPropagationSteps{this, "OutputPropagationSteps"};

  WriteDataHandle<std::unordered_map<size_t, Acts::RecordedMaterialTrack>>
      m_recordedMaterial{this, "RecordedMaterial"};

  std::optional<Acts::BoundSquareMatrix> generateCovariance(
      ActsExamples::RandomEngine& rnd,
      std::normal_distribution<double>& gauss) const;
};

}  // namespace ActsExamples