Difference between revisions of "POLAR Encoder 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]]
+
POLAR 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.
+
Polar codes are based on this paper by Erdal Arikan "Channel Polarization: A Method for Constructing Capacity-Achieving Codes for Symmetric Binary-Input Memoryless Channels", 2009 block holds common information for encoders and decoders.
 +
 
 +
Expects values with MSB first. It needs a full information word and encodes it in one pass. Output is a codeword of block_size.
  
 
== Parameters ==
 
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
  
; Param 1 (''R'')
+
; Packed Bits
: 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).
+
: Choose 1 active bit per byte or 8 active bit per byte. if false, VOLK polar encoder is used.
 +
 
 +
; Parallelism
 +
: For parallel execution of multiple instances of the block (more info is needed on this)
 +
 
 +
; Dimension 1
 +
: For parallelism
 +
 
 +
; Dimension 2
 +
: For parallelism
 +
 
 +
; Block size (N)
 +
: Codeword size. MUST be a power of 2.
 +
 
 +
; #Info Bits (K)
 +
: Represents the number of information bits in a block. Also called frame_size. <= block_size
 +
 
 +
; Frozen Bit Positions
 +
: Integer vector which defines the position of all frozen bits in a block. Its size MUST be equal to block_size - num_info_bits. Also it must be sorted and every position must only occur once.
  
; Param 2
+
; Frozen Bit Values
: blah blah blah
+
: Holds an unpacked byte for every frozen bit position. It defines if a frozen bit is fixed to '0' or '1'. Defaults to all ZERO.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 39:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/polar_encoder.cc]
 
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/polar_common.cc Common code]
; Header files
 
: [https://github.com/gnuradio/gnuradio TODO]
 
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/polar_encoder.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/variable_polar_encoder.block.yml]

Revision as of 16:56, 4 September 2019

POLAR encoder

Polar codes are based on this paper by Erdal Arikan "Channel Polarization: A Method for Constructing Capacity-Achieving Codes for Symmetric Binary-Input Memoryless Channels", 2009 block holds common information for encoders and decoders.

Expects values with MSB first. It needs a full information word and encodes it in one pass. Output is a codeword of block_size.

Parameters

Packed Bits
Choose 1 active bit per byte or 8 active bit per byte. if false, VOLK polar encoder is used.
Parallelism
For parallel execution of multiple instances of the block (more info is needed on this)
Dimension 1
For parallelism
Dimension 2
For parallelism
Block size (N)
Codeword size. MUST be a power of 2.
#Info Bits (K)
Represents the number of information bits in a block. Also called frame_size. <= block_size
Frozen Bit Positions
Integer vector which defines the position of all frozen bits in a block. Its size MUST be equal to block_size - num_info_bits. Also it must be sorted and every position must only occur once.
Frozen Bit Values
Holds an unpacked byte for every frozen bit position. It defines if a frozen bit is fixed to '0' or '1'. Defaults to all ZERO.

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