<!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: vtkBlankStructuredGridWithImage 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>vtkBlankStructuredGridWithImage Class Reference</h1><!-- doxytag: class="vtkBlankStructuredGridWithImage" --><!-- doxytag: inherits="vtkStructuredGridAlgorithm" --><code>#include <<a class="el" href="a04264.html">vtkBlankStructuredGridWithImage.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkBlankStructuredGridWithImage:</div>
<div class="dynsection">
<p><center><img src="a08153.png" border="0" usemap="#a08154" alt="Inheritance graph"></center>
<map name="a08154">
<area shape="rect" href="a01626.html" title="Superclass for algorithms that produce only structured grid as output." alt="" coords="27,229,213,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="71,155,169,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="80,80,160,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="65,5,175,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkBlankStructuredGridWithImage:</div>
<div class="dynsection">
<p><center><img src="a08155.png" border="0" usemap="#a08156" alt="Collaboration graph"></center>
<map name="a08156">
<area shape="rect" href="a01626.html" title="Superclass for algorithms that produce only structured grid as output." alt="" coords="157,499,344,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="a08157.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
blank a structured grid with an image
<p>
This filter can be used to set the blanking in a structured grid with an image. The filter takes two inputs: the structured grid to blank, and the image used to set the blanking. Make sure that the dimensions of both the image and the structured grid are identical.<p>
Note that the image is interpreted as follows: zero values indicate that the structured grid point is blanked; non-zero values indicate that the structured grid point is visible. The blanking data must be unsigned char.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01625.html" title="topologically regular array of data">vtkStructuredGrid</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_2.html#c2_vtk_t_vtkBlankStructuredGridWithImage">vtkBlankStructuredGridWithImage (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a04264.html#l00041">41</a> of file <a class="el" href="a04264.html">vtkBlankStructuredGridWithImage.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="a01626.html">vtkStructuredGridAlgorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#6ff71a41530bb7109054731c965d22aa">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="a00175.html#796dc325640159c3291fd68e21f4fb4a">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="a00175.html#8f03aafdb0757ab1a1f4e2bf20f2b207">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="a00175.html#ec4d1682a6ac7a9c3fb674ec2b2495de">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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#f661dbf5f5cf5c443f79c4c63b24f5a1">SetBlankingInput</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="a00175.html#2adbd9bce6d8b221fe432580bb14c48b">GetBlankingInput</a> ()</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 <br>
<a class="el" href="a00175.html">vtkBlankStructuredGridWithImage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#e5dff7cee29d2473a3c4288972473b27">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="a00175.html#6e00489b2fbff7da0d8f246938b76fb9">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
<a class="el" href="a00175.html">vtkBlankStructuredGridWithImage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#193eb19e5c200b14001bbd1f97d18f19">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="a00175.html#000c240fd09ec61fea441f2d0cb75abc">vtkBlankStructuredGridWithImage</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#949fc16833cfa4b05545442434fcf9b3">~vtkBlankStructuredGridWithImage</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#d95a560600096f3958d5789e74eb9580">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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html#f6e9b55f7c4d3ed9f9dc48f9da8e4315">FillInputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="6ff71a41530bb7109054731c965d22aa"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::Superclass" ref="6ff71a41530bb7109054731c965d22aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01626.html">vtkStructuredGridAlgorithm</a> <a class="el" href="a01626.html">vtkBlankStructuredGridWithImage::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01626.html#25937393e0d712c65fdae1a67fc54597">vtkStructuredGridAlgorithm</a>.</p>
<p>Definition at line <a class="el" href="a04264.html#l00045">45</a> of file <a class="el" href="a04264.html">vtkBlankStructuredGridWithImage.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="000c240fd09ec61fea441f2d0cb75abc"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::vtkBlankStructuredGridWithImage" ref="000c240fd09ec61fea441f2d0cb75abc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkBlankStructuredGridWithImage::vtkBlankStructuredGridWithImage </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="949fc16833cfa4b05545442434fcf9b3"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::~vtkBlankStructuredGridWithImage" ref="949fc16833cfa4b05545442434fcf9b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkBlankStructuredGridWithImage::~vtkBlankStructuredGridWithImage </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="e5dff7cee29d2473a3c4288972473b27"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::New" ref="e5dff7cee29d2473a3c4288972473b27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00175.html">vtkBlankStructuredGridWithImage</a>* vtkBlankStructuredGridWithImage::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="a01626.html#b585230d0911886cf2f27a20c84df56e">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="796dc325640159c3291fd68e21f4fb4a"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::GetClassName" ref="796dc325640159c3291fd68e21f4fb4a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkBlankStructuredGridWithImage::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="a01626.html#3ff0b601659b48f362994ee3ae172954">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="6e00489b2fbff7da0d8f246938b76fb9"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::IsTypeOf" ref="6e00489b2fbff7da0d8f246938b76fb9" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkBlankStructuredGridWithImage::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="a01626.html#4025c487957666b70bd424c9e933e7d6">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f03aafdb0757ab1a1f4e2bf20f2b207"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::IsA" ref="8f03aafdb0757ab1a1f4e2bf20f2b207" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkBlankStructuredGridWithImage::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="a01626.html#4b33ad053c13b76302ce1be43b4ef2ee">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="193eb19e5c200b14001bbd1f97d18f19"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::SafeDownCast" ref="193eb19e5c200b14001bbd1f97d18f19" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00175.html">vtkBlankStructuredGridWithImage</a>* vtkBlankStructuredGridWithImage::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="a01626.html#209a2186ba445942b6bb9183ecfd7aae">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="ec4d1682a6ac7a9c3fb674ec2b2495de"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::PrintSelf" ref="ec4d1682a6ac7a9c3fb674ec2b2495de" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBlankStructuredGridWithImage::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="a01626.html#d465827e27c818ec1d3a71bf6e4ec2c0">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="f661dbf5f5cf5c443f79c4c63b24f5a1"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::SetBlankingInput" ref="f661dbf5f5cf5c443f79c4c63b24f5a1" args="(vtkImageData *input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBlankStructuredGridWithImage::SetBlankingInput </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set / get the input image used to perform the blanking.
</div>
</div><p>
<a class="anchor" name="2adbd9bce6d8b221fe432580bb14c48b"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::GetBlankingInput" ref="2adbd9bce6d8b221fe432580bb14c48b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00751.html">vtkImageData</a>* vtkBlankStructuredGridWithImage::GetBlankingInput </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set / get the input image used to perform the blanking.
</div>
</div><p>
<a class="anchor" name="d95a560600096f3958d5789e74eb9580"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::RequestData" ref="d95a560600096f3958d5789e74eb9580" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkBlankStructuredGridWithImage::RequestData </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><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>
This is called by the superclass. This is the method you should override.
<p>Reimplemented from <a class="el" href="a01626.html#94d912ed6484e2afa5d1109c3ef1e810">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="f6e9b55f7c4d3ed9f9dc48f9da8e4315"></a><!-- doxytag: member="vtkBlankStructuredGridWithImage::FillInputPortInformation" ref="f6e9b55f7c4d3ed9f9dc48f9da8e4315" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkBlankStructuredGridWithImage::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="a01626.html#965ffc28342094c402740675a2d908e8">vtkStructuredGridAlgorithm</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Graphics/<a class="el" href="a04264.html">vtkBlankStructuredGridWithImage.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:54:19 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
>
178
