From 00b4fa45e70b16454864c57f5b3b5b32dab3fa91 Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Fri, 2 May 2014 16:01:35 +0200 Subject: [PATCH 1/6] Always interpret provided shapes as int. Add a note on using output_shape for color images. --- skimage/transform/_geometric.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index 883aa88d..3c14f709 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -1003,7 +1003,8 @@ def warp(image, inverse_map=None, map_args={}, output_shape=None, order=1, Keyword arguments passed to `inverse_map`. output_shape : tuple (rows, cols), optional Shape of the output image generated. By default the shape of the input - image is preserved. + image is preserved. Note that, even for multi-band images, only rows + and columns need to be specified. order : int, optional The order of interpolation. The order has to be in the range 0-5: * 0: Nearest-neighbor @@ -1073,6 +1074,7 @@ def warp(image, inverse_map=None, map_args={}, output_shape=None, order=1, image = np.atleast_3d(img_as_float(image)) ishape = np.array(image.shape) bands = ishape[2] + output_shape = np.array(output_shape, dtype=int) out = None @@ -1102,8 +1104,8 @@ def warp(image, inverse_map=None, map_args={}, output_shape=None, order=1, dims = [] for dim in range(image.shape[2]): dims.append(_warp_fast(image[..., dim], matrix, - output_shape=output_shape, - order=order, mode=mode, cval=cval)) + output_shape=output_shape, + order=order, mode=mode, cval=cval)) out = np.dstack(dims) if orig_ndim == 2: out = out[..., 0] From 4c7cd9bd654c1a088c72391048ced98f5c97bdc7 Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Fri, 2 May 2014 16:23:41 +0200 Subject: [PATCH 2/6] Add unit test to catch non-integer output shape bug --- skimage/transform/_geometric.py | 11 ++++++----- skimage/transform/tests/test_warps.py | 5 +++++ 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index 3c14f709..53074c00 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -1074,7 +1074,12 @@ def warp(image, inverse_map=None, map_args={}, output_shape=None, order=1, image = np.atleast_3d(img_as_float(image)) ishape = np.array(image.shape) bands = ishape[2] - output_shape = np.array(output_shape, dtype=int) + + if output_shape is None: + output_shape = ishape + else: + output_shape = np.array(output_shape, dtype=int) + out = None @@ -1111,10 +1116,6 @@ def warp(image, inverse_map=None, map_args={}, output_shape=None, order=1, out = out[..., 0] if out is None: # use ndimage.map_coordinates - - if output_shape is None: - output_shape = ishape - rows, cols = output_shape[:2] # inverse_map is a transformation matrix as numpy array diff --git a/skimage/transform/tests/test_warps.py b/skimage/transform/tests/test_warps.py index e49ab098..f85125d0 100644 --- a/skimage/transform/tests/test_warps.py +++ b/skimage/transform/tests/test_warps.py @@ -248,5 +248,10 @@ def test_inverse(): assert_array_equal(warp(image, inverse_tform), warp(image, tform.inverse)) +def test_slow_warp_nonint_oshape(): + image = np.random.random((5, 5)) + warp(image, lambda xy: xy, output_shape=(13.1, 19.5)) + + if __name__ == "__main__": run_module_suite() From e9c793eb177661b34d39f0acaa834d7349b3d88c Mon Sep 17 00:00:00 2001 From: "Josh Warner (Mac)" Date: Tue, 6 May 2014 13:09:03 -0500 Subject: [PATCH 3/6] FEAT: Shared function for safe int casting --- skimage/_shared/safe_int_cast.py | 61 +++++++++++++++++++++ skimage/_shared/tests/test_safe_int_cast.py | 36 ++++++++++++ 2 files changed, 97 insertions(+) create mode 100644 skimage/_shared/safe_int_cast.py create mode 100644 skimage/_shared/tests/test_safe_int_cast.py diff --git a/skimage/_shared/safe_int_cast.py b/skimage/_shared/safe_int_cast.py new file mode 100644 index 00000000..0733cf61 --- /dev/null +++ b/skimage/_shared/safe_int_cast.py @@ -0,0 +1,61 @@ +import numpy as np + +__all__ == ['_safe_int'] + + +def _safe_int_cast(val, atol=1e-7): + """ + Attempt to safely cast values to integer format. + + Parameters + ---------- + val : scalar or iterable of scalars + Number or container of numbers which are intended to be interpreted as + integers, e.g., for indexing purposes, but which may not carry integer + type. + atol : float + Absolute tolerance away from nearest integer to consider values in + ``val`` functionally integers. + + Returns + ------- + val_int : NumPy scalar or ndarray of dtype `np.int32` + Returns the input value(s) coerced to dtype `np.int32` assuming all + were within ``atol`` of the nearest integer. + + Notes + ----- + This operation calculates ``val`` modulo 1, which returns the mantissa of + all values. Then all mantissas greater than 0.5 are subtracted from one. + Finally, the absolute tolerance from zero is calculated. If it is less + than ``atol`` for all value(s) in ``val``, they are rounded and returned + in an integer array. Or, if ``val`` was a scalar, a NumPy scalar type is + returned. + + If any value(s) are outside the specified tolerance, an informative error + is raised. + + Examples + -------- + >>> _safe_int_cast(7.0) + 7 + >>> _safe_int_cast([9, 4, 2.9999999999]) + array([9, 4, 3], dtype=int32) + + """ + mod = np.asarray(val) % 1 # Modulo 1 + + # Check for and subtract any mod values > 0.5 from 1 + if mod.ndim == 0: # Scalar input, cannot be indexed + if mod > 0.5: + mod = 1 - mod + else: # Iterable input, now ndarray + mod[mod > 0.5] = 1 - mod[mod > 0.5] # Test on each side of nearest int + + try: + np.testing.assert_allclose(mod, 0, atol=atol) + except AssertionError: + raise ValueError("Integer argument required but received " + "{0}, check inputs.".format(val)) + + return np.round(val).astype(np.int32) diff --git a/skimage/_shared/tests/test_safe_int_cast.py b/skimage/_shared/tests/test_safe_int_cast.py new file mode 100644 index 00000000..27f88323 --- /dev/null +++ b/skimage/_shared/tests/test_safe_int_cast.py @@ -0,0 +1,36 @@ +import numpy as np +from skimage._shared.safe_int_cast import _safe_int_cast + + +def test_int_cast_not_possible(): + np.testing.assert_raises(ValueError, _safe_int_cast, 7.1) + np.testing.assert_raises(ValueError, _safe_int_cast, [7.1, 0.9]) + np.testing.assert_raises(ValueError, _safe_int_cast, np.r_[7.1, 0.9]) + np.testing.assert_raises(ValueError, _safe_int_cast, (7.1, 0.9)) + np.testing.assert_raises(ValueError, _safe_int_cast, ((3, 4, 1), + (2, 7.6, 289))) + + np.testing.assert_raises(ValueError, _safe_int_cast, 7.1, 0.09) + np.testing.assert_raises(ValueError, _safe_int_cast, [7.1, 0.9], 0.09) + np.testing.assert_raises(ValueError, _safe_int_cast, np.r_[7.1, 0.9], 0.09) + np.testing.assert_raises(ValueError, _safe_int_cast, (7.1, 0.9), 0.09) + np.testing.assert_raises(ValueError, _safe_int_cast, ((3, 4, 1), + (2, 7.6, 289)), 0.25) + + +def test_int_cast_possible(): + np.testing.assert_equal(_safe_int_cast(7.1, atol=0.11), 7) + np.testing.assert_equal(_safe_int_cast(-7.1, atol=0.11), -7) + np.testing.assert_equal(_safe_int_cast(41.9, atol=0.11), 42) + np.testing.assert_array_equal(_safe_int_cast([2, 42, 5789234.0, 87, 4]), + np.r_[2, 42, 5789234, 87, 4]) + np.testing.assert_array_equal(_safe_int_cast(np.r_[[[3, 4, 1.000000001], + [7, 2, -8.999999999], + [6, 9, -4234918347.]]]), + np.r_[[[3, 4, 1], + [7, 2, -9], + [6, 9, -4234918347]]]) + + +if __name__ == '__main__': + np.testing.run_module_suite() From 07d3e6ede458093efa9b738c544f5e6e534718dc Mon Sep 17 00:00:00 2001 From: "Josh Warner (Mac)" Date: Wed, 7 May 2014 19:09:18 -0500 Subject: [PATCH 4/6] Convert name to _safe_as_int, output np.int64, expand Examples --- .../{safe_int_cast.py => safe_as_int.py} | 25 ++++++++----- skimage/_shared/tests/test_safe_as_int.py | 36 +++++++++++++++++++ skimage/_shared/tests/test_safe_int_cast.py | 36 ------------------- 3 files changed, 53 insertions(+), 44 deletions(-) rename skimage/_shared/{safe_int_cast.py => safe_as_int.py} (75%) create mode 100644 skimage/_shared/tests/test_safe_as_int.py delete mode 100644 skimage/_shared/tests/test_safe_int_cast.py diff --git a/skimage/_shared/safe_int_cast.py b/skimage/_shared/safe_as_int.py similarity index 75% rename from skimage/_shared/safe_int_cast.py rename to skimage/_shared/safe_as_int.py index 0733cf61..0d665f9f 100644 --- a/skimage/_shared/safe_int_cast.py +++ b/skimage/_shared/safe_as_int.py @@ -1,9 +1,9 @@ import numpy as np -__all__ == ['_safe_int'] +__all__ = ['_safe_as_int'] -def _safe_int_cast(val, atol=1e-7): +def _safe_as_int(val, atol=1e-7): """ Attempt to safely cast values to integer format. @@ -19,8 +19,8 @@ def _safe_int_cast(val, atol=1e-7): Returns ------- - val_int : NumPy scalar or ndarray of dtype `np.int32` - Returns the input value(s) coerced to dtype `np.int32` assuming all + val_int : NumPy scalar or ndarray of dtype `np.int64` + Returns the input value(s) coerced to dtype `np.int64` assuming all were within ``atol`` of the nearest integer. Notes @@ -37,13 +37,22 @@ def _safe_int_cast(val, atol=1e-7): Examples -------- - >>> _safe_int_cast(7.0) + >>> _safe_as_int(7.0) 7 - >>> _safe_int_cast([9, 4, 2.9999999999]) + + >>> _safe_as_int([9, 4, 2.9999999999]) array([9, 4, 3], dtype=int32) + >>> _safe_as_int(53.01) + Traceback (most recent call last): + ... + ValueError: Integer argument required but received 53.1, check inputs. + + >>> _safe_as_int(53.01, atol=0.01) + 53 + """ - mod = np.asarray(val) % 1 # Modulo 1 + mod = np.asarray(val) % 1 # Extract mantissa # Check for and subtract any mod values > 0.5 from 1 if mod.ndim == 0: # Scalar input, cannot be indexed @@ -58,4 +67,4 @@ def _safe_int_cast(val, atol=1e-7): raise ValueError("Integer argument required but received " "{0}, check inputs.".format(val)) - return np.round(val).astype(np.int32) + return np.round(val).astype(np.int64) diff --git a/skimage/_shared/tests/test_safe_as_int.py b/skimage/_shared/tests/test_safe_as_int.py new file mode 100644 index 00000000..1a3674e0 --- /dev/null +++ b/skimage/_shared/tests/test_safe_as_int.py @@ -0,0 +1,36 @@ +import numpy as np +from skimage._shared.safe_int_cast import _safe_as_int + + +def test_int_cast_not_possible(): + np.testing.assert_raises(ValueError, _safe_as_int, 7.1) + np.testing.assert_raises(ValueError, _safe_as_int, [7.1, 0.9]) + np.testing.assert_raises(ValueError, _safe_as_int, np.r_[7.1, 0.9]) + np.testing.assert_raises(ValueError, _safe_as_int, (7.1, 0.9)) + np.testing.assert_raises(ValueError, _safe_as_int, ((3, 4, 1), + (2, 7.6, 289))) + + np.testing.assert_raises(ValueError, _safe_as_int, 7.1, 0.09) + np.testing.assert_raises(ValueError, _safe_as_int, [7.1, 0.9], 0.09) + np.testing.assert_raises(ValueError, _safe_as_int, np.r_[7.1, 0.9], 0.09) + np.testing.assert_raises(ValueError, _safe_as_int, (7.1, 0.9), 0.09) + np.testing.assert_raises(ValueError, _safe_as_int, ((3, 4, 1), + (2, 7.6, 289)), 0.25) + + +def test_int_cast_possible(): + np.testing.assert_equal(_safe_as_int(7.1, atol=0.11), 7) + np.testing.assert_equal(_safe_as_int(-7.1, atol=0.11), -7) + np.testing.assert_equal(_safe_as_int(41.9, atol=0.11), 42) + np.testing.assert_array_equal(_safe_as_int([2, 42, 5789234.0, 87, 4]), + np.r_[2, 42, 5789234, 87, 4]) + np.testing.assert_array_equal(_safe_as_int(np.r_[[[3, 4, 1.000000001], + [7, 2, -8.999999999], + [6, 9, -4234918347.]]]), + np.r_[[[3, 4, 1], + [7, 2, -9], + [6, 9, -4234918347]]]) + + +if __name__ == '__main__': + np.testing.run_module_suite() diff --git a/skimage/_shared/tests/test_safe_int_cast.py b/skimage/_shared/tests/test_safe_int_cast.py deleted file mode 100644 index 27f88323..00000000 --- a/skimage/_shared/tests/test_safe_int_cast.py +++ /dev/null @@ -1,36 +0,0 @@ -import numpy as np -from skimage._shared.safe_int_cast import _safe_int_cast - - -def test_int_cast_not_possible(): - np.testing.assert_raises(ValueError, _safe_int_cast, 7.1) - np.testing.assert_raises(ValueError, _safe_int_cast, [7.1, 0.9]) - np.testing.assert_raises(ValueError, _safe_int_cast, np.r_[7.1, 0.9]) - np.testing.assert_raises(ValueError, _safe_int_cast, (7.1, 0.9)) - np.testing.assert_raises(ValueError, _safe_int_cast, ((3, 4, 1), - (2, 7.6, 289))) - - np.testing.assert_raises(ValueError, _safe_int_cast, 7.1, 0.09) - np.testing.assert_raises(ValueError, _safe_int_cast, [7.1, 0.9], 0.09) - np.testing.assert_raises(ValueError, _safe_int_cast, np.r_[7.1, 0.9], 0.09) - np.testing.assert_raises(ValueError, _safe_int_cast, (7.1, 0.9), 0.09) - np.testing.assert_raises(ValueError, _safe_int_cast, ((3, 4, 1), - (2, 7.6, 289)), 0.25) - - -def test_int_cast_possible(): - np.testing.assert_equal(_safe_int_cast(7.1, atol=0.11), 7) - np.testing.assert_equal(_safe_int_cast(-7.1, atol=0.11), -7) - np.testing.assert_equal(_safe_int_cast(41.9, atol=0.11), 42) - np.testing.assert_array_equal(_safe_int_cast([2, 42, 5789234.0, 87, 4]), - np.r_[2, 42, 5789234, 87, 4]) - np.testing.assert_array_equal(_safe_int_cast(np.r_[[[3, 4, 1.000000001], - [7, 2, -8.999999999], - [6, 9, -4234918347.]]]), - np.r_[[[3, 4, 1], - [7, 2, -9], - [6, 9, -4234918347]]]) - - -if __name__ == '__main__': - np.testing.run_module_suite() From a9dcdc37131ee8e1a3b71e3fd77af3e3b5458e43 Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Thu, 8 May 2014 19:28:29 +0200 Subject: [PATCH 5/6] Use safe_as_int to check provided output shape --- skimage/_shared/{safe_as_int.py => _safe_as_int.py} | 2 +- skimage/_shared/utils.py | 4 +++- skimage/transform/_geometric.py | 4 ++-- skimage/transform/tests/test_warps.py | 6 +++++- 4 files changed, 11 insertions(+), 5 deletions(-) rename skimage/_shared/{safe_as_int.py => _safe_as_int.py} (98%) diff --git a/skimage/_shared/safe_as_int.py b/skimage/_shared/_safe_as_int.py similarity index 98% rename from skimage/_shared/safe_as_int.py rename to skimage/_shared/_safe_as_int.py index 0d665f9f..200d6efb 100644 --- a/skimage/_shared/safe_as_int.py +++ b/skimage/_shared/_safe_as_int.py @@ -3,7 +3,7 @@ import numpy as np __all__ = ['_safe_as_int'] -def _safe_as_int(val, atol=1e-7): +def safe_as_int(val, atol=1e-3): """ Attempt to safely cast values to integer format. diff --git a/skimage/_shared/utils.py b/skimage/_shared/utils.py index 9148e7ff..f94edfc5 100644 --- a/skimage/_shared/utils.py +++ b/skimage/_shared/utils.py @@ -5,8 +5,10 @@ import sys import six from ._warnings import all_warnings +from ._safe_as_int import safe_as_int -__all__ = ['deprecated', 'get_bound_method_class', 'all_warnings'] +__all__ = ['deprecated', 'get_bound_method_class', 'all_warnings', + 'safe_as_int'] class skimage_deprecation(Warning): diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index 53074c00..6eb0f70a 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -4,7 +4,7 @@ import warnings import numpy as np from scipy import ndimage, spatial -from skimage._shared.utils import get_bound_method_class +from skimage._shared.utils import get_bound_method_class, safe_as_int from skimage.util import img_as_float from ._warps_cy import _warp_fast @@ -1078,7 +1078,7 @@ def warp(image, inverse_map=None, map_args={}, output_shape=None, order=1, if output_shape is None: output_shape = ishape else: - output_shape = np.array(output_shape, dtype=int) + output_shape = safe_as_int(output_shape) out = None diff --git a/skimage/transform/tests/test_warps.py b/skimage/transform/tests/test_warps.py index f85125d0..07054ab7 100644 --- a/skimage/transform/tests/test_warps.py +++ b/skimage/transform/tests/test_warps.py @@ -250,7 +250,11 @@ def test_inverse(): def test_slow_warp_nonint_oshape(): image = np.random.random((5, 5)) - warp(image, lambda xy: xy, output_shape=(13.1, 19.5)) + + assert_raises(ValueError, warp, image, lambda xy: xy, + output_shape=(13.1, 19.5)) + + warp(image, lambda xy: xy, output_shape=(13.0001, 19.9999)) if __name__ == "__main__": From e9c0cde8d46b0b0ff30aea175af70ea1e4cd1caf Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Thu, 8 May 2014 20:11:17 +0200 Subject: [PATCH 6/6] Move safe_as_int into utils --- skimage/_shared/_safe_as_int.py | 70 ----------------------- skimage/_shared/tests/test_safe_as_int.py | 32 +++++------ skimage/_shared/utils.py | 69 +++++++++++++++++++++- 3 files changed, 84 insertions(+), 87 deletions(-) delete mode 100644 skimage/_shared/_safe_as_int.py diff --git a/skimage/_shared/_safe_as_int.py b/skimage/_shared/_safe_as_int.py deleted file mode 100644 index 200d6efb..00000000 --- a/skimage/_shared/_safe_as_int.py +++ /dev/null @@ -1,70 +0,0 @@ -import numpy as np - -__all__ = ['_safe_as_int'] - - -def safe_as_int(val, atol=1e-3): - """ - Attempt to safely cast values to integer format. - - Parameters - ---------- - val : scalar or iterable of scalars - Number or container of numbers which are intended to be interpreted as - integers, e.g., for indexing purposes, but which may not carry integer - type. - atol : float - Absolute tolerance away from nearest integer to consider values in - ``val`` functionally integers. - - Returns - ------- - val_int : NumPy scalar or ndarray of dtype `np.int64` - Returns the input value(s) coerced to dtype `np.int64` assuming all - were within ``atol`` of the nearest integer. - - Notes - ----- - This operation calculates ``val`` modulo 1, which returns the mantissa of - all values. Then all mantissas greater than 0.5 are subtracted from one. - Finally, the absolute tolerance from zero is calculated. If it is less - than ``atol`` for all value(s) in ``val``, they are rounded and returned - in an integer array. Or, if ``val`` was a scalar, a NumPy scalar type is - returned. - - If any value(s) are outside the specified tolerance, an informative error - is raised. - - Examples - -------- - >>> _safe_as_int(7.0) - 7 - - >>> _safe_as_int([9, 4, 2.9999999999]) - array([9, 4, 3], dtype=int32) - - >>> _safe_as_int(53.01) - Traceback (most recent call last): - ... - ValueError: Integer argument required but received 53.1, check inputs. - - >>> _safe_as_int(53.01, atol=0.01) - 53 - - """ - mod = np.asarray(val) % 1 # Extract mantissa - - # Check for and subtract any mod values > 0.5 from 1 - if mod.ndim == 0: # Scalar input, cannot be indexed - if mod > 0.5: - mod = 1 - mod - else: # Iterable input, now ndarray - mod[mod > 0.5] = 1 - mod[mod > 0.5] # Test on each side of nearest int - - try: - np.testing.assert_allclose(mod, 0, atol=atol) - except AssertionError: - raise ValueError("Integer argument required but received " - "{0}, check inputs.".format(val)) - - return np.round(val).astype(np.int64) diff --git a/skimage/_shared/tests/test_safe_as_int.py b/skimage/_shared/tests/test_safe_as_int.py index 1a3674e0..009fa9a4 100644 --- a/skimage/_shared/tests/test_safe_as_int.py +++ b/skimage/_shared/tests/test_safe_as_int.py @@ -1,30 +1,30 @@ import numpy as np -from skimage._shared.safe_int_cast import _safe_as_int +from skimage._shared.utils import safe_as_int def test_int_cast_not_possible(): - np.testing.assert_raises(ValueError, _safe_as_int, 7.1) - np.testing.assert_raises(ValueError, _safe_as_int, [7.1, 0.9]) - np.testing.assert_raises(ValueError, _safe_as_int, np.r_[7.1, 0.9]) - np.testing.assert_raises(ValueError, _safe_as_int, (7.1, 0.9)) - np.testing.assert_raises(ValueError, _safe_as_int, ((3, 4, 1), + np.testing.assert_raises(ValueError, safe_as_int, 7.1) + np.testing.assert_raises(ValueError, safe_as_int, [7.1, 0.9]) + np.testing.assert_raises(ValueError, safe_as_int, np.r_[7.1, 0.9]) + np.testing.assert_raises(ValueError, safe_as_int, (7.1, 0.9)) + np.testing.assert_raises(ValueError, safe_as_int, ((3, 4, 1), (2, 7.6, 289))) - np.testing.assert_raises(ValueError, _safe_as_int, 7.1, 0.09) - np.testing.assert_raises(ValueError, _safe_as_int, [7.1, 0.9], 0.09) - np.testing.assert_raises(ValueError, _safe_as_int, np.r_[7.1, 0.9], 0.09) - np.testing.assert_raises(ValueError, _safe_as_int, (7.1, 0.9), 0.09) - np.testing.assert_raises(ValueError, _safe_as_int, ((3, 4, 1), + np.testing.assert_raises(ValueError, safe_as_int, 7.1, 0.09) + np.testing.assert_raises(ValueError, safe_as_int, [7.1, 0.9], 0.09) + np.testing.assert_raises(ValueError, safe_as_int, np.r_[7.1, 0.9], 0.09) + np.testing.assert_raises(ValueError, safe_as_int, (7.1, 0.9), 0.09) + np.testing.assert_raises(ValueError, safe_as_int, ((3, 4, 1), (2, 7.6, 289)), 0.25) def test_int_cast_possible(): - np.testing.assert_equal(_safe_as_int(7.1, atol=0.11), 7) - np.testing.assert_equal(_safe_as_int(-7.1, atol=0.11), -7) - np.testing.assert_equal(_safe_as_int(41.9, atol=0.11), 42) - np.testing.assert_array_equal(_safe_as_int([2, 42, 5789234.0, 87, 4]), + np.testing.assert_equal(safe_as_int(7.1, atol=0.11), 7) + np.testing.assert_equal(safe_as_int(-7.1, atol=0.11), -7) + np.testing.assert_equal(safe_as_int(41.9, atol=0.11), 42) + np.testing.assert_array_equal(safe_as_int([2, 42, 5789234.0, 87, 4]), np.r_[2, 42, 5789234, 87, 4]) - np.testing.assert_array_equal(_safe_as_int(np.r_[[[3, 4, 1.000000001], + np.testing.assert_array_equal(safe_as_int(np.r_[[[3, 4, 1.000000001], [7, 2, -8.999999999], [6, 9, -4234918347.]]]), np.r_[[[3, 4, 1], diff --git a/skimage/_shared/utils.py b/skimage/_shared/utils.py index f94edfc5..612a2b63 100644 --- a/skimage/_shared/utils.py +++ b/skimage/_shared/utils.py @@ -1,11 +1,11 @@ import warnings import functools import sys +import numpy as np import six from ._warnings import all_warnings -from ._safe_as_int import safe_as_int __all__ = ['deprecated', 'get_bound_method_class', 'all_warnings', 'safe_as_int'] @@ -74,3 +74,70 @@ def get_bound_method_class(m): """ return m.im_class if sys.version < '3' else m.__self__.__class__ + + +def safe_as_int(val, atol=1e-3): + """ + Attempt to safely cast values to integer format. + + Parameters + ---------- + val : scalar or iterable of scalars + Number or container of numbers which are intended to be interpreted as + integers, e.g., for indexing purposes, but which may not carry integer + type. + atol : float + Absolute tolerance away from nearest integer to consider values in + ``val`` functionally integers. + + Returns + ------- + val_int : NumPy scalar or ndarray of dtype `np.int64` + Returns the input value(s) coerced to dtype `np.int64` assuming all + were within ``atol`` of the nearest integer. + + Notes + ----- + This operation calculates ``val`` modulo 1, which returns the mantissa of + all values. Then all mantissas greater than 0.5 are subtracted from one. + Finally, the absolute tolerance from zero is calculated. If it is less + than ``atol`` for all value(s) in ``val``, they are rounded and returned + in an integer array. Or, if ``val`` was a scalar, a NumPy scalar type is + returned. + + If any value(s) are outside the specified tolerance, an informative error + is raised. + + Examples + -------- + >>> _safe_as_int(7.0) + 7 + + >>> _safe_as_int([9, 4, 2.9999999999]) + array([9, 4, 3], dtype=int32) + + >>> _safe_as_int(53.01) + Traceback (most recent call last): + ... + ValueError: Integer argument required but received 53.1, check inputs. + + >>> _safe_as_int(53.01, atol=0.01) + 53 + + """ + mod = np.asarray(val) % 1 # Extract mantissa + + # Check for and subtract any mod values > 0.5 from 1 + if mod.ndim == 0: # Scalar input, cannot be indexed + if mod > 0.5: + mod = 1 - mod + else: # Iterable input, now ndarray + mod[mod > 0.5] = 1 - mod[mod > 0.5] # Test on each side of nearest int + + try: + np.testing.assert_allclose(mod, 0, atol=atol) + except AssertionError: + raise ValueError("Integer argument required but received " + "{0}, check inputs.".format(val)) + + return np.round(val).astype(np.int64)