wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-06-27 19:32:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2169 from AbdealiJK/ajk/docs

Browse Source 
color.colorconv: Fix documentation of rgb2gray()
This commit is contained in:
Juan Nunez-Iglesias
2016-06-23 11:08:54 -04:00
committed by GitHub
parent 9bc03189f8 860eb399ef
commit 6523227ece
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
----------