Skip to content

Commit 14ebea0

Browse files
committed
Document additional parameters and change order.
Argument order should now allow full backwards compatability
1 parent 10c4edf commit 14ebea0

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

surfer/viz.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1163,8 +1163,8 @@ def remove_labels(self, labels=None, hemi=None):
11631163
ll.remove()
11641164

11651165
def add_morphometry(self, measure, grayscale=False, hemi=None,
1166-
colormap=None, min=None, max=None, colorbar=True,
1167-
remove_existing=True):
1166+
remove_existing=True, colormap=None,
1167+
min=None, max=None, colorbar=True):
11681168
"""Add a morphometry overlay to the image.
11691169
11701170
Parameters
@@ -1177,10 +1177,16 @@ def add_morphometry(self, measure, grayscale=False, hemi=None,
11771177
If None, it is assumed to belong to the hemipshere being
11781178
shown. If two hemispheres are being shown, data must exist
11791179
for both hemispheres.
1180-
colormap : str
1181-
Mayavi colormap name, or None to use a sensible default.
11821180
remove_existing : bool
11831181
If True (default), remove old annotations.
1182+
colormap : str
1183+
Mayavi colormap name, or None to use a sensible default.
1184+
min, max : floats
1185+
Endpoints for the colormap; if not provided the robust range
1186+
of the data is used.
1187+
colorbar : bool
1188+
If True, show a colorbar corresponding to the overlay data.
1189+
11841190
"""
11851191
hemis = self._check_hemis(hemi)
11861192
morph_files = []

0 commit comments

Comments
 (0)