aboutsummaryrefslogtreecommitdiffstats
path: root/gr-fft
diff options
context:
space:
mode:
authorJacob Gilbert <mrjacobagilbert@gmail.com>2020-04-25 13:10:32 -0600
committermormj <34754695+mormj@users.noreply.github.com>2020-04-26 11:17:00 -0400
commit76a9d742f26621291eaa6956b8769f991c50c459 (patch)
treec25abc6f7eeb9b00bad1f982974b9905e0ea8ad5 /gr-fft
parentgr-fft: added tukey window generation (diff)
downloadgnuradio-76a9d742f26621291eaa6956b8769f991c50c459.tar.xz
gnuradio-76a9d742f26621291eaa6956b8769f991c50c459.zip
gr-fft: added documentation for flat top window design
a note about differences between other popular flat top window generators
Diffstat (limited to 'gr-fft')
-rw-r--r--gr-fft/include/gnuradio/fft/window.h15
1 files changed, 13 insertions, 2 deletions
diff --git a/gr-fft/include/gnuradio/fft/window.h b/gr-fft/include/gnuradio/fft/window.h
index 6b4411393..9fc15c123 100644
--- a/gr-fft/include/gnuradio/fft/window.h
+++ b/gr-fft/include/gnuradio/fft/window.h
@@ -211,9 +211,20 @@ public:
static std::vector<float> nuttal_cfd(int ntaps);
/*!
- * \brief Build a flat top window.
+ * \brief Build a flat top window per the SRS specification
*
- * See: http://en.wikipedia.org/wiki/Window_function#Flat_top_window
+ * See:
+ * <pre>
+ * Stanford Research Systems, "Model SR785 Dynamic Signal
+ * Analyzer: Operating Manual and Programming Reference,"
+ * 2017, pp 2-13
+ * </pre>
+ *
+ * Note: there are many flat top windows, and this implementation is different from
+ * SciPY and Matlab which use the coefficients from D’Antona et al. "Digital Signal
+ * Processing for Measurement Systems" with the following cosine coefficients: <pre>
+ * [0.21557895, 0.41663158, 0.277263158, 0.083578947, 0.006947368]
+ * </pre>
*
* \param ntaps Number of coefficients in the window.
*/