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">
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: NEGaussianPyramidOrb 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.03.1</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main 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 Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_gaussian_pyramid_orb.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">NEGaussianPyramidOrb Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic function to execute gaussian pyramid with ORB scale factor.
125 <a href="classarm__compute_1_1_n_e_gaussian_pyramid_orb.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_n_e_gaussian_pyramid_8h_source.xhtml">NEGaussianPyramid.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEGaussianPyramidOrb:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_gaussian_pyramid_orb__coll__graph.svg" width="176" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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:a944408035fc5125bab445b8241abcd90"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid_orb.xhtml#a944408035fc5125bab445b8241abcd90">NEGaussianPyramidOrb</a> ()</td></tr>
138 <tr class="memdesc:a944408035fc5125bab445b8241abcd90"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a944408035fc5125bab445b8241abcd90">More...</a><br /></td></tr>
139 <tr class="separator:a944408035fc5125bab445b8241abcd90"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a7983aea517b8777e7ef6800cfa41d6ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid_orb.xhtml#a7983aea517b8777e7ef6800cfa41d6ab">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_pyramid.xhtml">IPyramid</a> *pyramid, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value) override</td></tr>
141 <tr class="memdesc:a7983aea517b8777e7ef6800cfa41d6ab"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the function's source, destinations and border mode. <a href="#a7983aea517b8777e7ef6800cfa41d6ab">More...</a><br /></td></tr>
142 <tr class="separator:a7983aea517b8777e7ef6800cfa41d6ab"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid_orb.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
144 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft"> </td><td class="mdescRight">Run the kernels contained in the function. <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
145 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="inherit_header pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml">NEGaussianPyramid</a></td></tr>
147 <tr class="memitem:adf74ce175214d5cdbc645c05fb31b21b inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml#adf74ce175214d5cdbc645c05fb31b21b">NEGaussianPyramid</a> ()</td></tr>
148 <tr class="memdesc:adf74ce175214d5cdbc645c05fb31b21b inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#adf74ce175214d5cdbc645c05fb31b21b">More...</a><br /></td></tr>
149 <tr class="separator:adf74ce175214d5cdbc645c05fb31b21b inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:a676cea2aa477b7ec444b4c884e1465aa inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml#a676cea2aa477b7ec444b4c884e1465aa">NEGaussianPyramid</a> (const <a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml">NEGaussianPyramid</a> &)=delete</td></tr>
151 <tr class="memdesc:a676cea2aa477b7ec444b4c884e1465aa inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers) <a href="#a676cea2aa477b7ec444b4c884e1465aa">More...</a><br /></td></tr>
152 <tr class="separator:a676cea2aa477b7ec444b4c884e1465aa inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:a097e83a75f775a2d592e9779c372c2c2 inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml">NEGaussianPyramid</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml#a097e83a75f775a2d592e9779c372c2c2">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml">NEGaussianPyramid</a> &)=delete</td></tr>
154 <tr class="memdesc:a097e83a75f775a2d592e9779c372c2c2 inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers) <a href="#a097e83a75f775a2d592e9779c372c2c2">More...</a><br /></td></tr>
155 <tr class="separator:a097e83a75f775a2d592e9779c372c2c2 inherit pub_methods_classarm__compute_1_1_n_e_gaussian_pyramid"><td class="memSeparator" colspan="2"> </td></tr>
156 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
157 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
158 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
159 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
161 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
162 <div class="textblock"><p>Basic function to execute gaussian pyramid with ORB scale factor. </p>
163 <p>This function calls the following NEON kernels and functions:</p>
165 <li><a class="el" href="classarm__compute_1_1_n_e_fill_border_kernel.xhtml">NEFillBorderKernel</a> (executed if border_mode == CONSTANT or border_mode == REPLICATE)</li>
166 <li><a class="el" href="classarm__compute_1_1_n_e_gaussian5x5.xhtml">NEGaussian5x5</a></li>
167 <li><a class="el" href="classarm__compute_1_1_n_e_scale_kernel.xhtml">NEScaleKernel</a> </li>
170 <p>Definition at line <a class="el" href="_n_e_gaussian_pyramid_8h_source.xhtml#l00099">99</a> of file <a class="el" href="_n_e_gaussian_pyramid_8h_source.xhtml">NEGaussianPyramid.h</a>.</p>
171 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
172 <a class="anchor" id="a944408035fc5125bab445b8241abcd90"></a>
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
177 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid_orb.xhtml">NEGaussianPyramidOrb</a> </td>
179 <td class="paramname"></td><td>)</td>
183 </div><div class="memdoc">
189 <h2 class="groupheader">Member Function Documentation</h2>
190 <a class="anchor" id="a7983aea517b8777e7ef6800cfa41d6ab"></a>
191 <div class="memitem">
192 <div class="memproto">
193 <table class="mlabels">
195 <td class="mlabels-left">
196 <table class="memname">
198 <td class="memname">void configure </td>
200 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
201 <td class="paramname"><em>input</em>, </td>
204 <td class="paramkey"></td>
206 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_pyramid.xhtml">IPyramid</a> * </td>
207 <td class="paramname"><em>pyramid</em>, </td>
210 <td class="paramkey"></td>
212 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> </td>
213 <td class="paramname"><em>border_mode</em>, </td>
216 <td class="paramkey"></td>
218 <td class="paramtype">uint8_t </td>
219 <td class="paramname"><em>constant_border_value</em> </td>
228 <td class="mlabels-right">
229 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
232 </div><div class="memdoc">
234 <p>Initialise the function's source, destinations and border mode. </p>
235 <dl class="params"><dt>Parameters</dt><dd>
236 <table class="params">
237 <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data type supported: U8. </td></tr>
238 <tr><td class="paramdir">[out]</td><td class="paramname">pyramid</td><td>Destination pyramid tensors, Data type supported at each level: U8. </td></tr>
239 <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Border mode to use. </td></tr>
240 <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>
245 <p>Implements <a class="el" href="classarm__compute_1_1_n_e_gaussian_pyramid.xhtml#a569064c220a3a2bf4b7af719b8d54cba">NEGaussianPyramid</a>.</p>
249 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
250 <div class="memitem">
251 <div class="memproto">
252 <table class="mlabels">
254 <td class="mlabels-left">
255 <table class="memname">
257 <td class="memname">void run </td>
259 <td class="paramname"></td><td>)</td>
264 <td class="mlabels-right">
265 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
268 </div><div class="memdoc">
270 <p>Run the kernels contained in the function. </p>
271 <p>For NEON kernels:</p><ul>
272 <li>Multi-threading is used for the kernels which are parallelisable.</li>
273 <li>By default std::thread::hardware_concurrency() threads are used.</li>
275 <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>
276 <p>For OpenCL kernels:</p><ul>
277 <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>
278 <li>The queue is then flushed.</li>
280 <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>
282 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
286 <hr/>The documentation for this class was generated from the following file:<ul>
287 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_gaussian_pyramid_8h_source.xhtml">NEGaussianPyramid.h</a></li>
289 </div><!-- contents -->
290 </div><!-- doc-content -->
291 <!-- start footer part -->
292 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
294 <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_gaussian_pyramid_orb.xhtml">NEGaussianPyramidOrb</a></li>
295 <li class="footer">Generated on Fri Mar 24 2017 17:23:51 for ARM Compute Library by
296 <a href="http://www.doxygen.org/index.html">
297 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>