documentation/classarm__compute_1_1_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: Pyramid 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.02</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_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">Pyramid Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Basic implementation of the pyramid interface.
 126  <a href="classarm__compute_1_1_pyramid.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_pyramid_8h_source.xhtml">Pyramid.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for Pyramid:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_pyramid__coll__graph.svg" width="88" 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:ae4e11cca76492d63009564d1ea466dff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_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_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a>)</td></tr>
 139 <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>
 140 <tr class="separator:ae4e11cca76492d63009564d1ea466dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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_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_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a>)</td></tr>
 142 <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>
 143 <tr class="separator:a0dd473fd109df68b4747ebf0f586a115"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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_pyramid.xhtml#acaefe811b78a2fdc4a0dba0c4029c3ef">allocate</a> ()</td></tr>
 145 <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>
 146 <tr class="separator:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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_pyramid.xhtml#ac1b010c3c67886aa4add531ed3bbceac">info</a> () const override</td></tr>
 148 <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>
 149 <tr class="separator:ac1b010c3c67886aa4add531ed3bbceac"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:a4187fb90f552249901da9febb67d8b7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid.xhtml#a4187fb90f552249901da9febb67d8b7a">get_pyramid_level</a> (size_t index) const override</td></tr>
 151 <tr class="memdesc:a4187fb90f552249901da9febb67d8b7a"><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="#a4187fb90f552249901da9febb67d8b7a">More...</a><br /></td></tr>
 152 <tr class="separator:a4187fb90f552249901da9febb67d8b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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>
 154 <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>
 155 <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>
 156 <tr class="separator:a2925d59af502d059fcb2326a6ada7867 inherit pub_methods_classarm__compute_1_1_i_pyramid"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 </table>
 158 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 159 <div class="textblock"><p>Basic implementation of the pyramid interface. </p>
 160
 161 <p>Definition at line <a class="el" href="_pyramid_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_pyramid_8h_source.xhtml">Pyramid.h</a>.</p>
 162 </div><h2 class="groupheader">Member Function Documentation</h2>
 163 <a class="anchor" id="acaefe811b78a2fdc4a0dba0c4029c3ef"></a>
 164 <div class="memitem">
 165 <div class="memproto">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname">void allocate </td>
 169           <td>(</td>
 170           <td class="paramname"></td><td>)</td>
 171           <td></td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p>Allocate the planes in the pyramid. </p>
 177
 178 </div>
 179 </div>
 180 <a class="anchor" id="a4187fb90f552249901da9febb67d8b7a"></a>
 181 <div class="memitem">
 182 <div class="memproto">
 183 <table class="mlabels">
 184   <tr>
 185   <td class="mlabels-left">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a>* get_pyramid_level </td>
 189           <td>(</td>
 190           <td class="paramtype">size_t&#160;</td>
 191           <td class="paramname"><em>index</em></td><td>)</td>
 192           <td> const</td>
 193         </tr>
 194       </table>
 195   </td>
 196   <td class="mlabels-right">
 197 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 198   </tr>
 199 </table>
 200 </div><div class="memdoc">
 201
 202 <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>
 203 <dl class="params"><dt>Parameters</dt><dd>
 204   <table class="params">
 205     <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>
 206   </table>
 207   </dd>
 208 </dl>
 209 <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>
 210
 211 <p>Implements <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a11ab83492962adab883cb1d0fbdd7af6">IPyramid</a>.</p>
 212
 213 <p>Referenced by <a class="el" href="_gaussian_pyramid_8cpp_source.xhtml#l00074">arm_compute::test::validation::DATA_TEST_CASE()</a>.</p>
 214
 215 </div>
 216 </div>
 217 <a class="anchor" id="ac1b010c3c67886aa4add531ed3bbceac"></a>
 218 <div class="memitem">
 219 <div class="memproto">
 220 <table class="mlabels">
 221   <tr>
 222   <td class="mlabels-left">
 223       <table class="memname">
 224         <tr>
 225           <td class="memname">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a>* info </td>
 226           <td>(</td>
 227           <td class="paramname"></td><td>)</td>
 228           <td> const</td>
 229         </tr>
 230       </table>
 231   </td>
 232   <td class="mlabels-right">
 233 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 234   </tr>
 235 </table>
 236 </div><div class="memdoc">
 237
 238 <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>
 239 <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>
 240
 241 <p>Implements <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml#a7114241d28b1d2ebb7b9dba9f1ab0c8b">IPyramid</a>.</p>
 242
 243 </div>
 244 </div>
 245 <a class="anchor" id="ae4e11cca76492d63009564d1ea466dff"></a>
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">void init </td>
 251           <td>(</td>
 252           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td>
 253           <td class="paramname"><em>info</em></td><td>)</td>
 254           <td></td>
 255         </tr>
 256       </table>
 257 </div><div class="memdoc">
 258
 259 <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>
 260 <dl class="params"><dt>Parameters</dt><dd>
 261   <table class="params">
 262     <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>
 263   </table>
 264   </dd>
 265 </dl>
 266
 267 <p>Referenced by <a class="el" href="_gaussian_pyramid_8cpp_source.xhtml#l00074">arm_compute::test::validation::DATA_TEST_CASE()</a>.</p>
 268
 269 </div>
 270 </div>
 271 <a class="anchor" id="a0dd473fd109df68b4747ebf0f586a115"></a>
 272 <div class="memitem">
 273 <div class="memproto">
 274       <table class="memname">
 275         <tr>
 276           <td class="memname">void init_auto_padding </td>
 277           <td>(</td>
 278           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td>
 279           <td class="paramname"><em>info</em></td><td>)</td>
 280           <td></td>
 281         </tr>
 282       </table>
 283 </div><div class="memdoc">
 284
 285 <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>
 286 <dl class="section note"><dt>Note</dt><dd>Uses conservative padding strategy which fits all kernels.</dd></dl>
 287 <dl class="params"><dt>Parameters</dt><dd>
 288   <table class="params">
 289     <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>
 290   </table>
 291   </dd>
 292 </dl>
 293
 294 </div>
 295 </div>
 296 <hr/>The documentation for this class was generated from the following file:<ul>
 297 <li>arm_compute/runtime/<a class="el" href="_pyramid_8h_source.xhtml">Pyramid.h</a></li>
 298 </ul>
 299 </div><!-- contents -->
 300 </div><!-- doc-content -->
 301 <!-- start footer part -->
 302 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 303   <ul>
 304     <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_pyramid.xhtml">Pyramid</a></li>
 305     <li class="footer">Generated on Thu Feb 22 2018 15:45:25 for Compute Library by
 306     <a href="http://www.doxygen.org/index.html">
 307     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 308   </ul>
 309 </div>
 310 </body>
 311 </html>