<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.3.0 C++ API: gr_pfb_channelizer_ccf.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<h1>gr_pfb_channelizer_ccf.h</h1><a href="gr__pfb__channelizer__ccf_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2009,2010 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef INCLUDED_GR_PFB_CHANNELIZER_CCF_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_PFB_CHANNELIZER_CCF_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="gr__block_8h.html">gr_block.h</a>></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classgr__pfb__channelizer__ccf.html" title="Polyphase filterbank channelizer with gr_complex input, gr_complex output and float...">gr_pfb_channelizer_ccf</a>;
<a name="l00030"></a>00030 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_pfb_channelizer_ccf></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_pfb_channelizer_ccf_sptr</a>;
<a name="l00031"></a>00031 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_pfb_channelizer_ccf_sptr</a> <a class="code" href="gr__pfb__channelizer__ccf_8h.html#ab28944268ebe62b6b7e08d6fb0c9c353">gr_make_pfb_channelizer_ccf</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numchans,
<a name="l00032"></a>00032 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &<a class="code" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>,
<a name="l00033"></a>00033 <span class="keywordtype">float</span> oversample_rate=1);
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classgr__fir__ccf.html" title="Abstract class for FIR with gr_complex input, gr_complex output and float tapsThis...">gr_fir_ccf</a>;
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classgri__fft__complex.html" title="FFT: complex in, complex out.">gri_fft_complex</a>;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">/*!</span>
<a name="l00040"></a>00040 <span class="comment"> * \class gr_pfb_channelizer_ccf</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * \brief Polyphase filterbank channelizer with </span>
<a name="l00043"></a>00043 <span class="comment"> * gr_complex input, gr_complex output and float taps</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * \ingroup filter_blk</span>
<a name="l00046"></a>00046 <span class="comment"> *</span>
<a name="l00047"></a>00047 <span class="comment"> * This block takes in complex inputs and channelizes it to <EM>M</EM></span>
<a name="l00048"></a>00048 <span class="comment"> * channels of equal bandwidth. Each of the resulting channels is</span>
<a name="l00049"></a>00049 <span class="comment"> * decimated to the new rate that is the input sampling rate</span>
<a name="l00050"></a>00050 <span class="comment"> * <EM>fs</EM> divided by the number of channels, <EM>M</EM>.</span>
<a name="l00051"></a>00051 <span class="comment"> *</span>
<a name="l00052"></a>00052 <span class="comment"> * The PFB channelizer code takes the taps generated above and builds</span>
<a name="l00053"></a>00053 <span class="comment"> * a set of filters. The set contains <EM>M</EM> number of filters</span>
<a name="l00054"></a>00054 <span class="comment"> * and each filter contains ceil(taps.size()/decim) number of taps.</span>
<a name="l00055"></a>00055 <span class="comment"> * Each tap from the filter prototype is sequentially inserted into</span>
<a name="l00056"></a>00056 <span class="comment"> * the next filter. When all of the input taps are used, the remaining</span>
<a name="l00057"></a>00057 <span class="comment"> * filters in the filterbank are filled out with 0's to make sure each</span>
<a name="l00058"></a>00058 <span class="comment"> * filter has the same number of taps.</span>
<a name="l00059"></a>00059 <span class="comment"> *</span>
<a name="l00060"></a>00060 <span class="comment"> * Each filter operates using the gr_fir filter classs of GNU Radio,</span>
<a name="l00061"></a>00061 <span class="comment"> * which takes the input stream at <EM>i</EM> and performs the inner</span>
<a name="l00062"></a>00062 <span class="comment"> * product calculation to <EM>i+(n-1)</EM> where <EM>n</EM> is the</span>
<a name="l00063"></a>00063 <span class="comment"> * number of filter taps. To efficiently handle this in the GNU Radio</span>
<a name="l00064"></a>00064 <span class="comment"> * structure, each filter input must come from its own input</span>
<a name="l00065"></a>00065 <span class="comment"> * stream. So the channelizer must be provided with <EM>M</EM> streams</span>
<a name="l00066"></a>00066 <span class="comment"> * where the input stream has been deinterleaved. This is most easily</span>
<a name="l00067"></a>00067 <span class="comment"> * done using the gr_stream_to_streams block.</span>
<a name="l00068"></a>00068 <span class="comment"> *</span>
<a name="l00069"></a>00069 <span class="comment"> * The output is then produced as a vector, where index <EM>i</EM> in</span>
<a name="l00070"></a>00070 <span class="comment"> * the vector is the next sample from the <EM>i</EM>th channel. This</span>
<a name="l00071"></a>00071 <span class="comment"> * is most easily handled by sending the output to a</span>
<a name="l00072"></a>00072 <span class="comment"> * gr_vector_to_streams block to handle the conversion and passing</span>
<a name="l00073"></a>00073 <span class="comment"> * <EM>M</EM> streams out.</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> * The input and output formatting is done using a hier_block2 called</span>
<a name="l00076"></a>00076 <span class="comment"> * pfb_channelizer_ccf. This can take in a single stream and outputs</span>
<a name="l00077"></a>00077 <span class="comment"> * <EM>M</EM> streams based on the behavior described above.</span>
<a name="l00078"></a>00078 <span class="comment"> *</span>
<a name="l00079"></a>00079 <span class="comment"> * The filter's taps should be based on the input sampling rate.</span>
<a name="l00080"></a>00080 <span class="comment"> *</span>
<a name="l00081"></a>00081 <span class="comment"> * For example, using the GNU Radio's firdes utility to building</span>
<a name="l00082"></a>00082 <span class="comment"> * filters, we build a low-pass filter with a sampling rate of </span>
<a name="l00083"></a>00083 <span class="comment"> * <EM>fs</EM>, a 3-dB bandwidth of <EM>BW</EM> and a transition</span>
<a name="l00084"></a>00084 <span class="comment"> * bandwidth of <EM>TB</EM>. We can also specify the out-of-band</span>
<a name="l00085"></a>00085 <span class="comment"> * attenuation to use, <EM>ATT</EM>, and the filter window</span>
<a name="l00086"></a>00086 <span class="comment"> * function (a Blackman-harris window in this case). The first input</span>
<a name="l00087"></a>00087 <span class="comment"> * is the gain of the filter, which we specify here as unity.</span>
<a name="l00088"></a>00088 <span class="comment"> *</span>
<a name="l00089"></a>00089 <span class="comment"> * <B><EM>self._taps = gr.firdes.low_pass_2(1, fs, BW, TB, </span>
<a name="l00090"></a>00090 <span class="comment"> * attenuation_dB=ATT, window=gr.firdes.WIN_BLACKMAN_hARRIS)</EM></B></span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * The filter output can also be overs ampled. The over sampling rate </span>
<a name="l00093"></a>00093 <span class="comment"> * is the ratio of the the actual output sampling rate to the normal </span>
<a name="l00094"></a>00094 <span class="comment"> * output sampling rate. It must be rationally related to the number </span>
<a name="l00095"></a>00095 <span class="comment"> * of channels as N/i for i in [1,N], which gives an outputsample rate</span>
<a name="l00096"></a>00096 <span class="comment"> * of [fs/N, fs] where fs is the input sample rate and N is the number</span>
<a name="l00097"></a>00097 <span class="comment"> * of channels.</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * For example, for 6 channels with fs = 6000 Hz, the normal rate is </span>
<a name="l00100"></a>00100 <span class="comment"> * 6000/6 = 1000 Hz. Allowable oversampling rates are 6/6, 6/5, 6/4, </span>
<a name="l00101"></a>00101 <span class="comment"> * 6/3, 6/2, and 6/1 where the output sample rate of a 6/1 oversample</span>
<a name="l00102"></a>00102 <span class="comment"> * ratio is 6000 Hz, or 6 times the normal 1000 Hz. A rate of 6/5 = 1.2,</span>
<a name="l00103"></a>00103 <span class="comment"> * so the output rate would be 1200 Hz.</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> * The theory behind this block can be found in Chapter 6 of </span>
<a name="l00106"></a>00106 <span class="comment"> * the following book.</span>
<a name="l00107"></a>00107 <span class="comment"> *</span>
<a name="l00108"></a>00108 <span class="comment"> * <B><EM>f. harris, "Multirate Signal Processing for Communication </span>
<a name="l00109"></a>00109 <span class="comment"> * Systems," Upper Saddle River, NJ: Prentice Hall, Inc. 2004.</EM></B></span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112
<a name="l00113"></a><a class="code" href="classgr__pfb__channelizer__ccf.html">00113</a> <span class="keyword">class </span><a class="code" href="classgr__pfb__channelizer__ccf.html" title="Polyphase filterbank channelizer with gr_complex input, gr_complex output and float...">gr_pfb_channelizer_ccf</a> : <span class="keyword">public</span> <a class="code" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing...">gr_block</a>
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /*!</span>
<a name="l00117"></a>00117 <span class="comment"> * Build the polyphase filterbank decimator.</span>
<a name="l00118"></a>00118 <span class="comment"> * \param numchans (unsigned integer) Specifies the number of channels <EM>M</EM></span>
<a name="l00119"></a>00119 <span class="comment"> * \param taps (vector/list of floats) The prototype filter to populate the filterbank.</span>
<a name="l00120"></a>00120 <span class="comment"> * \param oversample_rate (float) The over sampling rate is the ratio of the the actual</span>
<a name="l00121"></a>00121 <span class="comment"> * output sampling rate to the normal output sampling rate.</span>
<a name="l00122"></a>00122 <span class="comment"> * It must be rationally related to the number of channels</span>
<a name="l00123"></a>00123 <span class="comment"> * as N/i for i in [1,N], which gives an outputsample rate </span>
<a name="l00124"></a>00124 <span class="comment"> * of [fs/N, fs] where fs is the input sample rate and N is</span>
<a name="l00125"></a>00125 <span class="comment"> * the number of channels.</span>
<a name="l00126"></a>00126 <span class="comment"> * </span>
<a name="l00127"></a>00127 <span class="comment"> * For example, for 6 channels with fs = 6000 Hz, the normal</span>
<a name="l00128"></a>00128 <span class="comment"> * rate is 6000/6 = 1000 Hz. Allowable oversampling rates</span>
<a name="l00129"></a>00129 <span class="comment"> * are 6/6, 6/5, 6/4, 6/3, 6/2, and 6/1 where the output</span>
<a name="l00130"></a>00130 <span class="comment"> * sample rate of a 6/1 oversample ratio is 6000 Hz, or</span>
<a name="l00131"></a>00131 <span class="comment"> * 6 times the normal 1000 Hz.</span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a>00133 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_pfb_channelizer_ccf_sptr</a> <a class="code" href="classgr__pfb__channelizer__ccf.html#a3395f48e0576b9a4812133ccafdd4f4f">gr_make_pfb_channelizer_ccf</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numchans,
<a name="l00134"></a>00134 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &<a class="code" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>,
<a name="l00135"></a>00135 <span class="keywordtype">float</span> oversample_rate);
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> d_updated;
<a name="l00138"></a>00138 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_numchans;
<a name="l00139"></a>00139 <span class="keywordtype">float</span> d_oversample_rate;
<a name="l00140"></a>00140 <a class="code" href="classstd_1_1vector.html">std::vector<gr_fir_ccf*></a> d_filters;
<a name="l00141"></a>00141 <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector< std::vector<float></a> > d_taps;
<a name="l00142"></a>00142 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_taps_per_filter;
<a name="l00143"></a>00143 <a class="code" href="classgri__fft__complex.html" title="FFT: complex in, complex out.">gri_fft_complex</a> *d_fft;
<a name="l00144"></a>00144 <span class="keywordtype">int</span> *d_idxlut;
<a name="l00145"></a>00145 <span class="keywordtype">int</span> d_rate_ratio;
<a name="l00146"></a>00146 <span class="keywordtype">int</span> d_output_multiple;
<a name="l00147"></a>00147 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment"> /*!</span>
<a name="l00149"></a>00149 <span class="comment"> * Build the polyphase filterbank decimator.</span>
<a name="l00150"></a>00150 <span class="comment"> * \param numchans (unsigned integer) Specifies the number of channels <EM>M</EM></span>
<a name="l00151"></a>00151 <span class="comment"> * \param taps (vector/list of floats) The prototype filter to populate the filterbank.</span>
<a name="l00152"></a>00152 <span class="comment"> * \param oversample_rate (float) The output over sampling rate.</span>
<a name="l00153"></a>00153 <span class="comment"> */</span>
<a name="l00154"></a>00154 <a class="code" href="classgr__pfb__channelizer__ccf.html" title="Polyphase filterbank channelizer with gr_complex input, gr_complex output and float...">gr_pfb_channelizer_ccf</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numchans,
<a name="l00155"></a>00155 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &taps,
<a name="l00156"></a>00156 <span class="keywordtype">float</span> oversample_rate);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">public</span>:
<a name="l00159"></a>00159 <a class="code" href="classgr__pfb__channelizer__ccf.html#a25b8a4dfdc76343c59ce6ea0e992cd98">~gr_pfb_channelizer_ccf</a> ();
<a name="l00160"></a>00160 <span class="comment"></span>
<a name="l00161"></a>00161 <span class="comment"> /*!</span>
<a name="l00162"></a>00162 <span class="comment"> * Resets the filterbank's filter taps with the new prototype filter</span>
<a name="l00163"></a>00163 <span class="comment"> * \param taps (vector/list of floats) The prototype filter to populate the filterbank.</span>
<a name="l00164"></a>00164 <span class="comment"> */</span>
<a name="l00165"></a>00165 <span class="keywordtype">void</span> <a class="code" href="classgr__pfb__channelizer__ccf.html#ac04a9e2ffc2815d12dc528174c7d9b5f">set_taps</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &taps);
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment"> /*!</span>
<a name="l00168"></a>00168 <span class="comment"> * Print all of the filterbank taps to screen.</span>
<a name="l00169"></a>00169 <span class="comment"> */</span>
<a name="l00170"></a>00170 <span class="keywordtype">void</span> <a class="code" href="classgr__pfb__channelizer__ccf.html#a1a399210c8b4fcb23b4a6226e2c790f6">print_taps</a>();
<a name="l00171"></a>00171
<a name="l00172"></a>00172 <span class="keywordtype">int</span> <a class="code" href="classgr__pfb__channelizer__ccf.html#a0e6a3d7ca55379a57877462595e2eab4" title="compute output items from input items">general_work</a> (<span class="keywordtype">int</span> noutput_items,
<a name="l00173"></a>00173 <a class="code" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items,
<a name="l00174"></a>00174 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00175"></a>00175 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00176"></a>00176 };
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:51:00 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
