MNT: deprecate axes versions of mlab functions

jklymak · jklymak · commit c7cbfaac625b · 2022-06-07T14:14:05.000+02:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -7006,6 +7006,7 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
 
         return h, xedges, yedges, pc
 
+    @_api.deprecated("3.6", alternative="scipy.signal.psd and ax.loglog")
     @_preprocess_data(replace_names=["x"])
     @_docstring.dedent_interpd
     def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
@@ -7117,6 +7118,7 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
         else:
             return pxx, freqs, line
 
+    @_api.deprecated("3.6", alternative="scipy.signal.csd and ax.plot")
     @_preprocess_data(replace_names=["x", "y"], label_namer="y")
     @_docstring.dedent_interpd
     def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
@@ -7219,6 +7221,8 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
         else:
             return pxy, freqs, line
 
+    @_api.deprecated("3.6", alternative="scipy.signal.spectrogram(mode='magnitude')"
+                                        "and ax.loglog")
     @_preprocess_data(replace_names=["x"])
     @_docstring.dedent_interpd
     def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
@@ -7305,6 +7309,9 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
 
         return spec, freqs, line
 
+    @_api.deprecated("3.6",
+                     alternative="scipy.signal.spectrogram(mode='angle') and "
+                                 "ax.loglog")
     @_preprocess_data(replace_names=["x"])
     @_docstring.dedent_interpd
     def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
@@ -7374,6 +7381,9 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
 
         return spec, freqs, lines[0]
 
+    @_api.deprecated("3.6",
+                     alternative="scipy.signal.spectrogram(mode='phase') and "
+                                 "ax.loglog")
     @_preprocess_data(replace_names=["x"])
     @_docstring.dedent_interpd
     def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
@@ -7443,6 +7453,8 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
 
         return spec, freqs, lines[0]
 
+    @_api.deprecated("3.6", alternative="scipy.signal.coherence and "
+                                        "ax.semilogx")
     @_preprocess_data(replace_names=["x", "y"])
     @_docstring.dedent_interpd
     def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
@@ -7507,6 +7519,9 @@ def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
 
         return cxy, freqs
 
+    @_api.deprecated("3.6",
+                     alternative="scipy.signal.spectrogram(mode='psd') and "
+                                 "ax.loglog")
     @_preprocess_data(replace_names=["x"])
     @_docstring.dedent_interpd
     def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
