Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 814

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkImageProgressIterator&lt; DType &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vtkImageProgressIterator&lt; DType &gt; Class Template Reference</h1><!-- doxytag: class="vtkImageProgressIterator" --><!-- doxytag: inherits="vtkImageIterator" --><code>#include &lt;<a class="el" href="a04072.html">vtkImageProgressIterator.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkImageProgressIterator&lt; DType &gt;:</div>
<div class="dynsection">
<p><center><img src="a11091.png" border="0" usemap="#a11092" alt="Inheritance graph"></center>
<map name="a11092">
<area shape="rect" href="a00783.html" title="a simple image iterator" alt="" coords="32,5,216,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkImageProgressIterator&lt; DType &gt;:</div>
<div class="dynsection">
<p><center><img src="a11093.png" border="0" usemap="#a11094" alt="Collaboration graph"></center>
<map name="a11094">
<area shape="rect" href="a00783.html" title="a simple image iterator" alt="" coords="68,382,252,408"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="297,382,396,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="477,499,576,526"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="407,174,487,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="404,264,553,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="212,264,321,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="164,6,273,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="5,174,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="153,83,284,110"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,417,110"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,174,373,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a11095.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class DType&gt;<br>
 class vtkImageProgressIterator&lt; DType &gt;</h3>

a simple image iterator with progress 
<p>
This is a simple image iterator that can be used to iterate over an image. Typically used to iterate over the output image<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00751.html" title="topologically and geometrically regular array of data">vtkImageData</a> <a class="el" href="a00783.html" title="a simple image iterator">vtkImageIterator</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_8.html#c2_vtk_t_vtkImageProgressIterator">vtkImageProgressIterator (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04072.html#l00035">35</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00783.html">vtkImageIterator</a>&lt; DType &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#16aa34a1dbf62235506e4ee5cae8e799">Superclass</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#abf2751d476a4f1064415e2b49feb630">NextSpan</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#4fcb86a69c17a9987c14a6464ab4926c">IsAtEnd</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#44925e120fb5b0c826c7937794464532">vtkImageProgressIterator</a> (<a class="el" href="a00751.html">vtkImageData</a> *imgd, int *ext, <a class="el" href="a00101.html">vtkAlgorithm</a> *po, int id)</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00101.html">vtkAlgorithm</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#60cd291d5df3637cf1d3a87e6368ad13">Algorithm</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ec51f7bd9a86d220b57907d5e1acd01e">Count</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ea7c6100bcb86c4cc2ea357ba3d43200">Count2</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#c2d71ac26742db5668e2b01aee60aa9c">Target</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#cb04fef73173c2e8e5d67d8649dce252">ID</a></td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="16aa34a1dbf62235506e4ee5cae8e799"></a><!-- doxytag: member="vtkImageProgressIterator::Superclass" ref="16aa34a1dbf62235506e4ee5cae8e799" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00783.html">vtkImageIterator</a>&lt;DType&gt; <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00783.html">Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04072.html#l00038">38</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="44925e120fb5b0c826c7937794464532"></a><!-- doxytag: member="vtkImageProgressIterator::vtkImageProgressIterator" ref="44925e120fb5b0c826c7937794464532" args="(vtkImageData *imgd, int *ext, vtkAlgorithm *po, int id)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00811.html">vtkImageProgressIterator</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"> <em>imgd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>ext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00101.html">vtkAlgorithm</a> *&nbsp;</td>
          <td class="paramname"> <em>po</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a progress iterator for the provided image data and extent to iterate over. The passes progress object will receive any UpdateProgress calls if the thread id is zero 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="abf2751d476a4f1064415e2b49feb630"></a><!-- doxytag: member="vtkImageProgressIterator::NextSpan" ref="abf2751d476a4f1064415e2b49feb630" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::NextSpan           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Move the iterator to the next span, may call UpdateProgress on the filter (<a class="el" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK.">vtkAlgorithm</a>) 
<p>Reimplemented from <a class="el" href="a00783.html#d247eb90a92a2058e9c7bf6e6eb42b39">vtkImageIterator&lt; DType &gt;</a>.</p>

</div>
</div><p>
<a class="anchor" name="4fcb86a69c17a9987c14a6464ab4926c"></a><!-- doxytag: member="vtkImageProgressIterator::IsAtEnd" ref="4fcb86a69c17a9987c14a6464ab4926c" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::IsAtEnd           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Overridden from <a class="el" href="a00783.html" title="a simple image iterator">vtkImageIterator</a> to check AbortExecute on the filter (<a class="el" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK.">vtkAlgorithm</a>). 
<p>Reimplemented from <a class="el" href="a00783.html#0f5382a1468669473f7a1b3ff342de5e">vtkImageIterator&lt; DType &gt;</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="60cd291d5df3637cf1d3a87e6368ad13"></a><!-- doxytag: member="vtkImageProgressIterator::Algorithm" ref="60cd291d5df3637cf1d3a87e6368ad13" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00101.html">vtkAlgorithm</a>* <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00811.html#60cd291d5df3637cf1d3a87e6368ad13">Algorithm</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04072.html#l00057">57</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ec51f7bd9a86d220b57907d5e1acd01e"></a><!-- doxytag: member="vtkImageProgressIterator::Count" ref="ec51f7bd9a86d220b57907d5e1acd01e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned long <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00811.html#ec51f7bd9a86d220b57907d5e1acd01e">Count</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04072.html#l00058">58</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ea7c6100bcb86c4cc2ea357ba3d43200"></a><!-- doxytag: member="vtkImageProgressIterator::Count2" ref="ea7c6100bcb86c4cc2ea357ba3d43200" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned long <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00811.html#ea7c6100bcb86c4cc2ea357ba3d43200">Count2</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04072.html#l00059">59</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c2d71ac26742db5668e2b01aee60aa9c"></a><!-- doxytag: member="vtkImageProgressIterator::Target" ref="c2d71ac26742db5668e2b01aee60aa9c" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned long <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00811.html#c2d71ac26742db5668e2b01aee60aa9c">Target</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04072.html#l00060">60</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="cb04fef73173c2e8e5d67d8649dce252"></a><!-- doxytag: member="vtkImageProgressIterator::ID" ref="cb04fef73173c2e8e5d67d8649dce252" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="a00811.html">vtkImageProgressIterator</a>&lt; DType &gt;::<a class="el" href="a00811.html#cb04fef73173c2e8e5d67d8649dce252">ID</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04072.html#l00061">61</a> of file <a class="el" href="a04072.html">vtkImageProgressIterator.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Filtering/<a class="el" href="a04072.html">vtkImageProgressIterator.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:10:35 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>