Update spectral_cube/dask_spectral_cube.py

Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/dask_spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/dask_spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/dask_spectral_cube.py Co-authored-by: Eric Koch <[email protected]> Update spectral_cube/dask_spectral_cube.py Co-authored-by: Eric Koch <[email protected]>
radio-astro-tools · Jul 22, 2022 · fdbfcd6 · fdbfcd6
1 parent 422b035
commit fdbfcd6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/spectral_cube/dask_spectral_cube.py b/spectral_cube/dask_spectral_cube.py
@@ -911,14 +911,14 @@ def spectral_smooth_median(self, ksize, raise_error_jybm=True,
     def spectral_filter(self, ksize, filter, raise_error_jybm=True,
                         **kwargs):
         """
-        Smooth the cube along the spectral dimension using a filter
+        Smooth the cube along the spectral dimension using a scipy.ndimage filter.
 
         Parameters
         ----------
         ksize : int
-            Size of the median filter (scipy.ndimage.filters.median_filter)
+            Size of the median filter in spectral channels (scipy.ndimage.filters.median_filter).
         filter : function
-            A filter from scipy.ndimage.filters
+            A filter from `scipy.ndimage.filters <https://docs.scipy.org/doc/scipy/reference/ndimage.html#filters>`_.
         save_to_tmp_dir : bool
             If `True`, the computation will be carried out straight away and
             saved to a temporary directory. This can improve performance,
@@ -984,9 +984,9 @@ def spatial_filter(self, ksize, filter, raise_error_jybm=True, **kwargs):
         Parameters
         ----------
         ksize : int
-            Size of the median filter (scipy.ndimage.filters.median_filter)
+            Size of the filter in pixels.
         filter : function
-            A filter from scipy.ndimage.filters
+            A filter from `scipy.ndimage.filters <https://docs.scipy.org/doc/scipy/reference/ndimage.html#filters>`_.
         raise_error_jybm : bool, optional
             Raises a `~spectral_cube.utils.BeamUnitsError` when smoothing a cube in Jy/beam units,
             since the brightness is dependent on the spatial resolution.

diff --git a/spectral_cube/spectral_cube.py b/spectral_cube/spectral_cube.py
@@ -2716,9 +2716,9 @@ def spatial_smooth_median(self, ksize, update_function=None, raise_error_jybm=Tr
         Parameters
         ----------
         ksize : int
-            Size of the median filter (scipy.ndimage.filters.*_filter)
+            Size of the median filter in pixels (scipy.ndimage.filters.median_filter)
         filter : function
-            A filter from scipy.ndimage.filters
+            A filter from scipy.ndimage.filters. The default is the median filter.
         update_function : method
             Method that is called to update an external progressbar
             If provided, it disables the default `astropy.utils.console.ProgressBar`
@@ -2736,14 +2736,14 @@ def spatial_smooth_median(self, ksize, update_function=None, raise_error_jybm=Tr
     @parallel_docstring
     def spatial_filter(self, ksize, filter, update_function=None, raise_error_jybm=True, **kwargs):
         """
-        Smooth the image in each spatial-spatial plane of the cube using a filter.
+        Smooth the image in each spatial-spatial plane of the cube using a scipy.ndimage filter.
 
         Parameters
         ----------
         ksize : int
-            Size of the median filter (scipy.ndimage.filters.*_filter)
+            Size of the filter in pixels (scipy.ndimage.filters.*_filter).
         filter : function
-            A filter from scipy.ndimage.filters
+            A filter from `scipy.ndimage.filters <https://docs.scipy.org/doc/scipy/reference/ndimage.html#filters>`_.
         update_function : method
             Method that is called to update an external progressbar
             If provided, it disables the default `astropy.utils.console.ProgressBar`
@@ -2806,7 +2806,7 @@ def _gsmooth_image(img, **kwargs):
     def spectral_filter(self, ksize, filter, use_memmap=True, verbose=0,
             num_cores=None, **kwargs):
         """
-        Smooth the cube along the spectral dimension using a filter
+        Smooth the cube along the spectral dimension using a scipy.ndimage filter.
 
         Parameters
         ----------