ref: ab2f66165913c6ea18e105ce5da7431fb21a2fbd
dir: /docs/leaf/group__tperioddetection.html/
<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>LEAF: tPeriodDetection</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>
<script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script>
<!-- <script src="/js/template.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/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> -->
</head>
<body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()">
<div>
<!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
</div>
</body>
</html><!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tPeriodDetection<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Period detection algorithm from Katja Vetters <a href="http://www.katjaas.nl/helmholtz/helmholtz.html">http://www.katjaas.nl/helmholtz/helmholtz.html</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga94c9cff1d6cb0f0d6a70fdeb8764cdb0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga94c9cff1d6cb0f0d6a70fdeb8764cdb0">tPeriodDetection_free</a> (tPeriodDetection *const)</td></tr>
<tr class="memdesc:ga94c9cff1d6cb0f0d6a70fdeb8764cdb0"><td class="mdescLeft"> </td><td class="mdescRight">Free a tPeriodDetection from its mempool. <a href="group__tperioddetection.html#ga94c9cff1d6cb0f0d6a70fdeb8764cdb0">More...</a><br /></td></tr>
<tr class="separator:ga94c9cff1d6cb0f0d6a70fdeb8764cdb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga18cf97615547a615aec4b183da82e8ee"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga18cf97615547a615aec4b183da82e8ee">tPeriodDetection_tick</a> (tPeriodDetection *const, float sample)</td></tr>
<tr class="separator:ga18cf97615547a615aec4b183da82e8ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04f0fa73e75e8fc128243515b039c474"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga04f0fa73e75e8fc128243515b039c474">tPeriodDetection_getPeriod</a> (tPeriodDetection *const)</td></tr>
<tr class="separator:ga04f0fa73e75e8fc128243515b039c474"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga207a7ec884eebc58c9cd9f17518d5a1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga207a7ec884eebc58c9cd9f17518d5a1b">tPeriodDetection_setHopSize</a> (tPeriodDetection *const, int hs)</td></tr>
<tr class="separator:ga207a7ec884eebc58c9cd9f17518d5a1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a3ed4fe9806b0ee691b56090cef4339"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga9a3ed4fe9806b0ee691b56090cef4339">tPeriodDetection_setWindowSize</a> (tPeriodDetection *const, int ws)</td></tr>
<tr class="separator:ga9a3ed4fe9806b0ee691b56090cef4339"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2249345fb1cb419173b35ef258cf4248"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga2249345fb1cb419173b35ef258cf4248">tPeriodDetection_setFidelityThreshold</a> (tPeriodDetection *const, float threshold)</td></tr>
<tr class="separator:ga2249345fb1cb419173b35ef258cf4248"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga95602fa326fda0ab685a626508166d15"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga95602fa326fda0ab685a626508166d15">tPeriodDetection_setAlpha</a> (tPeriodDetection *const, float alpha)</td></tr>
<tr class="separator:ga95602fa326fda0ab685a626508166d15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga49b5e95b84c6e101abac2ab7ec0cdebd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetection.html#ga49b5e95b84c6e101abac2ab7ec0cdebd">tPeriodDetection_setTolerance</a> (tPeriodDetection *const, float tolerance)</td></tr>
<tr class="separator:ga49b5e95b84c6e101abac2ab7ec0cdebd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Period detection algorithm from Katja Vetters <a href="http://www.katjaas.nl/helmholtz/helmholtz.html">http://www.katjaas.nl/helmholtz/helmholtz.html</a>. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga94c9cff1d6cb0f0d6a70fdeb8764cdb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94c9cff1d6cb0f0d6a70fdeb8764cdb0">◆ </a></span>tPeriodDetection_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetection_free </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tPeriodDetection from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the tPeriodDetection to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga18cf97615547a615aec4b183da82e8ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18cf97615547a615aec4b183da82e8ee">◆ </a></span>tPeriodDetection_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPeriodDetection_tick </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>sample</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
<tr><td class="paramname">input</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a id="ga04f0fa73e75e8fc128243515b039c474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04f0fa73e75e8fc128243515b039c474">◆ </a></span>tPeriodDetection_getPeriod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPeriodDetection_getPeriod </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The detected period. </dd></dl>
</div>
</div>
<a id="ga207a7ec884eebc58c9cd9f17518d5a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga207a7ec884eebc58c9cd9f17518d5a1b">◆ </a></span>tPeriodDetection_setHopSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetection_setHopSize </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>hs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
<tr><td class="paramname">hopSize</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9a3ed4fe9806b0ee691b56090cef4339"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a3ed4fe9806b0ee691b56090cef4339">◆ </a></span>tPeriodDetection_setWindowSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetection_setWindowSize </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ws</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
<tr><td class="paramname">windowSize</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga2249345fb1cb419173b35ef258cf4248"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2249345fb1cb419173b35ef258cf4248">◆ </a></span>tPeriodDetection_setFidelityThreshold()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetection_setFidelityThreshold </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>threshold</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
<tr><td class="paramname">threshold</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga95602fa326fda0ab685a626508166d15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95602fa326fda0ab685a626508166d15">◆ </a></span>tPeriodDetection_setAlpha()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetection_setAlpha </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>alpha</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
<tr><td class="paramname">alpha</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga49b5e95b84c6e101abac2ab7ec0cdebd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49b5e95b84c6e101abac2ab7ec0cdebd">◆ </a></span>tPeriodDetection_setTolerance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetection_setTolerance </td>
<td>(</td>
<td class="paramtype">tPeriodDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>tolerance</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tPeriodDetection. </td></tr>
<tr><td class="paramname">tolerance</td><td> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>