DOC: corrected mssim docstring to return float

This commit is contained in:
Kyle Jackson
2016-07-23 19:24:07 -04:00
parent 946b5c82d6
commit 08019c36e5
+1 -1
View File
@@ -54,7 +54,7 @@ def compare_ssim(X, Y, win_size=None, gradient=False,
Returns
-------
mssim : float or ndarray
mssim : float
The mean structural similarity over the image.
grad : ndarray
The gradient of the structural similarity index between X and Y [2]_.