From 97fb4b59487a769b26762b9a65f80a02c0f610ef Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Tue, 27 Feb 2018 11:58:58 +0000
Subject: [PATCH] imagewrapper.canonicalShape moved to image module
---
fsl/data/image.py | 28 ++++++++++++++++++++++++++--
fsl/data/imagewrapper.py | 26 ++++++--------------------
2 files changed, 32 insertions(+), 22 deletions(-)
diff --git a/fsl/data/image.py b/fsl/data/image.py
index ab36ce0cb..c6f83c598 100644
--- a/fsl/data/image.py
+++ b/fsl/data/image.py
@@ -22,6 +22,7 @@ and file names:
.. autosummary::
:nosignatures:
+ canonicalShape
looksLikeImage
addExt
splitExt
@@ -311,10 +312,10 @@ class Nifti(notifier.Notifier, meta.Meta):
- A sequence/tuple containing the zooms/pixdims.
"""
- # The canonicalShape method figures out
+ # The canonicalShape function figures out
# the data shape that we should use.
origShape = list(header.get_data_shape())
- shape = imagewrapper.canonicalShape(origShape)
+ shape = canonicalShape(origShape)
pixdims = list(header.get_zooms())
# if get_zooms() doesn't return at
@@ -1318,6 +1319,29 @@ class Image(Nifti):
self.notify(topic='dataRange')
+def canonicalShape(shape):
+ """Calculates a *canonical* shape, how the given ``shape`` should
+ be presented. The shape is forced to be at least three dimensions,
+ with any other trailing dimensions of length 1 ignored.
+ """
+
+ shape = list(shape)
+
+ # Squeeze out empty dimensions, as
+ # 3D image can sometimes be listed
+ # as having 4 or more dimensions
+ for i in reversed(range(len(shape))):
+ if shape[i] == 1: shape = shape[:i]
+ else: break
+
+ # But make sure the shape
+ # has at 3 least dimensions
+ if len(shape) < 3:
+ shape = shape + [1] * (3 - len(shape))
+
+ return shape
+
+
def looksLikeImage(filename, allowedExts=None):
"""Returns ``True`` if the given file looks like a NIFTI image, ``False``
otherwise.
diff --git a/fsl/data/imagewrapper.py b/fsl/data/imagewrapper.py
index edb4df4e4..5e06d5c88 100644
--- a/fsl/data/imagewrapper.py
+++ b/fsl/data/imagewrapper.py
@@ -766,27 +766,13 @@ def canonicalSliceObj(sliceobj, shape):
return nib.fileslice.canonical_slicers(sliceobj, shape)
+@deprecation.deprecated(deprecated_in='1.7.0',
+ removed_in='2.0.0',
+ details='moved to the fsl.data.image module')
def canonicalShape(shape):
- """Calculates a *canonical* shape, how the given ``shape`` should
- be presented. The shape is forced to be at least three dimensions,
- with any other trailing dimensions of length 1 ignored.
- """
-
- shape = list(shape)
-
- # Squeeze out empty dimensions, as
- # 3D image can sometimes be listed
- # as having 4 or more dimensions
- for i in reversed(range(len(shape))):
- if shape[i] == 1: shape = shape[:i]
- else: break
-
- # But make sure the shape
- # has at 3 least dimensions
- if len(shape) < 3:
- shape = shape + [1] * (3 - len(shape))
-
- return shape
+ """Deprecated - moved to the :mod:`fsl.data.image` module. """
+ from fsl.data.image import canonicalShape
+ return canonicalShape(shape)
def expectedShape(sliceobj, shape):
--
GitLab