vtk
Class vtkImageExport

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkProcessObject
              vtk.vtkImageExport

All Implemented Interfaces:

java.io.Serializable

public class vtkImageExport

extends vtkProcessObject

implements java.io.Serializable

vtkImageExport - Export VTK images to third-party systems.. vtkImageExport provides a way of exporting image data at the end of a pipeline to a third-party system or to a simple C array. Applications can use this to get direct access to the image data in memory. A callback interface is provided to allow connection of the VTK pipeline to a third-party pipeline. This interface conforms to the interface of vtkImageImport. In Python it is possible to use this class to write the image data into a python string that has been pre-allocated to be the correct size. JavaBean wrapper for vtkImageExport 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

	vtkImageExport()
protected	vtkImageExport(int dmy)

Method Summary

void	export() The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer().
java.lang.String	getClassName() Return the class name as a string.
int[]	getDataDimensions() Get the number of scalar components of the data.
int[]	getDataExtent() Get miscellaneous additional information about the data.
int	getDataMemorySize() Get the number of bytes required for the output C array.
int	getDataNumberOfScalarComponents() Get the number of scalar components of the data.
double[]	getDataOrigin() Get miscellaneous additional information about the data.
int	getDataScalarType() Get the scalar type of the data.
java.lang.String	getDataScalarTypeAsString() Get miscellaneous additional information about the data.
double[]	getDataSpacing() Get miscellaneous additional information about the data.
int	getImageLowerLeft() Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner.
vtkImageData	getInput() Set/Get the input object from the image pipeline.
vtkImageExport	getThisImageExport()
void	imageLowerLeftOff() Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner.
void	imageLowerLeftOn() Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner.
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setImageLowerLeft(int id0) Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner.
void	setInput(vtkImageData id0) Set/Get the input object from the image pipeline.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkProcessObject

abortExecuteOff, abortExecuteOn, getAbortExecute, getErrorCode, getNumberOfInputs, getProgress, getProgressMaxValue, getProgressMinValue, getProgressText, getThisProcessObject, removeAllInputs, setAbortExecute, setProgress, setProgressText, squeezeInputArray, updateProgress

Methods inherited from class vtk.vtkObject

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

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

vtkImageExport

public vtkImageExport()

vtkImageExport

protected vtkImageExport(int dmy)

Method Detail

getThisImageExport

public vtkImageExport getThisImageExport()

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 vtkProcessObject

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 vtkProcessObject

getDataMemorySize

public int getDataMemorySize()

Get the number of bytes required for the output C array.

getDataDimensions

public int[] getDataDimensions()

Get the number of scalar components of the data. Please note that when you index into a C array, the scalar component index comes last, i.e. array[z][y][x][c].

getDataNumberOfScalarComponents

public int getDataNumberOfScalarComponents()

Get the number of scalar components of the data. Please note that when you index into a C array, the scalar component index comes last, i.e. array[z][y][x][c].

getDataScalarType

public int getDataScalarType()

Get the scalar type of the data. The scalar type of the C array must match the scalar type of the data.

getDataScalarTypeAsString

public java.lang.String getDataScalarTypeAsString()

Get miscellaneous additional information about the data.

getDataExtent

public int[] getDataExtent()

Get miscellaneous additional information about the data.

getDataSpacing

public double[] getDataSpacing()

Get miscellaneous additional information about the data.

getDataOrigin

public double[] getDataOrigin()

Get miscellaneous additional information about the data.

setInput

public void setInput(vtkImageData id0)

Set/Get the input object from the image pipeline.

getInput

public vtkImageData getInput()

Set/Get the input object from the image pipeline.

imageLowerLeftOn

public void imageLowerLeftOn()

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

imageLowerLeftOff

public void imageLowerLeftOff()

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

getImageLowerLeft

public int getImageLowerLeft()

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

setImageLowerLeft

public void setImageLowerLeft(int id0)

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

export

public void export()

The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer(). You can also specify a void pointer when you call Export().

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkProcessObject