arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml
index 4167074..3633e8d 100644 (file)
@@ -40,7 +40,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">ARM Compute Library
-   &#160;<span id="projectnumber">17.03.1</span>
+   &#160;<span id="projectnumber">17.04</span>
    </div>
   </td>
  </tr>
@@ -134,9 +134,24 @@ Collaboration diagram for CLLKTrackerStage1Kernel:</div>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
-<tr class="memitem:ad9966ec6791c22371534112e5b7defce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#ad9966ec6791c22371534112e5b7defce">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *new_input, <a class="el" href="namespacearm__compute.xhtml#a569a32a7a853d4708fd4f4840c88a157">ICLLKInternalKeypointArray</a> *new_points_internal, <a class="el" href="namespacearm__compute.xhtml#a05d88c40a53babe38cb2cb5841c4a0ad">ICLCoefficientTableArray</a> *coeff_table, <a class="el" href="namespacearm__compute.xhtml#a0339a19c93dde6754834a7d4ec7dab73">ICLOldValArray</a> *old_ival, <a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a> termination, float epsilon, size_t num_iterations, size_t window_dimension, size_t level, int32_t border_offset)</td></tr>
-<tr class="memdesc:ad9966ec6791c22371534112e5b7defce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel input and output.  <a href="#ad9966ec6791c22371534112e5b7defce">More...</a><br /></td></tr>
-<tr class="separator:ad9966ec6791c22371534112e5b7defce"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac676c3a1b87aacf83246da916f5f5dee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#ac676c3a1b87aacf83246da916f5f5dee">CLLKTrackerStage1Kernel</a> ()</td></tr>
+<tr class="memdesc:ac676c3a1b87aacf83246da916f5f5dee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ac676c3a1b87aacf83246da916f5f5dee">More...</a><br /></td></tr>
+<tr class="separator:ac676c3a1b87aacf83246da916f5f5dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a78b1cf4e95b79731e32d48a757b653cf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#a78b1cf4e95b79731e32d48a757b653cf">CLLKTrackerStage1Kernel</a> (const <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;)=delete</td></tr>
+<tr class="memdesc:a78b1cf4e95b79731e32d48a757b653cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a78b1cf4e95b79731e32d48a757b653cf">More...</a><br /></td></tr>
+<tr class="separator:a78b1cf4e95b79731e32d48a757b653cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0226443ff006bea34e6bbcb1fbff2422"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#a0226443ff006bea34e6bbcb1fbff2422">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;)=delete</td></tr>
+<tr class="memdesc:a0226443ff006bea34e6bbcb1fbff2422"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a0226443ff006bea34e6bbcb1fbff2422">More...</a><br /></td></tr>
+<tr class="separator:a0226443ff006bea34e6bbcb1fbff2422"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aef6997e356ca8c5f6c35bec24b8fe28d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#aef6997e356ca8c5f6c35bec24b8fe28d">CLLKTrackerStage1Kernel</a> (<a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&amp;)=default</td></tr>
+<tr class="memdesc:aef6997e356ca8c5f6c35bec24b8fe28d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#aef6997e356ca8c5f6c35bec24b8fe28d">More...</a><br /></td></tr>
+<tr class="separator:aef6997e356ca8c5f6c35bec24b8fe28d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4f1ff65bdc81c14c9e9138d2d63aaece"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#a4f1ff65bdc81c14c9e9138d2d63aaece">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&amp;)=default</td></tr>
+<tr class="memdesc:a4f1ff65bdc81c14c9e9138d2d63aaece"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a4f1ff65bdc81c14c9e9138d2d63aaece">More...</a><br /></td></tr>
+<tr class="separator:a4f1ff65bdc81c14c9e9138d2d63aaece"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad4e047471bcabdeae5c07e1ed627ce64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#ad4e047471bcabdeae5c07e1ed627ce64">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *new_input, <a class="el" href="namespacearm__compute.xhtml#a569a32a7a853d4708fd4f4840c88a157">ICLLKInternalKeypointArray</a> *new_points_internal, <a class="el" href="namespacearm__compute.xhtml#a05d88c40a53babe38cb2cb5841c4a0ad">ICLCoefficientTableArray</a> *coeff_table, <a class="el" href="namespacearm__compute.xhtml#a0339a19c93dde6754834a7d4ec7dab73">ICLOldValArray</a> *old_ival, <a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a> termination, float epsilon, size_t num_iterations, size_t window_dimension, size_t level)</td></tr>
+<tr class="memdesc:ad4e047471bcabdeae5c07e1ed627ce64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel input and output.  <a href="#ad4e047471bcabdeae5c07e1ed627ce64">More...</a><br /></td></tr>
+<tr class="separator:ad4e047471bcabdeae5c07e1ed627ce64"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a493987e85723a8000eb26d1f00e2ad0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">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>, cl::CommandQueue &amp;queue) override</td></tr>
 <tr class="memdesc:a493987e85723a8000eb26d1f00e2ad0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.  <a href="#a493987e85723a8000eb26d1f00e2ad0e">More...</a><br /></td></tr>
 <tr class="separator:a493987e85723a8000eb26d1f00e2ad0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -189,9 +204,79 @@ Public Member Functions</h2></td></tr>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Interface to run the second stage of LKTracker, where the motion vectors of the given points are computed. </p>
 
-<p>Definition at line <a class="el" href="_c_l_l_k_tracker_kernel_8h_source.xhtml#l00134">134</a> of file <a class="el" href="_c_l_l_k_tracker_kernel_8h_source.xhtml">CLLKTrackerKernel.h</a>.</p>
-</div><h2 class="groupheader">Member Function Documentation</h2>
-<a class="anchor" id="ad9966ec6791c22371534112e5b7defce"></a>
+<p>Definition at line <a class="el" href="_c_l_l_k_tracker_kernel_8h_source.xhtml#l00148">148</a> of file <a class="el" href="_c_l_l_k_tracker_kernel_8h_source.xhtml">CLLKTrackerKernel.h</a>.</p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="ac676c3a1b87aacf83246da916f5f5dee"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Default constructor. </p>
+
+</div>
+</div>
+<a class="anchor" id="a78b1cf4e95b79731e32d48a757b653cf"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Prevent instances of this class from being copied (As this class contains pointers) </p>
+
+</div>
+</div>
+<a class="anchor" id="aef6997e356ca8c5f6c35bec24b8fe28d"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&amp;&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">default</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Allow instances of this class to be moved. </p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a class="anchor" id="ad4e047471bcabdeae5c07e1ed627ce64"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -247,13 +332,7 @@ Public Member Functions</h2></td></tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">size_t&#160;</td>
-          <td class="paramname"><em>level</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">int32_t&#160;</td>
-          <td class="paramname"><em>border_offset</em>&#160;</td>
+          <td class="paramname"><em>level</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -275,13 +354,64 @@ Public Member Functions</h2></td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">num_iterations</td><td>The maximum number of iterations before terminating the algorithm </td></tr>
     <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>
     <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The pyramid level </td></tr>
-    <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>
   </table>
   </dd>
 </dl>
 
 </div>
 </div>
+<a class="anchor" id="a0226443ff006bea34e6bbcb1fbff2422"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a>&amp; operator= </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Prevent instances of this class from being copied (As this class contains pointers) </p>
+
+</div>
+</div>
+<a class="anchor" id="a4f1ff65bdc81c14c9e9138d2d63aaece"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a>&amp; operator= </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a> &amp;&amp;&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">default</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Allow instances of this class to be moved. </p>
+
+</div>
+</div>
 <a class="anchor" id="a493987e85723a8000eb26d1f00e2ad0e"></a>
 <div class="memitem">
 <div class="memproto">
@@ -337,7 +467,7 @@ Public Member Functions</h2></td></tr>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <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_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a></li>
-    <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
+    <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
   </ul>