topologically and geometrically regular array of data More...

#include <vtkImageData.h>

Inheritance diagram for vtkImageData:

Collaboration diagram for vtkImageData:

Public Types
typedef vtkDataSet	Superclass

Public Types inherited from vtkDataSet
enum	FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImageData *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	CopyStructure (vtkDataSet *ds) override
	Copy the geometric and topological structure of an input image data object. More...

int	GetDataObjectType () override
	Return what type of dataset this is. More...

vtkIdType	GetNumberOfCells () override
	Standard vtkDataSet API methods. More...

vtkIdType	GetNumberOfPoints () override
	Determine the number of points composing the dataset. More...

double *	GetPoint (vtkIdType ptId) override
	Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. More...

void	GetPoint (vtkIdType id, double x[3]) override
	Copy point coordinates into user provided array x[3] for specified point id. More...

vtkCell *	GetCell (vtkIdType cellId) override
	Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...

vtkCell *	GetCell (int i, int j, int k) override

void	GetCell (vtkIdType cellId, vtkGenericCell *cell) override
	Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...

void	GetCellBounds (vtkIdType cellId, double bounds[6]) override
	Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...

virtual vtkIdType	FindPoint (double x, double y, double z)

vtkIdType	FindPoint (double x[3]) override

vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	Locate cell based on global coordinate x and tolerance squared. More...

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	This is a version of the above method that can be used with multithreaded applications. More...

vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	Locate the cell that contains a point and return the cell. More...

int	GetCellType (vtkIdType cellId) override
	Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. More...

void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
	Topological inquiry to get points defining cell. More...

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
	Topological inquiry to get cells using point. More...

void	ComputeBounds () override
	Compute the data bounding box from data points. More...

int	GetMaxCellSize () override
	Convenience method returns largest cell size in dataset. More...

void	Initialize () override
	Restore data object to initial state. More...

virtual void	SetDimensions (int i, int j, int k)
	Same as SetExtent(0, i-1, 0, j-1, 0, k-1) More...

virtual void	SetDimensions (const int dims[3])
	Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1) More...

virtual int *	GetDimensions ()
	Get dimensions of this structured points dataset. More...

virtual void	GetDimensions (int dims[3])
	Get dimensions of this structured points dataset. More...

virtual int	ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3])
	Convenience function computes the structured coordinates for a point x[3]. More...

virtual void	GetVoxelGradient (int i, int j, int k, vtkDataArray s, vtkDataArray g)
	Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners. More...

virtual void	GetPointGradient (int i, int j, int k, vtkDataArray *s, double g[3])
	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. More...

virtual int	GetDataDimension ()
	Return the dimensionality of the data. More...

virtual vtkIdType	ComputePointId (int ijk[3])
	Given a location in structured coordinates (i-j-k), return the point id. More...

virtual vtkIdType	ComputeCellId (int ijk[3])
	Given a location in structured coordinates (i-j-k), return the cell id. More...

virtual void	SetAxisUpdateExtent (int axis, int min, int max, const int updateExtent, int axisUpdateExtent)
	Set / Get the extent on just one axis. More...

virtual void	GetAxisUpdateExtent (int axis, int &min, int &max, const int *updateExtent)

virtual void	SetExtent (int extent[6])
	Set/Get the extent. More...

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 (vtkInformation *meta_data)
	These returns the minimum and maximum values the ScalarType can hold without overflowing. More...

virtual double	GetScalarTypeMin ()

virtual double	GetScalarTypeMax (vtkInformation *meta_data)

virtual double	GetScalarTypeMax ()

virtual int	GetScalarSize (vtkInformation *meta_data)
	Get the size of the scalar type in bytes. More...

virtual int	GetScalarSize ()

virtual vtkIdType *	GetIncrements ()
	Different ways to get the increments for moving around the data. More...

virtual void	GetIncrements (vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)

virtual void	GetIncrements (vtkIdType inc[3])

virtual vtkIdType *	GetIncrements (vtkDataArray *scalars)

virtual void	GetIncrements (vtkDataArray *scalars, vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)

virtual void	GetIncrements (vtkDataArray *scalars, vtkIdType inc[3])

virtual void	GetContinuousIncrements (int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
	Different ways to get the increments for moving around the data. More...

virtual void	GetContinuousIncrements (vtkDataArray *scalars, int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)

virtual void *	GetScalarPointerForExtent (int extent[6])
	Access the native pointer for the scalar data. More...

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)
	For access to data from wrappers. More...

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	AllocateScalars (int dataType, int numComponents)
	Allocate the point scalars for this dataset. More...

virtual void	AllocateScalars (vtkInformation *pipeline_info)
	Allocate the point scalars for this dataset. More...

virtual void	CopyAndCastFrom (vtkImageData *inData, int extent[6])
	This method is passed a input and output region, and executes the filter algorithm to fill the output from the input. More...

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

void	Crop (const int *updateExtent) override
	Reallocates and copies to set the Extent to updateExtent. More...

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes). More...

virtual double *	GetSpacing ()
	Set the spacing (width,height,length) of the cubical cells that compose the data set. More...

virtual void	GetSpacing (double &, double &, double &)

virtual void	GetSpacing (double[3])

virtual void	SetSpacing (double i, double j, double k)

virtual void	SetSpacing (const double ijk[3])

virtual double *	GetOrigin ()
	Set/Get the origin of the dataset. More...

virtual void	GetOrigin (double &, double &, double &)

virtual void	GetOrigin (double[3])

virtual void	SetOrigin (double i, double j, double k)

virtual void	SetOrigin (const double ijk[3])

virtual vtkMatrix3x3 *	GetDirectionMatrix ()
	Set/Get the direction transform of the dataset. More...

virtual void	SetDirectionMatrix (vtkMatrix3x3 *m)

virtual void	SetDirectionMatrix (const double elements[9])

virtual void	SetDirectionMatrix (double e00, double e01, double e02, double e10, double e11, double e12, double e20, double e21, double e22)

virtual vtkMatrix4x4 *	GetIndexToPhysicalMatrix ()
	Get the transformation matrix from the index space to the physical space coordinate system of the dataset. More...

virtual void	TransformContinuousIndexToPhysicalPoint (double i, double j, double k, double xyz[3])
	Convert coordinates from index space (ijk) to physical space (xyz) More...

virtual void	TransformContinuousIndexToPhysicalPoint (const double ijk[3], double xyz[3])

virtual void	TransformIndexToPhysicalPoint (int i, int j, int k, double xyz[3])

virtual void	TransformIndexToPhysicalPoint (const int ijk[3], double xyz[3])

virtual vtkMatrix4x4 *	GetPhysicalToIndexMatrix ()
	Get the transformation matrix from the physical space to the index space coordinate system of the dataset. More...

virtual void	TransformPhysicalPointToContinuousIndex (double x, double y, double z, double ijk[3])
	Convert coordinates from physical space (xyz) to index space (ijk) More...

virtual void	TransformPhysicalPointToContinuousIndex (const double xyz[3], double ijk[3])

virtual void	TransformPhysicalNormalToContinuousIndex (const double xyz[3], double ijk[3])
	Convert normal from physical space (xyz) to index space (ijk) More...

virtual void	TransformPhysicalPlaneToContinuousIndex (double const pplane[4], double iplane[4])
	Convert a plane form physical to continuous index. More...

int	GetScalarType ()

const char *	GetScalarTypeAsString ()

int	GetNumberOfScalarComponents ()

void	CopyInformationFromPipeline (vtkInformation *information) override
	Override these to handle origin, spacing, scalar type, and scalar number of components. More...

void	CopyInformationToPipeline (vtkInformation *information) override
	Copy information from this data object to the pipeline information. More...

void	PrepareForNewData () override
	make the output data ready for new data to be inserted. More...

void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy. More...

void	DeepCopy (vtkDataObject *src) override

void *	GetArrayPointerForExtent (vtkDataArray *array, int extent[6])
	These are convenience methods for getting a pointer from any filed array. More...

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

void	GetArrayIncrements (vtkDataArray *array, vtkIdType increments[3])
	Since various arrays have different number of components, the will have different increments. More...

void	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 not suffer from any boundary conditions) and place it in intExt. More...

int	GetExtentType () override
	The extent type is a 3D extent. More...

Public Member Functions inherited from vtkDataSet
vtkDataSet *	NewInstance () const

virtual void	CopyAttributes (vtkDataSet *ds)
	Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...

virtual vtkCellIterator *	NewCellIterator ()
	Return an iterator that traverses the cells in this data set. More...

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))

virtual void	GetCellTypes (vtkCellTypes *types)
	Get a list of types of cells in a dataset. More...

virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)
	Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). More...

vtkIdType	FindPoint (double x, double y, double z)
	Locate the closest point to the global coordinate x. More...

vtkMTimeType	GetMTime () override
	Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. More...

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's cell data. More...

vtkPointData *	GetPointData ()
	Return a pointer to this dataset's point data. More...

virtual void	Squeeze ()
	Reclaim any extra memory used to store data. More...

double *	GetBounds ()
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...

void	GetBounds (double bounds[6])
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...

double *	GetCenter ()
	Get the center of the bounding box. More...

void	GetCenter (double center[3])
	Get the center of the bounding box. More...

double	GetLength ()
	Return the length of the diagonal of the bounding box. More...

virtual void	GetScalarRange (double range[2])
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...

double *	GetScalarRange ()
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...

int	CheckAttributes ()
	This method checks to see if the cell and point attributes match the geometry. More...

virtual void	GenerateGhostArray (int zeroExt[6])
	Normally called by pipeline executives or algorithms only. More...

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData. More...

vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...

bool	HasAnyGhostCells ()
	Returns 1 if there are any ghost cells 0 otherwise. More...

bool	HasAnyGhostPoints ()
	Returns 1 if there are any ghost points 0 otherwise. More...

virtual bool	HasAnyBlankCells ()
	Returns 1 if there are any blanking cells 0 otherwise. More...

virtual bool	HasAnyBlankPoints ()
	Returns 1 if there are any blanking points 0 otherwise. More...

vtkUnsignedCharArray *	GetPointGhostArray ()
	Gets the array that defines the ghost type of each point. More...

void	UpdatePointGhostArrayCache ()
	Updates the pointer to the point ghost array. More...

vtkUnsignedCharArray *	AllocatePointGhostArray ()
	Allocate ghost array for points. More...

vtkUnsignedCharArray *	GetCellGhostArray ()
	Get the array that defines the ghost type of each cell. More...

void	UpdateCellGhostArrayCache ()
	Updates the pointer to the cell ghost array. More...

vtkUnsignedCharArray *	AllocateCellGhostArray ()
	Allocate ghost array for cells. More...

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...

virtual void	SetInformation (vtkInformation *)

void	ReleaseData ()
	Release data back to system to conserve memory resource. More...

virtual int	GetDataReleased ()
	Get the flag indicating the data has been released. More...

void	GlobalReleaseDataFlagOn ()

void	GlobalReleaseDataFlagOff ()

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...

virtual vtkFieldData *	GetFieldData ()

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information. More...

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information. More...

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data. More...

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type. More...

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkImageData *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageData *	SafeDownCast (vtkObjectBase *o)

static void	TransformContinuousIndexToPhysicalPoint (double i, double j, double k, double const origin[3], double const spacing[3], double const direction[9], double xyz[3])

static void	ComputeIndexToPhysicalMatrix (double const origin[3], double const spacing[3], double const direction[9], double result[16])

static void	SetScalarType (int, vtkInformation *meta_data)

static int	GetScalarType (vtkInformation *meta_data)

static bool	HasScalarType (vtkInformation *meta_data)

static void	SetNumberOfScalarComponents (int n, vtkInformation *meta_data)
	Set/Get the number of scalar components for points. More...

static int	GetNumberOfScalarComponents (vtkInformation *meta_data)

static bool	HasNumberOfScalarComponents (vtkInformation *meta_data)

static vtkImageData *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

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

Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataSet *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static void	SetGlobalReleaseDataFlag (int val)
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

static int	GetGlobalReleaseDataFlag ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array. More...

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters. More...

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...

static int	GetAssociationTypeFromString (const char *associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageData ()

	~vtkImageData () override

void	ComputeIncrements ()

void	ComputeIncrements (int numberOfComponents)

void	ComputeIncrements (vtkDataArray *scalars)

void	ComputeIncrements (vtkIdType inc[3])

void	ComputeIncrements (int numberOfComponents, vtkIdType inc[3])

void	ComputeIncrements (vtkDataArray *scalars, vtkIdType inc[3])

void	ComputeTransforms ()

vtkCell *	GetCellTemplateForDataDescription ()

bool	GetCellTemplateForDataDescription (vtkGenericCell *cell)

bool	GetIJKMinForCellId (vtkIdType cellId, int ijkMin[3])

bool	GetIJKMaxForIJKMin (int ijkMin[3], int ijkMax[3])

void	AddPointsToCellTemplate (vtkCell *cell, int ijkMin[3], int ijkMax[3])

void	SetDataDescription (int desc)

int	GetDataDescription ()

Protected Member Functions inherited from vtkDataSet
	vtkDataSet ()

	~vtkDataSet () override

virtual void	ComputeScalarRange ()
	Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...

bool	IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
	Helper function that tests if any of the values in 'a' have bitFlag set. More...

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Dimensions [3]

vtkIdType	Increments [3]

double	Origin [3]

double	Spacing [3]

vtkMatrix3x3 *	DirectionMatrix

vtkMatrix4x4 *	IndexToPhysicalMatrix

vtkMatrix4x4 *	PhysicalToIndexMatrix

int	Extent [6]

vtkTimeStamp	ExtentComputeTime

Protected Attributes inherited from vtkDataSet
vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

vtkUnsignedCharArray *	PointGhostArray
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...

vtkUnsignedCharArray *	CellGhostArray

bool	PointGhostArrayCached

bool	CellGhostArrayCached

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkUniformGrid

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 47 of file vtkImageData.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSet vtkImageData::Superclass

Definition at line 52 of file vtkImageData.h.

Constructor & Destructor Documentation

◆ vtkImageData()

vtkImageData::vtkImageData ( )

protected

◆ ~vtkImageData()

vtkImageData::~vtkImageData ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImageData* vtkImageData::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkImageData::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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 vtkUniformGrid, and vtkStructuredPoints.

◆ SafeDownCast()

static vtkImageData* vtkImageData::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageData::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid, and vtkStructuredPoints.

◆ NewInstance()

vtkImageData* vtkImageData::NewInstance ( ) const

◆ PrintSelf()

void vtkImageData::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ CopyStructure()

void vtkImageData::CopyStructure ( vtkDataSet * ds )

overridevirtual

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

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ GetDataObjectType()

int vtkImageData::GetDataObjectType ( )

inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid, and vtkStructuredPoints.

Definition at line 64 of file vtkImageData.h.

◆ GetNumberOfCells()

vtkIdType vtkImageData::GetNumberOfCells ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Warning: If GetCell(int,int,int) gets overridden in a subclass, it is necessary to override GetCell(vtkIdType) in that class as well since vtkImageData::GetCell(vtkIdType) will always call vkImageData::GetCell(int,int,int)

Implements vtkDataSet.

◆ GetNumberOfPoints()

vtkIdType vtkImageData::GetNumberOfPoints ( )

inlineoverridevirtual

Determine the number of points composing the dataset.

THIS METHOD IS THREAD SAFE

Implements vtkDataSet.

Definition at line 629 of file vtkImageData.h.

◆ GetPoint() [1/2]

double * vtkImageData::GetPoint ( vtkIdType ptId )

inlineoverridevirtual

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

Definition at line 622 of file vtkImageData.h.

◆ GetPoint() [2/2]

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

overridevirtual

Copy point coordinates into user provided array x[3] for specified point id.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

◆ GetCell() [1/3]

vtkCell* vtkImageData::GetCell ( vtkIdType cellId )

overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ GetCell() [2/3]

vtkCell* vtkImageData::GetCell	(	int	i,
		int	j,
		int	k
	)

override

◆ GetCell() [3/3]

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

overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ GetCellBounds()

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

overridevirtual

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.

A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

◆ FindPoint() [1/2]

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

inlinevirtual

Definition at line 82 of file vtkImageData.h.

◆ FindPoint() [2/2]

vtkIdType vtkImageData::FindPoint ( double x[3] )

overridevirtual

Implements vtkDataSet.

◆ FindCell() [1/2]

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

overridevirtual

Locate cell based on global coordinate x and tolerance squared.

If cell and cellId is non-nullptr, then search starts from this cell and looks at immediate neighbors. Returns cellId >= 0 if inside, < 0 otherwise. The parametric coordinates are provided in pcoords[3]. The interpolation weights are returned in weights[]. (The number of weights is equal to the number of points in the found cell). Tolerance is used to control how close the point is to be considered "in" the cell. THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ FindCell() [2/2]

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

overridevirtual

This is a version of the above method that can be used with multithreaded applications.

A vtkGenericCell must be passed in to be used in internal calls that might be made to GetCell() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ FindAndGetCell()

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

overridevirtual

Locate the cell that contains a point and return the cell.

Also returns the subcell id, parametric coordinates and weights for subsequent interpolation. This method combines the derived class methods int FindCell and vtkCell *GetCell. Derived classes may provide a more efficient implementation. See for example vtkStructuredPoints. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ GetCellType()

int vtkImageData::GetCellType ( vtkIdType cellId )

overridevirtual

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ GetCellPoints()

void vtkImageData::GetCellPoints	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

inlineoverridevirtual

Topological inquiry to get points defining cell.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 98 of file vtkImageData.h.

◆ GetPointCells()

void vtkImageData::GetPointCells	(	vtkIdType	ptId,
		vtkIdList *	cellIds
	)

inlineoverridevirtual

Topological inquiry to get cells using point.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 101 of file vtkImageData.h.

◆ ComputeBounds()

void vtkImageData::ComputeBounds ( )

overridevirtual

Compute the data bounding box from data points.

THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataSet.

◆ GetMaxCellSize()

int vtkImageData::GetMaxCellSize ( )

inlineoverridevirtual

Convenience method returns largest cell size in dataset.

This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 104 of file vtkImageData.h.

◆ Initialize()

void vtkImageData::Initialize ( )

overridevirtual

Restore data object to initial state.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ SetDimensions() [1/2]

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

virtual

Same as SetExtent(0, i-1, 0, j-1, 0, k-1)

◆ SetDimensions() [2/2]

virtual void vtkImageData::SetDimensions ( const int dims[3] )

virtual

Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1)

◆ GetDimensions() [1/2]

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.

Warning: Non thread-safe, use second signature if you want it to be.

◆ GetDimensions() [2/2]

virtual void vtkImageData::GetDimensions ( int dims[3] )

virtual

Get dimensions of this structured points dataset.

It is the number of points on each axis. This method is thread-safe.

Warning: The Dimensions member variable is not updated during this call.

◆ ComputeStructuredCoordinates()

virtual int vtkImageData::ComputeStructuredCoordinates	(	const 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.

◆ GetVoxelGradient()

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).

◆ GetPointGradient()

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.

◆ GetDataDimension()

int vtkImageData::GetDataDimension ( )

inlinevirtual

Return the dimensionality of the data.

Definition at line 641 of file vtkImageData.h.

◆ ComputePointId()

virtual vtkIdType vtkImageData::ComputePointId ( int ijk[3] )

inlinevirtual

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

Definition at line 179 of file vtkImageData.h.

◆ ComputeCellId()

virtual vtkIdType vtkImageData::ComputeCellId ( int ijk[3] )

inlinevirtual

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

Definition at line 185 of file vtkImageData.h.

◆ SetAxisUpdateExtent()

virtual void vtkImageData::SetAxisUpdateExtent	(	int	axis,
		int	min,
		int	max,
		const int *	updateExtent,
		int *	axisUpdateExtent
	)

virtual

Set / Get the extent on just one axis.

◆ GetAxisUpdateExtent()

virtual void vtkImageData::GetAxisUpdateExtent	(	int	axis,
		int &	min,
		int &	max,
		const int *	updateExtent
	)

virtual

◆ SetExtent() [1/2]

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.

◆ SetExtent() [2/2]

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

virtual

◆ GetExtent() [1/3]

virtual int* vtkImageData::GetExtent ( )

virtual

◆ GetExtent() [2/3]

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

virtual

◆ GetExtent() [3/3]

virtual void vtkImageData::GetExtent ( int [6] )

virtual

◆ GetScalarTypeMin() [1/2]

virtual double vtkImageData::GetScalarTypeMin ( vtkInformation * meta_data )

virtual

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

◆ GetScalarTypeMin() [2/2]

virtual double vtkImageData::GetScalarTypeMin ( )

virtual

◆ GetScalarTypeMax() [1/2]

virtual double vtkImageData::GetScalarTypeMax ( vtkInformation * meta_data )

virtual

◆ GetScalarTypeMax() [2/2]

virtual double vtkImageData::GetScalarTypeMax ( )

virtual

◆ GetScalarSize() [1/2]

virtual int vtkImageData::GetScalarSize ( vtkInformation * meta_data )

virtual

Get the size of the scalar type in bytes.

◆ GetScalarSize() [2/2]

virtual int vtkImageData::GetScalarSize ( )

virtual

◆ GetIncrements() [1/6]

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. The first three methods compute the increments based on the active scalar field while the next three, the scalar field is passed in.

◆ GetIncrements() [2/6]

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

virtual

◆ GetIncrements() [3/6]

virtual void vtkImageData::GetIncrements ( vtkIdType inc[3] )

virtual

◆ GetIncrements() [4/6]

virtual vtkIdType* vtkImageData::GetIncrements ( vtkDataArray * scalars )

virtual

◆ GetIncrements() [5/6]

virtual void vtkImageData::GetIncrements	(	vtkDataArray *	scalars,
		vtkIdType &	incX,
		vtkIdType &	incY,
		vtkIdType &	incZ
	)

virtual

◆ GetIncrements() [6/6]

virtual void vtkImageData::GetIncrements	(	vtkDataArray *	scalars,
		vtkIdType	inc[3]
	)

virtual

◆ GetContinuousIncrements() [1/2]

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. The first form of GetContinuousIncrements uses the active scalar field while the second form allows the scalar array to be passed in.

◆ GetContinuousIncrements() [2/2]

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

virtual

◆ GetScalarPointerForExtent()

virtual void* vtkImageData::GetScalarPointerForExtent ( int extent[6] )

virtual

Access the native pointer for the scalar data.

◆ GetScalarPointer() [1/3]

virtual void* vtkImageData::GetScalarPointer ( int coordinates[3] )

virtual

◆ GetScalarPointer() [2/3]

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

virtual

◆ GetScalarPointer() [3/3]

virtual void* vtkImageData::GetScalarPointer ( )

virtual

◆ GetScalarComponentAsFloat()

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

virtual

For access to data from wrappers.

◆ SetScalarComponentFromFloat()

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

virtual

◆ GetScalarComponentAsDouble()

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

virtual

◆ SetScalarComponentFromDouble()

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

virtual

◆ AllocateScalars() [1/2]

virtual void vtkImageData::AllocateScalars	(	int	dataType,
		int	numComponents
	)

virtual

Allocate the point scalars for this dataset.

The data type determines the type of the array (VTK_FLOAT, VTK_INT etc.) where as numComponents determines its number of components.

◆ AllocateScalars() [2/2]

virtual void vtkImageData::AllocateScalars ( vtkInformation * pipeline_info )

virtual

Allocate the point scalars for this dataset.

The data type and the number of components of the array is determined by the meta-data in the pipeline information. This is usually produced by a reader/filter upstream in the pipeline.

◆ CopyAndCastFrom() [1/2]

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.

◆ CopyAndCastFrom() [2/2]

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

inlinevirtual

Definition at line 315 of file vtkImageData.h.

◆ Crop()

void vtkImageData::Crop ( const int * updateExtent )

overridevirtual

Reallocates and copies to set the Extent to updateExtent.

This is used internally when the exact extent is requested, and the source generated more than the update extent.

Reimplemented from vtkDataObject.

◆ GetActualMemorySize()

unsigned long vtkImageData::GetActualMemorySize ( )

overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

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.

◆ GetSpacing() [1/3]

virtual double* vtkImageData::GetSpacing ( )

virtual

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

◆ GetSpacing() [2/3]

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

virtual

◆ GetSpacing() [3/3]

virtual void vtkImageData::GetSpacing ( double [3] )

virtual

◆ SetSpacing() [1/2]

virtual void vtkImageData::SetSpacing	(	double	i,
		double	j,
		double	k
	)

virtual

◆ SetSpacing() [2/2]

virtual void vtkImageData::SetSpacing ( const double ijk[3] )

virtual

◆ GetOrigin() [1/3]

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.

◆ GetOrigin() [2/3]

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

virtual

◆ GetOrigin() [3/3]

virtual void vtkImageData::GetOrigin ( double [3] )

virtual

◆ SetOrigin() [1/2]

virtual void vtkImageData::SetOrigin	(	double	i,
		double	j,
		double	k
	)

virtual

◆ SetOrigin() [2/2]

virtual void vtkImageData::SetOrigin ( const double ijk[3] )

virtual

◆ GetDirectionMatrix()

virtual vtkMatrix3x3* vtkImageData::GetDirectionMatrix ( )

virtual

Set/Get the direction transform of the dataset.

The direction is a 3 by 3 matrix.

◆ SetDirectionMatrix() [1/3]

virtual void vtkImageData::SetDirectionMatrix ( vtkMatrix3x3 * m )

virtual

◆ SetDirectionMatrix() [2/3]

virtual void vtkImageData::SetDirectionMatrix ( const double elements[9] )

virtual

◆ SetDirectionMatrix() [3/3]

virtual void vtkImageData::SetDirectionMatrix	(	double	e00,
		double	e01,
		double	e02,
		double	e10,
		double	e11,
		double	e12,
		double	e20,
		double	e21,
		double	e22
	)

virtual

◆ GetIndexToPhysicalMatrix()

virtual vtkMatrix4x4* vtkImageData::GetIndexToPhysicalMatrix ( )

virtual

Get the transformation matrix from the index space to the physical space coordinate system of the dataset.

The transform is a 4 by 4 matrix.

◆ TransformContinuousIndexToPhysicalPoint() [1/3]

virtual void vtkImageData::TransformContinuousIndexToPhysicalPoint	(	double	i,
		double	j,
		double	k,
		double	xyz[3]
	)

virtual

Convert coordinates from index space (ijk) to physical space (xyz)

◆ TransformContinuousIndexToPhysicalPoint() [2/3]

virtual void vtkImageData::TransformContinuousIndexToPhysicalPoint	(	const double	ijk[3],
		double	xyz[3]
	)

virtual

◆ TransformIndexToPhysicalPoint() [1/2]

virtual void vtkImageData::TransformIndexToPhysicalPoint	(	int	i,
		int	j,
		int	k,
		double	xyz[3]
	)

virtual

◆ TransformIndexToPhysicalPoint() [2/2]

virtual void vtkImageData::TransformIndexToPhysicalPoint	(	const int	ijk[3],
		double	xyz[3]
	)

virtual

◆ TransformContinuousIndexToPhysicalPoint() [3/3]

static void vtkImageData::TransformContinuousIndexToPhysicalPoint	(	double	i,
		double	j,
		double	k,
		double const	origin[3],
		double const	spacing[3],
		double const	direction[9],
		double	xyz[3]
	)

static

◆ GetPhysicalToIndexMatrix()

virtual vtkMatrix4x4* vtkImageData::GetPhysicalToIndexMatrix ( )

virtual

Get the transformation matrix from the physical space to the index space coordinate system of the dataset.

The transform is a 4 by 4 matrix.

◆ TransformPhysicalPointToContinuousIndex() [1/2]

virtual void vtkImageData::TransformPhysicalPointToContinuousIndex	(	double	x,
		double	y,
		double	z,
		double	ijk[3]
	)

virtual

Convert coordinates from physical space (xyz) to index space (ijk)

◆ TransformPhysicalPointToContinuousIndex() [2/2]

virtual void vtkImageData::TransformPhysicalPointToContinuousIndex	(	const double	xyz[3],
		double	ijk[3]
	)

virtual

◆ ComputeIndexToPhysicalMatrix()

static void vtkImageData::ComputeIndexToPhysicalMatrix	(	double const	origin[3],
		double const	spacing[3],
		double const	direction[9],
		double	result[16]
	)

static

◆ TransformPhysicalNormalToContinuousIndex()

virtual void vtkImageData::TransformPhysicalNormalToContinuousIndex	(	const double	xyz[3],
		double	ijk[3]
	)

virtual

Convert normal from physical space (xyz) to index space (ijk)

◆ TransformPhysicalPlaneToContinuousIndex()

virtual void vtkImageData::TransformPhysicalPlaneToContinuousIndex	(	double const	pplane[4],
		double	iplane[4]
	)

virtual

Convert a plane form physical to continuous index.

◆ SetScalarType()

static void vtkImageData::SetScalarType	(	int	,
		vtkInformation *	meta_data
	)

static

◆ GetScalarType() [1/2]

static int vtkImageData::GetScalarType ( vtkInformation * meta_data )

static

◆ HasScalarType()

static bool vtkImageData::HasScalarType ( vtkInformation * meta_data )

static

◆ GetScalarType() [2/2]

int vtkImageData::GetScalarType ( )

◆ GetScalarTypeAsString()

const char* vtkImageData::GetScalarTypeAsString ( )

inline

Definition at line 449 of file vtkImageData.h.

◆ SetNumberOfScalarComponents()

static void vtkImageData::SetNumberOfScalarComponents	(	int	n,
		vtkInformation *	meta_data
	)

static

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info.

◆ GetNumberOfScalarComponents() [1/2]

static int vtkImageData::GetNumberOfScalarComponents ( vtkInformation * meta_data )

static

◆ HasNumberOfScalarComponents()

static bool vtkImageData::HasNumberOfScalarComponents ( vtkInformation * meta_data )

static

◆ GetNumberOfScalarComponents() [2/2]

int vtkImageData::GetNumberOfScalarComponents ( )

◆ CopyInformationFromPipeline()

void vtkImageData::CopyInformationFromPipeline ( vtkInformation * information )

override

Override these to handle origin, spacing, scalar type, and scalar number of components.

See vtkDataObject for details.

◆ CopyInformationToPipeline()

void vtkImageData::CopyInformationToPipeline ( vtkInformation * information )

override

Copy information from this data object to the pipeline information.

This is used by the vtkTrivialProducer that is created when someone calls SetInputData() to connect the image to a pipeline.

◆ PrepareForNewData()

void vtkImageData::PrepareForNewData ( )

overridevirtual

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.

◆ ShallowCopy()

void vtkImageData::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

◆ DeepCopy()

void vtkImageData::DeepCopy ( vtkDataObject * src )

overridevirtual

Reimplemented from vtkDataSet.

◆ GetArrayPointerForExtent()

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).

◆ GetArrayPointer()

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

◆ GetArrayIncrements()

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

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

◆ ComputeInternalExtent()

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 not suffer from any boundary conditions) and place it in intExt.

◆ GetExtentType()

int vtkImageData::GetExtentType ( )

inlineoverridevirtual

The extent type is a 3D extent.

Reimplemented from vtkDataObject.

Definition at line 523 of file vtkImageData.h.

◆ GetData() [1/2]

static vtkImageData* vtkImageData::GetData ( vtkInformation * info )

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

static

◆ ComputeIncrements() [1/6]

void vtkImageData::ComputeIncrements ( )

inlineprotected

Definition at line 604 of file vtkImageData.h.

◆ ComputeIncrements() [2/6]

void vtkImageData::ComputeIncrements ( int numberOfComponents )

inlineprotected

Definition at line 610 of file vtkImageData.h.

◆ ComputeIncrements() [3/6]

void vtkImageData::ComputeIncrements ( vtkDataArray * scalars )

inlineprotected

Definition at line 616 of file vtkImageData.h.

◆ ComputeIncrements() [4/6]

void vtkImageData::ComputeIncrements ( vtkIdType inc[3] )

protected

◆ ComputeIncrements() [5/6]

void vtkImageData::ComputeIncrements	(	int	numberOfComponents,
		vtkIdType	inc[3]
	)

protected

◆ ComputeIncrements() [6/6]

void vtkImageData::ComputeIncrements	(	vtkDataArray *	scalars,
		vtkIdType	inc[3]
	)

protected

◆ ComputeTransforms()

void vtkImageData::ComputeTransforms ( )

protected

◆ GetCellTemplateForDataDescription() [1/2]

vtkCell* vtkImageData::GetCellTemplateForDataDescription ( )

protected

◆ GetCellTemplateForDataDescription() [2/2]

bool vtkImageData::GetCellTemplateForDataDescription ( vtkGenericCell * cell )

protected

◆ GetIJKMinForCellId()

bool vtkImageData::GetIJKMinForCellId	(	vtkIdType	cellId,
		int	ijkMin[3]
	)

protected

◆ GetIJKMaxForIJKMin()

bool vtkImageData::GetIJKMaxForIJKMin	(	int	ijkMin[3],
		int	ijkMax[3]
	)

protected

◆ AddPointsToCellTemplate()

void vtkImageData::AddPointsToCellTemplate	(	vtkCell *	cell,
		int	ijkMin[3],
		int	ijkMax[3]
	)

protected

◆ SetDataDescription()

void vtkImageData::SetDataDescription ( int desc )

protected

◆ GetDataDescription()

int vtkImageData::GetDataDescription ( )

inlineprotected

Definition at line 579 of file vtkImageData.h.

Friends And Related Function Documentation

◆ vtkUniformGrid

friend class vtkUniformGrid

friend

Definition at line 585 of file vtkImageData.h.

Member Data Documentation

◆ Dimensions

int vtkImageData::Dimensions[3]

protected

Definition at line 540 of file vtkImageData.h.

◆ Increments

vtkIdType vtkImageData::Increments[3]

protected

Definition at line 541 of file vtkImageData.h.

◆ Origin

double vtkImageData::Origin[3]

protected

Definition at line 544 of file vtkImageData.h.

◆ Spacing

double vtkImageData::Spacing[3]

protected

Definition at line 545 of file vtkImageData.h.

◆ DirectionMatrix

vtkMatrix3x3* vtkImageData::DirectionMatrix

protected

Definition at line 546 of file vtkImageData.h.

◆ IndexToPhysicalMatrix

vtkMatrix4x4* vtkImageData::IndexToPhysicalMatrix

protected

Definition at line 547 of file vtkImageData.h.

◆ PhysicalToIndexMatrix

vtkMatrix4x4* vtkImageData::PhysicalToIndexMatrix

protected

Definition at line 548 of file vtkImageData.h.

◆ Extent

int vtkImageData::Extent[6]

protected

Definition at line 550 of file vtkImageData.h.

◆ ExtentComputeTime

vtkTimeStamp vtkImageData::ExtentComputeTime

protected

Definition at line 576 of file vtkImageData.h.

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

dox/Common/DataModel/vtkImageData.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkImageData()

◆ ~vtkImageData()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ CopyStructure()

◆ GetDataObjectType()

◆ GetNumberOfCells()

◆ GetNumberOfPoints()

◆ GetPoint() [1/2]

◆ GetPoint() [2/2]

◆ GetCell() [1/3]

◆ GetCell() [2/3]

◆ GetCell() [3/3]

◆ GetCellBounds()

◆ FindPoint() [1/2]

◆ FindPoint() [2/2]

◆ FindCell() [1/2]

◆ FindCell() [2/2]

◆ FindAndGetCell()

◆ GetCellType()

◆ GetCellPoints()

◆ GetPointCells()

◆ ComputeBounds()

◆ GetMaxCellSize()

◆ Initialize()

◆ SetDimensions() [1/2]

◆ SetDimensions() [2/2]

◆ GetDimensions() [1/2]

◆ GetDimensions() [2/2]

◆ ComputeStructuredCoordinates()

◆ GetVoxelGradient()

◆ GetPointGradient()

◆ GetDataDimension()

◆ ComputePointId()

◆ ComputeCellId()

◆ SetAxisUpdateExtent()

◆ GetAxisUpdateExtent()

◆ SetExtent() [1/2]

◆ SetExtent() [2/2]

◆ GetExtent() [1/3]

◆ GetExtent() [2/3]

◆ GetExtent() [3/3]

◆ GetScalarTypeMin() [1/2]

◆ GetScalarTypeMin() [2/2]

◆ GetScalarTypeMax() [1/2]

◆ GetScalarTypeMax() [2/2]

◆ GetScalarSize() [1/2]

◆ GetScalarSize() [2/2]

◆ GetIncrements() [1/6]

◆ GetIncrements() [2/6]

◆ GetIncrements() [3/6]

◆ GetIncrements() [4/6]

◆ GetIncrements() [5/6]

◆ GetIncrements() [6/6]

◆ GetContinuousIncrements() [1/2]

◆ GetContinuousIncrements() [2/2]

◆ GetScalarPointerForExtent()

◆ GetScalarPointer() [1/3]

◆ GetScalarPointer() [2/3]

◆ GetScalarPointer() [3/3]

◆ GetScalarComponentAsFloat()

◆ SetScalarComponentFromFloat()

◆ GetScalarComponentAsDouble()

◆ SetScalarComponentFromDouble()