Merge fe8f1e3 into 31b0b51

radio-astro-tools · Feb 8, 2020 · ad6d689 · ad6d689
2 parents 31b0b51 + fe8f1e3
commit ad6d689
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/spectral_cube/spectral_cube.py b/spectral_cube/spectral_cube.py
@@ -2881,10 +2881,11 @@ def apply_function_parallel_spectral(self,
                                                  )
 
     @parallel_docstring
-    def sigma_clip(self, threshold, verbose=0, use_memmap=True,
-                   num_cores=None, **kwargs):
+    def sigma_clip_spectrally(self, threshold, verbose=0, use_memmap=True,
+                              num_cores=None, **kwargs):
         """
-        Run astropy's sigma clipper, converting all bad values to NaN.
+        Run astropy's sigma clipper along the spectral axis, converting all bad
+        (excluded) values to NaN.
 
         Parameters
         ----------