<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr::filter::single_pole_iir< gr_complex, i_type, double > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr_1_1filter_1_1single__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> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr::filter::single_pole_iir< gr_complex, i_type, double > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="single__pole__iir_8h_source.html">single_pole_iir.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8a61fabfa88654680de0c584db5a56da"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a8a61fabfa88654680de0c584db5a56da">single_pole_iir</a> (double alpha=1.0)</td></tr>
<tr class="memdesc:a8a61fabfa88654680de0c584db5a56da"><td class="mdescLeft"> </td><td class="mdescRight">construct new single pole IIR with given alpha <a href="#a8a61fabfa88654680de0c584db5a56da"></a><br/></td></tr>
<tr class="separator:a8a61fabfa88654680de0c584db5a56da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a900dc78957bf160c9592ea0b615deeb7"><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_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a900dc78957bf160c9592ea0b615deeb7">filter</a> (const i_type input)</td></tr>
<tr class="memdesc:a900dc78957bf160c9592ea0b615deeb7"><td class="mdescLeft"> </td><td class="mdescRight">compute a single output value. <a href="#a900dc78957bf160c9592ea0b615deeb7"></a><br/></td></tr>
<tr class="separator:a900dc78957bf160c9592ea0b615deeb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16a18c30612337692adc76769323d18e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a16a18c30612337692adc76769323d18e">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 class="memdesc:a16a18c30612337692adc76769323d18e"><td class="mdescLeft"> </td><td class="mdescRight">compute an array of N output values. <code>input</code> must have n valid entries. <a href="#a16a18c30612337692adc76769323d18e"></a><br/></td></tr>
<tr class="separator:a16a18c30612337692adc76769323d18e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa9a126536418a29f6539b0033ae74b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#aaa9a126536418a29f6539b0033ae74b6">set_taps</a> (double alpha)</td></tr>
<tr class="memdesc:aaa9a126536418a29f6539b0033ae74b6"><td class="mdescLeft"> </td><td class="mdescRight">install <code>alpha</code> as the current taps. <a href="#aaa9a126536418a29f6539b0033ae74b6"></a><br/></td></tr>
<tr class="separator:aaa9a126536418a29f6539b0033ae74b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4be9464dd8eaaa41f5b8771da9e3061f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a4be9464dd8eaaa41f5b8771da9e3061f">reset</a> ()</td></tr>
<tr class="memdesc:a4be9464dd8eaaa41f5b8771da9e3061f"><td class="mdescLeft"> </td><td class="mdescRight">reset state to zero <a href="#a4be9464dd8eaaa41f5b8771da9e3061f"></a><br/></td></tr>
<tr class="separator:a4be9464dd8eaaa41f5b8771da9e3061f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf8395c899ea97bbc8e00bfca23ac60f"><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_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#aaf8395c899ea97bbc8e00bfca23ac60f">prev_output</a> () const </td></tr>
<tr class="separator:aaf8395c899ea97bbc8e00bfca23ac60f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2717f4afb9a377f25d3038ff830a7f13"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#a2717f4afb9a377f25d3038ff830a7f13">d_alpha</a></td></tr>
<tr class="separator:a2717f4afb9a377f25d3038ff830a7f13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9d9f680088502623baf7010e5290c3f"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#ac9d9f680088502623baf7010e5290c3f">d_one_minus_alpha</a></td></tr>
<tr class="separator:ac9d9f680088502623baf7010e5290c3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0067a88b2ebf013418bcf12a7b7dfb6"><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_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html#ae0067a88b2ebf013418bcf12a7b7dfb6">d_prev_output</a></td></tr>
<tr class="separator:ae0067a88b2ebf013418bcf12a7b7dfb6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8a61fabfa88654680de0c584db5a56da"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::<a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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_1_1filter_1_1single__pole__iir.html#ac3a1d570a4eee0373568c4c9d17ee5da">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>, and <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#addcc5e4b40b047a852999125d69d5e94">gr::filter::single_pole_iir< o_type, i_type, tap_type >::set_taps()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a900dc78957bf160c9592ea0b615deeb7"></a>
<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_1_1filter_1_1single__pole__iir.html">gr::filter::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></td>
</tr>
</table>
</div><div class="memdoc">
<p>compute a single output value. </p>
<dl class="section return"><dt>Returns</dt><dd>the filtered input value. </dd></dl>
<p>References <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#aae34e9e591019dd8b081eb06a981252d">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_alpha</a>, <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#aa8d14823d7649449309387443c133615">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_one_minus_alpha</a>, and <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#ac3a1d570a4eee0373568c4c9d17ee5da">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>.</p>
</div>
</div>
<a class="anchor" id="a16a18c30612337692adc76769323d18e"></a>
<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="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::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>
</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_1_1filter_1_1single__pole__iir.html#a5f02362d24af0e1cc955d32c3e82adfe">gr::filter::single_pole_iir< o_type, i_type, tap_type >::filter()</a>.</p>
</div>
</div>
<a class="anchor" id="aaf8395c899ea97bbc8e00bfca23ac60f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__complex_8h.html#a90c065671dd1c4b7aed7e08b265e23f7">gr_complexd</a> <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::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> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>References <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#ac3a1d570a4eee0373568c4c9d17ee5da">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>.</p>
</div>
</div>
<a class="anchor" id="a4be9464dd8eaaa41f5b8771da9e3061f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>reset state to zero </p>
<p>References <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#ac3a1d570a4eee0373568c4c9d17ee5da">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_prev_output</a>.</p>
</div>
</div>
<a class="anchor" id="aaa9a126536418a29f6539b0033ae74b6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>install <code>alpha</code> as the current taps. </p>
<p>References <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#aae34e9e591019dd8b081eb06a981252d">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_alpha</a>, and <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html#aa8d14823d7649449309387443c133615">gr::filter::single_pole_iir< o_type, i_type, tap_type >::d_one_minus_alpha</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a2717f4afb9a377f25d3038ff830a7f13"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::d_alpha</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac9d9f680088502623baf7010e5290c3f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::d_one_minus_alpha</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae0067a88b2ebf013418bcf12a7b7dfb6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class i_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__complex_8h.html#a90c065671dd1c4b7aed7e08b265e23f7">gr_complexd</a> <a class="el" href="classgr_1_1filter_1_1single__pole__iir.html">gr::filter::single_pole_iir</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>, i_type, double >::d_prev_output</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </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="single__pole__iir_8h_source.html">single_pole_iir.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacegr.html">gr</a></li><li class="navelem"><a class="el" href="namespacegr_1_1filter.html">filter</a></li><li class="navelem"><a class="el" href="classgr_1_1filter_1_1single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4.html">single_pole_iir< gr_complex, i_type, double ></a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:41 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
