Changeset 326281f in sasmodels

Timestamp:

Mar 20, 2016 9:42:57 AM (9 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:

0cc31e1, 8b935d1

Parents:

d189429

Message:

improved doc correlation_length

File:

• sasmodels/models/correlation_length.py (modified) (2 diffs)

sasmodels/models/correlation_length.py

@@ -15 +15 @@
 and therefore the thermodynamics. The two multiplicative factors A and C, the
 incoherent background B and the two exponents n and m are used as fitting
-parameters. The final parameter ξ is a correlation length for the polymer
-chains. Note that when m=2 this functional form becomes the familiar Lorentzian
-function.
+parameters. (Respectively $porod\_scale$, $lorentz\_scale$, $background$, $exponent\_p$ and 
+$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 
+possible depending on the values of m and n.
 
 For 2D data: The 2D scattering intensity is calculated in the same way as 1D,
@@ -45 +47 @@
               ["lorentz_scale", "", 10.0, [0, inf], "", "Lorentzian Scaling Factor"],
               ["porod_scale", "", 1e-06, [0, inf], "", "Porod Scaling Factor"],
-              ["cor_length", "Ang", 50.0, [0, inf], "", "Correlation length"],
-              ["exponent_p", "", 3.0, [0, inf], "", "Porod Exponent"],
-              ["exponent_l", "1/Ang^2", 2.0, [0, inf], "", "Lorentzian Exponent"],
+              ["cor_length", "Ang", 50.0, [0, inf], "", "Correlation length, xi, in Lorentzian"],
+              ["exponent_p", "", 3.0, [0, inf], "", "Porod Exponent, n, in q^-n"],
+              ["exponent_l", "1/Ang^2", 2.0, [0, inf], "", "Lorentzian Exponent, m, in 1/( 1 + (q.xi)^m)"],
              ]
 # pylint: enable=bad-continuation, line-too-long