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
typedef vtkObject Superclass
 
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
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageData * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void CopyStructure (vtkDataSet *ds)
 
virtual int GetDataObjectType ()
 
virtual void Initialize ()
 
virtual void SetDimensions (int i, int j, int k)
 
virtual void SetDimensions (const int dims[3])
 
virtual int GetDataDimension ()
 
virtual void AllocateScalars (int dataType, int numComponents)
 
virtual void AllocateScalars (vtkInformation *pipeline_info)
 
virtual void Crop (const int *updateExtent)
 
virtual unsigned long GetActualMemorySize ()
 
int GetScalarType ()
 
const char * GetScalarTypeAsString ()
 
virtual void CopyInformationFromPipeline (vtkInformation *information)
 
virtual void CopyInformationToPipeline (vtkInformation *information)
 
virtual void PrepareForNewData ()
 
void GetArrayIncrements (vtkDataArray *array, vtkIdType increments[3])
 
void ComputeInternalExtent (int *intExt, int *tgtExt, int *bnds)
 
virtual int GetExtentType ()
 
virtual vtkIdType GetNumberOfCells ()
 
virtual vtkIdType GetNumberOfPoints ()
 
virtual double * GetPoint (vtkIdType ptId)
 
virtual void GetPoint (vtkIdType id, double x[3])
 
virtual vtkCell * GetCell (vtkIdType cellId)
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 
virtual vtkIdType FindPoint (double x, double y, double z)
 
virtual vtkIdType FindPoint (double x[3])
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual vtkCell * FindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual int GetCellType (vtkIdType cellId)
 
virtual void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
 
virtual void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
 
virtual void ComputeBounds ()
 
virtual int GetMaxCellSize ()
 
virtual int * GetDimensions ()
 
virtual void GetDimensions (int dims[3])
 
virtual int ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3])
 
virtual void GetVoxelGradient (int i, int j, int k, vtkDataArray *s, vtkDataArray *g)
 
virtual void GetPointGradient (int i, int j, int k, vtkDataArray *s, double g[3])
 
virtual vtkIdType ComputePointId (int ijk[3])
 
virtual vtkIdType ComputeCellId (int ijk[3])
 
virtual void SetAxisUpdateExtent (int axis, int min, int max, const int *updateExtent, int *axisUpdateExtent)
 
virtual void GetAxisUpdateExtent (int axis, int &min, int &max, const int *updateExtent)
 
virtual void SetExtent (int extent[6])
 
virtual void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 
virtual int * GetExtent ()
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetExtent (int[6])
 
virtual double GetScalarTypeMin (vtkInformation *meta_data)
 
virtual double GetScalarTypeMin ()
 
virtual double GetScalarTypeMax (vtkInformation *meta_data)
 
virtual double GetScalarTypeMax ()
 
virtual int GetScalarSize (vtkInformation *meta_data)
 
virtual int GetScalarSize ()
 
virtual vtkIdType * GetIncrements ()
 
virtual void GetIncrements (vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void GetIncrements (vtkIdType inc[3])
 
virtual vtkIdType * GetIncrements (vtkDataArray *scalars)
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType inc[3])
 
virtual void GetContinuousIncrements (int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void GetContinuousIncrements (vtkDataArray *scalars, int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void * GetScalarPointerForExtent (int extent[6])
 
virtual void * GetScalarPointer (int coordinates[3])
 
virtual void * GetScalarPointer (int x, int y, int z)
 
virtual void * GetScalarPointer ()
 
virtual float GetScalarComponentAsFloat (int x, int y, int z, int component)
 
virtual void SetScalarComponentFromFloat (int x, int y, int z, int component, float v)
 
virtual double GetScalarComponentAsDouble (int x, int y, int z, int component)
 
virtual void SetScalarComponentFromDouble (int x, int y, int z, int component, double v)
 
virtual void CopyAndCastFrom (vtkImageData *inData, int extent[6])
 
virtual void CopyAndCastFrom (vtkImageData *inData, int x0, int x1, int y0, int y1, int z0, int z1)
 
virtual void SetSpacing (double, double, double)
 
virtual void SetSpacing (double[3])
 
virtual double * GetSpacing ()
 
virtual void GetSpacing (double &, double &, double &)
 
virtual void GetSpacing (double[3])
 
virtual void SetOrigin (double, double, double)
 
virtual void SetOrigin (double[3])
 
virtual double * GetOrigin ()
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
virtual void ShallowCopy (vtkDataObject *src)
 
virtual void DeepCopy (vtkDataObject *src)
 
void * GetArrayPointerForExtent (vtkDataArray *array, int extent[6])
 
void * GetArrayPointer (vtkDataArray *array, int coordinates[3])
 
- Public Member Functions inherited from vtkDataSet
vtkDataSet * NewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 
virtual vtkCellIterator * NewCellIterator ()
 
virtual void GetCellTypes (vtkCellTypes *types)
 
unsigned long int GetMTime ()
 
vtkCellData * GetCellData ()
 
vtkPointData * GetPointData ()
 
virtual void Squeeze ()
 
double * GetBounds ()
 
void GetBounds (double bounds[6])
 
double * GetCenter ()
 
void GetCenter (double center[3])
 
double GetLength ()
 
virtual void GetScalarRange (double range[2])
 
double * GetScalarRange ()
 
int CheckAttributes ()
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual vtkIdType GetNumberOfElements (int type)
 
bool HasAnyGhostCells ()
 
bool HasAnyGhostPoints ()
 
vtkUnsignedCharArray * GetPointGhostArray ()
 
void UpdatePointGhostArrayCache ()
 
vtkUnsignedCharArray * AllocatePointGhostArray ()
 
vtkUnsignedCharArray * GetCellGhostArray ()
 
void UpdateCellGhostArrayCache ()
 
vtkUnsignedCharArray * AllocateCellGhostArray ()
 
virtual void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 
vtkIdType FindPoint (double x, double y, double z)
 
virtual void GenerateGhostArray (int zeroExt[6])
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 
virtual bool HasAnyBlankCells ()
 
virtual bool HasAnyBlankPoints ()
 
- Public Member Functions inherited from vtkDataObject
vtkDataObject * NewInstance () const
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 
void DataHasBeenGenerated ()
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkImageData * New ()
 
static int IsTypeOf (const char *type)
 
static vtkImageData * SafeDownCast (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 vtkImageData * GetData (vtkInformation *info)
 
static vtkImageData * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static int IsTypeOf (const char *type)
 
static vtkDataSet * SafeDownCast (vtkObjectBase *o)
 
static vtkDataSet * GetData (vtkInformation *info)
 
static vtkDataSet * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObject * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObject * SafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKey * DATA_TYPE_NAME ()
 
static vtkInformationDataObjectKey * DATA_OBJECT ()
 
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKey * DATA_EXTENT ()
 
static vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKey * DATA_TIME_STEP ()
 
static vtkInformationInformationVectorKey * POINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * CELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * VERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
 
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKey * FIELD_OPERATION ()
 
static vtkInformationDoubleVectorKey * FIELD_RANGE ()
 
static vtkInformationIntegerVectorKey * PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static vtkInformationDoubleVectorKey * ORIGIN ()
 
static vtkInformationDoubleVectorKey * SPACING ()
 
static vtkInformationDoubleVectorKey * BOUNDING_BOX ()
 
static vtkInformationDataObjectKey * SIL ()
 
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformation * SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObject * GetData (vtkInformation *info)
 
static vtkDataObject * GetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkImageData ()
 
 ~vtkImageData ()
 
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 ()
 
virtual void ComputeScalarRange ()
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Dimensions [3]
 
vtkIdType Increments [3]
 
double Origin [3]
 
double Spacing [3]
 
int Extent [6]
 
vtkTimeStamp ExtentComputeTime
 
- Protected Attributes inherited from vtkDataSet
vtkCellData * CellData
 
vtkPointData * PointData
 
vtkCallbackCommand * DataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArray * PointGhostArray
 
vtkUnsignedCharArray * CellGhostArray
 
- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkUniformGrid
 
static void SetNumberOfScalarComponents (int n, vtkInformation *meta_data)
 
static int GetNumberOfScalarComponents (vtkInformation *meta_data)
 
static bool HasNumberOfScalarComponents (vtkInformation *meta_data)
 
int GetNumberOfScalarComponents ()
 

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

Member Typedef Documentation

typedef vtkDataSet vtkImageData::Superclass

Definition at line 49 of file vtkImageData.h.

Constructor & Destructor Documentation

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

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::CopyStructure ( vtkDataSet *  ds)
virtual

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

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual int vtkImageData::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid, and vtkStructuredPoints.

Definition at line 57 of file vtkImageData.h.

virtual vtkIdType vtkImageData::GetNumberOfCells ( )
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkImageData::GetNumberOfPoints ( )
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 464 of file vtkImageData.h.

double * vtkImageData::GetPoint ( vtkIdType  ptId)
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 457 of file vtkImageData.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

virtual vtkCell* vtkImageData::GetCell ( vtkIdType  cellId)
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 68 of file vtkImageData.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual int vtkImageData::GetCellType ( vtkIdType  cellId)
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 84 of file vtkImageData.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 87 of file vtkImageData.h.

virtual void vtkImageData::ComputeBounds ( )
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

virtual int vtkImageData::GetMaxCellSize ( )
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkUniformGrid.

Definition at line 90 of file vtkImageData.h.

virtual void vtkImageData::Initialize ( )
virtual

Restore data object to initial state.

Reimplemented from vtkDataSet.

Reimplemented in vtkUniformGrid.

virtual void vtkImageData::SetDimensions ( int  i,
int  j,
int  k 
)
virtual
Deprecated:
{This is for backward compatibility only - use SetExtent().} Same as SetExtent(0, i-1, 0, j-1, 0, k-1)
virtual void vtkImageData::SetDimensions ( const int  dims[3])
virtual
Deprecated:
{This is for backward compatibility only - use SetExtent().} Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1)
virtual int* vtkImageData::GetDimensions ( )
virtual

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

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

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

virtual int vtkImageData::ComputeStructuredCoordinates ( 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 476 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 157 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 164 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 tcl

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

For access to data from tcl

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

For access to data from tcl

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

For access to data from tcl

virtual void vtkImageData::AllocateScalars ( 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 273 of file vtkImageData.h.

virtual void vtkImageData::Crop ( const int *  updateExtent)
virtual

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.

virtual unsigned long vtkImageData::GetActualMemorySize ( )
virtual

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

virtual void vtkImageData::CopyInformationFromPipeline ( vtkInformation *  information)
virtual

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

virtual void vtkImageData::CopyInformationToPipeline ( vtkInformation *  information)
virtual

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.

virtual void vtkImageData::PrepareForNewData ( )
virtual

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

Reimplemented from vtkDataObject.

virtual void vtkImageData::ShallowCopy ( vtkDataObject *  src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

virtual void vtkImageData::DeepCopy ( vtkDataObject *  src)
virtual

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

virtual int vtkImageData::GetExtentType ( )
inlinevirtual

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 369 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 439 of file vtkImageData.h.

void vtkImageData::ComputeIncrements ( int  numberOfComponents)
inlineprotected

Definition at line 445 of file vtkImageData.h.

void vtkImageData::ComputeIncrements ( vtkDataArray *  scalars)
inlineprotected

Definition at line 451 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 412 of file vtkImageData.h.

Friends And Related Function Documentation

friend class vtkUniformGrid
friend

Definition at line 419 of file vtkImageData.h.

Member Data Documentation

int vtkImageData::Dimensions[3]
protected

Definition at line 386 of file vtkImageData.h.

vtkIdType vtkImageData::Increments[3]
protected

Definition at line 387 of file vtkImageData.h.

double vtkImageData::Origin[3]
protected

Definition at line 389 of file vtkImageData.h.

double vtkImageData::Spacing[3]
protected

Definition at line 390 of file vtkImageData.h.

int vtkImageData::Extent[6]
protected

Definition at line 392 of file vtkImageData.h.

vtkTimeStamp vtkImageData::ExtentComputeTime
protected

Definition at line 409 of file vtkImageData.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.9.1