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

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classC3DRegTimeStep.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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
<!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>C3DRegTimeStep 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">C3DRegTimeStep Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__registration.html">Image Registration and Transformation</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The time-step part of time-marching registration algorithms.  
 <a href="classC3DRegTimeStep.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="3d_2timestep_8hh_source.html">mia/3d/timestep.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for C3DRegTimeStep:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classC3DRegTimeStep.png" usemap="#C3DRegTimeStep_map" alt=""/>
  <map id="C3DRegTimeStep_map" name="C3DRegTimeStep_map">
<area href="classCProductBase.html" title="The base class for all plug-in created object. " alt="CProductBase" shape="rect" coords="0,56,133,80"/>
<area href="classCPropertyFlagHolder.html" title="This class holds a set of properties. " alt="CPropertyFlagHolder" shape="rect" coords="0,0,133,24"/>
</map>
 </div></div>
<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:a7416ebb92a1f158f51be489483fad8d1"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classC3DImage.html">C3DImage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a7416ebb92a1f158f51be489483fad8d1">plugin_data</a></td></tr>
<tr class="memdesc:a7416ebb92a1f158f51be489483fad8d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">plugin hanlder helper  <a href="#a7416ebb92a1f158f51be489483fad8d1">More...</a><br/></td></tr>
<tr class="separator:a7416ebb92a1f158f51be489483fad8d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcb506ed319ad60db460c38ebffa3569"><td class="memItemLeft" align="right" valign="top">typedef timestep_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#afcb506ed319ad60db460c38ebffa3569">plugin_type</a></td></tr>
<tr class="memdesc:afcb506ed319ad60db460c38ebffa3569"><td class="mdescLeft">&#160;</td><td class="mdescRight">plugin hanlder helper  <a href="#afcb506ed319ad60db460c38ebffa3569">More...</a><br/></td></tr>
<tr class="separator:afcb506ed319ad60db460c38ebffa3569"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classCPropertyFlagHolder"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classCPropertyFlagHolder')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a></td></tr>
<tr class="memitem:ae19cdabd533c31d596b479686943e13e inherit pub_types_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">typedef std::set&lt; const char * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#ae19cdabd533c31d596b479686943e13e">Set</a></td></tr>
<tr class="memdesc:ae19cdabd533c31d596b479686943e13e inherit pub_types_classCPropertyFlagHolder"><td class="mdescLeft">&#160;</td><td class="mdescRight">define the type of the set of flags  <a href="#ae19cdabd533c31d596b479686943e13e">More...</a><br/></td></tr>
<tr class="separator:ae19cdabd533c31d596b479686943e13e inherit pub_types_classCPropertyFlagHolder"><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:abbc7560c5dc3d194d32793daff0b600a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#abbc7560c5dc3d194d32793daff0b600a">apply</a> (const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;infield, <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;outfield, float scale)</td></tr>
<tr class="separator:abbc7560c5dc3d194d32793daff0b600a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61bb30d74bf643330b0e6c2189a9e771"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a61bb30d74bf643330b0e6c2189a9e771">C3DRegTimeStep</a> (float min, float max)</td></tr>
<tr class="separator:a61bb30d74bf643330b0e6c2189a9e771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8122dfe260cc50fa3ecb52154c71cd60"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a8122dfe260cc50fa3ecb52154c71cd60">calculate_pertuberation</a> (<a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;io, const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;shift) const </td></tr>
<tr class="separator:a8122dfe260cc50fa3ecb52154c71cd60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35880fbfd7a81c17c2b0b1dfe69d1373"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a35880fbfd7a81c17c2b0b1dfe69d1373">decrease</a> ()</td></tr>
<tr class="separator:a35880fbfd7a81c17c2b0b1dfe69d1373"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25863b30c5ee2e59273f38628d0cd74f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a25863b30c5ee2e59273f38628d0cd74f">get_delta</a> (float maxshift) const </td></tr>
<tr class="separator:a25863b30c5ee2e59273f38628d0cd74f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a774207545899c26e2191a5aba9103d2b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a774207545899c26e2191a5aba9103d2b">has_regrid</a> () const </td></tr>
<tr class="separator:a774207545899c26e2191a5aba9103d2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c09ab9034ed1f113bbaeb3cdda2b2fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a3c09ab9034ed1f113bbaeb3cdda2b2fd">increase</a> ()</td></tr>
<tr class="separator:a3c09ab9034ed1f113bbaeb3cdda2b2fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d95fc53f6b707b15adc5f2c6eec440c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a1d95fc53f6b707b15adc5f2c6eec440c">regrid_requested</a> (const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;b, const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;v, float delta) const </td></tr>
<tr class="separator:a1d95fc53f6b707b15adc5f2c6eec440c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27047421195da17c843d3061d97e2727"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DRegTimeStep.html#a27047421195da17c843d3061d97e2727">~C3DRegTimeStep</a> ()</td></tr>
<tr class="separator:a27047421195da17c843d3061d97e2727"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCProductBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCProductBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCProductBase.html">CProductBase</a></td></tr>
<tr class="memitem:acfa85a057a881ced532bb78029efddc4 inherit pub_methods_classCProductBase"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProductBase.html#acfa85a057a881ced532bb78029efddc4">get_init_string</a> () const </td></tr>
<tr class="separator:acfa85a057a881ced532bb78029efddc4 inherit pub_methods_classCProductBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60ef92211cb697cc9d3bde947d668e9e inherit pub_methods_classCProductBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProductBase.html#a60ef92211cb697cc9d3bde947d668e9e">set_init_string</a> (const char *init)</td></tr>
<tr class="separator:a60ef92211cb697cc9d3bde947d668e9e inherit pub_methods_classCProductBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac78b75f25de93e9a8c9d9c6ee34b5fa2 inherit pub_methods_classCProductBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProductBase.html#ac78b75f25de93e9a8c9d9c6ee34b5fa2">set_module</a> (<a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a> module)</td></tr>
<tr class="separator:ac78b75f25de93e9a8c9d9c6ee34b5fa2 inherit pub_methods_classCProductBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCPropertyFlagHolder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCPropertyFlagHolder')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a></td></tr>
<tr class="memitem:a365d4cdb13500e1a4139e837fe7cb37c inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a365d4cdb13500e1a4139e837fe7cb37c">add</a> (const char *property)</td></tr>
<tr class="separator:a365d4cdb13500e1a4139e837fe7cb37c inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8410fdf2a8b736c700d8595d82acb1fc inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCPropertyFlagHolder.html#ae19cdabd533c31d596b479686943e13e">Set</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a8410fdf2a8b736c700d8595d82acb1fc">get_missing_properties</a> (const <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a> &amp;testset) const </td></tr>
<tr class="separator:a8410fdf2a8b736c700d8595d82acb1fc inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a106e9895cd3a2f5d7a121b6a41b0eebd inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a106e9895cd3a2f5d7a121b6a41b0eebd">has</a> (const char *property) const </td></tr>
<tr class="separator:a106e9895cd3a2f5d7a121b6a41b0eebd inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a110f2cdcf0cd275830b92deed7a0d648 inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a110f2cdcf0cd275830b92deed7a0d648">has_all_in</a> (const <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a> &amp;testset) const </td></tr>
<tr class="separator:a110f2cdcf0cd275830b92deed7a0d648 inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7612f039bf567bd94e79dc045de39e1 inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#ae7612f039bf567bd94e79dc045de39e1">~CPropertyFlagHolder</a> ()</td></tr>
<tr class="separator:ae7612f039bf567bd94e79dc045de39e1 inherit pub_methods_classCPropertyFlagHolder"><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>The time-step part of time-marching registration algorithms. </p>

<p>Definition at line <a class="el" href="3d_2timestep_8hh_source.html#l00038">38</a> of file <a class="el" href="3d_2timestep_8hh_source.html">3d/timestep.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a7416ebb92a1f158f51be489483fad8d1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classC3DImage.html">C3DImage</a> <a class="el" href="classC3DRegTimeStep.html#a7416ebb92a1f158f51be489483fad8d1">C3DRegTimeStep::plugin_data</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>plugin hanlder helper </p>

<p>Definition at line <a class="el" href="3d_2timestep_8hh_source.html#l00041">41</a> of file <a class="el" href="3d_2timestep_8hh_source.html">3d/timestep.hh</a>.</p>

</div>
</div>
<a class="anchor" id="afcb506ed319ad60db460c38ebffa3569"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef timestep_type <a class="el" href="classC3DRegTimeStep.html#afcb506ed319ad60db460c38ebffa3569">C3DRegTimeStep::plugin_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>plugin hanlder helper </p>

<p>Definition at line <a class="el" href="3d_2timestep_8hh_source.html#l00043">43</a> of file <a class="el" href="3d_2timestep_8hh_source.html">3d/timestep.hh</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a61bb30d74bf643330b0e6c2189a9e771"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">C3DRegTimeStep::C3DRegTimeStep </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>max</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Contructor to initialize the time setep with the range of possible time step length </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>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a27047421195da17c843d3061d97e2727"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual C3DRegTimeStep::~C3DRegTimeStep </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abbc7560c5dc3d194d32793daff0b600a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void C3DRegTimeStep::apply </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;&#160;</td>
          <td class="paramname"><em>infield</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;&#160;</td>
          <td class="paramname"><em>outfield</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#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>Apply the time step based on an input vector field to an output transformation </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir"></td><td class="paramname">infield</td><td>input vector field to add </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">outfield</td><td>at input: vector field that is to be changed, at output: updated field </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">scale</td><td>a scaling to apply to the input field prior to applying it </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8122dfe260cc50fa3ecb52154c71cd60"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float C3DRegTimeStep::calculate_pertuberation </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;&#160;</td>
          <td class="paramname"><em>shift</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Evaluate the pertuberation related to the time step type and transformation </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>at input: the field to pertoperate, output: pertuperated field </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">shift</td><td>related current transformation to base the pertuberation on </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a35880fbfd7a81c17c2b0b1dfe69d1373"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool C3DRegTimeStep::decrease </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Decrease the current time step </p>
<dl class="section return"><dt>Returns</dt><dd>true if decreasing time-step was sucessfull, otherwise false </dd></dl>

</div>
</div>
<a class="anchor" id="a25863b30c5ee2e59273f38628d0cd74f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float C3DRegTimeStep::get_delta </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>maxshift</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Evaluate the delta for the application of the time step based on the maxium allowed transformation </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">maxshift</td><td>maximum hypothetical transfornmation to be applied </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the delta value corresponding to the current time step </dd></dl>

</div>
</div>
<a class="anchor" id="a774207545899c26e2191a5aba9103d2b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool C3DRegTimeStep::has_regrid </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>true if the time-step requires regridding </dd></dl>

</div>
</div>
<a class="anchor" id="a3c09ab9034ed1f113bbaeb3cdda2b2fd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void C3DRegTimeStep::increase </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Increase time step (at most to its maximum) </p>

</div>
</div>
<a class="anchor" id="a1d95fc53f6b707b15adc5f2c6eec440c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool C3DRegTimeStep::regrid_requested </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;&#160;</td>
          <td class="paramname"><em>b</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__basic.html#ga6a2d1bf6a0358e78f492946d494c6e8e">C3DFVectorfield</a> &amp;&#160;</td>
          <td class="paramname"><em>v</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>delta</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>For a fluid-dynamic like registration evaluate whether a regridding is needed. For other time-steps it always should return false </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">b</td><td>current force field </td></tr>
    <tr><td class="paramname">v</td><td>velocity field </td></tr>
    <tr><td class="paramname">delta</td><td>time step value to be applied </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if regridding is to be applied </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="3d_2timestep_8hh_source.html">3d/timestep.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.