Changeset eb87965 in sasmodels for doc/guide

Timestamp:

Nov 6, 2017 2:29:25 PM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

c11d09f, 1e867a4

Parents:

c15e03c (diff), 82592da (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'ticket-776-orientation' of github.com:sasview/sasmodels into ticket-776-orientation

File:

• doc/guide/orientation/orientation.rst (modified) (2 diffs)

doc/guide/orientation/orientation.rst

@@ -62 +62 @@
 care for large ranges of angle.
 
-Note that the form factors for asymmetric particles are also performing
-numerical integrations over one or more variables, so care should be taken,
-especially with very large particles or more extreme aspect ratios. Users can
-experiment with the values of *Npts* and *Nsigs*, the number of steps used in the
-integration and the range spanned in number of standard deviations. The
-standard deviation is entered in units of degrees. For a rectangular
-(uniform) distribution the full width should be $\pm \sqrt(3)$ ~ 1.73 standard
-deviations (this may be changed soon).
+.. note::
+    Note that the form factors for oriented particles are also performing
+    numerical integrations over one or more variables, so care should be taken,
+    especially with very large particles or more extreme aspect ratios. In such 
+    cases results may not be accurate, particularly at very high Q, unless the model
+    has been specifically coded to use limiting forms of the scattering equations.
+    
+    For best numerical results keep the $\theta$ distribution narrower than the $\phi$ 
+    distribution. Thus for asymmetric particles, such as elliptical_cylinder, you may 
+    need to reorder the sizes of the three axes to acheive the desired result. 
+    This is due to the issues of mapping a rectangular distribution onto the 
+    surface of a sphere.
 
-Where appropriate, for best numerical results, keep $a < b < c$ and the
-$\theta$ distribution narrower than the $\phi$ distribution.
+Users can experiment with the values of *Npts* and *Nsigs*, the number of steps 
+used in the integration and the range spanned in number of standard deviations. 
+The standard deviation is entered in units of degrees. For a "rectangular" 
+distribution the full width should be $\pm \sqrt(3)$ ~ 1.73 standard deviations. 
+The new "uniform" distribution avoids this by letting you directly specify the 
+half width.
+
+The angular distributions will be truncated outside of the range -180 to +180 
+degrees, so beware of using saying a broad Gaussian distribution with large value
+of *Nsigs*, as the array of *Npts* may be truncated to many fewer points than would 
+give a good integration,as well as becoming rather meaningless. (At some point 
+in the future the actual polydispersity arrays may be made available to the user 
+for inspection.)
 
 Some more detailed technical notes are provided in the developer section of
@@ -79 +94 @@
 *Document History*
 
-| 2017-10-27 Richard Heenan
+| 2017-11-06 Richard Heenan