documentation/classarm__compute_1_1_c_l_h_o_g_descriptor.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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: CLHOGDescriptor 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.10</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_h_o_g_descriptor.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">CLHOGDescriptor Class Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Basic function to calculate <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> descriptor.
 124  <a href="classarm__compute_1_1_c_l_h_o_g_descriptor.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_c_l_h_o_g_descriptor_8h_source.xhtml">CLHOGDescriptor.h</a>&gt;</code></p>
 127 <div class="dynheader">
 128 Collaboration diagram for CLHOGDescriptor:</div>
 129 <div class="dyncontent">
 130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_h_o_g_descriptor__coll__graph.svg" width="140" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 131 </div>
 132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 133 <table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 135 Public Member Functions</h2></td></tr>
 136 <tr class="memitem:abb1eeabf6e748dc681f66d43769ab9c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_h_o_g_descriptor.xhtml#abb1eeabf6e748dc681f66d43769ab9c5">CLHOGDescriptor</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>
 137 <tr class="memdesc:abb1eeabf6e748dc681f66d43769ab9c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#abb1eeabf6e748dc681f66d43769ab9c5">More...</a><br/></td></tr>
 138 <tr class="separator:abb1eeabf6e748dc681f66d43769ab9c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:aa13cb80b9e2387f342aa75b205529a10"><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_h_o_g_descriptor.xhtml#aa13cb80b9e2387f342aa75b205529a10">configure</a> (<a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output, const <a class="el" href="classarm__compute_1_1_i_h_o_g.xhtml">IHOG</a> *hog, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value=0)</td></tr>
 140 <tr class="memdesc:aa13cb80b9e2387f342aa75b205529a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the function's source, destination, <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> data-object and border mode.  <a href="#aa13cb80b9e2387f342aa75b205529a10">More...</a><br/></td></tr>
 141 <tr class="separator:aa13cb80b9e2387f342aa75b205529a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <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_h_o_g_descriptor.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 143 <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>
 144 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <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>
 146 <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>
 147 <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>
 148 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table>
 150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 151 <div class="textblock"><p>Basic function to calculate <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> descriptor. </p>
 152 <p>This function calls the following OpenCL kernels:</p>
 153 <ol type="1">
 154 <li><a class="el" href="classarm__compute_1_1_c_l_h_o_g_gradient.xhtml">CLHOGGradient</a></li>
 155 <li><a class="el" href="classarm__compute_1_1_c_l_h_o_g_orientation_binning_kernel.xhtml">CLHOGOrientationBinningKernel</a></li>
 156 <li><a class="el" href="classarm__compute_1_1_c_l_h_o_g_block_normalization_kernel.xhtml">CLHOGBlockNormalizationKernel</a> </li>
 157 </ol>
 158
 159 <p>Definition at line <a class="el" href="_c_l_h_o_g_descriptor_8h_source.xhtml#l00047">47</a> of file <a class="el" href="_c_l_h_o_g_descriptor_8h_source.xhtml">CLHOGDescriptor.h</a>.</p>
 160 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 161 <a class="anchor" id="abb1eeabf6e748dc681f66d43769ab9c5"></a>
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_h_o_g_descriptor.xhtml">CLHOGDescriptor</a> </td>
 167           <td>(</td>
 168           <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt;&#160;</td>
 169           <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td>
 170           <td></td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174
 175 <p>Default constructor. </p>
 176
 177 </div>
 178 </div>
 179 <h2 class="groupheader">Member Function Documentation</h2>
 180 <a class="anchor" id="aa13cb80b9e2387f342aa75b205529a10"></a>
 181 <div class="memitem">
 182 <div class="memproto">
 183       <table class="memname">
 184         <tr>
 185           <td class="memname">void configure </td>
 186           <td>(</td>
 187           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 188           <td class="paramname"><em>input</em>, </td>
 189         </tr>
 190         <tr>
 191           <td class="paramkey"></td>
 192           <td></td>
 193           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 194           <td class="paramname"><em>output</em>, </td>
 195         </tr>
 196         <tr>
 197           <td class="paramkey"></td>
 198           <td></td>
 199           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_h_o_g.xhtml">IHOG</a> *&#160;</td>
 200           <td class="paramname"><em>hog</em>, </td>
 201         </tr>
 202         <tr>
 203           <td class="paramkey"></td>
 204           <td></td>
 205           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a>&#160;</td>
 206           <td class="paramname"><em>border_mode</em>, </td>
 207         </tr>
 208         <tr>
 209           <td class="paramkey"></td>
 210           <td></td>
 211           <td class="paramtype">uint8_t&#160;</td>
 212           <td class="paramname"><em>constant_border_value</em> = <code>0</code>&#160;</td>
 213         </tr>
 214         <tr>
 215           <td></td>
 216           <td>)</td>
 217           <td></td><td></td>
 218         </tr>
 219       </table>
 220 </div><div class="memdoc">
 221
 222 <p>Initialise the function's source, destination, <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> data-object and border mode. </p>
 223 <dl class="params"><dt>Parameters</dt><dd>
 224   <table class="params">
 225     <tr><td class="paramdir">[in,out]</td><td class="paramname">input</td><td>Input tensor. Data type supported: U8 (Written to only for <code>border_mode</code> != UNDEFINED) </td></tr>
 226     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Output tensor which stores the <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> descriptor. DataType supported: F32. The number of channels is equal to the number of histogram bins per block </td></tr>
 227     <tr><td class="paramdir">[in]</td><td class="paramname">hog</td><td><a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> data object which describes the <a class="el" href="classarm__compute_1_1_h_o_g.xhtml" title="CPU implementation of HOG data-object. ">HOG</a> descriptor </td></tr>
 228     <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Border mode to use. </td></tr>
 229     <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>
 230   </table>
 231   </dd>
 232 </dl>
 233
 234 </div>
 235 </div>
 236 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 237 <div class="memitem">
 238 <div class="memproto">
 239 <table class="mlabels">
 240   <tr>
 241   <td class="mlabels-left">
 242       <table class="memname">
 243         <tr>
 244           <td class="memname">void run </td>
 245           <td>(</td>
 246           <td class="paramname"></td><td>)</td>
 247           <td></td>
 248         </tr>
 249       </table>
 250   </td>
 251   <td class="mlabels-right">
 252 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 253   </tr>
 254 </table>
 255 </div><div class="memdoc">
 256
 257 <p>Run the kernels contained in the function. </p>
 258 <p>For NEON kernels:</p>
 259 <ul>
 260 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 261 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 262 </ul>
 263 <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>
 264 <p>For OpenCL kernels:</p>
 265 <ul>
 266 <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>
 267 <li>The queue is then flushed.</li>
 268 </ul>
 269 <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>
 270
 271 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 272
 273 </div>
 274 </div>
 275 <hr/>The documentation for this class was generated from the following file:<ul>
 276 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_h_o_g_descriptor_8h_source.xhtml">CLHOGDescriptor.h</a></li>
 277 </ul>
 278 </div><!-- contents -->
 279 </div><!-- doc-content -->
 280 <!-- start footer part -->
 281 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 282   <ul>
 283     <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_h_o_g_descriptor.xhtml">CLHOGDescriptor</a></li>
 284     <li class="footer">Generated on Thu Oct 12 2017 14:26:37 for Compute Library by
 285     <a href="http://www.doxygen.org/index.html">
 286     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 287   </ul>
 288 </div>
 289 </body>
 290 </html>