<!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.3.0 C++ API: gr_single_pole_iir< gr_complex, i_type, double > Class Template 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.3 -->
<div class="contents">
<h1>gr_single_pole_iir< gr_complex, i_type, double > Class Template Reference</h1><!-- doxytag: class="gr_single_pole_iir< gr_complex, i_type, double >" -->
<p><code>#include <<a class="el" href="gr__single__pole__iir_8h_source.html">gr_single_pole_iir.h</a>></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 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__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"> </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> </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"> </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 </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"> </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 </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"> </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 </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"> </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> </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>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </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 </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> </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<class i_type><br/>
class gr_single_pole_iir< gr_complex, i_type, double ></h3>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a60f697c8924bd2d2ca6a370d606d2483"></a><!-- doxytag: member="gr_single_pole_iir< gr_complex, i_type, double >::gr_single_pole_iir" ref="a60f697c8924bd2d2ca6a370d606d2483" args="(double alpha=1.0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::<a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a> </td>
<td>(</td>
<td class="paramtype">double </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="gr__single__pole__iir_8h_source.html#l00079">gr_single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>, and <a class="el" href="gr__single__pole__iir_8h_source.html#l00059">gr_single_pole_iir< o_type, i_type, tap_type >::set_taps()</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa833356db2d31691b39b166efd615880"></a><!-- doxytag: member="gr_single_pole_iir< gr_complex, i_type, double >::filter" ref="aa833356db2d31691b39b166efd615880" args="(const i_type input)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::filter </td>
<td>(</td>
<td class="paramtype">const i_type </td>
<td class="paramname"> <em>input</em></td>
<td> ) </td>
<td><code> [inline]</code></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="gr__single__pole__iir_8h_source.html#l00077">gr_single_pole_iir< o_type, i_type, tap_type >::d_alpha</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00078">gr_single_pole_iir< o_type, i_type, tap_type >::d_one_minus_alpha</a>, and <a class="el" href="gr__single__pole__iir_8h_source.html#l00079">gr_single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>.</p>
</div>
</div>
<a class="anchor" id="a8e96513599ab00798aac14f76b451ca2"></a><!-- doxytag: member="gr_single_pole_iir< gr_complex, i_type, double >::filterN" ref="a8e96513599ab00798aac14f76b451ca2" args="(gr_complex output[], const i_type input[], unsigned long n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::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 i_type </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> [inline]</code></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="gr__single__pole__iir_8h_source.html#l00088">gr_single_pole_iir< o_type, i_type, tap_type >::filter()</a>.</p>
</div>
</div>
<a class="anchor" id="a443a747cd842732ea49484d871212ed0"></a><!-- doxytag: member="gr_single_pole_iir< gr_complex, i_type, double >::prev_output" ref="a443a747cd842732ea49484d871212ed0" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::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="gr__single__pole__iir_8h_source.html#l00079">gr_single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>.</p>
</div>
</div>
<a class="anchor" id="a93048bf18a6017347b42c6395564981b"></a><!-- doxytag: member="gr_single_pole_iir< gr_complex, i_type, double >::reset" ref="a93048bf18a6017347b42c6395564981b" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::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="gr__single__pole__iir_8h_source.html#l00079">gr_single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>.</p>
</div>
</div>
<a class="anchor" id="aa97e7a76ddbefd08b3a32d674891ce8a"></a><!-- doxytag: member="gr_single_pole_iir< gr_complex, i_type, double >::set_taps" ref="aa97e7a76ddbefd08b3a32d674891ce8a" args="(double alpha)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::set_taps </td>
<td>(</td>
<td class="paramtype">double </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="gr__single__pole__iir_8h_source.html#l00077">gr_single_pole_iir< o_type, i_type, tap_type >::d_alpha</a>, and <a class="el" href="gr__single__pole__iir_8h_source.html#l00078">gr_single_pole_iir< o_type, i_type, tap_type >::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< gr_complex, i_type, double >::d_alpha" ref="a2609b118c141b19665d16e18cc37cf0e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::<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< gr_complex, i_type, double >::d_one_minus_alpha" ref="af5a95fc377d50f3b1f74a4258fdfb9df" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::<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< gr_complex, i_type, double >::d_prev_output" ref="a89dcb1aebab3a22b2fa5186238f696d8" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::<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>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:55 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
