FEC Extended Encoder: Difference between revisions

From GNU Radio
Jump to navigation Jump to 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 Parameters and example flowgraph)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Forward Error Correction (FEC) is a common technique used in telecommunication systems to control error in the data transmission over noisy transmission channels. The key concept is to encode the signal in a redundant way by using Error Correcting Code (ECC) in the transmitter; this allows the receiver to detect a limited number of error bits in the transmitted signal and often to correct these errors without the need of re-transmitting the signal.  
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 ==
; Encoder Objects
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
: Object defined by an LDPC_Encoder_Definition block


; Param 1 (''R'')
; Threading 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: [capillary, ordinary, none]


; Param 2
; Puncture Pattern
: blah blah blah
: default: '11'


== 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_ldpc_encoders.grc]
 
[[File:Fecapi_ldpc_encoders_fg.png|800px]]


== Source Files ==
== Source Files ==


; C++ files
; Python files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/python/fec/extended_encoder.py]
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/fec_extended_encoder.block.yml]

Latest revision as of 14:50, 3 December 2020

Forward Error Correction (FEC) is a common technique used in telecommunication systems to control error in the data transmission over noisy transmission channels. The key concept is to encode the signal in a redundant way by using Error Correcting Code (ECC) in the transmitter; this allows the receiver to detect a limited number of error bits in the transmitted signal and often to correct these errors without the need of re-transmitting the signal.

Parameters

Encoder Objects
Object defined by an LDPC_Encoder_Definition block
Threading Type
options: [capillary, ordinary, none]
Puncture Pattern
default: '11'

Example Flowgraph

This flowgraph can be found at [1]

Fecapi ldpc encoders fg.png

Source Files

Python files
[2]
Block definition
[3]