Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 871448ee8eff790c4ccc3250008dd71170cc78b2 / . / documentation / erode_8cl.xhtml
blob: 5acb1147651a14362eec564841f2fd4c45746deb [file] [log] [blame]
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame^]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/erode.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.03.1</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">
53var 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('erode_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">erode.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="erode_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>
126Functions</h2></td></tr>
127<tr class="memitem:a8b30acf5b6e25e473275a1e3f400054a"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="erode_8cl.xhtml#a8b30acf5b6e25e473275a1e3f400054a">erode</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_ptr, uint dst_stride_x, uint dst_step_x, uint dst_stride_y, uint dst_step_y, uint dst_offset_first_element_in_bytes)</td></tr>
128<tr class="memdesc:a8b30acf5b6e25e473275a1e3f400054a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function erodes an input image image. <a href="#a8b30acf5b6e25e473275a1e3f400054a">More...</a><br /></td></tr>
129<tr class="separator:a8b30acf5b6e25e473275a1e3f400054a"><td class="memSeparator" colspan="2">&#160;</td></tr>
130</table>
131<h2 class="groupheader">Function Documentation</h2>
132<a class="anchor" id="a8b30acf5b6e25e473275a1e3f400054a"></a>
133<div class="memitem">
134<div class="memproto">
135 <table class="memname">
136 <tr>
137 <td class="memname">__kernel void erode </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_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_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_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_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_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_offset_first_element_in_bytes</em>&#160;</td>
207 </tr>
208 <tr>
209 <td></td>
210 <td>)</td>
211 <td></td><td></td>
212 </tr>
213 </table>
214</div><div class="memdoc">
215
216<p>This function erodes an input image image. </p>
217<dl class="params"><dt>Parameters</dt><dd>
218 <table class="params">
219 <tr><td class="paramdir">[in]</td><td class="paramname">src_ptr</td><td>Pointer to the source image. Supported data types: U8 </td></tr>
220 <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>
221 <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>
222 <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>
223 <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>
224 <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>
225 <tr><td class="paramdir">[out]</td><td class="paramname">dst_ptr</td><td>Pointer to the destination image. Supported data types: U8 </td></tr>
226 <tr><td class="paramdir">[in]</td><td class="paramname">dst_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
227 <tr><td class="paramdir">[in]</td><td class="paramname">dst_step_x</td><td>dst_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
228 <tr><td class="paramdir">[in]</td><td class="paramname">dst_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
229 <tr><td class="paramdir">[in]</td><td class="paramname">dst_step_y</td><td>dst_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
230 <tr><td class="paramdir">[in]</td><td class="paramname">dst_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
231 </table>
232 </dd>
233</dl>
234
235<p>Definition at line <a class="el" href="erode_8cl_source.xhtml#l00041">41</a> of file <a class="el" href="erode_8cl_source.xhtml">erode.cl</a>.</p>
236
237<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>
238<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</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="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> dst = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(dst);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uchar16 top = vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, -1, -1));</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uchar16 middle = vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, -1, 0));</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; uchar16 bottom = vload16(0, <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;src, -1, 1));</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uchar16 tmp = min(top, min(middle, bottom));</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uchar8 out = min(tmp.s01234567, min(tmp.s12345678, tmp.s23456789));</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; vstore8(out, 0, dst.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</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>
239<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>
240<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>
241<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>
242</div><!-- fragment -->
243</div>
244</div>
245</div><!-- contents -->
246</div><!-- doc-content -->
247<!-- start footer part -->
248<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
249 <ul>
250 <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="erode_8cl.xhtml">erode.cl</a></li>
251 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
252 <a href="http://www.doxygen.org/index.html">
253 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
254 </ul>
255</div>
256</body>
257</html>