blob: 5ce5855c0560d7bfcd6cc5d633797be12362487e [file] [log] [blame]
Anthony Barbier871448e2017-03-24 14:54:29 +00001<!-- 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"/>
Kaizen8938bd32017-09-28 14:38:23 +01007<meta name="generator" content="Doxygen 1.8.6"/>
Anthony Barbier871448e2017-03-24 14:54:29 +00008<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Anthony Barbierdbdab852017-06-23 15:42:00 +01009<title>Compute Library: src/core/CL/cl_kernels/histogram.cl File Reference</title>
Anthony Barbier871448e2017-03-24 14:54:29 +000010<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>
Anthony Barbier871448e2017-03-24 14:54:29 +000015<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
19</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000021<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
Kaizen8938bd32017-09-28 14:38:23 +010023 $(document).ready(function() { searchBox.OnSelectItem(0); });
Anthony Barbier871448e2017-03-24 14:54:29 +000024</script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Kaizen8938bd32017-09-28 14:38:23 +010030</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000031<link href="doxygen.css" rel="stylesheet" type="text/css" />
32</head>
33<body>
34<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35<div id="titlearea">
36<table cellspacing="0" cellpadding="0">
37 <tbody>
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
Anthony Barbierdbdab852017-06-23 15:42:00 +010040 <div id="projectname">Compute Library
Kaizenbf8b01d2017-10-12 14:26:51 +010041 &#160;<span id="projectnumber">17.10</span>
Anthony Barbier871448e2017-03-24 14:54:29 +000042 </div>
43 </td>
44 </tr>
45 </tbody>
46</table>
47</div>
48<!-- end header part -->
Kaizen8938bd32017-09-28 14:38:23 +010049<!-- Generated by Doxygen 1.8.6 -->
Anthony Barbier871448e2017-03-24 14:54:29 +000050<script type="text/javascript">
51var searchBox = new SearchBox("searchBox", "search",false,'Search');
52</script>
53 <div id="navrow1" class="tabs">
54 <ul class="tablist">
55 <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
Anthony Barbierdbdab852017-06-23 15:42:00 +010056 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
Anthony Barbier871448e2017-03-24 14:54:29 +000057 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59 <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
60 <li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
62 <span class="left">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
66 alt=""/>
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73 </span>
74 </div>
75 </li>
76 </ul>
77 </div>
78 <div id="navrow2" class="tabs2">
79 <ul class="tablist">
80 <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
81 <li><a href="globals.xhtml"><span>Globals</span></a></li>
82 </ul>
83 </div>
84</div><!-- top -->
85<div id="side-nav" class="ui-resizable side-nav-resizable">
86 <div id="nav-tree">
87 <div id="nav-tree-contents">
88 <div id="nav-sync" class="sync"></div>
89 </div>
90 </div>
91 <div id="splitbar" style="-moz-user-select:none;"
92 class="ui-resizable-handle">
93 </div>
94</div>
95<script type="text/javascript">
96$(document).ready(function(){initNavTree('histogram_8cl.xhtml','');});
97</script>
98<div id="doc-content">
99<!-- window showing the filter options -->
100<div id="MSearchSelectWindow"
101 onmouseover="return searchBox.OnSearchSelectShow()"
102 onmouseout="return searchBox.OnSearchSelectHide()"
103 onkeydown="return searchBox.OnSearchSelectKey(event)">
Kaizen8938bd32017-09-28 14:38:23 +0100104<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000105
106<!-- iframe showing the search results (closed by default) -->
107<div id="MSearchResultsWindow">
108<iframe src="javascript:void(0)" frameborder="0"
109 name="MSearchResults" id="MSearchResults">
110</iframe>
111</div>
112
113<div class="header">
114 <div class="summary">
115<a href="#define-members">Macros</a> &#124;
116<a href="#func-members">Functions</a> </div>
117 <div class="headertitle">
118<div class="title">histogram.cl File Reference</div> </div>
119</div><!--header-->
120<div class="contents">
Kaizen8938bd32017-09-28 14:38:23 +0100121<div class="textblock"><code>#include &quot;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&quot;</code><br/>
Anthony Barbier871448e2017-03-24 14:54:29 +0000122</div>
123<p><a href="histogram_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="define-members"></a>
126Macros</h2></td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100127<tr class="memitem:a2c8a35cfde24ca7728709200962e1a91"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="histogram_8cl.xhtml#a2c8a35cfde24ca7728709200962e1a91">VATOMIC_INC16</a>(histogram, win_pos)</td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000128<tr class="separator:a2c8a35cfde24ca7728709200962e1a91"><td class="memSeparator" colspan="2">&#160;</td></tr>
129</table><table class="memberdecls">
130<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
131Functions</h2></td></tr>
132<tr class="memitem:abc81d92c9655c4ec22fff9163b66279d"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="histogram_8cl.xhtml#abc81d92c9655c4ec22fff9163b66279d">hist_local_kernel</a> (__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __local uint *histogram_local, __global uint *restrict histogram, uint num_bins, uint <a class="el" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, uint range, uint offrange)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100133<tr class="memdesc:abc81d92c9655c4ec22fff9163b66279d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the histogram of an 8 bit grayscale image. <a href="#abc81d92c9655c4ec22fff9163b66279d">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000134<tr class="separator:abc81d92c9655c4ec22fff9163b66279d"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:af82fea967051b827585009463255262d"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="histogram_8cl.xhtml#af82fea967051b827585009463255262d">hist_border_kernel</a> (__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __global uint *restrict histogram, uint num_bins, uint <a class="el" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, uint range, uint offrange)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100136<tr class="memdesc:af82fea967051b827585009463255262d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the histogram of an 8 bit grayscale image's border. <a href="#af82fea967051b827585009463255262d">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000137<tr class="separator:af82fea967051b827585009463255262d"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:a7c8051ab952a597e66090d77f4dc60e4"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="histogram_8cl.xhtml#a7c8051ab952a597e66090d77f4dc60e4">hist_local_kernel_fixed</a> (__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __local uint *histogram_local, __global uint *restrict histogram)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100139<tr class="memdesc:a7c8051ab952a597e66090d77f4dc60e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the histogram of an 8 bit grayscale image with bin size of 256 and window size of 1. <a href="#a7c8051ab952a597e66090d77f4dc60e4">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000140<tr class="separator:a7c8051ab952a597e66090d77f4dc60e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:aec6ec6157573195df9694109ebbb38ae"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="histogram_8cl.xhtml#aec6ec6157573195df9694109ebbb38ae">hist_border_kernel_fixed</a> (__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __global uint *restrict histogram)</td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100142<tr class="memdesc:aec6ec6157573195df9694109ebbb38ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the histogram of an 8 bit grayscale image with bin size as 256 and window size as 1. <a href="#aec6ec6157573195df9694109ebbb38ae">More...</a><br/></td></tr>
Anthony Barbier871448e2017-03-24 14:54:29 +0000143<tr class="separator:aec6ec6157573195df9694109ebbb38ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
144</table>
145<h2 class="groupheader">Macro Definition Documentation</h2>
146<a class="anchor" id="a2c8a35cfde24ca7728709200962e1a91"></a>
147<div class="memitem">
148<div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname">#define VATOMIC_INC16</td>
152 <td>(</td>
153 <td class="paramtype">&#160;</td>
154 <td class="paramname">histogram, </td>
155 </tr>
156 <tr>
157 <td class="paramkey"></td>
158 <td></td>
159 <td class="paramtype">&#160;</td>
160 <td class="paramname">win_pos&#160;</td>
161 </tr>
162 <tr>
163 <td></td>
164 <td>)</td>
165 <td></td><td></td>
166 </tr>
167 </table>
168</div><div class="memdoc">
Kaizen8938bd32017-09-28 14:38:23 +0100169<b>Value:</b><div class="fragment"><div class="line">{ \</div>
170<div class="line"> atomic_inc(histogram + win_pos.s0); \</div>
171<div class="line"> atomic_inc(histogram + win_pos.s1); \</div>
172<div class="line"> atomic_inc(histogram + win_pos.s2); \</div>
173<div class="line"> atomic_inc(histogram + win_pos.s3); \</div>
174<div class="line"> atomic_inc(histogram + win_pos.s4); \</div>
175<div class="line"> atomic_inc(histogram + win_pos.s5); \</div>
176<div class="line"> atomic_inc(histogram + win_pos.s6); \</div>
177<div class="line"> atomic_inc(histogram + win_pos.s7); \</div>
178<div class="line"> atomic_inc(histogram + win_pos.s8); \</div>
179<div class="line"> atomic_inc(histogram + win_pos.s9); \</div>
180<div class="line"> atomic_inc(histogram + win_pos.sa); \</div>
181<div class="line"> atomic_inc(histogram + win_pos.sb); \</div>
182<div class="line"> atomic_inc(histogram + win_pos.sc); \</div>
183<div class="line"> atomic_inc(histogram + win_pos.sd); \</div>
184<div class="line"> atomic_inc(histogram + win_pos.se); \</div>
185<div class="line"> atomic_inc(histogram + win_pos.sf); \</div>
186<div class="line"> }</div>
187</div><!-- fragment -->
Anthony Barbier871448e2017-03-24 14:54:29 +0000188<p>Definition at line <a class="el" href="histogram_8cl_source.xhtml#l00026">26</a> of file <a class="el" href="histogram_8cl_source.xhtml">histogram.cl</a>.</p>
189
190<p>Referenced by <a class="el" href="histogram_8cl_source.xhtml#l00068">hist_local_kernel()</a>.</p>
191
192</div>
193</div>
194<h2 class="groupheader">Function Documentation</h2>
195<a class="anchor" id="af82fea967051b827585009463255262d"></a>
196<div class="memitem">
197<div class="memproto">
198 <table class="memname">
199 <tr>
200 <td class="memname">__kernel void hist_border_kernel </td>
201 <td>(</td>
202 <td class="paramtype">__global uchar *&#160;</td>
203 <td class="paramname"><em>input_ptr</em>, </td>
204 </tr>
205 <tr>
206 <td class="paramkey"></td>
207 <td></td>
208 <td class="paramtype">uint&#160;</td>
209 <td class="paramname"><em>input_stride_x</em>, </td>
210 </tr>
211 <tr>
212 <td class="paramkey"></td>
213 <td></td>
214 <td class="paramtype">uint&#160;</td>
215 <td class="paramname"><em>input_step_x</em>, </td>
216 </tr>
217 <tr>
218 <td class="paramkey"></td>
219 <td></td>
220 <td class="paramtype">uint&#160;</td>
221 <td class="paramname"><em>input_stride_y</em>, </td>
222 </tr>
223 <tr>
224 <td class="paramkey"></td>
225 <td></td>
226 <td class="paramtype">uint&#160;</td>
227 <td class="paramname"><em>input_step_y</em>, </td>
228 </tr>
229 <tr>
230 <td class="paramkey"></td>
231 <td></td>
232 <td class="paramtype">uint&#160;</td>
233 <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
234 </tr>
235 <tr>
236 <td class="paramkey"></td>
237 <td></td>
238 <td class="paramtype">__global uint *restrict&#160;</td>
239 <td class="paramname"><em>histogram</em>, </td>
240 </tr>
241 <tr>
242 <td class="paramkey"></td>
243 <td></td>
244 <td class="paramtype">uint&#160;</td>
245 <td class="paramname"><em>num_bins</em>, </td>
246 </tr>
247 <tr>
248 <td class="paramkey"></td>
249 <td></td>
250 <td class="paramtype">uint&#160;</td>
251 <td class="paramname"><em>offset</em>, </td>
252 </tr>
253 <tr>
254 <td class="paramkey"></td>
255 <td></td>
256 <td class="paramtype">uint&#160;</td>
257 <td class="paramname"><em>range</em>, </td>
258 </tr>
259 <tr>
260 <td class="paramkey"></td>
261 <td></td>
262 <td class="paramtype">uint&#160;</td>
263 <td class="paramname"><em>offrange</em>&#160;</td>
264 </tr>
265 <tr>
266 <td></td>
267 <td>)</td>
268 <td></td><td></td>
269 </tr>
270 </table>
271</div><div class="memdoc">
272
273<p>Calculate the histogram of an 8 bit grayscale image's border. </p>
274<p>Each thread will process one pixel using global atomic. When all work items in a work group are done the resulting local histograms are added to the global histogram using global atomics.</p>
275<dl class="section note"><dt>Note</dt><dd>The input image is represented as a two-dimensional array of type uchar. The output is represented as a one-dimensional uint array of length of num_bins</dd></dl>
276<dl class="params"><dt>Parameters</dt><dd>
277 <table class="params">
278 <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the first source image. Supported data types: U8 </td></tr>
279 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_x</td><td>Stride of the first source image in X dimension (in bytes) </td></tr>
280 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_x</td><td>input_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
281 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_y</td><td>Stride of the first source image in Y dimension (in bytes) </td></tr>
282 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_y</td><td>input_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
283 <tr><td class="paramdir">[in]</td><td class="paramname">input_offset_first_element_in_bytes</td><td>The offset of the first element in the first source image </td></tr>
284 <tr><td class="paramdir">[out]</td><td class="paramname">histogram</td><td>The output buffer to hold histogram final result. Supported data types: U32 </td></tr>
285 <tr><td class="paramdir">[out]</td><td class="paramname">num_bins</td><td>The number of bins </td></tr>
286 <tr><td class="paramdir">[out]</td><td class="paramname">offset</td><td>The start of values to use (inclusive) </td></tr>
287 <tr><td class="paramdir">[out]</td><td class="paramname">range</td><td>The range of a bin </td></tr>
288 <tr><td class="paramdir">[out]</td><td class="paramname">offrange</td><td>The maximum value (exclusive) </td></tr>
289 </table>
290 </dd>
291</dl>
292
293<p>Definition at line <a class="el" href="histogram_8cl_source.xhtml#l00141">141</a> of file <a class="el" href="histogram_8cl_source.xhtml">histogram.cl</a>.</p>
294
Kaizenbf8b01d2017-10-12 14:26:51 +0100295<p>References <a class="el" href="helpers_8h_source.xhtml#l00096">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="helpers_8h_source.xhtml#l00295">offset()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00136">Image::ptr</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100296<div class="fragment"><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;{</div>
297<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> input_buffer = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(input);</div>
298<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;</div>
299<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; uint val = (uint)(*input_buffer.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div>
300<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div>
301<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; uint win_pos = (val &gt;= <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>) ? (((val - <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>) * num_bins) / range) : 0;</div>
302<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div>
303<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keywordflow">if</span>(val &gt;= <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a> &amp;&amp; (val &lt; offrange))</div>
304<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; {</div>
305<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; atomic_inc(histogram + win_pos);</div>
306<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; }</div>
307<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;}</div>
Kaizenbf8b01d2017-10-12 14:26:51 +0100308<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#l00295">helpers.h:295</a></div></div>
309<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#l00096">helpers.h:96</a></div></div>
310<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#l00134">helpers.h:134</a></div></div>
311<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#l00136">helpers.h:136</a></div></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000312</div><!-- fragment -->
313</div>
314</div>
315<a class="anchor" id="aec6ec6157573195df9694109ebbb38ae"></a>
316<div class="memitem">
317<div class="memproto">
318 <table class="memname">
319 <tr>
320 <td class="memname">__kernel void hist_border_kernel_fixed </td>
321 <td>(</td>
322 <td class="paramtype">__global uchar *&#160;</td>
323 <td class="paramname"><em>input_ptr</em>, </td>
324 </tr>
325 <tr>
326 <td class="paramkey"></td>
327 <td></td>
328 <td class="paramtype">uint&#160;</td>
329 <td class="paramname"><em>input_stride_x</em>, </td>
330 </tr>
331 <tr>
332 <td class="paramkey"></td>
333 <td></td>
334 <td class="paramtype">uint&#160;</td>
335 <td class="paramname"><em>input_step_x</em>, </td>
336 </tr>
337 <tr>
338 <td class="paramkey"></td>
339 <td></td>
340 <td class="paramtype">uint&#160;</td>
341 <td class="paramname"><em>input_stride_y</em>, </td>
342 </tr>
343 <tr>
344 <td class="paramkey"></td>
345 <td></td>
346 <td class="paramtype">uint&#160;</td>
347 <td class="paramname"><em>input_step_y</em>, </td>
348 </tr>
349 <tr>
350 <td class="paramkey"></td>
351 <td></td>
352 <td class="paramtype">uint&#160;</td>
353 <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
354 </tr>
355 <tr>
356 <td class="paramkey"></td>
357 <td></td>
358 <td class="paramtype">__global uint *restrict&#160;</td>
359 <td class="paramname"><em>histogram</em>&#160;</td>
360 </tr>
361 <tr>
362 <td></td>
363 <td>)</td>
364 <td></td><td></td>
365 </tr>
366 </table>
367</div><div class="memdoc">
368
369<p>Calculate the histogram of an 8 bit grayscale image with bin size as 256 and window size as 1. </p>
370<p>Each thread will process one pixel using global atomic. When all work items in a work group are done the resulting local histograms are added to the global histogram using global atomics.</p>
371<dl class="section note"><dt>Note</dt><dd>The input image is represented as a two-dimensional array of type uchar. The output is represented as a one-dimensional uint array of 256</dd></dl>
372<dl class="params"><dt>Parameters</dt><dd>
373 <table class="params">
374 <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the first source image. Supported data types: U8 </td></tr>
375 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_x</td><td>Stride of the first source image in X dimension (in bytes) </td></tr>
376 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_x</td><td>input_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
377 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_y</td><td>Stride of the first source image in Y dimension (in bytes) </td></tr>
378 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_y</td><td>input_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
379 <tr><td class="paramdir">[in]</td><td class="paramname">input_offset_first_element_in_bytes</td><td>The offset of the first element in the first source image </td></tr>
380 <tr><td class="paramdir">[out]</td><td class="paramname">histogram</td><td>The output buffer to hold histogram final result. Supported data types: U32 </td></tr>
381 </table>
382 </dd>
383</dl>
384
385<p>Definition at line <a class="el" href="histogram_8cl_source.xhtml#l00238">238</a> of file <a class="el" href="histogram_8cl_source.xhtml">histogram.cl</a>.</p>
386
Kaizenbf8b01d2017-10-12 14:26:51 +0100387<p>References <a class="el" href="helpers_8h_source.xhtml#l00096">CONVERT_TO_IMAGE_STRUCT</a>, and <a class="el" href="helpers_8h_source.xhtml#l00136">Image::ptr</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100388<div class="fragment"><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;{</div>
389<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> input_buffer = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(input);</div>
390<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; atomic_inc(histogram + *input_buffer.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div>
391<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;}</div>
Kaizenbf8b01d2017-10-12 14:26:51 +0100392<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#l00096">helpers.h:96</a></div></div>
393<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#l00134">helpers.h:134</a></div></div>
394<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#l00136">helpers.h:136</a></div></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000395</div><!-- fragment -->
396</div>
397</div>
398<a class="anchor" id="abc81d92c9655c4ec22fff9163b66279d"></a>
399<div class="memitem">
400<div class="memproto">
401 <table class="memname">
402 <tr>
403 <td class="memname">__kernel void hist_local_kernel </td>
404 <td>(</td>
405 <td class="paramtype">__global uchar *&#160;</td>
406 <td class="paramname"><em>input_ptr</em>, </td>
407 </tr>
408 <tr>
409 <td class="paramkey"></td>
410 <td></td>
411 <td class="paramtype">uint&#160;</td>
412 <td class="paramname"><em>input_stride_x</em>, </td>
413 </tr>
414 <tr>
415 <td class="paramkey"></td>
416 <td></td>
417 <td class="paramtype">uint&#160;</td>
418 <td class="paramname"><em>input_step_x</em>, </td>
419 </tr>
420 <tr>
421 <td class="paramkey"></td>
422 <td></td>
423 <td class="paramtype">uint&#160;</td>
424 <td class="paramname"><em>input_stride_y</em>, </td>
425 </tr>
426 <tr>
427 <td class="paramkey"></td>
428 <td></td>
429 <td class="paramtype">uint&#160;</td>
430 <td class="paramname"><em>input_step_y</em>, </td>
431 </tr>
432 <tr>
433 <td class="paramkey"></td>
434 <td></td>
435 <td class="paramtype">uint&#160;</td>
436 <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
437 </tr>
438 <tr>
439 <td class="paramkey"></td>
440 <td></td>
441 <td class="paramtype">__local uint *&#160;</td>
442 <td class="paramname"><em>histogram_local</em>, </td>
443 </tr>
444 <tr>
445 <td class="paramkey"></td>
446 <td></td>
447 <td class="paramtype">__global uint *restrict&#160;</td>
448 <td class="paramname"><em>histogram</em>, </td>
449 </tr>
450 <tr>
451 <td class="paramkey"></td>
452 <td></td>
453 <td class="paramtype">uint&#160;</td>
454 <td class="paramname"><em>num_bins</em>, </td>
455 </tr>
456 <tr>
457 <td class="paramkey"></td>
458 <td></td>
459 <td class="paramtype">uint&#160;</td>
460 <td class="paramname"><em>offset</em>, </td>
461 </tr>
462 <tr>
463 <td class="paramkey"></td>
464 <td></td>
465 <td class="paramtype">uint&#160;</td>
466 <td class="paramname"><em>range</em>, </td>
467 </tr>
468 <tr>
469 <td class="paramkey"></td>
470 <td></td>
471 <td class="paramtype">uint&#160;</td>
472 <td class="paramname"><em>offrange</em>&#160;</td>
473 </tr>
474 <tr>
475 <td></td>
476 <td>)</td>
477 <td></td><td></td>
478 </tr>
479 </table>
480</div><div class="memdoc">
481
482<p>Calculate the histogram of an 8 bit grayscale image. </p>
483<p>Each thread will process 16 pixels and use one local atomic operation per pixel. When all work items in a work group are done the resulting local histograms are added to the global histogram using global atomics.</p>
484<dl class="section note"><dt>Note</dt><dd>The input image is represented as a two-dimensional array of type uchar. The output is represented as a one-dimensional uint array of length of num_bins</dd></dl>
485<dl class="params"><dt>Parameters</dt><dd>
486 <table class="params">
487 <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the first source image. Supported data types: U8 </td></tr>
488 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_x</td><td>Stride of the first source image in X dimension (in bytes) </td></tr>
489 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_x</td><td>input_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
490 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_y</td><td>Stride of the first source image in Y dimension (in bytes) </td></tr>
491 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_y</td><td>input_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
492 <tr><td class="paramdir">[in]</td><td class="paramname">input_offset_first_element_in_bytes</td><td>The offset of the first element in the first source image </td></tr>
493 <tr><td class="paramdir">[in]</td><td class="paramname">histogram_local</td><td>The local buffer to hold histogram result in per workgroup. Supported data types: U32 </td></tr>
494 <tr><td class="paramdir">[out]</td><td class="paramname">histogram</td><td>The output buffer to hold histogram final result. Supported data types: U32 </td></tr>
495 <tr><td class="paramdir">[out]</td><td class="paramname">num_bins</td><td>The number of bins </td></tr>
496 <tr><td class="paramdir">[out]</td><td class="paramname">offset</td><td>The start of values to use (inclusive) </td></tr>
497 <tr><td class="paramdir">[out]</td><td class="paramname">range</td><td>The range of a bin </td></tr>
498 <tr><td class="paramdir">[out]</td><td class="paramname">offrange</td><td>The maximum value (exclusive) </td></tr>
499 </table>
500 </dd>
501</dl>
502
503<p>Definition at line <a class="el" href="histogram_8cl_source.xhtml#l00068">68</a> of file <a class="el" href="histogram_8cl_source.xhtml">histogram.cl</a>.</p>
504
Kaizenbf8b01d2017-10-12 14:26:51 +0100505<p>References <a class="el" href="helpers_8h_source.xhtml#l00096">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="helpers_8h_source.xhtml#l00136">Image::ptr</a>, and <a class="el" href="histogram_8cl_source.xhtml#l00026">VATOMIC_INC16</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100506<div class="fragment"><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;{</div>
507<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> input_buffer = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(input);</div>
508<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; uint local_id_x = get_local_id(0);</div>
509<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
510<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; uint local_x_size = get_local_size(0);</div>
511<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
512<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">if</span>(num_bins &gt; local_x_size)</div>
513<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div>
514<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = local_id_x; i &lt; num_bins; i += local_x_size)</div>
515<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; {</div>
516<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; histogram_local[i] = 0;</div>
517<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; }</div>
518<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div>
519<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">else</span></div>
520<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; {</div>
521<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">if</span>(local_id_x &lt;= num_bins)</div>
522<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; {</div>
523<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; histogram_local[local_id_x] = 0;</div>
524<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div>
525<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div>
526<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
527<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; uint16 vals = convert_uint16(vload16(0, input_buffer.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div>
528<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
529<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; uint16 win_pos = select(num_bins, ((vals - <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>) * num_bins) / range, (vals &gt;= <a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a> &amp;&amp; vals &lt; offrange));</div>
530<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
531<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; barrier(CLK_LOCAL_MEM_FENCE);</div>
532<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <a class="code" href="histogram_8cl.xhtml#a2c8a35cfde24ca7728709200962e1a91">VATOMIC_INC16</a>(histogram_local, win_pos);</div>
533<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; barrier(CLK_LOCAL_MEM_FENCE);</div>
534<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
535<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">if</span>(num_bins &gt; local_x_size)</div>
536<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; {</div>
537<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = local_id_x; i &lt; num_bins; i += local_x_size)</div>
538<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {</div>
539<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; atomic_add(histogram + i, histogram_local[i]);</div>
540<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div>
541<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; }</div>
542<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordflow">else</span></div>
543<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; {</div>
544<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">if</span>(local_id_x &lt;= num_bins)</div>
545<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; {</div>
546<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; atomic_add(histogram + local_id_x, histogram_local[local_id_x]);</div>
547<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div>
548<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; }</div>
549<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;}</div>
550<div class="ttc" id="histogram_8cl_xhtml_a2c8a35cfde24ca7728709200962e1a91"><div class="ttname"><a href="histogram_8cl.xhtml#a2c8a35cfde24ca7728709200962e1a91">VATOMIC_INC16</a></div><div class="ttdeci">#define VATOMIC_INC16(histogram, win_pos)</div><div class="ttdef"><b>Definition:</b> <a href="histogram_8cl_source.xhtml#l00026">histogram.cl:26</a></div></div>
Kaizenbf8b01d2017-10-12 14:26:51 +0100551<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#l00295">helpers.h:295</a></div></div>
552<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#l00096">helpers.h:96</a></div></div>
553<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#l00134">helpers.h:134</a></div></div>
554<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#l00136">helpers.h:136</a></div></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000555</div><!-- fragment -->
556</div>
557</div>
558<a class="anchor" id="a7c8051ab952a597e66090d77f4dc60e4"></a>
559<div class="memitem">
560<div class="memproto">
561 <table class="memname">
562 <tr>
563 <td class="memname">__kernel void hist_local_kernel_fixed </td>
564 <td>(</td>
565 <td class="paramtype">__global uchar *&#160;</td>
566 <td class="paramname"><em>input_ptr</em>, </td>
567 </tr>
568 <tr>
569 <td class="paramkey"></td>
570 <td></td>
571 <td class="paramtype">uint&#160;</td>
572 <td class="paramname"><em>input_stride_x</em>, </td>
573 </tr>
574 <tr>
575 <td class="paramkey"></td>
576 <td></td>
577 <td class="paramtype">uint&#160;</td>
578 <td class="paramname"><em>input_step_x</em>, </td>
579 </tr>
580 <tr>
581 <td class="paramkey"></td>
582 <td></td>
583 <td class="paramtype">uint&#160;</td>
584 <td class="paramname"><em>input_stride_y</em>, </td>
585 </tr>
586 <tr>
587 <td class="paramkey"></td>
588 <td></td>
589 <td class="paramtype">uint&#160;</td>
590 <td class="paramname"><em>input_step_y</em>, </td>
591 </tr>
592 <tr>
593 <td class="paramkey"></td>
594 <td></td>
595 <td class="paramtype">uint&#160;</td>
596 <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
597 </tr>
598 <tr>
599 <td class="paramkey"></td>
600 <td></td>
601 <td class="paramtype">__local uint *&#160;</td>
602 <td class="paramname"><em>histogram_local</em>, </td>
603 </tr>
604 <tr>
605 <td class="paramkey"></td>
606 <td></td>
607 <td class="paramtype">__global uint *restrict&#160;</td>
608 <td class="paramname"><em>histogram</em>&#160;</td>
609 </tr>
610 <tr>
611 <td></td>
612 <td>)</td>
613 <td></td><td></td>
614 </tr>
615 </table>
616</div><div class="memdoc">
617
618<p>Calculate the histogram of an 8 bit grayscale image with bin size of 256 and window size of 1. </p>
619<p>Each thread will process 16 pixels and use one local atomic operation per pixel. When all work items in a work group are done the resulting local histograms are added to the global histogram using global atomics.</p>
620<dl class="section note"><dt>Note</dt><dd>The input image is represented as a two-dimensional array of type uchar. The output is represented as a one-dimensional uint array of 256 elements</dd></dl>
621<dl class="params"><dt>Parameters</dt><dd>
622 <table class="params">
623 <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the first source image. Supported data types: U8 </td></tr>
624 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_x</td><td>Stride of the first source image in X dimension (in bytes) </td></tr>
625 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_x</td><td>input_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
626 <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_y</td><td>Stride of the first source image in Y dimension (in bytes) </td></tr>
627 <tr><td class="paramdir">[in]</td><td class="paramname">input_step_y</td><td>input_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
628 <tr><td class="paramdir">[in]</td><td class="paramname">input_offset_first_element_in_bytes</td><td>The offset of the first element in the first source image </td></tr>
629 <tr><td class="paramdir">[in]</td><td class="paramname">histogram_local</td><td>The local buffer to hold histogram result in per workgroup. Supported data types: U32 </td></tr>
630 <tr><td class="paramdir">[out]</td><td class="paramname">histogram</td><td>The output buffer to hold histogram final result. Supported data types: U32 </td></tr>
631 </table>
632 </dd>
633</dl>
634
635<p>Definition at line <a class="el" href="histogram_8cl_source.xhtml#l00178">178</a> of file <a class="el" href="histogram_8cl_source.xhtml">histogram.cl</a>.</p>
636
Kaizenbf8b01d2017-10-12 14:26:51 +0100637<p>References <a class="el" href="helpers_8h_source.xhtml#l00096">CONVERT_TO_IMAGE_STRUCT</a>, and <a class="el" href="helpers_8h_source.xhtml#l00136">Image::ptr</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100638<div class="fragment"><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;{</div>
639<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> input_buffer = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(input);</div>
640<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;</div>
641<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; uint local_index = get_local_id(0);</div>
642<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; uint local_x_size = get_local_size(0);</div>
643<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;</div>
644<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = local_index; i &lt; 256; i += local_x_size)</div>
645<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; {</div>
646<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; histogram_local[i] = 0;</div>
647<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; }</div>
648<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;</div>
649<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; uint16 vals = convert_uint16(vload16(0, input_buffer.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div>
650<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;</div>
651<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; barrier(CLK_LOCAL_MEM_FENCE);</div>
652<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div>
653<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; atomic_inc(histogram_local + vals.s0);</div>
654<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; atomic_inc(histogram_local + vals.s1);</div>
655<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; atomic_inc(histogram_local + vals.s2);</div>
656<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; atomic_inc(histogram_local + vals.s3);</div>
657<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; atomic_inc(histogram_local + vals.s4);</div>
658<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; atomic_inc(histogram_local + vals.s5);</div>
659<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; atomic_inc(histogram_local + vals.s6);</div>
660<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; atomic_inc(histogram_local + vals.s7);</div>
661<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; atomic_inc(histogram_local + vals.s8);</div>
662<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; atomic_inc(histogram_local + vals.s9);</div>
663<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; atomic_inc(histogram_local + vals.sa);</div>
664<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; atomic_inc(histogram_local + vals.sb);</div>
665<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; atomic_inc(histogram_local + vals.sc);</div>
666<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; atomic_inc(histogram_local + vals.sd);</div>
667<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; atomic_inc(histogram_local + vals.se);</div>
668<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; atomic_inc(histogram_local + vals.sf);</div>
669<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;</div>
670<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; barrier(CLK_LOCAL_MEM_FENCE);</div>
671<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;</div>
672<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = local_index; i &lt; 256; i += local_x_size)</div>
673<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; {</div>
674<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; atomic_add(histogram + i, histogram_local[i]);</div>
675<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; }</div>
676<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;}</div>
Kaizenbf8b01d2017-10-12 14:26:51 +0100677<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#l00096">helpers.h:96</a></div></div>
678<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#l00134">helpers.h:134</a></div></div>
679<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#l00136">helpers.h:136</a></div></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000680</div><!-- fragment -->
681</div>
682</div>
683</div><!-- contents -->
684</div><!-- doc-content -->
685<!-- start footer part -->
686<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
687 <ul>
Kaizen8938bd32017-09-28 14:38:23 +0100688 <li class="navelem"><a class="el" href="dir_55b5a5006e943fb664ff8cff3cfe7768.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_f6c3ae42d7e27145d0a3c3e38ca1c000.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_1b7ae9123c88e650426d50d95c19d414.xhtml">CL</a></li><li class="navelem"><a class="el" href="dir_b7c3d80b0dadb2139bc73b7161751c12.xhtml">cl_kernels</a></li><li class="navelem"><a class="el" href="histogram_8cl.xhtml">histogram.cl</a></li>
Kaizenbf8b01d2017-10-12 14:26:51 +0100689 <li class="footer">Generated on Thu Oct 12 2017 14:26:35 for Compute Library by
Anthony Barbier871448e2017-03-24 14:54:29 +0000690 <a href="http://www.doxygen.org/index.html">
Kaizen8938bd32017-09-28 14:38:23 +0100691 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000692 </ul>
693</div>
694</body>
695</html>