LDPC Encoder Definition: 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 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This block can be used to create an LDPC Encoder object that can then be used in other encoders such as FEC Extended Encoder.
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 ==
; Id
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
: The id of the block
 
; Parallelism
: For parallel execution of multiple instances of the block (more info is needed on this). It has 3 options: 0, 1, 2. If the option of 1 or 2 is chosen, respective number of new inputs appear for dimensions.
 
; Dimension 1
: This input appears when parallelism is set to 1 or 2.


; Param 1 (''R'')
; Dimension 2
: 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).
: This input appears when parallelism is set to 2.


; Param 2
; File
: blah blah blah
: Path of the file to use.


== 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
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ldpc_encoder_impl.cc ldpc_encoder_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ldpc_encoder_impl.h ldpc_encoder_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_encoder.h ldpc_encoder.h]


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

Latest revision as of 10:34, 6 June 2022

This block can be used to create an LDPC Encoder object that can then be used in other encoders such as FEC Extended Encoder.

Parameters

Id
The id of the block
Parallelism
For parallel execution of multiple instances of the block (more info is needed on this). It has 3 options: 0, 1, 2. If the option of 1 or 2 is chosen, respective number of new inputs appear for dimensions.
Dimension 1
This input appears when parallelism is set to 1 or 2.
Dimension 2
This input appears when parallelism is set to 2.
File
Path of the file to use.

Example Flowgraph

This flowgraph can be found at [1]

Fecapi ldpc encoders fg.png

Source Files

C++ files
ldpc_encoder_impl.cc
Header files
ldpc_encoder_impl.h
Public header files
ldpc_encoder.h
Block definition
ldpc_encoder_def_list.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=LDPC_Encoder_Definition&oldid=12329"