Skip to content

Commit 498f27e

Browse files
committed
DOC: cleaned up docstring
1 parent 48bee78 commit 498f27e

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

surfer/viz.py

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -297,21 +297,24 @@ class Brain(object):
297297
title : str
298298
title for the window
299299
cortex : str, tuple, dict, or None
300-
Specifies how the cortical surface is rendered. Accepts
301-
specification of a colormap (in which case binarized curvature
302-
values are rendered) or a color (in which case the cortical
303-
surface is rendered without binarized curvature values). Can
304-
be set to: (1) the name of one of the preset cortex styles
305-
('classic' [default], 'high_contrast', 'low_contrast', or
306-
'bone'), (2) the name of a colormap, (3) a tuple with four
307-
entries for (colormap, vmin, vmax, reverse) indicating the
308-
name of the colormap, the min and max values respectively and
309-
whether or not the colormap should be reversed, (4) a valid
310-
color specification (such as a 3-tuple with RGB values or a
311-
valid color name), or (5) a dictionary of keyword arguments
312-
that is passed on to the call to surface. If set to `None`,
313-
color is set to (0.5, 0.5, 0.5) rendering a gray brain without
314-
binarized curvature.
300+
Specifies how the cortical surface is rendered. Options:
301+
302+
1. The name of one of the preset cortex styles:
303+
``'classic'`` (default), ``'high_contrast'``,
304+
``'low_contrast'``, or ``'bone'``.
305+
2. A color-like argument to render the cortex as a single
306+
color, e.g. ``'red'`` or ``(0.1, 0.4, 1.)``. Setting
307+
this to ``None`` is equivalent to ``(0.5, 0.5, 0.5)``.
308+
3. The name of a colormap used to render binarized
309+
curvature values, e.g., ``Grays``.
310+
4. A container with four entries for colormap (string
311+
specifiying the name of a colormap), vmin (float
312+
specifying the minimum value for the colormap), vmax
313+
(float specifying the maximum value for the colormap),
314+
and reverse (bool specifying whether the colormap
315+
should be reversed. E.g., ``('Greys', -1, 2, False)``.
316+
5. A dict of keyword arguments that is passed on to the
317+
call to surface.
315318
alpha : float in [0, 1]
316319
Alpha level to control opacity of the cortical surface.
317320
size : float or pair of floats

0 commit comments

Comments
 (0)