arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_histogram_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: NEHistogramKernel 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_histogram_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">NEHistogramKernel Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Interface for the histogram kernel.  
126  <a href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_n_e_histogram_kernel_8h_source.xhtml">NEHistogramKernel.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for NEHistogramKernel:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_histogram_kernel__coll__graph.svg" width="158" 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_histogram_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:a13563fca453f4925820f84d182294b9d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a13563fca453f4925820f84d182294b9d">NEHistogramKernel</a> ()</td></tr>
142 <tr class="memdesc:a13563fca453f4925820f84d182294b9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a13563fca453f4925820f84d182294b9d">More...</a><br /></td></tr>
143 <tr class="separator:a13563fca453f4925820f84d182294b9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a4983480fbaa765aea4052cf5c28bf60e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a4983480fbaa765aea4052cf5c28bf60e">~NEHistogramKernel</a> ()=default</td></tr>
145 <tr class="memdesc:a4983480fbaa765aea4052cf5c28bf60e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a4983480fbaa765aea4052cf5c28bf60e">More...</a><br /></td></tr>
146 <tr class="separator:a4983480fbaa765aea4052cf5c28bf60e"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:ad671a80d59ee10144e810003ead8fb57"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#ad671a80d59ee10144e810003ead8fb57">NEHistogramKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;)=delete</td></tr>
148 <tr class="memdesc:ad671a80d59ee10144e810003ead8fb57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#ad671a80d59ee10144e810003ead8fb57">More...</a><br /></td></tr>
149 <tr class="separator:ad671a80d59ee10144e810003ead8fb57"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a141d3236a2c874c5ea0ac78776b4433b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a141d3236a2c874c5ea0ac78776b4433b">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;)=delete</td></tr>
151 <tr class="memdesc:a141d3236a2c874c5ea0ac78776b4433b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a141d3236a2c874c5ea0ac78776b4433b">More...</a><br /></td></tr>
152 <tr class="separator:a141d3236a2c874c5ea0ac78776b4433b"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a2961e5538b89a81b0b0e83159b0526c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a2961e5538b89a81b0b0e83159b0526c8">NEHistogramKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&amp;)=default</td></tr>
154 <tr class="memdesc:a2961e5538b89a81b0b0e83159b0526c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a2961e5538b89a81b0b0e83159b0526c8">More...</a><br /></td></tr>
155 <tr class="separator:a2961e5538b89a81b0b0e83159b0526c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a4d612efbb9c534d6d89d397e65d816dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a4d612efbb9c534d6d89d397e65d816dd">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&amp;)=default</td></tr>
157 <tr class="memdesc:a4d612efbb9c534d6d89d397e65d816dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a4d612efbb9c534d6d89d397e65d816dd">More...</a><br /></td></tr>
158 <tr class="separator:a4d612efbb9c534d6d89d397e65d816dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:aa6f4a855483e2d24a509181faa893b75"><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_histogram_kernel.xhtml#aa6f4a855483e2d24a509181faa893b75">configure</a> (const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *input, <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml">IDistribution1D</a> *output, uint32_t *local_hist, uint32_t *window_lut)</td></tr>
160 <tr class="memdesc:aa6f4a855483e2d24a509181faa893b75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input image and the distribution output.  <a href="#aa6f4a855483e2d24a509181faa893b75">More...</a><br /></td></tr>
161 <tr class="separator:aa6f4a855483e2d24a509181faa893b75"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:aaae5b09830704e2ed3cf7d09fe01bfc9"><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_histogram_kernel.xhtml#aaae5b09830704e2ed3cf7d09fe01bfc9">configure</a> (const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *input, <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml">IDistribution1D</a> *output)</td></tr>
163 <tr class="memdesc:aaae5b09830704e2ed3cf7d09fe01bfc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input image and the distribution output.  <a href="#aaae5b09830704e2ed3cf7d09fe01bfc9">More...</a><br /></td></tr>
164 <tr class="separator:aaae5b09830704e2ed3cf7d09fe01bfc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <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_histogram_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>
166 <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>
167 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><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: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>
183 <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>
184 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
185 <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>
186 <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>
187 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
188 </table>
189 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
190 <div class="textblock"><p>Interface for the histogram kernel. </p>
191
192 <p>Definition at line <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml">NEHistogramKernel.h</a>.</p>
193 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
194 <a class="anchor" id="a13563fca453f4925820f84d182294b9d"></a>
195 <div class="memitem">
196 <div class="memproto">
197       <table class="memname">
198         <tr>
199           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> </td>
200           <td>(</td>
201           <td class="paramname"></td><td>)</td>
202           <td></td>
203         </tr>
204       </table>
205 </div><div class="memdoc">
206
207 <p>Default constructor. </p>
208
209 <p>Referenced by <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00043">NEHistogramKernel::name()</a>.</p>
210
211 </div>
212 </div>
213 <a class="anchor" id="a4983480fbaa765aea4052cf5c28bf60e"></a>
214 <div class="memitem">
215 <div class="memproto">
216 <table class="mlabels">
217   <tr>
218   <td class="mlabels-left">
219       <table class="memname">
220         <tr>
221           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> </td>
222           <td>(</td>
223           <td class="paramname"></td><td>)</td>
224           <td></td>
225         </tr>
226       </table>
227   </td>
228   <td class="mlabels-right">
229 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
230   </tr>
231 </table>
232 </div><div class="memdoc">
233
234 <p>Default destructor. </p>
235
236 <p>Referenced by <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00043">NEHistogramKernel::name()</a>.</p>
237
238 </div>
239 </div>
240 <a class="anchor" id="ad671a80d59ee10144e810003ead8fb57"></a>
241 <div class="memitem">
242 <div class="memproto">
243 <table class="mlabels">
244   <tr>
245   <td class="mlabels-left">
246       <table class="memname">
247         <tr>
248           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> </td>
249           <td>(</td>
250           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&#160;</td>
251           <td class="paramname"></td><td>)</td>
252           <td></td>
253         </tr>
254       </table>
255   </td>
256   <td class="mlabels-right">
257 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
258   </tr>
259 </table>
260 </div><div class="memdoc">
261
262 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
263
264 </div>
265 </div>
266 <a class="anchor" id="a2961e5538b89a81b0b0e83159b0526c8"></a>
267 <div class="memitem">
268 <div class="memproto">
269 <table class="mlabels">
270   <tr>
271   <td class="mlabels-left">
272       <table class="memname">
273         <tr>
274           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> </td>
275           <td>(</td>
276           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&amp;&#160;</td>
277           <td class="paramname"></td><td>)</td>
278           <td></td>
279         </tr>
280       </table>
281   </td>
282   <td class="mlabels-right">
283 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
284   </tr>
285 </table>
286 </div><div class="memdoc">
287
288 <p>Allow instances of this class to be moved. </p>
289
290 </div>
291 </div>
292 <h2 class="groupheader">Member Function Documentation</h2>
293 <a class="anchor" id="aa6f4a855483e2d24a509181faa893b75"></a>
294 <div class="memitem">
295 <div class="memproto">
296       <table class="memname">
297         <tr>
298           <td class="memname">void configure </td>
299           <td>(</td>
300           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
301           <td class="paramname"><em>input</em>, </td>
302         </tr>
303         <tr>
304           <td class="paramkey"></td>
305           <td></td>
306           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml">IDistribution1D</a> *&#160;</td>
307           <td class="paramname"><em>output</em>, </td>
308         </tr>
309         <tr>
310           <td class="paramkey"></td>
311           <td></td>
312           <td class="paramtype">uint32_t *&#160;</td>
313           <td class="paramname"><em>local_hist</em>, </td>
314         </tr>
315         <tr>
316           <td class="paramkey"></td>
317           <td></td>
318           <td class="paramtype">uint32_t *&#160;</td>
319           <td class="paramname"><em>window_lut</em>&#160;</td>
320         </tr>
321         <tr>
322           <td></td>
323           <td>)</td>
324           <td></td><td></td>
325         </tr>
326       </table>
327 </div><div class="memdoc">
328
329 <p>Set the input image and the distribution output. </p>
330 <dl class="params"><dt>Parameters</dt><dd>
331   <table class="params">
332     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source image. Data type supported: U8. </td></tr>
333     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination distribution. </td></tr>
334     <tr><td class="paramdir">[in,out]</td><td class="paramname">local_hist</td><td><a class="el" href="classarm__compute_1_1_array.xhtml" title="Basic implementation of the IArray interface which allocates a static number of T values...">Array</a> that the threads use to save their local histograms. It's size should be equal to (number_of_threads * num_bins), and the Window::thread_id() is used to determine the part of the array used by each thread. </td></tr>
335     <tr><td class="paramdir">[out]</td><td class="paramname">window_lut</td><td>LUT with pre-calculated possible window values. The size of the LUT should be equal to max_range_size and it will be filled during the configure stage, while it re-used in every run, therefore can be safely shared among threads. </td></tr>
336   </table>
337   </dd>
338 </dl>
339
340 <p>Referenced by <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00043">NEHistogramKernel::name()</a>.</p>
341
342 </div>
343 </div>
344 <a class="anchor" id="aaae5b09830704e2ed3cf7d09fe01bfc9"></a>
345 <div class="memitem">
346 <div class="memproto">
347       <table class="memname">
348         <tr>
349           <td class="memname">void configure </td>
350           <td>(</td>
351           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td>
352           <td class="paramname"><em>input</em>, </td>
353         </tr>
354         <tr>
355           <td class="paramkey"></td>
356           <td></td>
357           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml">IDistribution1D</a> *&#160;</td>
358           <td class="paramname"><em>output</em>&#160;</td>
359         </tr>
360         <tr>
361           <td></td>
362           <td>)</td>
363           <td></td><td></td>
364         </tr>
365       </table>
366 </div><div class="memdoc">
367
368 <p>Set the input image and the distribution output. </p>
369 <dl class="section note"><dt>Note</dt><dd>Used for histogram of fixed size equal to 256</dd></dl>
370 <dl class="params"><dt>Parameters</dt><dd>
371   <table class="params">
372     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source image. Data type supported: U8. </td></tr>
373     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination distribution which must be of 256 bins.. </td></tr>
374   </table>
375   </dd>
376 </dl>
377
378 </div>
379 </div>
380 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
381 <div class="memitem">
382 <div class="memproto">
383 <table class="mlabels">
384   <tr>
385   <td class="mlabels-left">
386       <table class="memname">
387         <tr>
388           <td class="memname">const char* name </td>
389           <td>(</td>
390           <td class="paramname"></td><td>)</td>
391           <td> const</td>
392         </tr>
393       </table>
394   </td>
395   <td class="mlabels-right">
396 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
397   </tr>
398 </table>
399 </div><div class="memdoc">
400
401 <p>Name of the kernel. </p>
402 <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>
403
404 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
405
406 <p>Definition at line <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00043">43</a> of file <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml">NEHistogramKernel.h</a>.</p>
407
408 <p>References <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#aa6f4a855483e2d24a509181faa893b75">NEHistogramKernel::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_histogram_kernel.xhtml#a13563fca453f4925820f84d182294b9d">NEHistogramKernel::NEHistogramKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a141d3236a2c874c5ea0ac78776b4433b">NEHistogramKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEHistogramKernel::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_histogram_kernel.xhtml#a4983480fbaa765aea4052cf5c28bf60e">NEHistogramKernel::~NEHistogramKernel()</a>.</p>
409 <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    {</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEHistogramKernel&quot;</span>;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    }</div></div><!-- fragment -->
410 </div>
411 </div>
412 <a class="anchor" id="a141d3236a2c874c5ea0ac78776b4433b"></a>
413 <div class="memitem">
414 <div class="memproto">
415 <table class="mlabels">
416   <tr>
417   <td class="mlabels-left">
418       <table class="memname">
419         <tr>
420           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a>&amp; operator= </td>
421           <td>(</td>
422           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&#160;</td>
423           <td class="paramname"></td><td>)</td>
424           <td></td>
425         </tr>
426       </table>
427   </td>
428   <td class="mlabels-right">
429 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
430   </tr>
431 </table>
432 </div><div class="memdoc">
433
434 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
435
436 <p>Referenced by <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00043">NEHistogramKernel::name()</a>.</p>
437
438 </div>
439 </div>
440 <a class="anchor" id="a4d612efbb9c534d6d89d397e65d816dd"></a>
441 <div class="memitem">
442 <div class="memproto">
443 <table class="mlabels">
444   <tr>
445   <td class="mlabels-left">
446       <table class="memname">
447         <tr>
448           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a>&amp; operator= </td>
449           <td>(</td>
450           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_histogram_kernel.xhtml">NEHistogramKernel</a> &amp;&amp;&#160;</td>
451           <td class="paramname"></td><td>)</td>
452           <td></td>
453         </tr>
454       </table>
455   </td>
456   <td class="mlabels-right">
457 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
458   </tr>
459 </table>
460 </div><div class="memdoc">
461
462 <p>Allow instances of this class to be moved. </p>
463
464 </div>
465 </div>
466 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
467 <div class="memitem">
468 <div class="memproto">
469 <table class="mlabels">
470   <tr>
471   <td class="mlabels-left">
472       <table class="memname">
473         <tr>
474           <td class="memname">void run </td>
475           <td>(</td>
476           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
477           <td class="paramname"><em>window</em>, </td>
478         </tr>
479         <tr>
480           <td class="paramkey"></td>
481           <td></td>
482           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
483           <td class="paramname"><em>info</em>&#160;</td>
484         </tr>
485         <tr>
486           <td></td>
487           <td>)</td>
488           <td></td><td></td>
489         </tr>
490       </table>
491   </td>
492   <td class="mlabels-right">
493 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
494   </tr>
495 </table>
496 </div><div class="memdoc">
497
498 <p>Execute the kernel on the passed window. </p>
499 <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>
500 <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>
501 <dd>
502 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
503 <dl class="params"><dt>Parameters</dt><dd>
504   <table class="params">
505     <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>
506     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
507   </table>
508   </dd>
509 </dl>
510
511 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
512
513 <p>Referenced by <a class="el" href="_n_e_histogram_kernel_8h_source.xhtml#l00043">NEHistogramKernel::name()</a>.</p>
514
515 </div>
516 </div>
517 <hr/>The documentation for this class was generated from the following file:<ul>
518 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_histogram_kernel_8h_source.xhtml">NEHistogramKernel.h</a></li>
519 </ul>
520 </div><!-- contents -->
521 </div><!-- doc-content -->
522 <!-- start footer part -->
523 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
524   <ul>
525     <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_histogram_kernel.xhtml">NEHistogramKernel</a></li>
526     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
527     <a href="http://www.doxygen.org/index.html">
528     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
529   </ul>
530 </div>
531 </body>
532 </html>