arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>ARM Compute Library: NELKTrackerKernel Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml','');});
100 </script>
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104      onmouseover="return searchBox.OnSearchSelectShow()"
105      onmouseout="return searchBox.OnSearchSelectHide()"
106      onkeydown="return searchBox.OnSearchSelectKey(event)">
107 </div>
108
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0" 
112         name="MSearchResults" id="MSearchResults">
113 </iframe>
114 </div>
115
116 <div class="header">
117   <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a>  </div>
119   <div class="headertitle">
120 <div class="title">NELKTrackerKernel Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>Interface for the Lucas-Kanade tracker kernel.  
125  <a href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for NELKTrackerKernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_l_k_tracker_kernel__coll__graph.svg" width="150" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
132 </div>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:a10e6214af1515f5916f93dddd1bb3124"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#a10e6214af1515f5916f93dddd1bb3124">NELKTrackerKernel</a> ()</td></tr>
138 <tr class="memdesc:a10e6214af1515f5916f93dddd1bb3124"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a10e6214af1515f5916f93dddd1bb3124">More...</a><br /></td></tr>
139 <tr class="separator:a10e6214af1515f5916f93dddd1bb3124"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a5c272fb952051d6a06370c2fdb267c96"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#a5c272fb952051d6a06370c2fdb267c96">NELKTrackerKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a5c272fb952051d6a06370c2fdb267c96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a5c272fb952051d6a06370c2fdb267c96">More...</a><br /></td></tr>
142 <tr class="separator:a5c272fb952051d6a06370c2fdb267c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a4fca340cdf3937fc9d34364c0c63b87f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#a4fca340cdf3937fc9d34364c0c63b87f">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a4fca340cdf3937fc9d34364c0c63b87f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a4fca340cdf3937fc9d34364c0c63b87f">More...</a><br /></td></tr>
145 <tr class="separator:a4fca340cdf3937fc9d34364c0c63b87f"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:aca5d353ec5bfccdae41b2f647adb3da8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#aca5d353ec5bfccdae41b2f647adb3da8">NELKTrackerKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&amp;)=default</td></tr>
147 <tr class="memdesc:aca5d353ec5bfccdae41b2f647adb3da8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#aca5d353ec5bfccdae41b2f647adb3da8">More...</a><br /></td></tr>
148 <tr class="separator:aca5d353ec5bfccdae41b2f647adb3da8"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:ab71320bdcd0dfbee682dd61b8c1c0b0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#ab71320bdcd0dfbee682dd61b8c1c0b0c">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&amp;)=default</td></tr>
150 <tr class="memdesc:ab71320bdcd0dfbee682dd61b8c1c0b0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ab71320bdcd0dfbee682dd61b8c1c0b0c">More...</a><br /></td></tr>
151 <tr class="separator:ab71320bdcd0dfbee682dd61b8c1c0b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:ab32b5b543a39437043fd3e6df25ec574"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#ab32b5b543a39437043fd3e6df25ec574">~NELKTrackerKernel</a> ()=default</td></tr>
153 <tr class="memdesc:ab32b5b543a39437043fd3e6df25ec574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#ab32b5b543a39437043fd3e6df25ec574">More...</a><br /></td></tr>
154 <tr class="separator:ab32b5b543a39437043fd3e6df25ec574"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a1a240e81daadc55f75e59ab796faf029"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#a1a240e81daadc55f75e59ab796faf029">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input_old, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input_new, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *old_scharr_gx, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *old_scharr_gy, const <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *old_points, const <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *new_points_estimates, <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *new_points, <a class="el" href="namespacearm__compute.xhtml#a19699533eb1b662e46a10715f6086487">INELKInternalKeypointArray</a> *old_points_internal, <a class="el" href="namespacearm__compute.xhtml#a19699533eb1b662e46a10715f6086487">INELKInternalKeypointArray</a> *new_points_internal, <a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a> termination, bool use_initial_estimate, float epsilon, unsigned int num_iterations, size_t window_dimension, size_t level, size_t num_levels, float pyramid_scale, int32_t border_offset)</td></tr>
156 <tr class="memdesc:a1a240e81daadc55f75e59ab796faf029"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel input and output.  <a href="#a1a240e81daadc55f75e59ab796faf029">More...</a><br /></td></tr>
157 <tr class="separator:a1a240e81daadc55f75e59ab796faf029"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>) override</td></tr>
159 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
160 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
162 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
163 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
165 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
166 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
167 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
169 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
170 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
171 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
173 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
174 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
176 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
177 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
179 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
180 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 </table>
182 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
183 <div class="textblock"><p>Interface for the Lucas-Kanade tracker kernel. </p>
184
185 <p>Definition at line <a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml#l00051">51</a> of file <a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a>.</p>
186 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
187 <a class="anchor" id="a10e6214af1515f5916f93dddd1bb3124"></a>
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
193           <td>(</td>
194           <td class="paramname"></td><td>)</td>
195           <td></td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <p>Default constructor. </p>
201
202 </div>
203 </div>
204 <a class="anchor" id="a5c272fb952051d6a06370c2fdb267c96"></a>
205 <div class="memitem">
206 <div class="memproto">
207 <table class="mlabels">
208   <tr>
209   <td class="mlabels-left">
210       <table class="memname">
211         <tr>
212           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
213           <td>(</td>
214           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&#160;</td>
215           <td class="paramname"></td><td>)</td>
216           <td></td>
217         </tr>
218       </table>
219   </td>
220   <td class="mlabels-right">
221 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
222   </tr>
223 </table>
224 </div><div class="memdoc">
225
226 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
227
228 </div>
229 </div>
230 <a class="anchor" id="aca5d353ec5bfccdae41b2f647adb3da8"></a>
231 <div class="memitem">
232 <div class="memproto">
233 <table class="mlabels">
234   <tr>
235   <td class="mlabels-left">
236       <table class="memname">
237         <tr>
238           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
239           <td>(</td>
240           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&amp;&#160;</td>
241           <td class="paramname"></td><td>)</td>
242           <td></td>
243         </tr>
244       </table>
245   </td>
246   <td class="mlabels-right">
247 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
248   </tr>
249 </table>
250 </div><div class="memdoc">
251
252 <p>Allow instances of this class to be moved. </p>
253
254 </div>
255 </div>
256 <a class="anchor" id="ab32b5b543a39437043fd3e6df25ec574"></a>
257 <div class="memitem">
258 <div class="memproto">
259 <table class="mlabels">
260   <tr>
261   <td class="mlabels-left">
262       <table class="memname">
263         <tr>
264           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
265           <td>(</td>
266           <td class="paramname"></td><td>)</td>
267           <td></td>
268         </tr>
269       </table>
270   </td>
271   <td class="mlabels-right">
272 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
273   </tr>
274 </table>
275 </div><div class="memdoc">
276
277 <p>Default destructor. </p>
278
279 </div>
280 </div>
281 <h2 class="groupheader">Member Function Documentation</h2>
282 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
283 <div class="memitem">
284 <div class="memproto">
285 <table class="mlabels">
286   <tr>
287   <td class="mlabels-left">
288       <table class="memname">
289         <tr>
290           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
291           <td>(</td>
292           <td class="paramname"></td><td>)</td>
293           <td> const</td>
294         </tr>
295       </table>
296   </td>
297   <td class="mlabels-right">
298 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
299   </tr>
300 </table>
301 </div><div class="memdoc">
302
303 <p>The size of the border for that kernel. </p>
304 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
305
306 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
307
308 </div>
309 </div>
310 <a class="anchor" id="a1a240e81daadc55f75e59ab796faf029"></a>
311 <div class="memitem">
312 <div class="memproto">
313       <table class="memname">
314         <tr>
315           <td class="memname">void configure </td>
316           <td>(</td>
317           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
318           <td class="paramname"><em>input_old</em>, </td>
319         </tr>
320         <tr>
321           <td class="paramkey"></td>
322           <td></td>
323           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
324           <td class="paramname"><em>input_new</em>, </td>
325         </tr>
326         <tr>
327           <td class="paramkey"></td>
328           <td></td>
329           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
330           <td class="paramname"><em>old_scharr_gx</em>, </td>
331         </tr>
332         <tr>
333           <td class="paramkey"></td>
334           <td></td>
335           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
336           <td class="paramname"><em>old_scharr_gy</em>, </td>
337         </tr>
338         <tr>
339           <td class="paramkey"></td>
340           <td></td>
341           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *&#160;</td>
342           <td class="paramname"><em>old_points</em>, </td>
343         </tr>
344         <tr>
345           <td class="paramkey"></td>
346           <td></td>
347           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *&#160;</td>
348           <td class="paramname"><em>new_points_estimates</em>, </td>
349         </tr>
350         <tr>
351           <td class="paramkey"></td>
352           <td></td>
353           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *&#160;</td>
354           <td class="paramname"><em>new_points</em>, </td>
355         </tr>
356         <tr>
357           <td class="paramkey"></td>
358           <td></td>
359           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a19699533eb1b662e46a10715f6086487">INELKInternalKeypointArray</a> *&#160;</td>
360           <td class="paramname"><em>old_points_internal</em>, </td>
361         </tr>
362         <tr>
363           <td class="paramkey"></td>
364           <td></td>
365           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a19699533eb1b662e46a10715f6086487">INELKInternalKeypointArray</a> *&#160;</td>
366           <td class="paramname"><em>new_points_internal</em>, </td>
367         </tr>
368         <tr>
369           <td class="paramkey"></td>
370           <td></td>
371           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a>&#160;</td>
372           <td class="paramname"><em>termination</em>, </td>
373         </tr>
374         <tr>
375           <td class="paramkey"></td>
376           <td></td>
377           <td class="paramtype">bool&#160;</td>
378           <td class="paramname"><em>use_initial_estimate</em>, </td>
379         </tr>
380         <tr>
381           <td class="paramkey"></td>
382           <td></td>
383           <td class="paramtype">float&#160;</td>
384           <td class="paramname"><em>epsilon</em>, </td>
385         </tr>
386         <tr>
387           <td class="paramkey"></td>
388           <td></td>
389           <td class="paramtype">unsigned int&#160;</td>
390           <td class="paramname"><em>num_iterations</em>, </td>
391         </tr>
392         <tr>
393           <td class="paramkey"></td>
394           <td></td>
395           <td class="paramtype">size_t&#160;</td>
396           <td class="paramname"><em>window_dimension</em>, </td>
397         </tr>
398         <tr>
399           <td class="paramkey"></td>
400           <td></td>
401           <td class="paramtype">size_t&#160;</td>
402           <td class="paramname"><em>level</em>, </td>
403         </tr>
404         <tr>
405           <td class="paramkey"></td>
406           <td></td>
407           <td class="paramtype">size_t&#160;</td>
408           <td class="paramname"><em>num_levels</em>, </td>
409         </tr>
410         <tr>
411           <td class="paramkey"></td>
412           <td></td>
413           <td class="paramtype">float&#160;</td>
414           <td class="paramname"><em>pyramid_scale</em>, </td>
415         </tr>
416         <tr>
417           <td class="paramkey"></td>
418           <td></td>
419           <td class="paramtype">int32_t&#160;</td>
420           <td class="paramname"><em>border_offset</em>&#160;</td>
421         </tr>
422         <tr>
423           <td></td>
424           <td>)</td>
425           <td></td><td></td>
426         </tr>
427       </table>
428 </div><div class="memdoc">
429
430 <p>Initialise the kernel input and output. </p>
431 <dl class="params"><dt>Parameters</dt><dd>
432   <table class="params">
433     <tr><td class="paramdir">[in]</td><td class="paramname">input_old</td><td>Pointer to the input old tensor. Data type supported: U8 </td></tr>
434     <tr><td class="paramdir">[in]</td><td class="paramname">input_new</td><td>Pointer to the input new tensor. Data type supported. U8 </td></tr>
435     <tr><td class="paramdir">[in]</td><td class="paramname">old_scharr_gx</td><td>Pointer to the input scharr X tensor. Data type supported: S16 </td></tr>
436     <tr><td class="paramdir">[in]</td><td class="paramname">old_scharr_gy</td><td>Pointer to the input scharr Y tensor. Data type supported: S16 </td></tr>
437     <tr><td class="paramdir">[in]</td><td class="paramname">old_points</td><td>Pointer to the IKeyPointArray storing old key points </td></tr>
438     <tr><td class="paramdir">[in]</td><td class="paramname">new_points_estimates</td><td>Pointer to the IKeyPointArray storing new estimates key points </td></tr>
439     <tr><td class="paramdir">[out]</td><td class="paramname">new_points</td><td>Pointer to the IKeyPointArray storing new key points </td></tr>
440     <tr><td class="paramdir">[in,out]</td><td class="paramname">old_points_internal</td><td>Pointer to the array of <a class="el" href="structarm__compute_1_1_n_e_l_k_internal_keypoint.xhtml" title="Internal keypoint class for Lucas-Kanade Optical Flow. ">NELKInternalKeypoint</a> for old points </td></tr>
441     <tr><td class="paramdir">[out]</td><td class="paramname">new_points_internal</td><td>Pointer to the array of <a class="el" href="structarm__compute_1_1_n_e_l_k_internal_keypoint.xhtml" title="Internal keypoint class for Lucas-Kanade Optical Flow. ">NELKInternalKeypoint</a> for new points </td></tr>
442     <tr><td class="paramdir">[in]</td><td class="paramname">termination</td><td>The criteria to terminate the search of each keypoint. </td></tr>
443     <tr><td class="paramdir">[in]</td><td class="paramname">use_initial_estimate</td><td>The flag to indicate whether the initial estimated position should be used </td></tr>
444     <tr><td class="paramdir">[in]</td><td class="paramname">epsilon</td><td>The error for terminating the algorithm </td></tr>
445     <tr><td class="paramdir">[in]</td><td class="paramname">num_iterations</td><td>The maximum number of iterations before terminate the algorithm </td></tr>
446     <tr><td class="paramdir">[in]</td><td class="paramname">window_dimension</td><td>The size of the window on which to perform the algorithm </td></tr>
447     <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The pyramid level </td></tr>
448     <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels </td></tr>
449     <tr><td class="paramdir">[in]</td><td class="paramname">pyramid_scale</td><td>Scale factor used for generating the pyramid </td></tr>
450     <tr><td class="paramdir">[in]</td><td class="paramname">border_offset</td><td>The offset used to define the boundary of the tracked pixels in different border modes </td></tr>
451   </table>
452   </dd>
453 </dl>
454
455 </div>
456 </div>
457 <a class="anchor" id="a4fca340cdf3937fc9d34364c0c63b87f"></a>
458 <div class="memitem">
459 <div class="memproto">
460 <table class="mlabels">
461   <tr>
462   <td class="mlabels-left">
463       <table class="memname">
464         <tr>
465           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a>&amp; operator= </td>
466           <td>(</td>
467           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&#160;</td>
468           <td class="paramname"></td><td>)</td>
469           <td></td>
470         </tr>
471       </table>
472   </td>
473   <td class="mlabels-right">
474 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
475   </tr>
476 </table>
477 </div><div class="memdoc">
478
479 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
480
481 </div>
482 </div>
483 <a class="anchor" id="ab71320bdcd0dfbee682dd61b8c1c0b0c"></a>
484 <div class="memitem">
485 <div class="memproto">
486 <table class="mlabels">
487   <tr>
488   <td class="mlabels-left">
489       <table class="memname">
490         <tr>
491           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a>&amp; operator= </td>
492           <td>(</td>
493           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&amp;&#160;</td>
494           <td class="paramname"></td><td>)</td>
495           <td></td>
496         </tr>
497       </table>
498   </td>
499   <td class="mlabels-right">
500 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
501   </tr>
502 </table>
503 </div><div class="memdoc">
504
505 <p>Allow instances of this class to be moved. </p>
506
507 </div>
508 </div>
509 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
510 <div class="memitem">
511 <div class="memproto">
512 <table class="mlabels">
513   <tr>
514   <td class="mlabels-left">
515       <table class="memname">
516         <tr>
517           <td class="memname">void run </td>
518           <td>(</td>
519           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
520           <td class="paramname"><em>window</em></td><td>)</td>
521           <td></td>
522         </tr>
523       </table>
524   </td>
525   <td class="mlabels-right">
526 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
527   </tr>
528 </table>
529 </div><div class="memdoc">
530
531 <p>Execute the kernel on the passed window. </p>
532 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
533 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
534 <dd>
535 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
536 <dl class="params"><dt>Parameters</dt><dd>
537   <table class="params">
538     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
539   </table>
540   </dd>
541 </dl>
542
543 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
544
545 </div>
546 </div>
547 <hr/>The documentation for this class was generated from the following file:<ul>
548 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a></li>
549 </ul>
550 </div><!-- contents -->
551 </div><!-- doc-content -->
552 <!-- start footer part -->
553 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
554   <ul>
555     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a></li>
556     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
557     <a href="http://www.doxygen.org/index.html">
558     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
559   </ul>
560 </div>
561 </body>
562 </html>