Difference between revisions of "Single Pole IIR Filter"

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]]
+
The input and output satisfy a difference equation of the form y[n] - (1-alpha) y[n-1] = alpha x[n]
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.
+
with the corresponding rational system function H(z) = \frac{alpha}{1 - (1-alpha) z^{-1}}
 +
 
 +
Note that some texts define the system function with a + in the denominator. If you're using that convention, you'll need to negate the feedback tap.  
  
 
== 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'')
+
; Alpha (''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).
+
:  
 
 
; Param 2
 
: blah blah blah
 
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 19:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/single_pole_iir_filter_ff_impl.cc]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/single_pole_iir_filter_ff_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/single_pole_iir_filter_ff_impl.h]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/single_pole_iir_filter_ff_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/single_pole_iir.h Base]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/single_pole_iir_filter_cc.h Complex input]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/single_pole_iir_filter_ff.h Float input]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/grc/filter_single_pole_iir_filter_xx.block.yml]

Latest revision as of 15:09, 11 September 2019

The input and output satisfy a difference equation of the form y[n] - (1-alpha) y[n-1] = alpha x[n]

with the corresponding rational system function H(z) = \frac{alpha}{1 - (1-alpha) z^{-1}}

Note that some texts define the system function with a + in the denominator. If you're using that convention, you'll need to negate the feedback tap.

Parameters

(R): Run-time adjustable

Alpha (R)

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
[1]
[2]
Header files
[3]
[4]
Public header files
Base
Complex input
Float input
Block definition
[5]