Unpack K Bits: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Opposite of [[Pack K Bits]] - Converts a byte with k relevant bits to k output bytes with 1 bit each, located in the LSB.
Opposite of [[Pack K Bits]] - Converts a byte with k relevant bits to k output bytes with 1 bit each, located in the LSB.


Line 14: Line 13:


Each input byte produced four output bytes (that are either 0 or 1).  Remember that there is no item type of "bit" in GNU Radio, so we have to use bytes to represent single bits.
Each input byte produced four output bytes (that are either 0 or 1).  Remember that there is no item type of "bit" in GNU Radio, so we have to use bytes to represent single bits.
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 ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; K
 
: Constant for unpacking bits
; Param 1 (''R'')
: 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).
 
; Param 2
: blah blah blah


== 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.
[[File:Qpsk_stage6_fg.png|800px|]]
 
[[File:Fft-ex.png|700px]]
 
[[File:Fft-ex-output.png|700px]]


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


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vcc_fftw.cc Complex input]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/unpack_k_bits_bb_impl.cc Byte implementation]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vfc_fftw.cc Real input]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/unpack_k_bits.cc Base class]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft.cc Core algorithms]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vcc_fftw.h Complex input]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/unpack_k_bits_bb_impl.h]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/lib/fft_vfc_fftw.h Real input]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/include/gnuradio/fft/fft_vcc.h Complex input]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h Byte implementation]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/include/gnuradio/fft/fft_vfc.h Real input ]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/unpack_k_bits.h Base class]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fft/grc/fft_fft_vxx.block.yml GRC yaml]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_unpack_k_bits_bb.block.yml]

Latest revision as of 14:40, 9 December 2023

Opposite of Pack K Bits - Converts a byte with k relevant bits to k output bytes with 1 bit each, located in the LSB.

In other words, this block picks the K least significant bits from a byte, and expands them into K bytes of 0 or 1.

Example:

k = 4

in = [0xf5, 0x08]

out = [0,1,0,1,1,0,0,0]

Each input byte produced four output bytes (that are either 0 or 1). Remember that there is no item type of "bit" in GNU Radio, so we have to use bytes to represent single bits.

Parameters

K
Constant for unpacking bits

Example Flowgraph

Qpsk stage6 fg.png

Source Files

C++ files
Byte implementation
Base class
Header files
[1]
Public header files
Byte implementation
Base class
Block definition
[2]