ENH: Validate units parameter in all get/set_zooms

Author: effigies

nibabel/analyze.py

@@ -693,6 +693,8 @@ def get_zooms(self, units='norm', raise_unknown=False):
         >>> hdr.get_zooms()
         (3.0, 4.0)
         '''
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         hdr = self._structarr
         dims = hdr['dim']
         ndim = dims[0]
@@ -715,6 +717,8 @@ def set_zooms(self, zooms, units='norm'):
             spatial/temporal or as raw values to be interpreted according to
             format specification.
         '''
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         hdr = self._structarr
         dims = hdr['dim']
         ndim = dims[0]

nibabel/ecat.py

@@ -583,6 +583,8 @@ def get_frame_affine(self, frame=0):
 
     def get_zooms(self, frame=0, units='norm', raise_unknown=False):
         """returns zooms  ...pixdims"""
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         subhdr = self.subheaders[frame]
         x_zoom = subhdr['x_pixel_size'] * 10
         y_zoom = subhdr['y_pixel_size'] * 10

nibabel/freesurfer/mghformat.py

@@ -302,7 +302,11 @@ def set_zooms(self, zooms, units='norm'):
             Zooms are specified in normalized units of mm/sec for
             spatial/temporal dimensions or as raw values to be stored in
             header.
+
+        .. _mghformat: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat#line-82
         '''
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         hdr = self._structarr
         zooms = np.asarray(zooms)
         ndims = self._ndims()
@@ -317,12 +321,7 @@ def set_zooms(self, zooms, units='norm'):
             if zooms[3] < 0:
                 raise HeaderDataError('TR must be non-negative; got {!r}'
                                       ''.format(zooms[3]))
-            if units == 'norm':
-                tfactor = 1000
-            elif units == 'raw':
-                tfactor = 1
-            else:
-                raise ValueError("`units` parameter must be 'norm' or 'raw'")
+            tfactor = 1000 if units == 'norm' else 1
             hdr['tr'] = zooms[3] * tfactor
 
     def get_data_shape(self):

nibabel/minc1.py

@@ -94,6 +94,8 @@ def get_data_shape(self):
 
     def get_zooms(self, units='norm', raise_unknown=False):
         """ Get real-world sizes of voxels """
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         # zooms must be positive; but steps in MINC can be negative
         return tuple([abs(float(dim.step)) if hasattr(dim, 'step') else 1.0
                       for dim in self._dims])

nibabel/nifti1.py

@@ -1769,6 +1769,9 @@ def set_zooms(self, zooms, units=None):
                           ''.format(self.__class__.__name__),
                           FutureWarning, stacklevel=2)
 
+        if units not in ('norm', 'raw') and not isinstance(units, tuple):
+            raise ValueError("`units` parameter must be 'norm', 'raw',"
+                             " or a tuple of unit codes (see set_xyzt_units)")
         super(Nifti1Header, self).set_zooms(zooms, units=units)
 
         if isinstance(units, tuple):
@@ -1781,9 +1784,6 @@ def set_zooms(self, zooms, units=None):
             elif len(zooms) > 3 and t_code in ('unknown', 'sec', 'msec', 'usec'):
                 t_code = 'sec'
             self.set_xyzt_units(xyz_code, t_code)
-        elif units != 'raw':
-            raise ValueError("`units` parameter must be 'norm', 'raw',"
-                             " or a tuple of unit codes (see set_xyzt_units)")
 
     def _clean_after_mapping(self):
         ''' Set format-specific stuff after converting header from mapping

nibabel/spatialimages.py

@@ -246,6 +246,8 @@ def get_zooms(self, units='norm', raise_unknown=False):
         zooms : tuple
             Spacing between voxels along each axis
         '''
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         return self._zooms
 
     def set_zooms(self, zooms, units='norm'):
@@ -260,6 +262,8 @@ def set_zooms(self, zooms, units='norm'):
             spatial/temporal or as raw values to be interpreted according to
             format specification.
         '''
+        if units not in ('norm', 'raw'):
+            raise ValueError("`units` parameter must be 'norm' or 'raw'")
         zooms = tuple(float(z) for z in zooms)
         shape = self.get_data_shape()
         ndim = len(shape)