Block Template: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs This is the template for the "Block Docs". This first section should describe what the block does and how to use it, using however many paragraphs is...")
 
(Replaced content with "deleted, not needed anymore now that every block has a stub page")
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
deleted, not needed anymore now that every block has a stub page
 
This is the template for the "Block Docs".  This first section should describe what the block does and how to use it, using however many paragraphs is necessary. 
 
== Parameters ==
 
; FFT Size
: Number of samples used in each FFT calculation, which also determines how many points are in the output.
 
; Forward/Reverse
: Whether to do an FFT or IFFT.
 
; Window
: Type of window to apply to each set of samples before the FFT is taken, default is a blackmanharris window. The argument of the window.blackmanharris() function is simply how many points in the window, which must match the FFT size.
 
; Shift
: Whether or not to do an "fft shift" which puts DC (0 Hz) in the center.  If you are not sure what this means, leave it set to Yes. Only active when input type is complex.
 
; Num Threads
: Number of threads to assign to perform the FFTs.
 
== Example Flowgraph ==
 
Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI
 
[[File:Fft-ex.png|700px]]
 
[[File:Fft-ex-output.png|700px]]
 
== Source Files ==
 
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vcc_fftw.cc Complex input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vfc_fftw.cc Real input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft.cc Core algorithms]
 
; Header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vcc_fftw.h Complex input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vfc_fftw.h Real input]
 
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/include/gnuradio/fft/fft_vcc.h Complex input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/include/gnuradio/fft/fft_vfc.h Real input ]
 
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/grc/fft_fft_vxx.block.yml GRC yaml]

Latest revision as of 03:59, 27 July 2019

deleted, not needed anymore now that every block has a stub page

Retrieved from "https://wiki.gnuradio.org/index.php?title=Block_Template&oldid=5815"