ENH: Add image, clarify doc

Author: larsoner

bin/pysurfer

@@ -68,10 +68,14 @@ if __name__ == '__main__':
         argdict = args.__dict__
         config_opts = dict([(k, v) for k, v in argdict.items()
                                                 if k in confkeys and v])
+        if 'views' in argdict.keys():
+            views = argdict['views'].split(',')
+        else:
+            views = 'lat'
 
         # Load  up the figure and underlying brain object
         b = Brain(args.subject_id, args.hemi, args.surf, args.curv,
-                  args.title, config_opts=config_opts)
+                  args.title, views=views, config_opts=config_opts)
 
         # Maybe load some morphometry
         if args.morphometry is not None:

doc/_static/split_view.png

@@ -4,22 +4,28 @@ Working with a split-screen brain
 =================================
 
 The split-screen view can be activated by using the argument ``hemi='split'``.
-This will put views of the left hemisphere in consecutive vertical frames
-on the left, and views of the right hemisphere in consecutive vertical
-frames on the right. For example, running the following::
+Using this option will put views of the left hemisphere in consecutive
+vertical frames on the left, and views of the right hemisphere in
+consecutive vertical frames on the right. For example, running the following::
 
-    brain = Brain('fsaverage', 'split', 'inflated',
-                  views=['lat', 'med', 'ven'])
+    brain = Brain('fsaverage', 'split', 'inflated', views=['lat', 'med'])
 
-Will produce a window with two columns (hemispheres) and three rows (the
-lateral, medial, and vental views, respectively).
+Will produce a window with two columns (hemispheres) and two rows (the
+lateral and medial views, respectively), shown below.
+
+.. image:: ../../_static/split_view.png
 
 Adding and displaying data
 --------------------------
 
 Data can be added to either hemisphere using the same functions that are
 normally used, e.g. ``add_data``, ``add_overlay``, ``add_morphometry``.
-The objects are automatically shown on all views of the brain.
+The objects are automatically shown on all views of the brain. When
+calling these functions, the ``hemi`` keyword argument can be set to
+``hemi='lh'`` or ``hemi='rh'`` to specify the hemisphere to plot to.
+In some instances (e.g., ``add_morphometry``), if no keyword argument
+is provided, PySurfer will attempt to load data or both hemispheres
+automtically.
 
 Note that the ``show_view`` method accepts arguments for the ``row`` and
 ``col`` values, which allow the user to control which ``Brain`` panel

doc/documentation/split_brain.rst

@@ -67,3 +67,5 @@
                     help="colormap for binary cortex curvature")
 parser.add_argument("-title",
                     help="title to use for the figure")
+parser.add_argument("-views",
+                    help="view list (comma-separated) to use")