e6c208e9025283b6d63e9b97707ba77fbeada231
[platform/upstream/armcl.git] / documentation / depth__convert_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>Compute Library: src/core/CL/cl_kernels/depth_convert.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">Compute Library
43    &#160;<span id="projectnumber">18.02</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
83       <li><a href="globals.xhtml"><span>Globals</span></a></li>
84     </ul>
85   </div>
86 </div><!-- top -->
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
88   <div id="nav-tree">
89     <div id="nav-tree-contents">
90       <div id="nav-sync" class="sync"></div>
91     </div>
92   </div>
93   <div id="splitbar" style="-moz-user-select:none;" 
94        class="ui-resizable-handle">
95   </div>
96 </div>
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('depth__convert_8cl.xhtml','');});
99 </script>
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103      onmouseover="return searchBox.OnSearchSelectShow()"
104      onmouseout="return searchBox.OnSearchSelectHide()"
105      onkeydown="return searchBox.OnSearchSelectKey(event)">
106 </div>
107
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0" 
111         name="MSearchResults" id="MSearchResults">
112 </iframe>
113 </div>
114
115 <div class="header">
116   <div class="summary">
117 <a href="#define-members">Macros</a> &#124;
118 <a href="#func-members">Functions</a>  </div>
119   <div class="headertitle">
120 <div class="title">depth_convert.cl File Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123 <div class="textblock"><code>#include &quot;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&quot;</code><br />
124 </div>
125 <p><a href="depth__convert_8cl_source.xhtml">Go to the source code of this file.</a></p>
126 <table class="memberdecls">
127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
128 Macros</h2></td></tr>
129 <tr class="memitem:a5b0d9908c0af31eaa7a31d0b5cf8e56d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="depth__convert_8cl.xhtml#a5b0d9908c0af31eaa7a31d0b5cf8e56d">CONVERT_DOWN</a>(x,  type)&#160;&#160;&#160;<a class="el" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(x, type)</td></tr>
130 <tr class="separator:a5b0d9908c0af31eaa7a31d0b5cf8e56d"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <tr class="memitem:a9bed30cda5ab157322d2f0bbdff46d28"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="depth__convert_8cl.xhtml#a9bed30cda5ab157322d2f0bbdff46d28">CONVERT_UP</a>(x,  type)&#160;&#160;&#160;<a class="el" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(x, type)</td></tr>
132 <tr class="separator:a9bed30cda5ab157322d2f0bbdff46d28"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 </table><table class="memberdecls">
134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
135 Functions</h2></td></tr>
136 <tr class="memitem:aab970e69ff53ae814fae772df4ae9c2d"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="depth__convert_8cl.xhtml#aab970e69ff53ae814fae772df4ae9c2d">convert_depth_down</a> (__global uchar *in_ptr, uint in_stride_x, uint in_step_x, uint in_stride_y, uint in_step_y, uint in_offset_first_element_in_bytes, __global uchar *out_ptr, uint out_stride_x, uint out_step_x, uint out_stride_y, uint out_step_y, uint out_offset_first_element_in_bytes, const int shift)</td></tr>
137 <tr class="memdesc:aab970e69ff53ae814fae772df4ae9c2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs a down-scaling depth conversion.  <a href="#aab970e69ff53ae814fae772df4ae9c2d">More...</a><br /></td></tr>
138 <tr class="separator:aab970e69ff53ae814fae772df4ae9c2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <tr class="memitem:ae2f96efadb55c92fe506140c36b6b25d"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="depth__convert_8cl.xhtml#ae2f96efadb55c92fe506140c36b6b25d">convert_depth_up</a> (__global uchar *in_ptr, uint in_stride_x, uint in_step_x, uint in_stride_y, uint in_step_y, uint in_offset_first_element_in_bytes, __global uchar *out_ptr, uint out_stride_x, uint out_step_x, uint out_stride_y, uint out_step_y, uint out_offset_first_element_in_bytes, const int shift)</td></tr>
140 <tr class="memdesc:ae2f96efadb55c92fe506140c36b6b25d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs a up-scaling depth conversion.  <a href="#ae2f96efadb55c92fe506140c36b6b25d">More...</a><br /></td></tr>
141 <tr class="separator:ae2f96efadb55c92fe506140c36b6b25d"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 </table>
143 <h2 class="groupheader">Macro Definition Documentation</h2>
144 <a class="anchor" id="a5b0d9908c0af31eaa7a31d0b5cf8e56d"></a>
145 <div class="memitem">
146 <div class="memproto">
147       <table class="memname">
148         <tr>
149           <td class="memname">#define CONVERT_DOWN</td>
150           <td>(</td>
151           <td class="paramtype">&#160;</td>
152           <td class="paramname">x, </td>
153         </tr>
154         <tr>
155           <td class="paramkey"></td>
156           <td></td>
157           <td class="paramtype">&#160;</td>
158           <td class="paramname">type&#160;</td>
159         </tr>
160         <tr>
161           <td></td>
162           <td>)</td>
163           <td></td><td>&#160;&#160;&#160;<a class="el" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(x, type)</td>
164         </tr>
165       </table>
166 </div><div class="memdoc">
167
168 <p>Definition at line <a class="el" href="depth__convert_8cl_source.xhtml#l00046">46</a> of file <a class="el" href="depth__convert_8cl_source.xhtml">depth_convert.cl</a>.</p>
169
170 <p>Referenced by <a class="el" href="depth__convert_8cl_source.xhtml#l00074">convert_depth_down()</a>.</p>
171
172 </div>
173 </div>
174 <a class="anchor" id="a9bed30cda5ab157322d2f0bbdff46d28"></a>
175 <div class="memitem">
176 <div class="memproto">
177       <table class="memname">
178         <tr>
179           <td class="memname">#define CONVERT_UP</td>
180           <td>(</td>
181           <td class="paramtype">&#160;</td>
182           <td class="paramname">x, </td>
183         </tr>
184         <tr>
185           <td class="paramkey"></td>
186           <td></td>
187           <td class="paramtype">&#160;</td>
188           <td class="paramname">type&#160;</td>
189         </tr>
190         <tr>
191           <td></td>
192           <td>)</td>
193           <td></td><td>&#160;&#160;&#160;<a class="el" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(x, type)</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>Definition at line <a class="el" href="depth__convert_8cl_source.xhtml#l00049">49</a> of file <a class="el" href="depth__convert_8cl_source.xhtml">depth_convert.cl</a>.</p>
199
200 <p>Referenced by <a class="el" href="depth__convert_8cl_source.xhtml#l00115">convert_depth_up()</a>.</p>
201
202 </div>
203 </div>
204 <h2 class="groupheader">Function Documentation</h2>
205 <a class="anchor" id="aab970e69ff53ae814fae772df4ae9c2d"></a>
206 <div class="memitem">
207 <div class="memproto">
208       <table class="memname">
209         <tr>
210           <td class="memname">__kernel void convert_depth_down </td>
211           <td>(</td>
212           <td class="paramtype">__global uchar *&#160;</td>
213           <td class="paramname"><em>in_ptr</em>, </td>
214         </tr>
215         <tr>
216           <td class="paramkey"></td>
217           <td></td>
218           <td class="paramtype">uint&#160;</td>
219           <td class="paramname"><em>in_stride_x</em>, </td>
220         </tr>
221         <tr>
222           <td class="paramkey"></td>
223           <td></td>
224           <td class="paramtype">uint&#160;</td>
225           <td class="paramname"><em>in_step_x</em>, </td>
226         </tr>
227         <tr>
228           <td class="paramkey"></td>
229           <td></td>
230           <td class="paramtype">uint&#160;</td>
231           <td class="paramname"><em>in_stride_y</em>, </td>
232         </tr>
233         <tr>
234           <td class="paramkey"></td>
235           <td></td>
236           <td class="paramtype">uint&#160;</td>
237           <td class="paramname"><em>in_step_y</em>, </td>
238         </tr>
239         <tr>
240           <td class="paramkey"></td>
241           <td></td>
242           <td class="paramtype">uint&#160;</td>
243           <td class="paramname"><em>in_offset_first_element_in_bytes</em>, </td>
244         </tr>
245         <tr>
246           <td class="paramkey"></td>
247           <td></td>
248           <td class="paramtype">__global uchar *&#160;</td>
249           <td class="paramname"><em>out_ptr</em>, </td>
250         </tr>
251         <tr>
252           <td class="paramkey"></td>
253           <td></td>
254           <td class="paramtype">uint&#160;</td>
255           <td class="paramname"><em>out_stride_x</em>, </td>
256         </tr>
257         <tr>
258           <td class="paramkey"></td>
259           <td></td>
260           <td class="paramtype">uint&#160;</td>
261           <td class="paramname"><em>out_step_x</em>, </td>
262         </tr>
263         <tr>
264           <td class="paramkey"></td>
265           <td></td>
266           <td class="paramtype">uint&#160;</td>
267           <td class="paramname"><em>out_stride_y</em>, </td>
268         </tr>
269         <tr>
270           <td class="paramkey"></td>
271           <td></td>
272           <td class="paramtype">uint&#160;</td>
273           <td class="paramname"><em>out_step_y</em>, </td>
274         </tr>
275         <tr>
276           <td class="paramkey"></td>
277           <td></td>
278           <td class="paramtype">uint&#160;</td>
279           <td class="paramname"><em>out_offset_first_element_in_bytes</em>, </td>
280         </tr>
281         <tr>
282           <td class="paramkey"></td>
283           <td></td>
284           <td class="paramtype">const int&#160;</td>
285           <td class="paramname"><em>shift</em>&#160;</td>
286         </tr>
287         <tr>
288           <td></td>
289           <td>)</td>
290           <td></td><td></td>
291         </tr>
292       </table>
293 </div><div class="memdoc">
294
295 <p>This function performs a down-scaling depth conversion. </p>
296 <dl class="section attention"><dt>Attention</dt><dd>The input and output data_types need to be passed at compile time using -DDATA_TYPE_IN and -DDATA_TYPE_OUT: e.g. -DDATA_TYPE_IN=uchar -DDATA_TYPE_OUT=short</dd></dl>
297 <dl class="section note"><dt>Note</dt><dd>In case of fixed-point operation -DFIXED_POINT_POSITION=fixed_point_position must be provided: e.g. -DFIXED_POINT_POSITION=3</dd></dl>
298 <dl class="params"><dt>Parameters</dt><dd>
299   <table class="params">
300     <tr><td class="paramdir">[in]</td><td class="paramname">in_ptr</td><td>Pointer to the source image. Supported data types: U8, U16, S16, U32, S32, F16, F32 </td></tr>
301     <tr><td class="paramdir">[in]</td><td class="paramname">in_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
302     <tr><td class="paramdir">[in]</td><td class="paramname">in_step_x</td><td>in_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
303     <tr><td class="paramdir">[in]</td><td class="paramname">in_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
304     <tr><td class="paramdir">[in]</td><td class="paramname">in_step_y</td><td>in_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
305     <tr><td class="paramdir">[in]</td><td class="paramname">in_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
306     <tr><td class="paramdir">[out]</td><td class="paramname">out_ptr</td><td>Pointer to the destination image. Supported data types: QS8, U8, QS16, U16, S16, U32, S32 </td></tr>
307     <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
308     <tr><td class="paramdir">[in]</td><td class="paramname">out_step_x</td><td>out_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
309     <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
310     <tr><td class="paramdir">[in]</td><td class="paramname">out_step_y</td><td>out_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
311     <tr><td class="paramdir">[in]</td><td class="paramname">out_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
312     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>The integer shift amount value. Supported data types: S32 </td></tr>
313   </table>
314   </dd>
315 </dl>
316
317 <p>Definition at line <a class="el" href="depth__convert_8cl_source.xhtml#l00074">74</a> of file <a class="el" href="depth__convert_8cl_source.xhtml">depth_convert.cl</a>.</p>
318
319 <p>References <a class="el" href="depth__convert_8cl_source.xhtml#l00046">CONVERT_DOWN</a>, <a class="el" href="helpers_8h_source.xhtml#l00102">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="convolution3x3_8cl_source.xhtml#l00031">DATA_TYPE_OUT</a>, <a class="el" href="helpers_8h_source.xhtml#l00142">Image::ptr</a>, and <a class="el" href="fixed__point_8h_source.xhtml#l00093">VEC_DATA_TYPE</a>.</p>
320 <div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;{</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> in  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(in);</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> out = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(out);</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_IN, 16)</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    in_data = vload16(0, (__global DATA_TYPE_IN *)in.ptr);</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="preprocessor">#if defined(FIXED_POINT_POSITION)</span></div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    vstore16(<a class="code" href="depth__convert_8cl.xhtml#a5b0d9908c0af31eaa7a31d0b5cf8e56d">CONVERT_DOWN</a>(in_data, <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_IN, 16), <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16), FIXED_POINT_POSITION), 0, (__global <a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a> *)out.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="preprocessor">#else  </span><span class="comment">/* FIXED_POINT_POSITION */</span><span class="preprocessor"></span></div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    vstore16(<a class="code" href="depth__convert_8cl.xhtml#a5b0d9908c0af31eaa7a31d0b5cf8e56d">CONVERT_DOWN</a>(in_data &gt;&gt; shift, <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16)), 0, (__global <a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a> *)out.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FIXED_POINT_POSITION */</span><span class="preprocessor"></span></div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;}</div><div class="ttc" id="depth__convert_8cl_xhtml_a5b0d9908c0af31eaa7a31d0b5cf8e56d"><div class="ttname"><a href="depth__convert_8cl.xhtml#a5b0d9908c0af31eaa7a31d0b5cf8e56d">CONVERT_DOWN</a></div><div class="ttdeci">#define CONVERT_DOWN(x, type)</div><div class="ttdef"><b>Definition:</b> <a href="depth__convert_8cl_source.xhtml#l00046">depth_convert.cl:46</a></div></div>
321 <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#l00102">helpers.h:102</a></div></div>
322 <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#l00140">helpers.h:140</a></div></div>
323 <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#l00142">helpers.h:142</a></div></div>
324 <div class="ttc" id="fixed__point_8h_xhtml_a36f754c05b6fddf6df0d8d0a74f8159f"><div class="ttname"><a href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a></div><div class="ttdeci">#define VEC_DATA_TYPE(type, size)</div><div class="ttdef"><b>Definition:</b> <a href="fixed__point_8h_source.xhtml#l00093">fixed_point.h:93</a></div></div>
325 <div class="ttc" id="convolution3x3_8cl_xhtml_ac06f3e24d3fffd3c465d8b2a6e7c985e"><div class="ttname"><a href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a></div><div class="ttdeci">#define DATA_TYPE_OUT</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00031">convolution3x3.cl:31</a></div></div>
326 </div><!-- fragment -->
327 </div>
328 </div>
329 <a class="anchor" id="ae2f96efadb55c92fe506140c36b6b25d"></a>
330 <div class="memitem">
331 <div class="memproto">
332       <table class="memname">
333         <tr>
334           <td class="memname">__kernel void convert_depth_up </td>
335           <td>(</td>
336           <td class="paramtype">__global uchar *&#160;</td>
337           <td class="paramname"><em>in_ptr</em>, </td>
338         </tr>
339         <tr>
340           <td class="paramkey"></td>
341           <td></td>
342           <td class="paramtype">uint&#160;</td>
343           <td class="paramname"><em>in_stride_x</em>, </td>
344         </tr>
345         <tr>
346           <td class="paramkey"></td>
347           <td></td>
348           <td class="paramtype">uint&#160;</td>
349           <td class="paramname"><em>in_step_x</em>, </td>
350         </tr>
351         <tr>
352           <td class="paramkey"></td>
353           <td></td>
354           <td class="paramtype">uint&#160;</td>
355           <td class="paramname"><em>in_stride_y</em>, </td>
356         </tr>
357         <tr>
358           <td class="paramkey"></td>
359           <td></td>
360           <td class="paramtype">uint&#160;</td>
361           <td class="paramname"><em>in_step_y</em>, </td>
362         </tr>
363         <tr>
364           <td class="paramkey"></td>
365           <td></td>
366           <td class="paramtype">uint&#160;</td>
367           <td class="paramname"><em>in_offset_first_element_in_bytes</em>, </td>
368         </tr>
369         <tr>
370           <td class="paramkey"></td>
371           <td></td>
372           <td class="paramtype">__global uchar *&#160;</td>
373           <td class="paramname"><em>out_ptr</em>, </td>
374         </tr>
375         <tr>
376           <td class="paramkey"></td>
377           <td></td>
378           <td class="paramtype">uint&#160;</td>
379           <td class="paramname"><em>out_stride_x</em>, </td>
380         </tr>
381         <tr>
382           <td class="paramkey"></td>
383           <td></td>
384           <td class="paramtype">uint&#160;</td>
385           <td class="paramname"><em>out_step_x</em>, </td>
386         </tr>
387         <tr>
388           <td class="paramkey"></td>
389           <td></td>
390           <td class="paramtype">uint&#160;</td>
391           <td class="paramname"><em>out_stride_y</em>, </td>
392         </tr>
393         <tr>
394           <td class="paramkey"></td>
395           <td></td>
396           <td class="paramtype">uint&#160;</td>
397           <td class="paramname"><em>out_step_y</em>, </td>
398         </tr>
399         <tr>
400           <td class="paramkey"></td>
401           <td></td>
402           <td class="paramtype">uint&#160;</td>
403           <td class="paramname"><em>out_offset_first_element_in_bytes</em>, </td>
404         </tr>
405         <tr>
406           <td class="paramkey"></td>
407           <td></td>
408           <td class="paramtype">const int&#160;</td>
409           <td class="paramname"><em>shift</em>&#160;</td>
410         </tr>
411         <tr>
412           <td></td>
413           <td>)</td>
414           <td></td><td></td>
415         </tr>
416       </table>
417 </div><div class="memdoc">
418
419 <p>This function performs a up-scaling depth conversion. </p>
420 <dl class="section attention"><dt>Attention</dt><dd>The input and output data_types need to be passed at compile time using -DDATA_TYPE_IN and -DDATA_TYPE_OUT: e.g. -DDATA_TYPE_IN=uchar -DDATA_TYPE_OUT=short</dd></dl>
421 <dl class="section note"><dt>Note</dt><dd>In case of fixed-point operation -DFIXED_POINT_POSITION=fixed_point_position must be provided: e.g. -DFIXED_POINT_POSITION=3</dd></dl>
422 <dl class="params"><dt>Parameters</dt><dd>
423   <table class="params">
424     <tr><td class="paramdir">[in]</td><td class="paramname">in_ptr</td><td>Pointer to the source image. Supported data types: U8, QS8, U16, S16, QS16, U32 or S32 </td></tr>
425     <tr><td class="paramdir">[in]</td><td class="paramname">in_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
426     <tr><td class="paramdir">[in]</td><td class="paramname">in_step_x</td><td>in_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
427     <tr><td class="paramdir">[in]</td><td class="paramname">in_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
428     <tr><td class="paramdir">[in]</td><td class="paramname">in_step_y</td><td>in_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
429     <tr><td class="paramdir">[in]</td><td class="paramname">in_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
430     <tr><td class="paramdir">[out]</td><td class="paramname">out_ptr</td><td>Pointer to the destination image. Supported data types: U8, U16, S16, U32, S32, F16 or F32 </td></tr>
431     <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
432     <tr><td class="paramdir">[in]</td><td class="paramname">out_step_x</td><td>out_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
433     <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
434     <tr><td class="paramdir">[in]</td><td class="paramname">out_step_y</td><td>out_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
435     <tr><td class="paramdir">[in]</td><td class="paramname">out_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
436     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>The integer shift amount value. Supported data types: S32 </td></tr>
437   </table>
438   </dd>
439 </dl>
440
441 <p>Definition at line <a class="el" href="depth__convert_8cl_source.xhtml#l00115">115</a> of file <a class="el" href="depth__convert_8cl_source.xhtml">depth_convert.cl</a>.</p>
442
443 <p>References <a class="el" href="helpers_8h_source.xhtml#l00102">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="depth__convert_8cl_source.xhtml#l00049">CONVERT_UP</a>, <a class="el" href="convolution3x3_8cl_source.xhtml#l00031">DATA_TYPE_OUT</a>, <a class="el" href="helpers_8h_source.xhtml#l00142">Image::ptr</a>, and <a class="el" href="fixed__point_8h_source.xhtml#l00093">VEC_DATA_TYPE</a>.</p>
444 <div class="fragment"><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;{</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> in  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(in);</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> out = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(out);</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_IN, 16)</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    in_data = vload16(0, (__global DATA_TYPE_IN *)in.ptr);</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="preprocessor">#if defined(FIXED_POINT_POSITION)</span></div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    vstore16(<a class="code" href="depth__convert_8cl.xhtml#a9bed30cda5ab157322d2f0bbdff46d28">CONVERT_UP</a>(in_data, <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_IN, 16), <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16), FIXED_POINT_POSITION), 0, (__global <a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a> *)out.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#else  </span><span class="comment">/* FIXED_POINT_POSITION */</span><span class="preprocessor"></span></div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    vstore16(<a class="code" href="depth__convert_8cl.xhtml#a9bed30cda5ab157322d2f0bbdff46d28">CONVERT_UP</a>(in_data, <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16)) &lt;&lt; shift, 0, (__global <a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a> *)out.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FIXED_POINT_POSITION */</span><span class="preprocessor"></span></div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;}</div><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#l00102">helpers.h:102</a></div></div>
445 <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#l00140">helpers.h:140</a></div></div>
446 <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#l00142">helpers.h:142</a></div></div>
447 <div class="ttc" id="fixed__point_8h_xhtml_a36f754c05b6fddf6df0d8d0a74f8159f"><div class="ttname"><a href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a></div><div class="ttdeci">#define VEC_DATA_TYPE(type, size)</div><div class="ttdef"><b>Definition:</b> <a href="fixed__point_8h_source.xhtml#l00093">fixed_point.h:93</a></div></div>
448 <div class="ttc" id="convolution3x3_8cl_xhtml_ac06f3e24d3fffd3c465d8b2a6e7c985e"><div class="ttname"><a href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a></div><div class="ttdeci">#define DATA_TYPE_OUT</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00031">convolution3x3.cl:31</a></div></div>
449 <div class="ttc" id="depth__convert_8cl_xhtml_a9bed30cda5ab157322d2f0bbdff46d28"><div class="ttname"><a href="depth__convert_8cl.xhtml#a9bed30cda5ab157322d2f0bbdff46d28">CONVERT_UP</a></div><div class="ttdeci">#define CONVERT_UP(x, type)</div><div class="ttdef"><b>Definition:</b> <a href="depth__convert_8cl_source.xhtml#l00049">depth_convert.cl:49</a></div></div>
450 </div><!-- fragment -->
451 </div>
452 </div>
453 </div><!-- contents -->
454 </div><!-- doc-content -->
455 <!-- start footer part -->
456 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
457   <ul>
458     <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="depth__convert_8cl.xhtml">depth_convert.cl</a></li>
459     <li class="footer">Generated on Thu Feb 22 2018 15:45:22 for Compute Library by
460     <a href="http://www.doxygen.org/index.html">
461     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
462   </ul>
463 </div>
464 </body>
465 </html>