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: NormalizationLayerInfo 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.04</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_normalization_layer_info.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">NormalizationLayerInfo Class Reference</div> </div>
122 <div class="contents">
124 <p>Normalization Layer Information class.
125 <a href="classarm__compute_1_1_normalization_layer_info.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_types_8h_source.xhtml">Types.h</a>></code></p>
128 <table class="memberdecls">
129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
130 Public Member Functions</h2></td></tr>
131 <tr class="memitem:a364517fc26d500026eaa13f50db45703"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a364517fc26d500026eaa13f50db45703">NormalizationLayerInfo</a> (<a class="el" href="namespacearm__compute.xhtml#ad4bb8dabdbf8ad75e34220cc666b59ca">NormType</a> <a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a39f6445d0b790034f0d8fac36f2eb7f5">type</a>, uint32_t <a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a0549be3702c05e6ec1ada69a6d08e349">norm_size</a>=5, float <a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a4ee7f04c477d0e6a2a3609c24a8815b8">alpha</a>=0.0001f, float beta=0.5f, float kappa=1.f)</td></tr>
132 <tr class="memdesc:a364517fc26d500026eaa13f50db45703"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a364517fc26d500026eaa13f50db45703">More...</a><br /></td></tr>
133 <tr class="separator:a364517fc26d500026eaa13f50db45703"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:a39f6445d0b790034f0d8fac36f2eb7f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ad4bb8dabdbf8ad75e34220cc666b59ca">NormType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a39f6445d0b790034f0d8fac36f2eb7f5">type</a> () const </td></tr>
135 <tr class="separator:a39f6445d0b790034f0d8fac36f2eb7f5"><td class="memSeparator" colspan="2"> </td></tr>
136 <tr class="memitem:a0549be3702c05e6ec1ada69a6d08e349"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a0549be3702c05e6ec1ada69a6d08e349">norm_size</a> () const </td></tr>
137 <tr class="separator:a0549be3702c05e6ec1ada69a6d08e349"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:a4ee7f04c477d0e6a2a3609c24a8815b8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a4ee7f04c477d0e6a2a3609c24a8815b8">alpha</a> () const </td></tr>
139 <tr class="separator:a4ee7f04c477d0e6a2a3609c24a8815b8"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a55fe6a30749e41ce31c2bb969a5aa25e"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a55fe6a30749e41ce31c2bb969a5aa25e">beta</a> () const </td></tr>
141 <tr class="separator:a55fe6a30749e41ce31c2bb969a5aa25e"><td class="memSeparator" colspan="2"> </td></tr>
142 <tr class="memitem:a4df91dc0be2437a7d1bfd6d8df72baa8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a4df91dc0be2437a7d1bfd6d8df72baa8">kappa</a> () const </td></tr>
143 <tr class="separator:a4df91dc0be2437a7d1bfd6d8df72baa8"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:a6f541aab23799f6c61d9c8d7ca9fe15c"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml#a6f541aab23799f6c61d9c8d7ca9fe15c">scale_coeff</a> () const </td></tr>
145 <tr class="memdesc:a6f541aab23799f6c61d9c8d7ca9fe15c"><td class="mdescLeft"> </td><td class="mdescRight">Return the scaling factor of the normalization function. <a href="#a6f541aab23799f6c61d9c8d7ca9fe15c">More...</a><br /></td></tr>
146 <tr class="separator:a6f541aab23799f6c61d9c8d7ca9fe15c"><td class="memSeparator" colspan="2"> </td></tr>
148 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
149 <div class="textblock"><p>Normalization Layer Information class. </p>
151 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00482">482</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
152 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
153 <a class="anchor" id="a364517fc26d500026eaa13f50db45703"></a>
154 <div class="memitem">
155 <div class="memproto">
156 <table class="mlabels">
158 <td class="mlabels-left">
159 <table class="memname">
161 <td class="memname"><a class="el" href="classarm__compute_1_1_normalization_layer_info.xhtml">NormalizationLayerInfo</a> </td>
163 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ad4bb8dabdbf8ad75e34220cc666b59ca">NormType</a> </td>
164 <td class="paramname"><em>type</em>, </td>
167 <td class="paramkey"></td>
169 <td class="paramtype">uint32_t </td>
170 <td class="paramname"><em>norm_size</em> = <code>5</code>, </td>
173 <td class="paramkey"></td>
175 <td class="paramtype">float </td>
176 <td class="paramname"><em>alpha</em> = <code>0.0001f</code>, </td>
179 <td class="paramkey"></td>
181 <td class="paramtype">float </td>
182 <td class="paramname"><em>beta</em> = <code>0.5f</code>, </td>
185 <td class="paramkey"></td>
187 <td class="paramtype">float </td>
188 <td class="paramname"><em>kappa</em> = <code>1.f</code> </td>
197 <td class="mlabels-right">
198 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
201 </div><div class="memdoc">
203 <p>Default Constructor. </p>
204 <dl class="params"><dt>Parameters</dt><dd>
205 <table class="params">
206 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The normalization type. Can be <a class="el" href="namespacearm__compute.xhtml#ad4bb8dabdbf8ad75e34220cc666b59caa531d6a3a92fd17afd3c7a8de8d5834c2">NormType::IN_MAP</a> or <a class="el" href="namespacearm__compute.xhtml#ad4bb8dabdbf8ad75e34220cc666b59caa980fef040549733973683b1a868f96e5">NORM_TYPE::CROSS_MAP</a> </td></tr>
207 <tr><td class="paramdir">[in]</td><td class="paramname">norm_size</td><td>The normalization size is the number of elements to normalize across. Defaults to 5. </td></tr>
208 <tr><td class="paramdir">[in]</td><td class="paramname">alpha</td><td>Alpha parameter used by normalization equation. Defaults to 0.0001. </td></tr>
209 <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>Beta parameter used by normalization equation. Defaults to 0.5. </td></tr>
210 <tr><td class="paramdir">[in]</td><td class="paramname">kappa</td><td>Kappa parameter used by [Krichevksy 2012] Across Channel Local Brightness Normalization equation. </td></tr>
215 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00493">493</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
216 <div class="fragment"><div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  : _type(<a class="code" href="classarm__compute_1_1_normalization_layer_info.xhtml#a39f6445d0b790034f0d8fac36f2eb7f5">type</a>), _norm_size(<a class="code" href="classarm__compute_1_1_normalization_layer_info.xhtml#a0549be3702c05e6ec1ada69a6d08e349">norm_size</a>), _alpha(<a class="code" href="classarm__compute_1_1_normalization_layer_info.xhtml#a4ee7f04c477d0e6a2a3609c24a8815b8">alpha</a>), _beta(<a class="code" href="classarm__compute_1_1_normalization_layer_info.xhtml#a55fe6a30749e41ce31c2bb969a5aa25e">beta</a>), _kappa(<a class="code" href="classarm__compute_1_1_normalization_layer_info.xhtml#a4df91dc0be2437a7d1bfd6d8df72baa8">kappa</a>)</div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  {</div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  }</div><div class="ttc" id="classarm__compute_1_1_normalization_layer_info_xhtml_a39f6445d0b790034f0d8fac36f2eb7f5"><div class="ttname"><a href="classarm__compute_1_1_normalization_layer_info.xhtml#a39f6445d0b790034f0d8fac36f2eb7f5">arm_compute::NormalizationLayerInfo::type</a></div><div class="ttdeci">NormType type() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00497">Types.h:497</a></div></div>
217 <div class="ttc" id="classarm__compute_1_1_normalization_layer_info_xhtml_a0549be3702c05e6ec1ada69a6d08e349"><div class="ttname"><a href="classarm__compute_1_1_normalization_layer_info.xhtml#a0549be3702c05e6ec1ada69a6d08e349">arm_compute::NormalizationLayerInfo::norm_size</a></div><div class="ttdeci">uint32_t norm_size() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00501">Types.h:501</a></div></div>
218 <div class="ttc" id="classarm__compute_1_1_normalization_layer_info_xhtml_a4ee7f04c477d0e6a2a3609c24a8815b8"><div class="ttname"><a href="classarm__compute_1_1_normalization_layer_info.xhtml#a4ee7f04c477d0e6a2a3609c24a8815b8">arm_compute::NormalizationLayerInfo::alpha</a></div><div class="ttdeci">float alpha() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00505">Types.h:505</a></div></div>
219 <div class="ttc" id="classarm__compute_1_1_normalization_layer_info_xhtml_a4df91dc0be2437a7d1bfd6d8df72baa8"><div class="ttname"><a href="classarm__compute_1_1_normalization_layer_info.xhtml#a4df91dc0be2437a7d1bfd6d8df72baa8">arm_compute::NormalizationLayerInfo::kappa</a></div><div class="ttdeci">float kappa() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00513">Types.h:513</a></div></div>
220 <div class="ttc" id="classarm__compute_1_1_normalization_layer_info_xhtml_a55fe6a30749e41ce31c2bb969a5aa25e"><div class="ttname"><a href="classarm__compute_1_1_normalization_layer_info.xhtml#a55fe6a30749e41ce31c2bb969a5aa25e">arm_compute::NormalizationLayerInfo::beta</a></div><div class="ttdeci">float beta() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00509">Types.h:509</a></div></div>
221 </div><!-- fragment -->
224 <h2 class="groupheader">Member Function Documentation</h2>
225 <a class="anchor" id="a4ee7f04c477d0e6a2a3609c24a8815b8"></a>
226 <div class="memitem">
227 <div class="memproto">
228 <table class="mlabels">
230 <td class="mlabels-left">
231 <table class="memname">
233 <td class="memname">float alpha </td>
235 <td class="paramname"></td><td>)</td>
240 <td class="mlabels-right">
241 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
244 </div><div class="memdoc">
246 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00505">505</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
247 <div class="fragment"><div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  {</div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  <span class="keywordflow">return</span> _alpha;</div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  }</div></div><!-- fragment -->
250 <a class="anchor" id="a55fe6a30749e41ce31c2bb969a5aa25e"></a>
251 <div class="memitem">
252 <div class="memproto">
253 <table class="mlabels">
255 <td class="mlabels-left">
256 <table class="memname">
258 <td class="memname">float beta </td>
260 <td class="paramname"></td><td>)</td>
265 <td class="mlabels-right">
266 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
269 </div><div class="memdoc">
271 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00509">509</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
272 <div class="fragment"><div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  {</div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  <span class="keywordflow">return</span> _beta;</div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  }</div></div><!-- fragment -->
275 <a class="anchor" id="a4df91dc0be2437a7d1bfd6d8df72baa8"></a>
276 <div class="memitem">
277 <div class="memproto">
278 <table class="mlabels">
280 <td class="mlabels-left">
281 <table class="memname">
283 <td class="memname">float kappa </td>
285 <td class="paramname"></td><td>)</td>
290 <td class="mlabels-right">
291 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
294 </div><div class="memdoc">
296 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00513">513</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
297 <div class="fragment"><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  {</div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  <span class="keywordflow">return</span> _kappa;</div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  }</div></div><!-- fragment -->
300 <a class="anchor" id="a0549be3702c05e6ec1ada69a6d08e349"></a>
301 <div class="memitem">
302 <div class="memproto">
303 <table class="mlabels">
305 <td class="mlabels-left">
306 <table class="memname">
308 <td class="memname">uint32_t norm_size </td>
310 <td class="paramname"></td><td>)</td>
315 <td class="mlabels-right">
316 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
319 </div><div class="memdoc">
321 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00501">501</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
322 <div class="fragment"><div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  {</div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  <span class="keywordflow">return</span> _norm_size;</div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  }</div></div><!-- fragment -->
325 <a class="anchor" id="a6f541aab23799f6c61d9c8d7ca9fe15c"></a>
326 <div class="memitem">
327 <div class="memproto">
328 <table class="mlabels">
330 <td class="mlabels-left">
331 <table class="memname">
333 <td class="memname">float scale_coeff </td>
335 <td class="paramname"></td><td>)</td>
340 <td class="mlabels-right">
341 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
344 </div><div class="memdoc">
346 <p>Return the scaling factor of the normalization function. </p>
347 <p>If kappa is not 1 then [Krichevksy 2012] normalization scaling is specified. </p><dl class="section return"><dt>Returns</dt><dd>The normalization scaling factor. </dd></dl>
349 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00520">520</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
350 <div class="fragment"><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  {</div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  <span class="keywordflow">return</span> (_kappa == 1.f) ? (_alpha / _norm_size) : _alpha;</div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  }</div></div><!-- fragment -->
353 <a class="anchor" id="a39f6445d0b790034f0d8fac36f2eb7f5"></a>
354 <div class="memitem">
355 <div class="memproto">
356 <table class="mlabels">
358 <td class="mlabels-left">
359 <table class="memname">
361 <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ad4bb8dabdbf8ad75e34220cc666b59ca">NormType</a> type </td>
363 <td class="paramname"></td><td>)</td>
368 <td class="mlabels-right">
369 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
372 </div><div class="memdoc">
374 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00497">497</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
375 <div class="fragment"><div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  {</div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  <span class="keywordflow">return</span> _type;</div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  }</div></div><!-- fragment -->
378 <hr/>The documentation for this class was generated from the following file:<ul>
379 <li>arm_compute/core/<a class="el" href="_types_8h_source.xhtml">Types.h</a></li>
381 </div><!-- contents -->
382 </div><!-- doc-content -->
383 <!-- start footer part -->
384 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
386 <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_normalization_layer_info.xhtml">NormalizationLayerInfo</a></li>
387 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
388 <a href="http://www.doxygen.org/index.html">
389 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>