LDPC Encoder Definition: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
This block has not been properly documented. please help us remedy to that.
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 ==
== Parameters ==
; Id
: The id of the block


; Parallelism
; Parallelism
: For parallel execution of multiple instances of the block (more info is needed on this)
: 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
; Dimension 1
: For parallelism
: This input appears when parallelism is set to 1 or 2.


; Dimension 2
; Dimension 2
: For parallelism
: This input appears when parallelism is set to 2.


; File
; File
: Name of an alist file to use.
: 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/blob/master/gr-fec/lib/ldpc_encoder_impl.cc]
: [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/blob/master/gr-fec/lib/ldpc_encoder_impl.h]
: [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/blob/master/gr-fec/include/gnuradio/fec/ldpc_encoder.h]
: [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/blob/master/gr-fec/grc/ldpc_encoder_def_list.block.yml]
: [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"