documentation/classarm__compute_1_1_pyramid_info.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>ARM Compute Library: PyramidInfo 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_pyramid_info.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">PyramidInfo Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Store the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata.
 125  <a href="classarm__compute_1_1_pyramid_info.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_pyramid_info_8h_source.xhtml">PyramidInfo.h</a>&gt;</code></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 130 Public Member Functions</h2></td></tr>
 131 <tr class="memitem:a9e7e3f78b86c0a7f2cdd1ab1e836b2ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a9e7e3f78b86c0a7f2cdd1ab1e836b2ed">PyramidInfo</a> ()</td></tr>
 132 <tr class="memdesc:a9e7e3f78b86c0a7f2cdd1ab1e836b2ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a9e7e3f78b86c0a7f2cdd1ab1e836b2ed">More...</a><br /></td></tr>
 133 <tr class="separator:a9e7e3f78b86c0a7f2cdd1ab1e836b2ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:a443529237e92a4364aaf662644dfc686"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a443529237e92a4364aaf662644dfc686">~PyramidInfo</a> ()=default</td></tr>
 135 <tr class="memdesc:a443529237e92a4364aaf662644dfc686"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a443529237e92a4364aaf662644dfc686">More...</a><br /></td></tr>
 136 <tr class="separator:a443529237e92a4364aaf662644dfc686"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:a9ace7670f345dde6c78d6b3314f3d756"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a9ace7670f345dde6c78d6b3314f3d756">PyramidInfo</a> (const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;)=default</td></tr>
 138 <tr class="memdesc:a9ace7670f345dde6c78d6b3314f3d756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copy constructed.  <a href="#a9ace7670f345dde6c78d6b3314f3d756">More...</a><br /></td></tr>
 139 <tr class="separator:a9ace7670f345dde6c78d6b3314f3d756"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a21310a3eef49fc4f04b98897fc785b34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a21310a3eef49fc4f04b98897fc785b34">operator=</a> (const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;)=default</td></tr>
 141 <tr class="memdesc:a21310a3eef49fc4f04b98897fc785b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copied.  <a href="#a21310a3eef49fc4f04b98897fc785b34">More...</a><br /></td></tr>
 142 <tr class="separator:a21310a3eef49fc4f04b98897fc785b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:ab38f8d031a5cb0f5d807a180e7107fdd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ab38f8d031a5cb0f5d807a180e7107fdd">PyramidInfo</a> (<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&amp;)=default</td></tr>
 144 <tr class="memdesc:ab38f8d031a5cb0f5d807a180e7107fdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#ab38f8d031a5cb0f5d807a180e7107fdd">More...</a><br /></td></tr>
 145 <tr class="separator:ab38f8d031a5cb0f5d807a180e7107fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a09f1ed0da3ccc973d44d1156aff150f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a09f1ed0da3ccc973d44d1156aff150f9">operator=</a> (<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:a09f1ed0da3ccc973d44d1156aff150f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a09f1ed0da3ccc973d44d1156aff150f9">More...</a><br /></td></tr>
 148 <tr class="separator:a09f1ed0da3ccc973d44d1156aff150f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a6365834dc65fb5cc59cd17aea308db13"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a6365834dc65fb5cc59cd17aea308db13">PyramidInfo</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a20646dd69e82674924c6e5eb1458eefa">width</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0e3c6ba1d3f8a8e50aa3e3897210a2b">height</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
 150 <tr class="memdesc:a6365834dc65fb5cc59cd17aea308db13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create pyramid info for 2D tensors.  <a href="#a6365834dc65fb5cc59cd17aea308db13">More...</a><br /></td></tr>
 151 <tr class="separator:a6365834dc65fb5cc59cd17aea308db13"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ae79dbf996c991c72eee4f1d9122152ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ae79dbf996c991c72eee4f1d9122152ef">PyramidInfo</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#af3374fa8fcc6d226dc2b82317ab4d079">tensor_shape</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
 153 <tr class="memdesc:ae79dbf996c991c72eee4f1d9122152ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create pyramid info using <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a>.  <a href="#ae79dbf996c991c72eee4f1d9122152ef">More...</a><br /></td></tr>
 154 <tr class="separator:ae79dbf996c991c72eee4f1d9122152ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:a741486bedb7b0966b1d4e6e7c6cccf60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a741486bedb7b0966b1d4e6e7c6cccf60">init</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a20646dd69e82674924c6e5eb1458eefa">width</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0e3c6ba1d3f8a8e50aa3e3897210a2b">height</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
 156 <tr class="memdesc:a741486bedb7b0966b1d4e6e7c6cccf60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize pyramid's metadata for 2D tensors.  <a href="#a741486bedb7b0966b1d4e6e7c6cccf60">More...</a><br /></td></tr>
 157 <tr class="separator:a741486bedb7b0966b1d4e6e7c6cccf60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:a51a4719902c69a814ccc638963b3074e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a51a4719902c69a814ccc638963b3074e">init</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#af3374fa8fcc6d226dc2b82317ab4d079">tensor_shape</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
 159 <tr class="memdesc:a51a4719902c69a814ccc638963b3074e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize pyramid's metadata using <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a>.  <a href="#a51a4719902c69a814ccc638963b3074e">More...</a><br /></td></tr>
 160 <tr class="separator:a51a4719902c69a814ccc638963b3074e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:a14af062b9f957e61e4efe171fe7065a3"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a> () const </td></tr>
 162 <tr class="memdesc:a14af062b9f957e61e4efe171fe7065a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of the pyramid levels.  <a href="#a14af062b9f957e61e4efe171fe7065a3">More...</a><br /></td></tr>
 163 <tr class="separator:a14af062b9f957e61e4efe171fe7065a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:a20646dd69e82674924c6e5eb1458eefa"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a20646dd69e82674924c6e5eb1458eefa">width</a> () const </td></tr>
 165 <tr class="memdesc:a20646dd69e82674924c6e5eb1458eefa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the width of the 0th level tensor.  <a href="#a20646dd69e82674924c6e5eb1458eefa">More...</a><br /></td></tr>
 166 <tr class="separator:a20646dd69e82674924c6e5eb1458eefa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:ac0e3c6ba1d3f8a8e50aa3e3897210a2b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0e3c6ba1d3f8a8e50aa3e3897210a2b">height</a> () const </td></tr>
 168 <tr class="memdesc:ac0e3c6ba1d3f8a8e50aa3e3897210a2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the height of the 0th level tensor.  <a href="#ac0e3c6ba1d3f8a8e50aa3e3897210a2b">More...</a><br /></td></tr>
 169 <tr class="separator:ac0e3c6ba1d3f8a8e50aa3e3897210a2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:af3374fa8fcc6d226dc2b82317ab4d079"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#af3374fa8fcc6d226dc2b82317ab4d079">tensor_shape</a> () const </td></tr>
 171 <tr class="memdesc:af3374fa8fcc6d226dc2b82317ab4d079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a> of the o-th level tensor.  <a href="#af3374fa8fcc6d226dc2b82317ab4d079">More...</a><br /></td></tr>
 172 <tr class="separator:af3374fa8fcc6d226dc2b82317ab4d079"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:a0c875a3203d902e2ad6bc3045355e69e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a> () const </td></tr>
 174 <tr class="memdesc:a0c875a3203d902e2ad6bc3045355e69e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the image format of all tensor in the pyramid.  <a href="#a0c875a3203d902e2ad6bc3045355e69e">More...</a><br /></td></tr>
 175 <tr class="separator:a0c875a3203d902e2ad6bc3045355e69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:ac0960069e9d05e0ee93ef010ce63913a"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a> () const </td></tr>
 177 <tr class="memdesc:ac0960069e9d05e0ee93ef010ce63913a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the scale factor of the pyramid.  <a href="#ac0960069e9d05e0ee93ef010ce63913a">More...</a><br /></td></tr>
 178 <tr class="separator:ac0960069e9d05e0ee93ef010ce63913a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 </table>
 180 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 181 <div class="textblock"><p>Store the <a class="el" href="classarm__compute_1_1_pyramid.xhtml" title="Basic implementation of the pyramid interface. ">Pyramid</a>'s metadata. </p>
 182
 183 <p>Definition at line <a class="el" href="_pyramid_info_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_pyramid_info_8h_source.xhtml">PyramidInfo.h</a>.</p>
 184 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 185 <a class="anchor" id="a9e7e3f78b86c0a7f2cdd1ab1e836b2ed"></a>
 186 <div class="memitem">
 187 <div class="memproto">
 188       <table class="memname">
 189         <tr>
 190           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
 191           <td>(</td>
 192           <td class="paramname"></td><td>)</td>
 193           <td></td>
 194         </tr>
 195       </table>
 196 </div><div class="memdoc">
 197
 198 <p>Default constructor. </p>
 199
 200 </div>
 201 </div>
 202 <a class="anchor" id="a443529237e92a4364aaf662644dfc686"></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">virtual ~<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
 211           <td>(</td>
 212           <td class="paramname"></td><td>)</td>
 213           <td></td>
 214         </tr>
 215       </table>
 216   </td>
 217   <td class="mlabels-right">
 218 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 219   </tr>
 220 </table>
 221 </div><div class="memdoc">
 222
 223 <p>Default destructor. </p>
 224
 225 </div>
 226 </div>
 227 <a class="anchor" id="a9ace7670f345dde6c78d6b3314f3d756"></a>
 228 <div class="memitem">
 229 <div class="memproto">
 230 <table class="mlabels">
 231   <tr>
 232   <td class="mlabels-left">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
 236           <td>(</td>
 237           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td>
 238           <td class="paramname"></td><td>)</td>
 239           <td></td>
 240         </tr>
 241       </table>
 242   </td>
 243   <td class="mlabels-right">
 244 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 245   </tr>
 246 </table>
 247 </div><div class="memdoc">
 248
 249 <p>Allow instances of this class to be copy constructed. </p>
 250
 251 </div>
 252 </div>
 253 <a class="anchor" id="ab38f8d031a5cb0f5d807a180e7107fdd"></a>
 254 <div class="memitem">
 255 <div class="memproto">
 256 <table class="mlabels">
 257   <tr>
 258   <td class="mlabels-left">
 259       <table class="memname">
 260         <tr>
 261           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
 262           <td>(</td>
 263           <td class="paramtype"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&amp;&#160;</td>
 264           <td class="paramname"></td><td>)</td>
 265           <td></td>
 266         </tr>
 267       </table>
 268   </td>
 269   <td class="mlabels-right">
 270 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 271   </tr>
 272 </table>
 273 </div><div class="memdoc">
 274
 275 <p>Allow instances of this class to be move constructed. </p>
 276
 277 </div>
 278 </div>
 279 <a class="anchor" id="a6365834dc65fb5cc59cd17aea308db13"></a>
 280 <div class="memitem">
 281 <div class="memproto">
 282       <table class="memname">
 283         <tr>
 284           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
 285           <td>(</td>
 286           <td class="paramtype">size_t&#160;</td>
 287           <td class="paramname"><em>num_levels</em>, </td>
 288         </tr>
 289         <tr>
 290           <td class="paramkey"></td>
 291           <td></td>
 292           <td class="paramtype">float&#160;</td>
 293           <td class="paramname"><em>scale</em>, </td>
 294         </tr>
 295         <tr>
 296           <td class="paramkey"></td>
 297           <td></td>
 298           <td class="paramtype">size_t&#160;</td>
 299           <td class="paramname"><em>width</em>, </td>
 300         </tr>
 301         <tr>
 302           <td class="paramkey"></td>
 303           <td></td>
 304           <td class="paramtype">size_t&#160;</td>
 305           <td class="paramname"><em>height</em>, </td>
 306         </tr>
 307         <tr>
 308           <td class="paramkey"></td>
 309           <td></td>
 310           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
 311           <td class="paramname"><em>format</em>&#160;</td>
 312         </tr>
 313         <tr>
 314           <td></td>
 315           <td>)</td>
 316           <td></td><td></td>
 317         </tr>
 318       </table>
 319 </div><div class="memdoc">
 320
 321 <p>Create pyramid info for 2D tensors. </p>
 322 <dl class="params"><dt>Parameters</dt><dd>
 323   <table class="params">
 324     <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels. This is required to be a non-zero value </td></tr>
 325     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Used to indicate the scale between the pyramid levels. This is required to be a non-zero positive value. </td></tr>
 326     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The width of the 2D tensor at 0th pyramid level </td></tr>
 327     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The height of the 2D tensor at 0th pyramid level </td></tr>
 328     <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The format of all 2D tensors in the pyramid NV12, NV21, IYUV, UYVY and YUYV formats are not supported. </td></tr>
 329   </table>
 330   </dd>
 331 </dl>
 332
 333 </div>
 334 </div>
 335 <a class="anchor" id="ae79dbf996c991c72eee4f1d9122152ef"></a>
 336 <div class="memitem">
 337 <div class="memproto">
 338       <table class="memname">
 339         <tr>
 340           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
 341           <td>(</td>
 342           <td class="paramtype">size_t&#160;</td>
 343           <td class="paramname"><em>num_levels</em>, </td>
 344         </tr>
 345         <tr>
 346           <td class="paramkey"></td>
 347           <td></td>
 348           <td class="paramtype">float&#160;</td>
 349           <td class="paramname"><em>scale</em>, </td>
 350         </tr>
 351         <tr>
 352           <td class="paramkey"></td>
 353           <td></td>
 354           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
 355           <td class="paramname"><em>tensor_shape</em>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
 361           <td class="paramname"><em>format</em>&#160;</td>
 362         </tr>
 363         <tr>
 364           <td></td>
 365           <td>)</td>
 366           <td></td><td></td>
 367         </tr>
 368       </table>
 369 </div><div class="memdoc">
 370
 371 <p>Create pyramid info using <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a>. </p>
 372 <dl class="params"><dt>Parameters</dt><dd>
 373   <table class="params">
 374     <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels. This is required to be a non-zero value </td></tr>
 375     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Used to indicate the scale between the pyramid levels. This is required to be a non-zero positive value. </td></tr>
 376     <tr><td class="paramdir">[in]</td><td class="paramname">tensor_shape</td><td>It specifies the size for each dimension of the tensor 0th pyramid level in number of elements </td></tr>
 377     <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The format of all tensors in the pyramid </td></tr>
 378   </table>
 379   </dd>
 380 </dl>
 381
 382 </div>
 383 </div>
 384 <h2 class="groupheader">Member Function Documentation</h2>
 385 <a class="anchor" id="a0c875a3203d902e2ad6bc3045355e69e"></a>
 386 <div class="memitem">
 387 <div class="memproto">
 388       <table class="memname">
 389         <tr>
 390           <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> format </td>
 391           <td>(</td>
 392           <td class="paramname"></td><td>)</td>
 393           <td> const</td>
 394         </tr>
 395       </table>
 396 </div><div class="memdoc">
 397
 398 <p>Return the image format of all tensor in the pyramid. </p>
 399 <dl class="section return"><dt>Returns</dt><dd>The image format </dd></dl>
 400
 401 </div>
 402 </div>
 403 <a class="anchor" id="ac0e3c6ba1d3f8a8e50aa3e3897210a2b"></a>
 404 <div class="memitem">
 405 <div class="memproto">
 406       <table class="memname">
 407         <tr>
 408           <td class="memname">size_t height </td>
 409           <td>(</td>
 410           <td class="paramname"></td><td>)</td>
 411           <td> const</td>
 412         </tr>
 413       </table>
 414 </div><div class="memdoc">
 415
 416 <p>Return the height of the 0th level tensor. </p>
 417 <dl class="section return"><dt>Returns</dt><dd>The height of the 0th level tensor </dd></dl>
 418
 419 </div>
 420 </div>
 421 <a class="anchor" id="a741486bedb7b0966b1d4e6e7c6cccf60"></a>
 422 <div class="memitem">
 423 <div class="memproto">
 424       <table class="memname">
 425         <tr>
 426           <td class="memname">void init </td>
 427           <td>(</td>
 428           <td class="paramtype">size_t&#160;</td>
 429           <td class="paramname"><em>num_levels</em>, </td>
 430         </tr>
 431         <tr>
 432           <td class="paramkey"></td>
 433           <td></td>
 434           <td class="paramtype">float&#160;</td>
 435           <td class="paramname"><em>scale</em>, </td>
 436         </tr>
 437         <tr>
 438           <td class="paramkey"></td>
 439           <td></td>
 440           <td class="paramtype">size_t&#160;</td>
 441           <td class="paramname"><em>width</em>, </td>
 442         </tr>
 443         <tr>
 444           <td class="paramkey"></td>
 445           <td></td>
 446           <td class="paramtype">size_t&#160;</td>
 447           <td class="paramname"><em>height</em>, </td>
 448         </tr>
 449         <tr>
 450           <td class="paramkey"></td>
 451           <td></td>
 452           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
 453           <td class="paramname"><em>format</em>&#160;</td>
 454         </tr>
 455         <tr>
 456           <td></td>
 457           <td>)</td>
 458           <td></td><td></td>
 459         </tr>
 460       </table>
 461 </div><div class="memdoc">
 462
 463 <p>Initialize pyramid's metadata for 2D tensors. </p>
 464 <dl class="params"><dt>Parameters</dt><dd>
 465   <table class="params">
 466     <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels. This is required to be a non-zero value </td></tr>
 467     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Used to indicate the scale between the pyramid levels. This is required to be a non-zero positive value. </td></tr>
 468     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The width of the 2D tensor at 0th pyramid level </td></tr>
 469     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The height of the 2D tensor at 0th pyramid level </td></tr>
 470     <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The format of all 2D tensors in the pyramid NV12, NV21, IYUV, UYVY and YUYV formats are not supported. </td></tr>
 471   </table>
 472   </dd>
 473 </dl>
 474
 475 </div>
 476 </div>
 477 <a class="anchor" id="a51a4719902c69a814ccc638963b3074e"></a>
 478 <div class="memitem">
 479 <div class="memproto">
 480       <table class="memname">
 481         <tr>
 482           <td class="memname">void init </td>
 483           <td>(</td>
 484           <td class="paramtype">size_t&#160;</td>
 485           <td class="paramname"><em>num_levels</em>, </td>
 486         </tr>
 487         <tr>
 488           <td class="paramkey"></td>
 489           <td></td>
 490           <td class="paramtype">float&#160;</td>
 491           <td class="paramname"><em>scale</em>, </td>
 492         </tr>
 493         <tr>
 494           <td class="paramkey"></td>
 495           <td></td>
 496           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
 497           <td class="paramname"><em>tensor_shape</em>, </td>
 498         </tr>
 499         <tr>
 500           <td class="paramkey"></td>
 501           <td></td>
 502           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
 503           <td class="paramname"><em>format</em>&#160;</td>
 504         </tr>
 505         <tr>
 506           <td></td>
 507           <td>)</td>
 508           <td></td><td></td>
 509         </tr>
 510       </table>
 511 </div><div class="memdoc">
 512
 513 <p>Initialize pyramid's metadata using <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a>. </p>
 514 <dl class="params"><dt>Parameters</dt><dd>
 515   <table class="params">
 516     <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels. This is required to be a non-zero value </td></tr>
 517     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Used to indicate the scale between the pyramid levels. This is required to be a non-zero positive value. </td></tr>
 518     <tr><td class="paramdir">[in]</td><td class="paramname">tensor_shape</td><td>It specifies the size for each dimension of the tensor 0th pyramid level in number of elements </td></tr>
 519     <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The format of all tensors in the pyramid </td></tr>
 520   </table>
 521   </dd>
 522 </dl>
 523
 524 </div>
 525 </div>
 526 <a class="anchor" id="a14af062b9f957e61e4efe171fe7065a3"></a>
 527 <div class="memitem">
 528 <div class="memproto">
 529       <table class="memname">
 530         <tr>
 531           <td class="memname">size_t num_levels </td>
 532           <td>(</td>
 533           <td class="paramname"></td><td>)</td>
 534           <td> const</td>
 535         </tr>
 536       </table>
 537 </div><div class="memdoc">
 538
 539 <p>Return the number of the pyramid levels. </p>
 540 <dl class="section return"><dt>Returns</dt><dd>The number of the pyramid levels </dd></dl>
 541
 542 </div>
 543 </div>
 544 <a class="anchor" id="a21310a3eef49fc4f04b98897fc785b34"></a>
 545 <div class="memitem">
 546 <div class="memproto">
 547 <table class="mlabels">
 548   <tr>
 549   <td class="mlabels-left">
 550       <table class="memname">
 551         <tr>
 552           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a>&amp; operator= </td>
 553           <td>(</td>
 554           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td>
 555           <td class="paramname"></td><td>)</td>
 556           <td></td>
 557         </tr>
 558       </table>
 559   </td>
 560   <td class="mlabels-right">
 561 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 562   </tr>
 563 </table>
 564 </div><div class="memdoc">
 565
 566 <p>Allow instances of this class to be copied. </p>
 567
 568 </div>
 569 </div>
 570 <a class="anchor" id="a09f1ed0da3ccc973d44d1156aff150f9"></a>
 571 <div class="memitem">
 572 <div class="memproto">
 573 <table class="mlabels">
 574   <tr>
 575   <td class="mlabels-left">
 576       <table class="memname">
 577         <tr>
 578           <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a>&amp; operator= </td>
 579           <td>(</td>
 580           <td class="paramtype"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&amp;&#160;</td>
 581           <td class="paramname"></td><td>)</td>
 582           <td></td>
 583         </tr>
 584       </table>
 585   </td>
 586   <td class="mlabels-right">
 587 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 588   </tr>
 589 </table>
 590 </div><div class="memdoc">
 591
 592 <p>Allow instances of this class to be moved. </p>
 593
 594 </div>
 595 </div>
 596 <a class="anchor" id="ac0960069e9d05e0ee93ef010ce63913a"></a>
 597 <div class="memitem">
 598 <div class="memproto">
 599       <table class="memname">
 600         <tr>
 601           <td class="memname">float scale </td>
 602           <td>(</td>
 603           <td class="paramname"></td><td>)</td>
 604           <td> const</td>
 605         </tr>
 606       </table>
 607 </div><div class="memdoc">
 608
 609 <p>Return the scale factor of the pyramid. </p>
 610 <dl class="section return"><dt>Returns</dt><dd>Return the scale factor </dd></dl>
 611
 612 </div>
 613 </div>
 614 <a class="anchor" id="af3374fa8fcc6d226dc2b82317ab4d079"></a>
 615 <div class="memitem">
 616 <div class="memproto">
 617       <table class="memname">
 618         <tr>
 619           <td class="memname">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a>&amp; tensor_shape </td>
 620           <td>(</td>
 621           <td class="paramname"></td><td>)</td>
 622           <td> const</td>
 623         </tr>
 624       </table>
 625 </div><div class="memdoc">
 626
 627 <p>Return the <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a> of the o-th level tensor. </p>
 628 <dl class="section return"><dt>Returns</dt><dd></dd></dl>
 629
 630 </div>
 631 </div>
 632 <a class="anchor" id="a20646dd69e82674924c6e5eb1458eefa"></a>
 633 <div class="memitem">
 634 <div class="memproto">
 635       <table class="memname">
 636         <tr>
 637           <td class="memname">size_t width </td>
 638           <td>(</td>
 639           <td class="paramname"></td><td>)</td>
 640           <td> const</td>
 641         </tr>
 642       </table>
 643 </div><div class="memdoc">
 644
 645 <p>Return the width of the 0th level tensor. </p>
 646 <dl class="section return"><dt>Returns</dt><dd>The width of the 0th level tensor </dd></dl>
 647
 648 </div>
 649 </div>
 650 <hr/>The documentation for this class was generated from the following file:<ul>
 651 <li>arm_compute/core/<a class="el" href="_pyramid_info_8h_source.xhtml">PyramidInfo.h</a></li>
 652 </ul>
 653 </div><!-- contents -->
 654 </div><!-- doc-content -->
 655 <!-- start footer part -->
 656 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 657   <ul>
 658     <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_info.xhtml">PyramidInfo</a></li>
 659     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 660     <a href="http://www.doxygen.org/index.html">
 661     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 662   </ul>
 663 </div>
 664 </body>
 665 </html>