RF: rename axis2inax to output_axis_index

matthew-brett · matthew-brett · commit f0d5a1bf8b79 · 2012-06-09T19:35:23.000-07:00
From suggestion by Satra
diff --git a/nipy/core/image/image.py b/nipy/core/image/image.py
@@ -20,7 +20,7 @@
 # These imports are used in the fromarray and subsample functions only, not in
 # Image
 from ..reference.coordinate_map import (AffineTransform, CoordinateSystem,
-                                       axid2inax)
+                                       input_axis_index)
 from ..reference.array_coords import ArrayCoordMap
 
 
@@ -733,8 +733,8 @@ def rollimg(img, axis, start=0, fix0=False):
                      [ 0.,  0.,  0.,  0.,  1.]])
     )
     """
-    axis = axid2inax(img.coordmap, axis, fix0)
-    start = axid2inax(img.coordmap, start, fix0)
+    axis = input_axis_index(img.coordmap, axis, fix0)
+    start = input_axis_index(img.coordmap, start, fix0)
     order = range(img.ndim)
     order.remove(axis)
     order.insert(start, axis)
diff --git a/nipy/core/reference/coordinate_map.py b/nipy/core/reference/coordinate_map.py
@@ -1901,7 +1901,7 @@ def axmap(coordmap, direction='in2out', fix0=False):
     return in2out_map, out2in_map
 
 
-def axid2inax(coordmap, axis_id, fix0=False):
+def input_axis_index(coordmap, axis_id, fix0=False):
     """ Return input axis index for `axis_id`
 
     `axis_id` can be integer, or a name of an input axis, or it can be the name
diff --git a/nipy/core/reference/tests/test_coordinate_map.py b/nipy/core/reference/tests/test_coordinate_map.py
@@ -8,7 +8,7 @@
                               shifted_domain_origin, shifted_range_origin,
                               CoordMapMaker, CoordMapMakerError,
                               _as_coordinate_map, AxisError, _fix0,
-                              axmap, orth_axes, axid2inax, axid2axes)
+                              axmap, orth_axes, input_axis_index, axid2axes)
 
 from ..coordinate_system import (CoordinateSystem, CoordinateSystemError,
                                  CoordSysMaker, CoordSysMakerError)
@@ -770,34 +770,34 @@ def test_orth_axes():
     assert_false(orth_axes(0, 0, aff))
 
 
-def test_axid2inax():
+def test_input_axis_index():
     # Test routine to map name to input axis
     cmap = AffineTransform('ijk', 'xyz', np.eye(4))
     for i, in_name, out_name in zip(range(3), 'ijk', 'xyz'):
-        assert_equal(axid2inax(cmap, in_name), i)
-        assert_equal(axid2inax(cmap, out_name), i)
+        assert_equal(input_axis_index(cmap, in_name), i)
+        assert_equal(input_axis_index(cmap, out_name), i)
     flipped = [[0, 0, 1, 1], [0, 1, 0, 2], [1, 0, 0, 3], [0, 0, 0, 1]]
     cmap_f = AffineTransform('ijk', 'xyz', flipped)
     for i, in_name, out_name in zip(range(3), 'ijk', 'zyx'):
-        assert_equal(axid2inax(cmap_f, in_name), i)
-        assert_equal(axid2inax(cmap_f, out_name), i)
+        assert_equal(input_axis_index(cmap_f, in_name), i)
+        assert_equal(input_axis_index(cmap_f, out_name), i)
     # Names can be same in input and output but they must match
     cmap_m = AffineTransform('ijk', 'kji', flipped)
     for i, in_name, out_name in zip(range(3), 'ijk', 'ijk'):
-        assert_equal(axid2inax(cmap_m, in_name), i)
-        assert_equal(axid2inax(cmap_m, out_name), i)
+        assert_equal(input_axis_index(cmap_m, in_name), i)
+        assert_equal(input_axis_index(cmap_m, out_name), i)
     # If they don't match, AxisError
     cmap_b = AffineTransform('ijk', 'xiz', np.eye(4))
-    assert_equal(axid2inax(cmap_m, 'j'), 1)
-    assert_raises(AxisError, axid2inax, cmap_b, 'i')
+    assert_equal(input_axis_index(cmap_m, 'j'), 1)
+    assert_raises(AxisError, input_axis_index, cmap_b, 'i')
     # Name not found, AxisError
-    assert_raises(AxisError, axid2inax, cmap_b, 'q')
+    assert_raises(AxisError, input_axis_index, cmap_b, 'q')
     # 0 usually leads to no match
     cmap_z = AffineTransform('ijk', 'xyz', np.diag([2, 3, 0, 1]))
-    assert_equal(axid2inax(cmap_z, 'y'), 1)
-    assert_raises(AxisError, axid2inax, cmap_z, 'z')
+    assert_equal(input_axis_index(cmap_z, 'y'), 1)
+    assert_raises(AxisError, input_axis_index, cmap_z, 'z')
     # Unless fix0 in place
-    assert_equal(axid2inax(cmap_z, 'z', fix0=True), 2)
+    assert_equal(input_axis_index(cmap_z, 'z', fix0=True), 2)
 
 
 def test_axid2axes():
