Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImageExport Class Reference

Writes images to files. More...

#include <vtkImageExport.h>

Inheritance diagram for vtkImageExport:

Inheritance graph
[legend]
Collaboration diagram for vtkImageExport:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int GetDataMemorySize ()
void GetDataDimensions (int *ptr)
int * GetDataDimensions ()
int GetDataNumberOfScalarComponents ()
int * GetDataExtent ()
void GetDataExtent (int *ptr)
float * GetDataSpacing ()
void GetDataSpacing (float *ptr)
float * GetDataOrigin ()
void GetDataOrigin (float *ptr)
int GetDataScalarType ()
void SetInput (vtkImageData *input)
vtkImageDataGetInput ()
virtual void ImageLowerLeftOn ()
virtual void ImageLowerLeftOff ()
virtual int GetImageLowerLeft ()
virtual void SetImageLowerLeft (int)
virtual void Export (void *)
void * GetPointerToData ()

Static Public Methods

vtkImageExport * New ()
int IsTypeOf (const char *type)
vtkImageExport * SafeDownCast (vtkObject *o)

Protected Methods

 vtkImageExport ()
 ~vtkImageExport ()
 vtkImageExport (const vtkImageExport &)
void operator= (const vtkImageExport &)

Protected Attributes

vtkImageFlipImageFlip
int ImageLowerLeft
int DataDimensions [3]

Detailed Description

Writes images to files.

Date:
2000/12/10 20:09:05
Revision:
1.20
Thanks:
Thanks to David G. Gobbi who developed this class.
vtkImageExport 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 vtkBMPExport etc. It supports streaming.
Examples:
vtkImageExport (examples)

Definition at line 64 of file vtkImageExport.h.


Constructor & Destructor Documentation

vtkImageExport::vtkImageExport   [protected]
 

vtkImageExport::~vtkImageExport   [protected]
 

vtkImageExport::vtkImageExport const vtkImageExport &    [inline, protected]
 

Definition at line 130 of file vtkImageExport.h.


Member Function Documentation

vtkImageExport* vtkImageExport::New   [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkProcessObject.

virtual const char* vtkImageExport::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 vtkProcessObject.

int vtkImageExport::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 vtkProcessObject.

virtual int vtkImageExport::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 vtkProcessObject.

vtkImageExport* vtkImageExport::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 vtkProcessObject.

void vtkImageExport::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 vtkProcessObject.

int vtkImageExport::GetDataMemorySize  
 

Get the number of bytes required (for safety checks, etc)

void vtkImageExport::GetDataDimensions int *    ptr
 

Get the (x,y,z) index dimensions of the data (warning: C arrays are indexed like this: array[z][y][x])

int* vtkImageExport::GetDataDimensions   [inline]
 

Definition at line 77 of file vtkImageExport.h.

int vtkImageExport::GetDataNumberOfScalarComponents   [inline]
 

Get the number of scalar components of the data

Definition at line 82 of file vtkImageExport.h.

int* vtkImageExport::GetDataExtent   [inline]
 

Get misc. information about the data

Definition at line 87 of file vtkImageExport.h.

void vtkImageExport::GetDataExtent int *    ptr [inline]
 

Definition at line 90 of file vtkImageExport.h.

float* vtkImageExport::GetDataSpacing   [inline]
 

Definition at line 93 of file vtkImageExport.h.

void vtkImageExport::GetDataSpacing float *    ptr [inline]
 

Definition at line 96 of file vtkImageExport.h.

float* vtkImageExport::GetDataOrigin   [inline]
 

Definition at line 99 of file vtkImageExport.h.

void vtkImageExport::GetDataOrigin float *    ptr [inline]
 

Definition at line 102 of file vtkImageExport.h.

int vtkImageExport::GetDataScalarType   [inline]
 

Definition at line 105 of file vtkImageExport.h.

void vtkImageExport::SetInput vtkImageData   input
 

Set/Get the input object from the image pipeline.

vtkImageData* vtkImageExport::GetInput  
 

virtual void vtkImageExport::ImageLowerLeftOn   [virtual]
 

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner.

virtual void vtkImageExport::ImageLowerLeftOff   [virtual]
 

virtual int vtkImageExport::GetImageLowerLeft   [virtual]
 

virtual void vtkImageExport::SetImageLowerLeft int    [virtual]
 

virtual void vtkImageExport::Export void *    [virtual]
 

The main interface: export to the memory pointed to

void* vtkImageExport::GetPointerToData  
 

An alternative to Export(): Use with caution. Get a pointer to the image memory (the pointer might be different each time this is called)

void vtkImageExport::operator= const vtkImageExport &    [inline, protected]
 

Definition at line 131 of file vtkImageExport.h.


Member Data Documentation

vtkImageFlip* vtkImageExport::ImageFlip [protected]
 

Definition at line 133 of file vtkImageExport.h.

int vtkImageExport::ImageLowerLeft [protected]
 

Definition at line 134 of file vtkImageExport.h.

int vtkImageExport::DataDimensions[3] [protected]
 

Definition at line 135 of file vtkImageExport.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:48:31 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001