Changeset 0cc31e1 in sasmodels

Timestamp:

Mar 20, 2016 10:31:31 AM (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:

1dd2854

Parents:

326281f

Message:

more docs & sld name changes

Location:

sasmodels/models

Files:

• correlation_length.py (modified) (1 diff)
• elliptical_cylinder.py (modified) (1 diff)
• fuzzy_sphere.py (modified) (8 diffs)

sasmodels/models/correlation_length.py

@@ -16 +16 @@
 incoherent background B and the two exponents n and m are used as fitting
 parameters. (Respectively $porod\_scale$, $lorentz\_scale$, $background$, $exponent\_p$ and 
-$exponent\_l$ in the parameter list.) The remaining parameter \xi is a correlation 
+$exponent\_l$ in the parameter list.) The remaining parameter \ |xi|\  is a correlation 
 length for the polymer chains. Note that when m=2 this functional form becomes the 
 familiar Lorentzian function. Some interpretation of the values of A and C may be 

sasmodels/models/elliptical_cylinder.py

@@ -12 +12 @@
 .. figure:: img/elliptical_cylinder_geometry.png
 
-   Elliptical cylinder geometry $a$ = $r_{minor}$ and \nu = $axis\_ratio$ = $r_{major} / r_{minor}$
+   Elliptical cylinder geometry $a$ = $r_{minor}$ and \ |nu|\  = $axis\_ratio$ = $r_{major} / r_{minor}$
 
 The function calculated is

sasmodels/models/fuzzy_sphere.py

@@ -19 +19 @@
 
     A(q) = \frac{3\left[\sin(qR) - qR \cos(qR)\right]}{(qR)^3}
-           \exp\left(\frac{-(o_{fuzzy}q)^2}{2}\right)
+           \exp\left(\frac{-(\sigma_{fuzzy}q)^2}{2}\right)
 
 Here *|A(q)|*:sup:`2`\  is the form factor, *P(q)*. The scale is equivalent to the
@@ -26 +26 @@
 solvent.
 
-Poly-dispersion in radius and in fuzziness is provided for.
+Poly-dispersion in radius and in fuzziness is provided for, though the fuzziness
+must be kept much smaller than the sphere radius for meaningful results.
 
 
@@ -65 +66 @@
 or just volume fraction for absolute scale data
 radius: radius of the solid sphere
-fuzziness = the STD of the height of fuzzy interfacial
+fuzziness = the standard deviation of the fuzzy interfacial
 thickness (ie., so-called interfacial roughness)
 sld: the SLD of the sphere
@@ -76 +77 @@
 # pylint: disable=bad-whitespace,line-too-long
 # ["name", "units", default, [lower, upper], "type","description"],
-parameters = [["sld",         "1e-6/Ang^2",  1, [-inf, inf], "",       "Layer scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2",  3, [-inf, inf], "",       "Solvent scattering length density"],
+parameters = [["sld",         "1e-6/Ang^2",  1, [-inf, inf], "",       "Particle scattering length density"],
+              ["sld_solvent", "1e-6/Ang^2",  3, [-inf, inf], "",       "Solvent scattering length density"],
               ["radius",      "Ang",        60, [0, inf],    "volume", "Sphere radius"],
-              ["fuzziness",   "Ang",        10, [0, inf],    "",       "The STD of the height of fuzzy interfacial"],
+              ["fuzziness",   "Ang",        10, [0, inf],    "",       "std deviation of Gaussian convolution for interface (must be << radius)"],
              ]
 # pylint: enable=bad-whitespace,line-too-long
@@ -95 +96 @@
     const double bes = sph_j1c(qr);
     const double qf = q*fuzziness;
-    const double fq = bes * (sld - solvent_sld) * form_volume(radius) * exp(-0.5*qf*qf);
+    const double fq = bes * (sld - sld_solvent) * form_volume(radius) * exp(-0.5*qf*qf);
     return 1.0e-4*fq*fq;
     """
@@ -102 +103 @@
     // never called since no orientation or magnetic parameters.
     //return -1.0;
-    return Iq(sqrt(qx*qx + qy*qy), sld, solvent_sld, radius, fuzziness);
+    return Iq(sqrt(qx*qx + qy*qy), sld, sld_solvent, radius, fuzziness);
     """
 
@@ -114 +115 @@
 
 demo = dict(scale=1, background=0.001,
-            sld=1, solvent_sld=3,
+            sld=1, sld_solvent=3,
             radius=60,
             fuzziness=10,
@@ -121 +122 @@
 
 oldname = "FuzzySphereModel"
-oldpars = dict(sld='sldSph', solvent_sld='sldSolv', radius='radius', fuzziness='fuzziness')
+oldpars = dict(sld='sldSph', sld_solvent='sldSolv', radius='radius', fuzziness='fuzziness')