<!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: vtkPImageWriter 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>vtkPImageWriter Class Reference</h1><!-- doxytag: class="vtkPImageWriter" --><!-- doxytag: inherits="vtkImageWriter" --><code>#include <<a class="el" href="a05117.html">vtkPImageWriter.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkPImageWriter:</div>
<div class="dynsection">
<p><center><img src="a13010.png" border="0" usemap="#a13011" alt="Inheritance graph"></center>
<map name="a13011">
<area shape="rect" href="a00851.html" title="Writes images to files." alt="" coords="16,304,131,331"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="6,230,142,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="24,155,123,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="34,80,114,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="19,6,128,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkPImageWriter:</div>
<div class="dynsection">
<p><center><img src="a13012.png" border="0" usemap="#a13013" alt="Collaboration graph"></center>
<map name="a13013">
<area shape="rect" href="a00851.html" title="Writes images to files." alt="" coords="531,576,646,603"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="192,499,328,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="247,381,346,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="396,499,495,525"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="460,173,540,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="426,264,575,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="180,264,290,291"><area shape="rect" href="a01220.html" title="compute the memory required by a pipeline" alt="" coords="744,317,859,344"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="238,5,347,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="211,173,374,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="227,83,358,109"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="382,83,491,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="6,173,187,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a13014.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Writes images to files.
<p>
<a class="el" href="a01219.html" title="Writes images to files.">vtkPImageWriter</a> writes images to files with any data type. The data type of the file is the same scalar type as the input. The dimensionality determines whether the data will be written in one or multiple files. This class is used as the superclass of most image writing classes such as <a class="el" href="a00179.html" title="Writes Windows BMP files.">vtkBMPWriter</a> etc. It supports streaming.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkPImageWriter">vtkPImageWriter (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a05117.html#l00034">34</a> of file <a class="el" href="a05117.html">vtkPImageWriter.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="a00851.html">vtkImageWriter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#62dfcec97267693a85bb8b88500f47a2">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="a01219.html#1b9279cb226403256134946dd4975d2e">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="a01219.html#16a93d94f6abb81ffbefe211b4d24594">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="a01219.html#6918c216c778909a0a5bad4bb422e6d7">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="a01219.html#b01687c37fb9ef77e726df57afc1e3a8">SetMemoryLimit</a> (unsigned long)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#70a62f39aa5a2b9cf32562431f43c3e9">GetMemoryLimit</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 <a class="el" href="a01219.html">vtkPImageWriter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#ba680db9cc36942edf310150887c44aa">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="a01219.html#94393f4d753ac9049409ae307c72c1ea">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01219.html">vtkPImageWriter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#63658511baad7d6ab37edd22435abdbe">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="a01219.html#f95caa3b3f2e6f437582cf0177e2a717">vtkPImageWriter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#8a9a125ec143a022fc5cf7ebaae7e11b">~vtkPImageWriter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#a70cdae2e9f05fc3b09cf411b714b179">RecursiveWrite</a> (int dim, <a class="el" href="a00751.html">vtkImageData</a> *region, ofstream *file)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#5e247b6fc95242705c7eaa2c0f53c98a">RecursiveWrite</a> (int dim, <a class="el" href="a00751.html">vtkImageData</a> *cache, <a class="el" href="a00751.html">vtkImageData</a> *data, ofstream *file)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#f19a76573045503451adcc58ed37b5e3">MemoryLimit</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01220.html">vtkPipelineSize</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01219.html#25edcf6280028fd1830f189af9b33cab">SizeEstimator</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="62dfcec97267693a85bb8b88500f47a2"></a><!-- doxytag: member="vtkPImageWriter::Superclass" ref="62dfcec97267693a85bb8b88500f47a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00851.html">vtkImageWriter</a> <a class="el" href="a00851.html">vtkPImageWriter::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00851.html#d46fb666d388feb51154e5f89f8db802">vtkImageWriter</a>.</p>
<p>Definition at line <a class="el" href="a05117.html#l00038">38</a> of file <a class="el" href="a05117.html">vtkPImageWriter.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f95caa3b3f2e6f437582cf0177e2a717"></a><!-- doxytag: member="vtkPImageWriter::vtkPImageWriter" ref="f95caa3b3f2e6f437582cf0177e2a717" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPImageWriter::vtkPImageWriter </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="8a9a125ec143a022fc5cf7ebaae7e11b"></a><!-- doxytag: member="vtkPImageWriter::~vtkPImageWriter" ref="8a9a125ec143a022fc5cf7ebaae7e11b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPImageWriter::~vtkPImageWriter </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="ba680db9cc36942edf310150887c44aa"></a><!-- doxytag: member="vtkPImageWriter::New" ref="ba680db9cc36942edf310150887c44aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01219.html">vtkPImageWriter</a>* vtkPImageWriter::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="a00851.html#5114cbf67bc22e348935cf2b682540f8">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="1b9279cb226403256134946dd4975d2e"></a><!-- doxytag: member="vtkPImageWriter::GetClassName" ref="1b9279cb226403256134946dd4975d2e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkPImageWriter::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="a00851.html#86a176a5502bab7d009b1f2f70bdfe77">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="94393f4d753ac9049409ae307c72c1ea"></a><!-- doxytag: member="vtkPImageWriter::IsTypeOf" ref="94393f4d753ac9049409ae307c72c1ea" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkPImageWriter::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="a00851.html#1e0f8d99e62e4a9754b7f08a34f50f21">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="16a93d94f6abb81ffbefe211b4d24594"></a><!-- doxytag: member="vtkPImageWriter::IsA" ref="16a93d94f6abb81ffbefe211b4d24594" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkPImageWriter::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="a00851.html#74ee6ec43cb11c5fe41c8837e9588001">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="63658511baad7d6ab37edd22435abdbe"></a><!-- doxytag: member="vtkPImageWriter::SafeDownCast" ref="63658511baad7d6ab37edd22435abdbe" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01219.html">vtkPImageWriter</a>* vtkPImageWriter::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="a00851.html#e98e39d577982a7247c42e8d8cbbf2e5">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="6918c216c778909a0a5bad4bb422e6d7"></a><!-- doxytag: member="vtkPImageWriter::PrintSelf" ref="6918c216c778909a0a5bad4bb422e6d7" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPImageWriter::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="a00851.html#9af63bfc6f3d3f46be94ac4e57478447">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="b01687c37fb9ef77e726df57afc1e3a8"></a><!-- doxytag: member="vtkPImageWriter::SetMemoryLimit" ref="b01687c37fb9ef77e726df57afc1e3a8" args="(unsigned long)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPImageWriter::SetMemoryLimit </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>long</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set / Get the memory limit in kilobytes. The writer will stream to attempt to keep the pipeline size within this limit
</div>
</div><p>
<a class="anchor" name="70a62f39aa5a2b9cf32562431f43c3e9"></a><!-- doxytag: member="vtkPImageWriter::GetMemoryLimit" ref="70a62f39aa5a2b9cf32562431f43c3e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned long vtkPImageWriter::GetMemoryLimit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set / Get the memory limit in kilobytes. The writer will stream to attempt to keep the pipeline size within this limit
</div>
</div><p>
<a class="anchor" name="a70cdae2e9f05fc3b09cf411b714b179"></a><!-- doxytag: member="vtkPImageWriter::RecursiveWrite" ref="a70cdae2e9f05fc3b09cf411b714b179" args="(int dim, vtkImageData *region, ofstream *file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPImageWriter::RecursiveWrite </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>dim</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>region</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ofstream * </td>
<td class="paramname"> <em>file</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>
<p>Reimplemented from <a class="el" href="a00851.html#97a30fe0603c99a5c11385a29a134a57">vtkImageWriter</a>.</p>
</div>
</div><p>
<a class="anchor" name="5e247b6fc95242705c7eaa2c0f53c98a"></a><!-- doxytag: member="vtkPImageWriter::RecursiveWrite" ref="5e247b6fc95242705c7eaa2c0f53c98a" args="(int dim, vtkImageData *cache, vtkImageData *data, ofstream *file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPImageWriter::RecursiveWrite </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>dim</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>cache</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>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ofstream * </td>
<td class="paramname"> <em>file</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00851.html#cefe6a67be64f2bcc16c3ee7adf58fed">vtkImageWriter</a>.</p>
<p>Definition at line <a class="el" href="a05117.html#l00055">55</a> of file <a class="el" href="a05117.html">vtkPImageWriter.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f19a76573045503451adcc58ed37b5e3"></a><!-- doxytag: member="vtkPImageWriter::MemoryLimit" ref="f19a76573045503451adcc58ed37b5e3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long <a class="el" href="a01219.html#f19a76573045503451adcc58ed37b5e3">vtkPImageWriter::MemoryLimit</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05117.html#l00052">52</a> of file <a class="el" href="a05117.html">vtkPImageWriter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="25edcf6280028fd1830f189af9b33cab"></a><!-- doxytag: member="vtkPImageWriter::SizeEstimator" ref="25edcf6280028fd1830f189af9b33cab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01220.html">vtkPipelineSize</a>* <a class="el" href="a01219.html#25edcf6280028fd1830f189af9b33cab">vtkPImageWriter::SizeEstimator</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05117.html#l00057">57</a> of file <a class="el" href="a05117.html">vtkPImageWriter.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Parallel/<a class="el" href="a05117.html">vtkPImageWriter.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:24:01 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
>
1222
