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

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classCSplineParzenMI.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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
<!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>CSplineParzenMI 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-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CSplineParzenMI Class Reference<div class="ingroups"><a class="el" href="group__registration.html">Image Registration and Transformation</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Implementation of mutual information based on B-splines.  
 <a href="classCSplineParzenMI.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="splineparzenmi_8hh_source.html">mia/core/splineparzenmi.hh</a>&gt;</code></p>
<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:ab999c2e3236a479e22286c700a590ee0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#ab999c2e3236a479e22286c700a590ee0">CSplineParzenMI</a> (size_t rbins, <a class="el" href="group__interpol.html#gabb93b6f794b272a353b11de0d0dad8cd">PSplineKernel</a> rkernel, size_t mbins, <a class="el" href="group__interpol.html#gabb93b6f794b272a353b11de0d0dad8cd">PSplineKernel</a> mkernel, double cut_histogram)</td></tr>
<tr class="separator:ab999c2e3236a479e22286c700a590ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11c8cd4dc463aa6011419943402ad635"><td class="memTemplParams" colspan="2">template&lt;typename MovIterator , typename RefIterator &gt; </td></tr>
<tr class="memitem:a11c8cd4dc463aa6011419943402ad635"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#a11c8cd4dc463aa6011419943402ad635">fill</a> (MovIterator mov_begin, MovIterator mov_end, RefIterator ref_begin, RefIterator ref_end)</td></tr>
<tr class="separator:a11c8cd4dc463aa6011419943402ad635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19f093908b45ec64fa947d4900e2cb46"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#a19f093908b45ec64fa947d4900e2cb46">get_gradient</a> (double moving, double reference) const </td></tr>
<tr class="separator:a19f093908b45ec64fa947d4900e2cb46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addab43e1c425aec352d082be792fe3e0"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#addab43e1c425aec352d082be792fe3e0">get_gradient_slow</a> (double moving, double reference) const </td></tr>
<tr class="separator:addab43e1c425aec352d082be792fe3e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90167a105bd594d0140eb31c22b27b72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#a90167a105bd594d0140eb31c22b27b72">reset</a> ()</td></tr>
<tr class="separator:a90167a105bd594d0140eb31c22b27b72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d2c5f1e0d6f2e76c624f57c8ec4a569"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#a8d2c5f1e0d6f2e76c624f57c8ec4a569">value</a> () const </td></tr>
<tr class="separator:a8d2c5f1e0d6f2e76c624f57c8ec4a569"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a894bd73b139faca3e57d0d6d141dd2ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSplineParzenMI.html#a894bd73b139faca3e57d0d6d141dd2ab">fill_histograms</a> (const std::vector&lt; double &gt; &amp;values, double rmin, double rmax, double mmin, double mmax)</td></tr>
<tr class="separator:a894bd73b139faca3e57d0d6d141dd2ab"><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>Implementation of mutual information based on B-splines. </p>
<p>This class implements a spline parzen windows based evaluation of the mutual information between two images and its gradient w.r.t. to one image.</p>
<p>For details see P. Thévenaz, M. Unser, "Optimization of Mutual Information 
        for Multiresolution Image Registration," IEEE Tran on Img Proc, vol. 9, no. 12, pp. 2083-2099, December 2000. </p>

<p>Definition at line <a class="el" href="splineparzenmi_8hh_source.html#l00044">44</a> of file <a class="el" href="splineparzenmi_8hh_source.html">splineparzenmi.hh</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab999c2e3236a479e22286c700a590ee0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSplineParzenMI::CSplineParzenMI </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>rbins</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__interpol.html#gabb93b6f794b272a353b11de0d0dad8cd">PSplineKernel</a>&#160;</td>
          <td class="paramname"><em>rkernel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>mbins</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__interpol.html#gabb93b6f794b272a353b11de0d0dad8cd">PSplineKernel</a>&#160;</td>
          <td class="paramname"><em>mkernel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>cut_histogram</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor of the mutual information class </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">rbins</td><td>number of bins in reference intensity range </td></tr>
    <tr><td class="paramname">rkernel</td><td>B-spline kernel for filling and evaluating reference intensities </td></tr>
    <tr><td class="paramname">mbins</td><td>number of bins in moving intensity range </td></tr>
    <tr><td class="paramname">mkernel</td><td>B-spline kernel for filling and evaluating moving intensities </td></tr>
    <tr><td class="paramname">cut_histogram</td><td>the percentage of the histogram to clamp at the lower and upper end in order to eliminate outliers [0, 40] </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a11c8cd4dc463aa6011419943402ad635"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MovIterator , typename RefIterator &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void CSplineParzenMI::fill </td>
          <td>(</td>
          <td class="paramtype">MovIterator&#160;</td>
          <td class="paramname"><em>mov_begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MovIterator&#160;</td>
          <td class="paramname"><em>mov_end</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">RefIterator&#160;</td>
          <td class="paramname"><em>ref_begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">RefIterator&#160;</td>
          <td class="paramname"><em>ref_end</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Fill the histogram structures and caches </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">MovIterator</td><td>forward iterator type for moving image </td></tr>
    <tr><td class="paramname">RefIterator</td><td>forward iterator type for reference image </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mov_begin</td><td>begin of moving image range </td></tr>
    <tr><td class="paramname">mov_end</td><td>end of moving image range </td></tr>
    <tr><td class="paramname">ref_begin</td><td>begin of reference image range </td></tr>
    <tr><td class="paramname">ref_end</td><td>end of reference image range </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="splineparzenmi_8hh_source.html#l00152">152</a> of file <a class="el" href="splineparzenmi_8hh_source.html">splineparzenmi.hh</a>.</p>

<p>References <a class="el" href="msgstream_8hh_source.html#l00213">cvdebug()</a>.</p>

</div>
</div>
<a class="anchor" id="a894bd73b139faca3e57d0d6d141dd2ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void CSplineParzenMI::fill_histograms </td>
          <td>(</td>
          <td class="paramtype">const std::vector&lt; double &gt; &amp;&#160;</td>
          <td class="paramname"><em>values</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>rmin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>rmax</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>mmin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>mmax</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>these function is for test purpouses only </p>

</div>
</div>
<a class="anchor" id="a19f093908b45ec64fa947d4900e2cb46"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double CSplineParzenMI::get_gradient </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>moving</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>reference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Evaluate the gradient of the MI with respect to a given intensity pair using an approximation </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">moving</td><td>intensity in the moving image </td></tr>
    <tr><td class="paramname">reference</td><td>intensity in the moving image </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>gradient </dd></dl>

</div>
</div>
<a class="anchor" id="addab43e1c425aec352d082be792fe3e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double CSplineParzenMI::get_gradient_slow </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>moving</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>reference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Evaluate the gradient of the MI with respect to a given intensity pair </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">moving</td><td>intensity in the moving image </td></tr>
    <tr><td class="paramname">reference</td><td>intensity in the moving image </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>gradient </dd></dl>

</div>
</div>
<a class="anchor" id="a90167a105bd594d0140eb31c22b27b72"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSplineParzenMI::reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>reset the ranges to force a new evaluation </p>

</div>
</div>
<a class="anchor" id="a8d2c5f1e0d6f2e76c624f57c8ec4a569"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double CSplineParzenMI::value </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 value of the mutual information that is maximized if the given input images are equal. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="splineparzenmi_8hh_source.html">splineparzenmi.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 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.