Difference between revisions of "Generic Filterbank"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
A filter bank with generic taps.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
This block takes in a vector of N complex inputs, passes them through N FIR filters, and outputs a vector of N complex outputs.
 +
 
 +
The only advantage of using this block over N individual FIR filter blocks is that it places less of a load on the scheduler.
 +
 
 +
The number of filters cannot be changed dynamically, however filters can be deactivated (i.e. no processing is done for them) by passing a vector of filter taps containing all zeros to them.  In this case their entry in the output vector is a zero.
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Taps(list of lists) (''R'')
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
: (vector of vector of floats / list of list of floats) Populates the filters.
 
 
; Param 2
 
: blah blah blah
 
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 21:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/filterbank_vcvcf_impl.cc Work function]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/filterbank.cc Helper functions]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/filterbank_vcvcf_impl.cc Work function]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/filterbank_vcvcf.h Work function]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/filterbank.h Helper functions]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/grc/filter_filterbank_vcvcf.block.yml]

Latest revision as of 14:59, 11 September 2019

A filter bank with generic taps.

This block takes in a vector of N complex inputs, passes them through N FIR filters, and outputs a vector of N complex outputs.

The only advantage of using this block over N individual FIR filter blocks is that it places less of a load on the scheduler.

The number of filters cannot be changed dynamically, however filters can be deactivated (i.e. no processing is done for them) by passing a vector of filter taps containing all zeros to them. In this case their entry in the output vector is a zero.

Parameters

(R): Run-time adjustable

Taps(list of lists) (R)
(vector of vector of floats / list of list of floats) Populates the filters.

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

C++ files
Work function
Helper functions
Header files
Work function
Public header files
Work function
Helper functions
Block definition
[1]