<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aubio: temporal/filter.h File 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">aubio
 <span id="projectnumber">0.4.2~alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_9f81523443f82c74e7139b3dddc1da52.html">temporal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">filter.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Digital filter.
<a href="#details">More...</a></p>
<p><a href="filter_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a49b09d27ea1ef7b06d9948048143f67a"><td class="memItemLeft" align="right" valign="top">typedef struct _aubio_filter_t </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a></td></tr>
<tr class="memdesc:a49b09d27ea1ef7b06d9948048143f67a"><td class="mdescLeft"> </td><td class="mdescRight">Digital filter. <a href="#a49b09d27ea1ef7b06d9948048143f67a">More...</a><br /></td></tr>
<tr class="separator:a49b09d27ea1ef7b06d9948048143f67a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aca218f7701ad142eb6c0ce95b2d1c49b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#aca218f7701ad142eb6c0ce95b2d1c49b">aubio_filter_do</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f, <a class="el" href="structfvec__t.html">fvec_t</a> *in)</td></tr>
<tr class="memdesc:aca218f7701ad142eb6c0ce95b2d1c49b"><td class="mdescLeft"> </td><td class="mdescRight">filter input vector (in-place) <a href="#aca218f7701ad142eb6c0ce95b2d1c49b">More...</a><br /></td></tr>
<tr class="separator:aca218f7701ad142eb6c0ce95b2d1c49b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af206da6d4cb1ba6fd82b6cd1bc8eaa3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#af206da6d4cb1ba6fd82b6cd1bc8eaa3f">aubio_filter_do_outplace</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f, <a class="el" href="structfvec__t.html">fvec_t</a> *in, <a class="el" href="structfvec__t.html">fvec_t</a> *out)</td></tr>
<tr class="memdesc:af206da6d4cb1ba6fd82b6cd1bc8eaa3f"><td class="mdescLeft"> </td><td class="mdescRight">filter input vector (out-of-place) <a href="#af206da6d4cb1ba6fd82b6cd1bc8eaa3f">More...</a><br /></td></tr>
<tr class="separator:af206da6d4cb1ba6fd82b6cd1bc8eaa3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acae88254d736d3d02c81ef48ac64b108"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#acae88254d736d3d02c81ef48ac64b108">aubio_filter_do_filtfilt</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f, <a class="el" href="structfvec__t.html">fvec_t</a> *in, <a class="el" href="structfvec__t.html">fvec_t</a> *tmp)</td></tr>
<tr class="memdesc:acae88254d736d3d02c81ef48ac64b108"><td class="mdescLeft"> </td><td class="mdescRight">filter input vector forward and backward <a href="#acae88254d736d3d02c81ef48ac64b108">More...</a><br /></td></tr>
<tr class="separator:acae88254d736d3d02c81ef48ac64b108"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac26d05fd7e87e7ef5ad60cff9e91bb0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlvec__t.html">lvec_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#ac26d05fd7e87e7ef5ad60cff9e91bb0a">aubio_filter_get_feedback</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f)</td></tr>
<tr class="memdesc:ac26d05fd7e87e7ef5ad60cff9e91bb0a"><td class="mdescLeft"> </td><td class="mdescRight">returns a pointer to feedback coefficients \( a_i \) <a href="#ac26d05fd7e87e7ef5ad60cff9e91bb0a">More...</a><br /></td></tr>
<tr class="separator:ac26d05fd7e87e7ef5ad60cff9e91bb0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6c9127795e09e21f495ae4b85664cad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlvec__t.html">lvec_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#ab6c9127795e09e21f495ae4b85664cad">aubio_filter_get_feedforward</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f)</td></tr>
<tr class="memdesc:ab6c9127795e09e21f495ae4b85664cad"><td class="mdescLeft"> </td><td class="mdescRight">returns a pointer to feedforward coefficients \( b_i \) <a href="#ab6c9127795e09e21f495ae4b85664cad">More...</a><br /></td></tr>
<tr class="separator:ab6c9127795e09e21f495ae4b85664cad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a9cc27016e049f6243a63af6a464453"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#a5a9cc27016e049f6243a63af6a464453">aubio_filter_get_order</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f)</td></tr>
<tr class="memdesc:a5a9cc27016e049f6243a63af6a464453"><td class="mdescLeft"> </td><td class="mdescRight">get order of the filter <a href="#a5a9cc27016e049f6243a63af6a464453">More...</a><br /></td></tr>
<tr class="separator:a5a9cc27016e049f6243a63af6a464453"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f495e3c08c512b63020edcfb7c83594"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#a4f495e3c08c512b63020edcfb7c83594">aubio_filter_get_samplerate</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f)</td></tr>
<tr class="memdesc:a4f495e3c08c512b63020edcfb7c83594"><td class="mdescLeft"> </td><td class="mdescRight">get sampling rate of the filter <a href="#a4f495e3c08c512b63020edcfb7c83594">More...</a><br /></td></tr>
<tr class="separator:a4f495e3c08c512b63020edcfb7c83594"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41f31bc7c6f443c978bb37b94f7e3fe5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#a41f31bc7c6f443c978bb37b94f7e3fe5">aubio_filter_set_samplerate</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> samplerate)</td></tr>
<tr class="memdesc:a41f31bc7c6f443c978bb37b94f7e3fe5"><td class="mdescLeft"> </td><td class="mdescRight">get sampling rate of the filter <a href="#a41f31bc7c6f443c978bb37b94f7e3fe5">More...</a><br /></td></tr>
<tr class="separator:a41f31bc7c6f443c978bb37b94f7e3fe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae287756e6e7e1e0dbf786259550c2c3e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#ae287756e6e7e1e0dbf786259550c2c3e">aubio_filter_do_reset</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f)</td></tr>
<tr class="memdesc:ae287756e6e7e1e0dbf786259550c2c3e"><td class="mdescLeft"> </td><td class="mdescRight">reset filter memory <a href="#ae287756e6e7e1e0dbf786259550c2c3e">More...</a><br /></td></tr>
<tr class="separator:ae287756e6e7e1e0dbf786259550c2c3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae138bb8c05487f09ffbb2c49c79905ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#ae138bb8c05487f09ffbb2c49c79905ca">new_aubio_filter</a> (<a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> order)</td></tr>
<tr class="memdesc:ae138bb8c05487f09ffbb2c49c79905ca"><td class="mdescLeft"> </td><td class="mdescRight">create new filter object <a href="#ae138bb8c05487f09ffbb2c49c79905ca">More...</a><br /></td></tr>
<tr class="separator:ae138bb8c05487f09ffbb2c49c79905ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55e4be86dd74d9eddfe544bddc94e482"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="filter_8h.html#a55e4be86dd74d9eddfe544bddc94e482">del_aubio_filter</a> (<a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> *f)</td></tr>
<tr class="memdesc:a55e4be86dd74d9eddfe544bddc94e482"><td class="mdescLeft"> </td><td class="mdescRight">delete a filter object <a href="#a55e4be86dd74d9eddfe544bddc94e482">More...</a><br /></td></tr>
<tr class="separator:a55e4be86dd74d9eddfe544bddc94e482"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Digital filter. </p>
<p>This object stores a digital filter of order \(n\). It contains the following data:</p><ul>
<li>\( n*1 b_i \) feedforward coefficients</li>
<li>\( n*1 a_i \) feedback coefficients</li>
<li>\( n*c x_i \) input signal</li>
<li>\( n*c y_i \) output signal</li>
</ul>
<p>For convenience, the samplerate of the input signal is also stored in the object.</p>
<p>Feedforward and feedback parameters can be modified using <a class="el" href="filter_8h.html#ac26d05fd7e87e7ef5ad60cff9e91bb0a" title="returns a pointer to feedback coefficients ">aubio_filter_get_feedback()</a> and <a class="el" href="filter_8h.html#ab6c9127795e09e21f495ae4b85664cad" title="returns a pointer to feedforward coefficients ">aubio_filter_get_feedforward()</a>.</p>
<p>The function <a class="el" href="filter_8h.html#af206da6d4cb1ba6fd82b6cd1bc8eaa3f" title="filter input vector (out-of-place) ">aubio_filter_do_outplace()</a> computes the following output signal \( y[n] \) from the input signal \( x[n] \):</p>
<p class="formulaDsp">
\begin{eqnarray*} y[n] = b_0 x[n] & + & b_1 x[n-1] + b_2 x[n-2] + ... + b_P x[n-P] \\ & - & a_1 y[n-1] - a_2 y[n-2] - ... - a_P y[n-P] \\ \end{eqnarray*}
</p>
<p>The function <a class="el" href="filter_8h.html#aca218f7701ad142eb6c0ce95b2d1c49b" title="filter input vector (in-place) ">aubio_filter_do()</a> executes the same computation but modifies directly the input signal (in-place).</p>
<p>The function <a class="el" href="filter_8h.html#acae88254d736d3d02c81ef48ac64b108" title="filter input vector forward and backward ">aubio_filter_do_filtfilt()</a> version runs the filter twice, first forward then backward, to compensate with the phase shifting of the forward operation.</p>
<p>Some convenience functions are provided:</p><ul>
<li><a class="el" href="a__weighting_8h.html#a99c12d2c155e374aa55f4c9bea923ef5" title="create new A-design filter ">new_aubio_filter_a_weighting()</a> and <a class="el" href="a__weighting_8h.html#a97f5c911472782ae7db077353de7063a" title="set feedback and feedforward coefficients of a A-weighting filter ">aubio_filter_set_a_weighting()</a>,</li>
<li><a class="el" href="c__weighting_8h.html#ac2de2f91d6934b96f7dcbabe8e8e18c3" title="create new C-design filter ">new_aubio_filter_c_weighting()</a> and <a class="el" href="c__weighting_8h.html#a0a5fdaaf1d2058aa7a4db48853b0cb68" title="set feedback and feedforward coefficients of a C-weighting filter ">aubio_filter_set_c_weighting()</a>.</li>
<li><a class="el" href="biquad_8h.html#aceeb9c15639371381df42664556d7916" title="create biquad filter with b0, b1, b2, a1, a2 coeffs ">new_aubio_filter_biquad()</a> and <a class="el" href="biquad_8h.html#a43c7ab92a0c913d4feaed3ede748a603" title="set coefficients of a biquad filter ">aubio_filter_set_biquad()</a>. </li>
</ul>
<p class="definition">Definition in file <a class="el" href="filter_8h_source.html">filter.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a49b09d27ea1ef7b06d9948048143f67a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49b09d27ea1ef7b06d9948048143f67a">◆ </a></span>aubio_filter_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _aubio_filter_t <a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Digital filter. </p>
<p class="definition">Definition at line <a class="el" href="filter_8h_source.html#l00072">72</a> of file <a class="el" href="filter_8h_source.html">filter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aca218f7701ad142eb6c0ce95b2d1c49b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca218f7701ad142eb6c0ce95b2d1c49b">◆ </a></span>aubio_filter_do()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_filter_do </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>in</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>filter input vector (in-place) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter object as returned by <a class="el" href="filter_8h.html#ae138bb8c05487f09ffbb2c49c79905ca" title="create new filter object ">new_aubio_filter()</a> </td></tr>
<tr><td class="paramname">in</td><td>input vector to filter </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="temporal_2test-biquad_8c-example.html#a4">temporal/test-biquad.c</a>, and <a class="el" href="temporal_2test-filter_8c-example.html#a5">temporal/test-filter.c</a>.</dd>
</dl>
</div>
</div>
<a id="acae88254d736d3d02c81ef48ac64b108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acae88254d736d3d02c81ef48ac64b108">◆ </a></span>aubio_filter_do_filtfilt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_filter_do_filtfilt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>tmp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>filter input vector forward and backward </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a" title="Digital filter. ">aubio_filter_t</a> object as returned by <a class="el" href="filter_8h.html#ae138bb8c05487f09ffbb2c49c79905ca" title="create new filter object ">new_aubio_filter()</a> </td></tr>
<tr><td class="paramname">in</td><td><a class="el" href="structfvec__t.html" title="Buffer for real data. ">fvec_t</a> input vector to filter </td></tr>
<tr><td class="paramname">tmp</td><td>memory space to use for computation </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="temporal_2test-biquad_8c-example.html#a5">temporal/test-biquad.c</a>, and <a class="el" href="temporal_2test-filter_8c-example.html#a10">temporal/test-filter.c</a>.</dd>
</dl>
</div>
</div>
<a id="af206da6d4cb1ba6fd82b6cd1bc8eaa3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af206da6d4cb1ba6fd82b6cd1bc8eaa3f">◆ </a></span>aubio_filter_do_outplace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_filter_do_outplace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>filter input vector (out-of-place) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter object as returned by <a class="el" href="filter_8h.html#ae138bb8c05487f09ffbb2c49c79905ca" title="create new filter object ">new_aubio_filter()</a> </td></tr>
<tr><td class="paramname">in</td><td>input vector to filter </td></tr>
<tr><td class="paramname">out</td><td>output vector to store filtered input </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="temporal_2test-biquad_8c-example.html#a3">temporal/test-biquad.c</a>, and <a class="el" href="temporal_2test-filter_8c-example.html#a8">temporal/test-filter.c</a>.</dd>
</dl>
</div>
</div>
<a id="ae287756e6e7e1e0dbf786259550c2c3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae287756e6e7e1e0dbf786259550c2c3e">◆ </a></span>aubio_filter_do_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_filter_do_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>reset filter memory </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter object as returned by <a class="el" href="filter_8h.html#ae138bb8c05487f09ffbb2c49c79905ca" title="create new filter object ">new_aubio_filter()</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac26d05fd7e87e7ef5ad60cff9e91bb0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac26d05fd7e87e7ef5ad60cff9e91bb0a">◆ </a></span>aubio_filter_get_feedback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlvec__t.html">lvec_t</a>* aubio_filter_get_feedback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns a pointer to feedback coefficients \( a_i \) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter object to get parameters from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the \( a_0 ... a_i ... a_P \) coefficients </dd></dl>
</div>
</div>
<a id="ab6c9127795e09e21f495ae4b85664cad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6c9127795e09e21f495ae4b85664cad">◆ </a></span>aubio_filter_get_feedforward()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlvec__t.html">lvec_t</a>* aubio_filter_get_feedforward </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns a pointer to feedforward coefficients \( b_i \) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter object to get coefficients from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the \( b_0 ... b_i ... b_P \) coefficients </dd></dl>
</div>
</div>
<a id="a5a9cc27016e049f6243a63af6a464453"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a9cc27016e049f6243a63af6a464453">◆ </a></span>aubio_filter_get_order()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_filter_get_order </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get order of the filter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter to get order from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the order of the filter </dd></dl>
</div>
</div>
<a id="a4f495e3c08c512b63020edcfb7c83594"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f495e3c08c512b63020edcfb7c83594">◆ </a></span>aubio_filter_get_samplerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_filter_get_samplerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get sampling rate of the filter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter to get sampling rate from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the sampling rate of the filter, in Hz </dd></dl>
</div>
</div>
<a id="a41f31bc7c6f443c978bb37b94f7e3fe5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41f31bc7c6f443c978bb37b94f7e3fe5">◆ </a></span>aubio_filter_set_samplerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_filter_set_samplerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>samplerate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get sampling rate of the filter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter to get sampling rate from </td></tr>
<tr><td class="paramname">samplerate</td><td>sample rate to set the filter to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the sampling rate of the filter, in Hz </dd></dl>
</div>
</div>
<a id="a55e4be86dd74d9eddfe544bddc94e482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55e4be86dd74d9eddfe544bddc94e482">◆ </a></span>del_aubio_filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void del_aubio_filter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>delete a filter object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>filter object to delete </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="temporal_2test-a_weighting_8c-example.html#a1">temporal/test-a_weighting.c</a>, <a class="el" href="temporal_2test-biquad_8c-example.html#a7">temporal/test-biquad.c</a>, <a class="el" href="temporal_2test-c_weighting_8c-example.html#a1">temporal/test-c_weighting.c</a>, and <a class="el" href="temporal_2test-filter_8c-example.html#a6">temporal/test-filter.c</a>.</dd>
</dl>
</div>
</div>
<a id="ae138bb8c05487f09ffbb2c49c79905ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae138bb8c05487f09ffbb2c49c79905ca">◆ </a></span>new_aubio_filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a">aubio_filter_t</a>* new_aubio_filter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create new filter object </p>
<p>This function creates a new <a class="el" href="filter_8h.html#a49b09d27ea1ef7b06d9948048143f67a" title="Digital filter. ">aubio_filter_t</a> object, given the order of the filter.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>order of the filter (number of coefficients)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the newly created filter object </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="temporal_2test-a_weighting_8c-example.html#a2">temporal/test-a_weighting.c</a>, and <a class="el" href="temporal_2test-c_weighting_8c-example.html#a2">temporal/test-c_weighting.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
