Changeset ff7119b in sasmodels for sasmodels/weights.py

Timestamp:

Aug 26, 2014 10:27:06 PM (10 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:

5d4777d

Parents:

a7684e5

Message:

docu update

File:

• sasmodels/weights.py (modified) (3 diffs)

sasmodels/weights.py

@@ +1 @@
+"""
+SAS distributions for polydispersity.
+"""
 # TODO: include dispersion docs with the disperser models
 from math import sqrt
@@ -116 +119 @@
 
 
+# dispersion name -> disperser lookup table.
 models = dict((d.type,d) for d in (
     GaussianDispersion, RectangleDispersion,
@@ -123 +127 @@
 
 def get_weights(disperser, n, width, nsigmas, value, limits, relative):
+    """
+    Return the set of values and weights for a polydisperse parameter.
+
+    *disperser* is the name of the disperser.
+
+    *n* is the number of points in the weight vector.
+
+    *width* is the width of the disperser distribution.
+
+    *nsigmas* is the number of sigmas to span for the dispersion convolution.
+
+    *value* is the value of the parameter in the model.
+
+    *limits* is [lb, ub], the lower and upper bound of the weight value.
+
+    *relative* is true if *width* is defined in proportion to the value
+    of the parameter, and false if it is an absolute width.
+
+    Returns *(value,weight)*, where *value* and *weight* are vectors.
+    """
     cls = models[disperser]
     obj = cls(n, width, nsigmas)