You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
307 lines
16 KiB
HTML
307 lines
16 KiB
HTML
<!-- HTML header for doxygen 1.9.2-->
|
|
<!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=11"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CMSIS-DSP: Dynamic Time Warping Distance</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="footer.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
|
<link href="$extra_stylesheet" rel="stylesheet" type="text/css" />
|
|
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
|
|
<link href="version.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../version.js"></script>
|
|
</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: 55px;">
|
|
<td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
|
|
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
|
|
<div id="projectname">CMSIS-DSP
|
|
 <span id="projectnumber"><script type="text/javascript">
|
|
<!--
|
|
writeHeader.call(this);
|
|
writeVersionDropdown(this);
|
|
//-->
|
|
</script>
|
|
</span>
|
|
</div>
|
|
<div id="projectbrief">CMSIS DSP Software Library</div>
|
|
</td>
|
|
<!--END !PROJECT_NAME-->
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Usage and Description</span></a></li>
|
|
<li class="current"><a href="modules.html"><span> API Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.svg"
|
|
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.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__DTW.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">Dynamic Time Warping Distance<div class="ingroups"><a class="el" href="group__groupDistance.html">Distance functions</a> » <a class="el" href="group__FloatDist.html">Float Distances</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga3054a8c2bd87ec5ab533e1e31363837a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DTW.html#ga3054a8c2bd87ec5ab533e1e31363837a">arm_dtw_distance_f32</a> (const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pDistance, const <a class="el" href="structarm__matrix__instance__q7.html">arm_matrix_instance_q7</a> *pWindow, <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pDTW, <a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *distance)</td></tr>
|
|
<tr class="memdesc:ga3054a8c2bd87ec5ab533e1e31363837a"><td class="mdescLeft"> </td><td class="mdescRight">Dynamic Time Warping distance. <a href="group__DTW.html#ga3054a8c2bd87ec5ab533e1e31363837a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3054a8c2bd87ec5ab533e1e31363837a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaec9aeb4005af427929bd3dbb9ba4376e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DTW.html#gaec9aeb4005af427929bd3dbb9ba4376e">arm_dtw_init_window_q7</a> (const <a class="el" href="distance__functions_8h.html#aaf7ee1df9b342c53aa5e5ee1e0dde42d">arm_dtw_window</a> windowType, const int32_t windowSize, <a class="el" href="structarm__matrix__instance__q7.html">arm_matrix_instance_q7</a> *pWindow)</td></tr>
|
|
<tr class="memdesc:gaec9aeb4005af427929bd3dbb9ba4376e"><td class="mdescLeft"> </td><td class="mdescRight">Window for dynamic time warping computation. <a href="group__DTW.html#gaec9aeb4005af427929bd3dbb9ba4376e">More...</a><br /></td></tr>
|
|
<tr class="separator:gaec9aeb4005af427929bd3dbb9ba4376e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab413c9d09441e997b1d8d74da4b7245f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DTW.html#gab413c9d09441e997b1d8d74da4b7245f">arm_dtw_path_f32</a> (const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pDTW, int16_t *pPath, uint32_t *pathLength)</td></tr>
|
|
<tr class="memdesc:gab413c9d09441e997b1d8d74da4b7245f"><td class="mdescLeft"> </td><td class="mdescRight">Mapping between query and template. <a href="group__DTW.html#gab413c9d09441e997b1d8d74da4b7245f">More...</a><br /></td></tr>
|
|
<tr class="separator:gab413c9d09441e997b1d8d74da4b7245f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<p >Dynamic Time Warping Distance.</p>
|
|
<p >This is not really a distance since triangular inequality is not respected.</p>
|
|
<p >The step pattern used is symmetric2. Future versions of this function will provide more customization options. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga3054a8c2bd87ec5ab533e1e31363837a" name="ga3054a8c2bd87ec5ab533e1e31363837a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3054a8c2bd87ec5ab533e1e31363837a">◆ </a></span>arm_dtw_distance_f32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_dtw_distance_f32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> * </td>
|
|
<td class="paramname"><em>pDistance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structarm__matrix__instance__q7.html">arm_matrix_instance_q7</a> * </td>
|
|
<td class="paramname"><em>pWindow</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> * </td>
|
|
<td class="paramname"><em>pDTW</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td>
|
|
<td class="paramname"><em>distance</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="paramdir">[in]</td><td class="paramname">pDistance</td><td>Distance matrix (Query rows * Template columns) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pWindow</td><td>Windowing matrix (can be NULL if no windowing used) </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDTW</td><td>Temporary cost buffer (same size) </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">distance</td><td>Distance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>ARM_MATH_ARGUMENT_ERROR in case no path can be found with window constraint</dd></dl>
|
|
<dl class="section user"><dt>Windowing matrix</dt><dd></dd></dl>
|
|
<p>The windowing matrix is used to impose some constraints on the search for a path. The algorithm will run faster (smaller search path) but may not be able to find a solution.</p>
|
|
<p >The distance matrix must be initialized only where the windowing matrix is containing 1. Thus, use of a window also decreases the number of distances which must be computed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaec9aeb4005af427929bd3dbb9ba4376e" name="gaec9aeb4005af427929bd3dbb9ba4376e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaec9aeb4005af427929bd3dbb9ba4376e">◆ </a></span>arm_dtw_init_window_q7()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_dtw_init_window_q7 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="distance__functions_8h.html#aaf7ee1df9b342c53aa5e5ee1e0dde42d">arm_dtw_window</a> </td>
|
|
<td class="paramname"><em>windowType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int32_t </td>
|
|
<td class="paramname"><em>windowSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structarm__matrix__instance__q7.html">arm_matrix_instance_q7</a> * </td>
|
|
<td class="paramname"><em>pWindow</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="paramdir">[in]</td><td class="paramname">windowType</td><td>Type of window </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">windowSize</td><td>Window size </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">pWindow</td><td>Window </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Error if window type not recognized</dd></dl>
|
|
<dl class="section user"><dt>Windowing matrix</dt><dd>The window matrix will contain 1 for the position which are accepted and 0 for the positions which are rejected.</dd></dl>
|
|
<p>The input matrix must already contain a buffer and the number of rows (query length) and columns (template length) must be initialized. The function will fill the matrix with 0 and 1. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab413c9d09441e997b1d8d74da4b7245f" name="gab413c9d09441e997b1d8d74da4b7245f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab413c9d09441e997b1d8d74da4b7245f">◆ </a></span>arm_dtw_path_f32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_dtw_path_f32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> * </td>
|
|
<td class="paramname"><em>pDTW</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t * </td>
|
|
<td class="paramname"><em>pPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>pathLength</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="paramdir">[in]</td><td class="paramname">pDTW</td><td>Cost matrix (Query rows * Template columns) </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pPath</td><td>Warping path in cost matrix 2*(nb rows + nb columns) </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pathLength</td><td>Length of path in number of points </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Warping path</dt><dd></dd></dl>
|
|
<p>The warping path has length which is at most 2*(query length + template length) in float. 2 because it is a list of coordinates : (query index, template index) coordinate.</p>
|
|
<p >The buffer pPath must be big enough to contain the warping path.</p>
|
|
<p >pathLength is the number of points in the returned path. The resturned path may be smaller than query + template. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">
|
|
<script type="text/javascript">
|
|
<!--
|
|
writeFooter.call(this);
|
|
//-->
|
|
</script>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|