icy.vtk

Class VtkImageVolume

java.lang.Object

icy.vtk.VtkImageVolume

Direct Known Subclasses:

VtkBinaryVolume

public class VtkImageVolume
extends java.lang.Object

Class to represent a 3D image as a 3D VTK volume object.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VtkImageVolume.VtkVolumeBlendType
static class	VtkImageVolume.VtkVolumeMapperType Deprecated.

Constructor Summary

Constructors

Constructor and Description
VtkImageVolume()

Method Summary

Methods

Modifier and Type	Method and Description
double	getAmbient() Returns the ambient lighting coefficient (global)
VtkImageVolume.VtkVolumeBlendType	getBlendingMode() Returns the blending method for rendering.
double	getDiffuse() Returns the diffuse lighting coefficient (global)
boolean	getGPURendering() Returns true if selected volume mapper is the GPU accelerated raycaster.
int	getInterpolationMode() Returns the interpolation method for rendering.
double	getSampleResolution() Get the sample resolution of the raycaster volume rendering.
double[]	getScale() Returns the XYZ scaling of the volume image
boolean	getShade() Returns true if shading is enabled (global)
double	getSpecular() Returns the specular lighting coefficient (global)
double	getSpecularPower() Returns the specular power (global)
vtk.vtkVolume	getVolume()
vtk.vtkImageData	getVolumeData() Get the current volume image data object.
static boolean	isMapperSupported(vtk.vtkRenderer renderer) Deprecated. Should always return true now.
boolean	isPickable()
boolean	isVisible()
void	release()
void	setAmbient(double value) Sets the ambient lighting coefficient (global)
void	setBlendingMode(VtkImageVolume.VtkVolumeBlendType value) Sets the blending method for rendering.
void	setColorMap(vtk.vtkColorTransferFunction map, int channel) Sets the color map (vtkColorTransferFunction) used to render the specified channel of image volume.
void	setDiffuse(double value) Sets the diffuse lighting coefficient (global)
boolean	setGPURendering(boolean value) Enable GPU volume rendering.
void	setInterpolationMode(int value) Sets the interpolation method for rendering.
void	setLUT(LUT.LUTChannel lutChannel, int channel) Sets the LUT.LUTChannel used to render the specified channel of image volume.
void	setLUT(LUT value) Sets the LUT used to render the image volume.
void	setOpacityMap(vtk.vtkPiecewiseFunction map, int channel) Sets the opacity map (vtkPiecewiseFunction) used to render the specified channel of image volume.
void	setPickable(boolean value)
void	setSampleResolution(double value) Set sample resolution for the raycaster volume rendering.
void	setScale(double[] xyz) Sets the XYZ scaling of the volume image
void	setScale(double x, double y, double z) Sets the XYZ scaling of the volume image
void	setShade(boolean value) Enable / Disable the shading (global)
void	setSpecular(double value) Sets the specular lighting coefficient (global)
void	setSpecularPower(double value) Sets the specular power (global)
void	setVisible(boolean value) Sets the visible state of the image volume object
void	setVolumeData(vtk.vtkImageData data) Set the volume image data.

Methods inherited from class java.lang.Object

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

Constructor Detail

VtkImageVolume

public VtkImageVolume()

Method Detail

release

public void release()

getVolume

public vtk.vtkVolume getVolume()

setColorMap

public void setColorMap(vtk.vtkColorTransferFunction map,
               int channel)

Sets the color map (vtkColorTransferFunction) used to render the specified channel of image volume.

setOpacityMap

public void setOpacityMap(vtk.vtkPiecewiseFunction map,
                 int channel)

Sets the opacity map (vtkPiecewiseFunction) used to render the specified channel of image volume.

setLUT

public void setLUT(LUT value)

Sets the LUT used to render the image volume.

setLUT

public void setLUT(LUT.LUTChannel lutChannel,
          int channel)

Sets the LUT.LUTChannel used to render the specified channel of image volume.

getSampleResolution

public double getSampleResolution()

Get the sample resolution of the raycaster volume rendering.

• 0 = automatic
• 1 = finest (slow)
• 10 = coarse (fast)

setSampleResolution

public void setSampleResolution(double value)

Set sample resolution for the raycaster volume rendering.

• 0 = automatic
• 1 = finest (slow)
• 10 = coarse (fast)

isPickable

public boolean isPickable()

setPickable

public void setPickable(boolean value)

getScale

public double[] getScale()

Returns the XYZ scaling of the volume image

setScale

public void setScale(double x,
            double y,
            double z)

Sets the XYZ scaling of the volume image

setScale

public void setScale(double[] xyz)

Sets the XYZ scaling of the volume image

getShade

public boolean getShade()

Returns true if shading is enabled (global)

setShade

public void setShade(boolean value)

Enable / Disable the shading (global)

getAmbient

public double getAmbient()

Returns the ambient lighting coefficient (global)

setAmbient

public void setAmbient(double value)

Sets the ambient lighting coefficient (global)

getDiffuse

public double getDiffuse()

Returns the diffuse lighting coefficient (global)

setDiffuse

public void setDiffuse(double value)

Sets the diffuse lighting coefficient (global)

getSpecular

public double getSpecular()

Returns the specular lighting coefficient (global)

setSpecular

public void setSpecular(double value)

Sets the specular lighting coefficient (global)

getSpecularPower

public double getSpecularPower()

Returns the specular power (global)

setSpecularPower

public void setSpecularPower(double value)

Sets the specular power (global)

getInterpolationMode

public int getInterpolationMode()

Returns the interpolation method for rendering.
Possible values are:

• VTK_NEAREST_INTERPOLATION
• VTK_LINEAR_INTERPOLATION
• VTK_CUBIC_INTERPOLATION

setInterpolationMode

public void setInterpolationMode(int value)

Sets the interpolation method for rendering.
Possible values are:

• VTK_NEAREST_INTERPOLATION
• VTK_LINEAR_INTERPOLATION
• VTK_CUBIC_INTERPOLATION

getGPURendering

public boolean getGPURendering()

Returns true if selected volume mapper is the GPU accelerated raycaster.

setGPURendering

public boolean setGPURendering(boolean value)

Enable GPU volume rendering.

Parameters:

value - if true then the GPU accelerated raycaster will be used otherwise the classical CPU rayscaster is used.

isMapperSupported

@Deprecated
public static boolean isMapperSupported(vtk.vtkRenderer renderer)

Deprecated. Should always return true now.

getBlendingMode

public VtkImageVolume.VtkVolumeBlendType getBlendingMode()

Returns the blending method for rendering.

setBlendingMode

public void setBlendingMode(VtkImageVolume.VtkVolumeBlendType value)

Sets the blending method for rendering.

getVolumeData

public vtk.vtkImageData getVolumeData()

Get the current volume image data object.

See Also:

VtkUtil.getImageData(Object, DataType, int, int, int, int)

setVolumeData

public void setVolumeData(vtk.vtkImageData data)

Set the volume image data.

See Also:

VtkUtil.getImageData(Object, DataType, int, int, int, int)

setVisible

public void setVisible(boolean value)

Sets the visible state of the image volume object

isVisible

public boolean isVisible()

Returns:

visible state of the image volume object