Add docs for FlatTopPeak function

mantidproject · Jan 31, 2025 · 05008ec · 05008ec
1 parent 0cbbb4e
commit 05008ec
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/source/fitting/fitfunctions/FlatTopPeak.rst b/docs/source/fitting/fitfunctions/FlatTopPeak.rst
@@ -0,0 +1,22 @@
+.. _func-FlatTopPeak:
+
+===========
+FlatTopPeak
+===========
+
+.. index:: FlatTopPeak
+
+Description
+-----------
+
+A flat top peak function is defined as:
+
+.. math:: y = scale * (erfc((centre - 0.5 * width - x) / endGrad) - erfc((centre + 0.5 * width - x) / endGrad)) + background
+
+.. attributes::
+
+.. properties::
+
+.. categories::
+
+.. sourcelink::