DeltaFunction.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"
#include <cmath>
 
namespace Mantid {
namespace CurveFitting {
namespace Functions {
class MANTID_CURVEFITTING_DLL DeltaFunction : public API::IPeakFunction {
public:
  DeltaFunction();
 
  double centre() const override { return getParameter("Centre"); }
  double height() const override { return getParameter("Height"); }
  double fwhm() const override { return 0; }
  void setCentre(const double c) override { setParameter("Centre", c); }
  void setHeight(const double h) override { setParameter("Height", h); }
  void setFwhm(const double w) override { UNUSED_ARG(w); }
  virtual double HeightPrefactor() const { return 1.0; } // modulates the Height of the Delta function
  std::string name() const override { return "DeltaFunction"; }
  const std::string category() const override { return "Peak"; }
 
protected:
  void function1D(double *out, const double *xValues, const size_t nData) const override;
  void functionDeriv1D(API::Jacobian *out, const double *xValues, const size_t nData) override;
  void functionLocal(double *out, const double *xValues, const size_t nData) const override {
    UNUSED_ARG(out);
    UNUSED_ARG(xValues);
    UNUSED_ARG(nData);
  }
  void functionDerivLocal(API::Jacobian *out, const double *xValues, const size_t nData) override {
    UNUSED_ARG(out);
    UNUSED_ARG(xValues);
    UNUSED_ARG(nData);
  }
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid