Changeset e65a3e7 in sasmodels for sasmodels/models/elliptical_cylinder.py

Timestamp:

Mar 19, 2016 5:37:29 PM (8 years ago)

Author:

richardh

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:

aa24114

Parents:

81d3a0c

Message:

tidy docs and renam solvent_sld

File:

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

sasmodels/models/elliptical_cylinder.py

@@ -12 +12 @@
 .. figure:: img/elliptical_cylinder_geometry.png
 
-    *a* = *r_minor* and |nu|\ :sub:`n` = $r_ratio$ (i.e., $r_major / r_minor$).
+   Elliptical cylinder geometry $a$ = $r_{minor}$ and \nu = $r_{ratio}$ = $r_{major} / r_{minor}$
 
 The function calculated is
@@ -26 +26 @@
     F(\mathbf{q},\alpha,\psi)=2\frac{J_1(a)\sin(b)}{ab}
     \\
-    a = \mathbf{q}\sin(\alpha)\left[ r^2_{major}\sin^2(\psi)+r^2_{minor}\cos(\psi) \right]^{1/2}
+    where  a = \mathbf{q}\sin(\alpha)\left[ r^2_{major}\sin^2(\psi)+r^2_{minor}\cos(\psi) \right]^{1/2}
     \\
     b=\mathbf{q}\frac{L}{2}\cos(\alpha)
@@ -74 +74 @@
     The intensities averaged from 2D over different numbers of bins and angles.
 
-Reference
----------
+References
+----------
 
 L A Feigin and D I Svergun, *Structure Analysis by Small-Angle X-Ray and Neutron Scattering*, Plenum,
@@ -98 +98 @@
               ["length",      "Ang",        400.0, [1, inf],    "volume",      "Length of the cylinder"],
               ["sld",         "1e-6/Ang^2", 4.0,   [-inf, inf], "",            "Cylinder scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2", 1.0,   [-inf, inf], "",            "Solvent scattering length density"],
+              ["sld_solvent", "1e-6/Ang^2", 1.0,   [-inf, inf], "",            "Solvent scattering length density"],
               ["theta",       "degrees",    90.0,  [-360, 360], "orientation", "In plane angle"],
               ["phi",         "degrees",    0,     [-360, 360], "orientation", "Out of plane angle"],
@@ -108 +108 @@
 
 demo = dict(scale=1, background=0, r_minor=100, r_ratio=1.5, length=400.0,
-            sld=4.0, solvent_sld=1.0, theta=10.0, phi=20, psi=30, theta_pd=10, phi_pd=2, psi_pd=3)
+            sld=4.0, sld_solvent=1.0, theta=10.0, phi=20, psi=30, theta_pd=10, phi_pd=2, psi_pd=3)
 
 oldname = 'EllipticalCylinderModel'
-oldpars = dict(theta='cyl_theta', phi='cyl_phi', psi='cyl_psi', sld='sldCyl', solvent_sld='sldSolv')
+oldpars = dict(theta='cyl_theta', phi='cyl_phi', psi='cyl_psi', sld='sldCyl', sld_solvent='sldSolv')
 
 def ER(r_minor, r_ratio, length):
@@ -132 +132 @@
            'sld': 4.0,
            'length':400.0,
-           'solvent_sld':1.0,
+           'sld_solvent':1.0,
            'background':0.0
           }, 0.001, 675.504402]]