documentation/derivative_8cl.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: src/core/CL/cl_kernels/derivative.cl File 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><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li class="current"><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="files.xhtml"><span>File&#160;List</span></a></li>
  82       <li><a href="globals.xhtml"><span>Globals</span></a></li>
  83     </ul>
  84   </div>
  85 </div><!-- top -->
  86 <div id="side-nav" class="ui-resizable side-nav-resizable">
  87   <div id="nav-tree">
  88     <div id="nav-tree-contents">
  89       <div id="nav-sync" class="sync"></div>
  90     </div>
  91   </div>
  92   <div id="splitbar" style="-moz-user-select:none;"
  93        class="ui-resizable-handle">
  94   </div>
  95 </div>
  96 <script type="text/javascript">
  97 $(document).ready(function(){initNavTree('derivative_8cl.xhtml','');});
  98 </script>
  99 <div id="doc-content">
 100 <!-- window showing the filter options -->
 101 <div id="MSearchSelectWindow"
 102      onmouseover="return searchBox.OnSearchSelectShow()"
 103      onmouseout="return searchBox.OnSearchSelectHide()"
 104      onkeydown="return searchBox.OnSearchSelectKey(event)">
 105 </div>
 106
 107 <!-- iframe showing the search results (closed by default) -->
 108 <div id="MSearchResultsWindow">
 109 <iframe src="javascript:void(0)" frameborder="0"
 110         name="MSearchResults" id="MSearchResults">
 111 </iframe>
 112 </div>
 113
 114 <div class="header">
 115   <div class="summary">
 116 <a href="#func-members">Functions</a>  </div>
 117   <div class="headertitle">
 118 <div class="title">derivative.cl File Reference</div>  </div>
 119 </div><!--header-->
 120 <div class="contents">
 121 <div class="textblock"><code>#include &quot;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&quot;</code><br />
 122 </div>
 123 <p><a href="derivative_8cl_source.xhtml">Go to the source code of this file.</a></p>
 124 <table class="memberdecls">
 125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 126 Functions</h2></td></tr>
 127 <tr class="memitem:a5bd0ba0e3feaf66458557426291f2a77"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="derivative_8cl.xhtml#a5bd0ba0e3feaf66458557426291f2a77">derivative</a> (__global uchar *src_ptr, uint src_stride_x, uint src_step_x, uint src_stride_y, uint src_step_y, uint src_offset_first_element_in_bytes, __global uchar *dst_gx_ptr, uint dst_gx_stride_x, uint dst_gx_step_x, uint dst_gx_stride_y, uint dst_gx_step_y, uint dst_gx_offset_first_element_in_bytes, __global uchar *dst_gy_ptr, uint dst_gy_stride_x, uint dst_gy_step_x, uint dst_gy_stride_y, uint dst_gy_step_y, uint dst_gy_offset_first_element_in_bytes)</td></tr>
 128 <tr class="memdesc:a5bd0ba0e3feaf66458557426291f2a77"><td class="mdescLeft">&#160;</td><td class="mdescRight">This OpenCL kernel that computes the first-order derivative.  <a href="#a5bd0ba0e3feaf66458557426291f2a77">More...</a><br /></td></tr>
 129 <tr class="separator:a5bd0ba0e3feaf66458557426291f2a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 </table>
 131 <h2 class="groupheader">Function Documentation</h2>
 132 <a class="anchor" id="a5bd0ba0e3feaf66458557426291f2a77"></a>
 133 <div class="memitem">
 134 <div class="memproto">
 135       <table class="memname">
 136         <tr>
 137           <td class="memname">__kernel void derivative </td>
 138           <td>(</td>
 139           <td class="paramtype">__global uchar *&#160;</td>
 140           <td class="paramname"><em>src_ptr</em>, </td>
 141         </tr>
 142         <tr>
 143           <td class="paramkey"></td>
 144           <td></td>
 145           <td class="paramtype">uint&#160;</td>
 146           <td class="paramname"><em>src_stride_x</em>, </td>
 147         </tr>
 148         <tr>
 149           <td class="paramkey"></td>
 150           <td></td>
 151           <td class="paramtype">uint&#160;</td>
 152           <td class="paramname"><em>src_step_x</em>, </td>
 153         </tr>
 154         <tr>
 155           <td class="paramkey"></td>
 156           <td></td>
 157           <td class="paramtype">uint&#160;</td>
 158           <td class="paramname"><em>src_stride_y</em>, </td>
 159         </tr>
 160         <tr>
 161           <td class="paramkey"></td>
 162           <td></td>
 163           <td class="paramtype">uint&#160;</td>
 164           <td class="paramname"><em>src_step_y</em>, </td>
 165         </tr>
 166         <tr>
 167           <td class="paramkey"></td>
 168           <td></td>
 169           <td class="paramtype">uint&#160;</td>
 170           <td class="paramname"><em>src_offset_first_element_in_bytes</em>, </td>
 171         </tr>
 172         <tr>
 173           <td class="paramkey"></td>
 174           <td></td>
 175           <td class="paramtype">__global uchar *&#160;</td>
 176           <td class="paramname"><em>dst_gx_ptr</em>, </td>
 177         </tr>
 178         <tr>
 179           <td class="paramkey"></td>
 180           <td></td>
 181           <td class="paramtype">uint&#160;</td>
 182           <td class="paramname"><em>dst_gx_stride_x</em>, </td>
 183         </tr>
 184         <tr>
 185           <td class="paramkey"></td>
 186           <td></td>
 187           <td class="paramtype">uint&#160;</td>
 188           <td class="paramname"><em>dst_gx_step_x</em>, </td>
 189         </tr>
 190         <tr>
 191           <td class="paramkey"></td>
 192           <td></td>
 193           <td class="paramtype">uint&#160;</td>
 194           <td class="paramname"><em>dst_gx_stride_y</em>, </td>
 195         </tr>
 196         <tr>
 197           <td class="paramkey"></td>
 198           <td></td>
 199           <td class="paramtype">uint&#160;</td>
 200           <td class="paramname"><em>dst_gx_step_y</em>, </td>
 201         </tr>
 202         <tr>
 203           <td class="paramkey"></td>
 204           <td></td>
 205           <td class="paramtype">uint&#160;</td>
 206           <td class="paramname"><em>dst_gx_offset_first_element_in_bytes</em>, </td>
 207         </tr>
 208         <tr>
 209           <td class="paramkey"></td>
 210           <td></td>
 211           <td class="paramtype">__global uchar *&#160;</td>
 212           <td class="paramname"><em>dst_gy_ptr</em>, </td>
 213         </tr>
 214         <tr>
 215           <td class="paramkey"></td>
 216           <td></td>
 217           <td class="paramtype">uint&#160;</td>
 218           <td class="paramname"><em>dst_gy_stride_x</em>, </td>
 219         </tr>
 220         <tr>
 221           <td class="paramkey"></td>
 222           <td></td>
 223           <td class="paramtype">uint&#160;</td>
 224           <td class="paramname"><em>dst_gy_step_x</em>, </td>
 225         </tr>
 226         <tr>
 227           <td class="paramkey"></td>
 228           <td></td>
 229           <td class="paramtype">uint&#160;</td>
 230           <td class="paramname"><em>dst_gy_stride_y</em>, </td>
 231         </tr>
 232         <tr>
 233           <td class="paramkey"></td>
 234           <td></td>
 235           <td class="paramtype">uint&#160;</td>
 236           <td class="paramname"><em>dst_gy_step_y</em>, </td>
 237         </tr>
 238         <tr>
 239           <td class="paramkey"></td>
 240           <td></td>
 241           <td class="paramtype">uint&#160;</td>
 242           <td class="paramname"><em>dst_gy_offset_first_element_in_bytes</em>&#160;</td>
 243         </tr>
 244         <tr>
 245           <td></td>
 246           <td>)</td>
 247           <td></td><td></td>
 248         </tr>
 249       </table>
 250 </div><div class="memdoc">
 251
 252 <p>This OpenCL kernel that computes the first-order derivative. </p>
 253 <dl class="section attention"><dt>Attention</dt><dd>To enable computation of the X gradient -DGRAD_X must be passed at compile time, while computation of the Y gradient is performed when -DGRAD_Y is used. You can use both when computation of both gradients is required.</dd></dl>
 254 <dl class="params"><dt>Parameters</dt><dd>
 255   <table class="params">
 256     <tr><td class="paramdir">[in]</td><td class="paramname">src_ptr</td><td>Pointer to the source image. Supported data types: U8 </td></tr>
 257     <tr><td class="paramdir">[in]</td><td class="paramname">src_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
 258     <tr><td class="paramdir">[in]</td><td class="paramname">src_step_x</td><td>src_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
 259     <tr><td class="paramdir">[in]</td><td class="paramname">src_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
 260     <tr><td class="paramdir">[in]</td><td class="paramname">src_step_y</td><td>src_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
 261     <tr><td class="paramdir">[in]</td><td class="paramname">src_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
 262     <tr><td class="paramdir">[out]</td><td class="paramname">dst_gx_ptr</td><td>Pointer to the destination image. Supported data types: S16 </td></tr>
 263     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gx_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
 264     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gx_step_x</td><td>dst_gx_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
 265     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gx_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
 266     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gx_step_y</td><td>dst_gx_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
 267     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gx_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
 268     <tr><td class="paramdir">[out]</td><td class="paramname">dst_gy_ptr</td><td>Pointer to the destination image. Supported data types: S16 </td></tr>
 269     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gy_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
 270     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gy_step_x</td><td>dst_gy_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
 271     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gy_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
 272     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gy_step_y</td><td>dst_gy_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
 273     <tr><td class="paramdir">[in]</td><td class="paramname">dst_gy_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
 274   </table>
 275   </dd>
 276 </dl>
 277
 278 <p>Definition at line <a class="el" href="derivative_8cl_source.xhtml#l00050">50</a> of file <a class="el" href="derivative_8cl_source.xhtml">derivative.cl</a>.</p>
 279
 280 <p>References <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="helpers_8h_source.xhtml#l00201">offset()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>.</p>
 281 <div class="fragment"><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;{</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> src = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(src);</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#ifdef GRAD_X</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> dst_gx = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(dst_gx);</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="preprocessor">#ifdef GRAD_Y</span></div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> dst_gy = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(dst_gy);</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="preprocessor">#ifdef GRAD_X</span></div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    short16 l_data = convert_short16(vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, -1, 0)));</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    short16 r_data = convert_short16(vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, 1, 0)));</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    vstore16(r_data - l_data, 0, ((__global <span class="keywordtype">short</span> *)dst_gx.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor">#ifdef GRAD_Y</span></div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    short16 t_data = convert_short16(vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, 0, -1)));</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    short16 b_data = convert_short16(vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, 0, 1)));</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    vstore16(b_data - t_data, 0, ((__global <span class="keywordtype">short</span> *)dst_gy.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;}</div><div class="ttc" id="helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00201">helpers.h:201</a></div></div>
 282 <div class="ttc" id="helpers_8h_xhtml_aebe814363556c244be043b13e7969197"><div class="ttname"><a href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a></div><div class="ttdeci">#define CONVERT_TO_IMAGE_STRUCT(name)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00073">helpers.h:73</a></div></div>
 283 <div class="ttc" id="struct_image_xhtml"><div class="ttname"><a href="struct_image.xhtml">Image</a></div><div class="ttdoc">Structure to hold Image information. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00095">helpers.h:95</a></div></div>
 284 <div class="ttc" id="struct_image_xhtml_acf52c23cbd7424606c10a606524e3e32"><div class="ttname"><a href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">Image::ptr</a></div><div class="ttdeci">__global uchar * ptr</div><div class="ttdoc">Pointer to the starting postion of the buffer. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00097">helpers.h:97</a></div></div>
 285 </div><!-- fragment -->
 286 </div>
 287 </div>
 288 </div><!-- contents -->
 289 </div><!-- doc-content -->
 290 <!-- start footer part -->
 291 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 292   <ul>
 293     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_8c278f79c760e5c5fbd911f9870614c1.xhtml">CL</a></li><li class="navelem"><a class="el" href="dir_25885286e9dad4fa105b7b25a8031bbf.xhtml">cl_kernels</a></li><li class="navelem"><a class="el" href="derivative_8cl.xhtml">derivative.cl</a></li>
 294     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
 295     <a href="http://www.doxygen.org/index.html">
 296     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 297   </ul>
 298 </div>
 299 </body>
 300 </html>