Refs #8621 Correct several description bits

Make the descriptions of Gamma and Amplitude correct and consitent in the header, source, and wiki files.
mantidproject · Dec 13, 2013 · b2d92d8 · b2d92d8
1 parent b28aeb6
commit b2d92d8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/Lorentzian.h b/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/Lorentzian.h
@@ -12,14 +12,15 @@ namespace Mantid
   {
     /**
     Provide lorentzian peak shape function interface to IPeakFunction.
-    I.e. the function: <math>\frac{A}{\pi}( \Gamma/((x-PeakCentre)^2+HWHM^2) ).
+    I.e. the function: <math>\frac{A}{\pi}( \Gamma/2((x-PeakCentre)^2+(\Gamma/2)^2) ).
 
+    \Gamma/2 (HWHM) - half-width at half-maximum
 
     Lorentzian parameters:
     <UL>
-    <LI> Amplitude - Maximum height of peak at x=PeakCentre(default 1.0)</LI>
+    <LI> Amplitude - Intensity scaling (default 1.0)</LI>
     <LI> PeakCentre - centre of peak (default 0.0)</LI>
-    <LI> HWHM - half-width half-maximum (default 0.0)</LI>
+    <LI> FWHM - Full-width half-maximum (default 0.0)</LI>
     </UL>
 
     Copyright &copy; 2007-8 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

diff --git a/Code/Mantid/Framework/CurveFitting/src/Lorentzian.cpp b/Code/Mantid/Framework/CurveFitting/src/Lorentzian.cpp
@@ -5,12 +5,12 @@ A Lorentzian function is defined as:
 
 where:
     <UL>
-    <LI> A (Amplitude) - Maximum peak height at peak centre </LI>
+    <LI> A (Amplitude) - Intensity scaling </LI>
     <LI><math>x_0</math> (PeakCentre) - centre of peak </LI>
-    <LI><math>\Gamma</math> (HWHM) - half-width at half-maximum </LI>
+    <LI><math>\Gamma/2</math> (HWHM) - half-width at half-maximum </LI>
     </UL>
 
-Note that the FWHM (Full Width Half Maximum) equals two times HWHM, and the integral over the Lorentzian equals 1.
+Note that the FWHM (Full Width Half Maximum) equals two times HWHM, and the integral over the Lorentzian equals the intensity scaling A.
 
 The figure below illustrate this symmetric peakshape function fitted to a TOF peak:
 
@@ -35,9 +35,9 @@ DECLARE_FUNCTION(Lorentzian);
 
 void Lorentzian::init()
 {
-  declareParameter("Amplitude", 1.0, "Maximum height of peak when x=x0");
+  declareParameter("Amplitude", 1.0, "Intensity scaling");
   declareParameter("PeakCentre", 0.0, "Centre of peak");
-  declareParameter("FWHM", 0.0, "Falf-width at half-maximum");
+  declareParameter("FWHM", 0.0, "Full-width at half-maximum");
 }