vtkImageData Class Reference

#include <vtkImageData.h>

Inheritance diagram for vtkImageData:

[legend]

Collaboration diagram for vtkImageData:

[legend]

List of all members.

---

Detailed Description

topologically and geometrically regular array of data

vtkImageData is a data object that is a concrete implementation of vtkDataSet. vtkImageData represents a geometric structure that is a topological and geometrical regular array of points. Examples include volumes (voxel data) and pixmaps.

Examples:

vtkImageData (Examples)

Tests:

vtkImageData (Tests)

Definition at line 43 of file vtkImageData.h.

Public Types
typedef vtkDataSet	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	CopyStructure (vtkDataSet *ds)
virtual int	GetDataObjectType ()
virtual void	Initialize ()
virtual void	SetDimensions (int i, int j, int k)
virtual void	SetDimensions (const int dims[3])
virtual int	GetDataDimension ()
virtual void	UpdateInformation ()
virtual unsigned long	GetEstimatedMemorySize ()
virtual int	GetScalarSize ()
virtual void	AllocateScalars ()
virtual void	Crop ()
virtual unsigned long	GetActualMemorySize ()
virtual void	CopyTypeSpecificInformation (vtkDataObject *image)
virtual void	PrepareForNewData ()
void	GetArrayIncrements (vtkDataArray *array, vtkIdType increments[3])
void	ComputeInternalExtent (int *intExt, int *tgtExt, int *bnds)
virtual int	GetExtentType ()
virtual vtkIdType	GetNumberOfCells ()
virtual vtkIdType	GetNumberOfPoints ()
virtual double *	GetPoint (vtkIdType ptId)
virtual void	GetPoint (vtkIdType id, double x[3])
virtual vtkCell *	GetCell (vtkIdType cellId)
virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)
virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
virtual vtkIdType	FindPoint (double x, double y, double z)
virtual vtkIdType	FindPoint (double x[3])
virtual vtkIdType	FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
virtual vtkIdType	FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
virtual vtkCell *	FindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
virtual int	GetCellType (vtkIdType cellId)
virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
virtual void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
virtual void	ComputeBounds ()
virtual int	GetMaxCellSize ()
virtual int *	GetDimensions ()
virtual void	GetDimensions (int dims[3])
virtual int	ComputeStructuredCoordinates (double x[3], int ijk[3], double pcoords[3])
virtual void	GetVoxelGradient (int i, int j, int k, vtkDataArray *s, vtkDataArray *g)
virtual void	GetPointGradient (int i, int j, int k, vtkDataArray *s, double g[3])
virtual vtkIdType	ComputePointId (int ijk[3])
virtual vtkIdType	ComputeCellId (int ijk[3])
virtual void	SetAxisUpdateExtent (int axis, int min, int max)
virtual void	GetAxisUpdateExtent (int axis, int &min, int &max)
virtual void	SetExtent (int extent[6])
virtual void	SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
virtual int *	GetExtent ()
virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetExtent (int[6])
virtual double	GetScalarTypeMin ()
virtual double	GetScalarTypeMax ()
virtual vtkIdType *	GetIncrements ()
virtual void	GetIncrements (vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
virtual void	GetIncrements (vtkIdType inc[3])
virtual void	GetContinuousIncrements (int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
virtual void *	GetScalarPointerForExtent (int extent[6])
virtual void *	GetScalarPointer (int coordinates[3])
virtual void *	GetScalarPointer (int x, int y, int z)
virtual void *	GetScalarPointer ()
virtual float	GetScalarComponentAsFloat (int x, int y, int z, int component)
virtual void	SetScalarComponentFromFloat (int x, int y, int z, int component, float v)
virtual double	GetScalarComponentAsDouble (int x, int y, int z, int component)
virtual void	SetScalarComponentFromDouble (int x, int y, int z, int component, double v)
virtual void	CopyAndCastFrom (vtkImageData *inData, int extent[6])
virtual void	CopyAndCastFrom (vtkImageData *inData, int x0, int x1, int y0, int y1, int z0, int z1)
virtual void	SetSpacing (double, double, double)
virtual void	SetSpacing (double[3])
virtual double *	GetSpacing ()
virtual void	GetSpacing (double &, double &, double &)
virtual void	GetSpacing (double[3])
virtual void	SetOrigin (double, double, double)
virtual void	SetOrigin (double[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double &, double &, double &)
virtual void	GetOrigin (double[3])
void	SetScalarTypeToFloat ()
void	SetScalarTypeToDouble ()
void	SetScalarTypeToInt ()
void	SetScalarTypeToUnsignedInt ()
void	SetScalarTypeToLong ()
void	SetScalarTypeToUnsignedLong ()
void	SetScalarTypeToShort ()
void	SetScalarTypeToUnsignedShort ()
void	SetScalarTypeToUnsignedChar ()
void	SetScalarTypeToSignedChar ()
void	SetScalarTypeToChar ()
void	SetScalarType (int)
int	GetScalarType ()
const char *	GetScalarTypeAsString ()
void	SetNumberOfScalarComponents (int n)
int	GetNumberOfScalarComponents ()
virtual void	CopyInformationToPipeline (vtkInformation *request, vtkInformation *input, vtkInformation *output, int forceCopy)
virtual void	CopyInformationFromPipeline (vtkInformation *request)
virtual void	ShallowCopy (vtkDataObject *src)
virtual void	DeepCopy (vtkDataObject *src)
void *	GetArrayPointerForExtent (vtkDataArray *array, int extent[6])
void *	GetArrayPointer (vtkDataArray *array, int coordinates[3])
Static Public Member Functions
static vtkImageData *	New ()
static int	IsTypeOf (const char *type)
static vtkImageData *	SafeDownCast (vtkObject *o)
static vtkImageData *	GetData (vtkInformation *info)
static vtkImageData *	GetData (vtkInformationVector *v, int i=0)
Protected Member Functions
	vtkImageData ()
	~vtkImageData ()
void	ComputeIncrements ()
void	CopyOriginAndSpacingFromPipeline ()
Protected Attributes
vtkVertex *	Vertex
vtkLine *	Line
vtkPixel *	Pixel
vtkVoxel *	Voxel
int	Dimensions [3]
int	DataDescription
vtkIdType	Increments [3]
double	Origin [3]
double	Spacing [3]
int	Extent [6]
vtkTimeStamp	ExtentComputeTime

---

Member Typedef Documentation

typedef vtkDataSet vtkImageData::Superclass

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

Definition at line 48 of file vtkImageData.h.

---

Constructor & Destructor Documentation

vtkImageData::vtkImageData

(

)

[protected]

vtkImageData::~vtkImageData

(

)

[protected]

---

Member Function Documentation

static vtkImageData* vtkImageData::New

(

)

[static]

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

Reimplemented from vtkDataObject.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

virtual const char* vtkImageData::GetClassName

(

)

[virtual]

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

static int vtkImageData::IsTypeOf

(

const char *

name

)

[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 vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

virtual int vtkImageData::IsA

(

const char *

name

)

[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 vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

static vtkImageData* vtkImageData::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

void vtkImageData::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 vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::CopyStructure

(

vtkDataSet *

ds

)

[virtual]

Copy the geometric and topological structure of an input image data object.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual int vtkImageData::GetDataObjectType

(

)

[inline, virtual]

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

Definition at line 56 of file vtkImageData.h.

virtual vtkIdType vtkImageData::GetNumberOfCells

(

)

[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkImageData::GetNumberOfPoints

(

)

[inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 426 of file vtkImageData.h.

virtual double* vtkImageData::GetPoint

(

vtkIdType

ptId

)

[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

void vtkImageData::GetPoint	(	vtkIdType	id,
		double	x[3]
	)			[inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 419 of file vtkImageData.h.

virtual vtkCell* vtkImageData::GetCell

(

vtkIdType

cellId

)

[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)			[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::GetCellBounds	(	vtkIdType	cellId,
		double	bounds[6]
	)			[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

virtual vtkIdType vtkImageData::FindPoint	(	double	x,
		double	y,
		double	z
	)			[inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 67 of file vtkImageData.h.

virtual vtkIdType vtkImageData::FindPoint

(

double

x[3]

)

[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

virtual vtkIdType vtkImageData::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)			[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual vtkIdType vtkImageData::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkGenericCell *	gencell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)			[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual vtkCell* vtkImageData::FindAndGetCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)			[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual int vtkImageData::GetCellType

(

vtkIdType

cellId

)

[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::GetCellPoints	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)			[inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 83 of file vtkImageData.h.

virtual void vtkImageData::GetPointCells	(	vtkIdType	ptId,
		vtkIdList *	cellIds
	)			[inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 86 of file vtkImageData.h.

virtual void vtkImageData::ComputeBounds

(

)

[virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

virtual int vtkImageData::GetMaxCellSize

(

)

[inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 89 of file vtkImageData.h.

virtual void vtkImageData::Initialize

(

)

[virtual]

Restore data object to initial state,

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::SetDimensions	(	int	i,
		int	j,
		int	k
	)			[virtual]

Pass your way. This is for backward compatibility only. Use SetExtent() instead. Same as SetExtent(0, i-1, 0, j-1, 0, k-1)

virtual void vtkImageData::SetDimensions

(

const int

dims[3]

)

[virtual]

Pass your way. This is for backward compatibility only. Use SetExtent() instead. Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1)

virtual int* vtkImageData::GetDimensions

(

)

[virtual]

Get dimensions of this structured points dataset. It is the number of points on each axis. Dimensions are computed from Extents during this call.

virtual void vtkImageData::GetDimensions

(

int

dims[3]

)

[virtual]

Get dimensions of this structured points dataset. It is the number of points on each axis. Dimensions are computed from Extents during this call.

virtual int vtkImageData::ComputeStructuredCoordinates	(	double	x[3],
		int	ijk[3],
		double	pcoords[3]
	)			[virtual]

Convenience function computes the structured coordinates for a point x[3]. The voxel is specified by the array ijk[3], and the parametric coordinates in the cell are specified with pcoords[3]. The function returns a 0 if the point x is outside of the volume, and a 1 if inside the volume.

virtual void vtkImageData::GetVoxelGradient	(	int	i,
		int	j,
		int	k,
		vtkDataArray *	s,
		vtkDataArray *	g
	)			[virtual]

Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners. The order in which the gradient vectors are arranged corresponds to the ordering of the voxel points. Gradient vector is computed by central differences (except on edges of volume where forward difference is used). The scalars s are the scalars from which the gradient is to be computed. This method will treat only 3D structured point datasets (i.e., volumes).

virtual void vtkImageData::GetPointGradient	(	int	i,
		int	j,
		int	k,
		vtkDataArray *	s,
		double	g[3]
	)			[virtual]

Given structured coordinates (i,j,k) for a point in a structured point dataset, compute the gradient vector from the scalar data at that point. The scalars s are the scalars from which the gradient is to be computed. This method will treat structured point datasets of any dimension.

int vtkImageData::GetDataDimension

(

)

[inline, virtual]

Return the dimensionality of the data.

Definition at line 438 of file vtkImageData.h.

virtual vtkIdType vtkImageData::ComputePointId

(

int

ijk[3]

)

[inline, virtual]

Given a location in structured coordinates (i-j-k), return the point id.

Definition at line 151 of file vtkImageData.h.

virtual vtkIdType vtkImageData::ComputeCellId

(

int

ijk[3]

)

[inline, virtual]

Given a location in structured coordinates (i-j-k), return the cell id.

Definition at line 158 of file vtkImageData.h.

virtual void vtkImageData::SetAxisUpdateExtent	(	int	axis,
		int	min,
		int	max
	)			[virtual]

Set / Get the extent on just one axis

virtual void vtkImageData::GetAxisUpdateExtent	(	int	axis,
		int &	min,
		int &	max
	)			[virtual]

Set / Get the extent on just one axis

virtual void vtkImageData::UpdateInformation

(

)

[virtual]

Override to copy information from pipeline information to data information for backward compatibility. See vtkDataObject::UpdateInformation for details.

Reimplemented from vtkDataObject.

virtual void vtkImageData::SetExtent

(

int

extent[6]

)

[virtual]

Set/Get the extent. On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

virtual void vtkImageData::SetExtent	(	int	x1,
		int	x2,
		int	y1,
		int	y2,
		int	z1,
		int	z2
	)			[virtual]

Set/Get the extent. On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

virtual int* vtkImageData::GetExtent

(

)

[virtual]

Set/Get the extent. On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

virtual void vtkImageData::GetExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)			[virtual]

Set/Get the extent. On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

virtual void vtkImageData::GetExtent

(

int

[6]

)

[virtual]

Set/Get the extent. On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

virtual unsigned long vtkImageData::GetEstimatedMemorySize

(

)

[virtual]

Get the estimated size of this data object itself. Should be called after UpdateInformation() and PropagateUpdateExtent() have both been called. This estimate should be fairly accurate since this is structured data.

Reimplemented from vtkDataObject.

virtual double vtkImageData::GetScalarTypeMin

(

)

[virtual]

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

virtual double vtkImageData::GetScalarTypeMax

(

)

[virtual]

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

virtual int vtkImageData::GetScalarSize

(

)

[virtual]

Set the size of the scalar type in bytes.

virtual vtkIdType* vtkImageData::GetIncrements

(

)

[virtual]

Different ways to get the increments for moving around the data. GetIncrements() calls ComputeIncrements() to ensure the increments are up to date.

virtual void vtkImageData::GetIncrements	(	vtkIdType &	incX,
		vtkIdType &	incY,
		vtkIdType &	incZ
	)			[virtual]

Different ways to get the increments for moving around the data. GetIncrements() calls ComputeIncrements() to ensure the increments are up to date.

virtual void vtkImageData::GetIncrements

(

vtkIdType

inc[3]

)

[virtual]

Different ways to get the increments for moving around the data. GetIncrements() calls ComputeIncrements() to ensure the increments are up to date.

virtual void vtkImageData::GetContinuousIncrements	(	int	extent[6],
		vtkIdType &	incX,
		vtkIdType &	incY,
		vtkIdType &	incZ
	)			[virtual]

Different ways to get the increments for moving around the data. incX is always returned with 0. incY is returned with the increment needed to move from the end of one X scanline of data to the start of the next line. incZ is filled in with the increment needed to move from the end of one image to the start of the next. The proper way to use these values is to for a loop over Z, Y, X, C, incrementing the pointer by 1 after each component. When the end of the component is reached, the pointer is set to the beginning of the next pixel, thus incX is properly set to 0.

virtual void* vtkImageData::GetScalarPointerForExtent

(

int

extent[6]

)

[virtual]

Access the native pointer for the scalar data

virtual void* vtkImageData::GetScalarPointer

(

int

coordinates[3]

)

[virtual]

Access the native pointer for the scalar data

virtual void* vtkImageData::GetScalarPointer	(	int	x,
		int	y,
		int	z
	)			[virtual]

Access the native pointer for the scalar data

virtual void* vtkImageData::GetScalarPointer

(

)

[virtual]

Access the native pointer for the scalar data

virtual float vtkImageData::GetScalarComponentAsFloat	(	int	x,
		int	y,
		int	z,
		int	component
	)			[virtual]

For access to data from tcl

virtual void vtkImageData::SetScalarComponentFromFloat	(	int	x,
		int	y,
		int	z,
		int	component,
		float	v
	)			[virtual]

For access to data from tcl

virtual double vtkImageData::GetScalarComponentAsDouble	(	int	x,
		int	y,
		int	z,
		int	component
	)			[virtual]

For access to data from tcl

virtual void vtkImageData::SetScalarComponentFromDouble	(	int	x,
		int	y,
		int	z,
		int	component,
		double	v
	)			[virtual]

For access to data from tcl

virtual void vtkImageData::AllocateScalars

(

)

[virtual]

Allocate the vtkScalars object associated with this object.

virtual void vtkImageData::CopyAndCastFrom	(	vtkImageData *	inData,
		int	extent[6]
	)			[virtual]

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.

virtual void vtkImageData::CopyAndCastFrom	(	vtkImageData *	inData,
		int	x0,
		int	x1,
		int	y0,
		int	y1,
		int	z0,
		int	z1
	)			[inline, virtual]

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.

Definition at line 253 of file vtkImageData.h.

virtual void vtkImageData::Crop

(

)

[virtual]

Reallocates and copies to set the Extent to the UpdateExtent. This is used internally when the exact extent is requested, and the source generated more than the update extent.

Reimplemented from vtkDataObject.

virtual unsigned long vtkImageData::GetActualMemorySize

(

)

[virtual]

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkDataSet.

virtual void vtkImageData::SetSpacing	(	double	,
		double	,
		double
	)			[virtual]

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkImageData::SetSpacing

(

double

[3]

)

[virtual]

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual double* vtkImageData::GetSpacing

(

)

[virtual]

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkImageData::GetSpacing	(	double &	,
		double &	,
		double &
	)			[virtual]

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkImageData::GetSpacing

(

double

[3]

)

[virtual]

Set the spacing (width,height,length) of the cubical cells that compose the data set.

virtual void vtkImageData::SetOrigin	(	double	,
		double	,
		double
	)			[virtual]

Set/Get the origin of the dataset. The origin is the position in world coordinates of the point of extent (0,0,0). This point does not have to be part of the dataset, in other words, the dataset extent does not have to start at (0,0,0) and the origin can be outside of the dataset bounding box. The origin plus spacing determine the position in space of the points.

virtual void vtkImageData::SetOrigin

(

double

[3]

)

[virtual]

Set/Get the origin of the dataset. The origin is the position in world coordinates of the point of extent (0,0,0). This point does not have to be part of the dataset, in other words, the dataset extent does not have to start at (0,0,0) and the origin can be outside of the dataset bounding box. The origin plus spacing determine the position in space of the points.

virtual double* vtkImageData::GetOrigin

(

)

[virtual]

Set/Get the origin of the dataset. The origin is the position in world coordinates of the point of extent (0,0,0). This point does not have to be part of the dataset, in other words, the dataset extent does not have to start at (0,0,0) and the origin can be outside of the dataset bounding box. The origin plus spacing determine the position in space of the points.

virtual void vtkImageData::GetOrigin	(	double &	,
		double &	,
		double &
	)			[virtual]

Set/Get the origin of the dataset. The origin is the position in world coordinates of the point of extent (0,0,0). This point does not have to be part of the dataset, in other words, the dataset extent does not have to start at (0,0,0) and the origin can be outside of the dataset bounding box. The origin plus spacing determine the position in space of the points.

virtual void vtkImageData::GetOrigin

(

double

[3]

)

[virtual]

Set/Get the origin of the dataset. The origin is the position in world coordinates of the point of extent (0,0,0). This point does not have to be part of the dataset, in other words, the dataset extent does not have to start at (0,0,0) and the origin can be outside of the dataset bounding box. The origin plus spacing determine the position in space of the points.

void vtkImageData::SetScalarTypeToFloat

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 295 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToDouble

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 296 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToInt

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 297 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToUnsignedInt

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 298 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToLong

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 300 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToUnsignedLong

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 301 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToShort

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 303 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToUnsignedShort

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 304 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToUnsignedChar

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 306 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToSignedChar

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 308 of file vtkImageData.h.

void vtkImageData::SetScalarTypeToChar

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 310 of file vtkImageData.h.

void vtkImageData::SetScalarType

(

int

)

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

int vtkImageData::GetScalarType

(

)

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

const char* vtkImageData::GetScalarTypeAsString

(

)

[inline]

Set/Get the data scalar type (i.e VTK_DOUBLE). Note that these methods are setting and getting the pipeline scalar type. i.e. they are setting the type that the image data will be once it has executed. Until the REQUEST_DATA pass the actual scalars may be of some other type. This is for backwards compatibility

Definition at line 314 of file vtkImageData.h.

void vtkImageData::SetNumberOfScalarComponents

(

int

n

)

Set/Get the number of scalar components for points. As with the SetScalarType method this is setting pipeline info.

int vtkImageData::GetNumberOfScalarComponents

(

)

Set/Get the number of scalar components for points. As with the SetScalarType method this is setting pipeline info.

virtual void vtkImageData::CopyTypeSpecificInformation

(

vtkDataObject *

data

)

[virtual]

By default, there is no type specific information

Reimplemented from vtkDataObject.

virtual void vtkImageData::CopyInformationToPipeline	(	vtkInformation *	request,
		vtkInformation *	input,
		vtkInformation *	output,
		int	forceCopy
	)			[virtual]

Override these to handle origin, spacing, scalar type, and scalar number of components. See vtkDataObject for details.

Reimplemented from vtkDataObject.

virtual void vtkImageData::CopyInformationFromPipeline

(

vtkInformation *

request

)

[virtual]

Override these to handle origin, spacing, scalar type, and scalar number of components. See vtkDataObject for details.

Reimplemented from vtkDataObject.

virtual void vtkImageData::PrepareForNewData

(

)

[virtual]

make the output data ready for new data to be inserted. For most objects we just call Initialize. But for image data we leave the old data in case the memory can be reused.

Reimplemented from vtkDataObject.

virtual void vtkImageData::ShallowCopy

(

vtkDataObject *

src

)

[virtual]

Shallow and Deep copy.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::DeepCopy

(

vtkDataObject *

src

)

[virtual]

Shallow and Deep copy.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

void* vtkImageData::GetArrayPointerForExtent	(	vtkDataArray *	array,
		int	extent[6]
	)

These are convenience methods for getting a pointer from any filed array. It is a start at expanding image filters to process any array (not just scalars).

void* vtkImageData::GetArrayPointer	(	vtkDataArray *	array,
		int	coordinates[3]
	)

These are convenience methods for getting a pointer from any filed array. It is a start at expanding image filters to process any array (not just scalars).

void vtkImageData::GetArrayIncrements	(	vtkDataArray *	array,
		vtkIdType	increments[3]
	)

Since various arrays have different number of components, the will have different increments.

void vtkImageData::ComputeInternalExtent	(	int *	intExt,
		int *	tgtExt,
		int *	bnds
	)

Given how many pixel are required on a side for bounrary conditions (in bnds), the target extent to traverse, compute the internal extent (the extent for this ImageData that does nto suffer from any boundary conditions) and place it in intExt

virtual int vtkImageData::GetExtentType

(

)

[inline, virtual]

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 373 of file vtkImageData.h.

static vtkImageData* vtkImageData::GetData

(

vtkInformation *

info

)

[static]

Retrieve an instance of this class from an information object.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

static vtkImageData* vtkImageData::GetData	(	vtkInformationVector *	v,
		int	i = 0
	)			[static]

Retrieve an instance of this class from an information object.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

void vtkImageData::ComputeIncrements

(

)

[protected]

void vtkImageData::CopyOriginAndSpacingFromPipeline

(

)

[protected]

---

Member Data Documentation

vtkVertex* vtkImageData::Vertex [protected]

Definition at line 388 of file vtkImageData.h.

vtkLine* vtkImageData::Line [protected]

Definition at line 389 of file vtkImageData.h.

vtkPixel* vtkImageData::Pixel [protected]

Definition at line 390 of file vtkImageData.h.

vtkVoxel* vtkImageData::Voxel [protected]

Definition at line 391 of file vtkImageData.h.

int vtkImageData::Dimensions[3] [protected]

Definition at line 396 of file vtkImageData.h.

int vtkImageData::DataDescription [protected]

Definition at line 397 of file vtkImageData.h.

vtkIdType vtkImageData::Increments[3] [protected]

Definition at line 398 of file vtkImageData.h.

double vtkImageData::Origin[3] [protected]

Definition at line 400 of file vtkImageData.h.

double vtkImageData::Spacing[3] [protected]

Definition at line 401 of file vtkImageData.h.

int vtkImageData::Extent[6] [protected]

Definition at line 403 of file vtkImageData.h.

vtkTimeStamp vtkImageData::ExtentComputeTime [protected]

Definition at line 408 of file vtkImageData.h.

---

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

• dox/Filtering/vtkImageData.h