Skip to content

Make img_as_float act as ensure_img_is_float of any precision #3062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hmaarrfk wants to merge 2 commits into from
Closed

Make img_as_float act as ensure_img_is_float of any precision #3062

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc9058d
img_as_float does not force conversion to 64bit
hmaarrfk May 7, 2018
981a899
Fix: actually return the converted image
hmaarrfk May 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion skimage/util/dtype.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,36 @@ def img_as_float64(image, force_copy=False):
return convert(image, np.float64, force_copy)


img_as_float = img_as_float64
def img_as_float(image, force_copy=False, default_dtype=np.float64):
"""Ensure that an image is of floating point type.

First checks if the image is a floating point (any precision). If not
it will convert it to the desired precision (by default, 64-bit).

Parameters
----------
image : ndarray
Input image.
force_copy : bool, optional
Force a copy of the data, irrespective of its current dtype.
default_dtype: np.dtype
Desired for the image if it is not already a float.

Returns
-------
out : ndarray of desired precision
Output image.
"""
if np.dtype(default_dtype).kind != 'f':
raise ValueError('Provided default_dtype should be a float.')

if image.dtype.kind == 'f':
if force_copy:
return image.copy()
else:
return image
else:
return convert(image, dtype=default_dtype, force_copy=force_copy)


def img_as_uint(image, force_copy=False):
Expand Down