Skip to content

Commit 0932c6d

Browse files
committed
DOC: Update docstrings to describe affine property
1 parent d9463a2 commit 0932c6d

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

nibabel/nicom/dicomwrappers.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ class Wrapper(object):
9696
9797
Methods:
9898
99-
* get_affine()
99+
* get_affine() (deprecated, use affine property instead)
100100
* get_data()
101101
* get_pixel_array()
102102
* is_same_series(other)
@@ -105,6 +105,7 @@ class Wrapper(object):
105105
106106
Attributes and things that look like attributes:
107107
108+
* affine : (4, 4) array
108109
* dcm_data : object
109110
* image_shape : tuple
110111
* image_orient_patient : (3,2) array
@@ -298,11 +299,8 @@ def get_affine(self):
298299
def affine(self):
299300
""" Mapping between voxel and DICOM coordinate system
300301
301-
Returns
302-
-------
303-
aff : (4,4) affine
304-
Affine giving transformation between voxels in data array and
305-
mm in the DICOM patient coordinate system.
302+
(4, 4) affine matrix giving transformation between voxels in data array
303+
and mm in the DICOM patient coordinate system.
306304
"""
307305
# rotation matrix already accounts for the ij transpose in the
308306
# DICOM image orientation patient transform. So. column 0 is

0 commit comments

Comments
 (0)