Merge pull request #606 from keflavich/sigma_clip_name

minor: change sigma_clip to sigma_clip_spectrally
radio-astro-tools · Mar 3, 2020 · 698161e · 698161e
2 parents bc4bee5 + fe8f1e3
commit 698161e
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/spectral_cube/spectral_cube.py b/spectral_cube/spectral_cube.py
@@ -2886,10 +2886,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
         ----------