GetAllEi.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
 
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidKernel/TimeROI.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
 
namespace Geometry {
class IComponent;
}
 
namespace Kernel {
class Unit;
}
 
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL GetAllEi : public API::Algorithm {
public:
  GetAllEi();
  virtual ~GetAllEi() override = default;
  const std::string name() const override { return "GetAllEi"; };
  const std::string summary() const override {
    return "Analyze the chopper logs and the signal registered by the monitors "
           "to identify energies used as incident energies in an inelastic "
           "experiment.";
  }
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"GetEi"}; }
  const std::string category() const override { return "Inelastic\\Ei"; };
  std::map<std::string, std::string> validateInputs() override;
 
private:
  // Implement abstract Algorithm methods
  void init() override;
  void exec() override;
  Kernel::Property *getPLogForProperty(const API::MatrixWorkspace_sptr &inputWS, const std::string &propertyName);
  void setFilterLog(const API::MatrixWorkspace_sptr &inputWS);
  // former lambda function exposed as not evry compiler support this yet
  bool peakGuess(const API::MatrixWorkspace_sptr &inputWS, size_t index, double Ei,
                 const std::vector<size_t> &monsRangeMin, const std::vector<size_t> &monsRangeMax, double &peakPos,
                 double &peakHeight, double &peakTwoSigma);
 
protected: // for testing, private otherwise.
  // prepare working workspace with appropriate monitor spectra for fitting
  API::MatrixWorkspace_sptr
  // prepare matrix workspace to analyze monitor signal
  buildWorkspaceToFit(const API::MatrixWorkspace_sptr &inputWS, size_t &wsIndex0);
 
  double getAvrgLogValue(const API::MatrixWorkspace_sptr &inputWS, const std::string &propertyName,
                         const Kernel::TimeROI &timeroi);
  void findChopSpeedAndDelay(const API::MatrixWorkspace_sptr &inputWS, double &chop_speed, double &chop_delay);
  void findGuessOpeningTimes(const std::pair<double, double> &TOF_range, double ChopDelay, double Period,
                             std::vector<double> &guess_opening_times);
  bool findMonitorPeak(const API::MatrixWorkspace_sptr &inputWS, double Ei, const std::vector<size_t> &monsRangeMin,
                       const std::vector<size_t> &monsRangeMax, double &position, double &height, double &twoSigma);
  void findBinRanges(const HistogramData::HistogramX &eBins, const HistogramData::HistogramY &signal,
                     const std::vector<double> &guess_energy, double eResolution, std::vector<size_t> &irangeMin,
                     std::vector<size_t> &irangeMax, std::vector<bool> &guessValid);
 
  size_t calcDerivativeAndCountZeros(const std::vector<double> &bins, const std::vector<double> &signal,
                                     std::vector<double> &deriv, std::vector<double> &zeros);
 
  void printDebugModeInfo(const std::vector<double> &guess_opening, const std::pair<double, double> &TOF_range,
                          std::shared_ptr<Kernel::Unit> &destUnit);
  bool m_FilterWithDerivative;
  double m_min_Eresolution;
  // set as half max LET resolution at 20mev at 5e-4
  double m_max_Eresolution;
  double m_peakEnergyRatio2reject;
  // the value of constant phase shift on the chopper used to calculate
  // tof at chopper from recorded delay.
  double m_phase;
  // internal pointer to access to chopper
  std::shared_ptr<const Geometry::IComponent> m_chopper;
  // internal pointer to access log, used for filtering
  Kernel::TimeSeriesProperty<double> *m_pFilterLog;
};
 
} // namespace Algorithms
} // namespace Mantid