Difference between revisions of "Band Reject 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...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This filter is a convenience wrapper for an [[Decimating FIR Filter]] and a firdes taps generating function of band-reject type, i.e. calling firdes.band_reject().
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.
 
  
 
== 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'')
+
; FIR Type (''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).
+
: Specify whether input/output is real or complex, and if the taps are real or complex.
 +
 
 +
; Decimation
 +
: Decimation rate of filter, must be an integer, and cannot change in realtime.
 +
 
 +
; Gain (''R'')
 +
: Scaling factor applied to output.
  
; Param 2
+
; Sample Rate (''R'')
: blah blah blah
+
: Input sample rate.
  
== Example Flowgraph ==
+
; Low Cutoff Freq (''R'')
 +
: Lower cutoff frequency in Hz
  
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.
+
; High Cutoff Freq (''R'')
 +
: Upper cutoff frequency in Hz
  
== Source Files ==
+
; Transition Width (''R'')
 +
: Transition width between stop-band and pass-band in Hz
  
; C++ files
+
; Window (''R'')
: [https://github.com/gnuradio/gnuradio TODO]
+
: Type of window to use
  
; Header files
+
; Beta (''R'')
: [https://github.com/gnuradio/gnuradio TODO]
+
: The beta paramater only applies to the Kaiser window.
  
; Public header files
+
== Example Flowgraph ==
: [https://github.com/gnuradio/gnuradio TODO]
 
  
; Block definition
+
== Source Files ==
: [https://github.com/gnuradio/gnuradio TODO]
 

Latest revision as of 03:40, 27 July 2019

This filter is a convenience wrapper for an Decimating FIR Filter and a firdes taps generating function of band-reject type, i.e. calling firdes.band_reject().

Parameters[edit]

(R): Run-time adjustable

FIR Type (R)
Specify whether input/output is real or complex, and if the taps are real or complex.
Decimation
Decimation rate of filter, must be an integer, and cannot change in realtime.
Gain (R)
Scaling factor applied to output.
Sample Rate (R)
Input sample rate.
Low Cutoff Freq (R)
Lower cutoff frequency in Hz
High Cutoff Freq (R)
Upper cutoff frequency in Hz
Transition Width (R)
Transition width between stop-band and pass-band in Hz
Window (R)
Type of window to use
Beta (R)
The beta paramater only applies to the Kaiser window.

Example Flowgraph[edit]

Source Files[edit]