Deprecate the MexicanHat kernels, too

bsipocz · bsipocz · commit 110d5710dc22 · 2019-10-26T12:24:52.000-07:00
diff --git a/astropy/convolution/kernels.py b/astropy/convolution/kernels.py
@@ -8,10 +8,11 @@
 from .utils import has_even_axis, raise_even_kernel_exception
 from astropy.modeling import models
 from astropy.modeling.core import Fittable1DModel, Fittable2DModel
+from astropy.utils.decorators import deprecated
 
 __all__ = ['Gaussian1DKernel', 'Gaussian2DKernel', 'CustomKernel',
            'Box1DKernel', 'Box2DKernel', 'Tophat2DKernel',
-           'Trapezoid1DKernel', 'MexicanHat1DKernel', 'MexicanHat2DKernel',
+           'Trapezoid1DKernel', 'RickerWavelet1DKernel', 'RickerWavelet2DKernel',
            'AiryDisk2DKernel', 'Moffat2DKernel', 'Model1DKernel',
            'Model2DKernel', 'TrapezoidDisk2DKernel', 'Ring2DKernel']
 
@@ -58,7 +59,7 @@ class Gaussian1DKernel(Kernel1D):
 
     See Also
     --------
-    Box1DKernel, Trapezoid1DKernel, MexicanHat1DKernel
+    Box1DKernel, Trapezoid1DKernel, RickerWavelet1DKernel
 
 
     Examples
@@ -127,7 +128,7 @@ class Gaussian2DKernel(Kernel2D):
 
     See Also
     --------
-    Box2DKernel, Tophat2DKernel, MexicanHat2DKernel, Ring2DKernel,
+    Box2DKernel, Tophat2DKernel, RickerWavelet2DKernel, Ring2DKernel,
     TrapezoidDisk2DKernel, AiryDisk2DKernel, Moffat2DKernel
 
     Examples
@@ -198,7 +199,7 @@ class Box1DKernel(Kernel1D):
 
     See Also
     --------
-    Gaussian1DKernel, Trapezoid1DKernel, MexicanHat1DKernel
+    Gaussian1DKernel, Trapezoid1DKernel, RickerWavelet1DKernel
 
 
     Examples
@@ -266,7 +267,7 @@ class Box2DKernel(Kernel2D):
 
     See Also
     --------
-    Gaussian2DKernel, Tophat2DKernel, MexicanHat2DKernel, Ring2DKernel,
+    Gaussian2DKernel, Tophat2DKernel, RickerWavelet2DKernel, Ring2DKernel,
     TrapezoidDisk2DKernel, AiryDisk2DKernel, Moffat2DKernel
 
     Examples
@@ -331,7 +332,7 @@ class Tophat2DKernel(Kernel2D):
 
     See Also
     --------
-    Gaussian2DKernel, Box2DKernel, MexicanHat2DKernel, Ring2DKernel,
+    Gaussian2DKernel, Box2DKernel, RickerWavelet2DKernel, Ring2DKernel,
     TrapezoidDisk2DKernel, AiryDisk2DKernel, Moffat2DKernel
 
     Examples
@@ -390,7 +391,7 @@ class Ring2DKernel(Kernel2D):
 
     See Also
     --------
-    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, MexicanHat2DKernel,
+    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, RickerWavelet2DKernel,
     Ring2DKernel, AiryDisk2DKernel, Moffat2DKernel
 
     Examples
@@ -448,7 +449,7 @@ class Trapezoid1DKernel(Kernel1D):
 
     See Also
     --------
-    Box1DKernel, Gaussian1DKernel, MexicanHat1DKernel
+    Box1DKernel, Gaussian1DKernel, RickerWavelet1DKernel
 
     Examples
     --------
@@ -506,7 +507,7 @@ class TrapezoidDisk2DKernel(Kernel2D):
 
     See Also
     --------
-    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, MexicanHat2DKernel,
+    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, RickerWavelet2DKernel,
     Ring2DKernel, AiryDisk2DKernel, Moffat2DKernel
 
     Examples
@@ -536,7 +537,7 @@ def __init__(self, radius, slope=1., **kwargs):
         self.normalize()
 
 
-class MexicanHat1DKernel(Kernel1D):
+class RickerWavelet1DKernel(Kernel1D):
     """
     1D Mexican hat filter kernel.
 
@@ -588,8 +589,8 @@ class MexicanHat1DKernel(Kernel1D):
         :include-source:
 
         import matplotlib.pyplot as plt
-        from astropy.convolution import MexicanHat1DKernel
-        mexicanhat_1D_kernel = MexicanHat1DKernel(10)
+        from astropy.convolution import RickerWavelet1DKernel
+        mexicanhat_1D_kernel = RickerWavelet1DKernel(10)
         plt.plot(mexicanhat_1D_kernel, drawstyle='steps')
         plt.xlabel('x [pixels]')
         plt.ylabel('value')
@@ -606,7 +607,7 @@ def __init__(self, width, **kwargs):
         self._truncation = np.abs(self._array.sum() / self._array.size)
 
 
-class MexicanHat2DKernel(Kernel2D):
+class RickerWavelet2DKernel(Kernel2D):
     """
     2D Mexican hat filter kernel.
 
@@ -661,8 +662,8 @@ class MexicanHat2DKernel(Kernel2D):
         :include-source:
 
         import matplotlib.pyplot as plt
-        from astropy.convolution import MexicanHat2DKernel
-        mexicanhat_2D_kernel = MexicanHat2DKernel(10)
+        from astropy.convolution import RickerWavelet2DKernel
+        mexicanhat_2D_kernel = RickerWavelet2DKernel(10)
         plt.imshow(mexicanhat_2D_kernel, interpolation='none', origin='lower')
         plt.xlabel('x [pixels]')
         plt.ylabel('y [pixels]')
@@ -713,7 +714,7 @@ class AiryDisk2DKernel(Kernel2D):
 
     See Also
     --------
-    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, MexicanHat2DKernel,
+    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, RickerWavelet2DKernel,
     Ring2DKernel, TrapezoidDisk2DKernel, AiryDisk2DKernel, Moffat2DKernel
 
     Examples
@@ -777,7 +778,7 @@ class Moffat2DKernel(Kernel2D):
 
     See Also
     --------
-    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, MexicanHat2DKernel,
+    Gaussian2DKernel, Box2DKernel, Tophat2DKernel, RickerWavelet2DKernel,
     Ring2DKernel, TrapezoidDisk2DKernel, AiryDisk2DKernel
 
     Examples
@@ -1022,3 +1023,13 @@ def array(self, array):
         self._is_bool = bool(np.all(np.logical_or(ones, zeros)))
 
         self._truncation = 0.0
+
+
+@deprecated('4.0', alternative='RickerWavelet1DKernel')
+class MexicanHat1DKernel(RickerWavelet1DKernel):
+    pass
+
+
+@deprecated('4.0', alternative='RickerWavelet2DKernel')
+class MexicanHat2DKernel(RickerWavelet2DKernel):
+    pass
diff --git a/astropy/convolution/tests/test_kernel_class.py b/astropy/convolution/tests/test_kernel_class.py
@@ -9,8 +9,8 @@
 from astropy.convolution.convolve import convolve, convolve_fft
 from astropy.convolution.kernels import (
     Gaussian1DKernel, Gaussian2DKernel, Box1DKernel, Box2DKernel,
-    Trapezoid1DKernel, TrapezoidDisk2DKernel, MexicanHat1DKernel,
-    Tophat2DKernel, MexicanHat2DKernel, AiryDisk2DKernel, Ring2DKernel,
+    Trapezoid1DKernel, TrapezoidDisk2DKernel, RickerWavelet1DKernel,
+    Tophat2DKernel, RickerWavelet2DKernel, AiryDisk2DKernel, Ring2DKernel,
     CustomKernel, Model1DKernel, Model2DKernel, Kernel1D, Kernel2D)
 
 from astropy.convolution.utils import KernelSizeError
@@ -29,7 +29,7 @@
 KERNEL_TYPES = [Gaussian1DKernel, Gaussian2DKernel,
                 Box1DKernel, Box2DKernel,
                 Trapezoid1DKernel, TrapezoidDisk2DKernel,
-                MexicanHat1DKernel, Tophat2DKernel, AiryDisk2DKernel,
+                RickerWavelet1DKernel, Tophat2DKernel, AiryDisk2DKernel,
                 Ring2DKernel]
 
 
@@ -76,10 +76,10 @@ def test_scipy_filter_gaussian(self, width):
     @pytest.mark.parametrize(('width'), WIDTHS_ODD)
     def test_scipy_filter_gaussian_laplace(self, width):
         """
-        Test MexicanHat kernels against SciPy ndimage gaussian laplace filters.
+        Test RickerWavelet kernels against SciPy ndimage gaussian laplace filters.
         """
-        mexican_kernel_1D = MexicanHat1DKernel(width)
-        mexican_kernel_2D = MexicanHat2DKernel(width)
+        mexican_kernel_1D = RickerWavelet1DKernel(width)
+        mexican_kernel_2D = RickerWavelet2DKernel(width)
 
         astropy_1D = convolve(delta_pulse_1D, mexican_kernel_1D, boundary='fill', normalize_kernel=False)
         astropy_2D = convolve(delta_pulse_2D, mexican_kernel_2D, boundary='fill', normalize_kernel=False)
diff --git a/docs/convolution/kernels.rst b/docs/convolution/kernels.rst
@@ -156,13 +156,13 @@ scale compared to the original image.
     data_2D = gauss(x, y) + 0.1 * (np.random.rand(201, 201) - 0.5)
 
     # Setup kernels, including unity kernel for original image
-    # Choose normalization for linear scale space for MexicanHat
+    # Choose normalization for linear scale space for RickerWavelet
 
     kernels = [TrapezoidDisk2DKernel(11, slope=0.2),
                Tophat2DKernel(11),
                Gaussian2DKernel(11),
                Box2DKernel(11),
-               11 ** 2 * MexicanHat2DKernel(11),
+               11 ** 2 * RickerWavelet2DKernel(11),
                AiryDisk2DKernel(11)]
 
     fig, axes = plt.subplots(nrows=2, ncols=3)
@@ -203,8 +203,8 @@ Available Kernels
    CustomKernel
    Gaussian1DKernel
    Gaussian2DKernel
-   MexicanHat1DKernel
-   MexicanHat2DKernel
+   RickerWavelet1DKernel
+   RickerWavelet2DKernel
    Model1DKernel
    Model2DKernel
    Ring2DKernel
@@ -342,7 +342,7 @@ The kernel arrays can be renormalized explicitly by calling either the
 method leaves the kernel itself unchanged but works with an internal normalized
 version of the kernel.
 
-Note that for :class:`~astropy.convolution.MexicanHat1DKernel`
-and :class:`~astropy.convolution.MexicanHat2DKernel` there is
+Note that for :class:`~astropy.convolution.RickerWavelet1DKernel`
+and :class:`~astropy.convolution.RickerWavelet2DKernel` there is
 :math:`\int_{-\infty}^{\infty} f(x) dx = 0`. To define a proper normalization,
 both filters are derived from a normalized Gaussian function.
