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

Add concrete usage examples for preserve_range

Browse Source
This commit is contained in:
Juan Nunez-Iglesias
2015-02-04 09:47:28 +11:00
parent d0a9523297
commit d638e042eb
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/user_guide/data_types.txt
+3 -1
View File
@@ -78,7 +78,9 @@ Additionally, some functions take a ``preserve_range`` argument where a range
conversion is convenient but not necessary. For example, interpolation in
``transform.warp`` requires an image of type float, which should have a range
in [0, 1]. So, by default, input images will be rescaled to this range.
However, with ``preserve_range=True``, the original range of the data will be
However, in some cases, the image values represent physical measurements, such
as temperature or rainfall values, that the user does not want rescaled.
With ``preserve_range=True``, the original range of the data will be
preserved, even though the output is a float image. Users must then ensure
this non-standard image is properly processed by downstream functions, which
may expect an image in [0, 1].