[Yt-svn] yt-commit r670 - branches/yt-1.0/doc/source/tutorial trunk/doc/source/tutorial

[mturk at wrangler.dreamhost.com]

Author: mturk
Date: Tue Jul 15 20:36:46 2008
New Revision: 670
URL: http://yt.spacepope.org/changeset/670

Log:
Some notes about the 'center' argument to plots.



Modified:
   branches/yt-1.0/doc/source/tutorial/automated_plotting.rst
   trunk/doc/source/tutorial/automated_plotting.rst

Modified: branches/yt-1.0/doc/source/tutorial/automated_plotting.rst
==============================================================================
--- branches/yt-1.0/doc/source/tutorial/automated_plotting.rst	(original)
+++ branches/yt-1.0/doc/source/tutorial/automated_plotting.rst	Tue Jul 15 20:36:46 2008
@@ -21,6 +21,9 @@
    >>> import yt.raven as raven
    >>> pc = raven.PlotCollection(a)
 
+You can also -- optionally -- feed it a "center" argument.  Otherwise, it'll
+search for the point of maximum density.
+
 .. index:: Plotting;Adding plots to PlotCollections, Raven, PlotCollections;Adding Plots
 
 Adding Plots
@@ -37,7 +40,14 @@
 
 There's a lot in that little block of text.  First I add a slice (note that while
 we can feed it a pre-existing slice, it will also grab one automatically if we
-don't!) along each axis (0,1,2) in the field "Density".  Each time we
+don't!) along each axis (0,1,2) in the field "Density".  The slice will use the
+*c* attribute of its parent PlotCollection to center itself.
+
+.. note:: The center of a slice does not have to be the same as where it is
+   sliced!  *center* gets used for lots of stuff, like RadialVelocity, but
+   *coord* determines where the slice is taken.
+
+Each time we
 add a plot to the PlotCollection, it is accessible as pc.plots[index] where 'index'
 is the 0-based index in order of addition.  Each plot object has a 'data' property,
 so if we wanted the EnzoSlice object, we can access it: ::

Modified: trunk/doc/source/tutorial/automated_plotting.rst
==============================================================================
--- trunk/doc/source/tutorial/automated_plotting.rst	(original)
+++ trunk/doc/source/tutorial/automated_plotting.rst	Tue Jul 15 20:36:46 2008
@@ -21,6 +21,9 @@
    >>> import yt.raven as raven
    >>> pc = raven.PlotCollection(a)
 
+You can also -- optionally -- feed it a "center" argument.  Otherwise, it'll
+search for the point of maximum density.
+
 .. index:: Plotting;Adding plots to PlotCollections, Raven, PlotCollections;Adding Plots
 
 Adding Plots
@@ -37,7 +40,14 @@
 
 There's a lot in that little block of text.  First I add a slice (note that while
 we can feed it a pre-existing slice, it will also grab one automatically if we
-don't!) along each axis (0,1,2) in the field "Density".  Each time we
+don't!) along each axis (0,1,2) in the field "Density".  The slice will use the
+*c* attribute of its parent PlotCollection to center itself.
+
+.. note:: The center of a slice does not have to be the same as where it is
+   sliced!  *center* gets used for lots of stuff, like RadialVelocity, but
+   *coord* determines where the slice is taken.
+
+Each time we
 add a plot to the PlotCollection, it is accessible as pc.plots[index] where 'index'
 is the 0-based index in order of addition.  Each plot object has a 'data' property,
 so if we wanted the EnzoSlice object, we can access it: ::