<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: pfb_interpolator_ccf.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('pfb__interpolator__ccf_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">pfb_interpolator_ccf.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="pfb__interpolator__ccf_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2009,2012 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef INCLUDED_PFB_INTERPOLATOR_CCF_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_PFB_INTERPOLATOR_CCF_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="gr-filter_2include_2filter_2api_8h.html">filter/api.h</a>></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="gr__sync__interpolator_8h.html">gr_sync_interpolator.h</a>></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>gr {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">namespace </span>filter {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * \class gr_pfb_interpolator_ccf</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * \brief Polyphase filterbank interpolator with gr_complex input,</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * gr_complex output and float taps</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * \ingroup filter_blk</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * \ingroup pfb_blk</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * This block takes in a signal stream and performs interger up-</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * sampling (interpolation) with a polyphase filterbank. The first</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * input is the integer specifying how much to interpolate by. The</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * second input is a vector (Python list) of floating-point taps</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * of the prototype filter.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * The filter's taps should be based on the interpolation rate</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * specified. That is, the bandwidth specified is relative to the</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * bandwidth after interpolation.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * For example, using the GNU Radio's firdes utility to building</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * filters, we build a low-pass filter with a sampling rate of</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * <EM>fs</EM>, a 3-dB bandwidth of <EM>BW</EM> and a transition</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * bandwidth of <EM>TB</EM>. We can also specify the out-of-band</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * attenuation to use, ATT, and the filter window function (a</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * Blackman-harris window in this case). The first input is the</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * gain, which is also specified as the interpolation rate so that</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * the output levels are the same as the input (this creates an</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * overall increase in power).</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * <B><EM>self._taps = filter.firdes.low_pass_2(interp, interp*fs, BW, TB,</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * attenuation_dB=ATT, window=filter.firdes.WIN_BLACKMAN_hARRIS)</EM></B></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * The PFB interpolator code takes the taps generated above and</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * builds a set of filters. The set contains <EM>interp</EM></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * number of filters and each filter contains</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * ceil(taps.size()/interp) number of taps. Each tap from the</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * filter prototype is sequentially inserted into the next</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * filter. When all of the input taps are used, the remaining</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * filters in the filterbank are filled out with 0's to make sure</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * each filter has the same number of taps.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * The theory behind this block can be found in Chapter 7.1 of the</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * following book.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * <B><EM>f. harris, "Multirate Signal Processing for Communication</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * Systems</EM>," Upper Saddle River, NJ: Prentice Hall,</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * Inc. 2004.</EM></B></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="classgr_1_1filter_1_1pfb__interpolator__ccf.html"> 82</a></span>  <span class="keyword">class </span><a class="code" href="gr-filter_2include_2filter_2api_8h.html#a7d33c890adb08fbd7c1c524f2c889357">FILTER_API</a> <a class="code" href="classgr_1_1filter_1_1pfb__interpolator__ccf.html">pfb_interpolator_ccf</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> <a class="code" href="classgr__sync__interpolator.html" title="synchronous 1:N input to output with historyOverride work to provide the signal processing implementa...">gr_sync_interpolator</a></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// gr::filter::pfb_interpolator_ccf::sptr</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="classgr_1_1filter_1_1pfb__interpolator__ccf.html#a19815b1e0036185552b87230411b1c17"> 86</a></span>  <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<pfb_interpolator_ccf></a> <a class="code" href="classgr_1_1filter_1_1pfb__interpolator__ccf.html#a19815b1e0036185552b87230411b1c17">sptr</a>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * Build the polyphase filterbank interpolator.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * \param interp (unsigned integer) Specifies the interpolation rate to use</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * \param taps (vector/list of floats) The prototype filter to populate the filterbank. The taps</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * should be generated at the interpolated sampling rate.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">sptr</a> make(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> interp,</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> std::vector<float> &<a class="code" href="gnuradio-core_2src_2lib_2filter_2interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * Resets the filterbank's filter taps with the new prototype filter</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * \param taps (vector/list of floats) The prototype filter to populate the filterbank.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * The taps should be generated at the interpolated sampling rate.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_taps(<span class="keyword">const</span> std::vector<float> &<a class="code" href="gnuradio-core_2src_2lib_2filter_2interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>) = 0;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * Return a vector<vector<>> of the filterbank taps</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">virtual</span> std::vector<std::vector<float> > <a class="code" href="gnuradio-core_2src_2lib_2filter_2interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * Print all of the filterbank taps to screen.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> print_taps() = 0;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  };</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  } <span class="comment">/* namespace filter */</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> } <span class="comment">/* namespace gr */</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_FILTER_PFB_INTERPOLATOR_CCF_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3f33597fffd4cc01c99a86c5ab449d3c.html">gr-filter</a></li><li class="navelem"><a class="el" href="dir_382713beb7809954946194edda5b9aad.html">include</a></li><li class="navelem"><a class="el" href="dir_18ddda2d757c5ba1017f435442d72dc1.html">filter</a></li><li class="navelem"><a class="el" href="pfb__interpolator__ccf_8h.html">pfb_interpolator_ccf.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
