Changeset 9d76d29 in sasmodels

Timestamp:

Nov 9, 2015 1:43:00 PM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

ade352a

Parents:

93bffd4

Message:

fix up docs to use latex

File:

• sasmodels/models/gaussian_peak.py (modified) (3 diffs)

sasmodels/models/gaussian_peak.py

@@ -1 +1 @@
 r"""
+
+Definition
+----------
+
 This model describes a Gaussian shaped peak on a flat background
 
-.. image:: img/image198.PNG
+.. math::
 
-with the peak having height of *I0* centered at *q0* and having a standard deviation of *B*. The FWHM (full-width
-half-maximum) is 2.354 B.
+    I(q) = (\text{scale}) \exp\left[ -\tfrac12 (q-q_0)^2 / \sigma^2 \right]
+        + \text{background}
 
-For 2D data: The 2D scattering intensity is calculated in the same way as 1D, where the *q* vector is defined as
+with the peak having height of *scale* centered at $q_0$ and having a standard
+deviation of $\sigma$. The FWHM (full-width half-maximum) is $2.354 \sigma$.
 
-.. image:: img/image040.gif
+For 2D data, scattering intensity is calculated in the same way as 1D,
+where the $q$ vector is defined as
 
-.. image:: img/image199.jpg
+.. math::
 
-*Figure. 1D plot using the default values (w/500 data points).*
+    q = \sqrt{q_x^2 + q_y^2}
 
-REFERENCE
+
+.. image:: img/gaussian_peak_1d.jpg
+
+    1D plot using the default values (w/500 data points).
+
+Reference
 ---------
 
@@ -27 +38 @@
 description = """
     Model describes a Gaussian shaped peak including a flat background
-    Provide F(q) = scale*exp( -1/2 *[(q-q0)/B]^2 )+ background
+    Provide F(q) = scale*exp( -1/2 *[(q-q0)/sigma]^2 )+ background
 """
 category = "shape-independent"
@@ -33 +44 @@
 #             ["name", "units", default, [lower, upper], "type","description"],
 parameters = [["q0", "1/Ang", 0.05, [-inf, inf], "", "Peak position"],
-              ["sigma", "1/Ang", 0.005, [-inf, inf], "",
+              ["sigma", "1/Ang", 0.005, [0, inf], "",
                "Peak width (standard deviation)"],
              ]