<!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: vtkPNMReader 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>vtkPNMReader Class Reference</h1><!-- doxytag: class="vtkPNMReader" --><!-- doxytag: inherits="vtkImageReader" --><code>#include <<a class="el" href="a04966.html">vtkPNMReader.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkPNMReader:</div>
<div class="dynsection">
<p><center><img src="a13115.png" border="0" usemap="#a13116" alt="Inheritance graph"></center>
<map name="a13116">
<area shape="rect" href="a00814.html" title="Superclass of transformable binary file readers." alt="" coords="12,379,135,405"><area shape="rect" href="a00815.html" title="Superclass of binary file readers." alt="" coords="8,304,139,331"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="6,229,142,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="24,155,123,181"><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,5,128,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkPNMReader:</div>
<div class="dynsection">
<p><center><img src="a13117.png" border="0" usemap="#a13118" alt="Collaboration graph"></center>
<map name="a13118">
<area shape="rect" href="a00814.html" title="Superclass of transformable binary file readers." alt="" coords="2254,293,2376,320"><area shape="rect" href="a00815.html" title="Superclass of binary file readers." alt="" coords="1776,139,1907,165"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="1439,139,1575,165"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="1074,185,1172,212"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="1458,256,1556,283"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="444,260,524,287"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="710,260,859,287"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="730,61,839,88"><area shape="rect" href="a00081.html" title="Abstract superclass for all arrays." alt="" coords="1062,48,1184,75"><area shape="rect" href="a00089.html" title="superclass for all geometric transformations" alt="" coords="708,500,860,527"><area shape="rect" href="a00998.html" title="represent and manipulate 4x4 transformation matrices" alt="" coords="1074,389,1172,416"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="7,79,116,105"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="403,15,566,41"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="170,79,300,105"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="180,316,290,343"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="394,80,575,107"><area shape="rect" href="a01619.html" title="Subclass of vtkAbstractArray that holds vtkStdStrings." alt="" coords="1452,88,1562,115"><area shape="rect" href="a01607.html" title="Wrapper around vtkstd::string to keep symbols short." alt="" coords="1075,99,1171,125"><area shape="rect" href="a01723.html" title="describes linear transformations via a 4x4 matrix" alt="" coords="2038,419,2142,445"><area shape="rect" href="a00964.html" title="abstract superclass for linear transformations" alt="" coords="1771,387,1912,413"><area shape="rect" href="a00696.html" title="superclass for homogeneous transformations" alt="" coords="1411,387,1603,413"><area shape="rect" href="a01725.html" title="vtkTransformConcatenation" alt="" coords="1411,513,1603,540"><area shape="rect" href="a01730.html" title="vtkTransformPair" alt="" coords="1059,532,1187,559"><area shape="rect" href="a01548.html" title="vtkSimpleCriticalSection" alt="" coords="400,517,568,544"><area shape="rect" href="a01726.html" title="vtkTransformConcatenationStack" alt="" coords="1730,513,1954,540"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a13119.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
read pnm (i.e., portable anymap) files
<p>
<a class="el" href="a01240.html" title="read pnm (i.e., portable anymap) files">vtkPNMReader</a> is a source object that reads pnm (portable anymap) files. This includes .pbm (bitmap), .pgm (grayscale), and .ppm (pixmap) files. (Currently this object only reads binary versions of these files.)<p>
PNMReader creates structured point datasets. The dimension of the dataset depends upon the number of files read. Reading a single file results in a 2D image, while reading more than one file results in a 3D volume.<p>
To read a volume, files must be of the form "FileName.<number>" (e.g., foo.ppm.0, foo.ppm.1, ...). You must also specify the DataExtent. The fifth and sixth values of the DataExtent specify the beginning and ending files to read.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkPNMReader">vtkPNMReader (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a04966.html#l00042">42</a> of file <a class="el" href="a04966.html">vtkPNMReader.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="a00814.html">vtkImageReader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#4761c10325ba5648dea9f06a01de6e5e">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="a01240.html#d73e757c0e4d3beb8f5604ed1ab8f1ba">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="a01240.html#14c6c5634308d5d7c537428655c93cad">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#a3dd92db2f5205fa197532fede0721f3">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#d43b88f7cf5e4ff245c2c55f2aecf4a9">CanReadFile</a> (const char *fname)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#0bd28fc660250c8a4bb82c137a5e3f9d">GetFileExtensions</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#a28c4fd509b277a5b94f330299179a0f">GetDescriptiveName</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="a01240.html">vtkPNMReader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#59e4e847777cea9d1d9020cc3a705d76">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="a01240.html#7264cfa7edcd5bb50a976f63bfd4328f">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01240.html">vtkPNMReader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#b636d21338817447c3da1c4bcda994cf">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="a01240.html#fe76b47792e1878ba9541780454bf713">vtkPNMReader</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#47b5389063394b647c347a622fbafbbc">~vtkPNMReader</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01240.html#1484e56be8c90fc7ec06ae25d51c9415">ExecuteInformation</a> ()</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="4761c10325ba5648dea9f06a01de6e5e"></a><!-- doxytag: member="vtkPNMReader::Superclass" ref="4761c10325ba5648dea9f06a01de6e5e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00814.html">vtkImageReader</a> <a class="el" href="a00814.html">vtkPNMReader::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00814.html#25bde6f2d670b1876b279d53a08d7931">vtkImageReader</a>.</p>
<p>Definition at line <a class="el" href="a04966.html#l00046">46</a> of file <a class="el" href="a04966.html">vtkPNMReader.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="fe76b47792e1878ba9541780454bf713"></a><!-- doxytag: member="vtkPNMReader::vtkPNMReader" ref="fe76b47792e1878ba9541780454bf713" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPNMReader::vtkPNMReader </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04966.html#l00067">67</a> of file <a class="el" href="a04966.html">vtkPNMReader.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="47b5389063394b647c347a622fbafbbc"></a><!-- doxytag: member="vtkPNMReader::~vtkPNMReader" ref="47b5389063394b647c347a622fbafbbc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPNMReader::~vtkPNMReader </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04966.html#l00068">68</a> of file <a class="el" href="a04966.html">vtkPNMReader.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="59e4e847777cea9d1d9020cc3a705d76"></a><!-- doxytag: member="vtkPNMReader::New" ref="59e4e847777cea9d1d9020cc3a705d76" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01240.html">vtkPNMReader</a>* vtkPNMReader::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="a00814.html#46becf317d2382c3852b4f496bb76050">vtkImageReader</a>.</p>
</div>
</div><p>
<a class="anchor" name="d73e757c0e4d3beb8f5604ed1ab8f1ba"></a><!-- doxytag: member="vtkPNMReader::GetClassName" ref="d73e757c0e4d3beb8f5604ed1ab8f1ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkPNMReader::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="a00814.html#0b5bcb65428e5ab1ca5e82e899abc8a6">vtkImageReader</a>.</p>
</div>
</div><p>
<a class="anchor" name="7264cfa7edcd5bb50a976f63bfd4328f"></a><!-- doxytag: member="vtkPNMReader::IsTypeOf" ref="7264cfa7edcd5bb50a976f63bfd4328f" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkPNMReader::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="a00814.html#5d7f18684d6b94dcd85d9358571942cb">vtkImageReader</a>.</p>
</div>
</div><p>
<a class="anchor" name="14c6c5634308d5d7c537428655c93cad"></a><!-- doxytag: member="vtkPNMReader::IsA" ref="14c6c5634308d5d7c537428655c93cad" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkPNMReader::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="a00814.html#f898660c2966ba0508f06d7ffa713394">vtkImageReader</a>.</p>
</div>
</div><p>
<a class="anchor" name="b636d21338817447c3da1c4bcda994cf"></a><!-- doxytag: member="vtkPNMReader::SafeDownCast" ref="b636d21338817447c3da1c4bcda994cf" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01240.html">vtkPNMReader</a>* vtkPNMReader::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="a00814.html#b231b61350bf9e5402336afef9897c92">vtkImageReader</a>.</p>
</div>
</div><p>
<a class="anchor" name="a3dd92db2f5205fa197532fede0721f3"></a><!-- doxytag: member="vtkPNMReader::PrintSelf" ref="a3dd92db2f5205fa197532fede0721f3" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPNMReader::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="a00814.html#2e4cf49c97c10701ca9938ac802b9d96">vtkImageReader</a>.</p>
</div>
</div><p>
<a class="anchor" name="d43b88f7cf5e4ff245c2c55f2aecf4a9"></a><!-- doxytag: member="vtkPNMReader::CanReadFile" ref="d43b88f7cf5e4ff245c2c55f2aecf4a9" args="(const char *fname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkPNMReader::CanReadFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>fname</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0bd28fc660250c8a4bb82c137a5e3f9d"></a><!-- doxytag: member="vtkPNMReader::GetFileExtensions" ref="0bd28fc660250c8a4bb82c137a5e3f9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkPNMReader::GetFileExtensions </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
.pnm .pgm .ppm
<p>Reimplemented from <a class="el" href="a00815.html#2846943a7802b3a62df51e0936542abb">vtkImageReader2</a>.</p>
<p>Definition at line <a class="el" href="a04966.html#l00052">52</a> of file <a class="el" href="a04966.html">vtkPNMReader.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a28c4fd509b277a5b94f330299179a0f"></a><!-- doxytag: member="vtkPNMReader::GetDescriptiveName" ref="a28c4fd509b277a5b94f330299179a0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkPNMReader::GetDescriptiveName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
PNM
<p>Reimplemented from <a class="el" href="a00815.html#e83ebabf18c670a314bb32eb50371f61">vtkImageReader2</a>.</p>
<p>Definition at line <a class="el" href="a04966.html#l00060">60</a> of file <a class="el" href="a04966.html">vtkPNMReader.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="1484e56be8c90fc7ec06ae25d51c9415"></a><!-- doxytag: member="vtkPNMReader::ExecuteInformation" ref="1484e56be8c90fc7ec06ae25d51c9415" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPNMReader::ExecuteInformation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00815.html#e31d4865f47029d0a63da3716bae2305">vtkImageReader2</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/IO/<a class="el" href="a04966.html">vtkPNMReader.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:24:42 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
>
1243
