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...")
 
(add example flowgraph; revise parameter descriptions)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This filter is a convenience wrapper for a 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'')
+
; FIR Type
: 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).
+
: options: [Complex->Complex (Decimating), Complex->Complex (Interpolating), Float->Float (Decimating), Float->Float (Interpolating)]
 +
 
 +
; Decimation or Interpolation
 +
: decimation or interpolation factor (depending on which type is chosen above).
 +
 
 +
; Gain (''R'')
 +
: Overall gain of filter (default 1.0)
 +
 
 +
; Sample Rate (''R'')
 +
: Sample rate in samples per second.
 +
 
 +
; Symbol Rate (''R'')
 +
: Symbol rate, must be a factor of sample rate. Typically ((samples/second) / (samples/symbol)).
 +
 
 +
; Alpha (''R'')
 +
: Excess bandwidth factor, also known as alpha. (default: 0.35)
  
; Param 2
+
; Num Taps (''R'')
: blah blah blah
+
: Number of taps (default: 11*samp_rate)
  
 
== Example Flowgraph ==
 
== 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, unfortunatelyThe 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.
+
This flowgraph can be found at [https://github.com/duggabe/gr-morse-code-gen/blob/master/MorseGen_xmt.grc]Two Root Raised Cosine Filters in series produce a Raised Cosine Filter which is used for keying waveform shaping, thereby reducing key clicks.
 +
 
 +
[[File:MorseGen_xmt_fg.png|800px]]
  
 
== Source Files ==
 
== Source Files ==
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-filter/lib/firdes.cc]
  
 
; Header files
 
; Header files
Line 27: Line 41:
  
 
; 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 16:32, 4 March 2021

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

Parameters[edit]

(R): Run-time adjustable

FIR Type
options: [Complex->Complex (Decimating), Complex->Complex (Interpolating), Float->Float (Decimating), Float->Float (Interpolating)]
Decimation or Interpolation
decimation or interpolation factor (depending on which type is chosen above).
Gain (R)
Overall gain of filter (default 1.0)
Sample Rate (R)
Sample rate in samples per second.
Symbol Rate (R)
Symbol rate, must be a factor of sample rate. Typically ((samples/second) / (samples/symbol)).
Alpha (R)
Excess bandwidth factor, also known as alpha. (default: 0.35)
Num Taps (R)
Number of taps (default: 11*samp_rate)

Example Flowgraph[edit]

This flowgraph can be found at [1]. Two Root Raised Cosine Filters in series produce a Raised Cosine Filter which is used for keying waveform shaping, thereby reducing key clicks.

MorseGen xmt fg.png

Source Files[edit]

C++ files
[2]
Header files
TODO
Public header files
Taps creation
Filter definition
Block definition
[3]