Difference between revisions of "Root Raised Cosine 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]]
+
This filter is a convenience wrapper for an fir filter and a firdes taps generating function.
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'')
+
; Decimation
 
: 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).
 
: 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
+
; Gain (''R'')
: blah blah blah
+
: Overall gain of filter (typically 1.0)
 +
 
 +
; Sample Rate (''R'')
 +
: Sample rate in Hertz.
 +
 
 +
; Symbol Rate (''R'')
 +
: Symbol rate, must be a factor of sample rate
 +
 
 +
; Alpha (''R'')
 +
: Excess bandwidth factor
 +
 
 +
; Num Taps (''R'')
 +
: Number of taps
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 27: Line 36:
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/firdes.h#L320 Taps creation]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/include/gnuradio/filter/interp_fir_filter.h Filter definition]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/grc/filter_root_raised_cosine_filter.block.yml]

Latest revision as of 15:16, 11 September 2019

This filter is a convenience wrapper for an fir filter and a firdes taps generating function.

Parameters

(R): Run-time adjustable

Decimation
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).
Gain (R)
Overall gain of filter (typically 1.0)
Sample Rate (R)
Sample rate in Hertz.
Symbol Rate (R)
Symbol rate, must be a factor of sample rate
Alpha (R)
Excess bandwidth factor
Num Taps (R)
Number of taps

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
TODO
Header files
TODO
Public header files
Taps creation
Filter definition
Block definition
[1]