documentation/classarm__compute_1_1_c_l_pyramid.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: CLPyramid 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_pyramid.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">CLPyramid Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Basic implementation of the OpenCL pyramid interface.
 126  <a href="classarm__compute_1_1_c_l_pyramid.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_c_l_pyramid_8h_source.xhtml">CLPyramid.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for CLPyramid:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_pyramid__coll__graph.svg" width="102" 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:a24edddb8cac90e092ecbd4a2d2a1ce59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#a24edddb8cac90e092ecbd4a2d2a1ce59">CLPyramid</a> ()</td></tr>
 139 <tr class="memdesc:a24edddb8cac90e092ecbd4a2d2a1ce59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a24edddb8cac90e092ecbd4a2d2a1ce59">More...</a><br /></td></tr>
 140 <tr class="separator:a24edddb8cac90e092ecbd4a2d2a1ce59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ae4e11cca76492d63009564d1ea466dff"><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_pyramid.xhtml#ae4e11cca76492d63009564d1ea466dff">init</a> (const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;<a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a>)</td></tr>
 142 <tr class="memdesc:ae4e11cca76492d63009564d1ea466dff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata.  <a href="#ae4e11cca76492d63009564d1ea466dff">More...</a><br /></td></tr>
 143 <tr class="separator:ae4e11cca76492d63009564d1ea466dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a0dd473fd109df68b4747ebf0f586a115"><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_pyramid.xhtml#a0dd473fd109df68b4747ebf0f586a115">init_auto_padding</a> (const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;<a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a>)</td></tr>
 145 <tr class="memdesc:a0dd473fd109df68b4747ebf0f586a115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata.  <a href="#a0dd473fd109df68b4747ebf0f586a115">More...</a><br /></td></tr>
 146 <tr class="separator:a0dd473fd109df68b4747ebf0f586a115"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:acaefe811b78a2fdc4a0dba0c4029c3ef"><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_pyramid.xhtml#acaefe811b78a2fdc4a0dba0c4029c3ef">allocate</a> ()</td></tr>
 148 <tr class="memdesc:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate the planes in the pyramid.  <a href="#acaefe811b78a2fdc4a0dba0c4029c3ef">More...</a><br /></td></tr>
 149 <tr class="separator:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ac1b010c3c67886aa4add531ed3bbceac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a> () const override</td></tr>
 151 <tr class="memdesc:ac1b010c3c67886aa4add531ed3bbceac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata.  <a href="#ac1b010c3c67886aa4add531ed3bbceac">More...</a><br /></td></tr>
 152 <tr class="separator:ac1b010c3c67886aa4add531ed3bbceac"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:af07bb423a5c0df8018b67c0e94fada02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_tensor.xhtml">CLTensor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml#af07bb423a5c0df8018b67c0e94fada02">get_pyramid_level</a> (size_t index) const override</td></tr>
 154 <tr class="memdesc:af07bb423a5c0df8018b67c0e94fada02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a level of the pyramid as a <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a> pointer.  <a href="#af07bb423a5c0df8018b67c0e94fada02">More...</a><br /></td></tr>
 155 <tr class="separator:af07bb423a5c0df8018b67c0e94fada02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_pyramid"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_pyramid')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml">IPyramid</a></td></tr>
 157 <tr class="memitem:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a2925d59af502d059fcb2326a6ada7867">~IPyramid</a> ()=default</td></tr>
 158 <tr class="memdesc:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a2925d59af502d059fcb2326a6ada7867">More...</a><br /></td></tr>
 159 <tr class="separator:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 </table>
 161 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 162 <div class="textblock"><p>Basic implementation of the OpenCL pyramid interface. </p>
 163
 164 <p>Definition at line <a class="el" href="_c_l_pyramid_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_c_l_pyramid_8h_source.xhtml">CLPyramid.h</a>.</p>
 165 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 166 <a class="anchor" id="a24edddb8cac90e092ecbd4a2d2a1ce59"></a>
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_pyramid.xhtml">CLPyramid</a> </td>
 172           <td>(</td>
 173           <td class="paramname"></td><td>)</td>
 174           <td></td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178
 179 <p>Default constructor. </p>
 180
 181 </div>
 182 </div>
 183 <h2 class="groupheader">Member Function Documentation</h2>
 184 <a class="anchor" id="acaefe811b78a2fdc4a0dba0c4029c3ef"></a>
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">void allocate </td>
 190           <td>(</td>
 191           <td class="paramname"></td><td>)</td>
 192           <td></td>
 193         </tr>
 194       </table>
 195 </div><div class="memdoc">
 196
 197 <p>Allocate the planes in the pyramid. </p>
 198 <dl class="section note"><dt>Note</dt><dd>The pyramid must not already be allocated when calling this function. </dd></dl>
 199
 200 </div>
 201 </div>
 202 <a class="anchor" id="af07bb423a5c0df8018b67c0e94fada02"></a>
 203 <div class="memitem">
 204 <div class="memproto">
 205 <table class="mlabels">
 206   <tr>
 207   <td class="mlabels-left">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_tensor.xhtml">CLTensor</a>* get_pyramid_level </td>
 211           <td>(</td>
 212           <td class="paramtype">size_t&#160;</td>
 213           <td class="paramname"><em>index</em></td><td>)</td>
 214           <td> const</td>
 215         </tr>
 216       </table>
 217   </td>
 218   <td class="mlabels-right">
 219 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 220   </tr>
 221 </table>
 222 </div><div class="memdoc">
 223
 224 <p>Retrieves a level of the pyramid as a <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a> pointer. </p>
 225 <dl class="params"><dt>Parameters</dt><dd>
 226   <table class="params">
 227     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the level, such that index is less than levels.</td></tr>
 228   </table>
 229   </dd>
 230 </dl>
 231 <dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a> pointer </dd></dl>
 232
 233 <p>Implements <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a11ab83492962adab883cb1d0fbdd7af6">IPyramid</a>.</p>
 234
 235 <p>Referenced by <a class="el" href="_c_l_2_gaussian_pyramid_8cpp_source.xhtml#l00073">arm_compute::test::validation::DATA_TEST_CASE()</a>.</p>
 236
 237 </div>
 238 </div>
 239 <a class="anchor" id="ac1b010c3c67886aa4add531ed3bbceac"></a>
 240 <div class="memitem">
 241 <div class="memproto">
 242 <table class="mlabels">
 243   <tr>
 244   <td class="mlabels-left">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a>* info </td>
 248           <td>(</td>
 249           <td class="paramname"></td><td>)</td>
 250           <td> const</td>
 251         </tr>
 252       </table>
 253   </td>
 254   <td class="mlabels-right">
 255 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 256   </tr>
 257 </table>
 258 </div><div class="memdoc">
 259
 260 <p>Interface to be implemented by the child class to return the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
 261 <dl class="section return"><dt>Returns</dt><dd>A pointer to the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </dd></dl>
 262
 263 <p>Implements <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a7114241d28b1d2ebb7b9dba9f1ab0c8b">IPyramid</a>.</p>
 264
 265 </div>
 266 </div>
 267 <a class="anchor" id="ae4e11cca76492d63009564d1ea466dff"></a>
 268 <div class="memitem">
 269 <div class="memproto">
 270       <table class="memname">
 271         <tr>
 272           <td class="memname">void init </td>
 273           <td>(</td>
 274           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td>
 275           <td class="paramname"><em>info</em></td><td>)</td>
 276           <td></td>
 277         </tr>
 278       </table>
 279 </div><div class="memdoc">
 280
 281 <p>Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
 282 <dl class="params"><dt>Parameters</dt><dd>
 283   <table class="params">
 284     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td><a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata </td></tr>
 285   </table>
 286   </dd>
 287 </dl>
 288
 289 <p>Referenced by <a class="el" href="_c_l_2_gaussian_pyramid_8cpp_source.xhtml#l00073">arm_compute::test::validation::DATA_TEST_CASE()</a>.</p>
 290
 291 </div>
 292 </div>
 293 <a class="anchor" id="a0dd473fd109df68b4747ebf0f586a115"></a>
 294 <div class="memitem">
 295 <div class="memproto">
 296       <table class="memname">
 297         <tr>
 298           <td class="memname">void init_auto_padding </td>
 299           <td>(</td>
 300           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td>
 301           <td class="paramname"><em>info</em></td><td>)</td>
 302           <td></td>
 303         </tr>
 304       </table>
 305 </div><div class="memdoc">
 306
 307 <p>Initialize pyramid data-object using the given <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
 308 <dl class="section note"><dt>Note</dt><dd>Uses conservative padding strategy which fits all kernels.</dd></dl>
 309 <dl class="params"><dt>Parameters</dt><dd>
 310   <table class="params">
 311     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td><a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata </td></tr>
 312   </table>
 313   </dd>
 314 </dl>
 315
 316 </div>
 317 </div>
 318 <hr/>The documentation for this class was generated from the following file:<ul>
 319 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_pyramid_8h_source.xhtml">CLPyramid.h</a></li>
 320 </ul>
 321 </div><!-- contents -->
 322 </div><!-- doc-content -->
 323 <!-- start footer part -->
 324 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 325   <ul>
 326     <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_pyramid.xhtml">CLPyramid</a></li>
 327     <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
 328     <a href="http://www.doxygen.org/index.html">
 329     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 330   </ul>
 331 </div>
 332 </body>
 333 </html>