GetEi2.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidKernel/cow_ptr.h"
 
//----------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------
namespace Mantid {
namespace HistogramData {
class HistogramY;
class HistogramX;
class HistogramE;
} // namespace HistogramData
} // namespace Mantid
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL GetEi2 final : public API::Algorithm {
public:
  GetEi2();
  void init() override;
  void exec() override;
 
  const std::string name() const override { return "GetEi"; }
  const std::string summary() const override {
    return "Calculates the kinetic energy of neutrons leaving the source based "
           "on the time it takes for them to travel between two monitors.";
  }
 
  int version() const override { return 2; }
  const std::vector<std::string> seeAlso() const override { return {"GetAllEi", "GetEiMonDet", "GetEiT0atSNS"}; }
  const std::string category() const override { return "Inelastic\\Ei"; }
 
private:
  double calculateEi(const double initial_guess);
  double getDistanceFromSource(const size_t ws_index, const API::SpectrumInfo &spectrumInfo) const;
  double calculatePeakPosition(const size_t ws_index, const double t_min, const double t_max);
  API::MatrixWorkspace_sptr extractSpectrum(const size_t ws_index, const double start, const double end);
  double calculatePeakWidthAtHalfHeight(const API::MatrixWorkspace_sptr &data_ws, const double prominence,
                                        std::vector<double> &peak_x, std::vector<double> &peak_y,
                                        std::vector<double> &peak_e) const;
  double calculateFirstMoment(const API::MatrixWorkspace_sptr &monitor_ws, const double prominence);
  API::MatrixWorkspace_sptr rebin(const API::MatrixWorkspace_sptr &monitor_ws, const double first, const double width,
                                  const double end);
  void integrate(double &integral_val, double &integral_err, const HistogramData::HistogramX &x,
                 const HistogramData::HistogramY &s, const HistogramData::HistogramE &e, const double xmin,
                 const double xmax) const;
  void storeEi(const double ei) const;
 
  API::MatrixWorkspace_sptr m_input_ws;
  std::pair<int, double> m_peak1_pos;
  bool m_fixedei;
  double m_t_to_mev;
  double m_tof_window;
  const double m_peak_signif;
  const double m_peak_deriv;
  const double m_binwidth_frac;
  const double m_bkgd_frac;
};
 
} // namespace Algorithms
} // namespace Mantid