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>Compute Library: NENonLinearFilter 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">Compute Library
43  <span id="projectnumber">18.05</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="pages.xhtml"><span>Related 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 Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
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>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_non_linear_filter.xhtml','');});
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)">
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">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">NENonLinearFilter Class Reference</div> </div>
123 <div class="contents">
125 <p>Basic function to execute non linear filter.
126 <a href="classarm__compute_1_1_n_e_non_linear_filter.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_n_e_non_linear_filter_8h_source.xhtml">NENonLinearFilter.h</a>></code></p>
129 <div class="dynheader">
130 Collaboration diagram for NENonLinearFilter:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_non_linear_filter__coll__graph.svg" width="151" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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:ae2e668c3765731c5f71a324e15f131b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_non_linear_filter.xhtml#ae2e668c3765731c5f71a324e15f131b8">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, <a class="el" href="namespacearm__compute.xhtml#adf2ced65e536375a1c96425d9fced858">NonLinearFilterFunction</a> function, unsigned int mask_size, <a class="el" href="namespacearm__compute.xhtml#afdda916edc7502967bbec17ea3c06c02">MatrixPattern</a> pattern, const uint8_t *mask, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value=0)</td></tr>
139 <tr class="memdesc:ae2e668c3765731c5f71a324e15f131b8"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the function's source, destination, conv and border_mode. <a href="#ae2e668c3765731c5f71a324e15f131b8">More...</a><br /></td></tr>
140 <tr class="separator:ae2e668c3765731c5f71a324e15f131b8"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_n_e_simple_function')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_n_e_simple_function.xhtml">INESimpleFunction</a></td></tr>
142 <tr class="memitem:a4a6528d71f063140db37cdf5cf272960 inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_n_e_simple_function.xhtml#a4a6528d71f063140db37cdf5cf272960">INESimpleFunction</a> ()</td></tr>
143 <tr class="memdesc:a4a6528d71f063140db37cdf5cf272960 inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a4a6528d71f063140db37cdf5cf272960">More...</a><br /></td></tr>
144 <tr class="separator:a4a6528d71f063140db37cdf5cf272960 inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memSeparator" colspan="2"> </td></tr>
145 <tr class="memitem:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_n_e_simple_function.xhtml#ab5fd6e96c07aaaed2747c7e16ed5951e">run</a> () overridefinal</td></tr>
146 <tr class="memdesc:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="mdescLeft"> </td><td class="mdescRight">Run the kernels contained in the function. <a href="#ab5fd6e96c07aaaed2747c7e16ed5951e">More...</a><br /></td></tr>
147 <tr class="separator:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memSeparator" colspan="2"> </td></tr>
148 <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>
149 <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>
150 <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>
151 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26">prepare</a> ()</td></tr>
153 <tr class="memdesc:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft"> </td><td class="mdescRight">Prepare the function for executing. <a href="#a820f7291c24155a2980512fae45aac26">More...</a><br /></td></tr>
154 <tr class="separator:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
157 <div class="textblock"><p>Basic function to execute non linear filter. </p>
158 <p>This function calls the following NEON kernels:</p>
160 <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>
161 <li><a class="el" href="classarm__compute_1_1_n_e_non_linear_filter_kernel.xhtml">NENonLinearFilterKernel</a></li>
163 <dl class="section note"><dt>Note</dt><dd>Supported mask dimensions squares of sizes 3, 5 </dd></dl>
165 <p>Definition at line <a class="el" href="_n_e_non_linear_filter_8h_source.xhtml#l00043">43</a> of file <a class="el" href="_n_e_non_linear_filter_8h_source.xhtml">NENonLinearFilter.h</a>.</p>
166 </div><h2 class="groupheader">Member Function Documentation</h2>
167 <a class="anchor" id="ae2e668c3765731c5f71a324e15f131b8"></a>
168 <div class="memitem">
169 <div class="memproto">
170 <table class="memname">
172 <td class="memname">void configure </td>
174 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
175 <td class="paramname"><em>input</em>, </td>
178 <td class="paramkey"></td>
180 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
181 <td class="paramname"><em>output</em>, </td>
184 <td class="paramkey"></td>
186 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#adf2ced65e536375a1c96425d9fced858">NonLinearFilterFunction</a> </td>
187 <td class="paramname"><em>function</em>, </td>
190 <td class="paramkey"></td>
192 <td class="paramtype">unsigned int </td>
193 <td class="paramname"><em>mask_size</em>, </td>
196 <td class="paramkey"></td>
198 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#afdda916edc7502967bbec17ea3c06c02">MatrixPattern</a> </td>
199 <td class="paramname"><em>pattern</em>, </td>
202 <td class="paramkey"></td>
204 <td class="paramtype">const uint8_t * </td>
205 <td class="paramname"><em>mask</em>, </td>
208 <td class="paramkey"></td>
210 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> </td>
211 <td class="paramname"><em>border_mode</em>, </td>
214 <td class="paramkey"></td>
216 <td class="paramtype">uint8_t </td>
217 <td class="paramname"><em>constant_border_value</em> = <code>0</code> </td>
225 </div><div class="memdoc">
227 <p>Initialize the function's source, destination, conv and border_mode. </p>
228 <dl class="params"><dt>Parameters</dt><dd>
229 <table class="params">
230 <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>
231 <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data type supported: U8 </td></tr>
232 <tr><td class="paramdir">[in]</td><td class="paramname">function</td><td>Non linear function to perform </td></tr>
233 <tr><td class="paramdir">[in]</td><td class="paramname">mask_size</td><td>Mask size. Supported sizes: 3, 5 </td></tr>
234 <tr><td class="paramdir">[in]</td><td class="paramname">pattern</td><td>Mask pattern </td></tr>
235 <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>The given mask. Will be used only if pattern is specified to PATTERN_OTHER </td></tr>
236 <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Strategy to use for borders. </td></tr>
237 <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>
244 <hr/>The documentation for this class was generated from the following file:<ul>
245 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_non_linear_filter_8h_source.xhtml">NENonLinearFilter.h</a></li>
247 </div><!-- contents -->
248 </div><!-- doc-content -->
249 <!-- start footer part -->
250 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
252 <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_non_linear_filter.xhtml">NENonLinearFilter</a></li>
253 <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
254 <a href="http://www.doxygen.org/index.html">
255 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>