FEC 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...")
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This is a GNU Radio adaptor for any FEC encoder following the generic_encoder API in the fec module.  
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.
Input and output are flexible to accommodate encoders that, say, modulate their encoded results into complex or float types.
 
Generally, we would use the fec.extended_encoder Python implementation to instantiate this. The extended_encoder wraps up a few more details, like taking care of puncturing as well as the encoder itself.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Constituent Encoder
: 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).
: An FECAPI encoder object child of the generic_encoder class.
 
; Input Type
:* Complex
:* Int
:* Float
:* Short
:* Byte


; Param 2
; Output Type
: blah blah blah
:* Complex
:* Int
:* Float
:* Short
:* Byte


== Example Flowgraph ==
== Example Flowgraph ==
Line 21: Line 32:


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-fec/lib/encoder_impl.cc encoder_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-fec/lib/encoder_impl.h encoder_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-fec/include/gnuradio/fec/encoder.h encoder.h]


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

Latest revision as of 06:52, 27 January 2022

This is a GNU Radio adaptor for any FEC encoder following the generic_encoder API in the fec module.

Input and output are flexible to accommodate encoders that, say, modulate their encoded results into complex or float types.

Generally, we would use the fec.extended_encoder Python implementation to instantiate this. The extended_encoder wraps up a few more details, like taking care of puncturing as well as the encoder itself.

Parameters

Constituent Encoder
An FECAPI encoder object child of the generic_encoder class.
Input Type
  • Complex
  • Int
  • Float
  • Short
  • Byte
Output Type
  • Complex
  • Int
  • Float
  • Short
  • Byte

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++ files
encoder_impl.cc
Header files
encoder_impl.h
Public header files
encoder.h
Block definition
fec_encoder.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=FEC_Encoder&oldid=10903"