documentation/classarm__compute_1_1_c_l_optical_flow.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: CLOpticalFlow 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_c_l_optical_flow.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">CLOpticalFlow Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Basic function to execute optical flow.
 125  <a href="classarm__compute_1_1_c_l_optical_flow.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_optical_flow_8h_source.xhtml">CLOpticalFlow.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for CLOpticalFlow:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_optical_flow__coll__graph.svg" width="119" height="112"><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:a0c78677a1e128e674e4914ef5a534852"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml#a0c78677a1e128e674e4914ef5a534852">CLOpticalFlow</a> ()</td></tr>
 138 <tr class="memdesc:a0c78677a1e128e674e4914ef5a534852"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a0c78677a1e128e674e4914ef5a534852">More...</a><br /></td></tr>
 139 <tr class="separator:a0c78677a1e128e674e4914ef5a534852"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:ae0eabdf0a8999bc27a9f319122175013"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml#ae0eabdf0a8999bc27a9f319122175013">CLOpticalFlow</a> (const <a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;)=delete</td></tr>
 141 <tr class="memdesc:ae0eabdf0a8999bc27a9f319122175013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#ae0eabdf0a8999bc27a9f319122175013">More...</a><br /></td></tr>
 142 <tr class="separator:ae0eabdf0a8999bc27a9f319122175013"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a68eed0e07674cc6e041d5dc0fecd8c27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml#a68eed0e07674cc6e041d5dc0fecd8c27">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;)=delete</td></tr>
 144 <tr class="memdesc:a68eed0e07674cc6e041d5dc0fecd8c27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a68eed0e07674cc6e041d5dc0fecd8c27">More...</a><br /></td></tr>
 145 <tr class="separator:a68eed0e07674cc6e041d5dc0fecd8c27"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ae8090e64560fb80896bd682de4687343"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml#ae8090e64560fb80896bd682de4687343">CLOpticalFlow</a> (<a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:ae8090e64560fb80896bd682de4687343"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ae8090e64560fb80896bd682de4687343">More...</a><br /></td></tr>
 148 <tr class="separator:ae8090e64560fb80896bd682de4687343"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a24252fc100901855c82e8703834f9634"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml#a24252fc100901855c82e8703834f9634">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&amp;)=default</td></tr>
 150 <tr class="memdesc:a24252fc100901855c82e8703834f9634"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a24252fc100901855c82e8703834f9634">More...</a><br /></td></tr>
 151 <tr class="separator:a24252fc100901855c82e8703834f9634"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a8cd74e6bc7d3bcebbac4002717857601"><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_optical_flow.xhtml#a8cd74e6bc7d3bcebbac4002717857601">configure</a> (const <a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml">CLPyramid</a> *old_pyramid, const <a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml">CLPyramid</a> *new_pyramid, const <a class="el" href="namespacearm__compute.xhtml#adb969f0e554bf563f2fa671399d59280">ICLKeyPointArray</a> *old_points, const <a class="el" href="namespacearm__compute.xhtml#adb969f0e554bf563f2fa671399d59280">ICLKeyPointArray</a> *new_points_estimates, <a class="el" href="namespacearm__compute.xhtml#adb969f0e554bf563f2fa671399d59280">ICLKeyPointArray</a> *new_points, <a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a> termination, float epsilon, size_t num_iterations, size_t window_dimension, bool use_initial_estimate, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value=0)</td></tr>
 153 <tr class="memdesc:a8cd74e6bc7d3bcebbac4002717857601"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the function input and output.  <a href="#a8cd74e6bc7d3bcebbac4002717857601">More...</a><br /></td></tr>
 154 <tr class="separator:a8cd74e6bc7d3bcebbac4002717857601"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><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_optical_flow.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 156 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
 157 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
 159 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
 160 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
 161 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table>
 163 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 164 <div class="textblock"><p>Basic function to execute optical flow. </p>
 165 <p>This function calls the following OpenCL kernels and functions:</p>
 166 <ol type="1">
 167 <li><a class="el" href="classarm__compute_1_1_c_l_scharr3x3.xhtml">CLScharr3x3</a></li>
 168 <li><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_init_kernel.xhtml">CLLKTrackerInitKernel</a></li>
 169 <li><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage0_kernel.xhtml">CLLKTrackerStage0Kernel</a></li>
 170 <li><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml">CLLKTrackerStage1Kernel</a></li>
 171 <li><a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_finalize_kernel.xhtml">CLLKTrackerFinalizeKernel</a> </li>
 172 </ol>
 173
 174 <p>Definition at line <a class="el" href="_c_l_optical_flow_8h_source.xhtml#l00056">56</a> of file <a class="el" href="_c_l_optical_flow_8h_source.xhtml">CLOpticalFlow.h</a>.</p>
 175 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 176 <a class="anchor" id="a0c78677a1e128e674e4914ef5a534852"></a>
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> </td>
 182           <td>(</td>
 183           <td class="paramname"></td><td>)</td>
 184           <td></td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 <p>Default constructor. </p>
 190
 191 </div>
 192 </div>
 193 <a class="anchor" id="ae0eabdf0a8999bc27a9f319122175013"></a>
 194 <div class="memitem">
 195 <div class="memproto">
 196 <table class="mlabels">
 197   <tr>
 198   <td class="mlabels-left">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> </td>
 202           <td>(</td>
 203           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&#160;</td>
 204           <td class="paramname"></td><td>)</td>
 205           <td></td>
 206         </tr>
 207       </table>
 208   </td>
 209   <td class="mlabels-right">
 210 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 211   </tr>
 212 </table>
 213 </div><div class="memdoc">
 214
 215 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 216
 217 </div>
 218 </div>
 219 <a class="anchor" id="ae8090e64560fb80896bd682de4687343"></a>
 220 <div class="memitem">
 221 <div class="memproto">
 222 <table class="mlabels">
 223   <tr>
 224   <td class="mlabels-left">
 225       <table class="memname">
 226         <tr>
 227           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> </td>
 228           <td>(</td>
 229           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&amp;&#160;</td>
 230           <td class="paramname"></td><td>)</td>
 231           <td></td>
 232         </tr>
 233       </table>
 234   </td>
 235   <td class="mlabels-right">
 236 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 237   </tr>
 238 </table>
 239 </div><div class="memdoc">
 240
 241 <p>Allow instances of this class to be moved. </p>
 242
 243 </div>
 244 </div>
 245 <h2 class="groupheader">Member Function Documentation</h2>
 246 <a class="anchor" id="a8cd74e6bc7d3bcebbac4002717857601"></a>
 247 <div class="memitem">
 248 <div class="memproto">
 249       <table class="memname">
 250         <tr>
 251           <td class="memname">void configure </td>
 252           <td>(</td>
 253           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml">CLPyramid</a> *&#160;</td>
 254           <td class="paramname"><em>old_pyramid</em>, </td>
 255         </tr>
 256         <tr>
 257           <td class="paramkey"></td>
 258           <td></td>
 259           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml">CLPyramid</a> *&#160;</td>
 260           <td class="paramname"><em>new_pyramid</em>, </td>
 261         </tr>
 262         <tr>
 263           <td class="paramkey"></td>
 264           <td></td>
 265           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#adb969f0e554bf563f2fa671399d59280">ICLKeyPointArray</a> *&#160;</td>
 266           <td class="paramname"><em>old_points</em>, </td>
 267         </tr>
 268         <tr>
 269           <td class="paramkey"></td>
 270           <td></td>
 271           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#adb969f0e554bf563f2fa671399d59280">ICLKeyPointArray</a> *&#160;</td>
 272           <td class="paramname"><em>new_points_estimates</em>, </td>
 273         </tr>
 274         <tr>
 275           <td class="paramkey"></td>
 276           <td></td>
 277           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#adb969f0e554bf563f2fa671399d59280">ICLKeyPointArray</a> *&#160;</td>
 278           <td class="paramname"><em>new_points</em>, </td>
 279         </tr>
 280         <tr>
 281           <td class="paramkey"></td>
 282           <td></td>
 283           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a08c1503414e23f5dd10ff83492685453">Termination</a>&#160;</td>
 284           <td class="paramname"><em>termination</em>, </td>
 285         </tr>
 286         <tr>
 287           <td class="paramkey"></td>
 288           <td></td>
 289           <td class="paramtype">float&#160;</td>
 290           <td class="paramname"><em>epsilon</em>, </td>
 291         </tr>
 292         <tr>
 293           <td class="paramkey"></td>
 294           <td></td>
 295           <td class="paramtype">size_t&#160;</td>
 296           <td class="paramname"><em>num_iterations</em>, </td>
 297         </tr>
 298         <tr>
 299           <td class="paramkey"></td>
 300           <td></td>
 301           <td class="paramtype">size_t&#160;</td>
 302           <td class="paramname"><em>window_dimension</em>, </td>
 303         </tr>
 304         <tr>
 305           <td class="paramkey"></td>
 306           <td></td>
 307           <td class="paramtype">bool&#160;</td>
 308           <td class="paramname"><em>use_initial_estimate</em>, </td>
 309         </tr>
 310         <tr>
 311           <td class="paramkey"></td>
 312           <td></td>
 313           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a>&#160;</td>
 314           <td class="paramname"><em>border_mode</em>, </td>
 315         </tr>
 316         <tr>
 317           <td class="paramkey"></td>
 318           <td></td>
 319           <td class="paramtype">uint8_t&#160;</td>
 320           <td class="paramname"><em>constant_border_value</em> = <code>0</code>&#160;</td>
 321         </tr>
 322         <tr>
 323           <td></td>
 324           <td>)</td>
 325           <td></td><td></td>
 326         </tr>
 327       </table>
 328 </div><div class="memdoc">
 329
 330 <p>Initialise the function input and output. </p>
 331 <dl class="params"><dt>Parameters</dt><dd>
 332   <table class="params">
 333     <tr><td class="paramdir">[in]</td><td class="paramname">old_pyramid</td><td>Pointer to the pyramid for the old tensor. Data types supported U8 </td></tr>
 334     <tr><td class="paramdir">[in]</td><td class="paramname">new_pyramid</td><td>Pointer to the pyramid for the new tensor. Data types supported U8 </td></tr>
 335     <tr><td class="paramdir">[in]</td><td class="paramname">old_points</td><td>Pointer to the IKeyPointArray storing old key points </td></tr>
 336     <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>
 337     <tr><td class="paramdir">[out]</td><td class="paramname">new_points</td><td>Pointer to the IKeyPointArray storing new key points </td></tr>
 338     <tr><td class="paramdir">[in]</td><td class="paramname">termination</td><td>The criteria to terminate the search of each keypoint. </td></tr>
 339     <tr><td class="paramdir">[in]</td><td class="paramname">epsilon</td><td>The error for terminating the algorithm </td></tr>
 340     <tr><td class="paramdir">[in]</td><td class="paramname">num_iterations</td><td>The maximum number of iterations before terminate the alogrithm </td></tr>
 341     <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>
 342     <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>
 343     <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>The border mode applied at scharr kernel stage </td></tr>
 344     <tr><td class="paramdir">[in]</td><td class="paramname">constant_border_value</td><td>(Optional) Constant value to use for borders if border_mode is set to CONSTANT </td></tr>
 345   </table>
 346   </dd>
 347 </dl>
 348
 349 </div>
 350 </div>
 351 <a class="anchor" id="a68eed0e07674cc6e041d5dc0fecd8c27"></a>
 352 <div class="memitem">
 353 <div class="memproto">
 354 <table class="mlabels">
 355   <tr>
 356   <td class="mlabels-left">
 357       <table class="memname">
 358         <tr>
 359           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a>&amp; operator= </td>
 360           <td>(</td>
 361           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&#160;</td>
 362           <td class="paramname"></td><td>)</td>
 363           <td></td>
 364         </tr>
 365       </table>
 366   </td>
 367   <td class="mlabels-right">
 368 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 369   </tr>
 370 </table>
 371 </div><div class="memdoc">
 372
 373 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 374
 375 </div>
 376 </div>
 377 <a class="anchor" id="a24252fc100901855c82e8703834f9634"></a>
 378 <div class="memitem">
 379 <div class="memproto">
 380 <table class="mlabels">
 381   <tr>
 382   <td class="mlabels-left">
 383       <table class="memname">
 384         <tr>
 385           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a>&amp; operator= </td>
 386           <td>(</td>
 387           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_optical_flow.xhtml">CLOpticalFlow</a> &amp;&amp;&#160;</td>
 388           <td class="paramname"></td><td>)</td>
 389           <td></td>
 390         </tr>
 391       </table>
 392   </td>
 393   <td class="mlabels-right">
 394 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 395   </tr>
 396 </table>
 397 </div><div class="memdoc">
 398
 399 <p>Allow instances of this class to be moved. </p>
 400
 401 </div>
 402 </div>
 403 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 404 <div class="memitem">
 405 <div class="memproto">
 406 <table class="mlabels">
 407   <tr>
 408   <td class="mlabels-left">
 409       <table class="memname">
 410         <tr>
 411           <td class="memname">void run </td>
 412           <td>(</td>
 413           <td class="paramname"></td><td>)</td>
 414           <td></td>
 415         </tr>
 416       </table>
 417   </td>
 418   <td class="mlabels-right">
 419 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 420   </tr>
 421 </table>
 422 </div><div class="memdoc">
 423
 424 <p>Run the kernels contained in the function. </p>
 425 <p>For NEON kernels:</p><ul>
 426 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 427 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 428 </ul>
 429 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae9dc1846ff1612778bbac85d46344aef">CPPScheduler::force_number_of_threads()</a> can be used to manually set the number of threads</dd></dl>
 430 <p>For OpenCL kernels:</p><ul>
 431 <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue. ">CLScheduler</a>.</li>
 432 <li>The queue is then flushed.</li>
 433 </ul>
 434 <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd></dl>
 435
 436 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 437
 438 </div>
 439 </div>
 440 <hr/>The documentation for this class was generated from the following file:<ul>
 441 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_optical_flow_8h_source.xhtml">CLOpticalFlow.h</a></li>
 442 </ul>
 443 </div><!-- contents -->
 444 </div><!-- doc-content -->
 445 <!-- start footer part -->
 446 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 447   <ul>
 448     <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_optical_flow.xhtml">CLOpticalFlow</a></li>
 449     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 450     <a href="http://www.doxygen.org/index.html">
 451     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 452   </ul>
 453 </div>
 454 </body>
 455 </html>