<!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_util.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__util_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_fir_util.h</h1> </div>
</div>
<div class="contents">
<a href="gr__fir__util_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 2003,2004 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</span>
<a name="l00025"></a>00025 <span class="comment"> * generate_gr_fir_util.py.</span>
<a name="l00026"></a>00026 <span class="comment"> *</span>
<a name="l00027"></a>00027 <span class="comment"> * Any changes made to this file will be overwritten.</span>
<a name="l00028"></a>00028 <span class="comment"> */</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef INCLUDED_GR_FIR_UTIL_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_FIR_UTIL_H</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/*!</span>
<a name="l00034"></a>00034 <span class="comment"> * \brief routines to create gr_fir_XXX's</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> * This class handles selecting the fastest version of the finite</span>
<a name="l00037"></a>00037 <span class="comment"> * implulse response filter available for your platform. This</span>
<a name="l00038"></a>00038 <span class="comment"> * interface should be used by the rest of the system for creating</span>
<a name="l00039"></a>00039 <span class="comment"> * gr_fir_XXX's.</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * The trailing suffix has the form _IOT where I codes the input type,</span>
<a name="l00042"></a>00042 <span class="comment"> * O codes the output type, and T codes the tap type.</span>
<a name="l00043"></a>00043 <span class="comment"> * I,O,T are elements of the set 's' (short), 'f' (float), 'c' (gr_complex), </span>
<a name="l00044"></a>00044 <span class="comment"> * 'i' (short)</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="preprocessor">#include <gr_types.h></span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <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 is the abstract cl...">gr_fir_ccf</a>;
<a name="l00050"></a>00050 <span class="keyword">class </span><a class="code" href="classgr__fir__fcc.html" title="Abstract class for FIR with float input, gr_complex output and gr_complex tapsThis is the abstract cl...">gr_fir_fcc</a>;
<a name="l00051"></a>00051 <span class="keyword">class </span><a class="code" href="classgr__fir__ccc.html" title="Abstract class for FIR with gr_complex input, gr_complex output and gr_complex tapsThis is the abstra...">gr_fir_ccc</a>;
<a name="l00052"></a>00052 <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="l00053"></a>00053 <span class="keyword">class </span><a class="code" href="classgr__fir__scc.html" title="Abstract class for FIR with short input, gr_complex output and gr_complex tapsThis is the abstract cl...">gr_fir_scc</a>;
<a name="l00054"></a>00054 <span class="keyword">class </span><a class="code" href="classgr__fir__fsf.html" title="Abstract class for FIR with float input, short output and float tapsThis is the abstract class for a ...">gr_fir_fsf</a>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">// structures returned by get_gr_fir_XXX_info methods</span>
<a name="l00057"></a>00057
<a name="l00058"></a>00058
<a name="l00059"></a><a class="code" href="structgr__fir__ccf__info.html">00059</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__ccf__info.html">gr_fir_ccf_info</a> {
<a name="l00060"></a><a class="code" href="structgr__fir__ccf__info.html#ab93b6a691673ce2c26d3c5584d70d250">00060</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgr__fir__ccf__info.html#ab93b6a691673ce2c26d3c5584d70d250">name</a>; <span class="comment">// implementation name, e.g., "generic", "SSE", "3DNow!"</span>
<a name="l00061"></a><a class="code" href="structgr__fir__ccf__info.html#ac1590d8a50eaf9c4fd7ff30e9bc90a4e">00061</a> <a class="code" href="classgr__fir__ccf.html" title="Abstract class for FIR with gr_complex input, gr_complex output and float tapsThis is the abstract cl...">gr_fir_ccf</a> *(*create)(<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="l00062"></a>00062 };
<a name="l00063"></a>00063
<a name="l00064"></a><a class="code" href="structgr__fir__fcc__info.html">00064</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__fcc__info.html">gr_fir_fcc_info</a> {
<a name="l00065"></a><a class="code" href="structgr__fir__fcc__info.html#abcbedaa9197808529b49cc864da0631b">00065</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgr__fir__fcc__info.html#abcbedaa9197808529b49cc864da0631b">name</a>; <span class="comment">// implementation name, e.g., "generic", "SSE", "3DNow!"</span>
<a name="l00066"></a><a class="code" href="structgr__fir__fcc__info.html#a3a606c7a0d8902eed93c2c31d1cd5d5a">00066</a> <a class="code" href="classgr__fir__fcc.html" title="Abstract class for FIR with float input, gr_complex output and gr_complex tapsThis is the abstract cl...">gr_fir_fcc</a> *(*create)(<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<gr_complex></a> &<a class="code" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>);
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a><a class="code" href="structgr__fir__ccc__info.html">00069</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__ccc__info.html">gr_fir_ccc_info</a> {
<a name="l00070"></a><a class="code" href="structgr__fir__ccc__info.html#a9a4427fec75c88c6e32e54cde9ffc035">00070</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgr__fir__ccc__info.html#a9a4427fec75c88c6e32e54cde9ffc035">name</a>; <span class="comment">// implementation name, e.g., "generic", "SSE", "3DNow!"</span>
<a name="l00071"></a><a class="code" href="structgr__fir__ccc__info.html#ad142ed96680c92893b4bfa94c89bcab7">00071</a> <a class="code" href="classgr__fir__ccc.html" title="Abstract class for FIR with gr_complex input, gr_complex output and gr_complex tapsThis is the abstra...">gr_fir_ccc</a> *(*create)(<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<gr_complex></a> &<a class="code" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>);
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073
<a name="l00074"></a><a class="code" href="structgr__fir__fff__info.html">00074</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__fff__info.html">gr_fir_fff_info</a> {
<a name="l00075"></a><a class="code" href="structgr__fir__fff__info.html#a56f138dcab8baa0a1a66d986a9793bf7">00075</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgr__fir__fff__info.html#a56f138dcab8baa0a1a66d986a9793bf7">name</a>; <span class="comment">// implementation name, e.g., "generic", "SSE", "3DNow!"</span>
<a name="l00076"></a><a class="code" href="structgr__fir__fff__info.html#adaf6c12946519d91dd8224c530225c9a">00076</a> <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> *(*create)(<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="l00077"></a>00077 };
<a name="l00078"></a>00078
<a name="l00079"></a><a class="code" href="structgr__fir__scc__info.html">00079</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__scc__info.html">gr_fir_scc_info</a> {
<a name="l00080"></a><a class="code" href="structgr__fir__scc__info.html#a9dfd54f0ce1cb7a98f1d35e90796e3d9">00080</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgr__fir__scc__info.html#a9dfd54f0ce1cb7a98f1d35e90796e3d9">name</a>; <span class="comment">// implementation name, e.g., "generic", "SSE", "3DNow!"</span>
<a name="l00081"></a><a class="code" href="structgr__fir__scc__info.html#a8fd5175063394a503dd3e7973d8cb428">00081</a> <a class="code" href="classgr__fir__scc.html" title="Abstract class for FIR with short input, gr_complex output and gr_complex tapsThis is the abstract cl...">gr_fir_scc</a> *(*create)(<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<gr_complex></a> &<a class="code" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>);
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083
<a name="l00084"></a><a class="code" href="structgr__fir__fsf__info.html">00084</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__fsf__info.html">gr_fir_fsf_info</a> {
<a name="l00085"></a><a class="code" href="structgr__fir__fsf__info.html#a11f1c7598d7e0aabfdafd4a819737a7e">00085</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgr__fir__fsf__info.html#a11f1c7598d7e0aabfdafd4a819737a7e">name</a>; <span class="comment">// implementation name, e.g., "generic", "SSE", "3DNow!"</span>
<a name="l00086"></a><a class="code" href="structgr__fir__fsf__info.html#a04583a831e8b40fae941eac7cd9e32b8">00086</a> <a class="code" href="classgr__fir__fsf.html" title="Abstract class for FIR with float input, short output and float tapsThis is the abstract class for a ...">gr_fir_fsf</a> *(*create)(<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="l00087"></a>00087 };
<a name="l00088"></a>00088
<a name="l00089"></a><a class="code" href="structgr__fir__util.html">00089</a> <span class="keyword">struct </span><a class="code" href="structgr__fir__util.html">gr_fir_util</a> {
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="comment">// create a fast version of gr_fir_XXX.</span>
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keyword">static</span> <a class="code" href="classgr__fir__ccf.html" title="Abstract class for FIR with gr_complex input, gr_complex output and float tapsThis is the abstract cl...">gr_fir_ccf</a> *<a class="code" href="structgr__fir__util.html#ab9a003f4a74006ae1237628455cb1c25">create_gr_fir_ccf</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="l00094"></a>00094 <span class="keyword">static</span> <a class="code" href="classgr__fir__fcc.html" title="Abstract class for FIR with float input, gr_complex output and gr_complex tapsThis is the abstract cl...">gr_fir_fcc</a> *<a class="code" href="structgr__fir__util.html#a299491e5c5ed72cd09e3030f520785bf">create_gr_fir_fcc</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<gr_complex></a> &taps);
<a name="l00095"></a>00095 <span class="keyword">static</span> <a class="code" href="classgr__fir__ccc.html" title="Abstract class for FIR with gr_complex input, gr_complex output and gr_complex tapsThis is the abstra...">gr_fir_ccc</a> *<a class="code" href="structgr__fir__util.html#abaa4190ad22e8cdf3b18c4dab635ce6b">create_gr_fir_ccc</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<gr_complex></a> &taps);
<a name="l00096"></a>00096 <span class="keyword">static</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 class="code" href="structgr__fir__util.html#a057383eb6bb853345ff6016249669b1b">create_gr_fir_fff</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &taps);
<a name="l00097"></a>00097 <span class="keyword">static</span> <a class="code" href="classgr__fir__scc.html" title="Abstract class for FIR with short input, gr_complex output and gr_complex tapsThis is the abstract cl...">gr_fir_scc</a> *<a class="code" href="structgr__fir__util.html#a824fbdc6aba9d6ef0d41cb44841d1968">create_gr_fir_scc</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<gr_complex></a> &taps);
<a name="l00098"></a>00098 <span class="keyword">static</span> <a class="code" href="classgr__fir__fsf.html" title="Abstract class for FIR with float input, short output and float tapsThis is the abstract class for a ...">gr_fir_fsf</a> *<a class="code" href="structgr__fir__util.html#a8be127aabfe4a4ad65cb246a295455d6">create_gr_fir_fsf</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &taps);
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">// Get information about all gr_fir_XXX implementations.</span>
<a name="l00101"></a>00101 <span class="comment">// This is useful for benchmarking, testing, etc without having to</span>
<a name="l00102"></a>00102 <span class="comment">// know a priori what's linked into this image</span>
<a name="l00103"></a>00103 <span class="comment">//</span>
<a name="l00104"></a>00104 <span class="comment">// The caller must pass in a valid pointer to a vector.</span>
<a name="l00105"></a>00105 <span class="comment">// The vector will be filled with structs describing the</span>
<a name="l00106"></a>00106 <span class="comment">// available implementations.</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structgr__fir__util.html#aed7ed65d1dea75b4ceb82a1e4dff8f0e">get_gr_fir_ccf_info</a> (<a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_fir_ccf_info></a> *info);
<a name="l00109"></a>00109 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structgr__fir__util.html#aeab7aa6fc0cac7d172ffc26221a1a0c8">get_gr_fir_fcc_info</a> (<a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_fir_fcc_info></a> *info);
<a name="l00110"></a>00110 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structgr__fir__util.html#a4544120bf730d571ac3e5e041b5232b7">get_gr_fir_ccc_info</a> (<a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_fir_ccc_info></a> *info);
<a name="l00111"></a>00111 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structgr__fir__util.html#afb24714a3c670b9158a5fac03d23ca57">get_gr_fir_fff_info</a> (<a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_fir_fff_info></a> *info);
<a name="l00112"></a>00112 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structgr__fir__util.html#a47d290c0e92b83ce677a013331603ad9">get_gr_fir_scc_info</a> (<a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_fir_scc_info></a> *info);
<a name="l00113"></a>00113 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structgr__fir__util.html#a235f00cd94b5318aa06846b46a3025e2">get_gr_fir_fsf_info</a> (<a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_fir_fsf_info></a> *info);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_FIR_UTIL_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__fir__util_8h.html">gr_fir_util.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
>
4312
