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