Skip to content

Commit 46d3e71

Browse files
committed
DOC - add docstring comment about append_diag
To clarify what it does, a little.
1 parent cf288c3 commit 46d3e71

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

nibabel/affines.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ def apply_affine(aff, pts):
7979
def append_diag(aff, steps, starts=()):
8080
""" Add diagonal elements `steps` and translations `starts` to affine
8181
82+
Typical use is in expanding 4x4 affines to larger dimensions. Nipy is the
83+
main consumer because it uses NxM affines, whereas we generally only use 4x4
84+
affines; the routine is here for convenience.
85+
8286
Parameters
8387
----------
8488
aff : 2D array

0 commit comments

Comments
 (0)