added information regarding new spectrum functions to CHANGELOG, whats_new, and api_changes

toddrjen · toddrjen · commit 4d9cc28e238f · 2013-10-22T22:38:32.000+02:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,19 @@
+2013-10-06 Add stride-based functions to mlab for easy creation of 2D arrays
+           with less memory.
+
+2013-10-06 Improve window and detrend functions in mlab, particulart support for
+           2D arrays.
+
+2013-10-06 Improve performance of all spectrum-related mlab functions and plots.
+
+2013-10-06 Added support for magnitude, phase, and angle spectrums to
+           axes.specgram, and support for magnitude, phase, angle, and complex
+           spectrums to mlab-specgram.
+
+2013-10-06 Added magnitude_spectrum, angle_spectrum, and phase_spectrum plots,
+           as well as magnitude_spectrum, angle_spectrum, phase_spectrum,
+           and complex_spectrum functions to mlab
+
 2013-07-12 Added support for datetime axes to 2d plots. Axis values are passed
            through Axes.convert_xunits/Axes.convert_yunits before being used by
            contour/contourf, pcolormesh and pcolor.
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -76,6 +76,28 @@ original location:
     - `xycoords` -> set the units of the point location
     - `set_position()` -> `Annotation` only set location of annotation
 
+* NFFT being even is now enforced in `matplotlib.mlab.specgram`,
+  `matplotlib.mlab.psd`,  `matplotlib.mlab.csd`,
+  `matplotlib.mlab.cohere`, `matplotlib.mlab.cohere_pairs`,
+  `matplotlib.pyplot.specgram`, `matplotlib.pyplot.psd`,
+  `matplotlib.pyplot.csd`, and `matplotlib.pyplot.cohere`.  This was
+  listed as a requirement but was not actually checked.
+
+* `matplotlib.mlab.specgram`, `matplotlib.mlab.psd`,  `matplotlib.mlab.csd`,
+  `matplotlib.mlab.cohere`, `matplotlib.mlab.cohere_pairs`,
+  `matplotlib.pyplot.specgram`, `matplotlib.pyplot.psd`,
+  `matplotlib.pyplot.csd`, and `matplotlib.pyplot.cohere` now raise
+  ValueError where they previously raised AssertionError.
+
+* For `matplotlib.mlab.psd`,  `matplotlib.mlab.csd`,
+  `matplotlib.mlab.cohere`, `matplotlib.mlab.cohere_pairs`,
+  `matplotlib.pyplot.specgram`, `matplotlib.pyplot.psd`,
+  `matplotlib.pyplot.csd`, and `matplotlib.pyplot.cohere`, in cases
+  where a shape (n, 1) array is returned, this is now converted to a (n, )
+  array.  Previously, (n, m) arrays were averaged to an (n, ) array, but
+  (n, 1) arrays were returend unchanged.  This change makes the dimensions
+  consistent in both cases.
+
 
 .. _changes_in_1_3:
 
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -32,6 +32,36 @@ Andrew Dawson added support for datetime axes to
 :func:`~matplotlib.pyplot.contour`, :func:`~matplotlib.pyplot.contourf`, 
 :func:`~matplotlib.pyplot.pcolormesh` and :func:`~matplotlib.pyplot.pcolor`. 
 
+Support for additional spectrum types
+`````````````````````````````````````
+Todd Jennings added support for new types of frequency spectrum plots:
+:func:`~matplotlib.pyplot.magnitude_spectrum`,
+:func:`~matplotlib.pyplot.phase_spectrum`, and
+:func:`~matplotlib.pyplot.angle_spectrum`, as well as corresponding functions
+in mlab.
+
+He also added these spectrum types to :func:`~matplotlib.pyplot.specgram`,
+as well as adding support for linear scaling there (in addition to the
+existing dB scaling). Support for additional spectrum types was also added to
+:func:`~matplotlib.mlab.specgram`.
+
+He also increased the performance for all of these functions and plot types.
+
+Support for detrending and windowing 2D arrays in mlab
+``````````````````````````````````````````````````````
+Todd Jennings added support for 2D arrays in the 
+:func:`~matplotlib.mlab.detrend_mean`, :func:`~matplotlib.mlab.detrend_none`,
+and :func:`~matplotlib.mlab.detrend`, as well as adding 
+:func:`~matplotlib.mlab.apply_window` which support windowing 2D arrays.
+
+Support for strides in mlab
+```````````````````````````
+Todd Jennings added some functions to mlab to make it easier to use numpy
+strides to create memory-efficient 2D arrays.  This includes
+:func:`~matplotlib.mlab.stride_repeat`, which repeats an array to create a 2D
+array, and :func:`~matplotlib.mlab.stride_windows`, which uses a moving window
+to create a 2D array from a 1D array.
+
 
 Date handling
 -------------
