ref: cc0694e2a5c399faada2396980745338930e1c38
dir: /docs/leaf/group__tattackdetection.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: tAttackDetection</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">tAttackDetection<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Detect attacks in an input signal.
<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:gaa7cf7c473a720eb6e034661a92a9164a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#gaa7cf7c473a720eb6e034661a92a9164a">tAttackDetection_init</a> (tAttackDetection *const, int blocksize, int atk, int rel, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:gaa7cf7c473a720eb6e034661a92a9164a"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tAttackDetection to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. <a href="group__tattackdetection.html#gaa7cf7c473a720eb6e034661a92a9164a">More...</a><br /></td></tr>
<tr class="separator:gaa7cf7c473a720eb6e034661a92a9164a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga159b77e3617708f63d34705f66891eca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#ga159b77e3617708f63d34705f66891eca">tAttackDetection_initToPool</a> (tAttackDetection *const, int blocksize, int atk, int rel, tMempool *const)</td></tr>
<tr class="memdesc:ga159b77e3617708f63d34705f66891eca"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tAttackDetection to a specified mempool. <a href="group__tattackdetection.html#ga159b77e3617708f63d34705f66891eca">More...</a><br /></td></tr>
<tr class="separator:ga159b77e3617708f63d34705f66891eca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac0cecbd3eb9478a8ac62ad056b4e65e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#gac0cecbd3eb9478a8ac62ad056b4e65e8">tAttackDetection_free</a> (tAttackDetection *const)</td></tr>
<tr class="memdesc:gac0cecbd3eb9478a8ac62ad056b4e65e8"><td class="mdescLeft"> </td><td class="mdescRight">Free a tAttackDetection from its mempool. <a href="group__tattackdetection.html#gac0cecbd3eb9478a8ac62ad056b4e65e8">More...</a><br /></td></tr>
<tr class="separator:gac0cecbd3eb9478a8ac62ad056b4e65e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga330419a7bcf2aea460cbb8341d0cc7a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#ga330419a7bcf2aea460cbb8341d0cc7a1">tAttackDetection_setBlocksize</a> (tAttackDetection *const, int size)</td></tr>
<tr class="memdesc:ga330419a7bcf2aea460cbb8341d0cc7a1"><td class="mdescLeft"> </td><td class="mdescRight">Set expected input blocksize. <a href="group__tattackdetection.html#ga330419a7bcf2aea460cbb8341d0cc7a1">More...</a><br /></td></tr>
<tr class="separator:ga330419a7bcf2aea460cbb8341d0cc7a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc1088d0fc65cb8c9ca3e219dc6ee23e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#gafc1088d0fc65cb8c9ca3e219dc6ee23e">tAttackDetection_setSamplerate</a> (tAttackDetection *const, int inRate)</td></tr>
<tr class="memdesc:gafc1088d0fc65cb8c9ca3e219dc6ee23e"><td class="mdescLeft"> </td><td class="mdescRight">Set attack detection sample rate. <a href="group__tattackdetection.html#gafc1088d0fc65cb8c9ca3e219dc6ee23e">More...</a><br /></td></tr>
<tr class="separator:gafc1088d0fc65cb8c9ca3e219dc6ee23e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1258e29699c07368168a5a06e847c1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#gae1258e29699c07368168a5a06e847c1c">tAttackDetection_setAttack</a> (tAttackDetection *const, int inAtk)</td></tr>
<tr class="memdesc:gae1258e29699c07368168a5a06e847c1c"><td class="mdescLeft"> </td><td class="mdescRight">Set attack time and coeff. <a href="group__tattackdetection.html#gae1258e29699c07368168a5a06e847c1c">More...</a><br /></td></tr>
<tr class="separator:gae1258e29699c07368168a5a06e847c1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga849d76be546d42e00dcfaee4ca326adb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#ga849d76be546d42e00dcfaee4ca326adb">tAttackDetection_setRelease</a> (tAttackDetection *const, int inRel)</td></tr>
<tr class="memdesc:ga849d76be546d42e00dcfaee4ca326adb"><td class="mdescLeft"> </td><td class="mdescRight">Set release time and coeff. <a href="group__tattackdetection.html#ga849d76be546d42e00dcfaee4ca326adb">More...</a><br /></td></tr>
<tr class="separator:ga849d76be546d42e00dcfaee4ca326adb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc46d23c20523048eaf45a68e146dbcf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#gafc46d23c20523048eaf45a68e146dbcf">tAttackDetection_setThreshold</a> (tAttackDetection *const, float thres)</td></tr>
<tr class="memdesc:gafc46d23c20523048eaf45a68e146dbcf"><td class="mdescLeft"> </td><td class="mdescRight">Set level above which values are identified as attacks. <a href="group__tattackdetection.html#gafc46d23c20523048eaf45a68e146dbcf">More...</a><br /></td></tr>
<tr class="separator:gafc46d23c20523048eaf45a68e146dbcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga628b4e4305fb135f7f363b94a209cb37"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tattackdetection.html#ga628b4e4305fb135f7f363b94a209cb37">tAttackDetection_detect</a> (tAttackDetection *const, float *in)</td></tr>
<tr class="memdesc:ga628b4e4305fb135f7f363b94a209cb37"><td class="mdescLeft"> </td><td class="mdescRight">Find the largest transient in input block, return index of attack. <a href="group__tattackdetection.html#ga628b4e4305fb135f7f363b94a209cb37">More...</a><br /></td></tr>
<tr class="separator:ga628b4e4305fb135f7f363b94a209cb37"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Detect attacks in an input signal. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa7cf7c473a720eb6e034661a92a9164a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa7cf7c473a720eb6e034661a92a9164a">◆ </a></span>tAttackDetection_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_init </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>blocksize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>atk</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>rel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const </td>
<td class="paramname"><em>leaf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tAttackDetection to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the tAttackDetection to initialize. </td></tr>
<tr><td class="paramname">blockSize</td><td></td></tr>
<tr><td class="paramname">attack</td><td></td></tr>
<tr><td class="paramname">release</td><td></td></tr>
<tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga159b77e3617708f63d34705f66891eca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga159b77e3617708f63d34705f66891eca">◆ </a></span>tAttackDetection_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_initToPool </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>blocksize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>atk</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>rel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tMempool * const </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tAttackDetection to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the tAttackDetection to initialize. </td></tr>
<tr><td class="paramname">blockSize</td><td></td></tr>
<tr><td class="paramname">attack</td><td></td></tr>
<tr><td class="paramname">release</td><td></td></tr>
<tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac0cecbd3eb9478a8ac62ad056b4e65e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac0cecbd3eb9478a8ac62ad056b4e65e8">◆ </a></span>tAttackDetection_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_free </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tAttackDetection 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 tAttackDetection to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga330419a7bcf2aea460cbb8341d0cc7a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga330419a7bcf2aea460cbb8341d0cc7a1">◆ </a></span>tAttackDetection_setBlocksize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_setBlocksize </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set expected input blocksize. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tAttackDetection. </td></tr>
<tr><td class="paramname">blockSize</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafc1088d0fc65cb8c9ca3e219dc6ee23e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc1088d0fc65cb8c9ca3e219dc6ee23e">◆ </a></span>tAttackDetection_setSamplerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_setSamplerate </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>inRate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set attack detection sample rate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tAttackDetection. </td></tr>
<tr><td class="paramname">sampleRate</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae1258e29699c07368168a5a06e847c1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae1258e29699c07368168a5a06e847c1c">◆ </a></span>tAttackDetection_setAttack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_setAttack </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>inAtk</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set attack time and coeff. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tAttackDetection. </td></tr>
<tr><td class="paramname">attack</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga849d76be546d42e00dcfaee4ca326adb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga849d76be546d42e00dcfaee4ca326adb">◆ </a></span>tAttackDetection_setRelease()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_setRelease </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>inRel</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set release time and coeff. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tAttackDetection. </td></tr>
<tr><td class="paramname">release</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafc46d23c20523048eaf45a68e146dbcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc46d23c20523048eaf45a68e146dbcf">◆ </a></span>tAttackDetection_setThreshold()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tAttackDetection_setThreshold </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>thres</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set level above which values are identified as attacks. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tAttackDetection. </td></tr>
<tr><td class="paramname">threshold</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga628b4e4305fb135f7f363b94a209cb37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga628b4e4305fb135f7f363b94a209cb37">◆ </a></span>tAttackDetection_detect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tAttackDetection_detect </td>
<td>(</td>
<td class="paramtype">tAttackDetection * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </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>Find the largest transient in input block, return index of attack. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detection</td><td>A pointer to the relevant tAttackDetection. </td></tr>
<tr><td class="paramname">inputBlock</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Index of the largest transient in the input.  </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>