VTK
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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageDataNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void CopyStructure (vtkDataSet *ds) override
 Copy the geometric and topological structure of an input image data object. More...
 
int GetDataObjectType () override
 Return what type of dataset this is. More...
 
void Initialize () override
 Restore data object to initial state. More...
 
virtual void SetDimensions (int i, int j, int k)
 Same as SetExtent(0, i-1, 0, j-1, 0, k-1) More...
 
virtual void SetDimensions (const int dims[3])
 Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1) More...
 
virtual intGetDimensions ()
 Get dimensions of this structured points dataset. More...
 
virtual void GetDimensions (int dims[3])
 Get dimensions of this structured points dataset. More...
 
virtual int ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3])
 Convenience function computes the structured coordinates for a point x[3]. More...
 
virtual void GetVoxelGradient (int i, int j, int k, vtkDataArray *s, vtkDataArray *g)
 Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners. More...
 
virtual void GetPointGradient (int i, int j, int k, vtkDataArray *s, double g[3])
 Given structured coordinates (i,j,k) for a point in a structured point dataset, compute the gradient vector from the scalar data at that point. More...
 
virtual int GetDataDimension ()
 Return the dimensionality of the data. More...
 
virtual vtkIdType ComputePointId (int ijk[3])
 Given a location in structured coordinates (i-j-k), return the point id. More...
 
virtual vtkIdType ComputeCellId (int ijk[3])
 Given a location in structured coordinates (i-j-k), return the cell id. More...
 
virtual void AllocateScalars (int dataType, int numComponents)
 Allocate the point scalars for this dataset. More...
 
virtual void AllocateScalars (vtkInformation *pipeline_info)
 Allocate the point scalars for this dataset. More...
 
void Crop (const int *updateExtent) override
 Reallocates and copies to set the Extent to updateExtent. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
int GetScalarType ()
 
const char * GetScalarTypeAsString ()
 
void CopyInformationFromPipeline (vtkInformation *information) override
 Override these to handle origin, spacing, scalar type, and scalar number of components. More...
 
void CopyInformationToPipeline (vtkInformation *information) override
 Copy information from this data object to the pipeline information. More...
 
void PrepareForNewData () override
 make the output data ready for new data to be inserted. More...
 
void GetArrayIncrements (vtkDataArray *array, vtkIdType increments[3])
 Since various arrays have different number of components, the will have different increments. More...
 
void ComputeInternalExtent (int *intExt, int *tgtExt, int *bnds)
 Given how many pixel are required on a side for bounrary conditions (in bnds), the target extent to traverse, compute the internal extent (the extent for this ImageData that does not suffer from any boundary conditions) and place it in intExt. More...
 
int GetExtentType () override
 The extent type is a 3D extent. More...
 
vtkIdType GetNumberOfCells () override
 Standard vtkDataSet API methods. More...
 
vtkIdType GetNumberOfPoints () override
 Standard vtkDataSet API methods. More...
 
doubleGetPoint (vtkIdType ptId) override
 Standard vtkDataSet API methods. More...
 
void GetPoint (vtkIdType id, double x[3]) override
 Standard vtkDataSet API methods. More...
 
vtkCellGetCell (vtkIdType cellId) override
 Standard vtkDataSet API methods. More...
 
vtkCellGetCell (int i, int j, int k) override
 Standard vtkDataSet API methods. More...
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell) override
 Standard vtkDataSet API methods. More...
 
void GetCellBounds (vtkIdType cellId, double bounds[6]) override
 Standard vtkDataSet API methods. More...
 
virtual vtkIdType FindPoint (double x, double y, double z)
 Standard vtkDataSet API methods. More...
 
vtkIdType FindPoint (double x[3]) override
 Standard vtkDataSet API methods. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Standard vtkDataSet API methods. More...
 
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. More...
 
vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Standard vtkDataSet API methods. More...
 
int GetCellType (vtkIdType cellId) override
 Standard vtkDataSet API methods. More...
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
 Standard vtkDataSet API methods. More...
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 Standard vtkDataSet API methods. More...
 
void ComputeBounds () override
 Standard vtkDataSet API methods. More...
 
int GetMaxCellSize () override
 Standard vtkDataSet API methods. More...
 
virtual void SetAxisUpdateExtent (int axis, int min, int max, const int *updateExtent, int *axisUpdateExtent)
 Set / Get the extent on just one axis. More...
 
virtual void GetAxisUpdateExtent (int axis, int &min, int &max, const int *updateExtent)
 Set / Get the extent on just one axis. More...
 
virtual void SetExtent (int extent[6])
 Set/Get the extent. More...
 
virtual void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 Set/Get the extent. More...
 
virtual intGetExtent ()
 Set/Get the extent. More...
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 Set/Get the extent. More...
 
virtual void GetExtent (int[6])
 Set/Get the extent. More...
 
virtual double GetScalarTypeMin (vtkInformation *meta_data)
 These returns the minimum and maximum values the ScalarType can hold without overflowing. More...
 
virtual double GetScalarTypeMin ()
 These returns the minimum and maximum values the ScalarType can hold without overflowing. More...
 
virtual double GetScalarTypeMax (vtkInformation *meta_data)
 These returns the minimum and maximum values the ScalarType can hold without overflowing. More...
 
virtual double GetScalarTypeMax ()
 These returns the minimum and maximum values the ScalarType can hold without overflowing. More...
 
virtual int GetScalarSize (vtkInformation *meta_data)
 Get the size of the scalar type in bytes. More...
 
virtual int GetScalarSize ()
 Get the size of the scalar type in bytes. More...
 
virtual vtkIdTypeGetIncrements ()
 Different ways to get the increments for moving around the data. More...
 
virtual void GetIncrements (vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data. More...
 
virtual void GetIncrements (vtkIdType inc[3])
 Different ways to get the increments for moving around the data. More...
 
virtual vtkIdTypeGetIncrements (vtkDataArray *scalars)
 Different ways to get the increments for moving around the data. More...
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data. More...
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType inc[3])
 Different ways to get the increments for moving around the data. More...
 
virtual void GetContinuousIncrements (int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data. More...
 
virtual void GetContinuousIncrements (vtkDataArray *scalars, int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data. More...
 
virtual void * GetScalarPointerForExtent (int extent[6])
 Access the native pointer for the scalar data. More...
 
virtual void * GetScalarPointer (int coordinates[3])
 Access the native pointer for the scalar data. More...
 
virtual void * GetScalarPointer (int x, int y, int z)
 Access the native pointer for the scalar data. More...
 
virtual void * GetScalarPointer ()
 Access the native pointer for the scalar data. More...
 
virtual float GetScalarComponentAsFloat (int x, int y, int z, int component)
 For access to data from wrappers. More...
 
virtual void SetScalarComponentFromFloat (int x, int y, int z, int component, float v)
 For access to data from wrappers. More...
 
virtual double GetScalarComponentAsDouble (int x, int y, int z, int component)
 For access to data from wrappers. More...
 
virtual void SetScalarComponentFromDouble (int x, int y, int z, int component, double v)
 For access to data from wrappers. More...
 
virtual void CopyAndCastFrom (vtkImageData *inData, int extent[6])
 This method is passed a input and output region, and executes the filter algorithm to fill the output from the input. More...
 
virtual void CopyAndCastFrom (vtkImageData *inData, int x0, int x1, int y0, int y1, int z0, int z1)
 This method is passed a input and output region, and executes the filter algorithm to fill the output from the input. More...
 
virtual void SetSpacing (double, double, double)
 Set the spacing (width,height,length) of the cubical cells that compose the data set. More...
 
virtual void SetSpacing (double[3])
 Set the spacing (width,height,length) of the cubical cells that compose the data set. More...
 
virtual doubleGetSpacing ()
 Set the spacing (width,height,length) of the cubical cells that compose the data set. More...
 
virtual void GetSpacing (double &, double &, double &)
 Set the spacing (width,height,length) of the cubical cells that compose the data set. More...
 
virtual void GetSpacing (double[3])
 Set the spacing (width,height,length) of the cubical cells that compose the data set. More...
 
virtual void SetOrigin (double, double, double)
 Set/Get the origin of the dataset. More...
 
virtual void SetOrigin (double[3])
 Set/Get the origin of the dataset. More...
 
virtual doubleGetOrigin ()
 Set/Get the origin of the dataset. More...
 
virtual void GetOrigin (double &, double &, double &)
 Set/Get the origin of the dataset. More...
 
virtual void GetOrigin (double[3])
 Set/Get the origin of the dataset. More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void * GetArrayPointerForExtent (vtkDataArray *array, int extent[6])
 These are convenience methods for getting a pointer from any filed array. More...
 
void * GetArrayPointer (vtkDataArray *array, int coordinates[3])
 These are convenience methods for getting a pointer from any filed array. More...
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...
 
virtual vtkCellIteratorNewCellIterator ()
 Return an iterator that traverses the cells in this data set. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset. More...
 
virtual void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). More...
 
vtkMTimeType GetMTime () override
 Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. More...
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data. More...
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data. More...
 
virtual void Squeeze ()
 Reclaim any extra memory used to store data. More...
 
doubleGetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
doubleGetCenter ()
 Get the center of the bounding box. More...
 
void GetCenter (double center[3])
 Get the center of the bounding box. More...
 
double GetLength ()
 Return the length of the diagonal of the bounding box. More...
 
virtual void GetScalarRange (double range[2])
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
doubleGetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. More...
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise. More...
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise. More...
 
virtual bool HasAnyBlankCells ()
 Returns 1 if there are any blanking cells 0 otherwise. More...
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise. More...
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point. More...
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array. More...
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points. More...
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell. More...
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array. More...
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells. More...
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x. More...
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only. More...
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 Normally called by pipeline executives or algorithms only. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object. More...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object. More...
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkImageDataNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageDataSafeDownCast (vtkObjectBase *o)
 
static int ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3], const int *extent, const double *spacing, const double *origin, const double *bounds)
 
static void SetScalarType (int, vtkInformation *meta_data)
 
static int GetScalarType (vtkInformation *meta_data)
 
static bool HasScalarType (vtkInformation *meta_data)
 
static vtkImageDataGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkImageDataGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
- Static Public Member Functions inherited from vtkDataSet
static int IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int 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) More...
 
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. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
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). More...
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static 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 vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

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 CopyOriginAndSpacingFromPipeline (vtkInformation *info)
 
void SetDataDescription (int desc)
 
int GetDataDescription ()
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet () override
 
virtual void ComputeScalarRange ()
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set. More...
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Dimensions [3]
 
vtkIdType Increments [3]
 
double Origin [3]
 
double Spacing [3]
 
int Extent [6]
 
vtkTimeStamp ExtentComputeTime
 
- Protected Attributes inherited from vtkDataSet
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)) More...
 
vtkUnsignedCharArrayCellGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
bool PointGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
bool CellGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

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

Detailed Description

topologically and geometrically regular array of data

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

Examples:
vtkImageData (Examples)
Tests:
vtkImageData (Tests)

Definition at line 45 of file vtkImageData.h.

Member Typedef Documentation

Definition at line 50 of file vtkImageData.h.

Constructor & Destructor Documentation

vtkImageData::vtkImageData ( )
protected
vtkImageData::~vtkImageData ( )
overrideprotected

Member Function Documentation

static vtkImageData* vtkImageData::New ( )
static
static int vtkImageData::IsTypeOf ( const char *  type)
static
virtual int vtkImageData::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid, and vtkStructuredPoints.

static vtkImageData* vtkImageData::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkImageData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid, and vtkStructuredPoints.

vtkImageData* vtkImageData::NewInstance ( ) const
void vtkImageData::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

void vtkImageData::CopyStructure ( vtkDataSet ds)
overridevirtual

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

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

int vtkImageData::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid, and vtkStructuredPoints.

Definition at line 62 of file vtkImageData.h.

vtkIdType vtkImageData::GetNumberOfCells ( )
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkImageData::GetNumberOfPoints ( )
inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 527 of file vtkImageData.h.

double * vtkImageData::GetPoint ( vtkIdType  ptId)
inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 520 of file vtkImageData.h.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

vtkCell* vtkImageData::GetCell ( vtkIdType  cellId)
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Definition at line 76 of file vtkImageData.h.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

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.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

int vtkImageData::GetCellType ( vtkIdType  cellId)
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 92 of file vtkImageData.h.

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

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 95 of file vtkImageData.h.

void vtkImageData::ComputeBounds ( )
overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

int vtkImageData::GetMaxCellSize ( )
inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 98 of file vtkImageData.h.

void vtkImageData::Initialize ( )
overridevirtual

Restore data object to initial state.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

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

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

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

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

virtual int* vtkImageData::GetDimensions ( )
virtual

Get dimensions of this structured points dataset.

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

Warning
Non thread-safe, use second signature if you want it to be.
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.
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.

static int vtkImageData::ComputeStructuredCoordinates ( const double  x[3],
int  ijk[3],
double  pcoords[3],
const int extent,
const double spacing,
const double origin,
const double bounds 
)
static
virtual void vtkImageData::GetVoxelGradient ( int  i,
int  j,
int  k,
vtkDataArray s,
vtkDataArray g 
)
virtual

Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners.

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

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

Given structured coordinates (i,j,k) for a point in a structured point dataset, compute the gradient vector from the scalar data at that point.

The scalars s are the scalars from which the gradient is to be computed. This method will treat structured point datasets of any dimension.

int vtkImageData::GetDataDimension ( )
inlinevirtual

Return the dimensionality of the data.

Definition at line 539 of file vtkImageData.h.

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

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

Definition at line 175 of file vtkImageData.h.

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

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

Definition at line 181 of file vtkImageData.h.

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

Set / Get the extent on just one axis.

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

Set / Get the extent on just one axis.

virtual void vtkImageData::SetExtent ( int  extent[6])
virtual

Set/Get the extent.

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

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

Set/Get the extent.

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

virtual int* vtkImageData::GetExtent ( )
virtual

Set/Get the extent.

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

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

Set/Get the extent.

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

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

Set/Get the extent.

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

virtual double vtkImageData::GetScalarTypeMin ( vtkInformation meta_data)
virtual

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

virtual double vtkImageData::GetScalarTypeMin ( )
virtual

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

virtual double vtkImageData::GetScalarTypeMax ( vtkInformation meta_data)
virtual

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

virtual double vtkImageData::GetScalarTypeMax ( )
virtual

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

virtual int vtkImageData::GetScalarSize ( vtkInformation meta_data)
virtual

Get the size of the scalar type in bytes.

virtual int vtkImageData::GetScalarSize ( )
virtual

Get the size of the scalar type in bytes.

virtual vtkIdType* vtkImageData::GetIncrements ( )
virtual

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

GetIncrements() calls ComputeIncrements() to ensure the increments are up to date. The first three methods compute the increments based on the active scalar field while the next three, the scalar field is passed in.

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.

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.

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.

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.

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.

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.

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.

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

Access the native pointer for the scalar data.

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

Access the native pointer for the scalar data.

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

Access the native pointer for the scalar data.

virtual void* vtkImageData::GetScalarPointer ( )
virtual

Access the native pointer for the scalar data.

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

For access to data from wrappers.

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

For access to data from wrappers.

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

For access to data from wrappers.

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

For access to data from wrappers.

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.

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.

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

This method is passed a input and output region, and executes the filter algorithm to fill the output from the input.

It just executes a switch statement to call the correct function for the regions data types.

virtual void vtkImageData::CopyAndCastFrom ( vtkImageData inData,
int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
)
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 311 of file vtkImageData.h.

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.

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.

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

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

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

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

virtual double* vtkImageData::GetSpacing ( )
virtual

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

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

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

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

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

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

Set/Get the origin of the dataset.

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

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

Set/Get the origin of the dataset.

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

virtual double* vtkImageData::GetOrigin ( )
virtual

Set/Get the origin of the dataset.

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

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

Set/Get the origin of the dataset.

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

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

Set/Get the origin of the dataset.

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

static void vtkImageData::SetScalarType ( int  ,
vtkInformation meta_data 
)
static
static int vtkImageData::GetScalarType ( vtkInformation meta_data)
static
static bool vtkImageData::HasScalarType ( vtkInformation meta_data)
static
int vtkImageData::GetScalarType ( )
const char* vtkImageData::GetScalarTypeAsString ( )
inline

Definition at line 360 of file vtkImageData.h.

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.

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.

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.

int vtkImageData::GetNumberOfScalarComponents ( )

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info.

void vtkImageData::CopyInformationFromPipeline ( vtkInformation information)
override

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

See vtkDataObject for details.

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.

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.

void vtkImageData::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

void vtkImageData::DeepCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

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

These are convenience methods for getting a pointer from any filed array.

It is a start at expanding image filters to process any array (not just scalars).

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

These are convenience methods for getting a pointer from any filed array.

It is a start at expanding image filters to process any array (not just scalars).

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

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

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

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

int vtkImageData::GetExtentType ( )
inlineoverridevirtual

The extent type is a 3D extent.

Reimplemented from vtkDataObject.

Definition at line 434 of file vtkImageData.h.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

void vtkImageData::ComputeIncrements ( )
inlineprotected

Definition at line 502 of file vtkImageData.h.

void vtkImageData::ComputeIncrements ( int  numberOfComponents)
inlineprotected

Definition at line 508 of file vtkImageData.h.

void vtkImageData::ComputeIncrements ( vtkDataArray scalars)
inlineprotected

Definition at line 514 of file vtkImageData.h.

void vtkImageData::ComputeIncrements ( vtkIdType  inc[3])
protected
void vtkImageData::ComputeIncrements ( int  numberOfComponents,
vtkIdType  inc[3] 
)
protected
void vtkImageData::ComputeIncrements ( vtkDataArray scalars,
vtkIdType  inc[3] 
)
protected
void vtkImageData::CopyOriginAndSpacingFromPipeline ( vtkInformation info)
protected
void vtkImageData::SetDataDescription ( int  desc)
protected
int vtkImageData::GetDataDescription ( )
inlineprotected

Definition at line 477 of file vtkImageData.h.

Friends And Related Function Documentation

friend class vtkUniformGrid
friend

Definition at line 483 of file vtkImageData.h.

Member Data Documentation

int vtkImageData::Dimensions[3]
protected

Definition at line 451 of file vtkImageData.h.

vtkIdType vtkImageData::Increments[3]
protected

Definition at line 452 of file vtkImageData.h.

double vtkImageData::Origin[3]
protected

Definition at line 454 of file vtkImageData.h.

double vtkImageData::Spacing[3]
protected

Definition at line 455 of file vtkImageData.h.

int vtkImageData::Extent[6]
protected

Definition at line 457 of file vtkImageData.h.

vtkTimeStamp vtkImageData::ExtentComputeTime
protected

Definition at line 474 of file vtkImageData.h.


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