arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_mean_std_dev_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: NEMeanStdDevKernel 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_mean_std_dev_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">NEMeanStdDevKernel Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Interface for the kernel to calculate mean and standard deviation of input image pixels.  
126  <a href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml">NEMeanStdDevKernel.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for NEMeanStdDevKernel:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_mean_std_dev_kernel__coll__graph.svg" width="172" 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_mean_std_dev_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:a6a85f552b312ad2560ae02676db95f9e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a6a85f552b312ad2560ae02676db95f9e">NEMeanStdDevKernel</a> ()</td></tr>
142 <tr class="memdesc:a6a85f552b312ad2560ae02676db95f9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a6a85f552b312ad2560ae02676db95f9e">More...</a><br /></td></tr>
143 <tr class="separator:a6a85f552b312ad2560ae02676db95f9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a1a1acc45068c69bc66b6d5d530d7b63f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a1a1acc45068c69bc66b6d5d530d7b63f">NEMeanStdDevKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;)=delete</td></tr>
145 <tr class="memdesc:a1a1acc45068c69bc66b6d5d530d7b63f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a1a1acc45068c69bc66b6d5d530d7b63f">More...</a><br /></td></tr>
146 <tr class="separator:a1a1acc45068c69bc66b6d5d530d7b63f"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a8658dfa985e2cd5805d4756eed25638d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a8658dfa985e2cd5805d4756eed25638d">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;)=delete</td></tr>
148 <tr class="memdesc:a8658dfa985e2cd5805d4756eed25638d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a8658dfa985e2cd5805d4756eed25638d">More...</a><br /></td></tr>
149 <tr class="separator:a8658dfa985e2cd5805d4756eed25638d"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a6d25c4a312717de480c27bdf6c4937ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a6d25c4a312717de480c27bdf6c4937ce">NEMeanStdDevKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;&amp;)=default</td></tr>
151 <tr class="memdesc:a6d25c4a312717de480c27bdf6c4937ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a6d25c4a312717de480c27bdf6c4937ce">More...</a><br /></td></tr>
152 <tr class="separator:a6d25c4a312717de480c27bdf6c4937ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:addfd7a52f0ae7ff3ff637834f4cb977c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#addfd7a52f0ae7ff3ff637834f4cb977c">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;&amp;)=default</td></tr>
154 <tr class="memdesc:addfd7a52f0ae7ff3ff637834f4cb977c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#addfd7a52f0ae7ff3ff637834f4cb977c">More...</a><br /></td></tr>
155 <tr class="separator:addfd7a52f0ae7ff3ff637834f4cb977c"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:ad18b8df3b46973ddb4196f5b31ef5356"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#ad18b8df3b46973ddb4196f5b31ef5356">~NEMeanStdDevKernel</a> ()=default</td></tr>
157 <tr class="memdesc:ad18b8df3b46973ddb4196f5b31ef5356"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#ad18b8df3b46973ddb4196f5b31ef5356">More...</a><br /></td></tr>
158 <tr class="separator:ad18b8df3b46973ddb4196f5b31ef5356"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:a22fb6b7d1bd5ce8a90c61780c94cebbb"><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_mean_std_dev_kernel.xhtml#a22fb6b7d1bd5ce8a90c61780c94cebbb">configure</a> (const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *input, float *mean, uint64_t *global_sum, float *stddev=nullptr, uint64_t *global_sum_squared=nullptr)</td></tr>
160 <tr class="memdesc:a22fb6b7d1bd5ce8a90c61780c94cebbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input and outputs.  <a href="#a22fb6b7d1bd5ce8a90c61780c94cebbb">More...</a><br /></td></tr>
161 <tr class="separator:a22fb6b7d1bd5ce8a90c61780c94cebbb"><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_mean_std_dev_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="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><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_n_e_mean_std_dev_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
166 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
167 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <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>
169 <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>
170 <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>
171 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <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>
173 <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>
174 <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>
175 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <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>
177 <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>
178 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 <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>
180 <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>
181 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a 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>Interface for the kernel to calculate mean and standard deviation of input image pixels. </p>
188
189 <p>Definition at line <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml#l00038">38</a> of file <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml">NEMeanStdDevKernel.h</a>.</p>
190 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
191 <a class="anchor" id="a6a85f552b312ad2560ae02676db95f9e"></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_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</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_mean_std_dev_kernel_8h_source.xhtml#l00041">NEMeanStdDevKernel::name()</a>.</p>
207
208 </div>
209 </div>
210 <a class="anchor" id="a1a1acc45068c69bc66b6d5d530d7b63f"></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_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> </td>
219           <td>(</td>
220           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</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="a6d25c4a312717de480c27bdf6c4937ce"></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_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> </td>
245           <td>(</td>
246           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</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="ad18b8df3b46973ddb4196f5b31ef5356"></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">~<a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</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">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_mean_std_dev_kernel_8h_source.xhtml#l00041">NEMeanStdDevKernel::name()</a>.</p>
286
287 </div>
288 </div>
289 <h2 class="groupheader">Member Function Documentation</h2>
290 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></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"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
299           <td>(</td>
300           <td class="paramname"></td><td>)</td>
301           <td> const</td>
302         </tr>
303       </table>
304   </td>
305   <td class="mlabels-right">
306 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
307   </tr>
308 </table>
309 </div><div class="memdoc">
310
311 <p>The size of the border for that kernel. </p>
312 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
313
314 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
315
316 <p>Referenced by <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml#l00041">NEMeanStdDevKernel::name()</a>.</p>
317
318 </div>
319 </div>
320 <a class="anchor" id="a22fb6b7d1bd5ce8a90c61780c94cebbb"></a>
321 <div class="memitem">
322 <div class="memproto">
323       <table class="memname">
324         <tr>
325           <td class="memname">void configure </td>
326           <td>(</td>
327           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
328           <td class="paramname"><em>input</em>, </td>
329         </tr>
330         <tr>
331           <td class="paramkey"></td>
332           <td></td>
333           <td class="paramtype">float *&#160;</td>
334           <td class="paramname"><em>mean</em>, </td>
335         </tr>
336         <tr>
337           <td class="paramkey"></td>
338           <td></td>
339           <td class="paramtype">uint64_t *&#160;</td>
340           <td class="paramname"><em>global_sum</em>, </td>
341         </tr>
342         <tr>
343           <td class="paramkey"></td>
344           <td></td>
345           <td class="paramtype">float *&#160;</td>
346           <td class="paramname"><em>stddev</em> = <code>nullptr</code>, </td>
347         </tr>
348         <tr>
349           <td class="paramkey"></td>
350           <td></td>
351           <td class="paramtype">uint64_t *&#160;</td>
352           <td class="paramname"><em>global_sum_squared</em> = <code>nullptr</code>&#160;</td>
353         </tr>
354         <tr>
355           <td></td>
356           <td>)</td>
357           <td></td><td></td>
358         </tr>
359       </table>
360 </div><div class="memdoc">
361
362 <p>Initialise the kernel's input and outputs. </p>
363 <dl class="params"><dt>Parameters</dt><dd>
364   <table class="params">
365     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input image. Data type supported: U8. </td></tr>
366     <tr><td class="paramdir">[out]</td><td class="paramname">mean</td><td>Input average pixel value. </td></tr>
367     <tr><td class="paramdir">[out]</td><td class="paramname">global_sum</td><td>Keeps global sum of pixel values. </td></tr>
368     <tr><td class="paramdir">[out]</td><td class="paramname">stddev</td><td>(Optional) Output standard deviation of pixel values. </td></tr>
369     <tr><td class="paramdir">[out]</td><td class="paramname">global_sum_squared</td><td>(Optional if stddev is not set, required if stddev is set) Keeps global sum of squared pixel values. </td></tr>
370   </table>
371   </dd>
372 </dl>
373
374 <p>Referenced by <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml#l00041">NEMeanStdDevKernel::name()</a>.</p>
375
376 </div>
377 </div>
378 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
379 <div class="memitem">
380 <div class="memproto">
381 <table class="mlabels">
382   <tr>
383   <td class="mlabels-left">
384       <table class="memname">
385         <tr>
386           <td class="memname">const char* name </td>
387           <td>(</td>
388           <td class="paramname"></td><td>)</td>
389           <td> const</td>
390         </tr>
391       </table>
392   </td>
393   <td class="mlabels-right">
394 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
395   </tr>
396 </table>
397 </div><div class="memdoc">
398
399 <p>Name of the kernel. </p>
400 <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>
401
402 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
403
404 <p>Definition at line <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml#l00041">41</a> of file <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml">NEMeanStdDevKernel.h</a>.</p>
405
406 <p>References <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">NEMeanStdDevKernel::border_size()</a>, <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a22fb6b7d1bd5ce8a90c61780c94cebbb">NEMeanStdDevKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a6a85f552b312ad2560ae02676db95f9e">NEMeanStdDevKernel::NEMeanStdDevKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a8658dfa985e2cd5805d4756eed25638d">NEMeanStdDevKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEMeanStdDevKernel::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_mean_std_dev_kernel.xhtml#ad18b8df3b46973ddb4196f5b31ef5356">NEMeanStdDevKernel::~NEMeanStdDevKernel()</a>.</p>
407 <div class="fragment"><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    {</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEMeanStdDevKernel&quot;</span>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    }</div></div><!-- fragment -->
408 </div>
409 </div>
410 <a class="anchor" id="a8658dfa985e2cd5805d4756eed25638d"></a>
411 <div class="memitem">
412 <div class="memproto">
413 <table class="mlabels">
414   <tr>
415   <td class="mlabels-left">
416       <table class="memname">
417         <tr>
418           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a>&amp; operator= </td>
419           <td>(</td>
420           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;&#160;</td>
421           <td class="paramname"></td><td>)</td>
422           <td></td>
423         </tr>
424       </table>
425   </td>
426   <td class="mlabels-right">
427 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
428   </tr>
429 </table>
430 </div><div class="memdoc">
431
432 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
433
434 <p>Referenced by <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml#l00041">NEMeanStdDevKernel::name()</a>.</p>
435
436 </div>
437 </div>
438 <a class="anchor" id="addfd7a52f0ae7ff3ff637834f4cb977c"></a>
439 <div class="memitem">
440 <div class="memproto">
441 <table class="mlabels">
442   <tr>
443   <td class="mlabels-left">
444       <table class="memname">
445         <tr>
446           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a>&amp; operator= </td>
447           <td>(</td>
448           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a> &amp;&amp;&#160;</td>
449           <td class="paramname"></td><td>)</td>
450           <td></td>
451         </tr>
452       </table>
453   </td>
454   <td class="mlabels-right">
455 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
456   </tr>
457 </table>
458 </div><div class="memdoc">
459
460 <p>Allow instances of this class to be moved. </p>
461
462 </div>
463 </div>
464 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
465 <div class="memitem">
466 <div class="memproto">
467 <table class="mlabels">
468   <tr>
469   <td class="mlabels-left">
470       <table class="memname">
471         <tr>
472           <td class="memname">void run </td>
473           <td>(</td>
474           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
475           <td class="paramname"><em>window</em>, </td>
476         </tr>
477         <tr>
478           <td class="paramkey"></td>
479           <td></td>
480           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
481           <td class="paramname"><em>info</em>&#160;</td>
482         </tr>
483         <tr>
484           <td></td>
485           <td>)</td>
486           <td></td><td></td>
487         </tr>
488       </table>
489   </td>
490   <td class="mlabels-right">
491 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
492   </tr>
493 </table>
494 </div><div class="memdoc">
495
496 <p>Execute the kernel on the passed window. </p>
497 <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>
498 <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>
499 <dd>
500 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
501 <dl class="params"><dt>Parameters</dt><dd>
502   <table class="params">
503     <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>
504     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
505   </table>
506   </dd>
507 </dl>
508
509 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
510
511 <p>Referenced by <a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml#l00041">NEMeanStdDevKernel::name()</a>.</p>
512
513 </div>
514 </div>
515 <hr/>The documentation for this class was generated from the following file:<ul>
516 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_mean_std_dev_kernel_8h_source.xhtml">NEMeanStdDevKernel.h</a></li>
517 </ul>
518 </div><!-- contents -->
519 </div><!-- doc-content -->
520 <!-- start footer part -->
521 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
522   <ul>
523     <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_mean_std_dev_kernel.xhtml">NEMeanStdDevKernel</a></li>
524     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
525     <a href="http://www.doxygen.org/index.html">
526     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
527   </ul>
528 </div>
529 </body>
530 </html>