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

vtkImageImport Class Reference

Import data from a C array. More...

#include <vtkImageImport.h>

Inheritance diagram for vtkImageImport:

Inheritance graph
[legend]
Collaboration diagram for vtkImageImport:

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)
void CopyImportVoidPointer (void *ptr, int size)
void SetImportVoidPointer (void *ptr)
void * GetImportVoidPointer ()
void SetImportVoidPointer (void *ptr, int save)
virtual void SetDataScalarType (int)
void SetDataScalarTypeToDouble ()
void SetDataScalarTypeToFloat ()
void SetDataScalarTypeToInt ()
void SetDataScalarTypeToShort ()
void SetDataScalarTypeToUnsignedShort ()
void SetDataScalarTypeToUnsignedChar ()
virtual int GetDataScalarType ()
const char * GetDataScalarTypeAsString ()
virtual void SetNumberOfScalarComponents (int)
virtual int GetNumberOfScalarComponents ()
virtual void SetDataExtent (int, int, int, int, int, int)
virtual void SetDataExtent (int[6])
virtual int * GetDataExtent ()
virtual void GetDataExtent (int &, int &, int &, int &, int &, int &)
virtual void GetDataExtent (int[6])
virtual void SetDataSpacing (float, float, float)
virtual void SetDataSpacing (float[3])
virtual float * GetDataSpacing ()
virtual void GetDataSpacing (float &, float &, float &)
virtual void GetDataSpacing (float[3])
virtual void SetDataOrigin (float, float, float)
virtual void SetDataOrigin (float[3])
virtual float * GetDataOrigin ()
virtual void GetDataOrigin (float &, float &, float &)
virtual void GetDataOrigin (float[3])

Static Public Methods

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

Protected Methods

 vtkImageImport ()
 ~vtkImageImport ()
 vtkImageImport (const vtkImageImport &)
void operator= (const vtkImageImport &)
void ExecuteInformation ()
void EnlargeOutputUpdateExtents (vtkDataObject *data)
void Execute (vtkImageData *data)
void Execute ()

Protected Attributes

void * ImportVoidPointer
int SaveUserArray
int NumberOfScalarComponents
int DataScalarType
int DataExtent [6]
float DataSpacing [3]
float DataOrigin [3]

Detailed Description

Import data from a C array.

Date:
2000/12/10 20:09:07
Revision:
1.25
Thanks:
Thanks to David G. Gobbi who developed this class.
vtkImageImport provides methods needed to import data from a C array.

See also:
vtkImageSource
Examples:
vtkImageImport (examples)

Definition at line 61 of file vtkImageImport.h.

Constructor & Destructor Documentation

vtkImageImport::vtkImageImport (    )  [protected]
 

vtkImageImport::~vtkImageImport (    )  [protected]
 

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

Definition at line 117 of file vtkImageImport.h.

Member Function Documentation

vtkImageImport* vtkImageImport::New (    )  [static]
 

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

Reimplemented from vtkImageSource.

virtual const char* vtkImageImport::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 vtkImageSource.

int vtkImageImport::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 vtkImageSource.

virtual int vtkImageImport::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 vtkImageSource.

vtkImageImport* vtkImageImport::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 vtkImageSource.

void vtkImageImport::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 vtkSource.

void vtkImageImport::CopyImportVoidPointer (  void *    ptr,
int    size
) 
 

Import data and make an internal copy of it. You should use this OR SetImportVoidPointer. The last one called will control how the current memory is handled. The size is the size of the data in BYTES.

void vtkImageImport::SetImportVoidPointer (  void *    ptr ) 
 

Set the pointer from which the image data is imported.

void* vtkImageImport::GetImportVoidPointer (    )  [inline]
 

Definition at line 75 of file vtkImageImport.h.

void vtkImageImport::SetImportVoidPointer (  void *    ptr,
int    save
) 
 

Set the pointer from which the image data is imported. Set save to 1 to keep the vtk from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array.

virtual void vtkImageImport::SetDataScalarType (  int    )  [virtual]
 

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

void vtkImageImport::SetDataScalarTypeToDouble (    )  [inline]
 

Definition at line 86 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToFloat (    )  [inline]
 

Definition at line 87 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToInt (    )  [inline]
 

Definition at line 88 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToShort (    )  [inline]
 

Definition at line 89 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToUnsignedShort (    )  [inline]
 

Definition at line 90 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToUnsignedChar (    )  [inline]
 

Definition at line 92 of file vtkImageImport.h.

virtual int vtkImageImport::GetDataScalarType (    )  [virtual]
 

const char* vtkImageImport::GetDataScalarTypeAsString (    )  [inline]
 

Definition at line 95 of file vtkImageImport.h.

virtual void vtkImageImport::SetNumberOfScalarComponents (  int    )  [virtual]
 

Set/Get the number of scalar components

virtual int vtkImageImport::GetNumberOfScalarComponents (    )  [virtual]
 

virtual void vtkImageImport::SetDataExtent (  int   ,
int   ,
int   ,
int   ,
int   ,
int   
)  [virtual]
 

Get/Set the extent of the data on disk.

virtual void vtkImageImport::SetDataExtent (  int   [6] )  [virtual]
 

virtual int* vtkImageImport::GetDataExtent (    )  [virtual]
 

virtual void vtkImageImport::GetDataExtent (  int &   ,
int &   ,
int &   ,
int &   ,
int &   ,
int &   
)  [virtual]
 

virtual void vtkImageImport::GetDataExtent (  int   [6] )  [virtual]
 

virtual void vtkImageImport::SetDataSpacing (  float   ,
float   ,
float   
)  [virtual]
 

Set/Get the spacing of the data in the file.

virtual void vtkImageImport::SetDataSpacing (  float   [3] )  [virtual]
 

virtual float* vtkImageImport::GetDataSpacing (    )  [virtual]
 

virtual void vtkImageImport::GetDataSpacing (  float &   ,
float &   ,
float &   
)  [virtual]
 

virtual void vtkImageImport::GetDataSpacing (  float   [3] )  [virtual]
 

virtual void vtkImageImport::SetDataOrigin (  float   ,
float   ,
float   
)  [virtual]
 

Set/Get the origin of the data (location of first pixel in the file).

virtual void vtkImageImport::SetDataOrigin (  float   [3] )  [virtual]
 

virtual float* vtkImageImport::GetDataOrigin (    )  [virtual]
 

virtual void vtkImageImport::GetDataOrigin (  float &   ,
float &   ,
float &   
)  [virtual]
 

virtual void vtkImageImport::GetDataOrigin (  float   [3] )  [virtual]
 

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

Definition at line 118 of file vtkImageImport.h.

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

This method returns the largest data that can be generated.

Reimplemented from vtkSource.

void vtkImageImport::EnlargeOutputUpdateExtents (  vtkDataObject *    data )  [protected]
 

void vtkImageImport::Execute (  vtkImageData *    data )  [protected, virtual]
 

Reimplemented from vtkImageSource.

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

Reimplemented from vtkImageSource.

Definition at line 139 of file vtkImageImport.h.

Member Data Documentation

void* vtkImageImport::ImportVoidPointer [protected]
 

Definition at line 127 of file vtkImageImport.h.

int vtkImageImport::SaveUserArray [protected]
 

Definition at line 128 of file vtkImageImport.h.

int vtkImageImport::NumberOfScalarComponents [protected]
 

Definition at line 131 of file vtkImageImport.h.

int vtkImageImport::DataScalarType [protected]
 

Definition at line 132 of file vtkImageImport.h.

int vtkImageImport::DataExtent[6] [protected]
 

Definition at line 134 of file vtkImageImport.h.

float vtkImageImport::DataSpacing[3] [protected]
 

Definition at line 135 of file vtkImageImport.h.

float vtkImageImport::DataOrigin[3] [protected]
 

Definition at line 136 of file vtkImageImport.h.

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