vtkBMPReader Class Reference

#include <vtkBMPReader.h>

Inheritance diagram for vtkBMPReader:

[legend]Collaboration diagram for vtkBMPReader:

[legend]List of all members.

---

Detailed Description

read Windows BMP files

vtkBMPReader is a source object that reads Windows BMP files. This includes indexed and 24bit bitmaps Usually, all BMPs are converted to 24bit RGB, but BMPs may be output as 8bit images with a LookupTable if the Allow8BitBMP flag is set.

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.bmp.0, foo.bmp.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.bmp).

See also:

vtkBMPWriter

Examples:

vtkBMPReader (Examples)

Tests:

vtkBMPReader (Tests)

Definition at line 52 of file vtkBMPReader.h.

Public Types
typedef vtkImageReader	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetDepth ()
virtual int	CanReadFile (const char *fname)
virtual const char *	GetFileExtensions ()
virtual const char *	GetDescriptiveName ()
virtual void	SetAllow8BitBMP (int)
virtual int	GetAllow8BitBMP ()
virtual void	Allow8BitBMPOn ()
virtual void	Allow8BitBMPOff ()
virtual vtkLookupTable *	GetLookupTable ()
virtual unsigned char *	GetColors ()
Static Public Member Functions
static vtkBMPReader *	New ()
static int	IsTypeOf (const char *type)
static vtkBMPReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkBMPReader ()
	~vtkBMPReader ()
virtual void	ComputeDataIncrements ()
virtual void	ExecuteInformation ()
virtual void	ExecuteData (vtkDataObject *out)
Protected Attributes
unsigned char *	Colors
short	Depth
int	Allow8BitBMP
vtkLookupTable *	LookupTable

---

Member Typedef Documentation

typedef vtkImageReader vtkBMPReader::Superclass

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

---

Constructor & Destructor Documentation

vtkBMPReader::vtkBMPReader (   )  [protected]

vtkBMPReader::~vtkBMPReader (   )  [protected]

---

Member Function Documentation

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

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

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

Reimplemented from vtkImageReader.

static 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkImageReader.

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

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 int vtkBMPReader::CanReadFile (  const char *  fname  )  [virtual]

virtual const char* vtkBMPReader::GetFileExtensions (   )  [inline, virtual]

Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension Reimplemented from vtkImageReader2. Definition at line 71 of file vtkBMPReader.h.

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

Return a descriptive name for the file format that might be useful in a GUI. Reimplemented from vtkImageReader2. Definition at line 80 of file vtkBMPReader.h.

virtual void vtkBMPReader::SetAllow8BitBMP (  int   )  [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported

virtual int vtkBMPReader::GetAllow8BitBMP (   )  [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported

virtual void vtkBMPReader::Allow8BitBMPOn (   )  [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported

virtual void vtkBMPReader::Allow8BitBMPOff (   )  [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported

virtual vtkLookupTable* vtkBMPReader::GetLookupTable (   )  [virtual]

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

Returns the color lut.

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

Reimplemented from vtkImageReader2.

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

Reimplemented from vtkImageReader2.

virtual void vtkBMPReader::ExecuteData (  vtkDataObject *  out  )  [protected, virtual]

This method is the old style execute method Reimplemented from vtkImageReader.

---

Member Data Documentation

unsigned char* vtkBMPReader::Colors [protected]

Definition at line 108 of file vtkBMPReader.h.

short vtkBMPReader::Depth [protected]

Definition at line 109 of file vtkBMPReader.h.

int vtkBMPReader::Allow8BitBMP [protected]

Definition at line 110 of file vtkBMPReader.h.

vtkLookupTable* vtkBMPReader::LookupTable [protected]

Definition at line 111 of file vtkBMPReader.h.

---

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

• dox/IO/vtkBMPReader.h

---