Difference between revisions of "POLAR code Configurator"

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...")
 
(Example Flowgraph)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This block serves as an interface to the underlying Python functions for channel construction.
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 ==
 +
 
 +
; Channel
 +
: Current channel types are: BEC/AWGN
 +
 
 +
; Block size (N)
 +
: Block size must be a power of 2!
  
== Parameters ==
+
; Info bits (K)
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
+
: Info Bits must be 0 < K < N
  
; Param 1 (''R'')
+
; Design SNR
: 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).
+
: Design SNR does affect the target transmission SNR and thus performance.
  
; Param 2
+
; mu
: blah blah blah
+
: The parameter mu is only relevant for AWGN channels. It is passed on to the corresponding Channel construction algorithm.
  
 
== 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, 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.
+
This flowgraph can be found at [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/examples/fecapi_polar_encoders.grc]
 +
 
 +
[[File:Fecapi_polar_encoders_fg.png|800px]]
  
 
== Source Files ==
 
== Source Files ==
Line 30: Line 37:
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/variable_polar_code_configurator.block.yml]

Latest revision as of 15:04, 7 December 2020

This block serves as an interface to the underlying Python functions for channel construction.

Parameters[edit]

Channel
Current channel types are: BEC/AWGN
Block size (N)
Block size must be a power of 2!
Info bits (K)
Info Bits must be 0 < K < N
Design SNR
Design SNR does affect the target transmission SNR and thus performance.
mu
The parameter mu is only relevant for AWGN channels. It is passed on to the corresponding Channel construction algorithm.

Example Flowgraph[edit]

This flowgraph can be found at [1]

Fecapi polar encoders fg.png

Source Files[edit]

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
[2]