From 8db0b2a38181ad0aac4faa7352477e337f5d21f4 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Tue, 28 Feb 2017 12:07:47 +0000
Subject: [PATCH] Documentation fix to Nifti.getOrientation - I had it
backwards, because I was using transposed xforms!
---
fsl/data/image.py | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/fsl/data/image.py b/fsl/data/image.py
index f5cdce5c6..2b17dd65b 100644
--- a/fsl/data/image.py
+++ b/fsl/data/image.py
@@ -501,13 +501,18 @@ class Nifti(notifier.Notifier):
def getOrientation(self, axis, xform):
- """Returns a code representing the orientation of the specified data
- axis in the coordinate system defined by the given transformation
+ """Returns a code representing the orientation of the specified
+ axis in the input coordinate system of the given transformation
matrix.
:arg xform: A transformation matrix which is assumed to transform
- coordinates from the image world coordinate system to
- some other coordinate system.
+ coordinates from some coordinate system (the one
+ which you want an orientation for) into the image
+ world coordinate system.
+
+ For example, if you pass in the voxel-to-world
+ transformation matrix, you will get an orientation
+ for axes in the voxel coordinate system.
This method returns one of the following values, indicating the
direction in which coordinates along the specified axis increase:
--
GitLab