Sophie

Sophie

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

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: vtkSimpleImageToImageFilter Class 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>vtkSimpleImageToImageFilter Class Reference</h1><!-- doxytag: class="vtkSimpleImageToImageFilter" --><!-- doxytag: inherits="vtkImageAlgorithm" --><code>#include &lt;<a class="el" href="a04150.html">vtkSimpleImageToImageFilter.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkSimpleImageToImageFilter:</div>
<div class="dynsection">
<p><center><img src="a14473.png" border="0" usemap="#a14474" alt="Inheritance graph"></center>
<map name="a14474">
<area shape="rect" href="a01550.html" title="Simple example of an image&#45;image filter." alt="" coords="5,379,208,406"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="39,230,175,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="57,155,156,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="67,80,147,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="52,6,161,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkSimpleImageToImageFilter:</div>
<div class="dynsection">
<p><center><img src="a14475.png" border="0" usemap="#a14476" alt="Collaboration graph"></center>
<map name="a14476">
<area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="183,499,319,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="281,381,380,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="477,499,576,525"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="407,173,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,5,273,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="5,173,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="153,83,284,109"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,417,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,173,373,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a14477.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Generic image filter with one input. 
<p>
<a class="el" href="a01551.html" title="Generic image filter with one input.">vtkSimpleImageToImageFilter</a> is a filter which aims to avoid much of the complexity associated with <a class="el" href="a00727.html" title="Generic algorithm superclass for image algs.">vtkImageAlgorithm</a> (i.e. support for pieces, multi-threaded operation). If you need to write a simple image-image filter which operates on the whole input, use this as the superclass. The subclass has to provide only an execute method which takes input and output as arguments. Memory allocation is handled in <a class="el" href="a01551.html" title="Generic image filter with one input.">vtkSimpleImageToImageFilter</a>. Also, you are guaranteed to have a valid input in the Execute(input, output) method. By default, this filter requests it's input's whole extent and copies the input's information (spacing, whole extent etc...) to the output. If the output's setup is different (for example, if it performs some sort of sub-sampling), ExecuteInformation has to be overwritten. As an example of how this can be done, you can look at vtkImageShrink3D::ExecuteInformation. For a complete example which uses templates to support generic data types, see <a class="el" href="a01551.html" title="Generic image filter with one input.">vtkSimpleImageToImageFilter</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00727.html" title="Generic algorithm superclass for image algs.">vtkImageAlgorithm</a> <a class="el" href="a01550.html" title="Simple example of an image-image filter.">vtkSimpleImageFilterExample</a> </dd></dl>

<p>Definition at line <a class="el" href="a04150.html#l00044">44</a> of file <a class="el" href="a04150.html">vtkSimpleImageToImageFilter.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="a00727.html">vtkImageAlgorithm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#ccc36307b4e9476c125b42840068b5cf">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">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#3862b5b315e37d0333d0b1b1044aa003">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#9ec07ea2c8d21e4778571edd1a253644">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#4557022cb7872e82d3ad2d4641dac378">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#e363f5a95e6c8d3975b95ffb1feb511e">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
<a class="el" href="a01551.html">vtkSimpleImageToImageFilter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#4e32da4594cdc77c0cdf1077f5f86fd2">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#4506ebd922cb618c5e2749d9a533bbd1">vtkSimpleImageToImageFilter</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#421f1c354d7f30f35e9c9dcfd5894579">~vtkSimpleImageToImageFilter</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#024cad374eb25dbfe0b916fd93bb9fe4">RequestUpdateExtent</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#cc970821c5a403cff02038f47d558ce8">RequestData</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01551.html#978188605006ddf983d3e339b19095e8">SimpleExecute</a> (<a class="el" href="a00751.html">vtkImageData</a> *input, <a class="el" href="a00751.html">vtkImageData</a> *output)=0</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="ccc36307b4e9476c125b42840068b5cf"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::Superclass" ref="ccc36307b4e9476c125b42840068b5cf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00727.html">vtkImageAlgorithm</a> <a class="el" href="a00727.html">vtkSimpleImageToImageFilter::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00727.html#4886a2bada7e61a8f7767bea0e68cb21">vtkImageAlgorithm</a>.</p>

<p>Reimplemented in <a class="el" href="a01550.html#18cdaa9ca21c28b32c08255b5055f2b6">vtkSimpleImageFilterExample</a>.</p>

<p>Definition at line <a class="el" href="a04150.html#l00047">47</a> of file <a class="el" href="a04150.html">vtkSimpleImageToImageFilter.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="4506ebd922cb618c5e2749d9a533bbd1"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::vtkSimpleImageToImageFilter" ref="4506ebd922cb618c5e2749d9a533bbd1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkSimpleImageToImageFilter::vtkSimpleImageToImageFilter           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="421f1c354d7f30f35e9c9dcfd5894579"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::~vtkSimpleImageToImageFilter" ref="421f1c354d7f30f35e9c9dcfd5894579" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkSimpleImageToImageFilter::~vtkSimpleImageToImageFilter           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3862b5b315e37d0333d0b1b1044aa003"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::GetClassName" ref="3862b5b315e37d0333d0b1b1044aa003" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkSimpleImageToImageFilter::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00727.html#91c28cada9653fbb3c9d281eb611fdfa">vtkImageAlgorithm</a>.</p>

<p>Reimplemented in <a class="el" href="a01550.html#aa94d522c24c86b9343314b1d944a29b">vtkSimpleImageFilterExample</a>.</p>

</div>
</div><p>
<a class="anchor" name="e363f5a95e6c8d3975b95ffb1feb511e"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::IsTypeOf" ref="e363f5a95e6c8d3975b95ffb1feb511e" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkSimpleImageToImageFilter::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a00727.html#27cee08eda0b22134811f84ef44d269d">vtkImageAlgorithm</a>.</p>

<p>Reimplemented in <a class="el" href="a01550.html#81f788a5f2f7d746a31ffae6f3379f0f">vtkSimpleImageFilterExample</a>.</p>

</div>
</div><p>
<a class="anchor" name="9ec07ea2c8d21e4778571edd1a253644"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::IsA" ref="9ec07ea2c8d21e4778571edd1a253644" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkSimpleImageToImageFilter::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a00727.html#572ad8603a8e0e66eb95362fc3c7f970">vtkImageAlgorithm</a>.</p>

<p>Reimplemented in <a class="el" href="a01550.html#c841bdad5911a3f972c298965e735394">vtkSimpleImageFilterExample</a>.</p>

</div>
</div><p>
<a class="anchor" name="4e32da4594cdc77c0cdf1077f5f86fd2"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::SafeDownCast" ref="4e32da4594cdc77c0cdf1077f5f86fd2" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01551.html">vtkSimpleImageToImageFilter</a>* vtkSimpleImageToImageFilter::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00727.html#e069fec1c9cac59188001ad8493945a4">vtkImageAlgorithm</a>.</p>

<p>Reimplemented in <a class="el" href="a01550.html#749b6a0152a8ad175dad796b6c42388a">vtkSimpleImageFilterExample</a>.</p>

</div>
</div><p>
<a class="anchor" name="4557022cb7872e82d3ad2d4641dac378"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::PrintSelf" ref="4557022cb7872e82d3ad2d4641dac378" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkSimpleImageToImageFilter::PrintSelf           </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a>&nbsp;</td>
          <td class="paramname"> <em>indent</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. 
<p>Reimplemented from <a class="el" href="a00727.html#24f67bbfad1ac731eb64f5172cf30af3">vtkImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="024cad374eb25dbfe0b916fd93bb9fe4"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::RequestUpdateExtent" ref="024cad374eb25dbfe0b916fd93bb9fe4" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkSimpleImageToImageFilter::RequestUpdateExtent           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> **&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> *&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00727.html#442e91c5e549f40acffb0941846cb047">vtkImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="cc970821c5a403cff02038f47d558ce8"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::RequestData" ref="cc970821c5a403cff02038f47d558ce8" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkSimpleImageToImageFilter::RequestData           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname"> <em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> **&nbsp;</td>
          <td class="paramname"> <em>inputVector</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> *&nbsp;</td>
          <td class="paramname"> <em>outputVector</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This is called by the superclass. This is the method you should override. 
<p>Reimplemented from <a class="el" href="a00727.html#ddc9f91ebe9386c31617c3e12166e10e">vtkImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="978188605006ddf983d3e339b19095e8"></a><!-- doxytag: member="vtkSimpleImageToImageFilter::SimpleExecute" ref="978188605006ddf983d3e339b19095e8" args="(vtkImageData *input, vtkImageData *output)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkSimpleImageToImageFilter::SimpleExecute           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"> <em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"> <em>output</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Implemented in <a class="el" href="a01550.html#b56fe57cc7a38992fc66539aabd8d589">vtkSimpleImageFilterExample</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="a04150.html">vtkSimpleImageToImageFilter.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:34:14 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>