Changeset eb69cce in sasmodels for sasmodels/models/cylinder.py

Timestamp:

Nov 30, 2015 7:18:41 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:

d18f8a8

Parents:

d138d43

Message:

make model docs more consistent; build pdf docs

File:

• sasmodels/models/cylinder.py (modified) (6 diffs)

sasmodels/models/cylinder.py

@@ -12 +12 @@
 .. math::
 
-    P(Q,\alpha) = {\text{scale} \over V} F^2(Q) + \text{background}
+    P(q,\alpha) = \frac{\text{scale}}{V} F^2(q) + \text{background}
 
 where
@@ -18 +18 @@
 .. math::
 
-    F(Q) = 2 (\Delta \rho) V
-           {\sin \left(Q\tfrac12 L\cos\alpha \right)
-               \over Q\tfrac12 L \cos \alpha}
-           {J_1 \left(Q R \sin \alpha\right) \over Q R \sin \alpha}
+    F(q) = 2 (\Delta \rho) V
+           \frac{\sin \left(q\tfrac12 L\cos\alpha \right)}
+                {q\tfrac12 L \cos \alpha}
+           \frac{J_1 \left(q R \sin \alpha\right)}{q R \sin \alpha}
 
 and $\alpha$ is the angle between the axis of the cylinder and $\vec q$, $V$
@@ -44 +44 @@
 
 NB: The 2nd virial coefficient of the cylinder is calculated based on the
-radius and length values, and used as the effective radius for $S(Q)$
-when $P(Q) \cdot S(Q)$ is applied.
+radius and length values, and used as the effective radius for $S(q)$
+when $P(q) \cdot S(q)$ is applied.
 
 The output of the 1D scattering intensity function for randomly oriented
@@ -52 +52 @@
 .. math::
 
-    P(Q) = {\text{scale} \over V}
-        \int_0^{\pi/2} F^2(Q,\alpha) \sin \alpha\ d\alpha + \text{background}
+    P(q) = \frac{\text{scale}}{V}
+        \int_0^{\pi/2} F^2(q,\alpha) \sin \alpha\ d\alpha + \text{background}
 
-The *theta* and *phi* parameters are not used for the 1D output. Our
-implementation of the scattering kernel and the 1D scattering intensity
-use the c-library from NIST.
+The $\theta$ and $\phi$ parameters are not used for the 1D output.
 
 Validation
@@ -82 +80 @@
 .. math::
 
-    P(Q) = \int_0^{\pi/2} d\phi
-        \int_0^\pi p(\theta, \phi) P_0(Q,\alpha) \sin \theta\ d\theta
+    P(q) = \int_0^{\pi/2} d\phi
+        \int_0^\pi p(\theta, \phi) P_0(q,\alpha) \sin \theta\ d\theta
 
 
 where $p(\theta,\phi)$ is the probability distribution for the orientation
-and $P_0(Q,\alpha)$ is the scattering intensity for the fully oriented
+and $P_0(q,\alpha)$ is the scattering intensity for the fully oriented
 system. Since we have no other software to compare the implementation of
 the intensity for fully oriented cylinders, we can compare the result of
@@ -129 +127 @@
 
 #             [ "name", "units", default, [lower, upper], "type", "description"],
-parameters = [["sld", "1e-6/Ang^2", 4, [-inf, inf], "",
+parameters = [["sld", "4e-6/Ang^2", 4, [-inf, inf], "",
                "Cylinder scattering length density"],
               ["solvent_sld", "1e-6/Ang^2", 1, [-inf, inf], "",