/usr/share/doc/mia-2.0/libdoc/classTHistogramFeeder.html is in libmia-2.0-doc 2.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>THistogramFeeder< T > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">THistogramFeeder< T > Class Template Reference<div class="ingroups"><a class="el" href="group__misc.html">Uncategorized</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A class to normalize and quantizize input data to a given histogram range with its given number of bins.
<a href="classTHistogramFeeder.html#details">More...</a></p>
<p><code>#include <<a class="el" href="histogram_8hh_source.html">mia/core/histogram.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0b36c4d659d2a925fb2eb9c54089ddb0"><td class="memItemLeft" align="right" valign="top">typedef T </td><td class="memItemRight" valign="bottom"><a class="el" href="classTHistogramFeeder.html#a0b36c4d659d2a925fb2eb9c54089ddb0">value_type</a></td></tr>
<tr class="memdesc:a0b36c4d659d2a925fb2eb9c54089ddb0"><td class="mdescLeft"> </td><td class="mdescRight">typedef for generic programming <a href="#a0b36c4d659d2a925fb2eb9c54089ddb0">More...</a><br/></td></tr>
<tr class="separator:a0b36c4d659d2a925fb2eb9c54089ddb0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2050ce6b4aeb3fc39036a96f23559171"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTHistogramFeeder.html#a2050ce6b4aeb3fc39036a96f23559171">index</a> (T x) const </td></tr>
<tr class="separator:a2050ce6b4aeb3fc39036a96f23559171"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a539f3fd9881b0c89ff2376da91b2aeab"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTHistogramFeeder.html#a539f3fd9881b0c89ff2376da91b2aeab">size</a> () const </td></tr>
<tr class="separator:a539f3fd9881b0c89ff2376da91b2aeab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f219b3806fe8979b5e666db9df4eef8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTHistogramFeeder.html#a9f219b3806fe8979b5e666db9df4eef8">THistogramFeeder</a> (T min, T max, size_t bins)</td></tr>
<tr class="separator:a9f219b3806fe8979b5e666db9df4eef8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a8e7643c02df46029652a08bc05e4db"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classTHistogramFeeder.html#a0a8e7643c02df46029652a08bc05e4db">value</a> (size_t k) const </td></tr>
<tr class="separator:a0a8e7643c02df46029652a08bc05e4db"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br/>
class THistogramFeeder< T ></h3>
<p>A class to normalize and quantizize input data to a given histogram range with its given number of bins. </p>
<p>This class is used as a helpe class for simple histograms. The class is responsible for scaling and quantizising the input values to fit the histogram parameters. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">the</td><td>input data type to be fed into the instogram </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="histogram_8hh_source.html#l00049">49</a> of file <a class="el" href="histogram_8hh_source.html">histogram.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a0b36c4d659d2a925fb2eb9c54089ddb0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">typedef T <a class="el" href="classTHistogramFeeder.html">THistogramFeeder</a>< T >::<a class="el" href="classTHistogramFeeder.html#a0b36c4d659d2a925fb2eb9c54089ddb0">value_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>typedef for generic programming </p>
<p>Definition at line <a class="el" href="histogram_8hh_source.html#l00052">52</a> of file <a class="el" href="histogram_8hh_source.html">histogram.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9f219b3806fe8979b5e666db9df4eef8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTHistogramFeeder.html">THistogramFeeder</a>< T >::<a class="el" href="classTHistogramFeeder.html">THistogramFeeder</a> </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bins</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the histogram feeder for a histogram with values in [min,max] with the given number of bins. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min</td><td></td></tr>
<tr><td class="paramname">max</td><td></td></tr>
<tr><td class="paramname">bins</td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="histogram_8hh_source.html#l00228">228</a> of file <a class="el" href="histogram_8hh_source.html">histogram.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2050ce6b4aeb3fc39036a96f23559171"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classTHistogramFeeder.html">THistogramFeeder</a>< T >::index </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the target bin of an input value </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>input value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the target bin index </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>the index is the nearest neighbor of the scaled input value </dd></dl>
<p>Definition at line <a class="el" href="histogram_8hh_source.html#l00244">244</a> of file <a class="el" href="histogram_8hh_source.html">histogram.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a539f3fd9881b0c89ff2376da91b2aeab"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classTHistogramFeeder.html">THistogramFeeder</a>< T >::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of bins </dd></dl>
<p>Definition at line <a class="el" href="histogram_8hh_source.html#l00238">238</a> of file <a class="el" href="histogram_8hh_source.html">histogram.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a0a8e7643c02df46029652a08bc05e4db"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classTHistogramFeeder.html">THistogramFeeder</a>< T >::value </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>k</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the center value of a given bin in terms of the input data range </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">k</td><td>bin index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>center value of bin </dd></dl>
<p>Definition at line <a class="el" href="histogram_8hh_source.html#l00255">255</a> of file <a class="el" href="histogram_8hh_source.html">histogram.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="histogram_8hh_source.html">histogram.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:10 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|