Lorentzian.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/IPeakFunction.h"
#include "MantidCurveFitting/DllConfig.h"
 
namespace Mantid {
namespace CurveFitting {
namespace Functions {
class MANTID_CURVEFITTING_DLL Lorentzian : public API::IPeakFunction {
public:
  Lorentzian();
  double centre() const override { return getParameter("PeakCentre"); }
  double height() const override;
  double fwhm() const override { return getParameter("FWHM"); }
  double intensity() const override { return getParameter("Amplitude"); }
  double intensityError() const override { return getError("Amplitude"); }
  void setCentre(const double c) override { setParameter("PeakCentre", c); }
  void setHeight(const double h) override;
  void setFwhm(const double w) override;
  void setIntensity(const double i) override { setParameter("Amplitude", i); }
  void fixCentre(bool isDefault = false) override;
  void unfixCentre() override;
  void fixIntensity(bool isDefault = false) override;
  void unfixIntensity() override;
 
  std::string name() const override { return "Lorentzian"; }
  const std::string category() const override { return "Peak; Muon\\MuonModelling"; }
 
protected:
  void functionLocal(double *out, const double *xValues, const size_t nData) const override;
  void functionDerivLocal(API::Jacobian *out, const double *xValues, const size_t nData) override;
  void init() override;
  void histogram1D(double *out, double left, const double *right, const size_t nBins) const override;
  void histogramDerivative1D(API::Jacobian *jacobian, double left, const double *right,
                             const size_t nBins) const override;
 
private:
  bool m_amplitudeEqualHeight;
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid