arm_compute v18.05
[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>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">Compute Library
43    &#160;<span id="projectnumber">18.05</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 class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><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="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_gradient_kernel.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">NEGradientKernel Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Computes magnitude and quantised phase from inputs gradients.  
126  <a href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml">NECannyEdgeKernel.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for NEGradientKernel:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_gradient_kernel__coll__graph.svg" width="146" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 </div>
134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
137 Public Member Functions</h2></td></tr>
138 <tr class="memitem:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
139 <tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the kernel.  <a href="#ab5656bb5b6334bdbe6e606c715872828">More...</a><br /></td></tr>
140 <tr class="separator:ab5656bb5b6334bdbe6e606c715872828"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <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>
142 <tr class="memdesc:a7da52d0627026b852dc51dbab82a978b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a7da52d0627026b852dc51dbab82a978b">More...</a><br /></td></tr>
143 <tr class="separator:a7da52d0627026b852dc51dbab82a978b"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <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>
145 <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>
146 <tr class="separator:ad383dd933d1927d688347f6f412dfc21"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <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>
148 <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>
149 <tr class="separator:ac9fb1a343e29082ecd7ffaa0216dcd35"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <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>
151 <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>
152 <tr class="separator:a5abcaf3e9545a325505641d321a858c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <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>
154 <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>
155 <tr class="separator:a77d401f1799eff9f50baca598c912801"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <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>
157 <tr class="memdesc:aec72e1144d2cb538834aa369232de727"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#aec72e1144d2cb538834aa369232de727">More...</a><br /></td></tr>
158 <tr class="separator:aec72e1144d2cb538834aa369232de727"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <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>
160 <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>
161 <tr class="separator:a49306e1c9421979fc704f3c96096ce8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><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#a112b35dd205c62ea6ed1447ef226da82">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>, const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;info) override</td></tr>
163 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a112b35dd205c62ea6ed1447ef226da82">More...</a><br /></td></tr>
164 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <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>
166 <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>
167 <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>
168 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <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>
170 <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>
171 <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>
172 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <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>
174 <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>
175 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <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>
177 <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>
178 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 <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>
180 <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>
181 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <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>
183 <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>
184 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
185 </table>
186 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
187 <div class="textblock"><p>Computes magnitude and quantised phase from inputs gradients. </p>
188
189 <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>
190 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
191 <a class="anchor" id="a7da52d0627026b852dc51dbab82a978b"></a>
192 <div class="memitem">
193 <div class="memproto">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
197           <td>(</td>
198           <td class="paramname"></td><td>)</td>
199           <td></td>
200         </tr>
201       </table>
202 </div><div class="memdoc">
203
204 <p>Default constructor. </p>
205
206 <p>Referenced by <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00039">NEGradientKernel::name()</a>.</p>
207
208 </div>
209 </div>
210 <a class="anchor" id="ad383dd933d1927d688347f6f412dfc21"></a>
211 <div class="memitem">
212 <div class="memproto">
213 <table class="mlabels">
214   <tr>
215   <td class="mlabels-left">
216       <table class="memname">
217         <tr>
218           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
219           <td>(</td>
220           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&#160;</td>
221           <td class="paramname"></td><td>)</td>
222           <td></td>
223         </tr>
224       </table>
225   </td>
226   <td class="mlabels-right">
227 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
228   </tr>
229 </table>
230 </div><div class="memdoc">
231
232 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
233
234 </div>
235 </div>
236 <a class="anchor" id="a5abcaf3e9545a325505641d321a858c9"></a>
237 <div class="memitem">
238 <div class="memproto">
239 <table class="mlabels">
240   <tr>
241   <td class="mlabels-left">
242       <table class="memname">
243         <tr>
244           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
245           <td>(</td>
246           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&amp;&#160;</td>
247           <td class="paramname"></td><td>)</td>
248           <td></td>
249         </tr>
250       </table>
251   </td>
252   <td class="mlabels-right">
253 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
254   </tr>
255 </table>
256 </div><div class="memdoc">
257
258 <p>Allow instances of this class to be moved. </p>
259
260 </div>
261 </div>
262 <a class="anchor" id="aec72e1144d2cb538834aa369232de727"></a>
263 <div class="memitem">
264 <div class="memproto">
265 <table class="mlabels">
266   <tr>
267   <td class="mlabels-left">
268       <table class="memname">
269         <tr>
270           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> </td>
271           <td>(</td>
272           <td class="paramname"></td><td>)</td>
273           <td></td>
274         </tr>
275       </table>
276   </td>
277   <td class="mlabels-right">
278 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
279   </tr>
280 </table>
281 </div><div class="memdoc">
282
283 <p>Default destructor. </p>
284
285 <p>Referenced by <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00039">NEGradientKernel::name()</a>.</p>
286
287 </div>
288 </div>
289 <h2 class="groupheader">Member Function Documentation</h2>
290 <a class="anchor" id="a49306e1c9421979fc704f3c96096ce8e"></a>
291 <div class="memitem">
292 <div class="memproto">
293 <table class="mlabels">
294   <tr>
295   <td class="mlabels-left">
296       <table class="memname">
297         <tr>
298           <td class="memname">virtual void configure </td>
299           <td>(</td>
300           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
301           <td class="paramname"><em>gx</em>, </td>
302         </tr>
303         <tr>
304           <td class="paramkey"></td>
305           <td></td>
306           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
307           <td class="paramname"><em>gy</em>, </td>
308         </tr>
309         <tr>
310           <td class="paramkey"></td>
311           <td></td>
312           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
313           <td class="paramname"><em>magnitude</em>, </td>
314         </tr>
315         <tr>
316           <td class="paramkey"></td>
317           <td></td>
318           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
319           <td class="paramname"><em>phase</em>, </td>
320         </tr>
321         <tr>
322           <td class="paramkey"></td>
323           <td></td>
324           <td class="paramtype">int32_t&#160;</td>
325           <td class="paramname"><em>norm_type</em>&#160;</td>
326         </tr>
327         <tr>
328           <td></td>
329           <td>)</td>
330           <td></td><td></td>
331         </tr>
332       </table>
333   </td>
334   <td class="mlabels-right">
335 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
336   </tr>
337 </table>
338 </div><div class="memdoc">
339
340 <p>Initialise the kernel's sources, destinations and border mode. </p>
341 <dl class="section note"><dt>Note</dt><dd>gx, gy and magnitude must all be the same size (either 16 or 32)</dd></dl>
342 <dl class="params"><dt>Parameters</dt><dd>
343   <table class="params">
344     <tr><td class="paramdir">[in]</td><td class="paramname">gx</td><td>Source tensor - Gx component. Data type supported: S16/S32. </td></tr>
345     <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>
346     <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>
347     <tr><td class="paramdir">[out]</td><td class="paramname">phase</td><td>Destination tensor - Quantized phase. Data type supported: U8. </td></tr>
348     <tr><td class="paramdir">[in]</td><td class="paramname">norm_type</td><td>Normalization type. If 1, L1-Norm otherwise L2-Norm </td></tr>
349   </table>
350   </dd>
351 </dl>
352
353 <p>Referenced by <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00039">NEGradientKernel::name()</a>, <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00116">NEEdgeNonMaxSuppressionKernel::name()</a>, and <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00173">NEEdgeTraceKernel::name()</a>.</p>
354
355 </div>
356 </div>
357 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
358 <div class="memitem">
359 <div class="memproto">
360 <table class="mlabels">
361   <tr>
362   <td class="mlabels-left">
363       <table class="memname">
364         <tr>
365           <td class="memname">const char* name </td>
366           <td>(</td>
367           <td class="paramname"></td><td>)</td>
368           <td> const</td>
369         </tr>
370       </table>
371   </td>
372   <td class="mlabels-right">
373 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
374   </tr>
375 </table>
376 </div><div class="memdoc">
377
378 <p>Name of the kernel. </p>
379 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name </dd></dl>
380
381 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
382
383 <p>Definition at line <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml">NECannyEdgeKernel.h</a>.</p>
384
385 <p>References <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a49306e1c9421979fc704f3c96096ce8e">NEGradientKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="validation_2reference_2_magnitude_8cpp_source.xhtml#l00035">arm_compute::test::validation::reference::magnitude()</a>, <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a7da52d0627026b852dc51dbab82a978b">NEGradientKernel::NEGradientKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#ac9fb1a343e29082ecd7ffaa0216dcd35">NEGradientKernel::operator=()</a>, <a class="el" href="validation_2reference_2_phase_8cpp_source.xhtml#l00035">arm_compute::test::validation::reference::phase()</a>, <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEGradientKernel::run()</a>, <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>, and <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml#aec72e1144d2cb538834aa369232de727">NEGradientKernel::~NEGradientKernel()</a>.</p>
386 <div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    {</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEGradientKernel&quot;</span>;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    }</div></div><!-- fragment -->
387 </div>
388 </div>
389 <a class="anchor" id="ac9fb1a343e29082ecd7ffaa0216dcd35"></a>
390 <div class="memitem">
391 <div class="memproto">
392 <table class="mlabels">
393   <tr>
394   <td class="mlabels-left">
395       <table class="memname">
396         <tr>
397           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a>&amp; operator= </td>
398           <td>(</td>
399           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&#160;</td>
400           <td class="paramname"></td><td>)</td>
401           <td></td>
402         </tr>
403       </table>
404   </td>
405   <td class="mlabels-right">
406 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
407   </tr>
408 </table>
409 </div><div class="memdoc">
410
411 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
412
413 <p>Referenced by <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00039">NEGradientKernel::name()</a>, <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00116">NEEdgeNonMaxSuppressionKernel::name()</a>, and <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00173">NEEdgeTraceKernel::name()</a>.</p>
414
415 </div>
416 </div>
417 <a class="anchor" id="a77d401f1799eff9f50baca598c912801"></a>
418 <div class="memitem">
419 <div class="memproto">
420 <table class="mlabels">
421   <tr>
422   <td class="mlabels-left">
423       <table class="memname">
424         <tr>
425           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a>&amp; operator= </td>
426           <td>(</td>
427           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_gradient_kernel.xhtml">NEGradientKernel</a> &amp;&amp;&#160;</td>
428           <td class="paramname"></td><td>)</td>
429           <td></td>
430         </tr>
431       </table>
432   </td>
433   <td class="mlabels-right">
434 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
435   </tr>
436 </table>
437 </div><div class="memdoc">
438
439 <p>Allow instances of this class to be moved. </p>
440
441 </div>
442 </div>
443 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
444 <div class="memitem">
445 <div class="memproto">
446 <table class="mlabels">
447   <tr>
448   <td class="mlabels-left">
449       <table class="memname">
450         <tr>
451           <td class="memname">void run </td>
452           <td>(</td>
453           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
454           <td class="paramname"><em>window</em>, </td>
455         </tr>
456         <tr>
457           <td class="paramkey"></td>
458           <td></td>
459           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
460           <td class="paramname"><em>info</em>&#160;</td>
461         </tr>
462         <tr>
463           <td></td>
464           <td>)</td>
465           <td></td><td></td>
466         </tr>
467       </table>
468   </td>
469   <td class="mlabels-right">
470 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
471   </tr>
472 </table>
473 </div><div class="memdoc">
474
475 <p>Execute the kernel on the passed window. </p>
476 <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>
477 <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>
478 <dd>
479 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
480 <dl class="params"><dt>Parameters</dt><dd>
481   <table class="params">
482     <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>
483     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
484   </table>
485   </dd>
486 </dl>
487
488 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
489
490 <p>Referenced by <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00039">NEGradientKernel::name()</a>, <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00116">NEEdgeNonMaxSuppressionKernel::name()</a>, and <a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml#l00173">NEEdgeTraceKernel::name()</a>.</p>
491
492 </div>
493 </div>
494 <hr/>The documentation for this class was generated from the following file:<ul>
495 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_canny_edge_kernel_8h_source.xhtml">NECannyEdgeKernel.h</a></li>
496 </ul>
497 </div><!-- contents -->
498 </div><!-- doc-content -->
499 <!-- start footer part -->
500 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
501   <ul>
502     <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>
503     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
504     <a href="http://www.doxygen.org/index.html">
505     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
506   </ul>
507 </div>
508 </body>
509 </html>