<!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.2.2 C++ API: gr_fir_fff.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('gr__fir__fff_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_fir_fff.h</h1> </div>
</div>
<div class="contents">
<a href="gr__fir__fff_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 2002,2003 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 <span class="comment">/*</span>
<a name="l00024"></a>00024 <span class="comment"> * WARNING: This file is automatically generated by generate_gr_fir_XXX.py</span>
<a name="l00025"></a>00025 <span class="comment"> * Any changes made to this file will be overwritten.</span>
<a name="l00026"></a>00026 <span class="comment"> */</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef INCLUDED_GR_FIR_FFF_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_FIR_FFF_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <vector></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include <gr_reverse.h></span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/*!</span>
<a name="l00037"></a>00037 <span class="comment"> * \brief Abstract class for FIR with float input, float output and float taps</span>
<a name="l00038"></a>00038 <span class="comment"> * \ingroup filter_primitive</span>
<a name="l00039"></a>00039 <span class="comment"> * </span>
<a name="l00040"></a>00040 <span class="comment"> * This is the abstract class for a Finite Impulse Response filter.</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * The trailing suffix has the form _IOT where I codes the input type,</span>
<a name="l00043"></a>00043 <span class="comment"> * O codes the output type, and T codes the tap type.</span>
<a name="l00044"></a>00044 <span class="comment"> * I,O,T are elements of the set 's' (short), 'f' (float), 'c' (gr_complex), 'i' (int)</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046
<a name="l00047"></a><a class="code" href="classgr__fir__fff.html">00047</a> <span class="keyword">class </span><a class="code" href="classgr__fir__fff.html" title="Abstract class for FIR with float input, float output and float tapsThis is the abstract class for a ...">gr_fir_fff</a> {
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">protected</span>:
<a name="l00050"></a><a class="code" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">00050</a> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> <a class="code" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">d_taps</a>; <span class="comment">// reversed taps</span>
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// CONSTRUCTORS</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /*!</span>
<a name="l00057"></a>00057 <span class="comment"> * \brief construct new FIR with given taps.</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * Note that taps must be in forward order, e.g., coefficient 0 is</span>
<a name="l00060"></a>00060 <span class="comment"> * stored in new_taps[0], coefficient 1 is stored in</span>
<a name="l00061"></a>00061 <span class="comment"> * new_taps[1], etc.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="classgr__fir__fff.html#abb048967e21dc9aca56e551ff4042eec">00063</a> <a class="code" href="classgr__fir__fff.html#abb048967e21dc9aca56e551ff4042eec" title="construct new FIR with given taps.">gr_fir_fff</a> () {}
<a name="l00064"></a><a class="code" href="classgr__fir__fff.html#a9f7f901a8030ba8e8940a0c9cd3d795d">00064</a> <a class="code" href="classgr__fir__fff.html#a9f7f901a8030ba8e8940a0c9cd3d795d">gr_fir_fff</a> (<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 class="code" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">d_taps</a> (<a class="code" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse</a>(taps)) {}
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <a class="code" href="classgr__fir__fff.html#acf438d5de004cd0a852358d52d8d1609">~gr_fir_fff</a> ();
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">// MANIPULATORS</span>
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /*!</span>
<a name="l00071"></a>00071 <span class="comment"> * \brief compute a single output value.</span>
<a name="l00072"></a>00072 <span class="comment"> *</span>
<a name="l00073"></a>00073 <span class="comment"> * \p input must have ntaps() valid entries.</span>
<a name="l00074"></a>00074 <span class="comment"> * input[0] .. input[ntaps() - 1] are referenced to compute the output value.</span>
<a name="l00075"></a>00075 <span class="comment"> *</span>
<a name="l00076"></a>00076 <span class="comment"> * \returns the filtered input value.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classgr__fir__fff.html#aea3a56a189c75c3752900d05a5b627d3" title="compute a single output value.">filter</a> (<span class="keyword">const</span> <span class="keywordtype">float</span> input[]) = 0;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /*!</span>
<a name="l00081"></a>00081 <span class="comment"> * \brief compute an array of N output values.</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * \p input must have (n - 1 + ntaps()) valid entries.</span>
<a name="l00084"></a>00084 <span class="comment"> * input[0] .. input[n - 1 + ntaps() - 1] are referenced to compute the output values.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__fir__fff.html#ad53a1e12dd89e647fdbeea37691df85a" title="compute an array of N output values.">filterN</a> (<span class="keywordtype">float</span> output[], <span class="keyword">const</span> <span class="keywordtype">float</span> input[],
<a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n) = 0;
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /*!</span>
<a name="l00090"></a>00090 <span class="comment"> * \brief compute an array of N output values, decimating the input</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * \p input must have (decimate * (n - 1) + ntaps()) valid entries.</span>
<a name="l00093"></a>00093 <span class="comment"> * input[0] .. input[decimate * (n - 1) + ntaps() - 1] are referenced to </span>
<a name="l00094"></a>00094 <span class="comment"> * compute the output values.</span>
<a name="l00095"></a>00095 <span class="comment"> */</span>
<a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__fir__fff.html#a930255550bf68802cd694fe79091738f" title="compute an array of N output values, decimating the input">filterNdec</a> (<span class="keywordtype">float</span> output[], <span class="keyword">const</span> <span class="keywordtype">float</span> input[],
<a name="l00097"></a>00097 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n, <span class="keywordtype">unsigned</span> decimate) = 0;
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /*!</span>
<a name="l00100"></a>00100 <span class="comment"> * \brief install \p new_taps as the current taps.</span>
<a name="l00101"></a>00101 <span class="comment"> */</span>
<a name="l00102"></a><a class="code" href="classgr__fir__fff.html#ad692c67d571c9fdd45a214bac28c38d6">00102</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__fir__fff.html#ad692c67d571c9fdd45a214bac28c38d6" title="install new_taps as the current taps.">set_taps</a> (<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="l00103"></a>00103 {
<a name="l00104"></a>00104 <a class="code" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">d_taps</a> = <a class="code" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse</a>(taps);
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="comment">// ACCESSORS</span>
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> /*!</span>
<a name="l00110"></a>00110 <span class="comment"> * \return number of taps in filter.</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a><a class="code" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">00112</a> <span class="keywordtype">unsigned</span> <a class="code" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">d_taps</a>.size (); }
<a name="l00113"></a>00113 <span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment"> /*!</span>
<a name="l00115"></a>00115 <span class="comment"> * \return current taps</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a><a class="code" href="classgr__fir__fff.html#a4c8fdac7c6d2d3eea81064c7ed5f25e6">00117</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> <a class="code" href="classgr__fir__fff.html#a4c8fdac7c6d2d3eea81064c7ed5f25e6">get_taps</a> ()<span class="keyword"> const</span>
<a name="l00118"></a>00118 <span class="keyword"> </span>{
<a name="l00119"></a>00119 <span class="keywordflow">return</span> <a class="code" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse</a>(<a class="code" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">d_taps</a>);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 };
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_FIR_FFF_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__fir__fff_8h.html">gr_fir_fff.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
4164
