Merge pull request #5834 from larrybradley/sigmaclip-docs

Remove references to an image in sigma_clipped_stats docs
astropy · Feb 22, 2017 · 529a5d8 · 529a5d8
2 parents 13d525c + 11c688e
commit 529a5d8
Showing 1 changed file with 8 additions and 11 deletions.
diff --git a/astropy/stats/sigma_clipping.py b/astropy/stats/sigma_clipping.py
@@ -205,10 +205,7 @@ def sigma_clipped_stats(data, mask=None, mask_value=None, sigma=3.0,
                         sigma_lower=None, sigma_upper=None, iters=5,
                         cenfunc=np.ma.median, stdfunc=np.std, axis=None):
     """
-    Calculate sigma-clipped statistics from data.
-
-    For example, sigma-clipped statistics can be used to estimate the
-    background and background noise in an image.
+    Calculate sigma-clipped statistics on the provided data.
 
     Parameters
     ----------
@@ -218,12 +215,12 @@ def sigma_clipped_stats(data, mask=None, mask_value=None, sigma=3.0,
     mask : `numpy.ndarray` (bool), optional
         A boolean mask with the same shape as ``data``, where a `True`
         value indicates the corresponding element of ``data`` is masked.
-        Masked pixels are excluded when computing the image statistics.
+        Masked pixels are excluded when computing the statistics.
 
     mask_value : float, optional
-        An image data value (e.g., ``0.0``) that is ignored when
-        computing the image statistics.  ``mask_value`` will be masked
-        in addition to any input ``mask``.
+        A data value (e.g., ``0.0``) that is ignored when computing the
+        statistics.  ``mask_value`` will be masked in addition to any
+        input ``mask``.
 
     sigma : float, optional
         The number of standard deviations to use as the lower and upper
@@ -243,8 +240,8 @@ def sigma_clipped_stats(data, mask=None, mask_value=None, sigma=3.0,
     iters : int, optional
         The number of iterations to perform sigma clipping, or `None` to
         clip until convergence is achieved (i.e., continue until the
-        last iteration clips nothing) when calculating the image
-        statistics. Defaults to 5.
+        last iteration clips nothing) when calculating the statistics.
+        Defaults to 5.
 
     cenfunc : callable, optional
         The function used to compute the center for the clipping. Must
@@ -277,7 +274,7 @@ def sigma_clipped_stats(data, mask=None, mask_value=None, sigma=3.0,
     -------
     mean, median, stddev : float
         The mean, median, and standard deviation of the sigma-clipped
-        image.
+        data.
     """
 
     if mask is not None: