GNU Radio 3.7.1 C++ API
pfb_channelizer_ccf.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2009,2010,2012 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
24
#ifndef INCLUDED_FILTER_PFB_CHANNELIZER_CCF_H
25
#define INCLUDED_FILTER_PFB_CHANNELIZER_CCF_H
26
27
#include <
gnuradio/filter/api.h
>
28
#include <
gnuradio/block.h
>
29
30
namespace
gr {
31
namespace
filter {
32
33
/*!
34
* \brief Polyphase filterbank channelizer with
35
* gr_complex input, gr_complex output and float taps
36
* \ingroup channelizers_blk
37
*
38
* \details
39
* This block takes in complex inputs and channelizes it to <EM>M</EM>
40
* channels of equal bandwidth. Each of the resulting channels is
41
* decimated to the new rate that is the input sampling rate
42
* <EM>fs</EM> divided by the number of channels, <EM>M</EM>.
43
*
44
* The PFB channelizer code takes the taps generated above and builds
45
* a set of filters. The set contains <EM>M</EM> number of filters
46
* and each filter contains ceil(taps.size()/decim) number of taps.
47
* Each tap from the filter prototype is sequentially inserted into
48
* the next filter. When all of the input taps are used, the remaining
49
* filters in the filterbank are filled out with 0's to make sure each
50
* filter has the same number of taps.
51
*
52
* Each filter operates using the gr::blocks::fir_filter_XXX
53
* classs of GNU Radio, which takes the input stream at <EM>i</EM>
54
* and performs the inner product calculation to <EM>i+(n-1)</EM>
55
* where <EM>n</EM> is the number of filter taps. To efficiently
56
* handle this in the GNU Radio structure, each filter input must
57
* come from its own input stream. So the channelizer must be
58
* provided with <EM>M</EM> streams where the input stream has
59
* been deinterleaved. This is most easily done using the
60
* gr::blocks::stream_to_streams block.
61
*
62
* The output is then produced as a vector, where index <EM>i</EM>
63
* in the vector is the next sample from the <EM>i</EM>th
64
* channel. This is most easily handled by sending the output to a
65
* gr::blocks::vector_to_streams block to handle the conversion
66
* and passing <EM>M</EM> streams out.
67
*
68
* The input and output formatting is done using a hier_block2 called
69
* pfb_channelizer_ccf. This can take in a single stream and outputs
70
* <EM>M</EM> streams based on the behavior described above.
71
*
72
* The filter's taps should be based on the input sampling rate.
73
*
74
* For example, using the GNU Radio's firdes utility to building
75
* filters, we build a low-pass filter with a sampling rate of
76
* <EM>fs</EM>, a 3-dB bandwidth of <EM>BW</EM> and a transition
77
* bandwidth of <EM>TB</EM>. We can also specify the out-of-band
78
* attenuation to use, <EM>ATT</EM>, and the filter window
79
* function (a Blackman-harris window in this case). The first input
80
* is the gain of the filter, which we specify here as unity.
81
*
82
* <B><EM>self._taps = filter.firdes.low_pass_2(1, fs, BW, TB,
83
* attenuation_dB=ATT, window=filter.firdes.WIN_BLACKMAN_hARRIS)</EM></B>
84
*
85
* The filter output can also be overs ampled. The over sampling rate
86
* is the ratio of the the actual output sampling rate to the normal
87
* output sampling rate. It must be rationally related to the number
88
* of channels as N/i for i in [1,N], which gives an outputsample rate
89
* of [fs/N, fs] where fs is the input sample rate and N is the number
90
* of channels.
91
*
92
* For example, for 6 channels with fs = 6000 Hz, the normal rate is
93
* 6000/6 = 1000 Hz. Allowable oversampling rates are 6/6, 6/5, 6/4,
94
* 6/3, 6/2, and 6/1 where the output sample rate of a 6/1 oversample
95
* ratio is 6000 Hz, or 6 times the normal 1000 Hz. A rate of 6/5 = 1.2,
96
* so the output rate would be 1200 Hz.
97
*
98
* The theory behind this block can be found in Chapter 6 of
99
* the following book.
100
*
101
* <B><EM>f. harris, "Multirate Signal Processing for Communication
102
* Systems," Upper Saddle River, NJ: Prentice Hall, Inc. 2004.</EM></B>
103
*
104
*/
105
106
class
FILTER_API
pfb_channelizer_ccf
:
virtual
public
block
107
{
108
public
:
109
// gr::filter::pfb_channelizer_ccf::sptr
110
typedef
boost::shared_ptr<pfb_channelizer_ccf>
sptr
;
111
112
/*!
113
* Build the polyphase filterbank decimator.
114
* \param numchans (unsigned integer) Specifies the number of
115
* channels <EM>M</EM>
116
* \param taps (vector/list of floats) The prototype filter to
117
* populate the filterbank.
118
* \param oversample_rate (float) The over sampling rate is the
119
* ratio of the the actual output
120
* sampling rate to the normal
121
* output sampling rate. It must
122
* be rationally related to the
123
* number of channels as N/i for
124
* i in [1,N], which gives an
125
* outputsample rate of [fs/N,
126
* fs] where fs is the input
127
* sample rate and N is the
128
* number of channels.
129
*
130
* For example, for 6 channels
131
* with fs = 6000 Hz, the normal
132
* rateis 6000/6 = 1000
133
* Hz. Allowable oversampling
134
* rates are 6/6, 6/5, 6/4, 6/3,
135
* 6/2, and 6/1 where the output
136
* sample rate of a 6/1
137
* oversample ratio is 6000 Hz,
138
* or 6 times the normal 1000 Hz.
139
*/
140
static
sptr
make(
unsigned
int
numchans,
141
const
std::vector<float> &
taps
,
142
float
oversample_rate);
143
144
/*!
145
* Resets the filterbank's filter taps with the new prototype filter
146
* \param taps (vector/list of floats) The prototype filter to populate the filterbank.
147
*/
148
virtual
void
set_taps(
const
std::vector<float> &
taps
) = 0;
149
150
/*!
151
* Print all of the filterbank taps to screen.
152
*/
153
virtual
void
print_taps() = 0;
154
155
/*!
156
* Return a vector<vector<>> of the filterbank taps
157
*/
158
virtual
std::vector<std::vector<float> >
taps
()
const
= 0;
159
160
/*!
161
* Set the channel map. Channels are numbers as:
162
*
163
* N/2+1 | ... | N-1 | 0 | 1 | 2 | ... | N/2
164
* <------------------- 0 -------------------->
165
* freq
166
*
167
* So output stream 0 comes from channel 0, etc. Setting a new
168
* channel map allows the user to specify which channel in frequency
169
* he/she wants to got to which output stream.
170
*
171
* The map should have the same number of elements as the number
172
* of output connections from the block. The minimum value of
173
* the map is 0 (for the 0th channel) and the maximum number is
174
* N-1 where N is the number of channels.
175
*
176
* We specify M as the number of output connections made where M
177
* <= N, so only M out of N channels are driven to an output
178
* stream. The number of items in the channel map should be at
179
* least M long. If there are more channels specified, any value
180
* in the map over M-1 will be ignored. If the size of the map
181
* is less than M the behavior is unknown (we don't wish to
182
* check every entry into the work function).
183
*
184
* This means that if the channelizer is splitting the signal up
185
* into N channels but only M channels are specified in the map
186
* (where M <= N), then M output streams must be connected and
187
* the map and the channel numbers used must be less than
188
* N-1. Output channel number can be reused, too. By default,
189
* the map is [0...M-1] with M = N.
190
*/
191
virtual
void
set_channel_map(
const
std::vector<int> &
map
) = 0;
192
193
/*!
194
* Gets the current channel map.
195
*/
196
virtual
std::vector<int> channel_map()
const
= 0;
197
};
198
199
}
/* namespace filter */
200
}
/* namespace gr */
201
202
#endif
/* INCLUDED_FILTER_PFB_CHANNELIZER_CCF_H */
gr-filter
include
gnuradio
filter
pfb_channelizer_ccf.h
Generated on Wed Oct 2 2013 01:55:46 for GNU Radio 3.7.1 C++ API by
1.8.4