VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkPNMReader Class Reference

read pnm (i.e., portable anymap) files More...

#include <vtkPNMReader.h>

Inheritance diagram for vtkPNMReader:
Inheritance graph
[legend]
Collaboration diagram for vtkPNMReader:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkImageReader Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPNMReaderNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
int CanReadFile (const char *fname)
virtual const char * GetFileExtensions ()
virtual const char * GetDescriptiveName ()

Static Public Member Functions

static vtkPNMReaderNew ()
static int IsTypeOf (const char *type)
static vtkPNMReaderSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPNMReader ()
 ~vtkPNMReader ()
void ExecuteInformation ()

Detailed Description

read pnm (i.e., portable anymap) files

vtkPNMReader 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.)

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.

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.

Examples:
vtkPNMReader (Examples)
Tests:
vtkPNMReader (Tests)

Definition at line 46 of file vtkPNMReader.h.


Member Typedef Documentation

Reimplemented from vtkImageReader.

Definition at line 50 of file vtkPNMReader.h.


Constructor & Destructor Documentation

vtkPNMReader::vtkPNMReader ( ) [inline, protected]

Definition at line 71 of file vtkPNMReader.h.

vtkPNMReader::~vtkPNMReader ( ) [inline, protected]

Definition at line 72 of file vtkPNMReader.h.


Member Function Documentation

static vtkPNMReader* vtkPNMReader::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkImageReader.

static int vtkPNMReader::IsTypeOf ( const char *  name) [static]

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageReader.

virtual int vtkPNMReader::IsA ( const char *  name) [virtual]

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageReader.

Reimplemented from vtkImageReader.

virtual vtkObjectBase* vtkPNMReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImageReader.

Reimplemented from vtkImageReader.

virtual void vtkPNMReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageReader.

int vtkPNMReader::CanReadFile ( const char *  fname)
virtual const char* vtkPNMReader::GetFileExtensions ( ) [inline, virtual]

.pnm .pgm .ppm

Reimplemented from vtkImageReader2.

Definition at line 56 of file vtkPNMReader.h.

virtual const char* vtkPNMReader::GetDescriptiveName ( ) [inline, virtual]

PNM

Reimplemented from vtkImageReader2.

Definition at line 64 of file vtkPNMReader.h.

void vtkPNMReader::ExecuteInformation ( ) [protected, virtual]

Reimplemented from vtkImageReader2.


The documentation for this class was generated from the following file: