arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_canny_edge.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>ARM Compute Library: NECannyEdge Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_canny_edge.xhtml','');});
100 </script>
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104      onmouseover="return searchBox.OnSearchSelectShow()"
105      onmouseout="return searchBox.OnSearchSelectHide()"
106      onkeydown="return searchBox.OnSearchSelectKey(event)">
107 </div>
108
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0" 
112         name="MSearchResults" id="MSearchResults">
113 </iframe>
114 </div>
115
116 <div class="header">
117   <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a>  </div>
119   <div class="headertitle">
120 <div class="title">NECannyEdge Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>Basic function to execute canny edge on NEON.  
125  <a href="classarm__compute_1_1_n_e_canny_edge.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_n_e_canny_edge_8h_source.xhtml">NECannyEdge.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for NECannyEdge:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_canny_edge__coll__graph.svg" width="120" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
132 </div>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:ae42141847e0a4f706223a1f71d435451"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml#ae42141847e0a4f706223a1f71d435451">NECannyEdge</a> ()</td></tr>
138 <tr class="memdesc:ae42141847e0a4f706223a1f71d435451"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ae42141847e0a4f706223a1f71d435451">More...</a><br /></td></tr>
139 <tr class="separator:ae42141847e0a4f706223a1f71d435451"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a168eb5b6fa7992e8a6eea6d665f1c006"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml#a168eb5b6fa7992e8a6eea6d665f1c006">NECannyEdge</a> (const <a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a168eb5b6fa7992e8a6eea6d665f1c006"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a168eb5b6fa7992e8a6eea6d665f1c006">More...</a><br /></td></tr>
142 <tr class="separator:a168eb5b6fa7992e8a6eea6d665f1c006"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a325fac2836aecb2da2f86b7699e2b359"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml#a325fac2836aecb2da2f86b7699e2b359">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a325fac2836aecb2da2f86b7699e2b359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a325fac2836aecb2da2f86b7699e2b359">More...</a><br /></td></tr>
145 <tr class="separator:a325fac2836aecb2da2f86b7699e2b359"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a9222c1af43116f31809789741c6adef0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml#a9222c1af43116f31809789741c6adef0">configure</a> (<a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, int32_t upper_thr, int32_t lower_thr, int32_t gradient_size, int32_t norm_type, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value=0, bool use_fp16=false)</td></tr>
147 <tr class="memdesc:a9222c1af43116f31809789741c6adef0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the function's source, destination, thresholds, gradient size, normalization type and border mode.  <a href="#a9222c1af43116f31809789741c6adef0">More...</a><br /></td></tr>
148 <tr class="separator:a9222c1af43116f31809789741c6adef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
150 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
151 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
153 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
154 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
155 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 </table>
157 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
158 <div class="textblock"><p>Basic function to execute canny edge on NEON. </p>
159 <p>This function calls the following NEON kernels and functions:</p>
160 <ol type="1">
161 <li><a class="el" href="classarm__compute_1_1_n_e_fill_border_kernel.xhtml">NEFillBorderKernel</a> (if border_mode == REPLICATE or border_mode == CONSTANT)</li>
162 <li><a class="el" href="classarm__compute_1_1_n_e_sobel3x3.xhtml">NESobel3x3</a> (if gradient_size == 3) or <a class="el" href="classarm__compute_1_1_n_e_sobel5x5.xhtml">NESobel5x5</a> (if gradient_size == 5) or <a class="el" href="classarm__compute_1_1_n_e_sobel7x7.xhtml">NESobel7x7</a> (if gradient_size == 7)</li>
163 <li><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a></li>
164 <li><a class="el" href="classarm__compute_1_1_n_e_edge_non_max_suppression_kernel.xhtml">NEEdgeNonMaxSuppressionKernel</a></li>
165 <li><a class="el" href="classarm__compute_1_1_n_e_edge_trace_kernel.xhtml">NEEdgeTraceKernel</a> </li>
166 </ol>
167
168 <p>Definition at line <a class="el" href="_n_e_canny_edge_8h_source.xhtml#l00051">51</a> of file <a class="el" href="_n_e_canny_edge_8h_source.xhtml">NECannyEdge.h</a>.</p>
169 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
170 <a class="anchor" id="ae42141847e0a4f706223a1f71d435451"></a>
171 <div class="memitem">
172 <div class="memproto">
173       <table class="memname">
174         <tr>
175           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> </td>
176           <td>(</td>
177           <td class="paramname"></td><td>)</td>
178           <td></td>
179         </tr>
180       </table>
181 </div><div class="memdoc">
182
183 <p>Constructor. </p>
184 <p>Initialize Sobel kernel to nullptr. </p>
185
186 </div>
187 </div>
188 <a class="anchor" id="a168eb5b6fa7992e8a6eea6d665f1c006"></a>
189 <div class="memitem">
190 <div class="memproto">
191 <table class="mlabels">
192   <tr>
193   <td class="mlabels-left">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> </td>
197           <td>(</td>
198           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> &amp;&#160;</td>
199           <td class="paramname"></td><td>)</td>
200           <td></td>
201         </tr>
202       </table>
203   </td>
204   <td class="mlabels-right">
205 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
206   </tr>
207 </table>
208 </div><div class="memdoc">
209
210 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
211
212 </div>
213 </div>
214 <h2 class="groupheader">Member Function Documentation</h2>
215 <a class="anchor" id="a9222c1af43116f31809789741c6adef0"></a>
216 <div class="memitem">
217 <div class="memproto">
218       <table class="memname">
219         <tr>
220           <td class="memname">void configure </td>
221           <td>(</td>
222           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
223           <td class="paramname"><em>input</em>, </td>
224         </tr>
225         <tr>
226           <td class="paramkey"></td>
227           <td></td>
228           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
229           <td class="paramname"><em>output</em>, </td>
230         </tr>
231         <tr>
232           <td class="paramkey"></td>
233           <td></td>
234           <td class="paramtype">int32_t&#160;</td>
235           <td class="paramname"><em>upper_thr</em>, </td>
236         </tr>
237         <tr>
238           <td class="paramkey"></td>
239           <td></td>
240           <td class="paramtype">int32_t&#160;</td>
241           <td class="paramname"><em>lower_thr</em>, </td>
242         </tr>
243         <tr>
244           <td class="paramkey"></td>
245           <td></td>
246           <td class="paramtype">int32_t&#160;</td>
247           <td class="paramname"><em>gradient_size</em>, </td>
248         </tr>
249         <tr>
250           <td class="paramkey"></td>
251           <td></td>
252           <td class="paramtype">int32_t&#160;</td>
253           <td class="paramname"><em>norm_type</em>, </td>
254         </tr>
255         <tr>
256           <td class="paramkey"></td>
257           <td></td>
258           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a>&#160;</td>
259           <td class="paramname"><em>border_mode</em>, </td>
260         </tr>
261         <tr>
262           <td class="paramkey"></td>
263           <td></td>
264           <td class="paramtype">uint8_t&#160;</td>
265           <td class="paramname"><em>constant_border_value</em> = <code>0</code>, </td>
266         </tr>
267         <tr>
268           <td class="paramkey"></td>
269           <td></td>
270           <td class="paramtype">bool&#160;</td>
271           <td class="paramname"><em>use_fp16</em> = <code>false</code>&#160;</td>
272         </tr>
273         <tr>
274           <td></td>
275           <td>)</td>
276           <td></td><td></td>
277         </tr>
278       </table>
279 </div><div class="memdoc">
280
281 <p>Initialise the function's source, destination, thresholds, gradient size, normalization type and border mode. </p>
282 <dl class="params"><dt>Parameters</dt><dd>
283   <table class="params">
284     <tr><td class="paramdir">[in,out]</td><td class="paramname">input</td><td>Source tensor. Data type supported: U8. (Written to only for <code>border_mode</code> != UNDEFINED) </td></tr>
285     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data type supported: U8. </td></tr>
286     <tr><td class="paramdir">[in]</td><td class="paramname">upper_thr</td><td>Upper threhold used for the hysteresis </td></tr>
287     <tr><td class="paramdir">[in]</td><td class="paramname">lower_thr</td><td>Lower threshold used for the hysteresis. </td></tr>
288     <tr><td class="paramdir">[in]</td><td class="paramname">gradient_size</td><td>Gradient size (3, 5 or 7) </td></tr>
289     <tr><td class="paramdir">[in]</td><td class="paramname">norm_type</td><td>Normalization type. If 1, L1-Norm otherwise L2-Norm </td></tr>
290     <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Border mode to use for the convolution. </td></tr>
291     <tr><td class="paramdir">[in]</td><td class="paramname">constant_border_value</td><td>(Optional) Constant value to use for borders if border_mode is set to CONSTANT. </td></tr>
292     <tr><td class="paramdir">[in]</td><td class="paramname">use_fp16</td><td>(Optional) If true the FP16 kernels will be used. If false F32 kernels are used. </td></tr>
293   </table>
294   </dd>
295 </dl>
296
297 </div>
298 </div>
299 <a class="anchor" id="a325fac2836aecb2da2f86b7699e2b359"></a>
300 <div class="memitem">
301 <div class="memproto">
302 <table class="mlabels">
303   <tr>
304   <td class="mlabels-left">
305       <table class="memname">
306         <tr>
307           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a>&amp; operator= </td>
308           <td>(</td>
309           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a> &amp;&#160;</td>
310           <td class="paramname"></td><td>)</td>
311           <td></td>
312         </tr>
313       </table>
314   </td>
315   <td class="mlabels-right">
316 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
317   </tr>
318 </table>
319 </div><div class="memdoc">
320
321 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
322
323 </div>
324 </div>
325 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
326 <div class="memitem">
327 <div class="memproto">
328 <table class="mlabels">
329   <tr>
330   <td class="mlabels-left">
331       <table class="memname">
332         <tr>
333           <td class="memname">void run </td>
334           <td>(</td>
335           <td class="paramname"></td><td>)</td>
336           <td></td>
337         </tr>
338       </table>
339   </td>
340   <td class="mlabels-right">
341 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
342   </tr>
343 </table>
344 </div><div class="memdoc">
345
346 <p>Run the kernels contained in the function. </p>
347 <p>For NEON kernels:</p><ul>
348 <li>Multi-threading is used for the kernels which are parallelisable.</li>
349 <li>By default std::thread::hardware_concurrency() threads are used.</li>
350 </ul>
351 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae9dc1846ff1612778bbac85d46344aef">CPPScheduler::force_number_of_threads()</a> can be used to manually set the number of threads</dd></dl>
352 <p>For OpenCL kernels:</p><ul>
353 <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue. ">CLScheduler</a>.</li>
354 <li>The queue is then flushed.</li>
355 </ul>
356 <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd></dl>
357
358 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
359
360 </div>
361 </div>
362 <hr/>The documentation for this class was generated from the following file:<ul>
363 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_canny_edge_8h_source.xhtml">NECannyEdge.h</a></li>
364 </ul>
365 </div><!-- contents -->
366 </div><!-- doc-content -->
367 <!-- start footer part -->
368 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
369   <ul>
370     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_canny_edge.xhtml">NECannyEdge</a></li>
371     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
372     <a href="http://www.doxygen.org/index.html">
373     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
374   </ul>
375 </div>
376 </body>
377 </html>