libmia-2.0-doc 2.0.13-1 / usr / share / doc / mia-2.0 / libdoc / classC1DScalar.html

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classC1DScalar.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<!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>C1DScalar Class 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">C1DScalar Class Reference<div class="ingroups"><a class="el" href="group__interpol.html">Interpolation</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>A class for general scaling of one-dimensional arrays.  
 <a href="classC1DScalar.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="scaler1d_8hh_source.html">mia/core/scaler1d.hh</a>&gt;</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:a1db8113d72051f32465e23b8e263a07f"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a1db8113d72051f32465e23b8e263a07f">std_double_vector</a></td></tr>
<tr class="separator:a1db8113d72051f32465e23b8e263a07f"><td class="memSeparator" colspan="2">&#160;</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:aad24e07deb197edd3e8d5edd7511c39a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#aad24e07deb197edd3e8d5edd7511c39a">C1DScalar</a> (const <a class="el" href="classCSplineKernel.html">CSplineKernel</a> &amp;kernel, size_t in_size, size_t out_size)</td></tr>
<tr class="separator:aad24e07deb197edd3e8d5edd7511c39a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f2cd0085199c3803ab71cceecdc6aa3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a6f2cd0085199c3803ab71cceecdc6aa3">C1DScalar</a> (const <a class="el" href="classCSplineKernel.html">CSplineKernel</a> &amp;kernel, size_t in_size, double scale)</td></tr>
<tr class="separator:a6f2cd0085199c3803ab71cceecdc6aa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15d88d80972b0bd95d5861f5a20d2484"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a15d88d80972b0bd95d5861f5a20d2484">get_output_size</a> () const </td></tr>
<tr class="separator:a15d88d80972b0bd95d5861f5a20d2484"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49a8ff762432d454e72decf86f593dc2"><td class="memItemLeft" align="right" valign="top">std_double_vector::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a49a8ff762432d454e72decf86f593dc2">input_begin</a> ()</td></tr>
<tr class="separator:a49a8ff762432d454e72decf86f593dc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25ccb87ede0af0f85ff44a9666774c0a"><td class="memItemLeft" align="right" valign="top">std_double_vector::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a25ccb87ede0af0f85ff44a9666774c0a">input_end</a> ()</td></tr>
<tr class="separator:a25ccb87ede0af0f85ff44a9666774c0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a565fe06edc3b724dfb53db958adc7b95"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a565fe06edc3b724dfb53db958adc7b95">operator()</a> (const <a class="el" href="classC1DScalar.html#a1db8113d72051f32465e23b8e263a07f">std_double_vector</a> &amp;input, <a class="el" href="classC1DScalar.html#a1db8113d72051f32465e23b8e263a07f">std_double_vector</a> &amp;output) const </td></tr>
<tr class="separator:a565fe06edc3b724dfb53db958adc7b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30e5aaa693981e800f3b750ae69996a1"><td class="memItemLeft" align="right" valign="top">std_double_vector::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a30e5aaa693981e800f3b750ae69996a1">output_begin</a> ()</td></tr>
<tr class="separator:a30e5aaa693981e800f3b750ae69996a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd97afbba00bcf04f975555b2a72e7b9"><td class="memItemLeft" align="right" valign="top">std_double_vector::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#abd97afbba00bcf04f975555b2a72e7b9">output_end</a> ()</td></tr>
<tr class="separator:abd97afbba00bcf04f975555b2a72e7b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69f73eed555da96d8edae92c0d51dfb5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC1DScalar.html#a69f73eed555da96d8edae92c0d51dfb5">run</a> ()</td></tr>
<tr class="separator:a69f73eed555da96d8edae92c0d51dfb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class for general scaling of one-dimensional arrays. </p>
<p>Class for general scaling of one-dimensional arrays. kernels are the separable B-spline functions. For upscaling, an interpolator is created by using the provided interpolator factory. Downscaling is done solving an overdetermined linear system of equations Ax = y. At construction time the matrix A is QR decomposed, and later the downscaling is done by solving QRx=y </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd><p class="startdd">see if scaling can be expressed by a filter </p>
<p class="enddd">seems like downscaling isn't done properly </p>
</dd></dl>

<p>Definition at line <a class="el" href="scaler1d_8hh_source.html#l00047">47</a> of file <a class="el" href="scaler1d_8hh_source.html">scaler1d.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a1db8113d72051f32465e23b8e263a07f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::vector&lt;double&gt; <a class="el" href="classC1DScalar.html#a1db8113d72051f32465e23b8e263a07f">C1DScalar::std_double_vector</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="scaler1d_8hh_source.html#l00049">49</a> of file <a class="el" href="scaler1d_8hh_source.html">scaler1d.hh</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aad24e07deb197edd3e8d5edd7511c39a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">C1DScalar::C1DScalar </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCSplineKernel.html">CSplineKernel</a> &amp;&#160;</td>
          <td class="paramname"><em>kernel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>in_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>out_size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create the scaler prividing the given interpolator kernel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">kernel</td><td>interpolation kernel </td></tr>
    <tr><td class="paramname">in_size</td><td></td></tr>
    <tr><td class="paramname">out_size</td><td>the input will be scaled to the given size, the scale is set accordingly </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6f2cd0085199c3803ab71cceecdc6aa3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">C1DScalar::C1DScalar </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCSplineKernel.html">CSplineKernel</a> &amp;&#160;</td>
          <td class="paramname"><em>kernel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>in_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>scale</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create the scaler providing the given interpolator kernel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">kernel</td><td>interpolation kernel </td></tr>
    <tr><td class="paramname">in_size</td><td></td></tr>
    <tr><td class="paramname">scale</td><td>factor by which tho scale the input size, the interpolation will be exact with respect to the scale </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a15d88d80972b0bd95d5861f5a20d2484"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t C1DScalar::get_output_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 size of the output vector </dd></dl>

</div>
</div>
<a class="anchor" id="a49a8ff762432d454e72decf86f593dc2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std_double_vector::iterator C1DScalar::input_begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>begin iterator of the input buffer </dd></dl>

</div>
</div>
<a class="anchor" id="a25ccb87ede0af0f85ff44a9666774c0a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std_double_vector::iterator C1DScalar::input_end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>end iterator of the input buffer </dd></dl>

</div>
</div>
<a class="anchor" id="a565fe06edc3b724dfb53db958adc7b95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void C1DScalar::operator() </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classC1DScalar.html#a1db8113d72051f32465e23b8e263a07f">std_double_vector</a> &amp;&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classC1DScalar.html#a1db8113d72051f32465e23b8e263a07f">std_double_vector</a> &amp;&#160;</td>
          <td class="paramname"><em>output</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Scaling operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir"></td><td class="paramname">input</td><td>input data </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>when calling the function, the size of this vector must be set to the requested size. The path for down or upscaling is automatically selected. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a30e5aaa693981e800f3b750ae69996a1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std_double_vector::iterator C1DScalar::output_begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>begin iterator of the output buffer </dd></dl>

</div>
</div>
<a class="anchor" id="abd97afbba00bcf04f975555b2a72e7b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std_double_vector::iterator C1DScalar::output_end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>end iterator of the output buffer </dd></dl>

</div>
</div>
<a class="anchor" id="a69f73eed555da96d8edae92c0d51dfb5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void C1DScalar::run </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Alternate interface for scaling. Here the input data has to be copied into the pre-acclocated memory by using the <em><a class="el" href="classC1DScalar.html#a49a8ff762432d454e72decf86f593dc2">input_begin()</a></em> and <em><a class="el" href="classC1DScalar.html#a25ccb87ede0af0f85ff44a9666774c0a">input_end()</a></em> iterators, and the result can be read using the <em><a class="el" href="classC1DScalar.html#a30e5aaa693981e800f3b750ae69996a1">output_begin()</a></em>, <em><a class="el" href="classC1DScalar.html#abd97afbba00bcf04f975555b2a72e7b9">output_end()</a></em> iterators. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="scaler1d_8hh_source.html">scaler1d.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:08 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.