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

sasmodels/models/triaxial_ellipsoid.py

@@ -2 +2 @@
 # Note: model title and parameter table are inserted automatically
 r"""
-All three axes are of different lengths with $R_a \le R_b <= R_c$
+All three axes are of different lengths with $R_a \leq R_b \leq R_c$
 **Users should maintain this inequality for all calculations**.
 
 .. math::
 
-    P(Q) = \text{scale} V \left< F^2(Q) \right> + \text{background}
+    P(q) = \text{scale} V \left< F^2(q) \right> + \text{background}
 
 where the volume $V = 4/3 \pi R_a R_b R_c$, and the averaging
-$\left< \cdots \right>$ is applied over all orientations for 1D.
+$\left<\ldots\right>$ is applied over all orientations for 1D.
 
 .. figure:: img/triaxial_ellipsoid_geometry.jpg
 
     Ellipsoid schematic.
-
-The returned value is in units of |cm^-1|, on absolute scale.
 
 Definition
@@ -25 +23 @@
 .. math::
 
-    P(Q) = \frac{\text{scale}}{V}\int_0^1\int_0^1
-        \Phi^2(QR_a^2\cos^2( \pi x/2) + QR_b^2\sin^2(\pi y/2)(1-y^2) + c^2y^2)
+    P(q) = \frac{\text{scale}}{V}\int_0^1\int_0^1
+        \Phi^2(qR_a^2\cos^2( \pi x/2) + qR_b^2\sin^2(\pi y/2)(1-y^2) + R_c^2y^2)
         dx dy
 
@@ -40 +38 @@
 :num:`figure #triaxial-ellipsoid-angles`.
 The angle $\psi$ is the rotational angle around its own $c$ axis
-against the $Q$ plane. For example, $\psi = 0$ when the
+against the $q$ plane. For example, $\psi = 0$ when the
 $a$ axis is parallel to the $x$ axis of the detector.
 
@@ -52 +50 @@
 
 The contrast is defined as SLD(ellipsoid) - SLD(solvent).  In the
-parameters, *a* is the minor equatorial radius, *b* is the major
-equatorial radius, and c is the polar radius of the ellipsoid.
+parameters, $R_a$ is the minor equatorial radius, $R_b$ is the major
+equatorial radius, and $R_c$ is the polar radius of the ellipsoid.
 
 NB: The 2nd virial coefficient of the triaxial solid ellipsoid is
 calculated based on the polar radius $R_p = R_c$ and equatorial
 radius $R_e = \sqrt{R_a R_b}$, 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.
 
 .. figure:: img/triaxial_ellipsoid_1d.jpg
@@ -81 +79 @@
     Comparison between 1D and averaged 2D.
 
-Our model uses the form factor calculations implemented in a c-library provided by the NIST Center for Neutron Research
-(Kline, 2006)
-
-REFERENCE
+References
+----------
 
 L A Feigin and D I Svergun, *Structure Analysis by Small-Angle X-Ray and Neutron Scattering*, Plenum,