GetEi.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 "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL GetEi final : public API::Algorithm {
public:
  GetEi();
 
  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 1; }
  const std::string category() const override { return "Inelastic\\Ei"; }
 
private:
  API::MatrixWorkspace_sptr m_tempWS;
  double m_fracCompl;
  enum direction {
    GO_LEFT = -1, 
    GO_RIGHT = 1  
  };
 
  // Implement abstract Algorithm methods
  void init() override;
  void exec() override;
 
  void getGeometry(const API::MatrixWorkspace_const_sptr &WS, specnum_t mon0Spec, specnum_t mon1Spec,
                   double &monitor0Dist, double &monitor1Dist) const;
  std::vector<size_t> getMonitorWsIndexs(const API::MatrixWorkspace_const_sptr &WS, specnum_t specNum1,
                                         specnum_t specNum2) const;
  double timeToFly(double s, double E_KE) const;
  double getPeakCentre(const API::MatrixWorkspace_const_sptr &WS, const size_t monitIn, const double peakTime);
  void extractSpec(int wsInd, double start, double end);
  void getPeakEstimates(double &height, int64_t &centreInd, double &background) const;
  double findHalfLoc(MantidVec::size_type startInd, const double height, const double noise, const direction go) const;
  double neutron_E_At(double speed) const;
  void advanceProgress(double toAdd);
 
  static const double HALF_WINDOW;
  static const double PEAK_THRESH_H;
  static const double PEAK_THRESH_A;
  static const int64_t PEAK_THRESH_W;
 
  // for estimating algorithm progress
  static const double CROP;           
  static const double GET_COUNT_RATE; 
  static const double FIT_PEAK; 
};
 
} // namespace Algorithms
} // namespace Mantid