Difference between revisions of "TPC Encoder Definition"

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 instantiates a 1-dim array or 2-dim array for Turbo Product Encoders (TPC).
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.
+
           
 
+
Restrictions: B and Q must be carefully chosen such that when the matrices are setup, and the first B outputs are removed, they (the first B outputs) are all 0's.
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>
 
  
; Param 1 (''R'')
+
; Parallelism
 
: 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
+
; Dimension 1
: blah blah blah
+
: For parallelism
 +
 
 +
; Dimension 2
 +
: For parallelism
 +
 
 +
; Row Encoder Polynomials
 +
:
 +
 
 +
; Column Encoder Polynomials
 +
:
 +
 
 +
; K Row
 +
:
 +
 
 +
; K Col
 +
:
 +
 
 +
; B
 +
:
 +
 
 +
; Q
 +
:
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 40:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/tpc_common.cc Common]
 
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/tpc_encoder.cc Encoder]
; Header files
 
: [https://github.com/gnuradio/gnuradio TODO]
 
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/tpc_common.h Common]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/tpc_encoder.h Encoder]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/tpc_encoder_def_list.block.yml]

Latest revision as of 09:20, 12 September 2019

This instantiates a 1-dim array or 2-dim array for Turbo Product Encoders (TPC).

Restrictions: B and Q must be carefully chosen such that when the matrices are setup, and the first B outputs are removed, they (the first B outputs) are all 0's.

Parameters[edit]

Parallelism
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).
Dimension 1
For parallelism
Dimension 2
For parallelism
Row Encoder Polynomials
Column Encoder Polynomials
K Row
K Col
B
Q

Example Flowgraph[edit]

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[edit]

C++ files
Common
Encoder
Public header files
Common
Encoder
Block definition
[1]