STY: rename get_dimension_labels to get_volume_labels

Author: grlee77

nibabel/parrec.py

@@ -1126,7 +1126,7 @@ def get_sorted_slice_indices(self):
         n_used = np.prod(self.get_data_shape()[2:])
         return sort_order[:n_used]
 
-    def get_dimension_labels(self, collapse_slices=True):
+    def get_volume_labels(self, collapse_slices=True):
         """ Dynamic labels corresponding to the final data dimension(s).
 
         This is useful for custom data sorting.  A subset of the info in
@@ -1148,6 +1148,8 @@ def get_dimension_labels(self, collapse_slices=True):
             The ordering of each value corresponds to that returned by
             ``self.get_sorted_slice_indices``.
         """
+        sorted_indices = self.get_sorted_slice_indices()
+        image_defs = self.image_defs
 
         # define which keys to store sorting info for
         dynamic_keys = ['slice number',
@@ -1163,9 +1165,6 @@ def get_dimension_labels(self, collapse_slices=True):
                         'gradient orientation number',
                         'diffusion b value number']
 
-        sorted_indices = self.get_sorted_slice_indices()
-        image_defs = self.image_defs
-
         if collapse_slices:
             dynamic_keys.remove('slice number')
 
@@ -1187,15 +1186,12 @@ def get_dimension_labels(self, collapse_slices=True):
                 non_unique_keys.append(key)
 
         if collapse_slices:
-            if 'slice orientation' in non_unique_keys:
-                raise ValueError("for non-unique slice orientation, need "
-                                 "collapse_slice=False")
-            if 'image angulation' in non_unique_keys:
-                raise ValueError("for non-unique image angulation, need "
-                                 "collapse_slice=False")
-            if 'image_display_orientation' in non_unique_keys:  # ???
-                raise ValueError("for non-unique display orientation, need "
-                                 "collapse_slice=False")
+            for key in ('slice_orientation', 'image_angulation',
+                        'image_display_orientation'):
+                if key in non_unique_keys:
+                    raise ValueError(
+                        'for values of {0} that differ overslices, use '
+                        '"collapse_slice=False"'.format(key))
             sl1_indices = image_defs['slice number'][sorted_indices] == 1
 
         sort_info = {}

nibabel/tests/test_parrec.py

@@ -192,13 +192,13 @@ def test_header_scaling():
 def test_header_dimension_labels():
     hdr = PARRECHeader(HDR_INFO, HDR_DEFS)
     # check volume labels
-    vol_labels = hdr.get_dimension_labels()
+    vol_labels = hdr.get_volume_labels()
     assert_equal(list(vol_labels.keys()), ['dynamic scan number'])
     assert_array_equal(vol_labels['dynamic scan number'], [1, 2, 3])
     # check that output is ndarray rather than list
     assert_true(isinstance(vol_labels['dynamic scan number'], np.ndarray))
     # check case with individual slice labels
-    slice_vol_labels = hdr.get_dimension_labels(collapse_slices=False)
+    slice_vol_labels = hdr.get_volume_labels(collapse_slices=False)
     # verify that both expected keys are present
     assert_true('slice number' in slice_vol_labels)
     assert_true('dynamic scan number' in slice_vol_labels)
@@ -302,7 +302,7 @@ def test_sorting_dual_echo_T1():
     assert_equal(np.all(sorted_echos[n_half:] == 2), True)
 
     # check volume labels
-    vol_labels = t1_hdr.get_dimension_labels()
+    vol_labels = t1_hdr.get_volume_labels()
     assert_equal(list(vol_labels.keys()), ['echo number'])
     assert_array_equal(vol_labels['echo number'], [1, 2])
 
@@ -349,7 +349,7 @@ def test_sorting_multiple_echos_and_contrasts():
     assert_equal(np.all(sorted_types[3*ntotal//4:ntotal] == 3), True)
 
     # check volume labels
-    vol_labels = t1_hdr.get_dimension_labels()
+    vol_labels = t1_hdr.get_volume_labels()
     assert_equal(sorted(list(vol_labels.keys())),
                  ['echo number', 'image_type_mr'])
     assert_array_equal(vol_labels['echo number'], [1, 2, 3]*4)
@@ -398,7 +398,7 @@ def test_sorting_multiecho_ASL():
     assert_array_equal(sorted_slices[:nslices], np.arange(1, nslices+1))
 
     # check volume labels
-    vol_labels = asl_hdr.get_dimension_labels()
+    vol_labels = asl_hdr.get_volume_labels()
     assert_equal(sorted(list(vol_labels.keys())),
                  ['dynamic scan number', 'echo number', 'label type'])
     assert_array_equal(vol_labels['dynamic scan number'], [1]*6 + [2]*6)