VTK  9.4.20241013
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkImageData Class Reference

topologically and geometrically regular array of data More...

#include <vtkImageData.h>

Inheritance diagram for vtkImageData:
[legend]
Collaboration diagram for vtkImageData:
[legend]

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.
 
vtkImageDataNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void CopyStructure (vtkDataSet *ds) override
 Copy the geometric and topological structure of an input image data object.
 
void Initialize () override
 Restore object to initial state.
 
int GetDataObjectType () override
 Return what type of dataset this is.
 
vtkStructuredCellArrayGetCells ()
 Return the image data connectivity array.
 
vtkConstantArray< int > * GetCellTypesArray ()
 Get the array of all cell types in the image data.
 
void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int *seedLoc)
 Get cell neighbors around cell located at seedloc, except cell of id cellId.
 
unsigned char IsPointVisible (vtkIdType ptId)
 Return non-zero value if specified point is visible.
 
unsigned char IsCellVisible (vtkIdType cellId)
 Return non-zero value if specified point is visible.
 
bool HasAnyBlankPoints () override
 Returns 1 if there is any visibility constraint on the points, 0 otherwise.
 
bool HasAnyBlankCells () override
 Returns 1 if there is any visibility constraint on the cells, 0 otherwise.
 
virtual int GetDataDescription ()
 Get the data description of the image data.
 
void GetCellDims (int cellDims[3])
 Given the node dimensions of this grid instance, this method computes the node dimensions.
 
virtual void SetDimensions (int i, int j, int k)
 Same as SetExtent(0, i-1, 0, j-1, 0, k-1)
 
virtual void SetDimensions (const int dims[3])
 Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1)
 
virtual int * GetDimensions ()
 Get dimensions of this structured points dataset.
 
virtual void GetDimensions (int dims[3])
 Get dimensions of this structured points dataset.
 
virtual int ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3])
 Convenience function computes the structured coordinates for a point x[3].
 
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.
 
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.
 
virtual int GetDataDimension ()
 Return the dimensionality of the data.
 
virtual vtkIdType ComputePointId (int ijk[3])
 Given a location in structured coordinates (i-j-k), return the point id.
 
virtual vtkIdType ComputeCellId (int ijk[3])
 Given a location in structured coordinates (i-j-k), return the cell id.
 
virtual void AllocateScalars (int dataType, int numComponents)
 Allocate the point scalars for this dataset.
 
virtual void AllocateScalars (vtkInformation *pipeline_info)
 Allocate the point scalars for this dataset.
 
void Crop (const int *updateExtent) override
 Reallocates and copies to set the Extent to updateExtent.
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes).
 
virtual void TransformPhysicalPlaneToContinuousIndex (double const pplane[4], double iplane[4])
 Convert a plane from physical to a continuous index.
 
int GetScalarType ()
 
const char * GetScalarTypeAsString ()
 
void CopyInformationFromPipeline (vtkInformation *information) override
 Override these to handle origin, spacing, scalar type, and scalar number of components.
 
void CopyInformationToPipeline (vtkInformation *information) override
 Copy information from this data object to the pipeline information.
 
void PrepareForNewData () override
 make the output data ready for new data to be inserted.
 
void GetArrayIncrements (vtkDataArray *array, vtkIdType increments[3])
 Since various arrays have different number of components, the will have different increments.
 
void ComputeInternalExtent (int *intExt, int *tgtExt, int *bnds)
 Given how many pixel are required on a side for boundary 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.
 
int GetExtentType () override
 The extent type is a 3D extent.
 
vtkIdType GetNumberOfCells () override
 Standard vtkDataSet API methods.
 
vtkIdType GetNumberOfPoints () override
 Standard vtkDataSet API methods.
 
vtkPointsGetPoints () override
 Standard vtkDataSet API methods.
 
double * GetPoint (vtkIdType ptId) override
 Standard vtkDataSet API methods.
 
void GetPoint (vtkIdType id, double x[3]) override
 Standard vtkDataSet API methods.
 
vtkCellGetCell (vtkIdType cellId) override
 Standard vtkDataSet API methods.
 
vtkCellGetCell (int i, int j, int k) override
 Standard vtkDataSet API methods.
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell) override
 Standard vtkDataSet API methods.
 
void GetCellBounds (vtkIdType cellId, double bounds[6]) override
 Standard vtkDataSet API methods.
 
vtkIdType FindPoint (double x[3]) override
 Standard vtkDataSet API methods.
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Standard vtkDataSet API methods.
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Standard vtkDataSet API methods.
 
vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Standard vtkDataSet API methods.
 
int GetCellType (vtkIdType cellId) override
 Standard vtkDataSet API methods.
 
vtkIdType GetCellSize (vtkIdType cellId) override
 Standard vtkDataSet API methods.
 
void GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts, vtkIdList *ptIds) override
 Standard vtkDataSet API methods.
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
 Standard vtkDataSet API methods.
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 Standard vtkDataSet API methods.
 
void ComputeBounds () override
 Standard vtkDataSet API methods.
 
int GetMaxCellSize () override
 Standard vtkDataSet API methods.
 
int GetMaxSpatialDimension () override
 Standard vtkDataSet API methods.
 
void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) override
 Standard vtkDataSet API methods.
 
virtual void BlankPoint (vtkIdType ptId)
 Methods for supporting blanking of cells.
 
virtual void UnBlankPoint (vtkIdType ptId)
 Methods for supporting blanking of cells.
 
virtual void BlankPoint (int i, int j, int k)
 Methods for supporting blanking of cells.
 
virtual void UnBlankPoint (int i, int j, int k)
 Methods for supporting blanking of cells.
 
virtual void BlankCell (vtkIdType ptId)
 Methods for supporting blanking of cells.
 
virtual void UnBlankCell (vtkIdType ptId)
 Methods for supporting blanking of cells.
 
virtual void BlankCell (int i, int j, int k)
 Methods for supporting blanking of cells.
 
virtual void UnBlankCell (int i, int j, int k)
 Methods for supporting blanking of cells.
 
virtual void SetAxisUpdateExtent (int axis, int min, int max, const int *updateExtent, int *axisUpdateExtent)
 Set / Get the extent on just one axis.
 
virtual void GetAxisUpdateExtent (int axis, int &min, int &max, const int *updateExtent)
 Set / Get the extent on just one axis.
 
virtual void SetExtent (int extent[6])
 Set/Get the extent.
 
virtual void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 Set/Get the extent.
 
virtual int * GetExtent ()
 Set/Get the extent.
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 Set/Get the extent.
 
virtual void GetExtent (int[6])
 Set/Get the extent.
 
virtual double GetScalarTypeMin (vtkInformation *meta_data)
 These returns the minimum and maximum values the ScalarType can hold without overflowing.
 
virtual double GetScalarTypeMin ()
 These returns the minimum and maximum values the ScalarType can hold without overflowing.
 
virtual double GetScalarTypeMax (vtkInformation *meta_data)
 These returns the minimum and maximum values the ScalarType can hold without overflowing.
 
virtual double GetScalarTypeMax ()
 These returns the minimum and maximum values the ScalarType can hold without overflowing.
 
virtual int GetScalarSize (vtkInformation *meta_data)
 Get the size of the scalar type in bytes.
 
virtual int GetScalarSize ()
 Get the size of the scalar type in bytes.
 
virtual vtkIdTypeGetIncrements ()
 Different ways to get the increments for moving around the data.
 
virtual void GetIncrements (vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data.
 
virtual void GetIncrements (vtkIdType inc[3])
 Different ways to get the increments for moving around the data.
 
virtual vtkIdTypeGetIncrements (vtkDataArray *scalars)
 Different ways to get the increments for moving around the data.
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data.
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType inc[3])
 Different ways to get the increments for moving around the data.
 
virtual void GetContinuousIncrements (int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data.
 
virtual void GetContinuousIncrements (vtkDataArray *scalars, int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data.
 
virtual void * GetScalarPointerForExtent (int extent[6])
 Access the native pointer for the scalar data.
 
virtual void * GetScalarPointer (int coordinates[3])
 Access the native pointer for the scalar data.
 
virtual void * GetScalarPointer (int x, int y, int z)
 Access the native pointer for the scalar data.
 
virtual void * GetScalarPointer ()
 Access the native pointer for the scalar data.
 
virtual vtkIdType GetScalarIndexForExtent (int extent[6])
 Access the index for the scalar data.
 
virtual vtkIdType GetScalarIndex (int coordinates[3])
 Access the index for the scalar data.
 
virtual vtkIdType GetScalarIndex (int x, int y, int z)
 Access the index for the scalar data.
 
virtual float GetScalarComponentAsFloat (int x, int y, int z, int component)
 For access to data from wrappers.
 
virtual void SetScalarComponentFromFloat (int x, int y, int z, int component, float v)
 For access to data from wrappers.
 
virtual double GetScalarComponentAsDouble (int x, int y, int z, int component)
 For access to data from wrappers.
 
virtual void SetScalarComponentFromDouble (int x, int y, int z, int component, double v)
 For access to data from wrappers.
 
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.
 
virtual void CopyAndCastFrom (vtkImageData *inData, int x0, int x1, int y0, int y1, int z0, int z1)
 This method is passed a input and output region, and executes the filter algorithm to fill the output from the input.
 
virtual double * GetSpacing ()
 Set the spacing (width,height,length) of the cubical cells that compose the data set.
 
virtual void GetSpacing (double &, double &, double &)
 Set the spacing (width,height,length) of the cubical cells that compose the data set.
 
virtual void GetSpacing (double[3])
 Set the spacing (width,height,length) of the cubical cells that compose the data set.
 
virtual void SetSpacing (double i, double j, double k)
 Set the spacing (width,height,length) of the cubical cells that compose the data set.
 
virtual void SetSpacing (const double ijk[3])
 Set the spacing (width,height,length) of the cubical cells that compose the data set.
 
virtual double * GetOrigin ()
 Set/Get the origin of the dataset.
 
virtual void GetOrigin (double &, double &, double &)
 Set/Get the origin of the dataset.
 
virtual void GetOrigin (double[3])
 Set/Get the origin of the dataset.
 
virtual void SetOrigin (double i, double j, double k)
 Set/Get the origin of the dataset.
 
virtual void SetOrigin (const double ijk[3])
 Set/Get the origin of the dataset.
 
virtual vtkMatrix3x3GetDirectionMatrix ()
 Set/Get the direction transform of the dataset.
 
virtual void SetDirectionMatrix (vtkMatrix3x3 *m)
 Set/Get the direction transform of the dataset.
 
virtual void SetDirectionMatrix (const double elements[9])
 Set/Get the direction transform of the dataset.
 
virtual void SetDirectionMatrix (double e00, double e01, double e02, double e10, double e11, double e12, double e20, double e21, double e22)
 Set/Get the direction transform of the dataset.
 
virtual vtkMatrix4x4GetIndexToPhysicalMatrix ()
 Get the transformation matrix from the index space to the physical space coordinate system of the dataset.
 
void ApplyIndexToPhysicalMatrix (vtkMatrix4x4 *source)
 Set the transformation matrix from the index space to the physical space coordinate system of the dataset.
 
virtual vtkMatrix4x4GetPhysicalToIndexMatrix ()
 Get the transformation matrix from the physical space to the index space coordinate system of the dataset.
 
void ApplyPhysicalToIndexMatrix (vtkMatrix4x4 *source)
 Get the transformation matrix from the physical space to the index space coordinate system of the dataset.
 
virtual void TransformPhysicalPointToContinuousIndex (double x, double y, double z, double ijk[3])
 Convert coordinates from physical space (xyz) to index space (ijk).
 
virtual void TransformPhysicalPointToContinuousIndex (const double xyz[3], double ijk[3])
 Convert coordinates from physical space (xyz) to index space (ijk).
 
virtual void TransformPhysicalNormalToContinuousIndex (const double xyz[3], double ijk[3])
 Convert normal from physical space (xyz) to index space (ijk).
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
void * GetArrayPointerForExtent (vtkDataArray *array, int extent[6])
 These are convenience methods for getting a pointer from any filed array.
 
void * GetArrayPointer (vtkDataArray *array, int coordinates[3])
 These are convenience methods for getting a pointer from any filed array.
 
vtkIdType GetTupleIndex (vtkDataArray *array, int coordinates[3])
 Given a data array and a coordinate, return the index of the tuple in the array corresponding to that coordinate.
 
- Public Member Functions inherited from vtkDataSet
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void CopyStructure (vtkDataSet *ds)=0
 Copy the geometric and topological structure of an object.
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet.
 
virtual vtkIdType GetNumberOfPoints ()=0
 Determine the number of points composing the dataset.
 
virtual vtkIdType GetNumberOfCells ()=0
 Determine the number of cells composing the dataset.
 
virtual vtkPointsGetPoints ()
 If the subclass has (implicit/explicit) points, then return them.
 
virtual double * GetPoint (vtkIdType ptId)=0
 Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
 
virtual void GetPoint (vtkIdType id, double x[3])
 Copy point coordinates into user provided array x[3] for specified point id.
 
virtual vtkCellIteratorNewCellIterator ()
 Return an iterator that traverses the cells in this data set.
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
void SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell)
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual int GetCellType (vtkIdType cellId)=0
 Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkIdType GetCellSize (vtkIdType cellId)
 Get the size of cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset.
 
virtual void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
 Topological inquiry to get points defining cell.
 
virtual void GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts, vtkIdList *ptIds)
 Topological inquiry to get points defining cell.
 
virtual void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
 Topological inquiry to get cells using point.
 
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).
 
int GetCellNumberOfFaces (vtkIdType cellId, unsigned char &cellType, vtkGenericCell *cell)
 Get the number of faces of a cell.
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 Locate cell based on global coordinate x and tolerance squared.
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 This is a version of the above method that can be used with multithreaded applications.
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 Locate the cell that contains a point and return the cell.
 
vtkMTimeType GetMTime () override
 Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data.
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data.
 
virtual void Squeeze ()
 Reclaim any extra memory used to store data.
 
virtual void ComputeBounds ()
 Compute the data bounding box from data points.
 
double * GetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
double * GetCenter ()
 Get the center of the bounding box.
 
void GetCenter (double center[3])
 Get the center of the bounding box.
 
double GetLength ()
 Return the length of the diagonal of the bounding box.
 
double GetLength2 ()
 Return the squared length of the diagonal of the bounding box.
 
void Initialize () override
 Restore data object to initial state.
 
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.
 
double * GetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.
 
virtual int GetMaxCellSize ()=0
 Convenience method returns largest cell size in dataset.
 
virtual int GetMaxSpatialDimension ()
 Get the maximum spatial dimensionality of the data which is the maximum dimension of all cells.
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes).
 
int GetDataObjectType () override
 Return the type of data object.
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry.
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData.
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
virtual vtkMTimeType GetMeshMTime ()
 Abstract method which return the mesh (geometry/topology) modification time.
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise.
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise.
 
virtual bool HasAnyBlankCells ()
 Returns 1 if there are any blanking cells 0 otherwise.
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise.
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point.
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array.
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points.
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell.
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array.
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells.
 
vtkUnsignedCharArrayGetGhostArray (int type) override
 Returns the ghost array for the given type (point or cell).
 
bool SupportsGhostArray (int type) override
 Returns true for POINT or CELL, false otherwise.
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x.
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only.
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 Normally called by pipeline executives or algorithms only.
 
- Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Data objects are composite objects and need to check each part for MTime.
 
virtual void Initialize ()
 Restore data object to initial state,.
 
void ReleaseData ()
 Release data back to system to conserve memory resource.
 
virtual int GetDataObjectType ()
 Return class name of data type.
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
 
virtual unsigned long GetActualMemorySize ()
 Return the actual size of the data in kibibytes (1024 bytes).
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information.
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information.
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data.
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted.
 
virtual void ShallowCopy (vtkDataObject *src)
 The goal of the method is to copy the data up to the array pointers only.
 
virtual void DeepCopy (vtkDataObject *src)
 The goal of the method is to copy the complete data from src into this object.
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent.
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkUnsignedCharArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified attribute type.
 
virtual bool SupportsGhostArray (int type)
 Returns if this type of data object support ghost array for specified type.
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData.
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from.
 
virtual vtkIdType GetNumberOfElements (int type)
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object.
 
virtual vtkTypeBool GetDataReleased ()
 Get the flag indicating the data has been released.
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object.
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object.
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkImageDataNew ()
 
static vtkImageDataExtendedNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageDataSafeDownCast (vtkObjectBase *o)
 
static void SetScalarType (int, vtkInformation *meta_data)
 
static int GetScalarType (vtkInformation *meta_data)
 
static bool HasScalarType (vtkInformation *meta_data)
 
static void ComputeIndexToPhysicalMatrix (double const origin[3], double const spacing[3], double const direction[9], double result[16])
 Static method to compute the IndexToPhysicalMatrix.
 
static void ComputePhysicalToIndexMatrix (double const origin[3], double const spacing[3], double const direction[9], double result[16])
 Static method to compute the PhysicalToIndexMatrix.
 
static vtkImageDataGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkImageDataGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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)
 
static vtkInformationGetNamedFieldInformation (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.
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array.
 
static vtkInformationSetActiveAttribute (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).
 
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).
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters.
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e.
 
static int GetAssociationTypeFromString (const char *associationName)
 Given a string association name, this static method returns an integer association type for the attribute (i.e.
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
static void SetGlobalReleaseDataFlag (vtkTypeBool val)
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
static vtkTypeBool GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
void BuildImplicitStructures ()
 
void BuildPoints ()
 
void BuildCells ()
 
void BuildCellTypes ()
 
- Protected Member Functions inherited from vtkDataSet
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSet ()
 
 ~vtkDataSet () override
 
vtkMTimeType GetGhostCellsTime ()
 Return the MTime of the ghost cells array.
 
virtual void ComputeScalarRange ()
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).
 
- Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Dimensions [3]
 
vtkIdType Increments [3]
 
double Origin [3]
 
double Spacing [3]
 
vtkMatrix3x3DirectionMatrix
 
vtkMatrix4x4IndexToPhysicalMatrix
 
vtkMatrix4x4PhysicalToIndexMatrix
 
int Extent [6]
 
vtkSmartPointer< vtkPointsStructuredPoints
 
vtkSmartPointer< vtkStructuredCellArrayStructuredCells
 
vtkSmartPointer< vtkConstantArray< int > > StructuredCellTypes
 
- Protected Attributes inherited from vtkDataSet
vtkNew< vtkGenericCellGenericCell
 
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
vtkUnsignedCharArrayCellGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
bool PointGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
bool CellGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
vtkTypeBool DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkUniformGrid
 
static void TransformContinuousIndexToPhysicalPoint (double i, double j, double k, double const origin[3], double const spacing[3], double const direction[9], double xyz[3])
 Convert coordinates from index space (ijk) to physical space (xyz).
 
virtual void TransformContinuousIndexToPhysicalPoint (double i, double j, double k, double xyz[3])
 Convert coordinates from index space (ijk) to physical space (xyz).
 
virtual void TransformContinuousIndexToPhysicalPoint (const double ijk[3], double xyz[3])
 Convert coordinates from index space (ijk) to physical space (xyz).
 
virtual void TransformIndexToPhysicalPoint (int i, int j, int k, double xyz[3])
 Convert coordinates from index space (ijk) to physical space (xyz).
 
virtual void TransformIndexToPhysicalPoint (const int ijk[3], double xyz[3])
 Convert coordinates from index space (ijk) to physical space (xyz).
 
static void SetNumberOfScalarComponents (int n, vtkInformation *meta_data)
 Set/Get the number of scalar components for points.
 
static int GetNumberOfScalarComponents (vtkInformation *meta_data)
 Set/Get the number of scalar components for points.
 
static bool HasNumberOfScalarComponents (vtkInformation *meta_data)
 Set/Get the number of scalar components for points.
 
int GetNumberOfScalarComponents ()
 Set/Get the number of scalar components for points.
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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. This representation supports images up to three dimensions. The image may also be oriented (see the DirectionMatrices and related transformation methods). Note however, that not all filters support oriented images.

See also
vtkImageTransform
Examples:
vtkImageData (Examples)
Online Examples:

Tests:
vtkImageData (Tests)

Definition at line 155 of file vtkImageData.h.

Member Typedef Documentation

◆ Superclass

Definition at line 161 of file vtkImageData.h.

Constructor & Destructor Documentation

◆ vtkImageData()

vtkImageData::vtkImageData ( )
protected

◆ ~vtkImageData()

vtkImageData::~vtkImageData ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageData * vtkImageData::New ( )
static

◆ ExtendedNew()

static vtkImageData * vtkImageData::ExtendedNew ( )
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 vtkStructuredPoints, and vtkUniformGrid.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

◆ 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 vtkStructuredPoints, and 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.

◆ Initialize()

void vtkImageData::Initialize ( )
overridevirtual

Restore object to initial state.

Release memory back to system.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

◆ GetDataObjectType()

int vtkImageData::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredPoints, and vtkUniformGrid.

Definition at line 178 of file vtkImageData.h.

◆ GetNumberOfCells()

vtkIdType vtkImageData::GetNumberOfCells ( )
inlineoverridevirtual

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.

Definition at line 871 of file vtkImageData.h.

◆ GetNumberOfPoints()

vtkIdType vtkImageData::GetNumberOfPoints ( )
inlineoverridevirtual

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.

Definition at line 865 of file vtkImageData.h.

◆ GetPoints()

vtkPoints * vtkImageData::GetPoints ( )
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)

Reimplemented from vtkDataSet.

◆ GetPoint() [1/2]

double * vtkImageData::GetPoint ( vtkIdType  ptId)
inlineoverridevirtual

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.

Definition at line 858 of file vtkImageData.h.

◆ GetPoint() [2/2]

void vtkImageData::GetPoint ( vtkIdType  id,
double  x[3] 
)
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)

Reimplemented from vtkDataSet.

◆ GetCell() [1/3]

vtkCell * vtkImageData::GetCell ( vtkIdType  cellId)
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.

◆ GetCell() [2/3]

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

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)

◆ GetCell() [3/3]

void vtkImageData::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
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.

◆ GetCellBounds()

void vtkImageData::GetCellBounds ( vtkIdType  cellId,
double  bounds[6] 
)
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)

Reimplemented from vtkDataSet.

◆ FindPoint()

vtkIdType vtkImageData::FindPoint ( double  x[3])
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.

◆ FindCell() [1/2]

vtkIdType vtkImageData::FindCell ( double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights 
)
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.

◆ 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

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.

◆ FindAndGetCell()

vtkCell * vtkImageData::FindAndGetCell ( double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights 
)
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)

Reimplemented from vtkDataSet.

◆ GetCellType()

int vtkImageData::GetCellType ( vtkIdType  cellId)
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.

◆ GetCellSize()

vtkIdType vtkImageData::GetCellSize ( vtkIdType  cellId)
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)

Reimplemented from vtkDataSet.

◆ GetCellPoints() [1/2]

void vtkImageData::GetCellPoints ( vtkIdType  cellId,
vtkIdType npts,
vtkIdType const *&  pts,
vtkIdList ptIds 
)
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)

Reimplemented from vtkDataSet.

◆ GetCellPoints() [2/2]

void vtkImageData::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
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.

◆ GetPointCells()

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

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.

Definition at line 209 of file vtkImageData.h.

◆ ComputeBounds()

void vtkImageData::ComputeBounds ( )
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)

Reimplemented from vtkDataSet.

◆ GetMaxCellSize()

int vtkImageData::GetMaxCellSize ( )
inlineoverridevirtual

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.

Definition at line 216 of file vtkImageData.h.

◆ GetMaxSpatialDimension()

int vtkImageData::GetMaxSpatialDimension ( )
inlineoverridevirtual

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)

Reimplemented from vtkDataSet.

Definition at line 883 of file vtkImageData.h.

◆ GetCellNeighbors() [1/2]

void vtkImageData::GetCellNeighbors ( vtkIdType  cellId,
vtkIdList ptIds,
vtkIdList cellIds 
)
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)

Reimplemented from vtkDataSet.

◆ GetCells()

vtkStructuredCellArray * vtkImageData::GetCells ( )

Return the image data connectivity array.

NOTE: the returned object should not be modified.

◆ GetCellTypesArray()

vtkConstantArray< int > * vtkImageData::GetCellTypesArray ( )

Get the array of all cell types in the image data.

Each single-component integer value is the same. The array is of size GetNumberOfCells().

NOTE: the returned object should not be modified.

◆ GetCellNeighbors() [2/2]

void vtkImageData::GetCellNeighbors ( vtkIdType  cellId,
vtkIdList ptIds,
vtkIdList cellIds,
int *  seedLoc 
)

Get cell neighbors around cell located at seedloc, except cell of id cellId.

Warning
seedloc is the position in the grid with the origin shifted to (0, 0, 0). This is because the backend of this method is shared with vtkRectilinearGrid and vtkStructuredGrid.

◆ BlankPoint() [1/2]

virtual void vtkImageData::BlankPoint ( vtkIdType  ptId)
virtual

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankPoint() [1/2]

virtual void vtkImageData::UnBlankPoint ( vtkIdType  ptId)
virtual

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ BlankPoint() [2/2]

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

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankPoint() [2/2]

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

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ BlankCell() [1/2]

virtual void vtkImageData::BlankCell ( vtkIdType  ptId)
virtual

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankCell() [1/2]

virtual void vtkImageData::UnBlankCell ( vtkIdType  ptId)
virtual

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ BlankCell() [2/2]

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

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankCell() [2/2]

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

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ IsPointVisible()

unsigned char vtkImageData::IsPointVisible ( vtkIdType  ptId)

Return non-zero value if specified point is visible.

These methods should be called only after the dimensions of the grid are set.

◆ IsCellVisible()

unsigned char vtkImageData::IsCellVisible ( vtkIdType  cellId)

Return non-zero value if specified point is visible.

These methods should be called only after the dimensions of the grid are set.

◆ HasAnyBlankPoints()

bool vtkImageData::HasAnyBlankPoints ( )
overridevirtual

Returns 1 if there is any visibility constraint on the points, 0 otherwise.

Reimplemented from vtkDataSet.

◆ HasAnyBlankCells()

bool vtkImageData::HasAnyBlankCells ( )
overridevirtual

Returns 1 if there is any visibility constraint on the cells, 0 otherwise.

Reimplemented from vtkDataSet.

◆ GetDataDescription()

virtual int vtkImageData::GetDataDescription ( )
virtual

Get the data description of the image data.

◆ GetCellDims()

void vtkImageData::GetCellDims ( int  cellDims[3])

Given the node dimensions of this grid instance, this method computes the node dimensions.

The value in each dimension can will have a lowest value of "1" such that computing the total number of cells can be achieved by simply by cellDims[0]*cellDims[1]*cellDims[2].

◆ 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 877 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 374 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 382 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

Set / Get the extent on just one axis.

◆ 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

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.

◆ GetExtent() [1/3]

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.

◆ GetExtent() [2/3]

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.

◆ GetExtent() [3/3]

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.

◆ 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

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

◆ GetScalarTypeMax() [1/2]

virtual double vtkImageData::GetScalarTypeMax ( vtkInformation meta_data)
virtual

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

◆ GetScalarTypeMax() [2/2]

virtual double vtkImageData::GetScalarTypeMax ( )
virtual

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

◆ 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

Get the size of the scalar type in bytes.

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

Note that all methods which do not have the increments passed in are not thread-safe. When working on a given vtkImageData instance on multiple threads, each thread should use the inc* overloads to compute the increments to avoid racing with other threads.

◆ GetIncrements() [2/6]

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

Note that all methods which do not have the increments passed in are not thread-safe. When working on a given vtkImageData instance on multiple threads, each thread should use the inc* overloads to compute the increments to avoid racing with other threads.

◆ GetIncrements() [3/6]

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

Note that all methods which do not have the increments passed in are not thread-safe. When working on a given vtkImageData instance on multiple threads, each thread should use the inc* overloads to compute the increments to avoid racing with other threads.

◆ GetIncrements() [4/6]

virtual vtkIdType * vtkImageData::GetIncrements ( vtkDataArray scalars)
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.

Note that all methods which do not have the increments passed in are not thread-safe. When working on a given vtkImageData instance on multiple threads, each thread should use the inc* overloads to compute the increments to avoid racing with other threads.

◆ GetIncrements() [5/6]

virtual void vtkImageData::GetIncrements ( vtkDataArray scalars,
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. The first three methods compute the increments based on the active scalar field while the next three, the scalar field is passed in.

Note that all methods which do not have the increments passed in are not thread-safe. When working on a given vtkImageData instance on multiple threads, each thread should use the inc* overloads to compute the increments to avoid racing with other threads.

◆ GetIncrements() [6/6]

virtual void vtkImageData::GetIncrements ( vtkDataArray scalars,
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. The first three methods compute the increments based on the active scalar field while the next three, the scalar field is passed in.

Note that all methods which do not have the increments passed in are not thread-safe. When working on a given vtkImageData instance on multiple threads, each thread should use the inc* overloads to compute the increments to avoid racing with other threads.

◆ 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

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.

◆ 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

Access the native pointer for the scalar data.

◆ GetScalarPointer() [2/3]

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

Access the native pointer for the scalar data.

◆ GetScalarPointer() [3/3]

virtual void * vtkImageData::GetScalarPointer ( )
virtual

Access the native pointer for the scalar data.

◆ GetScalarIndexForExtent()

virtual vtkIdType vtkImageData::GetScalarIndexForExtent ( int  extent[6])
virtual

Access the index for the scalar data.

◆ GetScalarIndex() [1/2]

virtual vtkIdType vtkImageData::GetScalarIndex ( int  coordinates[3])
virtual

Access the index for the scalar data.

◆ GetScalarIndex() [2/2]

virtual vtkIdType vtkImageData::GetScalarIndex ( int  x,
int  y,
int  z 
)
virtual

Access the index for the scalar data.

◆ 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

For access to data from wrappers.

◆ GetScalarComponentAsDouble()

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

For access to data from wrappers.

◆ SetScalarComponentFromDouble()

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

For access to data from wrappers.

◆ 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

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 525 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

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

◆ GetSpacing() [3/3]

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

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

◆ SetSpacing() [1/2]

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

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

◆ SetSpacing() [2/2]

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

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

◆ 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

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() [3/3]

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.

◆ SetOrigin() [1/2]

virtual void vtkImageData::SetOrigin ( double  i,
double  j,
double  k 
)
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.

◆ SetOrigin() [2/2]

virtual void vtkImageData::SetOrigin ( const double  ijk[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.

◆ GetDirectionMatrix()

virtual vtkMatrix3x3 * vtkImageData::GetDirectionMatrix ( )
virtual

Set/Get the direction transform of the dataset.

The direction matrix is a 3x3 transformation matrix supporting scaling and rotation.

◆ SetDirectionMatrix() [1/3]

virtual void vtkImageData::SetDirectionMatrix ( vtkMatrix3x3 m)
virtual

Set/Get the direction transform of the dataset.

The direction matrix is a 3x3 transformation matrix supporting scaling and rotation.

◆ SetDirectionMatrix() [2/3]

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

Set/Get the direction transform of the dataset.

The direction matrix is a 3x3 transformation matrix supporting scaling and rotation.

◆ 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

Set/Get the direction transform of the dataset.

The direction matrix is a 3x3 transformation matrix supporting scaling and rotation.

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

◆ ApplyIndexToPhysicalMatrix()

void vtkImageData::ApplyIndexToPhysicalMatrix ( vtkMatrix4x4 source)

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

The transform is a 4 by 4 matrix. The supplied matrix pointer is not stored in the the image object but the matrix values are used for updating the Origin, Spacing, and DirectionMatrix.

See also
SetOrigin
SetSpacing
SetDirectionMatrix

◆ 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

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

◆ TransformIndexToPhysicalPoint() [1/2]

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

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

◆ TransformIndexToPhysicalPoint() [2/2]

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

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

◆ 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

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

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

◆ ApplyPhysicalToIndexMatrix()

void vtkImageData::ApplyPhysicalToIndexMatrix ( vtkMatrix4x4 source)

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. The supplied matrix pointer is not stored in the the image object but the matrix values are used for updating the Origin, Spacing, and DirectionMatrix.

See also
SetOrigin
SetSpacing
SetDirectionMatrix

◆ 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

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

◆ 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 from physical to a continuous index.

The plane is represented as n(x-xo)=0; or using a four component normal: pplane=( nx,ny,nz,-(n(x0)) ).

◆ ComputeIndexToPhysicalMatrix()

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

Static method to compute the IndexToPhysicalMatrix.

◆ ComputePhysicalToIndexMatrix()

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

Static method to compute the PhysicalToIndexMatrix.

◆ 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 685 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

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info.

◆ HasNumberOfScalarComponents()

static bool vtkImageData::HasNumberOfScalarComponents ( vtkInformation meta_data)
static

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info.

◆ GetNumberOfScalarComponents() [2/2]

int vtkImageData::GetNumberOfScalarComponents ( )

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info.

◆ 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

Shallow and Deep copy.

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

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

◆ GetTupleIndex()

vtkIdType vtkImageData::GetTupleIndex ( vtkDataArray array,
int  coordinates[3] 
)

Given a data array and a coordinate, return the index of the tuple in the array corresponding to that coordinate.

This method is analogous to GetArrayPointer(), but it conforms to the API of vtkGenericDataArray.

◆ 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 boundary 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 769 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

Retrieve an instance of this class from an information object.

◆ ComputeIncrements() [1/6]

void vtkImageData::ComputeIncrements ( )
inlineprotected

Definition at line 840 of file vtkImageData.h.

◆ ComputeIncrements() [2/6]

void vtkImageData::ComputeIncrements ( int  numberOfComponents)
inlineprotected

Definition at line 846 of file vtkImageData.h.

◆ ComputeIncrements() [3/6]

void vtkImageData::ComputeIncrements ( vtkDataArray scalars)
inlineprotected

Definition at line 852 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

◆ BuildImplicitStructures()

void vtkImageData::BuildImplicitStructures ( )
protected

◆ BuildPoints()

void vtkImageData::BuildPoints ( )
protected

◆ BuildCells()

void vtkImageData::BuildCells ( )
protected

◆ BuildCellTypes()

void vtkImageData::BuildCellTypes ( )
protected

Friends And Related Symbol Documentation

◆ vtkUniformGrid

friend class vtkUniformGrid
friend

Definition at line 827 of file vtkImageData.h.

Member Data Documentation

◆ Dimensions

int vtkImageData::Dimensions[3]
protected

Definition at line 786 of file vtkImageData.h.

◆ Increments

vtkIdType vtkImageData::Increments[3]
protected

Definition at line 787 of file vtkImageData.h.

◆ Origin

double vtkImageData::Origin[3]
protected

Definition at line 790 of file vtkImageData.h.

◆ Spacing

double vtkImageData::Spacing[3]
protected

Definition at line 791 of file vtkImageData.h.

◆ DirectionMatrix

vtkMatrix3x3* vtkImageData::DirectionMatrix
protected

Definition at line 792 of file vtkImageData.h.

◆ IndexToPhysicalMatrix

vtkMatrix4x4* vtkImageData::IndexToPhysicalMatrix
protected

Definition at line 793 of file vtkImageData.h.

◆ PhysicalToIndexMatrix

vtkMatrix4x4* vtkImageData::PhysicalToIndexMatrix
protected

Definition at line 794 of file vtkImageData.h.

◆ Extent

int vtkImageData::Extent[6]
protected

Definition at line 796 of file vtkImageData.h.

◆ StructuredPoints

vtkSmartPointer<vtkPoints> vtkImageData::StructuredPoints
protected

Definition at line 798 of file vtkImageData.h.

◆ StructuredCells

vtkSmartPointer<vtkStructuredCellArray> vtkImageData::StructuredCells
protected

Definition at line 799 of file vtkImageData.h.

◆ StructuredCellTypes

vtkSmartPointer<vtkConstantArray<int> > vtkImageData::StructuredCellTypes
protected

Definition at line 800 of file vtkImageData.h.


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