Difference between revisions of "LDPC Bit Flip Decoder 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...")
 
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This block creates a LDPC Bit Flip Decoder Definition variable.
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.
+
The decoder requires knowledge of the matrix used to create (encode) the codewords.
  
 
== 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).
+
: For parallel execution of multiple instances of the block (more info is needed on this)
  
; Param 2
+
; Dimension 1
: blah blah blah
+
: For parallelism
 +
 
 +
; Dimension 2
 +
: For parallelism
 +
 
 +
; Max iterations
 +
: Max iterations may be increased from 100 for possibly better performance, but significantly higher number of iterations may slow things down.
 +
 
 +
; LDPC FEC matrix ID
 +
:  In the LDPC FEC Matrix ID field, input the ID of either a:
 +
::  1) LDPC Generator Matrix variable, or
 +
::  2) LDPC Parity Check Matrix variable
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 30:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ldpc_bit_flip_decoder_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ldpc_bit_flip_decoder_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/ldpc_bit_flip_decoder.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/variable_ldpc_bit_flip_decoder.block.yml]

Latest revision as of 14:02, 5 September 2019

This block creates a LDPC Bit Flip Decoder Definition variable.

The decoder requires knowledge of the matrix used to create (encode) the codewords.

Parameters[edit]

Parallelism
For parallel execution of multiple instances of the block (more info is needed on this)
Dimension 1
For parallelism
Dimension 2
For parallelism
Max iterations
Max iterations may be increased from 100 for possibly better performance, but significantly higher number of iterations may slow things down.
LDPC FEC matrix ID
In the LDPC FEC Matrix ID field, input the ID of either a:
1) LDPC Generator Matrix variable, or
2) LDPC Parity Check Matrix variable

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
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]