Skip to content

DOC: get_slice_indices #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2016
Merged

DOC: get_slice_indices #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions pypreprocess/slice_timing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,23 @@ def get_slice_indices(n_slices, slice_order='ascending',
Parameters
----------
n_slices: int
the number of slices there're altogether
The number of slices there're altogether.

slice_order: string or array of ints or length n_slices
slice order of acquisitions in a TR
slice_order: string ('ascending', 'descending'), or array of ints or
length n_slices slice order of acquisitions in a TR.
'ascending': slices were acquired from bottommost to topmost
'descending': slices were acquired from topmost to bottommost
'descending': slices were acquired from topmost to bottommost.
If list of integers, 0-based (i.e Python!) indexing is assumed.

interleaved: bool (optional, default False)
if set, then slices were acquired in interleaved order, odd-numbered
slices first, and then even-numbered slices
Ff set, then slices were acquired in interleaved order, odd-numbered
slices first, and then even-numbered slices.

Returns
-------
slice_indices: 1D array of length n_slices
slice indices consistent with slice order (i.e, slice_indices[k]
is the corrected index of slice k according to the slice order)
Slice indices consistent with slice order (i.e, slice_indices[k]
is the corrected index of slice k according to the slice order).

Raises
------
Expand Down