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

color.colorconv: Fix documentation of rgb2gray()

Browse Source 
The working of rgb2gray() has been modified, and it now works
with both 3D and 4D arrays and appropriately finds the luminance
image of the given image. The documnetation does not mention the
4D array support and this commit modifies the documentation to
mention this.
This commit is contained in:
AbdealiJK
2016-06-23 09:25:51 +05:30
parent 9bc03189f8
commit 860eb399ef
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/color/colorconv.py
+7 -5
View File
@@ -694,19 +694,21 @@ def rgb2gray(rgb):
Parameters
----------
rgb : array_like
The image in RGB format, in a 3-D array of shape ``(.., .., 3)``,
or in RGBA format with shape ``(.., .., 4)``.
The image in RGB format, in a 3-D or 4-D array of shape
``(.., ..,[ ..,] 3)``, or in RGBA format with shape
``(.., ..,[ ..,] 4)``.
Returns
-------
out : ndarray
The luminance image, a 2-D array.
The luminance image - an array which is the same size as the input
array, but with the channel dimension removed.
Raises
------
ValueError
If `rgb2gray` is not a 3-D array of shape ``(.., .., 3)`` or
``(.., .., 4)``.
If `rgb2gray` is not a 3-D or 4-D arrays of shape
``(.., ..,[ ..,] 3)`` or ``(.., ..,[ ..,] 4)``.
References
----------