diff options
author | Ben Reynwar | 2012-04-30 09:20:59 -0700 |
---|---|---|
committer | Ben Reynwar | 2012-04-30 09:20:59 -0700 |
commit | 2817cf14147d6da2e7ef051fbbbf8228fd1c07ba (patch) | |
tree | 0695ce3bcdbd75784198c28e6cb963c99ae5d0f6 /gr-fft/doc | |
parent | e7f45e3c513242706a9e4aa36e99e33e79e66d4f (diff) | |
parent | d7ecbd12be995ad6db7a53a5d6dd3fcb205c07ea (diff) | |
download | gnuradio-2817cf14147d6da2e7ef051fbbbf8228fd1c07ba.tar.gz gnuradio-2817cf14147d6da2e7ef051fbbbf8228fd1c07ba.tar.bz2 gnuradio-2817cf14147d6da2e7ef051fbbbf8228fd1c07ba.zip |
Merge branch 'master' of http://gnuradio.org/git/gnuradio
Diffstat (limited to 'gr-fft/doc')
-rw-r--r-- | gr-fft/doc/CMakeLists.txt | 23 | ||||
-rw-r--r-- | gr-fft/doc/README.fft | 13 | ||||
-rw-r--r-- | gr-fft/doc/fft.dox | 29 |
3 files changed, 65 insertions, 0 deletions
diff --git a/gr-fft/doc/CMakeLists.txt b/gr-fft/doc/CMakeLists.txt new file mode 100644 index 000000000..96c42f030 --- /dev/null +++ b/gr-fft/doc/CMakeLists.txt @@ -0,0 +1,23 @@ +# Copyright 2012 Free Software Foundation, Inc. +# +# This file is part of GNU Radio +# +# GNU Radio is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3, or (at your option) +# any later version. +# +# GNU Radio is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with GNU Radio; see the file COPYING. If not, write to +# the Free Software Foundation, Inc., 51 Franklin Street, +# Boston, MA 02110-1301, USA. + +install( + FILES README.fft + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-fft/doc/README.fft b/gr-fft/doc/README.fft new file mode 100644 index 000000000..3ea9e81f8 --- /dev/null +++ b/gr-fft/doc/README.fft @@ -0,0 +1,13 @@ +This is the gr-fft package. It contains signal processing blocks to +perform FFTs and FFT-related functionality. + +The Python namespace is in gnuradio.fft, which would be normally +imported as: + + from gnuradio import fft + +See the Doxygen documentation for details about the blocks available +in this package. A quick listing of the details can be found in Python +after importing by using: + + help(fft) diff --git a/gr-fft/doc/fft.dox b/gr-fft/doc/fft.dox new file mode 100644 index 000000000..5bf612d84 --- /dev/null +++ b/gr-fft/doc/fft.dox @@ -0,0 +1,29 @@ +/*! \page page_fft FFT Signal Processing Blocks + +\section Introduction + +This is the gr-fft package. It contains signal processing blocks to +perform FFTs and FFT-related functionality. + +The Python namespace is in gnuradio.fft, which would be normally +imported as: + +\code + from gnuradio import fft +\endcode + +See the Doxygen documentation for details about the blocks available +in this package. A quick listing of the details can be found in Python +after importing by using: + +\code + help(fft) +\endcode + +\section Dependencies + +The FFT blocks require the following dependencies. + +\li fftw3f (>= 3.0) http://www.fftw.org/download.html + +*/ |