<!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_scc 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__scc.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_scc Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_fir_scc" -->
<p>Abstract class for FIR with short 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__scc_8h_source.html">gr_fir_scc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_fir_scc:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__fir__scc__inherit__graph.png" border="0" usemap="#gr__fir__scc_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__fir__scc_inherit__map" id="gr__fir__scc_inherit__map">
<area shape="rect" id="node3" href="classgr__fir__scc__generic.html" title="Concrete class for generic implementation of FIR with short input, gr_complex output and gr_complex t..." alt="" coords="159,83,287,112"/><area shape="rect" id="node5" href="classgr__fir__scc__simd.html" title="common base class for SIMD versions of gr_fir_sccThis base class handles alignment issues common to S..." alt="" coords="165,160,280,189"/><area shape="rect" id="node7" href="classgr__fir__scc__3dnow.html" title="3DNow! version of gr_fir_scc" alt="" coords="5,237,128,267"/><area shape="rect" id="node9" href="classgr__fir__scc__3dnowext.html" title="3DNow! Ext version of gr_fir_scc" alt="" coords="152,237,293,267"/><area shape="rect" id="node11" href="classgr__fir__scc__sse.html" title="SSE version of gr_fir_scc." alt="" coords="317,237,424,267"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__fir__scc-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__scc.html#a9a4cd739c2b025cc1bbed59e06781ea0">gr_fir_scc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">construct new FIR with given taps. <a href="#a9a4cd739c2b025cc1bbed59e06781ea0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__scc.html#a335875e4c9f6295c27c212224712b033">gr_fir_scc</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__scc.html#ae65e83fa7b779593b9bb92f67f94387c">~gr_fir_scc</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__scc.html#a2d5bd57bed50960c917fa659e3b12b7a">filter</a> (const short input[])=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute a single output value. <a href="#a2d5bd57bed50960c917fa659e3b12b7a"></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__scc.html#ac113d7d0a1781360cd2072ac34fc60a9">filterN</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> output[], const short input[], unsigned long n)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute an array of N output values. <a href="#ac113d7d0a1781360cd2072ac34fc60a9"></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__scc.html#ade9edb86250e2a0a3df76a8bcfac6dd4">filterNdec</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> output[], const short 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="#ade9edb86250e2a0a3df76a8bcfac6dd4"></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__scc.html#a1404a3100e262622de0ba450a4256462">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="#a1404a3100e262622de0ba450a4256462"></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__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">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__scc.html#a292c9d7f99daf321ac0c0900369e0a50">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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__scc.html#aa571d27aec97b0e708ab0ba66ee7697e">d_taps</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class for FIR with short 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>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9a4cd739c2b025cc1bbed59e06781ea0"></a><!-- doxytag: member="gr_fir_scc::gr_fir_scc" ref="a9a4cd739c2b025cc1bbed59e06781ea0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_fir_scc::gr_fir_scc </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="a335875e4c9f6295c27c212224712b033"></a><!-- doxytag: member="gr_fir_scc::gr_fir_scc" ref="a335875e4c9f6295c27c212224712b033" args="(const std::vector< gr_complex > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_fir_scc::gr_fir_scc </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="ae65e83fa7b779593b9bb92f67f94387c"></a><!-- doxytag: member="gr_fir_scc::~gr_fir_scc" ref="ae65e83fa7b779593b9bb92f67f94387c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_fir_scc::~gr_fir_scc </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="a2d5bd57bed50960c917fa659e3b12b7a"></a><!-- doxytag: member="gr_fir_scc::filter" ref="a2d5bd57bed50960c917fa659e3b12b7a" args="(const short 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_scc::filter </td>
<td>(</td>
<td class="paramtype">const short </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__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">ntaps()</a> valid entries. input[0] .. input[<a class="el" href="classgr__fir__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">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__scc__generic.html#ae7edfaf21a3369981d92cae952e775a7">gr_fir_scc_generic</a>, and <a class="el" href="classgr__fir__scc__simd.html#a0c9892233109886cd83542b2fa6f4572">gr_fir_scc_simd</a>.</p>
</div>
</div>
<a class="anchor" id="ac113d7d0a1781360cd2072ac34fc60a9"></a><!-- doxytag: member="gr_fir_scc::filterN" ref="ac113d7d0a1781360cd2072ac34fc60a9" args="(gr_complex output[], const short input[], unsigned long n)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_scc::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 short </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__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">ntaps()</a>) valid entries. input[0] .. input[n - 1 + <a class="el" href="classgr__fir__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">ntaps()</a> - 1] are referenced to compute the output values. </p>
<p>Implemented in <a class="el" href="classgr__fir__scc__generic.html#a978a159e834dbf24422f02f93f0d85ef">gr_fir_scc_generic</a>.</p>
</div>
</div>
<a class="anchor" id="ade9edb86250e2a0a3df76a8bcfac6dd4"></a><!-- doxytag: member="gr_fir_scc::filterNdec" ref="ade9edb86250e2a0a3df76a8bcfac6dd4" args="(gr_complex output[], const short input[], unsigned long n, unsigned decimate)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_scc::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 short </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__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">ntaps()</a>) valid entries. input[0] .. input[decimate * (n - 1) + <a class="el" href="classgr__fir__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">ntaps()</a> - 1] are referenced to compute the output values. </p>
<p>Implemented in <a class="el" href="classgr__fir__scc__generic.html#a0218f2adbe0984b44803425263279ceb">gr_fir_scc_generic</a>.</p>
</div>
</div>
<a class="anchor" id="a292c9d7f99daf321ac0c0900369e0a50"></a><!-- doxytag: member="gr_fir_scc::get_taps" ref="a292c9d7f99daf321ac0c0900369e0a50" 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_scc::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__scc.html#aa571d27aec97b0e708ab0ba66ee7697e">d_taps</a>, and <a class="el" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a46c990dc7c764b50b1fcffdb15b9d0b0"></a><!-- doxytag: member="gr_fir_scc::ntaps" ref="a46c990dc7c764b50b1fcffdb15b9d0b0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_fir_scc::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__scc.html#aa571d27aec97b0e708ab0ba66ee7697e">d_taps</a>.</p>
</div>
</div>
<a class="anchor" id="a1404a3100e262622de0ba450a4256462"></a><!-- doxytag: member="gr_fir_scc::set_taps" ref="a1404a3100e262622de0ba450a4256462" args="(const std::vector< gr_complex > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_fir_scc::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__scc__simd.html#a6a1af670f1fde60d3b85c414df763ef5">gr_fir_scc_simd</a>.</p>
<p>References <a class="el" href="classgr__fir__scc.html#aa571d27aec97b0e708ab0ba66ee7697e">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="aa571d27aec97b0e708ab0ba66ee7697e"></a><!-- doxytag: member="gr_fir_scc::d_taps" ref="aa571d27aec97b0e708ab0ba66ee7697e" 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__scc.html#aa571d27aec97b0e708ab0ba66ee7697e">gr_fir_scc::d_taps</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__fir__scc.html#a292c9d7f99daf321ac0c0900369e0a50">get_taps()</a>, <a class="el" href="classgr__fir__scc.html#a46c990dc7c764b50b1fcffdb15b9d0b0">ntaps()</a>, and <a class="el" href="classgr__fir__scc.html#a1404a3100e262622de0ba450a4256462">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__scc_8h_source.html">gr_fir_scc.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__fir__scc.html">gr_fir_scc</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
>
1179
