@@ -85,17 +85,15 @@ def _pack_rgba(rgba):
8585 """Pack an RGBA sequence into a single integer.
8686
8787 Used by :func:`read_annot` and :func:`write_annot` to generate
88- "annotation values" for a Freesuerfer `.annot` file.
88+ "annotation values" for a Freesuerfer `` .annot` ` file.
8989
9090 Parameters
9191 ----------
92-
9392 rgba : ndarray, shape (n, 4)
9493 RGBA colours
9594
9695 Returns
9796 -------
98-
9997 out : ndarray, shape (n, 1)
10098 Annotation values for each colour.
10199 """
@@ -326,16 +324,14 @@ def write_morph_data(file_like, values, fnum=0):
326324
327325
328326def read_annot (filepath , orig_ids = False ):
329- """Read in a Freesurfer annotation from a `.annot` file.
327+ """Read in a Freesurfer annotation from a `` .annot` ` file.
330328
331- An `.annot` file contains a sequence of vertices with a label (also known
329+ An `` .annot` ` file contains a sequence of vertices with a label (also known
332330 as an "annotation value") associated with each vertex, and then a sequence
333331 of colours corresponding to each label.
334332
335- The colour table itself may be stored in either an "old-style" format, or
336- a "new-style" format - the :func:`_read_annot_ctab_old_format` and
337- :func:`_read_annot_ctab_new_format` functions are respectively used to
338- read in the colour table.
333+ Annotation file format versions 1 and 2 are supported, corresponding to
334+ the "old-style" and "new-style" color table layout.
339335
340336 See:
341337 https://surfer.nmr.mgh.harvard.edu/fswiki/LabelsClutsAnnotationFiles#Annotation
@@ -488,7 +484,7 @@ def _read_annot_ctab_new_format(fobj, ctab_version):
488484
489485
490486def write_annot (filepath , labels , ctab , names , fill_ctab = True ):
491- """Write out a Freesurfer annotation file.
487+ """Write out a "new-style" Freesurfer annotation file.
492488
493489 See:
494490 https://surfer.nmr.mgh.harvard.edu/fswiki/LabelsClutsAnnotationFiles#Annotation
0 commit comments