Skip to content

Commit 317c0fc

Browse files
author
CindeeM
committed
added examples to new function get_series_framenumbers
1 parent 752c647 commit 317c0fc

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

nibabel/ecat.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,7 @@ def get_frame_order(self):
465465
>>> mlist.get_frame_order()
466466
{0: [0, 16842758.0]}
467467
468+
468469
"""
469470
mlist = self._mlist
470471
ids = mlist[:, 0].copy()
@@ -499,8 +500,20 @@ def get_series_framenumbers(self):
499500
frame_dict: dict mapping order_stored -> frame in series
500501
where frame in series counts from 1; [1,2,3,4...]
501502
503+
Examples
504+
--------
505+
>>> import os
506+
>>> import nibabel as nib
507+
>>> nibabel_dir = os.path.dirname(nib.__file__)
508+
>>> from nibabel import ecat
509+
>>> ecat_file = os.path.join(nibabel_dir,'tests','data','tinypet.v')
510+
>>> img = ecat.load(ecat_file)
511+
>>> mlist = img.get_mlist()
512+
>>> mlist.get_series_framenumbers()
513+
{0: 1}
502514
503515
516+
504517
"""
505518
frames_order = self.get_frame_order()
506519
nframes = self.hdr['num_frames']

0 commit comments

Comments
 (0)