[Yt-svn] commit/yt-doc: sskory: Adding lines about theta/phi variables.

[Bitbucket]

1 new changeset in yt-doc:

http://bitbucket.org/yt_analysis/yt-doc/changeset/90cf48bd5027/
changeset:   r36:90cf48bd5027
user:        sskory
date:        2011-03-08 03:50:16
summary:     Adding lines about theta/phi variables.
affected #:  1 file (483 bytes)

--- a/source/analysis_modules/two_point_functions.rst	Mon Mar 07 10:05:30 2011 -0700
+++ b/source/analysis_modules/two_point_functions.rst	Mon Mar 07 19:50:16 2011 -0700
@@ -303,6 +303,14 @@
     keeping everything else constant from this set: (MPI task count, 
     number of ruler lengths, ruler min/max, number of functions,
     number of point pairs per ruler length). Default: 0.
+  * ``theta``, float: For random pairs of points, the second point is found by
+    traversing a distance along a ray set by the angle (phi, theta) from the
+    first point. To keep this angle constant, set ``theta`` to a value in the
+    range [0, pi]. Default = None, which will randomize theta for every pair of
+    points.
+  * ``phi``, float: Similar to theta above, but the range of values is
+    [0, 2*pi). Default = None, which will randomize phi for every pair of
+    points.
 
 .. _tpf_add_fcns:

Repository URL: https://bitbucket.org/yt_analysis/yt-doc/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.