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

Clarify docstrings

Browse Source
This commit is contained in:
Tony S Yu
2014-06-16 23:17:31 -05:00
parent ec9198c58e
commit 8e539cc12a
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/exposure/exposure.py
+11 -6
View File
@@ -151,9 +151,13 @@ def intensity_range(image, range_values='image', zero_min=False):
'dtype'
Return min/max of the image's dtype as the range.
dtype-name
Valid key in `DTYPE_RANGE`.
Return intensity range based on desired `dtype`. Must be valid key
in `DTYPE_RANGE`. Note: `image` is ignored for this range type.
2-tuple
Explicit values for the min/max intensities.
Return `range_values` as min/max intensities. Note that there's no
reason to use this function if you just want to specify the
intensity range explicitly. This option is included for functions
that use `intensity_range` to support all desired range types.
zero_min : bool
If True, the image dtype's min is truncated to 0. Note that this only
@@ -195,13 +199,14 @@ def rescale_intensity(image, in_range='image', out_range='dtype'):
Min and max intensity values of input and output image.
'image'
Return image min/max as the range.
Use image min/max as the intensity range.
'dtype'
Return min/max of the image's dtype as the range.
Use min/max of the image's dtype as the intensity range.
dtype-name
Valid key in `DTYPE_RANGE`.
Use intensity range based on desired `dtype`. Must be valid key
in `DTYPE_RANGE`.
2-tuple
Explicit values for the min/max intensities.
Use `range_values` as explicit min/max intensities.
Returns
-------