<!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: vtkImageStencil 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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkImageStencil Class Reference</h1><!-- doxytag: class="vtkImageStencil" --><!-- doxytag: inherits="vtkThreadedImageAlgorithm" --><code>#include <<a class="el" href="a04753.html">vtkImageStencil.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkImageStencil:</div>
<div class="dynsection">
<p><center><img src="a11211.png" border="0" usemap="#a11212" alt="Inheritance graph"></center>
<map name="a11212">
<area shape="rect" href="a01705.html" title="Generic filter that has one input.." alt="" coords="5,304,200,331"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="35,230,171,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="53,155,152,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="63,80,143,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="48,6,157,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkImageStencil:</div>
<div class="dynsection">
<p><center><img src="a11213.png" border="0" usemap="#a11214" alt="Collaboration graph"></center>
<map name="a11214">
<area shape="rect" href="a01705.html" title="Generic filter that has one input.." alt="" coords="710,590,904,616"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="627,499,763,526"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="414,382,512,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="423,499,522,526"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="408,174,488,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="479,264,628,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="155,264,264,291"><area shape="rect" href="a01064.html" title="A class for performing multithreaded execution." alt="" coords="796,499,922,526"><area shape="rect" href="a01074.html" title="mutual exclusion locking class" alt="" coords="866,264,972,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="164,6,274,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="6,174,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="154,83,284,110"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,418,110"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,174,374,200"><area shape="rect" href="a01065.html" title="vtkMultiThreader::ThreadInfo" alt="" coords="1106,382,1306,408"><area shape="rect" href="a01552.html" title="vtkSimpleMutexLock" alt="" coords="846,174,992,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a11215.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
combine images via a cookie-cutter operation
<p>
<a class="el" href="a00835.html" title="combine images via a cookie-cutter operation">vtkImageStencil</a> will combine two images together using a stencil. The stencil should be provided in the form of a <a class="el" href="a00836.html" title="efficient description of an image stencil">vtkImageStencilData</a>,<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_8.html#c2_vtk_t_vtkImageStencil">vtkImageStencil (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a04753.html#l00032">32</a> of file <a class="el" href="a04753.html">vtkImageStencil.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="a01705.html">vtkThreadedImageAlgorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#da4117903aaae18f872eef07ea648602">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 * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#ff524a84b3df82ae84edcf69c5846bbd">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#7a68c983356a65658c6c8ba8f98a6772">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#f102df97739e5fd947e0f262c5b1e052">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#7e87472be26b90fd627eee48437fc180">SetStencil</a> (<a class="el" href="a00836.html">vtkImageStencilData</a> *stencil)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00836.html">vtkImageStencilData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#aa518ef85445c905285c55e471bc9d44">GetStencil</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#cf70b35da668ae34f5019cb03aaa5dcf">SetReverseStencil</a> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#8cada3c39908ff35402828df75a2d3b9">ReverseStencilOn</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#c99027b658b7ddd9ea6bc8828a44d345">ReverseStencilOff</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#4abecfb8a2e8422ec8e2f60560d68019">GetReverseStencil</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#6dfe5280aad306b80c80c05aa4bc97a0">SetBackgroundInput</a> (<a class="el" href="a00751.html">vtkImageData</a> *input)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00751.html">vtkImageData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#7756d5d3a23c52356f014441360e1ee2">GetBackgroundInput</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#876de4e9e8faeab5fe05dbe6ebbae409">SetBackgroundValue</a> (double val)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#5bf415e82f11c6adeaccc17708611946">GetBackgroundValue</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#7e1e861d684c1af81d82ecd71fd00560">SetBackgroundColor</a> (double, double, double, double)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#af219a1358f310e9ca5521b34cb89e29">SetBackgroundColor</a> (double[4])</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#de4f1a4e28332b9df2f00e2c14acadb1">GetBackgroundColor</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#a91062191aa77c4c63e037db6527be56">GetBackgroundColor</a> (double &, double &, double &, double &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#a4f4224918f1a930208e9f7700dd7dcd">GetBackgroundColor</a> (double[4])</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 <a class="el" href="a00835.html">vtkImageStencil</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#d9b4da5f9bf3396521e4f98db915f220">New</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#f69fc9d63a1775789190274bd120247a">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00835.html">vtkImageStencil</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#0802c05760b970a0b5248facfdafa33f">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#b6721f226013f4a4931c18ed3c50b526">vtkImageStencil</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#204397b88a3fb646102dda745fdd2451">~vtkImageStencil</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#e1f059a5474457151dd370dc4f437b31">RequestInformation</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#e0e02e6f09887acb91ece5aa32011db9">ThreadedRequestData</a> (<a class="el" href="a00872.html">vtkInformation</a> *request, <a class="el" href="a00895.html">vtkInformationVector</a> **inputVector, <a class="el" href="a00895.html">vtkInformationVector</a> *outputVector, <a class="el" href="a00751.html">vtkImageData</a> ***inData, <a class="el" href="a00751.html">vtkImageData</a> **outData, int extent[6], int id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#010eb17b94452a2efacd6430a53e76fe">FillInputPortInformation</a> (int, <a class="el" href="a00872.html">vtkInformation</a> *)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#04dd43cc650a94b8c183e5df55dafbaf">ReverseStencil</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00835.html#8d9766437098eee09ecee095791bba4b">BackgroundColor</a> [4]</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="da4117903aaae18f872eef07ea648602"></a><!-- doxytag: member="vtkImageStencil::Superclass" ref="da4117903aaae18f872eef07ea648602" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01705.html">vtkThreadedImageAlgorithm</a> <a class="el" href="a01705.html">vtkImageStencil::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01705.html#67876177e53dbc18f91b9b50f8f03331">vtkThreadedImageAlgorithm</a>.</p>
<p>Definition at line <a class="el" href="a04753.html#l00036">36</a> of file <a class="el" href="a04753.html">vtkImageStencil.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b6721f226013f4a4931c18ed3c50b526"></a><!-- doxytag: member="vtkImageStencil::vtkImageStencil" ref="b6721f226013f4a4931c18ed3c50b526" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkImageStencil::vtkImageStencil </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="204397b88a3fb646102dda745fdd2451"></a><!-- doxytag: member="vtkImageStencil::~vtkImageStencil" ref="204397b88a3fb646102dda745fdd2451" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkImageStencil::~vtkImageStencil </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="d9b4da5f9bf3396521e4f98db915f220"></a><!-- doxytag: member="vtkImageStencil::New" ref="d9b4da5f9bf3396521e4f98db915f220" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00835.html">vtkImageStencil</a>* vtkImageStencil::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
<p>Reimplemented from <a class="el" href="a00101.html#06d80d8d4aa1a4856135fa003845be82">vtkAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="ff524a84b3df82ae84edcf69c5846bbd"></a><!-- doxytag: member="vtkImageStencil::GetClassName" ref="ff524a84b3df82ae84edcf69c5846bbd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkImageStencil::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01705.html#8622c920af18a6521f427d7b70613faa">vtkThreadedImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="f69fc9d63a1775789190274bd120247a"></a><!-- doxytag: member="vtkImageStencil::IsTypeOf" ref="f69fc9d63a1775789190274bd120247a" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkImageStencil::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </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="a01705.html#1e20b0feec3712e39d352e47d582ff4e">vtkThreadedImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="7a68c983356a65658c6c8ba8f98a6772"></a><!-- doxytag: member="vtkImageStencil::IsA" ref="7a68c983356a65658c6c8ba8f98a6772" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkImageStencil::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </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="a01705.html#250ac29fa902a270b6f94702f7f24e9b">vtkThreadedImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="0802c05760b970a0b5248facfdafa33f"></a><!-- doxytag: member="vtkImageStencil::SafeDownCast" ref="0802c05760b970a0b5248facfdafa33f" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00835.html">vtkImageStencil</a>* vtkImageStencil::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01705.html#def8b2b0abda015b495884db6f717625">vtkThreadedImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="f102df97739e5fd947e0f262c5b1e052"></a><!-- doxytag: member="vtkImageStencil::PrintSelf" ref="f102df97739e5fd947e0f262c5b1e052" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkImageStencil::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </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> </td>
<td class="paramname"> <em>indent</em></td><td> </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="a01705.html#53dc14a03ab6cffae0ca5cadb2c6d172">vtkThreadedImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="7e87472be26b90fd627eee48437fc180"></a><!-- doxytag: member="vtkImageStencil::SetStencil" ref="7e87472be26b90fd627eee48437fc180" args="(vtkImageStencilData *stencil)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::SetStencil </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00836.html">vtkImageStencilData</a> * </td>
<td class="paramname"> <em>stencil</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the stencil to use. The stencil can be created from a <a class="el" href="a00855.html" title="abstract interface for implicit functions">vtkImplicitFunction</a> or a <a class="el" href="a01260.html" title="concrete dataset represents vertices, lines, polygons, and triangle strips">vtkPolyData</a>.
</div>
</div><p>
<a class="anchor" name="aa518ef85445c905285c55e471bc9d44"></a><!-- doxytag: member="vtkImageStencil::GetStencil" ref="aa518ef85445c905285c55e471bc9d44" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00836.html">vtkImageStencilData</a>* vtkImageStencil::GetStencil </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the stencil to use. The stencil can be created from a <a class="el" href="a00855.html" title="abstract interface for implicit functions">vtkImplicitFunction</a> or a <a class="el" href="a01260.html" title="concrete dataset represents vertices, lines, polygons, and triangle strips">vtkPolyData</a>.
</div>
</div><p>
<a class="anchor" name="cf70b35da668ae34f5019cb03aaa5dcf"></a><!-- doxytag: member="vtkImageStencil::SetReverseStencil" ref="cf70b35da668ae34f5019cb03aaa5dcf" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::SetReverseStencil </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reverse the stencil.
</div>
</div><p>
<a class="anchor" name="8cada3c39908ff35402828df75a2d3b9"></a><!-- doxytag: member="vtkImageStencil::ReverseStencilOn" ref="8cada3c39908ff35402828df75a2d3b9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::ReverseStencilOn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reverse the stencil.
</div>
</div><p>
<a class="anchor" name="c99027b658b7ddd9ea6bc8828a44d345"></a><!-- doxytag: member="vtkImageStencil::ReverseStencilOff" ref="c99027b658b7ddd9ea6bc8828a44d345" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::ReverseStencilOff </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reverse the stencil.
</div>
</div><p>
<a class="anchor" name="4abecfb8a2e8422ec8e2f60560d68019"></a><!-- doxytag: member="vtkImageStencil::GetReverseStencil" ref="4abecfb8a2e8422ec8e2f60560d68019" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkImageStencil::GetReverseStencil </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reverse the stencil.
</div>
</div><p>
<a class="anchor" name="6dfe5280aad306b80c80c05aa4bc97a0"></a><!-- doxytag: member="vtkImageStencil::SetBackgroundInput" ref="6dfe5280aad306b80c80c05aa4bc97a0" args="(vtkImageData *input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::SetBackgroundInput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> * </td>
<td class="paramname"> <em>input</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
NOTE: Not yet implemented, use SetBackgroundValue instead. Set the second input. This image will be used for the 'outside' of the stencil. If not set, the output voxels will be filled with BackgroundValue instead.
</div>
</div><p>
<a class="anchor" name="7756d5d3a23c52356f014441360e1ee2"></a><!-- doxytag: member="vtkImageStencil::GetBackgroundInput" ref="7756d5d3a23c52356f014441360e1ee2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00751.html">vtkImageData</a>* vtkImageStencil::GetBackgroundInput </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
NOTE: Not yet implemented, use SetBackgroundValue instead. Set the second input. This image will be used for the 'outside' of the stencil. If not set, the output voxels will be filled with BackgroundValue instead.
</div>
</div><p>
<a class="anchor" name="876de4e9e8faeab5fe05dbe6ebbae409"></a><!-- doxytag: member="vtkImageStencil::SetBackgroundValue" ref="876de4e9e8faeab5fe05dbe6ebbae409" args="(double val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkImageStencil::SetBackgroundValue </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>val</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default output value to use when the second input is not set.
<p>Definition at line <a class="el" href="a04753.html#l00064">64</a> of file <a class="el" href="a04753.html">vtkImageStencil.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5bf415e82f11c6adeaccc17708611946"></a><!-- doxytag: member="vtkImageStencil::GetBackgroundValue" ref="5bf415e82f11c6adeaccc17708611946" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double vtkImageStencil::GetBackgroundValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default output value to use when the second input is not set.
<p>Definition at line <a class="el" href="a04753.html#l00066">66</a> of file <a class="el" href="a04753.html">vtkImageStencil.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7e1e861d684c1af81d82ecd71fd00560"></a><!-- doxytag: member="vtkImageStencil::SetBackgroundColor" ref="7e1e861d684c1af81d82ecd71fd00560" args="(double, double, double, double)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::SetBackgroundColor </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.
</div>
</div><p>
<a class="anchor" name="af219a1358f310e9ca5521b34cb89e29"></a><!-- doxytag: member="vtkImageStencil::SetBackgroundColor" ref="af219a1358f310e9ca5521b34cb89e29" args="(double[4])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::SetBackgroundColor </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname">[4] </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.
</div>
</div><p>
<a class="anchor" name="de4f1a4e28332b9df2f00e2c14acadb1"></a><!-- doxytag: member="vtkImageStencil::GetBackgroundColor" ref="de4f1a4e28332b9df2f00e2c14acadb1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double* vtkImageStencil::GetBackgroundColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.
</div>
</div><p>
<a class="anchor" name="a91062191aa77c4c63e037db6527be56"></a><!-- doxytag: member="vtkImageStencil::GetBackgroundColor" ref="a91062191aa77c4c63e037db6527be56" args="(double &, double &, double &, double &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::GetBackgroundColor </td>
<td>(</td>
<td class="paramtype">double & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.
</div>
</div><p>
<a class="anchor" name="a4f4224918f1a930208e9f7700dd7dcd"></a><!-- doxytag: member="vtkImageStencil::GetBackgroundColor" ref="a4f4224918f1a930208e9f7700dd7dcd" args="(double[4])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkImageStencil::GetBackgroundColor </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname">[4] </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.
</div>
</div><p>
<a class="anchor" name="e1f059a5474457151dd370dc4f437b31"></a><!-- doxytag: member="vtkImageStencil::RequestInformation" ref="e1f059a5474457151dd370dc4f437b31" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkImageStencil::RequestInformation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> ** </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> * </td>
<td class="paramname"></td><td> </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#b739abd84881f7e31a8a382bf5a06a91">vtkImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="e0e02e6f09887acb91ece5aa32011db9"></a><!-- doxytag: member="vtkImageStencil::ThreadedRequestData" ref="e0e02e6f09887acb91ece5aa32011db9" args="(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkImageStencil::ThreadedRequestData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </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> ** </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> * </td>
<td class="paramname"> <em>outputVector</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *** </td>
<td class="paramname"> <em>inData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> ** </td>
<td class="paramname"> <em>outData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>extent</em>[6], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>threadId</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.
<p>Reimplemented from <a class="el" href="a01705.html#dda52b8ad4b703ee11c76b916accbb42">vtkThreadedImageAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="010eb17b94452a2efacd6430a53e76fe"></a><!-- doxytag: member="vtkImageStencil::FillInputPortInformation" ref="010eb17b94452a2efacd6430a53e76fe" args="(int, vtkInformation *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkImageStencil::FillInputPortInformation </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td>
<td class="paramname"> <em>info</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
<p>Reimplemented from <a class="el" href="a00727.html#7abefdbb585c2e27ebc314c894c87f74">vtkImageAlgorithm</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="04dd43cc650a94b8c183e5df55dafbaf"></a><!-- doxytag: member="vtkImageStencil::ReverseStencil" ref="04dd43cc650a94b8c183e5df55dafbaf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00835.html#04dd43cc650a94b8c183e5df55dafbaf">vtkImageStencil::ReverseStencil</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04753.html#l00089">89</a> of file <a class="el" href="a04753.html">vtkImageStencil.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8d9766437098eee09ecee095791bba4b"></a><!-- doxytag: member="vtkImageStencil::BackgroundColor" ref="8d9766437098eee09ecee095791bba4b" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="a00835.html#8d9766437098eee09ecee095791bba4b">vtkImageStencil::BackgroundColor</a>[4]<code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04753.html#l00090">90</a> of file <a class="el" href="a04753.html">vtkImageStencil.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Imaging/<a class="el" href="a04753.html">vtkImageStencil.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:11:17 2009 for VTK by
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
838
