From 85670d60b6730266d1998442c0b24c131f19ea4f Mon Sep 17 00:00:00 2001 From: cgohlke Date: Tue, 22 May 2012 12:13:51 -0700 Subject: [PATCH] Update docstring --- skimage/util/dtype.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/skimage/util/dtype.py b/skimage/util/dtype.py index 372eb683..93e9035a 100644 --- a/skimage/util/dtype.py +++ b/skimage/util/dtype.py @@ -28,16 +28,16 @@ def convert(image, dtype, force_copy=False, uniform=False): """ Convert an image to the requested data-type. - Warnings are issued in case of precision loss, or when - negative values have to be scaled into the positive domain. + Warnings are issued in case of precision loss, or when negative values + are clipped during conversion to unsigned integer types (sign loss). Floating point values are expected to be normalized. They will be clipped to the range [0.0, 1.0] or [-1.0, 1.0] when converting to unsigned or signed integers respectively. Numbers are not shifted to the negative side when converting from - unsigned to signed integer types. Negative values will be clipped from - signed integers when converting to unsigned integers. + unsigned to signed integer types. Negative values will be clipped when + converting to unsigned integers. Parameters ----------