Changeset eb69cce in sasmodels for sasmodels/models/ellipsoid.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/ellipsoid.py (modified) (5 diffs)

sasmodels/models/ellipsoid.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) = {3 (\Delta rho)) V (\sin[Qr(R_p,R_e,\alpha)]
-                - \cos[Qr(R_p,R_e,\alpha)])
-            \over [Qr(R_p,R_e,\alpha)]^3 }
+    F(q) = \frac{3 \Delta \rho V (\sin[qr(R_p,R_e,\alpha)]
+                - \cos[qr(R_p,R_e,\alpha)])}
+                {[qr(R_p,R_e,\alpha)]^3}
 
 and
@@ -45 +45 @@
 NB: The 2nd virial coefficient of the solid ellipsoid is calculated based
 on the $R_p$ and $R_e$ values, and used as the effective radius for
-$S(Q)$ when $P(Q) \cdot S(Q)$ is applied.
+$S(q)$ when $P(q) \cdot S(q)$ is applied.
 
 .. _ellipsoid-1d:
 
-.. figure:: img/ellipsoid_1d.JPG
+.. figure:: img/ellipsoid_1d.jpg
 
     The output of the 1D scattering intensity function for randomly oriented
@@ -55 +55 @@
 
 
-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.
 
 .. _ellipsoid-geometry:
 
-.. figure:: img/ellipsoid_geometry.JPG
+.. figure:: img/ellipsoid_geometry.jpg
 
     The angles for oriented ellipsoid.
@@ -100 +98 @@
     *contrast* = 3e-6 |Ang^-2|, and *background* = 0.0 |cm^-1|.
 
-The discrepancy above *q* = 0.3 |cm^-1| is due to the way the form factors
+The discrepancy above $q$ = 0.3 |cm^-1| is due to the way the form factors
 are calculated in the c-library provided by NIST. A numerical integration
-has to be performed to obtain $P(Q)$ for randomly oriented particles.
+has to be performed to obtain $P(q)$ for randomly oriented particles.
 The NIST software performs that integration with a 76-point Gaussian
-quadrature rule, which will become imprecise at high $Q$ where the amplitude
-varies quickly as a function of $Q$. The SasView result shown has been
+quadrature rule, which will become imprecise at high $q$ where the amplitude
+varies quickly as a function of $q$. The SasView result shown has been
 obtained by summing over 501 equidistant points. Our result was found
-to be stable over the range of $Q$ shown for a number of points higher
+to be stable over the range of $q$ shown for a number of points higher
 than 500.
 
-REFERENCE
+References
+----------
 
 L A Feigin and D I Svergun. *Structure Analysis by Small-Angle X-Ray and Neutron Scattering*, Plenum,