<!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_fcc Class Reference</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.2 -->
<div class="contents">
<h1>gr_fir_fcc Class Reference</h1><!-- doxytag: class="gr_fir_fcc" -->
<p>Abstract class for FIR with float input, gr_complex output and gr_complex 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__fcc_8h_source.html">gr_fir_fcc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_fir_fcc:</div>
<div class="dynsection">
<div class="center"><img src="classgr__fir__fcc__inherit__graph.png" border="0" usemap="#gr__fir__fcc_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__fir__fcc_inherit__map" id="gr__fir__fcc_inherit__map">
<area shape="rect" id="node3" href="classgr__fir__fcc__generic.html" title="Concrete class for generic implementation of FIR with float input, gr_complex output..." alt="" coords="71,83,196,112"/><area shape="rect" id="node5" href="classgr__fir__fcc__simd.html" title="common base class for SIMD versions of gr_fir_fccThis base class handles alignment..." alt="" coords="79,160,188,189"/><area shape="rect" id="node7" href="classgr__fir__fcc__3dnow.html" title="3DNow! version of gr_fir_fcc" alt="" coords="5,237,125,267"/><area shape="rect" id="node9" href="classgr__fir__fcc__sse.html" title="SSE version of gr_fir_fcc." alt="" coords="149,237,253,267"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__fir__fcc-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>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__fcc.html#a602df7de8dc88cda40b9ad4bc9ed4895">gr_fir_fcc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">construct new FIR with given taps. <a href="#a602df7de8dc88cda40b9ad4bc9ed4895"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fcc.html#a8485ef01a775803216857a97066687b6">gr_fir_fcc</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > &<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__fcc.html#a396ea765ab9c6f2535e927b09342933b">~gr_fir_fcc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fcc.html#a9eabd99e888d13f96677b430b9408df5">filter</a> (const float input[])=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute a single output value. <a href="#a9eabd99e888d13f96677b430b9408df5"></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__fcc.html#a6fab43ec65ca46a32eb52ec18b0bd669">filterN</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> 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="#a6fab43ec65ca46a32eb52ec18b0bd669"></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__fcc.html#ac51ae358b509b4c578ba7a7380cad4c5">filterNdec</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> 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="#ac51ae358b509b4c578ba7a7380cad4c5"></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__fcc.html#a03a29e78ad8ea447e52f20156b2b2601">set_taps</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > &<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="#a03a29e78ad8ea447e52f20156b2b2601"></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__fcc.html#a480be7ebc5d223ab61a8a375486acb41">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><br class="typebreak"/>
< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fcc.html#ab27c9fa920e78e94219575cca834522a">get_taps</a> () const </td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fcc.html#a53f351706cdd0e7cc714087eca85002d">d_taps</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract class for FIR with float input, gr_complex output and gr_complex 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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a602df7de8dc88cda40b9ad4bc9ed4895"></a><!-- doxytag: member="gr_fir_fcc::gr_fir_fcc" ref="a602df7de8dc88cda40b9ad4bc9ed4895" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_fir_fcc::gr_fir_fcc </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="a8485ef01a775803216857a97066687b6"></a><!-- doxytag: member="gr_fir_fcc::gr_fir_fcc" ref="a8485ef01a775803216857a97066687b6" args="(const std::vector< gr_complex > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_fir_fcc::gr_fir_fcc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > & </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="a396ea765ab9c6f2535e927b09342933b"></a><!-- doxytag: member="gr_fir_fcc::~gr_fir_fcc" ref="a396ea765ab9c6f2535e927b09342933b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_fir_fcc::~gr_fir_fcc </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="a9eabd99e888d13f96677b430b9408df5"></a><!-- doxytag: member="gr_fir_fcc::filter" ref="a9eabd99e888d13f96677b430b9408df5" args="(const float input[])=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> gr_fir_fcc::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__fcc.html#a480be7ebc5d223ab61a8a375486acb41">ntaps()</a> valid entries. input[0] .. input[<a class="el" href="classgr__fir__fcc.html#a480be7ebc5d223ab61a8a375486acb41">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__fcc__generic.html#ab72639ddf12ad3838e468235838ab38d">gr_fir_fcc_generic</a>, and <a class="el" href="classgr__fir__fcc__simd.html#a868747af1b2acfc6fd376afd12fdcf29">gr_fir_fcc_simd</a>.</p>
</div>
</div>
<a class="anchor" id="a6fab43ec65ca46a32eb52ec18b0bd669"></a><!-- doxytag: member="gr_fir_fcc::filterN" ref="a6fab43ec65ca46a32eb52ec18b0bd669" args="(gr_complex 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_fcc::filterN </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </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><td> </td>
</tr>
<tr>
<td></td>
<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__fcc.html#a480be7ebc5d223ab61a8a375486acb41">ntaps()</a>) valid entries. input[0] .. input[n - 1 + <a class="el" href="classgr__fir__fcc.html#a480be7ebc5d223ab61a8a375486acb41">ntaps()</a> - 1] are referenced to compute the output values. </p>
<p>Implemented in <a class="el" href="classgr__fir__fcc__generic.html#ab6f6924bfaff50518e5ddcf4abc0a2d8">gr_fir_fcc_generic</a>.</p>
</div>
</div>
<a class="anchor" id="ac51ae358b509b4c578ba7a7380cad4c5"></a><!-- doxytag: member="gr_fir_fcc::filterNdec" ref="ac51ae358b509b4c578ba7a7380cad4c5" args="(gr_complex 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_fcc::filterNdec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </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><td> </td>
</tr>
<tr>
<td></td>
<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__fcc.html#a480be7ebc5d223ab61a8a375486acb41">ntaps()</a>) valid entries. input[0] .. input[decimate * (n - 1) + <a class="el" href="classgr__fir__fcc.html#a480be7ebc5d223ab61a8a375486acb41">ntaps()</a> - 1] are referenced to compute the output values. </p>
<p>Implemented in <a class="el" href="classgr__fir__fcc__generic.html#a57bccce1991278446982c0e9c1b7fbae">gr_fir_fcc_generic</a>.</p>
</div>
</div>
<a class="anchor" id="ab27c9fa920e78e94219575cca834522a"></a><!-- doxytag: member="gr_fir_fcc::get_taps" ref="ab27c9fa920e78e94219575cca834522a" 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><<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>> gr_fir_fcc::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="gr__fir__fcc_8h_source.html#l00050">d_taps</a>, and <a class="el" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a480be7ebc5d223ab61a8a375486acb41"></a><!-- doxytag: member="gr_fir_fcc::ntaps" ref="a480be7ebc5d223ab61a8a375486acb41" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_fir_fcc::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="gr__fir__fcc_8h_source.html#l00050">d_taps</a>.</p>
</div>
</div>
<a class="anchor" id="a03a29e78ad8ea447e52f20156b2b2601"></a><!-- doxytag: member="gr_fir_fcc::set_taps" ref="a03a29e78ad8ea447e52f20156b2b2601" args="(const std::vector< gr_complex > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_fcc::set_taps </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > & </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__fcc__simd.html#addafd951a10d29910605186df87db899">gr_fir_fcc_simd</a>.</p>
<p>References <a class="el" href="gr__fir__fcc_8h_source.html#l00050">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="a53f351706cdd0e7cc714087eca85002d"></a><!-- doxytag: member="gr_fir_fcc::d_taps" ref="a53f351706cdd0e7cc714087eca85002d" 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><<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>> <a class="el" href="classgr__fir__fcc.html#a53f351706cdd0e7cc714087eca85002d">gr_fir_fcc::d_taps</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gr__fir__fcc_8h_source.html#l00117">get_taps()</a>, <a class="el" href="gr__fir__fcc_8h_source.html#l00112">ntaps()</a>, and <a class="el" href="gr__fir__fcc_8h_source.html#l00102">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__fcc_8h_source.html">gr_fir_fcc.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
