vtk
Class vtkImageData

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkDataObject
              vtk.vtkDataSet
                  vtk.vtkImageData

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

vtkStructuredPoints

public class vtkImageData

extends vtkDataSet

implements java.io.Serializable

vtkImageData - 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. JavaBean wrapper for vtkImageData object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkImageData()
protected	vtkImageData(int dmy)

Method Summary

void	allocateScalars() Allocate the vtkScalars object associated with this object.
void	computeBounds() Standard vtkDataSet API methods.
int	computeCellId(int[] id0) Given a location in structured coordinates (i-j-k), return the cell id.
int	computePointId(int[] id0) Given a location in structured coordinates (i-j-k), return the point id.
int	computeStructuredCoordinates(double[] id0, int[] id1, double[] id2) Convenience function computes the structured coordinates for a point x[3].
void	copyAndCastFrom(vtkImageData id0, int[] id1) This method is passed a input and output region, and executes the filter algorithm to fill the output from the input.
void	copyAndCastFrom(vtkImageData id0, int id1, int id2, int id3, int id4, int id5, int id6) Reallocates and copies to set the Extent to the UpdateExtent.
void	copyStructure(vtkDataSet id0) Copy the geometric and topological structure of an input image data object.
void	copyTypeSpecificInformation(vtkDataObject id0) By default, there is no type specific information
void	crop() Reallocates and copies to set the Extent to the UpdateExtent.
void	deepCopy(vtkDataObject id0) Shallow and Deep copy.
int	findPoint(double[] id0) Standard vtkDataSet API methods.
int	findPoint(double id0, double id1, double id2) Standard vtkDataSet API methods.
int	getActualMemorySize() Return the actual size of the data in kilobytes.
void	getArrayIncrements(vtkDataArray id0, int[] id1) Since various arrays have different number of components, the will have different increments.
vtkCell	getCell(int id0) Standard vtkDataSet API methods.
void	getCell(int id0, vtkGenericCell id1) Standard vtkDataSet API methods.
void	getCellBounds(int id0, double[] id1) Standard vtkDataSet API methods.
void	getCellPoints(int id0, vtkIdList id1) Standard vtkDataSet API methods.
int	getCellType(int id0) Standard vtkDataSet API methods.
java.lang.String	getClassName() Return the class name as a string.
int	getDataDimension() Return the dimensionality of the data.
int	getDataObjectType() Return what type of dataset this is.
int[]	getDimensions() Get dimensions of this structured points dataset.
void	getDimensions(int[] id0) Get dimensions of this structured points dataset.
int	getEstimatedMemorySize() Get the estimated size of this data object itself.
int[]	getExtent() Different ways to set the extent of the data array.
int	getExtentType() The extent type is a 3D extent
int[]	getIncrements() Different ways to get the increments for moving around the data.
void	getIncrements(int[] id0) Different ways to get the increments for moving around the data.
int	getMaxCellSize() Standard vtkDataSet API methods.
int	getNumberOfCells() Standard vtkDataSet API methods.
int	getNumberOfPoints() Standard vtkDataSet API methods.
int	getNumberOfScalarComponents() Set/Get the number of scalar components for points.
double[]	getOrigin() Set the origin of the data.
double[]	getPoint(int id0) Standard vtkDataSet API methods.
void	getPoint(int id0, double[] id1) Standard vtkDataSet API methods.
void	getPointCells(int id0, vtkIdList id1) Standard vtkDataSet API methods.
void	getPointGradient(int id0, int id1, int id2, vtkDataArray id3, double[] id4) 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.
double	getScalarComponentAsDouble(int id0, int id1, int id2, int id3) For access to data from tcl
int	getScalarSize() Set the size of the scalar type in bytes.
int	getScalarType() Set/Get the data scalar type (i.e VTK_DOUBLE).
java.lang.String	getScalarTypeAsString() Set/Get the data scalar type (i.e VTK_DOUBLE).
double	getScalarTypeMax() These returns the minimum and maximum values the ScalarType can hold without overflowing.
double	getScalarTypeMin() These returns the minimum and maximum values the ScalarType can hold without overflowing.
double[]	getSpacing() Set the spacing (width,height,length) of the cubical cells that compose the data set.
vtkImageData	getThisImageData()
void	getVoxelGradient(int id0, int id1, int id2, vtkDataArray id3, vtkDataArray id4) Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners.
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	prepareForNewData() make the output data ready for new data to be inserted.
void	setAxisUpdateExtent(int id0, int id1, int id2) Set / Get the extent on just one axis
void	setDimensions(int[] id0) Set dimensions of structured points dataset.
void	setDimensions(int id0, int id1, int id2) Set dimensions of structured points dataset.
void	setExtent(int[] id0) Different ways to set the extent of the data array.
void	setExtent(int id0, int id1, int id2, int id3, int id4, int id5) Different ways to set the extent of the data array.
void	setNumberOfScalarComponents(int id0) Set/Get the number of scalar components for points.
void	setOrigin(double[] id0) Set the origin of the data.
void	setOrigin(double id0, double id1, double id2) Set the origin of the data.
void	setScalarComponentFromDouble(int id0, int id1, int id2, int id3, double id4) For access to data from tcl
void	setScalarType(int id0) Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToChar() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToDouble() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToFloat() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToInt() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToLong() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToShort() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToUnsignedChar() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToUnsignedInt() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToUnsignedLong() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setScalarTypeToUnsignedShort() Set/Get the data scalar type (i.e VTK_DOUBLE).
void	setSpacing(double[] id0) Set the spacing (width,height,length) of the cubical cells that compose the data set.
void	setSpacing(double id0, double id1, double id2) Set the spacing (width,height,length) of the cubical cells that compose the data set.
void	setUpdateExtent(int[] id0) Call superclass method to avoid hiding
void	setUpdateExtent(int id0, int id1) Call superclass method to avoid hiding
void	setUpdateExtent(int id0, int id1, int id2) Required for the lowest common denominator for setting the UpdateExtent (i.e. vtkDataSetToStructuredPointsFilter).
void	setUpdateExtent(int id0, int id1, int id2, int id3, int id4, int id5) Call superclass method to avoid hiding
void	shallowCopy(vtkDataObject id0) Shallow and Deep copy.
void	updateData() This update method will supply the ghost level arrays if they are requested.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkDataSet

checkAttributes, getBounds, getBounds, getCellData, getCellNeighbors, getCellTypes, getCenter, getCenter, getLength, getMTime, getPointData, getScalarRange, getScalarRange, getThisDataSet, initialize, squeeze

Methods inherited from class vtk.vtkDataObject

addConsumer, copyInformation, dataHasBeenGenerated, getConsumer, getDataReleased, getExtentTranslator, getFieldData, getGlobalReleaseDataFlag, getLocality, getMaximumNumberOfPieces, getNetReferenceCount, getNumberOfConsumers, getPipelineMTime, getReleaseDataFlag, getRequestExactExtent, getSource, getThisDataObject, getUpdateExtent, getUpdateGhostLevel, getUpdateNumberOfPieces, getUpdatePiece, getUpdateTime, getWholeExtent, globalReleaseDataFlagOff, globalReleaseDataFlagOn, isConsumer, propagateUpdateExtent, releaseData, releaseDataFlagOff, releaseDataFlagOn, removeConsumer, requestExactExtentOff, requestExactExtentOn, setExtentTranslator, setFieldData, setGlobalReleaseDataFlag, setLocality, setMaximumNumberOfPieces, setPipelineMTime, setReleaseDataFlag, setRequestExactExtent, setSource, setUpdateExtentToWholeExtent, setUpdateGhostLevel, setUpdateNumberOfPieces, setUpdatePiece, setWholeExtent, setWholeExtent, shouldIReleaseData, triggerAsynchronousUpdate, unRegister, update, updateInformation

Methods inherited from class vtk.vtkObject

AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay

Methods inherited from class vtk.vtkObjectBase

addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changes

protected java.beans.PropertyChangeSupport changes

Constructor Detail

vtkImageData

public vtkImageData()

vtkImageData

protected vtkImageData(int dmy)

Method Detail

getThisImageData

public vtkImageData getThisImageData()

getClassName

public java.lang.String getClassName()

Description copied from class: vtkObjectBase

Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

getClassName in class vtkDataSet

isA

public int isA(java.lang.String id0)

Description copied from class: vtkObjectBase

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

isA in class vtkDataSet

copyStructure

public void copyStructure(vtkDataSet id0)

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

Overrides:

copyStructure in class vtkDataSet

getDataObjectType

public int getDataObjectType()

Return what type of dataset this is.

Overrides:

getDataObjectType in class vtkDataSet

updateData

public void updateData()

This update method will supply the ghost level arrays if they are requested.

Overrides:

updateData in class vtkDataObject

getNumberOfCells

public int getNumberOfCells()

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getNumberOfCells in class vtkDataSet

getNumberOfPoints

public int getNumberOfPoints()

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getNumberOfPoints in class vtkDataSet

getPoint

public double[] getPoint(int id0)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getPoint in class vtkDataSet

getPoint

public void getPoint(int id0,
                     double[] id1)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getPoint in class vtkDataSet

getCell

public vtkCell getCell(int id0)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getCell in class vtkDataSet

getCell

public void getCell(int id0,
                    vtkGenericCell id1)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getCell in class vtkDataSet

getCellBounds

public void getCellBounds(int id0,
                          double[] id1)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getCellBounds in class vtkDataSet

findPoint

public int findPoint(double id0,
                     double id1,
                     double id2)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

findPoint in class vtkDataSet

findPoint

public int findPoint(double[] id0)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

findPoint in class vtkDataSet

getCellType

public int getCellType(int id0)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getCellType in class vtkDataSet

getCellPoints

public void getCellPoints(int id0,
                          vtkIdList id1)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getCellPoints in class vtkDataSet

getPointCells

public void getPointCells(int id0,
                          vtkIdList id1)

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getPointCells in class vtkDataSet

computeBounds

public void computeBounds()

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

computeBounds in class vtkDataSet

getMaxCellSize

public int getMaxCellSize()

Standard vtkDataSet API methods. See vtkDataSet for more information.

Overrides:

getMaxCellSize in class vtkDataSet

setDimensions

public void setDimensions(int id0,
                          int id1,
                          int id2)

Set dimensions of structured points dataset.

setDimensions

public void setDimensions(int[] id0)

Set dimensions of structured points dataset.

getDimensions

public int[] getDimensions()

Get dimensions of this structured points dataset. Dimensions are computed from Extents during this call.

getDimensions

public void getDimensions(int[] id0)

Get dimensions of this structured points dataset. Dimensions are computed from Extents during this call.

computeStructuredCoordinates

public int computeStructuredCoordinates(double[] id0,
                                        int[] id1,
                                        double[] id2)

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

getVoxelGradient

public void getVoxelGradient(int id0,
                             int id1,
                             int id2,
                             vtkDataArray id3,
                             vtkDataArray id4)

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

getPointGradient

public void getPointGradient(int id0,
                             int id1,
                             int id2,
                             vtkDataArray id3,
                             double[] id4)

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

getDataDimension

public int getDataDimension()

Return the dimensionality of the data.

computePointId

public int computePointId(int[] id0)

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

computeCellId

public int computeCellId(int[] id0)

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

setAxisUpdateExtent

public void setAxisUpdateExtent(int id0,
                                int id1,
                                int id2)

Set / Get the extent on just one axis

setUpdateExtent

public void setUpdateExtent(int id0,
                            int id1,
                            int id2)

Required for the lowest common denominator for setting the UpdateExtent (i.e. vtkDataSetToStructuredPointsFilter). This assumes that WholeExtent is valid (UpdateInformation has been called).

Overrides:

setUpdateExtent in class vtkDataObject

setUpdateExtent

public void setUpdateExtent(int id0,
                            int id1)

Call superclass method to avoid hiding

Overrides:

setUpdateExtent in class vtkDataObject

setUpdateExtent

public void setUpdateExtent(int id0,
                            int id1,
                            int id2,
                            int id3,
                            int id4,
                            int id5)

Call superclass method to avoid hiding

Overrides:

setUpdateExtent in class vtkDataObject

setUpdateExtent

public void setUpdateExtent(int[] id0)

Call superclass method to avoid hiding

Overrides:

setUpdateExtent in class vtkDataObject

setExtent

public void setExtent(int[] id0)

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

setExtent

public void setExtent(int id0,
                      int id1,
                      int id2,
                      int id3,
                      int id4,
                      int id5)

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

getExtent

public int[] getExtent()

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

getEstimatedMemorySize

public int getEstimatedMemorySize()

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

Overrides:

getEstimatedMemorySize in class vtkDataObject

getScalarTypeMin

public double getScalarTypeMin()

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

getScalarTypeMax

public double getScalarTypeMax()

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

getScalarSize

public int getScalarSize()

Set the size of the scalar type in bytes.

getIncrements

public int[] getIncrements()

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

getIncrements

public void getIncrements(int[] id0)

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

getScalarComponentAsDouble

public double getScalarComponentAsDouble(int id0,
                                         int id1,
                                         int id2,
                                         int id3)

For access to data from tcl

setScalarComponentFromDouble

public void setScalarComponentFromDouble(int id0,
                                         int id1,
                                         int id2,
                                         int id3,
                                         double id4)

For access to data from tcl

allocateScalars

public void allocateScalars()

Allocate the vtkScalars object associated with this object.

copyAndCastFrom

public void copyAndCastFrom(vtkImageData id0,
                            int[] id1)

This method is passed a input and output region, and executes the filter algorithm to fill the output from the input. It just executes a switch statement to call the correct function for the regions data types.

copyAndCastFrom

public void copyAndCastFrom(vtkImageData id0,
                            int id1,
                            int id2,
                            int id3,
                            int id4,
                            int id5,
                            int id6)

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

crop

public void crop()

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

getActualMemorySize

public int getActualMemorySize()

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

Overrides:

getActualMemorySize in class vtkDataSet

setSpacing

public void setSpacing(double id0,
                       double id1,
                       double id2)

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

setSpacing

public void setSpacing(double[] id0)

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

getSpacing

public double[] getSpacing()

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

setOrigin

public void setOrigin(double id0,
                      double id1,
                      double id2)

Set the origin of the data. The origin plus spacing determine the position in space of the points.

setOrigin

public void setOrigin(double[] id0)

Set the origin of the data. The origin plus spacing determine the position in space of the points.

getOrigin

public double[] getOrigin()

Set the origin of the data. The origin plus spacing determine the position in space of the points.

setScalarTypeToFloat

public void setScalarTypeToFloat()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToDouble

public void setScalarTypeToDouble()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToInt

public void setScalarTypeToInt()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToUnsignedInt

public void setScalarTypeToUnsignedInt()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToLong

public void setScalarTypeToLong()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToUnsignedLong

public void setScalarTypeToUnsignedLong()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToShort

public void setScalarTypeToShort()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToUnsignedShort

public void setScalarTypeToUnsignedShort()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToUnsignedChar

public void setScalarTypeToUnsignedChar()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarTypeToChar

public void setScalarTypeToChar()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setScalarType

public void setScalarType(int id0)

Set/Get the data scalar type (i.e VTK_DOUBLE).

getScalarType

public int getScalarType()

Set/Get the data scalar type (i.e VTK_DOUBLE).

getScalarTypeAsString

public java.lang.String getScalarTypeAsString()

Set/Get the data scalar type (i.e VTK_DOUBLE).

setNumberOfScalarComponents

public void setNumberOfScalarComponents(int id0)

Set/Get the number of scalar components for points.

getNumberOfScalarComponents

public int getNumberOfScalarComponents()

Set/Get the number of scalar components for points.

copyTypeSpecificInformation

public void copyTypeSpecificInformation(vtkDataObject id0)

Description copied from class: vtkDataObject

By default, there is no type specific information

Overrides:

copyTypeSpecificInformation in class vtkDataObject

prepareForNewData

public void prepareForNewData()

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.

Overrides:

prepareForNewData in class vtkDataObject

shallowCopy

public void shallowCopy(vtkDataObject id0)

Shallow and Deep copy.

Overrides:

shallowCopy in class vtkDataSet

deepCopy

public void deepCopy(vtkDataObject id0)

Shallow and Deep copy.

Overrides:

deepCopy in class vtkDataSet

getArrayIncrements

public void getArrayIncrements(vtkDataArray id0,
                               int[] id1)

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

getExtentType

public int getExtentType()

The extent type is a 3D extent

Overrides:

getExtentType in class vtkDataObject

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkDataObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkDataSet