diff options
| author | Tim Kuester <tpkuester@gmail.com> | 2014-04-15 16:59:53 -0400 |
|---|---|---|
| committer | Tim Kuester <tpkuester@gmail.com> | 2014-04-15 17:02:02 -0400 |
| commit | 850d5ca30cd10a3cf1edaf46234690c5dca3e5c4 (patch) | |
| tree | 91d1134b67a3691db7718b180d6809f63634e1e4 /gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h | |
| parent | 76970d54f3a6551751d481c63ea54c0794fc2591 (diff) | |
documentation: Bit handling gotchas explained
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h b/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h index c8c4378c30..cd057725c1 100644 --- a/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h +++ b/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h @@ -32,6 +32,15 @@ namespace gr { /*! * \brief Converts a stream of bytes with 1 bit in the LSB to a * byte with k relevent bits. + * + * This block takes in K bytes at a time, and uses the least significant + * bit to form a new byte. + * + * Example: + * k = 4 + * in = [0,1,0,1, 0x81,0x00,0x00,0x00] + * out = [0x05, 0x08] + * * \ingroup byte_operators_blk */ class BLOCKS_API pack_k_bits_bb : virtual public sync_decimator |