Constellation Rect. Object: 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...")
 
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
A version of [[Constellation Object]] specific to rectangular constellations. See [[Constellation Object]] for more usage info.  
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 ==
; Symbol Map
: List of alphabet symbols (before applying any differential coding) (order of list matches Constellation Points)
 
; Constellation Points
: List of constellation points (order of list matches Symbol Map)
 
; Rotational Symmetry
: Number of rotations around unit circle that have the same representation.
 
; Real Sectors
: Number of sectors the real axis is split in to.


== Parameters ==
; Imaginary Sectors
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
: Number of sectors the imag axis is split in to.
 
; Width Real Sectors
: Width of each real sector to calculate decision boundaries.
 
; Width Imaginary Sectors
: Width of each imag sector to calculate decision boundaries.


; Param 1 (''R'')
; Soft Bits Precision
: 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).
: The number of bits of precision used when generating the LUT.


; Param 2
; Soft Decisions LUT
: blah blah blah
: The soft decision LUT as a vector of tuples (vectors in C++) of soft decisions. Each element of the LUT is a vector of k-bit floats (where there are k bits/sample in the constellation).


== 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 is taken from the [[QPSK_Mod_and_Demod]] tutorial.
 
[[File:Qpsk_stage1_fg.png|800px]]


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


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


; Header files
; Header files
Line 27: Line 45:


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


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

Latest revision as of 14:59, 9 December 2023

A version of Constellation Object specific to rectangular constellations. See Constellation Object for more usage info.

Parameters

Symbol Map
List of alphabet symbols (before applying any differential coding) (order of list matches Constellation Points)
Constellation Points
List of constellation points (order of list matches Symbol Map)
Rotational Symmetry
Number of rotations around unit circle that have the same representation.
Real Sectors
Number of sectors the real axis is split in to.
Imaginary Sectors
Number of sectors the imag axis is split in to.
Width Real Sectors
Width of each real sector to calculate decision boundaries.
Width Imaginary Sectors
Width of each imag sector to calculate decision boundaries.
Soft Bits Precision
The number of bits of precision used when generating the LUT.
Soft Decisions LUT
The soft decision LUT as a vector of tuples (vectors in C++) of soft decisions. Each element of the LUT is a vector of k-bit floats (where there are k bits/sample in the constellation).

Example Flowgraph

This flowgraph is taken from the QPSK_Mod_and_Demod tutorial.

Qpsk stage1 fg.png

Source Files

C++ files
constellation.cc
Header files
TODO
Public header files
constellation.h
Block definition
digital_constellation_rect.block.yml