documentation/classarm__compute_1_1_r_o_i_pooling_layer_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>Compute Library: ROIPoolingLayerInfo 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_r_o_i_pooling_layer_info.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">ROIPoolingLayerInfo Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p><a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> Pooling Layer Information class.
 126  <a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>&gt;</code></p>
 129 <table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 131 Public Member Functions</h2></td></tr>
 132 <tr class="memitem:aeb18f7aaaa12486cd2cf6499c19059db"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#aeb18f7aaaa12486cd2cf6499c19059db">ROIPoolingLayerInfo</a> (unsigned int <a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">pooled_width</a>, unsigned int <a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">pooled_height</a>, float <a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">spatial_scale</a>)</td></tr>
 133 <tr class="memdesc:aeb18f7aaaa12486cd2cf6499c19059db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#aeb18f7aaaa12486cd2cf6499c19059db">More...</a><br /></td></tr>
 134 <tr class="separator:aeb18f7aaaa12486cd2cf6499c19059db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:ae889c3657ba9390ac5ecd268e8a19720"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">pooled_width</a> () const </td></tr>
 136 <tr class="memdesc:ae889c3657ba9390ac5ecd268e8a19720"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the pooled width of the layer.  <a href="#ae889c3657ba9390ac5ecd268e8a19720">More...</a><br /></td></tr>
 137 <tr class="separator:ae889c3657ba9390ac5ecd268e8a19720"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a5ef65c82efd18c18e7f23585364e3fa9"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">pooled_height</a> () const </td></tr>
 139 <tr class="memdesc:a5ef65c82efd18c18e7f23585364e3fa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the pooled height of the layer.  <a href="#a5ef65c82efd18c18e7f23585364e3fa9">More...</a><br /></td></tr>
 140 <tr class="separator:a5ef65c82efd18c18e7f23585364e3fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a13a5239b80c3170a975b369f288cbd91"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">spatial_scale</a> () const </td></tr>
 142 <tr class="memdesc:a13a5239b80c3170a975b369f288cbd91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the spatial scale.  <a href="#a13a5239b80c3170a975b369f288cbd91">More...</a><br /></td></tr>
 143 <tr class="separator:a13a5239b80c3170a975b369f288cbd91"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 </table>
 145 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 146 <div class="textblock"><p><a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> Pooling Layer Information class. </p>
 147
 148 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00773">773</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 149 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 150 <a class="anchor" id="aeb18f7aaaa12486cd2cf6499c19059db"></a>
 151 <div class="memitem">
 152 <div class="memproto">
 153 <table class="mlabels">
 154   <tr>
 155   <td class="mlabels-left">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml">ROIPoolingLayerInfo</a> </td>
 159           <td>(</td>
 160           <td class="paramtype">unsigned int&#160;</td>
 161           <td class="paramname"><em>pooled_width</em>, </td>
 162         </tr>
 163         <tr>
 164           <td class="paramkey"></td>
 165           <td></td>
 166           <td class="paramtype">unsigned int&#160;</td>
 167           <td class="paramname"><em>pooled_height</em>, </td>
 168         </tr>
 169         <tr>
 170           <td class="paramkey"></td>
 171           <td></td>
 172           <td class="paramtype">float&#160;</td>
 173           <td class="paramname"><em>spatial_scale</em>&#160;</td>
 174         </tr>
 175         <tr>
 176           <td></td>
 177           <td>)</td>
 178           <td></td><td></td>
 179         </tr>
 180       </table>
 181   </td>
 182   <td class="mlabels-right">
 183 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 184   </tr>
 185 </table>
 186 </div><div class="memdoc">
 187
 188 <p>Default Constructor. </p>
 189 <dl class="params"><dt>Parameters</dt><dd>
 190   <table class="params">
 191     <tr><td class="paramdir">[in]</td><td class="paramname">pooled_width</td><td>Pooled width of the layer. </td></tr>
 192     <tr><td class="paramdir">[in]</td><td class="paramname">pooled_height</td><td>Pooled height of the layer. </td></tr>
 193     <tr><td class="paramdir">[in]</td><td class="paramname">spatial_scale</td><td>Spatial scale to be applied to the <a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> coordinates and dimensions. </td></tr>
 194   </table>
 195   </dd>
 196 </dl>
 197
 198 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00782">782</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 199 <div class="fragment"><div class="line"><a name="l00783"></a><span class="lineno">  783</span>&#160;        : _pooled_width(<a class="code" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">pooled_width</a>), _pooled_height(<a class="code" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">pooled_height</a>), _spatial_scale(<a class="code" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">spatial_scale</a>)</div><div class="line"><a name="l00784"></a><span class="lineno">  784</span>&#160;    {</div><div class="line"><a name="l00785"></a><span class="lineno">  785</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_r_o_i_pooling_layer_info_xhtml_a13a5239b80c3170a975b369f288cbd91"><div class="ttname"><a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">arm_compute::ROIPoolingLayerInfo::spatial_scale</a></div><div class="ttdeci">float spatial_scale() const </div><div class="ttdoc">Get the spatial scale. </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00797">Types.h:797</a></div></div>
 200 <div class="ttc" id="classarm__compute_1_1_r_o_i_pooling_layer_info_xhtml_ae889c3657ba9390ac5ecd268e8a19720"><div class="ttname"><a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">arm_compute::ROIPoolingLayerInfo::pooled_width</a></div><div class="ttdeci">unsigned int pooled_width() const </div><div class="ttdoc">Get the pooled width of the layer. </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00787">Types.h:787</a></div></div>
 201 <div class="ttc" id="classarm__compute_1_1_r_o_i_pooling_layer_info_xhtml_a5ef65c82efd18c18e7f23585364e3fa9"><div class="ttname"><a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">arm_compute::ROIPoolingLayerInfo::pooled_height</a></div><div class="ttdeci">unsigned int pooled_height() const </div><div class="ttdoc">Get the pooled height of the layer. </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00792">Types.h:792</a></div></div>
 202 </div><!-- fragment -->
 203 </div>
 204 </div>
 205 <h2 class="groupheader">Member Function Documentation</h2>
 206 <a class="anchor" id="a5ef65c82efd18c18e7f23585364e3fa9"></a>
 207 <div class="memitem">
 208 <div class="memproto">
 209 <table class="mlabels">
 210   <tr>
 211   <td class="mlabels-left">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname">unsigned int pooled_height </td>
 215           <td>(</td>
 216           <td class="paramname"></td><td>)</td>
 217           <td> const</td>
 218         </tr>
 219       </table>
 220   </td>
 221   <td class="mlabels-right">
 222 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 223   </tr>
 224 </table>
 225 </div><div class="memdoc">
 226
 227 <p>Get the pooled height of the layer. </p>
 228
 229 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00792">792</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 230
 231 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00576">arm_compute::test::generate_random_rois()</a>, and <a class="el" href="utils_2_type_printer_8h_source.xhtml#l00200">arm_compute::operator&lt;&lt;()</a>.</p>
 232 <div class="fragment"><div class="line"><a name="l00793"></a><span class="lineno">  793</span>&#160;    {</div><div class="line"><a name="l00794"></a><span class="lineno">  794</span>&#160;        <span class="keywordflow">return</span> _pooled_height;</div><div class="line"><a name="l00795"></a><span class="lineno">  795</span>&#160;    }</div></div><!-- fragment -->
 233 </div>
 234 </div>
 235 <a class="anchor" id="ae889c3657ba9390ac5ecd268e8a19720"></a>
 236 <div class="memitem">
 237 <div class="memproto">
 238 <table class="mlabels">
 239   <tr>
 240   <td class="mlabels-left">
 241       <table class="memname">
 242         <tr>
 243           <td class="memname">unsigned int pooled_width </td>
 244           <td>(</td>
 245           <td class="paramname"></td><td>)</td>
 246           <td> const</td>
 247         </tr>
 248       </table>
 249   </td>
 250   <td class="mlabels-right">
 251 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 252   </tr>
 253 </table>
 254 </div><div class="memdoc">
 255
 256 <p>Get the pooled width of the layer. </p>
 257
 258 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00787">787</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 259
 260 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00576">arm_compute::test::generate_random_rois()</a>, and <a class="el" href="utils_2_type_printer_8h_source.xhtml#l00200">arm_compute::operator&lt;&lt;()</a>.</p>
 261 <div class="fragment"><div class="line"><a name="l00788"></a><span class="lineno">  788</span>&#160;    {</div><div class="line"><a name="l00789"></a><span class="lineno">  789</span>&#160;        <span class="keywordflow">return</span> _pooled_width;</div><div class="line"><a name="l00790"></a><span class="lineno">  790</span>&#160;    }</div></div><!-- fragment -->
 262 </div>
 263 </div>
 264 <a class="anchor" id="a13a5239b80c3170a975b369f288cbd91"></a>
 265 <div class="memitem">
 266 <div class="memproto">
 267 <table class="mlabels">
 268   <tr>
 269   <td class="mlabels-left">
 270       <table class="memname">
 271         <tr>
 272           <td class="memname">float spatial_scale </td>
 273           <td>(</td>
 274           <td class="paramname"></td><td>)</td>
 275           <td> const</td>
 276         </tr>
 277       </table>
 278   </td>
 279   <td class="mlabels-right">
 280 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 281   </tr>
 282 </table>
 283 </div><div class="memdoc">
 284
 285 <p>Get the spatial scale. </p>
 286
 287 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00797">797</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
 288
 289 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00576">arm_compute::test::generate_random_rois()</a>, and <a class="el" href="utils_2_type_printer_8h_source.xhtml#l00200">arm_compute::operator&lt;&lt;()</a>.</p>
 290 <div class="fragment"><div class="line"><a name="l00798"></a><span class="lineno">  798</span>&#160;    {</div><div class="line"><a name="l00799"></a><span class="lineno">  799</span>&#160;        <span class="keywordflow">return</span> _spatial_scale;</div><div class="line"><a name="l00800"></a><span class="lineno">  800</span>&#160;    }</div></div><!-- fragment -->
 291 </div>
 292 </div>
 293 <hr/>The documentation for this class was generated from the following file:<ul>
 294 <li>arm_compute/core/<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a></li>
 295 </ul>
 296 </div><!-- contents -->
 297 </div><!-- doc-content -->
 298 <!-- start footer part -->
 299 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 300   <ul>
 301     <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_r_o_i_pooling_layer_info.xhtml">ROIPoolingLayerInfo</a></li>
 302     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
 303     <a href="http://www.doxygen.org/index.html">
 304     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 305   </ul>
 306 </div>
 307 </body>
 308 </html>