GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
deinterleave.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012,2014 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_BLOCKS_DEINTERLEAVE_H
24 #define INCLUDED_BLOCKS_DEINTERLEAVE_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief deinterleave an input block of samples into N outputs.
34  * \ingroup stream_operators_blk
35  *
36  * \details
37  * This block deinterleaves blocks of samples. For each output
38  * connection, the input stream will be deinterleaved successively
39  * to the output connections. By default, the block deinterleaves
40  * a single input to each output unless blocksize is given in the
41  * constructor.
42  *
43  * \code
44  * blocksize = 1
45  * connections = 2
46  * input = [a, b, c, d, e, f, g, h]
47  * output[0] = [a, c, e, g]
48  * output[1] = [b, d, f, h]
49  * \endcode
50  *
51  * \code
52  * blocksize = 2
53  * connections = 2
54  * input = [a, b, c, d, e, f, g, h]
55  * output[0] = [a, b, e, f]
56  * output[1] = [c, d, g, h]
57  * \endcode
58  */
59  class BLOCKS_API deinterleave : virtual public block
60  {
61  public:
62  // gr::blocks::deinterleave::sptr
63  typedef boost::shared_ptr<deinterleave> sptr;
64 
65  /*!
66  * Make a deinterleave block.
67  *
68  * \param itemsize stream itemsize
69  * \param blocksize size of block to deinterleave
70  */
71  static sptr make(size_t itemsize, unsigned int blocksize = 1);
72  };
73 
74  } /* namespace blocks */
75 } /* namespace gr */
76 
77 #endif /* INCLUDED_BLOCKS_DEINTERLEAVE_H */
boost::shared_ptr< deinterleave > sptr
Definition: deinterleave.h:63
deinterleave an input block of samples into N outputs.
Definition: deinterleave.h:59
Include this header to use the message passing features.
Definition: logger.h:131
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...
Definition: block.h:60
BLOCKS_API size_t itemsize(vector_type type)