summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h b/gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h
index 926819502a..09d7ae912c 100644
--- a/gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h
+++ b/gr-blocks/include/gnuradio/blocks/unpack_k_bits_bb.h
@@ -31,6 +31,14 @@ namespace gr {
/*!
* \brief Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB.
+ *
+ * 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]
* \ingroup byte_operators_blk
*/
class BLOCKS_API unpack_k_bits_bb : virtual public sync_interpolator