documentation/classarm__compute_1_1_c_l_channel_extract_kernel.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: CLChannelExtractKernel 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_c_l_channel_extract_kernel.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">CLChannelExtractKernel Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Interface for the channel extract kernel.
 125  <a href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_channel_extract_kernel_8h_source.xhtml">CLChannelExtractKernel.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for CLChannelExtractKernel:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_channel_extract_kernel__coll__graph.svg" width="178" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:a3fdfc3c05d6e6970d2648138d43b59e9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a3fdfc3c05d6e6970d2648138d43b59e9">CLChannelExtractKernel</a> ()</td></tr>
 138 <tr class="memdesc:a3fdfc3c05d6e6970d2648138d43b59e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a3fdfc3c05d6e6970d2648138d43b59e9">More...</a><br /></td></tr>
 139 <tr class="separator:a3fdfc3c05d6e6970d2648138d43b59e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a4a91d966993ad7c8b6251a6c32c67d23"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a4a91d966993ad7c8b6251a6c32c67d23">CLChannelExtractKernel</a> (const <a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;)=delete</td></tr>
 141 <tr class="memdesc:a4a91d966993ad7c8b6251a6c32c67d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a4a91d966993ad7c8b6251a6c32c67d23">More...</a><br /></td></tr>
 142 <tr class="separator:a4a91d966993ad7c8b6251a6c32c67d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a9b79b58e02befadc03a8efa21453cc6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a9b79b58e02befadc03a8efa21453cc6d">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;)=delete</td></tr>
 144 <tr class="memdesc:a9b79b58e02befadc03a8efa21453cc6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a9b79b58e02befadc03a8efa21453cc6d">More...</a><br /></td></tr>
 145 <tr class="separator:a9b79b58e02befadc03a8efa21453cc6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a529220c75abfe2ed2cd9ab7310d593bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a529220c75abfe2ed2cd9ab7310d593bb">CLChannelExtractKernel</a> (<a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:a529220c75abfe2ed2cd9ab7310d593bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a529220c75abfe2ed2cd9ab7310d593bb">More...</a><br /></td></tr>
 148 <tr class="separator:a529220c75abfe2ed2cd9ab7310d593bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a3903cf5b0f5ffd0687b19d45a39bfb72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a3903cf5b0f5ffd0687b19d45a39bfb72">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&amp;)=default</td></tr>
 150 <tr class="memdesc:a3903cf5b0f5ffd0687b19d45a39bfb72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a3903cf5b0f5ffd0687b19d45a39bfb72">More...</a><br /></td></tr>
 151 <tr class="separator:a3903cf5b0f5ffd0687b19d45a39bfb72"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a27ad648b664e45d4c571487543160bfb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a27ad648b664e45d4c571487543160bfb">~CLChannelExtractKernel</a> ()=default</td></tr>
 153 <tr class="memdesc:a27ad648b664e45d4c571487543160bfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a27ad648b664e45d4c571487543160bfb">More...</a><br /></td></tr>
 154 <tr class="separator:a27ad648b664e45d4c571487543160bfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:a359fed4a61e4568d258d27aee9bc20c4"><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_channel_extract_kernel.xhtml#a359fed4a61e4568d258d27aee9bc20c4">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input, <a class="el" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455a">Channel</a> channel, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output)</td></tr>
 156 <tr class="memdesc:a359fed4a61e4568d258d27aee9bc20c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output of the kernel.  <a href="#a359fed4a61e4568d258d27aee9bc20c4">More...</a><br /></td></tr>
 157 <tr class="separator:a359fed4a61e4568d258d27aee9bc20c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:af360eaecbadc6e66e1de099aa50c584d"><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_channel_extract_kernel.xhtml#af360eaecbadc6e66e1de099aa50c584d">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml">ICLMultiImage</a> *input, <a class="el" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455a">Channel</a> channel, <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> *output)</td></tr>
 159 <tr class="memdesc:af360eaecbadc6e66e1de099aa50c584d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output of the kernel.  <a href="#af360eaecbadc6e66e1de099aa50c584d">More...</a><br /></td></tr>
 160 <tr class="separator:af360eaecbadc6e66e1de099aa50c584d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:a493987e85723a8000eb26d1f00e2ad0e"><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_channel_extract_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>, cl::CommandQueue &amp;queue) override</td></tr>
 162 <tr class="memdesc:a493987e85723a8000eb26d1f00e2ad0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.  <a href="#a493987e85723a8000eb26d1f00e2ad0e">More...</a><br /></td></tr>
 163 <tr class="separator:a493987e85723a8000eb26d1f00e2ad0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a></td></tr>
 165 <tr class="memitem:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a6b10e96ce90bf901d17def86b874b019">ICLKernel</a> ()</td></tr>
 166 <tr class="memdesc:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6b10e96ce90bf901d17def86b874b019">More...</a><br /></td></tr>
 167 <tr class="separator:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">cl::Kernel &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ae5121015ab09ece4d470f50c7ffe198e">kernel</a> ()</td></tr>
 169 <tr class="memdesc:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the OpenCL kernel of this object.  <a href="#ae5121015ab09ece4d470f50c7ffe198e">More...</a><br /></td></tr>
 170 <tr class="separator:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a479e7043e65dc87de35d374e108510f7">add_1D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>)</td></tr>
 172 <tr class="memdesc:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#a479e7043e65dc87de35d374e108510f7">More...</a><br /></td></tr>
 173 <tr class="separator:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ac74dad3e61f79334f5e73f3c3ac603cb">add_2D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>)</td></tr>
 175 <tr class="memdesc:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#ac74dad3e61f79334f5e73f3c3ac603cb">More...</a><br /></td></tr>
 176 <tr class="separator:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a28f5847162f352444c6ac1825d0e99c7">add_3D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>)</td></tr>
 178 <tr class="memdesc:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#a28f5847162f352444c6ac1825d0e99c7">More...</a><br /></td></tr>
 179 <tr class="separator:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a770f45838881fc061294e56d64f34386">num_arguments_per_1D_tensor</a> () const </td></tr>
 181 <tr class="memdesc:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 1D tensor object.  <a href="#a770f45838881fc061294e56d64f34386">More...</a><br /></td></tr>
 182 <tr class="separator:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ac734502531e7f95e25b3bf688a304a59">num_arguments_per_2D_tensor</a> () const </td></tr>
 184 <tr class="memdesc:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 2D tensor object.  <a href="#ac734502531e7f95e25b3bf688a304a59">More...</a><br /></td></tr>
 185 <tr class="separator:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a4feaae9c860cddfa843d37c953674a22">num_arguments_per_3D_tensor</a> () const </td></tr>
 187 <tr class="memdesc:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 3D tensor object.  <a href="#a4feaae9c860cddfa843d37c953674a22">More...</a><br /></td></tr>
 188 <tr class="separator:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
 190 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a50f427a1d9419800972b9e03c4034311">add_argument</a> (unsigned int &amp;idx, T value)</td></tr>
 191 <tr class="memdesc:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed parameters to the object's kernel's arguments starting from the index idx.  <a href="#a50f427a1d9419800972b9e03c4034311">More...</a><br /></td></tr>
 192 <tr class="separator:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 193 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
 194 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
 195 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
 196 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 197 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
 198 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
 199 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 200 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
 201 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
 202 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 203 <tr class="memitem:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">border_size</a> () const </td></tr>
 204 <tr class="memdesc:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#aa6daa9b04e2035bf007e5e5c3c4396a8">More...</a><br /></td></tr>
 205 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 206 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
 207 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
 208 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 209 </table>
 210 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 211 <div class="textblock"><p>Interface for the channel extract kernel. </p>
 212
 213 <p>Definition at line <a class="el" href="_c_l_channel_extract_kernel_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_c_l_channel_extract_kernel_8h_source.xhtml">CLChannelExtractKernel.h</a>.</p>
 214 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 215 <a class="anchor" id="a3fdfc3c05d6e6970d2648138d43b59e9"></a>
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> </td>
 221           <td>(</td>
 222           <td class="paramname"></td><td>)</td>
 223           <td></td>
 224         </tr>
 225       </table>
 226 </div><div class="memdoc">
 227
 228 <p>Default constructor. </p>
 229
 230 </div>
 231 </div>
 232 <a class="anchor" id="a4a91d966993ad7c8b6251a6c32c67d23"></a>
 233 <div class="memitem">
 234 <div class="memproto">
 235 <table class="mlabels">
 236   <tr>
 237   <td class="mlabels-left">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> </td>
 241           <td>(</td>
 242           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&#160;</td>
 243           <td class="paramname"></td><td>)</td>
 244           <td></td>
 245         </tr>
 246       </table>
 247   </td>
 248   <td class="mlabels-right">
 249 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 250   </tr>
 251 </table>
 252 </div><div class="memdoc">
 253
 254 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 255
 256 </div>
 257 </div>
 258 <a class="anchor" id="a529220c75abfe2ed2cd9ab7310d593bb"></a>
 259 <div class="memitem">
 260 <div class="memproto">
 261 <table class="mlabels">
 262   <tr>
 263   <td class="mlabels-left">
 264       <table class="memname">
 265         <tr>
 266           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> </td>
 267           <td>(</td>
 268           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&amp;&#160;</td>
 269           <td class="paramname"></td><td>)</td>
 270           <td></td>
 271         </tr>
 272       </table>
 273   </td>
 274   <td class="mlabels-right">
 275 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 276   </tr>
 277 </table>
 278 </div><div class="memdoc">
 279
 280 <p>Allow instances of this class to be moved. </p>
 281
 282 </div>
 283 </div>
 284 <a class="anchor" id="a27ad648b664e45d4c571487543160bfb"></a>
 285 <div class="memitem">
 286 <div class="memproto">
 287 <table class="mlabels">
 288   <tr>
 289   <td class="mlabels-left">
 290       <table class="memname">
 291         <tr>
 292           <td class="memname">~<a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> </td>
 293           <td>(</td>
 294           <td class="paramname"></td><td>)</td>
 295           <td></td>
 296         </tr>
 297       </table>
 298   </td>
 299   <td class="mlabels-right">
 300 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 301   </tr>
 302 </table>
 303 </div><div class="memdoc">
 304
 305 <p>Default destructor. </p>
 306
 307 </div>
 308 </div>
 309 <h2 class="groupheader">Member Function Documentation</h2>
 310 <a class="anchor" id="a359fed4a61e4568d258d27aee9bc20c4"></a>
 311 <div class="memitem">
 312 <div class="memproto">
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">void configure </td>
 316           <td>(</td>
 317           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 318           <td class="paramname"><em>input</em>, </td>
 319         </tr>
 320         <tr>
 321           <td class="paramkey"></td>
 322           <td></td>
 323           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455a">Channel</a>&#160;</td>
 324           <td class="paramname"><em>channel</em>, </td>
 325         </tr>
 326         <tr>
 327           <td class="paramkey"></td>
 328           <td></td>
 329           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 330           <td class="paramname"><em>output</em>&#160;</td>
 331         </tr>
 332         <tr>
 333           <td></td>
 334           <td>)</td>
 335           <td></td><td></td>
 336         </tr>
 337       </table>
 338 </div><div class="memdoc">
 339
 340 <p>Set the input and output of the kernel. </p>
 341 <dl class="params"><dt>Parameters</dt><dd>
 342   <table class="params">
 343     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. </td></tr>
 344     <tr><td class="paramdir">[in]</td><td class="paramname">channel</td><td>Channel to extract. </td></tr>
 345     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Must be of U8 format. </td></tr>
 346   </table>
 347   </dd>
 348 </dl>
 349
 350 </div>
 351 </div>
 352 <a class="anchor" id="af360eaecbadc6e66e1de099aa50c584d"></a>
 353 <div class="memitem">
 354 <div class="memproto">
 355       <table class="memname">
 356         <tr>
 357           <td class="memname">void configure </td>
 358           <td>(</td>
 359           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml">ICLMultiImage</a> *&#160;</td>
 360           <td class="paramname"><em>input</em>, </td>
 361         </tr>
 362         <tr>
 363           <td class="paramkey"></td>
 364           <td></td>
 365           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455a">Channel</a>&#160;</td>
 366           <td class="paramname"><em>channel</em>, </td>
 367         </tr>
 368         <tr>
 369           <td class="paramkey"></td>
 370           <td></td>
 371           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> *&#160;</td>
 372           <td class="paramname"><em>output</em>&#160;</td>
 373         </tr>
 374         <tr>
 375           <td></td>
 376           <td>)</td>
 377           <td></td><td></td>
 378         </tr>
 379       </table>
 380 </div><div class="memdoc">
 381
 382 <p>Set the input and output of the kernel. </p>
 383 <dl class="params"><dt>Parameters</dt><dd>
 384   <table class="params">
 385     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Multi-planar source image. </td></tr>
 386     <tr><td class="paramdir">[in]</td><td class="paramname">channel</td><td>Channel to extract. </td></tr>
 387     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Single-planar 2D destination image. Must be of U8 format. </td></tr>
 388   </table>
 389   </dd>
 390 </dl>
 391
 392 </div>
 393 </div>
 394 <a class="anchor" id="a9b79b58e02befadc03a8efa21453cc6d"></a>
 395 <div class="memitem">
 396 <div class="memproto">
 397 <table class="mlabels">
 398   <tr>
 399   <td class="mlabels-left">
 400       <table class="memname">
 401         <tr>
 402           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a>&amp; operator= </td>
 403           <td>(</td>
 404           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&#160;</td>
 405           <td class="paramname"></td><td>)</td>
 406           <td></td>
 407         </tr>
 408       </table>
 409   </td>
 410   <td class="mlabels-right">
 411 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 412   </tr>
 413 </table>
 414 </div><div class="memdoc">
 415
 416 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 417
 418 </div>
 419 </div>
 420 <a class="anchor" id="a3903cf5b0f5ffd0687b19d45a39bfb72"></a>
 421 <div class="memitem">
 422 <div class="memproto">
 423 <table class="mlabels">
 424   <tr>
 425   <td class="mlabels-left">
 426       <table class="memname">
 427         <tr>
 428           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a>&amp; operator= </td>
 429           <td>(</td>
 430           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml">CLChannelExtractKernel</a> &amp;&amp;&#160;</td>
 431           <td class="paramname"></td><td>)</td>
 432           <td></td>
 433         </tr>
 434       </table>
 435   </td>
 436   <td class="mlabels-right">
 437 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 438   </tr>
 439 </table>
 440 </div><div class="memdoc">
 441
 442 <p>Allow instances of this class to be moved. </p>
 443
 444 </div>
 445 </div>
 446 <a class="anchor" id="a493987e85723a8000eb26d1f00e2ad0e"></a>
 447 <div class="memitem">
 448 <div class="memproto">
 449 <table class="mlabels">
 450   <tr>
 451   <td class="mlabels-left">
 452       <table class="memname">
 453         <tr>
 454           <td class="memname">void run </td>
 455           <td>(</td>
 456           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 457           <td class="paramname"><em>window</em>, </td>
 458         </tr>
 459         <tr>
 460           <td class="paramkey"></td>
 461           <td></td>
 462           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 463           <td class="paramname"><em>queue</em>&#160;</td>
 464         </tr>
 465         <tr>
 466           <td></td>
 467           <td>)</td>
 468           <td></td><td></td>
 469         </tr>
 470       </table>
 471   </td>
 472   <td class="mlabels-right">
 473 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 474   </tr>
 475 </table>
 476 </div><div class="memdoc">
 477
 478 <p>Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. </p>
 479 <dl class="section note"><dt>Note</dt><dd>The queue is <em>not</em> flushed by this method, and therefore the kernel will not have been executed by the time this method returns.</dd></dl>
 480 <dl class="params"><dt>Parameters</dt><dd>
 481   <table class="params">
 482     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a valid region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>). </td></tr>
 483     <tr><td class="paramdir">[in,out]</td><td class="paramname">queue</td><td>Command queue on which to enqueue the kernel. </td></tr>
 484   </table>
 485   </dd>
 486 </dl>
 487
 488 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#af6a174d47571f51f199ffc27ecc10f51">ICLKernel</a>.</p>
 489
 490 </div>
 491 </div>
 492 <hr/>The documentation for this class was generated from the following file:<ul>
 493 <li>arm_compute/core/CL/kernels/<a class="el" href="_c_l_channel_extract_kernel_8h_source.xhtml">CLChannelExtractKernel.h</a></li>
 494 </ul>
 495 </div><!-- contents -->
 496 </div><!-- doc-content -->
 497 <!-- start footer part -->
 498 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 499   <ul>
 500     <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_channel_extract_kernel.xhtml">CLChannelExtractKernel</a></li>
 501     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
 502     <a href="http://www.doxygen.org/index.html">
 503     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 504   </ul>
 505 </div>
 506 </body>
 507 </html>