<!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_fsf Class Reference</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('classgr__fir__fsf.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>gr_fir_fsf Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_fir_fsf" -->
<p>Abstract class for FIR with float input, short output and float tapsThis is the abstract class for a Finite Impulse Response filter.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__fir__fsf_8h_source.html">gr_fir_fsf.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_fir_fsf:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__fir__fsf__inherit__graph.png" border="0" usemap="#gr__fir__fsf_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__fir__fsf_inherit__map" id="gr__fir__fsf_inherit__map">
<area shape="rect" id="node3" href="classgr__fir__fsf__generic.html" title="Concrete class for generic implementation of FIR with float input, short output and float taps..." alt="" coords="69,83,192,112"/><area shape="rect" id="node5" href="classgr__fir__fsf__simd.html" title="common base class for SIMD versions of gr_fir_fsfThis base class handles alignment issues common to S..." alt="" coords="77,160,184,189"/><area shape="rect" id="node7" href="classgr__fir__fsf__3dnow.html" title="3DNow! version of gr_fir_fsf" alt="" coords="5,237,123,267"/><area shape="rect" id="node9" href="classgr__fir__fsf__sse.html" title="SSE version of gr_fir_fsf." alt="" coords="147,237,248,267"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__fir__fsf-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#af2b781c4ecca64a3a5315dfe6e10a62f">gr_fir_fsf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">construct new FIR with given taps. <a href="#af2b781c4ecca64a3a5315dfe6e10a62f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#a58226fbee4ba0994918afe687343f548">gr_fir_fsf</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#a711d702cf671f00754acd74813d38c4d">~gr_fir_fsf</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual short </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#a72d4b9fb5669d54e826b506a288c3b12">filter</a> (const float input[])=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute a single output value. <a href="#a72d4b9fb5669d54e826b506a288c3b12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#a40b807639ff338eea553e9cfbe5b7852">filterN</a> (short output[], const float input[], unsigned long n)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute an array of N output values. <a href="#a40b807639ff338eea553e9cfbe5b7852"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#abaa7da67d2c6484fcbf5c509b21794ed">filterNdec</a> (short output[], const float input[], unsigned long n, unsigned decimate)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute an array of N output values, decimating the input <a href="#abaa7da67d2c6484fcbf5c509b21794ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#adc6959598abe050fe195c2202fc6c521">set_taps</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">install <code>new_taps</code> as the current taps. <a href="#adc6959598abe050fe195c2202fc6c521"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#ae6dcb8e0d14dd3fe98459f76d1b329c9">get_taps</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf.html#a4cd04bb59ee2ab71a3b470ead188d101">d_taps</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class for FIR with float input, short output and float taps</p>
<p>This is the abstract class for a Finite Impulse Response filter. </p>
<p>The trailing suffix has the form _IOT where I codes the input type, O codes the output type, and T codes the tap type. I,O,T are elements of the set 's' (short), 'f' (float), 'c' (gr_complex), 'i' (int) </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af2b781c4ecca64a3a5315dfe6e10a62f"></a><!-- doxytag: member="gr_fir_fsf::gr_fir_fsf" ref="af2b781c4ecca64a3a5315dfe6e10a62f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_fir_fsf::gr_fir_fsf </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>construct new FIR with given taps. </p>
<p>Note that taps must be in forward order, e.g., coefficient 0 is stored in new_taps[0], coefficient 1 is stored in new_taps[1], etc. </p>
</div>
</div>
<a class="anchor" id="a58226fbee4ba0994918afe687343f548"></a><!-- doxytag: member="gr_fir_fsf::gr_fir_fsf" ref="a58226fbee4ba0994918afe687343f548" args="(const std::vector< float > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_fir_fsf::gr_fir_fsf </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td>
<td class="paramname"><em>taps</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a711d702cf671f00754acd74813d38c4d"></a><!-- doxytag: member="gr_fir_fsf::~gr_fir_fsf" ref="a711d702cf671f00754acd74813d38c4d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_fir_fsf::~gr_fir_fsf </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a72d4b9fb5669d54e826b506a288c3b12"></a><!-- doxytag: member="gr_fir_fsf::filter" ref="a72d4b9fb5669d54e826b506a288c3b12" args="(const float input[])=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual short gr_fir_fsf::filter </td>
<td>(</td>
<td class="paramtype">const float </td>
<td class="paramname"><em>input</em>[]</td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compute a single output value. </p>
<p><code>input</code> must have <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> valid entries. input[0] .. input[<a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> - 1] are referenced to compute the output value.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the filtered input value. </dd></dl>
<p>Implemented in <a class="el" href="classgr__fir__fsf__generic.html#a8a88649387d44e24b3c2ab7033087f82">gr_fir_fsf_generic</a>, and <a class="el" href="classgr__fir__fsf__simd.html#a9b221f60ff010490358eed5e39bc9673">gr_fir_fsf_simd</a>.</p>
</div>
</div>
<a class="anchor" id="a40b807639ff338eea553e9cfbe5b7852"></a><!-- doxytag: member="gr_fir_fsf::filterN" ref="a40b807639ff338eea553e9cfbe5b7852" args="(short output[], const float input[], unsigned long n)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_fsf::filterN </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"><em>output</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float </td>
<td class="paramname"><em>input</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compute an array of N output values. </p>
<p><code>input</code> must have (n - 1 + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a>) valid entries. input[0] .. input[n - 1 + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> - 1] are referenced to compute the output values. </p>
<p>Implemented in <a class="el" href="classgr__fir__fsf__generic.html#a5a22acd8dae47ae1bc008198ffa68b5e">gr_fir_fsf_generic</a>.</p>
</div>
</div>
<a class="anchor" id="abaa7da67d2c6484fcbf5c509b21794ed"></a><!-- doxytag: member="gr_fir_fsf::filterNdec" ref="abaa7da67d2c6484fcbf5c509b21794ed" args="(short output[], const float input[], unsigned long n, unsigned decimate)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_fsf::filterNdec </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"><em>output</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float </td>
<td class="paramname"><em>input</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>decimate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compute an array of N output values, decimating the input </p>
<p><code>input</code> must have (decimate * (n - 1) + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a>) valid entries. input[0] .. input[decimate * (n - 1) + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> - 1] are referenced to compute the output values. </p>
<p>Implemented in <a class="el" href="classgr__fir__fsf__generic.html#a4893ed68bbc23906e76e5094b50ffbbf">gr_fir_fsf_generic</a>.</p>
</div>
</div>
<a class="anchor" id="ae6dcb8e0d14dd3fe98459f76d1b329c9"></a><!-- doxytag: member="gr_fir_fsf::get_taps" ref="ae6dcb8e0d14dd3fe98459f76d1b329c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classstd_1_1vector.html">std::vector</a><float> gr_fir_fsf::get_taps </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>current taps </dd></dl>
<p>References <a class="el" href="classgr__fir__fsf.html#a4cd04bb59ee2ab71a3b470ead188d101">d_taps</a>, and <a class="el" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a695ea61ff30c7b9c196571834002da46"></a><!-- doxytag: member="gr_fir_fsf::ntaps" ref="a695ea61ff30c7b9c196571834002da46" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_fir_fsf::ntaps </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>number of taps in filter. </dd></dl>
<p>References <a class="el" href="classgr__fir__fsf.html#a4cd04bb59ee2ab71a3b470ead188d101">d_taps</a>.</p>
</div>
</div>
<a class="anchor" id="adc6959598abe050fe195c2202fc6c521"></a><!-- doxytag: member="gr_fir_fsf::set_taps" ref="adc6959598abe050fe195c2202fc6c521" args="(const std::vector< float > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_fsf::set_taps </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td>
<td class="paramname"><em>taps</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>install <code>new_taps</code> as the current taps. </p>
<p>Reimplemented in <a class="el" href="classgr__fir__fsf__simd.html#a73c1e774c165feec6b4e16123d4d83b4">gr_fir_fsf_simd</a>.</p>
<p>References <a class="el" href="classgr__fir__fsf.html#a4cd04bb59ee2ab71a3b470ead188d101">d_taps</a>, and <a class="el" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a4cd04bb59ee2ab71a3b470ead188d101"></a><!-- doxytag: member="gr_fir_fsf::d_taps" ref="a4cd04bb59ee2ab71a3b470ead188d101" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a><float> <a class="el" href="classgr__fir__fsf.html#a4cd04bb59ee2ab71a3b470ead188d101">gr_fir_fsf::d_taps</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__fir__fsf.html#ae6dcb8e0d14dd3fe98459f76d1b329c9">get_taps()</a>, <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a>, and <a class="el" href="classgr__fir__fsf.html#adc6959598abe050fe195c2202fc6c521">set_taps()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__fir__fsf_8h_source.html">gr_fir_fsf.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__fir__fsf.html">gr_fir_fsf</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
>
1154
