Skip to content

Commit

Permalink
Merge pull request #401 from mvdoc/doc/actmaps
Browse files Browse the repository at this point in the history
DOC: add missing docstring for dim in plot_anat
  • Loading branch information
yarikoptic committed May 25, 2016
2 parents 6f77638 + 65bb9cc commit ccb1c8d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions nipy/labs/viz_tools/activation_maps.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,11 @@ def plot_anat(anat=None, anat_affine=None, cut_coords=None, slicer='ortho',
you whish to save figures with a black background, you
will need to pass "facecolor='k', edgecolor='k'" to pylab's
savefig.
dim: float, optional
If set, dim the anatomical image, such that
vmax = vmean + (1+dim)*ptp if black_bg is set to True, or
vmin = vmean - (1+dim)*ptp otherwise, where
ptp = .5*(vmax - vmin)
cmap: matplotlib colormap, optional
The colormap for the anat
Expand Down

0 comments on commit ccb1c8d

Please sign in to comment.