<!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< o_type, i_type, tap_type > 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< o_type, i_type, tap_type > Class Template Reference</h1><!-- doxytag: class="gr_single_pole_iir" -->
<p>class template for single pole IIR filter
<a href="#_details">More...</a></p>
<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-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.html#a0bd31e559ccc5cce039f198ec9b88e93">gr_single_pole_iir</a> (tap_type alpha=1.0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">construct new single pole IIR with given alpha <a href="#a0bd31e559ccc5cce039f198ec9b88e93"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">o_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir.html#ad8cecedbfed0bc1f24524d08914288c7">filter</a> (const i_type input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute a single output value. <a href="#ad8cecedbfed0bc1f24524d08914288c7"></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.html#aabd52c15f1973d6e75d8aad3a2c6381c">filterN</a> (o_type 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="#aabd52c15f1973d6e75d8aad3a2c6381c"></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.html#af8f1dfca2e1492caf5ef10a6d01f7851">set_taps</a> (tap_type alpha)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">install <code>alpha</code> as the current taps. <a href="#af8f1dfca2e1492caf5ef10a6d01f7851"></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.html#aec64a97520727ae05377c782b44b6062">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reset state to zero <a href="#aec64a97520727ae05377c782b44b6062"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">tap_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir.html#a3cb0c20fea52b8168e5c0a57476dfb87">prev_output</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">tap_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir.html#a3cecd484003a907e60ff8d0eff8fa887">d_alpha</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">tap_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir.html#a5e0f640e76cd29ba756d962097ede891">d_one_minus_alpha</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">tap_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir.html#a896007d3ed8be78894c19a6f58fd870f">d_prev_output</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class o_type, class i_type, class tap_type><br/>
class gr_single_pole_iir< o_type, i_type, tap_type ></h3>
<p>class template for single pole IIR filter </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0bd31e559ccc5cce039f198ec9b88e93"></a><!-- doxytag: member="gr_single_pole_iir::gr_single_pole_iir" ref="a0bd31e559ccc5cce039f198ec9b88e93" args="(tap_type alpha=1.0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::<a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a> </td>
<td>(</td>
<td class="paramtype">tap_type </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>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad8cecedbfed0bc1f24524d08914288c7"></a><!-- doxytag: member="gr_single_pole_iir::filter" ref="ad8cecedbfed0bc1f24524d08914288c7" args="(const i_type input)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type , class i_type, class tap_type > </div>
<table class="memname">
<tr>
<td class="memname">o_type <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::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>
<p>Referenced by <a class="el" href="gr__single__pole__iir_8h_source.html#l00182">gr_single_pole_iir< gr_complex, i_type, double >::filterN()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00101">gr_single_pole_iir< o_type, i_type, tap_type >::filterN()</a>, and <a class="el" href="atsci__slicer__agc_8h_source.html#l00044">atsci_slicer_agc::scale()</a>.</p>
</div>
</div>
<a class="anchor" id="aabd52c15f1973d6e75d8aad3a2c6381c"></a><!-- doxytag: member="gr_single_pole_iir::filterN" ref="aabd52c15f1973d6e75d8aad3a2c6381c" args="(o_type output[], const i_type input[], unsigned long n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::filterN </td>
<td>(</td>
<td class="paramtype">o_type </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="a3cb0c20fea52b8168e5c0a57476dfb87"></a><!-- doxytag: member="gr_single_pole_iir::prev_output" ref="a3cb0c20fea52b8168e5c0a57476dfb87" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname">tap_type <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::prev_output </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aec64a97520727ae05377c782b44b6062"></a><!-- doxytag: member="gr_single_pole_iir::reset" ref="aec64a97520727ae05377c782b44b6062" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::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>
</div>
</div>
<a class="anchor" id="af8f1dfca2e1492caf5ef10a6d01f7851"></a><!-- doxytag: member="gr_single_pole_iir::set_taps" ref="af8f1dfca2e1492caf5ef10a6d01f7851" args="(tap_type alpha)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::set_taps </td>
<td>(</td>
<td class="paramtype">tap_type </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>Referenced by <a class="el" href="gr__single__pole__iir_8h_source.html#l00122">gr_single_pole_iir< gr_complex, i_type, double >::gr_single_pole_iir()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00038">gr_single_pole_iir< double, double, double >::gr_single_pole_iir()</a>, <a class="el" href="gr__pwr__squelch__ff_8h_source.html#l00059">gr_pwr_squelch_ff::set_alpha()</a>, and <a class="el" href="gr__pwr__squelch__cc_8h_source.html#l00059">gr_pwr_squelch_cc::set_alpha()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a3cecd484003a907e60ff8d0eff8fa887"></a><!-- doxytag: member="gr_single_pole_iir::d_alpha" ref="a3cecd484003a907e60ff8d0eff8fa887" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname">tap_type <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::<a class="el" href="classgr__single__pole__iir.html#a3cecd484003a907e60ff8d0eff8fa887">d_alpha</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gr__single__pole__iir_8h_source.html#l00168">gr_single_pole_iir< gr_complex, i_type, double >::filter()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00088">gr_single_pole_iir< o_type, i_type, tap_type >::filter()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00143">gr_single_pole_iir< gr_complex, i_type, double >::set_taps()</a>, and <a class="el" href="gr__single__pole__iir_8h_source.html#l00059">gr_single_pole_iir< double, double, double >::set_taps()</a>.</p>
</div>
</div>
<a class="anchor" id="a5e0f640e76cd29ba756d962097ede891"></a><!-- doxytag: member="gr_single_pole_iir::d_one_minus_alpha" ref="a5e0f640e76cd29ba756d962097ede891" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname">tap_type <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::<a class="el" href="classgr__single__pole__iir.html#a5e0f640e76cd29ba756d962097ede891">d_one_minus_alpha</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gr__single__pole__iir_8h_source.html#l00168">gr_single_pole_iir< gr_complex, i_type, double >::filter()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00088">gr_single_pole_iir< o_type, i_type, tap_type >::filter()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00143">gr_single_pole_iir< gr_complex, i_type, double >::set_taps()</a>, and <a class="el" href="gr__single__pole__iir_8h_source.html#l00059">gr_single_pole_iir< double, double, double >::set_taps()</a>.</p>
</div>
</div>
<a class="anchor" id="a896007d3ed8be78894c19a6f58fd870f"></a><!-- doxytag: member="gr_single_pole_iir::d_prev_output" ref="a896007d3ed8be78894c19a6f58fd870f" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class o_type, class i_type, class tap_type> </div>
<table class="memname">
<tr>
<td class="memname">tap_type <a class="el" href="classgr__single__pole__iir.html">gr_single_pole_iir</a>< o_type, i_type, tap_type >::<a class="el" href="classgr__single__pole__iir.html#a896007d3ed8be78894c19a6f58fd870f">d_prev_output</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gr__single__pole__iir_8h_source.html#l00168">gr_single_pole_iir< gr_complex, i_type, double >::filter()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00088">gr_single_pole_iir< o_type, i_type, tap_type >::filter()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00122">gr_single_pole_iir< gr_complex, i_type, double >::gr_single_pole_iir()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00038">gr_single_pole_iir< double, double, double >::gr_single_pole_iir()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00158">gr_single_pole_iir< gr_complex, i_type, double >::prev_output()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00074">gr_single_pole_iir< double, double, double >::prev_output()</a>, <a class="el" href="gr__single__pole__iir_8h_source.html#l00153">gr_single_pole_iir< gr_complex, i_type, double >::reset()</a>, and <a class="el" href="gr__single__pole__iir_8h_source.html#l00069">gr_single_pole_iir< double, double, double >::reset()</a>.</p>
</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>
