EnergyLossWriter.hpp

Go to the documentation of this file.

/*
 * (c) Copyright 2021 CORSIKA Project, corsika-project@lists.kit.edu
 *
 * This software is distributed under the terms of the GNU General Public
 * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
 * the license.
 */

#pragma once

#include <corsika/output/BaseOutput.hpp>
#include <corsika/framework/core/ParticleProperties.hpp>
#include <corsika/framework/core/PhysicalUnits.hpp>
#include <corsika/media/ShowerAxis.hpp>
#include <corsika/modules/writers/WriterOff.hpp>
#include <corsika/modules/writers/EnergyLossWriterParquet.hpp>

#include <vector>
#include <array>

namespace corsika {

  // clang-format-off
  // clang-format-on

  namespace dEdX_output {

    enum class ProfileIndex { Total, Entries };

    size_t constexpr NColumns = static_cast<int>(ProfileIndex::Entries);

    static std::array<char const*, NColumns> constexpr ProfileIndexNames{{"total"}};

    typedef std::array<HEPEnergyType, NColumns> Profile;

  } // namespace dEdX_output

  template <typename TOutput = EnergyLossWriterParquet<dEdX_output::NColumns>>
  class EnergyLossWriter : public TOutput {

  public:
    EnergyLossWriter(ShowerAxis const& axis,
                     GrammageType dX = 10_g / square(1_cm), // profile binning
                     unsigned int const nBins = 200,        // number of bins
                     GrammageType dX_threshold = 0.0001_g /
                                                 square(1_cm)); // ignore too short tracks

    void startOfLibrary(boost::filesystem::path const& directory) final override;

    void startOfShower(unsigned int const showerId) final override;

    void endOfShower(unsigned int const showerId) final override;

    void endOfLibrary() final override;

    void write(Point const& p0, Point const& p1, Code const PID, HEPEnergyType const dE);

    void write(Point const& point, Code const PID, HEPEnergyType const dE);

    void write(GrammageType const Xstart, GrammageType const Xend, Code const PID,
               HEPEnergyType const dE);

    HEPEnergyType getEnergyLost() const;

    YAML::Node getSummary() const;

    YAML::Node getConfig() const;

  private:
    ShowerAxis const& showerAxis_; 
    GrammageType dX_;              
    size_t nBins_;                 
    GrammageType dX_threshold_;    
    std::vector<dEdX_output::Profile> profile_; // longitudinal profile

  }; // namespace corsika

} // namespace corsika

#include <corsika/detail/modules/writers/EnergyLossWriter.inl>