Difference between revisions of "GLFSR Source"

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]]
+
Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0.
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 ==
+
; Degree
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
+
: Degree of shift register must be in [1, 32]. If mask is 0, the degree determines a default mask (see digital_impl_glfsr.cc for the mapping).
 +
 
 +
; Repeat
 +
: Set to repeat sequence.
  
; Param 1 (''R'')
+
; Mask
: 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).
+
: Allows a user-defined bit mask for indexes of the shift register to feed back.
  
; Param 2
+
; Seed
: blah blah blah
+
: Initial setting for values in shift register.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

Latest revision as of 14:29, 11 September 2019

Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0.

Parameters

Degree
Degree of shift register must be in [1, 32]. If mask is 0, the degree determines a default mask (see digital_impl_glfsr.cc for the mapping).
Repeat
Set to repeat sequence.
Mask
Allows a user-defined bit mask for indexes of the shift register to feed back.
Seed
Initial setting for values in shift register.

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++ fileshttps
//wiki.gnuradio.org/index.php/SISO
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO