wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-09-12 12:50:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Make ndim explicit arg for clarity and update docstring

Browse Source
This commit is contained in:
Steven Silvester
2014-09-21 05:48:58 -05:00
parent bcac1b1a6d
commit 2a057f7246
17 changed files with 44 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/_shared/utils.py
+6 -6
View File
@@ -143,23 +143,23 @@ def safe_as_int(val, atol=1e-3):
return np.round(val).astype(np.int64)
def assert_nD(array, arg_name='image', ndim=2):
def assert_nD(array, ndim, arg_name='image'):
"""
Verify an arry meets the desired ndims.
Verify an array meets the desired ndims.
Parameters
----------
array : array-like
Input array to be validated
arg_name : str
The name of the array in the original function.
ndim : int or array-like
ndim : int or iterable of ints
Allowable ndim or ndims for the array.
arg_name : str, optional
The name of the array in the original function.
"""
array = np.asanyarray(array)
msg = "The parameter `%s` must be a %s-dimensional array"
if isinstance(ndim, int):
ndim = [ndim]
if not array.ndim in ndim:
msg = "The parameter `%s` must be a %s-dimensional array"
raise ValueError(msg % (arg_name, '-or-'.join([str(n) for n in ndim])))