Adds shape property to NDCube

changelog/684.breaking.rst

@@ -0,0 +1 @@
+"dimensions" property has been depcreated and replaced by "shape"

ndcube/ndcube.py

@@ -28,7 +28,7 @@
 from ndcube.global_coords import GlobalCoords, GlobalCoordsABC
 from ndcube.mixins import NDCubeSlicingMixin
 from ndcube.ndcube_sequence import NDCubeSequence
-from ndcube.utils.exceptions import NDCubeDeprecationWarning
+from ndcube.utils.exceptions import warn_deprecated
 from ndcube.utils.wcs_high_level_conversion import values_to_high_level_objects
 from ndcube.visualization import PlotterDescriptor
 from ndcube.wcs.wrappers import CompoundLowLevelWCS, ResampledLowLevelWCS
@@ -416,12 +416,12 @@
 
     @property
     def dimensions(self):
-        warnings.warn("Replaced by ndcube.NDCube.shape", NDCubeDeprecationWarning)
+        warn_deprecated("Replaced by ndcube.NDCube.shape")
         return u.Quantity(self.data.shape, unit=u.pix)
 
     @property
     def shape(self):
         return self.data.shape
 
     @property
     def array_axis_physical_types(self):

ndcube/ndcube_sequence.py

@@ -1,14 +1,13 @@
 import copy
 import numbers
 import textwrap
-import warnings
 
 import numpy as np
 
 import astropy.units as u
 
 from ndcube import utils
-from ndcube.utils.exceptions import NDCubeDeprecationWarning
+from ndcube.utils.exceptions import warn_deprecated
 from ndcube.visualization.descriptor import PlotterDescriptor
 
 
@@ -48,16 +47,16 @@
         """
         The length of each axis including the sequence axis.
         """
-        warnings.warn("Replaced by ndcube.NDCubeSequence.shape", NDCubeDeprecationWarning)
+        warn_deprecated("Replaced by ndcube.NDCubeSequence.shape")
         return tuple([d * u.pix for d in self._shape])
 
     @property
     def shape(self):
         return self._shape
 
     @property
     def _shape(self):
         dimensions = [len(self.data)] + list(self.data[0].shape)
         if len(dimensions) > 1:
             # If there is a common axis, length of cube's along it may not
             # be the same. Therefore if the lengths are different,
@@ -65,9 +64,9 @@
             if self._common_axis is not None:
                 common_axis_lengths = [cube.data.shape[self._common_axis] for cube in self.data]
                 if len(np.unique(common_axis_lengths)) != 1:
                     common_axis_dimensions = tuple([cube.shape[self._common_axis]
                                                    for cube in self.data])
                     dimensions[self._common_axis + 1] = common_axis_dimensions
         return tuple(dimensions)
 
     @property