---

vtkBMPReader Class Reference

read Windows BMP files. More...

#include <vtkBMPReader.h>

Inheritance diagram for vtkBMPReader:

[legend]Collaboration diagram for vtkBMPReader:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetDepth ()
virtual unsigned char *	GetColors ()
Static Public Methods
vtkBMPReader *	New ()
int	IsTypeOf (const char *type)
vtkBMPReader *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkBMPReader ()
	~vtkBMPReader ()
	vtkBMPReader (const vtkBMPReader &)
void	operator= (const vtkBMPReader &)
virtual void	ComputeDataIncrements ()
virtual void	ExecuteInformation ()
virtual void	Execute (vtkImageData *out)
void	Execute ()
Protected Attributes
unsigned char *	Colors
short	Depth

---

Detailed Description

read Windows BMP files.

Date:

2000/12/10 20:09:02

Revision:

1.17

vtkBMPReader is a source object that reads Windows BMP files. This includes indexed and 24bit bitmaps

BMPReader 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 image range. This range specifies the beginning and ending files to read (range can be any pair of non-negative numbers).

The default behavior is to read a single file. In this case, the form of the file is simply "FileName" (e.g., foo.bar, foo.ppm, foo.BMP).

See also:

vtkBMPWriter

Examples:

vtkBMPReader (examples)

Definition at line 74 of file vtkBMPReader.h.

---

Constructor & Destructor Documentation

vtkBMPReader::vtkBMPReader (    )  [protected]

vtkBMPReader::~vtkBMPReader (    )  [protected]

vtkBMPReader::vtkBMPReader (  const vtkBMPReader &    )  [inline, protected]

Definition at line 93 of file vtkBMPReader.h.

---

Member Function Documentation

vtkBMPReader* vtkBMPReader::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageReader.

virtual const char* vtkBMPReader::GetClassName (    )  [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageReader.

int vtkBMPReader::IsTypeOf (  const char *    type )  [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 vtkBMPReader::IsA (  const char *    type )  [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.

vtkBMPReader* vtkBMPReader::SafeDownCast (  vtkObject *    o )  [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageReader.

void vtkBMPReader::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.

virtual int vtkBMPReader::GetDepth (    )  [virtual]

Returns the depth of the BMP, either 8 or 24.

virtual unsigned char* vtkBMPReader::GetColors (    )  [virtual]

Returns the color lut.

void vtkBMPReader::operator= (  const vtkBMPReader &    )  [inline, protected]

Definition at line 94 of file vtkBMPReader.h.

virtual void vtkBMPReader::ComputeDataIncrements (    )  [protected, virtual]

Reimplemented from vtkImageReader.

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

Reimplemented from vtkImageReader.

virtual void vtkBMPReader::Execute (  vtkImageData *    out )  [protected, virtual]

Reimplemented from vtkImageReader.

void vtkBMPReader::Execute (    )  [inline, protected, virtual]

Reimplemented from vtkImageReader. Definition at line 102 of file vtkBMPReader.h.

---

Member Data Documentation

unsigned char* vtkBMPReader::Colors [protected]

Definition at line 96 of file vtkBMPReader.h.

short vtkBMPReader::Depth [protected]

Definition at line 97 of file vtkBMPReader.h.

---

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

• imaging/vtkBMPReader.h

---