Documentation for vtkImageData

vtkImageData - Similar to structured points.

Description:

vtkImageData is the basic image data structure specific to the image pipeline. The extent represents the actual dimensions of the underlying memory. The actual memory is stored in objects (vtkPointData,vtkScalars,vtkArray) used in the visualization pipline, so transfer of data is efficient. Currently, the only contents of PointData used are the Scalars. The underlying memory can be any data type. This class basically adds some extra methods to vtkStructuredPoints to fascilitate image processing. At some point in the future it will probably be moved into vtkStructuredPoints.

Methods:

	void vtkImageData ()
	static vtkImageData *New ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void SetExtent (int *)
	void SetExtent (int ,int ,int ,int ,int ,int )
	int *GetExtent ()
	void GetExtent (int & ,int & ,int & ,int & ,int & ,int &)
	void SetScalarType (int )
	int GetScalarType ()
	double GetScalarTypeMin ()
	double GetScalarTypeMax ()
	int GetScalarSize ()
	int *GetIncrements ()
	void GetContinuousIncrements (int ,int & ,int & ,int &)
	void *GetScalarPointerForExtent (int )
	void *GetScalarPointer (int )
	void *GetScalarPointer (int ,int ,int )
	void *GetScalarPointer ()
	float GetScalarComponentAsFloat (int ,int ,int ,int )
	void AllocateScalars ()
	void SetNumberOfScalarComponents (int )
	int GetNumberOfScalarComponents ()
	void CopyAndCastFrom (vtkImageData * ,int )
	void ComputeIncrements ()

Detailed Method Descriptions:

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

	void SetExtent (int *)
	void SetExtent (int ,int ,int ,int ,int ,int )
	int *GetExtent ()
	void GetExtent (int & ,int & ,int & ,int & ,int & ,int &)

Set/Get the data scalar type of the regions created by this cache.

	void SetScalarType (int )
	int GetScalarType ()

These returns the minimum and maximum values the ScalarType can hold without overflowing.

	double GetScalarTypeMin ()
	double GetScalarTypeMax ()

Set the size of the scalar type in bytes.

int GetScalarSize ()

Different ways to get the increments for moving around the data.

int *GetIncrements ()

Different ways to get the increments for moving around the data. They are store (Component, X, Y, Z). This method returns increments that are suited for continuous incrementing of the pointer in a Z, Y, X, C nested for loop.

void GetContinuousIncrements (int ,int & ,int & ,int &)

Access the native pointer for the scalar data

	void *GetScalarPointerForExtent (int )
	void *GetScalarPointer (int )
	void *GetScalarPointer (int ,int ,int )
	void *GetScalarPointer ()

For acces to data from tcl

float GetScalarComponentAsFloat (int ,int ,int ,int )

Allocate the vtkScalars object associated with this object.

void AllocateScalars ()

Set/Get the number of scalar components

	void SetNumberOfScalarComponents (int )
	int GetNumberOfScalarComponents ()

This method is passed a input and output region, and executes the filter algorithm to fill the output from the input. It just executes a switch statement to call the correct function for the regions data types.

void CopyAndCastFrom (vtkImageData * ,int )