Changes in sasmodels/models/peak_lorentz.py [14ba6f6:04b0b30] in sasmodels

File:

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

sasmodels/models/peak_lorentz.py

@@ -11 +11 @@
     I(q) = \frac{scale}{\bigl(1+\bigl(\frac{q-q_0}{B}\bigr)^2\bigr)} + background
 
-with the peak having height of $I_0$ centered at $q_0$ and having a HWHM (half-width half-maximum) of B.
+with the peak having height of $I_0$ centered at $q_0$ and having
+a HWHM (half-width half-maximum) of B.
 
 For 2D data the scattering intensity is calculated in the same way as 1D,
@@ -55 +56 @@
 
 def Iq(q, peak_pos, peak_hwhm):
+    """
+        Return I(q)
+    """
     inten = (1/(1+((q-peak_pos)/peak_hwhm)**2))
     return inten
@@ -60 +64 @@
 
 def Iqxy(qx, qy, *args):
+    """
+        Return I(qx, qy)
+    """
     return Iq(sqrt(qx ** 2 + qy ** 2), *args)
 Iqxy.vectorized = True # Iqxy accepts an array of qx, qy values