VesuvioResolution.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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/IPeakFunction.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAPI/ParamFunction.h"
#include "MantidCurveFitting/DllConfig.h"
 
namespace Mantid {
namespace CurveFitting {
namespace Algorithms {
//---------------------------------------------------------------------------
// Forward declarations
//---------------------------------------------------------------------------
struct DetectorParams;
} // namespace Algorithms
namespace Functions {
 
//---------------------------------------------------------------------------
struct ResolutionParams {
  double dl1;        
  double dl2;        
  double dtof;       
  double dthe;       
  double dEnLorentz; 
  double dEnGauss;   
};
 
class MANTID_CURVEFITTING_DLL VesuvioResolution : public API::ParamFunction, public API::IFunction1D {
public:
  static ResolutionParams getResolutionParameters(const API::MatrixWorkspace_const_sptr &ws, const size_t index);
 
  VesuvioResolution();
 
  std::string name() const override;
  inline double resolutionFWHM() const { return m_resolutionSigma; }
  inline double lorentzFWHM() const { return m_lorentzFWHM; }
  void function1D(double *out, const double *xValues, const size_t nData) const override;
  void setUpForFit() override;
  void setMatrixWorkspace(std::shared_ptr<const API::MatrixWorkspace> workspace, size_t wsIndex, double startX,
                          double endX) override;
  void cacheResolutionComponents(const Algorithms::DetectorParams &detpar, const ResolutionParams &respar);
  void disableLogging() { m_log.setEnabled(false); }
  void voigtApprox(std::vector<double> &voigt, const std::vector<double> &xValues, const double lorentzPos,
                   const double lorentzAmp, const double lorentzWidth, const double gaussWidth) const;
  void voigtApprox(std::vector<double> &voigt, const std::vector<double> &xValues, const double lorentzPos,
                   const double lorentzAmp) const;
 
 
private:
  void declareAttributes() override;
  void setAttribute(const std::string &name, const Attribute &value) override;
 
  mutable Kernel::Logger m_log;
  size_t m_wsIndex;
  double m_mass;
  std::shared_ptr<API::IPeakFunction> m_voigt;
  double m_resolutionSigma;
  double m_lorentzFWHM;
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid