arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_gradient_kernel.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: NEGradientKernel 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_gradient_kernel.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">NEGradientKernel Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>Computes magnitude and quantised phase from inputs gradients.  
125  <a href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml">NECannyEdgeKernel.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEGradientKernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_gradient_kernel__coll__graph.svg" width="138" height="187"><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:a7da52d0627026b852dc51dbab82a978b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a7da52d0627026b852dc51dbab82a978b">NEGradientKernel</a> ()</td></tr>
138 <tr class="memdesc:a7da52d0627026b852dc51dbab82a978b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a7da52d0627026b852dc51dbab82a978b">More...</a><br /></td></tr>
139 <tr class="separator:a7da52d0627026b852dc51dbab82a978b"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:ad383dd933d1927d688347f6f412dfc21"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#ad383dd933d1927d688347f6f412dfc21">NEGradientKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:ad383dd933d1927d688347f6f412dfc21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#ad383dd933d1927d688347f6f412dfc21">More...</a><br /></td></tr>
142 <tr class="separator:ad383dd933d1927d688347f6f412dfc21"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:ac9fb1a343e29082ecd7ffaa0216dcd35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#ac9fb1a343e29082ecd7ffaa0216dcd35">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:ac9fb1a343e29082ecd7ffaa0216dcd35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#ac9fb1a343e29082ecd7ffaa0216dcd35">More...</a><br /></td></tr>
145 <tr class="separator:ac9fb1a343e29082ecd7ffaa0216dcd35"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a5abcaf3e9545a325505641d321a858c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a5abcaf3e9545a325505641d321a858c9">NEGradientKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&amp;)=default</td></tr>
147 <tr class="memdesc:a5abcaf3e9545a325505641d321a858c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a5abcaf3e9545a325505641d321a858c9">More...</a><br /></td></tr>
148 <tr class="separator:a5abcaf3e9545a325505641d321a858c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:a77d401f1799eff9f50baca598c912801"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a77d401f1799eff9f50baca598c912801">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&amp;)=default</td></tr>
150 <tr class="memdesc:a77d401f1799eff9f50baca598c912801"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a77d401f1799eff9f50baca598c912801">More...</a><br /></td></tr>
151 <tr class="separator:a77d401f1799eff9f50baca598c912801"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:aec72e1144d2cb538834aa369232de727"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#aec72e1144d2cb538834aa369232de727">~NEGradientKernel</a> ()=default</td></tr>
153 <tr class="memdesc:aec72e1144d2cb538834aa369232de727"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#aec72e1144d2cb538834aa369232de727">More...</a><br /></td></tr>
154 <tr class="separator:aec72e1144d2cb538834aa369232de727"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a49306e1c9421979fc704f3c96096ce8e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a49306e1c9421979fc704f3c96096ce8e">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *gx, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *gy, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *magnitude, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *phase, int32_t norm_type)</td></tr>
156 <tr class="memdesc:a49306e1c9421979fc704f3c96096ce8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's sources, destinations and border mode.  <a href="#a49306e1c9421979fc704f3c96096ce8e">More...</a><br /></td></tr>
157 <tr class="separator:a49306e1c9421979fc704f3c96096ce8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><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_gradient_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>) override</td></tr>
159 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
160 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
162 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
163 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
164 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
166 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
167 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
168 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
170 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
171 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
173 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
174 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">border_size</a> () const </td></tr>
176 <tr class="memdesc:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#aa6daa9b04e2035bf007e5e5c3c4396a8">More...</a><br /></td></tr>
177 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
179 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
180 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 </table>
182 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
183 <div class="textblock"><p>Computes magnitude and quantised phase from inputs gradients. </p>
184
185 <p>Definition at line <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml">NECannyEdgeKernel.h</a>.</p>
186 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
187 <a class="anchor" id="a7da52d0627026b852dc51dbab82a978b"></a>
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
193           <td>(</td>
194           <td class="paramname"></td><td>)</td>
195           <td></td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <p>Default constructor. </p>
201
202 </div>
203 </div>
204 <a class="anchor" id="ad383dd933d1927d688347f6f412dfc21"></a>
205 <div class="memitem">
206 <div class="memproto">
207 <table class="mlabels">
208   <tr>
209   <td class="mlabels-left">
210       <table class="memname">
211         <tr>
212           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
213           <td>(</td>
214           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&#160;</td>
215           <td class="paramname"></td><td>)</td>
216           <td></td>
217         </tr>
218       </table>
219   </td>
220   <td class="mlabels-right">
221 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
222   </tr>
223 </table>
224 </div><div class="memdoc">
225
226 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
227
228 </div>
229 </div>
230 <a class="anchor" id="a5abcaf3e9545a325505641d321a858c9"></a>
231 <div class="memitem">
232 <div class="memproto">
233 <table class="mlabels">
234   <tr>
235   <td class="mlabels-left">
236       <table class="memname">
237         <tr>
238           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
239           <td>(</td>
240           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&amp;&#160;</td>
241           <td class="paramname"></td><td>)</td>
242           <td></td>
243         </tr>
244       </table>
245   </td>
246   <td class="mlabels-right">
247 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
248   </tr>
249 </table>
250 </div><div class="memdoc">
251
252 <p>Allow instances of this class to be moved. </p>
253
254 </div>
255 </div>
256 <a class="anchor" id="aec72e1144d2cb538834aa369232de727"></a>
257 <div class="memitem">
258 <div class="memproto">
259 <table class="mlabels">
260   <tr>
261   <td class="mlabels-left">
262       <table class="memname">
263         <tr>
264           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
265           <td>(</td>
266           <td class="paramname"></td><td>)</td>
267           <td></td>
268         </tr>
269       </table>
270   </td>
271   <td class="mlabels-right">
272 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
273   </tr>
274 </table>
275 </div><div class="memdoc">
276
277 <p>Default destructor. </p>
278
279 </div>
280 </div>
281 <h2 class="groupheader">Member Function Documentation</h2>
282 <a class="anchor" id="a49306e1c9421979fc704f3c96096ce8e"></a>
283 <div class="memitem">
284 <div class="memproto">
285 <table class="mlabels">
286   <tr>
287   <td class="mlabels-left">
288       <table class="memname">
289         <tr>
290           <td class="memname">virtual void configure </td>
291           <td>(</td>
292           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
293           <td class="paramname"><em>gx</em>, </td>
294         </tr>
295         <tr>
296           <td class="paramkey"></td>
297           <td></td>
298           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
299           <td class="paramname"><em>gy</em>, </td>
300         </tr>
301         <tr>
302           <td class="paramkey"></td>
303           <td></td>
304           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
305           <td class="paramname"><em>magnitude</em>, </td>
306         </tr>
307         <tr>
308           <td class="paramkey"></td>
309           <td></td>
310           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
311           <td class="paramname"><em>phase</em>, </td>
312         </tr>
313         <tr>
314           <td class="paramkey"></td>
315           <td></td>
316           <td class="paramtype">int32_t&#160;</td>
317           <td class="paramname"><em>norm_type</em>&#160;</td>
318         </tr>
319         <tr>
320           <td></td>
321           <td>)</td>
322           <td></td><td></td>
323         </tr>
324       </table>
325   </td>
326   <td class="mlabels-right">
327 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
328   </tr>
329 </table>
330 </div><div class="memdoc">
331
332 <p>Initialise the kernel's sources, destinations and border mode. </p>
333 <dl class="section note"><dt>Note</dt><dd>gx, gy and magnitude must all be the same size (either 16 or 32)</dd></dl>
334 <dl class="params"><dt>Parameters</dt><dd>
335   <table class="params">
336     <tr><td class="paramdir">[in]</td><td class="paramname">gx</td><td>Source tensor - Gx component. Data type supported: S16/S32. </td></tr>
337     <tr><td class="paramdir">[in]</td><td class="paramname">gy</td><td>Source tensor - Gy component. Data type supported: same as <code>gx</code>. </td></tr>
338     <tr><td class="paramdir">[out]</td><td class="paramname">magnitude</td><td>Destination tensor - Magnitude. Data type supported: U16 (if the data type of <code>gx</code> is S16) / U32 (if the data type of <code>gx</code> is S32). </td></tr>
339     <tr><td class="paramdir">[out]</td><td class="paramname">phase</td><td>Destination tensor - Quantized phase. Data type supported: U8. </td></tr>
340     <tr><td class="paramdir">[in]</td><td class="paramname">norm_type</td><td>Normalization type. If 1, L1-Norm otherwise L2-Norm </td></tr>
341   </table>
342   </dd>
343 </dl>
344
345 <p>Reimplemented in <a class="el" href="classarm__compute_1_1_n_e_gradient_f_p16_kernel.xhtml#adb775291de007def514f8c8d368e7448">NEGradientFP16Kernel</a>.</p>
346
347 </div>
348 </div>
349 <a class="anchor" id="ac9fb1a343e29082ecd7ffaa0216dcd35"></a>
350 <div class="memitem">
351 <div class="memproto">
352 <table class="mlabels">
353   <tr>
354   <td class="mlabels-left">
355       <table class="memname">
356         <tr>
357           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a>&amp; operator= </td>
358           <td>(</td>
359           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&#160;</td>
360           <td class="paramname"></td><td>)</td>
361           <td></td>
362         </tr>
363       </table>
364   </td>
365   <td class="mlabels-right">
366 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
367   </tr>
368 </table>
369 </div><div class="memdoc">
370
371 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
372
373 </div>
374 </div>
375 <a class="anchor" id="a77d401f1799eff9f50baca598c912801"></a>
376 <div class="memitem">
377 <div class="memproto">
378 <table class="mlabels">
379   <tr>
380   <td class="mlabels-left">
381       <table class="memname">
382         <tr>
383           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a>&amp; operator= </td>
384           <td>(</td>
385           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&amp;&#160;</td>
386           <td class="paramname"></td><td>)</td>
387           <td></td>
388         </tr>
389       </table>
390   </td>
391   <td class="mlabels-right">
392 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
393   </tr>
394 </table>
395 </div><div class="memdoc">
396
397 <p>Allow instances of this class to be moved. </p>
398
399 </div>
400 </div>
401 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
402 <div class="memitem">
403 <div class="memproto">
404 <table class="mlabels">
405   <tr>
406   <td class="mlabels-left">
407       <table class="memname">
408         <tr>
409           <td class="memname">void run </td>
410           <td>(</td>
411           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
412           <td class="paramname"><em>window</em></td><td>)</td>
413           <td></td>
414         </tr>
415       </table>
416   </td>
417   <td class="mlabels-right">
418 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
419   </tr>
420 </table>
421 </div><div class="memdoc">
422
423 <p>Execute the kernel on the passed window. </p>
424 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
425 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
426 <dd>
427 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
428 <dl class="params"><dt>Parameters</dt><dd>
429   <table class="params">
430     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
431   </table>
432   </dd>
433 </dl>
434
435 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
436
437 </div>
438 </div>
439 <hr/>The documentation for this class was generated from the following file:<ul>
440 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml">NECannyEdgeKernel.h</a></li>
441 </ul>
442 </div><!-- contents -->
443 </div><!-- doc-content -->
444 <!-- start footer part -->
445 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
446   <ul>
447     <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_gradient_kernel.xhtml">NEGradientKernel</a></li>
448     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
449     <a href="http://www.doxygen.org/index.html">
450     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
451   </ul>
452 </div>
453 </body>
454 </html>