diff options
Diffstat (limited to 'gr-digital/include/digital/additive_scrambler_bb.h')
| -rw-r--r-- | gr-digital/include/digital/additive_scrambler_bb.h | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/gr-digital/include/digital/additive_scrambler_bb.h b/gr-digital/include/digital/additive_scrambler_bb.h index c0ae70e7b1..bc4d4b36e9 100644 --- a/gr-digital/include/digital/additive_scrambler_bb.h +++ b/gr-digital/include/digital/additive_scrambler_bb.h @@ -32,10 +32,18 @@ namespace gr { /*! * \ingroup coding_blk * + * \brief + * Scramble an input stream using an LFSR. + * * \details - * Scramble an input stream using an LFSR. This block works on the - * LSB only of the input data stream, i.e., on an "unpacked - * binary" stream, and produces the same format on its output. + * This block works on the LSB only of the input data stream, + * i.e., on an "unpacked binary" stream, and produces the same + * format on its output. + * + * The scrambler works by XORing the incoming bit stream by the + * output of the LFSR. Optionally, after 'count' bits have been + * processed, the shift register is reset to the seed value. + * This allows processing fixed length vectors of samples. */ class DIGITAL_API additive_scrambler_bb : virtual public gr_sync_block { @@ -46,19 +54,11 @@ namespace gr { /*! * \brief Create additive scrambler. * - * Scramble an input stream using an LFSR. This block works on - * the LSB only of the input data stream, i.e., on an "unpacked - * binary" stream, and produces the same format on its output. - * * \param mask Polynomial mask for LFSR * \param seed Initial shift register contents * \param len Shift register length * \param count Number of bits after which shift register is reset, 0=never * - * The scrambler works by XORing the incoming bit stream by the - * output of the LFSR. Optionally, after 'count' bits have been - * processed, the shift register is reset to the seed value. - * This allows processing fixed length vectors of samples. */ static sptr make(int mask, int seed, int len, int count=0); |