FatrasSimulation.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2017-2021 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/Geometry/TrackingGeometry.hpp"
#include "Acts/Utilities/Logger.hpp"
#include "ActsExamples/EventData/SimHit.hpp"
#include "ActsExamples/EventData/SimParticle.hpp"
#include "ActsExamples/Framework/DataHandle.hpp"
#include "ActsExamples/Framework/IAlgorithm.hpp"
#include "ActsExamples/Framework/ProcessCode.hpp"
#include "ActsExamples/Framework/RandomNumbers.hpp"
#include "ActsExamples/MagneticField/MagneticField.hpp"
#include "ActsFatras/Physics/NuclearInteraction/NuclearInteraction.hpp"

#include <cstddef>
#include <memory>
#include <string>

namespace Acts {
class MagneticFieldProvider;
class TrackingGeometry;
}  // namespace Acts

namespace ActsExamples {
class RandomNumbers;
struct AlgorithmContext;

namespace detail {
struct FatrasSimulation;
}

class FatrasSimulation final : public IAlgorithm {
 public:
  struct Config {
    std::string inputParticles;
    std::string outputParticlesInitial;
    std::string outputParticlesFinal;
    std::string outputSimHits;
    std::string imputParametrisationNuclearInteraction =
        "nuclearInteractionParameters";
    std::shared_ptr<const RandomNumbers> randomNumbers;
    std::shared_ptr<const Acts::TrackingGeometry> trackingGeometry;
    std::shared_ptr<const Acts::MagneticFieldProvider> magneticField;

    // tuning parameters
    double pMin = 0.5 * Acts::UnitConstants::GeV;
    bool emScattering = true;
    bool emEnergyLossIonisation = true;
    bool emEnergyLossRadiation = true;
    bool emPhotonConversion = true;
    bool generateHitsOnSensitive = true;
    bool generateHitsOnMaterial = false;
    bool generateHitsOnPassive = false;

    size_t averageHitsPerParticle = 16u;
  };

  FatrasSimulation(Config cfg, Acts::Logging::Level lvl);
  ~FatrasSimulation() override;

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

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

  ReadDataHandle<SimParticleContainer> m_inputParticles{this, "InputParticles"};

  WriteDataHandle<SimHitContainer> m_outputSimHits{this, "OutputSimHits"};

  WriteDataHandle<SimParticleContainer> m_outputParticlesInitial{
      this, "OutputParticlesInitial"};
  WriteDataHandle<SimParticleContainer> m_outputParticlesFinal{
      this, "OutputParticlesFinal"};

 private:
  Config m_cfg;
  std::unique_ptr<detail::FatrasSimulation> m_sim;
};

}  // namespace ActsExamples