documentation/classarm__compute_1_1_n_e_harris_corners.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: NEHarrisCorners 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_harris_corners.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">NEHarrisCorners Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Basic function to execute harris corners detection.
 126  <a href="classarm__compute_1_1_n_e_harris_corners.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_n_e_harris_corners_8h_source.xhtml">NEHarrisCorners.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for NEHarrisCorners:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_harris_corners__coll__graph.svg" width="139" 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:a2e2017552e622fdfca6e14066fb83806"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_harris_corners.xhtml#a2e2017552e622fdfca6e14066fb83806">NEHarrisCorners</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:a2e2017552e622fdfca6e14066fb83806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a2e2017552e622fdfca6e14066fb83806">More...</a><br /></td></tr>
 140 <tr class="separator:a2e2017552e622fdfca6e14066fb83806"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ac8648d69d8b453c5143c14e3811346c3"><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_harris_corners.xhtml#ac8648d69d8b453c5143c14e3811346c3">configure</a> (<a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *input, float threshold, float min_dist, float sensitivity, int32_t gradient_size, int32_t block_size, <a class="el" href="namespacearm__compute.xhtml#a8856eca9a83e16bb0cb5880e9c6c9fe7">KeyPointArray</a> *corners, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value=0, bool use_fp16=false)</td></tr>
 142 <tr class="memdesc:ac8648d69d8b453c5143c14e3811346c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the function's source, destination, conv and border_mode.  <a href="#ac8648d69d8b453c5143c14e3811346c3">More...</a><br /></td></tr>
 143 <tr class="separator:ac8648d69d8b453c5143c14e3811346c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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_n_e_harris_corners.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 145 <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>
 146 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <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>
 149 <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>
 150 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <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>
 152 <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>
 153 <tr class="separator:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 </table>
 155 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 156 <div class="textblock"><p>Basic function to execute harris corners detection. </p>
 157 <p>This function calls the following NEON kernels and functions:</p>
 158 <ol type="1">
 159 <li><a class="el" href="classarm__compute_1_1_n_e_sobel3x3.xhtml">NESobel3x3</a> (if gradient_size == 3) or<br />
 160  <a class="el" href="classarm__compute_1_1_n_e_sobel5x5.xhtml">NESobel5x5</a> (if gradient_size == 5) or<br />
 161  <a class="el" href="classarm__compute_1_1_n_e_sobel7x7.xhtml">NESobel7x7</a> (if gradient_size == 7)</li>
 162 <li><a class="el" href="classarm__compute_1_1_n_e_fill_border_kernel.xhtml">NEFillBorderKernel</a></li>
 163 <li>NEHarrisScoreKernel&lt;3&gt; (if block_size == 3) or<br />
 164  NEHarrisScoreKernel&lt;5&gt; (if block_size == 5) or<br />
 165  NEHarrisScoreKernel&lt;7&gt; (if block_size == 7)</li>
 166 <li><a class="el" href="classarm__compute_1_1_n_e_non_maxima_suppression3x3.xhtml">NENonMaximaSuppression3x3</a></li>
 167 <li><a class="el" href="classarm__compute_1_1_c_p_p_corner_candidates_kernel.xhtml">CPPCornerCandidatesKernel</a></li>
 168 <li><a class="el" href="classarm__compute_1_1_c_p_p_sort_euclidean_distance_kernel.xhtml">CPPSortEuclideanDistanceKernel</a> </li>
 169 </ol>
 170
 171 <p>Definition at line <a class="el" href="_n_e_harris_corners_8h_source.xhtml#l00061">61</a> of file <a class="el" href="_n_e_harris_corners_8h_source.xhtml">NEHarrisCorners.h</a>.</p>
 172 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 173 <a class="anchor" id="a2e2017552e622fdfca6e14066fb83806"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_harris_corners.xhtml">NEHarrisCorners</a> </td>
 179           <td>(</td>
 180           <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt;&#160;</td>
 181           <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td>
 182           <td></td>
 183         </tr>
 184       </table>
 185 </div><div class="memdoc">
 186
 187 <p>Constructor. </p>
 188 <p>Initialize _sobel, _harris_score and _corner_list to nullptr.</p>
 189 <dl class="params"><dt>Parameters</dt><dd>
 190   <table class="params">
 191     <tr><td class="paramdir">[in]</td><td class="paramname">memory_manager</td><td>(Optional) <a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> manager. </td></tr>
 192   </table>
 193   </dd>
 194 </dl>
 195
 196 </div>
 197 </div>
 198 <h2 class="groupheader">Member Function Documentation</h2>
 199 <a class="anchor" id="ac8648d69d8b453c5143c14e3811346c3"></a>
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">void configure </td>
 205           <td>(</td>
 206           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
 207           <td class="paramname"><em>input</em>, </td>
 208         </tr>
 209         <tr>
 210           <td class="paramkey"></td>
 211           <td></td>
 212           <td class="paramtype">float&#160;</td>
 213           <td class="paramname"><em>threshold</em>, </td>
 214         </tr>
 215         <tr>
 216           <td class="paramkey"></td>
 217           <td></td>
 218           <td class="paramtype">float&#160;</td>
 219           <td class="paramname"><em>min_dist</em>, </td>
 220         </tr>
 221         <tr>
 222           <td class="paramkey"></td>
 223           <td></td>
 224           <td class="paramtype">float&#160;</td>
 225           <td class="paramname"><em>sensitivity</em>, </td>
 226         </tr>
 227         <tr>
 228           <td class="paramkey"></td>
 229           <td></td>
 230           <td class="paramtype">int32_t&#160;</td>
 231           <td class="paramname"><em>gradient_size</em>, </td>
 232         </tr>
 233         <tr>
 234           <td class="paramkey"></td>
 235           <td></td>
 236           <td class="paramtype">int32_t&#160;</td>
 237           <td class="paramname"><em>block_size</em>, </td>
 238         </tr>
 239         <tr>
 240           <td class="paramkey"></td>
 241           <td></td>
 242           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a8856eca9a83e16bb0cb5880e9c6c9fe7">KeyPointArray</a> *&#160;</td>
 243           <td class="paramname"><em>corners</em>, </td>
 244         </tr>
 245         <tr>
 246           <td class="paramkey"></td>
 247           <td></td>
 248           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a>&#160;</td>
 249           <td class="paramname"><em>border_mode</em>, </td>
 250         </tr>
 251         <tr>
 252           <td class="paramkey"></td>
 253           <td></td>
 254           <td class="paramtype">uint8_t&#160;</td>
 255           <td class="paramname"><em>constant_border_value</em> = <code>0</code>, </td>
 256         </tr>
 257         <tr>
 258           <td class="paramkey"></td>
 259           <td></td>
 260           <td class="paramtype">bool&#160;</td>
 261           <td class="paramname"><em>use_fp16</em> = <code>false</code>&#160;</td>
 262         </tr>
 263         <tr>
 264           <td></td>
 265           <td>)</td>
 266           <td></td><td></td>
 267         </tr>
 268       </table>
 269 </div><div class="memdoc">
 270
 271 <p>Initialize the function's source, destination, conv and border_mode. </p>
 272 <dl class="params"><dt>Parameters</dt><dd>
 273   <table class="params">
 274     <tr><td class="paramdir">[in,out]</td><td class="paramname">input</td><td>Source image. Data type supported: U8. (Written to only for <code>border_mode</code> != UNDEFINED) </td></tr>
 275     <tr><td class="paramdir">[in]</td><td class="paramname">threshold</td><td>Minimum threshold with which to eliminate Harris Corner scores (computed using the normalized Sobel kernel). </td></tr>
 276     <tr><td class="paramdir">[in]</td><td class="paramname">min_dist</td><td>Radial Euclidean distance for the euclidean diatance stage </td></tr>
 277     <tr><td class="paramdir">[in]</td><td class="paramname">sensitivity</td><td>Sensitivity threshold k from the Harris-Stephens equation </td></tr>
 278     <tr><td class="paramdir">[in]</td><td class="paramname">gradient_size</td><td>The gradient window size to use on the input. The implementation supports 3, 5, and 7 </td></tr>
 279     <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>The block window size used to compute the Harris Corner score. The implementation supports 3, 5, and 7. </td></tr>
 280     <tr><td class="paramdir">[out]</td><td class="paramname">corners</td><td><a class="el" href="classarm__compute_1_1_array.xhtml" title="Basic implementation of the IArray interface which allocates a static number of T values...">Array</a> of keypoints to store the results. </td></tr>
 281     <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Border mode to use </td></tr>
 282     <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>
 283     <tr><td class="paramdir">[in]</td><td class="paramname">use_fp16</td><td>(Optional) If true the FP16 kernels will be used. If false F32 kernels are used. </td></tr>
 284   </table>
 285   </dd>
 286 </dl>
 287
 288 </div>
 289 </div>
 290 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 291 <div class="memitem">
 292 <div class="memproto">
 293 <table class="mlabels">
 294   <tr>
 295   <td class="mlabels-left">
 296       <table class="memname">
 297         <tr>
 298           <td class="memname">void run </td>
 299           <td>(</td>
 300           <td class="paramname"></td><td>)</td>
 301           <td></td>
 302         </tr>
 303       </table>
 304   </td>
 305   <td class="mlabels-right">
 306 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 307   </tr>
 308 </table>
 309 </div><div class="memdoc">
 310
 311 <p>Run the kernels contained in the function. </p>
 312 <p>For NEON kernels:</p><ul>
 313 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 314 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 315 </ul>
 316 <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>
 317 <p>For OpenCL kernels:</p><ul>
 318 <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>
 319 <li>The queue is then flushed.</li>
 320 </ul>
 321 <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>
 322 <dd>
 323 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>
 324
 325 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 326
 327 </div>
 328 </div>
 329 <hr/>The documentation for this class was generated from the following file:<ul>
 330 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_harris_corners_8h_source.xhtml">NEHarrisCorners.h</a></li>
 331 </ul>
 332 </div><!-- contents -->
 333 </div><!-- doc-content -->
 334 <!-- start footer part -->
 335 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 336   <ul>
 337     <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_harris_corners.xhtml">NEHarrisCorners</a></li>
 338     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
 339     <a href="http://www.doxygen.org/index.html">
 340     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 341   </ul>
 342 </div>
 343 </body>
 344 </html>