Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 1988

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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_single_pole_iir&lt; gr_complex, i_type, double &gt; Class Template 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__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<h1>gr_single_pole_iir&lt; gr_complex, i_type, double &gt; Class Template Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;" -->
<p><code>#include &lt;<a class="el" href="gr__single__pole__iir_8h_source.html">gr_single_pole_iir.h</a>&gt;</code></p>

<p><a href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a60f697c8924bd2d2ca6a370d606d2483">gr_single_pole_iir</a> (double alpha=1.0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">construct new single pole IIR with given alpha  <a href="#a60f697c8924bd2d2ca6a370d606d2483"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#aa833356db2d31691b39b166efd615880">filter</a> (const i_type input)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">compute a single output value.  <a href="#aa833356db2d31691b39b166efd615880"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a8e96513599ab00798aac14f76b451ca2">filterN</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> output[], const i_type input[], unsigned long n)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">compute an array of N output values. <code>input</code> must have n valid entries.  <a href="#a8e96513599ab00798aac14f76b451ca2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#aa97e7a76ddbefd08b3a32d674891ce8a">set_taps</a> (double alpha)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">install <code>alpha</code> as the current taps.  <a href="#aa97e7a76ddbefd08b3a32d674891ce8a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a93048bf18a6017347b42c6395564981b">reset</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">reset state to zero  <a href="#a93048bf18a6017347b42c6395564981b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__complex_8h.html#a90c065671dd1c4b7aed7e08b265e23f7">gr_complexd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a443a747cd842732ea49484d871212ed0">prev_output</a> ()</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">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a2609b118c141b19665d16e18cc37cf0e">d_alpha</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#af5a95fc377d50f3b1f74a4258fdfb9df">d_one_minus_alpha</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__complex_8h.html#a90c065671dd1c4b7aed7e08b265e23f7">gr_complexd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a89dcb1aebab3a22b2fa5186238f696d8">d_prev_output</a></td></tr>
</table>
<h3>template&lt;class i_type&gt;<br/>
 class gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</h3>

<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a60f697c8924bd2d2ca6a370d606d2483"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::gr_single_pole_iir" ref="a60f697c8924bd2d2ca6a370d606d2483" args="(double alpha=1.0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::<a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a> </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>alpha</em> = <code>1.0</code></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>construct new single pole IIR with given alpha </p>
<p>computes y(i) = (1-alpha) * y(i-1) + alpha * x(i) </p>

<p>References <a class="el" href="classgr__single__pole__iir.html#a896007d3ed8be78894c19a6f58fd870f">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</a>, and <a class="el" href="classgr__single__pole__iir.html#af8f1dfca2e1492caf5ef10a6d01f7851">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::set_taps()</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa833356db2d31691b39b166efd615880"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filter" ref="aa833356db2d31691b39b166efd615880" args="(const i_type input)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::filter </td>
          <td>(</td>
          <td class="paramtype">const i_type&#160;</td>
          <td class="paramname"><em>input</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>compute a single output value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the filtered input value. </dd></dl>

<p>References <a class="el" href="classgr__single__pole__iir.html#a3cecd484003a907e60ff8d0eff8fa887">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_alpha</a>, <a class="el" href="classgr__single__pole__iir.html#a5e0f640e76cd29ba756d962097ede891">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_one_minus_alpha</a>, and <a class="el" href="classgr__single__pole__iir.html#a896007d3ed8be78894c19a6f58fd870f">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</a>.</p>

</div>
</div>
<a class="anchor" id="a8e96513599ab00798aac14f76b451ca2"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filterN" ref="a8e96513599ab00798aac14f76b451ca2" args="(gr_complex output[], const i_type input[], unsigned long n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::filterN </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>&#160;</td>
          <td class="paramname"><em>output</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const i_type&#160;</td>
          <td class="paramname"><em>input</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>n</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>compute an array of N output values. <code>input</code> must have n valid entries. </p>

<p>References <a class="el" href="classgr__single__pole__iir.html#ad8cecedbfed0bc1f24524d08914288c7">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::filter()</a>.</p>

</div>
</div>
<a class="anchor" id="a443a747cd842732ea49484d871212ed0"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::prev_output" ref="a443a747cd842732ea49484d871212ed0" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__complex_8h.html#a90c065671dd1c4b7aed7e08b265e23f7">gr_complexd</a> <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::prev_output </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>References <a class="el" href="classgr__single__pole__iir.html#a896007d3ed8be78894c19a6f58fd870f">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</a>.</p>

</div>
</div>
<a class="anchor" id="a93048bf18a6017347b42c6395564981b"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::reset" ref="a93048bf18a6017347b42c6395564981b" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>reset state to zero </p>

<p>References <a class="el" href="classgr__single__pole__iir.html#a896007d3ed8be78894c19a6f58fd870f">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</a>.</p>

</div>
</div>
<a class="anchor" id="aa97e7a76ddbefd08b3a32d674891ce8a"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::set_taps" ref="aa97e7a76ddbefd08b3a32d674891ce8a" args="(double alpha)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::set_taps </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>alpha</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>install <code>alpha</code> as the current taps. </p>

<p>References <a class="el" href="classgr__single__pole__iir.html#a3cecd484003a907e60ff8d0eff8fa887">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_alpha</a>, and <a class="el" href="classgr__single__pole__iir.html#a5e0f640e76cd29ba756d962097ede891">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_one_minus_alpha</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2609b118c141b19665d16e18cc37cf0e"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::d_alpha" ref="a2609b118c141b19665d16e18cc37cf0e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::<a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a2609b118c141b19665d16e18cc37cf0e">d_alpha</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="af5a95fc377d50f3b1f74a4258fdfb9df"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::d_one_minus_alpha" ref="af5a95fc377d50f3b1f74a4258fdfb9df" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::<a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#af5a95fc377d50f3b1f74a4258fdfb9df">d_one_minus_alpha</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a89dcb1aebab3a22b2fa5186238f696d8"></a><!-- doxytag: member="gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::d_prev_output" ref="a89dcb1aebab3a22b2fa5186238f696d8" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class i_type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__complex_8h.html#a90c065671dd1c4b7aed7e08b265e23f7">gr_complexd</a> <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double &gt;::<a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a89dcb1aebab3a22b2fa5186238f696d8">d_prev_output</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__single__pole__iir_8h_source.html">gr_single_pole_iir.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>