arm_compute v18.05
[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>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">Compute Library
43    &#160;<span id="projectnumber">18.05</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="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">NELKTrackerKernel Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Interface for the Lucas-Kanade tracker kernel.  
126  <a href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for NELKTrackerKernel:</div>
131 <div class="dyncontent">
132 <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>
133 </div>
134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
137 Public Member Functions</h2></td></tr>
138 <tr class="memitem:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
139 <tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the kernel.  <a href="#ab5656bb5b6334bdbe6e606c715872828">More...</a><br /></td></tr>
140 <tr class="separator:ab5656bb5b6334bdbe6e606c715872828"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <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>
142 <tr class="memdesc:a10e6214af1515f5916f93dddd1bb3124"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a10e6214af1515f5916f93dddd1bb3124">More...</a><br /></td></tr>
143 <tr class="separator:a10e6214af1515f5916f93dddd1bb3124"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <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>
145 <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>
146 <tr class="separator:a5c272fb952051d6a06370c2fdb267c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <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>
148 <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>
149 <tr class="separator:a4fca340cdf3937fc9d34364c0c63b87f"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <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>
151 <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>
152 <tr class="separator:aca5d353ec5bfccdae41b2f647adb3da8"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <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>
154 <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>
155 <tr class="separator:ab71320bdcd0dfbee682dd61b8c1c0b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <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>
157 <tr class="memdesc:ab32b5b543a39437043fd3e6df25ec574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#ab32b5b543a39437043fd3e6df25ec574">More...</a><br /></td></tr>
158 <tr class="separator:ab32b5b543a39437043fd3e6df25ec574"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:a9db04388927168bc8d9423087dfa8a6d"><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#a9db04388927168bc8d9423087dfa8a6d">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)</td></tr>
160 <tr class="memdesc:a9db04388927168bc8d9423087dfa8a6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel input and output.  <a href="#a9db04388927168bc8d9423087dfa8a6d">More...</a><br /></td></tr>
161 <tr class="separator:a9db04388927168bc8d9423087dfa8a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><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#a112b35dd205c62ea6ed1447ef226da82">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>, const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;info) override</td></tr>
163 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a112b35dd205c62ea6ed1447ef226da82">More...</a><br /></td></tr>
164 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <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>
166 <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>
167 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <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>
169 <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>
170 <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>
171 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <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>
173 <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>
174 <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>
175 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <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>
177 <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>
178 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 <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>
180 <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>
181 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <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>
183 <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>
184 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
185 </table>
186 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
187 <div class="textblock"><p>Interface for the Lucas-Kanade tracker kernel. </p>
188
189 <p>Definition at line <a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml#l00052">52</a> of file <a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a>.</p>
190 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
191 <a class="anchor" id="a10e6214af1515f5916f93dddd1bb3124"></a>
192 <div class="memitem">
193 <div class="memproto">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
197           <td>(</td>
198           <td class="paramname"></td><td>)</td>
199           <td></td>
200         </tr>
201       </table>
202 </div><div class="memdoc">
203
204 <p>Default constructor. </p>
205
206 </div>
207 </div>
208 <a class="anchor" id="a5c272fb952051d6a06370c2fdb267c96"></a>
209 <div class="memitem">
210 <div class="memproto">
211 <table class="mlabels">
212   <tr>
213   <td class="mlabels-left">
214       <table class="memname">
215         <tr>
216           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
217           <td>(</td>
218           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&#160;</td>
219           <td class="paramname"></td><td>)</td>
220           <td></td>
221         </tr>
222       </table>
223   </td>
224   <td class="mlabels-right">
225 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
226   </tr>
227 </table>
228 </div><div class="memdoc">
229
230 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
231
232 </div>
233 </div>
234 <a class="anchor" id="aca5d353ec5bfccdae41b2f647adb3da8"></a>
235 <div class="memitem">
236 <div class="memproto">
237 <table class="mlabels">
238   <tr>
239   <td class="mlabels-left">
240       <table class="memname">
241         <tr>
242           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
243           <td>(</td>
244           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&amp;&#160;</td>
245           <td class="paramname"></td><td>)</td>
246           <td></td>
247         </tr>
248       </table>
249   </td>
250   <td class="mlabels-right">
251 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
252   </tr>
253 </table>
254 </div><div class="memdoc">
255
256 <p>Allow instances of this class to be moved. </p>
257
258 </div>
259 </div>
260 <a class="anchor" id="ab32b5b543a39437043fd3e6df25ec574"></a>
261 <div class="memitem">
262 <div class="memproto">
263 <table class="mlabels">
264   <tr>
265   <td class="mlabels-left">
266       <table class="memname">
267         <tr>
268           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> </td>
269           <td>(</td>
270           <td class="paramname"></td><td>)</td>
271           <td></td>
272         </tr>
273       </table>
274   </td>
275   <td class="mlabels-right">
276 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
277   </tr>
278 </table>
279 </div><div class="memdoc">
280
281 <p>Default destructor. </p>
282
283 </div>
284 </div>
285 <h2 class="groupheader">Member Function Documentation</h2>
286 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
287 <div class="memitem">
288 <div class="memproto">
289 <table class="mlabels">
290   <tr>
291   <td class="mlabels-left">
292       <table class="memname">
293         <tr>
294           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
295           <td>(</td>
296           <td class="paramname"></td><td>)</td>
297           <td> const</td>
298         </tr>
299       </table>
300   </td>
301   <td class="mlabels-right">
302 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
303   </tr>
304 </table>
305 </div><div class="memdoc">
306
307 <p>The size of the border for that kernel. </p>
308 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
309
310 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
311
312 </div>
313 </div>
314 <a class="anchor" id="a9db04388927168bc8d9423087dfa8a6d"></a>
315 <div class="memitem">
316 <div class="memproto">
317       <table class="memname">
318         <tr>
319           <td class="memname">void configure </td>
320           <td>(</td>
321           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
322           <td class="paramname"><em>input_old</em>, </td>
323         </tr>
324         <tr>
325           <td class="paramkey"></td>
326           <td></td>
327           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
328           <td class="paramname"><em>input_new</em>, </td>
329         </tr>
330         <tr>
331           <td class="paramkey"></td>
332           <td></td>
333           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
334           <td class="paramname"><em>old_scharr_gx</em>, </td>
335         </tr>
336         <tr>
337           <td class="paramkey"></td>
338           <td></td>
339           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
340           <td class="paramname"><em>old_scharr_gy</em>, </td>
341         </tr>
342         <tr>
343           <td class="paramkey"></td>
344           <td></td>
345           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *&#160;</td>
346           <td class="paramname"><em>old_points</em>, </td>
347         </tr>
348         <tr>
349           <td class="paramkey"></td>
350           <td></td>
351           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *&#160;</td>
352           <td class="paramname"><em>new_points_estimates</em>, </td>
353         </tr>
354         <tr>
355           <td class="paramkey"></td>
356           <td></td>
357           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2">IKeyPointArray</a> *&#160;</td>
358           <td class="paramname"><em>new_points</em>, </td>
359         </tr>
360         <tr>
361           <td class="paramkey"></td>
362           <td></td>
363           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a19699533eb1b662e46a10715f6086487">INELKInternalKeypointArray</a> *&#160;</td>
364           <td class="paramname"><em>old_points_internal</em>, </td>
365         </tr>
366         <tr>
367           <td class="paramkey"></td>
368           <td></td>
369           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a19699533eb1b662e46a10715f6086487">INELKInternalKeypointArray</a> *&#160;</td>
370           <td class="paramname"><em>new_points_internal</em>, </td>
371         </tr>
372         <tr>
373           <td class="paramkey"></td>
374           <td></td>
375           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a>&#160;</td>
376           <td class="paramname"><em>termination</em>, </td>
377         </tr>
378         <tr>
379           <td class="paramkey"></td>
380           <td></td>
381           <td class="paramtype">bool&#160;</td>
382           <td class="paramname"><em>use_initial_estimate</em>, </td>
383         </tr>
384         <tr>
385           <td class="paramkey"></td>
386           <td></td>
387           <td class="paramtype">float&#160;</td>
388           <td class="paramname"><em>epsilon</em>, </td>
389         </tr>
390         <tr>
391           <td class="paramkey"></td>
392           <td></td>
393           <td class="paramtype">unsigned int&#160;</td>
394           <td class="paramname"><em>num_iterations</em>, </td>
395         </tr>
396         <tr>
397           <td class="paramkey"></td>
398           <td></td>
399           <td class="paramtype">size_t&#160;</td>
400           <td class="paramname"><em>window_dimension</em>, </td>
401         </tr>
402         <tr>
403           <td class="paramkey"></td>
404           <td></td>
405           <td class="paramtype">size_t&#160;</td>
406           <td class="paramname"><em>level</em>, </td>
407         </tr>
408         <tr>
409           <td class="paramkey"></td>
410           <td></td>
411           <td class="paramtype">size_t&#160;</td>
412           <td class="paramname"><em>num_levels</em>, </td>
413         </tr>
414         <tr>
415           <td class="paramkey"></td>
416           <td></td>
417           <td class="paramtype">float&#160;</td>
418           <td class="paramname"><em>pyramid_scale</em>&#160;</td>
419         </tr>
420         <tr>
421           <td></td>
422           <td>)</td>
423           <td></td><td></td>
424         </tr>
425       </table>
426 </div><div class="memdoc">
427
428 <p>Initialise the kernel input and output. </p>
429 <dl class="params"><dt>Parameters</dt><dd>
430   <table class="params">
431     <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>
432     <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>
433     <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>
434     <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>
435     <tr><td class="paramdir">[in]</td><td class="paramname">old_points</td><td>Pointer to the IKeyPointArray storing old key points </td></tr>
436     <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>
437     <tr><td class="paramdir">[out]</td><td class="paramname">new_points</td><td>Pointer to the IKeyPointArray storing new key points </td></tr>
438     <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>
439     <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>
440     <tr><td class="paramdir">[in]</td><td class="paramname">termination</td><td>The criteria to terminate the search of each keypoint. </td></tr>
441     <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>
442     <tr><td class="paramdir">[in]</td><td class="paramname">epsilon</td><td>The error for terminating the algorithm </td></tr>
443     <tr><td class="paramdir">[in]</td><td class="paramname">num_iterations</td><td>The maximum number of iterations before terminate the algorithm </td></tr>
444     <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>
445     <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The pyramid level </td></tr>
446     <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels </td></tr>
447     <tr><td class="paramdir">[in]</td><td class="paramname">pyramid_scale</td><td>Scale factor used for generating the pyramid </td></tr>
448   </table>
449   </dd>
450 </dl>
451
452 </div>
453 </div>
454 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
455 <div class="memitem">
456 <div class="memproto">
457 <table class="mlabels">
458   <tr>
459   <td class="mlabels-left">
460       <table class="memname">
461         <tr>
462           <td class="memname">const char* name </td>
463           <td>(</td>
464           <td class="paramname"></td><td>)</td>
465           <td> const</td>
466         </tr>
467       </table>
468   </td>
469   <td class="mlabels-right">
470 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
471   </tr>
472 </table>
473 </div><div class="memdoc">
474
475 <p>Name of the kernel. </p>
476 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name </dd></dl>
477
478 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
479
480 <p>Definition at line <a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml#l00055">55</a> of file <a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a>.</p>
481
482 <p>References <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>.</p>
483 <div class="fragment"><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    {</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NELKTrackerKernel&quot;</span>;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    }</div></div><!-- fragment -->
484 </div>
485 </div>
486 <a class="anchor" id="a4fca340cdf3937fc9d34364c0c63b87f"></a>
487 <div class="memitem">
488 <div class="memproto">
489 <table class="mlabels">
490   <tr>
491   <td class="mlabels-left">
492       <table class="memname">
493         <tr>
494           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a>&amp; operator= </td>
495           <td>(</td>
496           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&#160;</td>
497           <td class="paramname"></td><td>)</td>
498           <td></td>
499         </tr>
500       </table>
501   </td>
502   <td class="mlabels-right">
503 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
504   </tr>
505 </table>
506 </div><div class="memdoc">
507
508 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
509
510 </div>
511 </div>
512 <a class="anchor" id="ab71320bdcd0dfbee682dd61b8c1c0b0c"></a>
513 <div class="memitem">
514 <div class="memproto">
515 <table class="mlabels">
516   <tr>
517   <td class="mlabels-left">
518       <table class="memname">
519         <tr>
520           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a>&amp; operator= </td>
521           <td>(</td>
522           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_l_k_tracker_kernel.xhtml">NELKTrackerKernel</a> &amp;&amp;&#160;</td>
523           <td class="paramname"></td><td>)</td>
524           <td></td>
525         </tr>
526       </table>
527   </td>
528   <td class="mlabels-right">
529 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
530   </tr>
531 </table>
532 </div><div class="memdoc">
533
534 <p>Allow instances of this class to be moved. </p>
535
536 </div>
537 </div>
538 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
539 <div class="memitem">
540 <div class="memproto">
541 <table class="mlabels">
542   <tr>
543   <td class="mlabels-left">
544       <table class="memname">
545         <tr>
546           <td class="memname">void run </td>
547           <td>(</td>
548           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
549           <td class="paramname"><em>window</em>, </td>
550         </tr>
551         <tr>
552           <td class="paramkey"></td>
553           <td></td>
554           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
555           <td class="paramname"><em>info</em>&#160;</td>
556         </tr>
557         <tr>
558           <td></td>
559           <td>)</td>
560           <td></td><td></td>
561         </tr>
562       </table>
563   </td>
564   <td class="mlabels-right">
565 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
566   </tr>
567 </table>
568 </div><div class="memdoc">
569
570 <p>Execute the kernel on the passed window. </p>
571 <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>
572 <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>
573 <dd>
574 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
575 <dl class="params"><dt>Parameters</dt><dd>
576   <table class="params">
577     <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>
578     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
579   </table>
580   </dd>
581 </dl>
582
583 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
584
585 </div>
586 </div>
587 <hr/>The documentation for this class was generated from the following file:<ul>
588 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_l_k_tracker_kernel_8h_source.xhtml">NELKTrackerKernel.h</a></li>
589 </ul>
590 </div><!-- contents -->
591 </div><!-- doc-content -->
592 <!-- start footer part -->
593 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
594   <ul>
595     <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>
596     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
597     <a href="http://www.doxygen.org/index.html">
598     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
599   </ul>
600 </div>
601 </body>
602 </html>