vtk
Class vtkEncodedGradientEstimator

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkEncodedGradientEstimator

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

vtkFiniteDifferenceGradientEstimator

public class vtkEncodedGradientEstimator

extends vtkObject

implements java.io.Serializable

vtkEncodedGradientEstimator - Superclass for gradient estimation. vtkEncodedGradientEstimator is an abstract superclass for gradient estimation. It takes a scalar input of vtkImageData, computes a gradient value for every point, and encodes this value into a three byte value (2 for direction, 1 for magnitude) using the vtkDirectionEncoder. The direction encoder is defaulted to a vtkRecursiveSphereDirectionEncoder, but can be overridden with the SetDirectionEncoder method. The scale and the bias values for the gradient magnitude are used to convert it into a one byte value according to v = m*scale + bias where m is the magnitude and v is the resulting one byte value. JavaBean wrapper for vtkEncodedGradientEstimator object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkFiniteDifferenceGradientEstimator, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkEncodedGradientEstimator()
protected	vtkEncodedGradientEstimator(int dmy)

Method Summary

void	boundsClipOff() Turn on / off the bounding of the normal computation by the this->Bounds bounding box
void	boundsClipOn() Turn on / off the bounding of the normal computation by the this->Bounds bounding box
void	computeGradientMagnitudesOff() If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used.
void	computeGradientMagnitudesOn() If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used.
void	cylinderClipOff() If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle.
void	cylinderClipOn() If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle.
int[]	getBounds() Set / Get the bounds of the computation (used if this->ComputationBounds is 1.)
int	getBoundsClip() Turn on / off the bounding of the normal computation by the this->Bounds bounding box
int	getBoundsClipMaxValue() Turn on / off the bounding of the normal computation by the this->Bounds bounding box
int	getBoundsClipMinValue() Turn on / off the bounding of the normal computation by the this->Bounds bounding box
java.lang.String	getClassName() Return the class name as a string.
int	getComputeGradientMagnitudes() If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used.
int	getCylinderClip() If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle.
vtkDirectionEncoder	getDirectionEncoder() Set / Get the direction encoder used to encode normal directions to fit within two bytes
int	getEncodedNormalIndex(int id0) Get the encoded normal at an x,y,z location in the volume
int	getEncodedNormalIndex(int id0, int id1, int id2) Get the encoded normal at an x,y,z location in the volume
double	getGradientMagnitudeBias() Set/Get the scale and bias for the gradient magnitude
double	getGradientMagnitudeScale() Set/Get the scale and bias for the gradient magnitude
vtkImageData	getInput() Set/Get the scalar input for which the normals will be calculated
double	getLastUpdateTimeInCPUSeconds() Get the time required for the last update in seconds or cpu seconds
double	getLastUpdateTimeInSeconds() Get the time required for the last update in seconds or cpu seconds
int	getNumberOfThreads() Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine
int	getNumberOfThreadsMaxValue() Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine
int	getNumberOfThreadsMinValue() Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine
vtkEncodedGradientEstimator	getThisEncodedGradientEstimator()
int	getUseCylinderClip()
double	getZeroNormalThreshold() Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction.
int	getZeroPad() Assume that the data value outside the volume is zero when computing normals.
int	getZeroPadMaxValue() Assume that the data value outside the volume is zero when computing normals.
int	getZeroPadMinValue() Assume that the data value outside the volume is zero when computing normals.
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setBounds(int[] id0) Set / Get the bounds of the computation (used if this->ComputationBounds is 1.)
void	setBounds(int id0, int id1, int id2, int id3, int id4, int id5) Set / Get the bounds of the computation (used if this->ComputationBounds is 1.)
void	setBoundsClip(int id0) Turn on / off the bounding of the normal computation by the this->Bounds bounding box
void	setComputeGradientMagnitudes(int id0) If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used.
void	setCylinderClip(int id0) If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle.
void	setDirectionEncoder(vtkDirectionEncoder id0) Set / Get the direction encoder used to encode normal directions to fit within two bytes
void	setGradientMagnitudeBias(double id0) Set/Get the scale and bias for the gradient magnitude
void	setGradientMagnitudeScale(double id0) Set/Get the scale and bias for the gradient magnitude
void	setInput(vtkImageData id0) Set/Get the scalar input for which the normals will be calculated
void	setNumberOfThreads(int id0) Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine
void	setZeroNormalThreshold(double id0) Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction.
void	setZeroPad(int id0) Assume that the data value outside the volume is zero when computing normals.
void	update() Recompute the encoded normals and gradient magnitudes.
protected void	VTKCastInit()
void	zeroPadOff() Assume that the data value outside the volume is zero when computing normals.
void	zeroPadOn() Assume that the data value outside the volume is zero when computing normals.

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, VTKInit

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

vtkEncodedGradientEstimator

public vtkEncodedGradientEstimator()

vtkEncodedGradientEstimator

protected vtkEncodedGradientEstimator(int dmy)

Method Detail

getThisEncodedGradientEstimator

public vtkEncodedGradientEstimator getThisEncodedGradientEstimator()

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 vtkObject

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 vtkObject

setInput

public void setInput(vtkImageData id0)

Set/Get the scalar input for which the normals will be calculated

getInput

public vtkImageData getInput()

Set/Get the scalar input for which the normals will be calculated

setGradientMagnitudeScale

public void setGradientMagnitudeScale(double id0)

Set/Get the scale and bias for the gradient magnitude

getGradientMagnitudeScale

public double getGradientMagnitudeScale()

Set/Get the scale and bias for the gradient magnitude

setGradientMagnitudeBias

public void setGradientMagnitudeBias(double id0)

Set/Get the scale and bias for the gradient magnitude

getGradientMagnitudeBias

public double getGradientMagnitudeBias()

Set/Get the scale and bias for the gradient magnitude

setBoundsClip

public void setBoundsClip(int id0)

Turn on / off the bounding of the normal computation by the this->Bounds bounding box

getBoundsClipMinValue

public int getBoundsClipMinValue()

Turn on / off the bounding of the normal computation by the this->Bounds bounding box

getBoundsClipMaxValue

public int getBoundsClipMaxValue()

Turn on / off the bounding of the normal computation by the this->Bounds bounding box

getBoundsClip

public int getBoundsClip()

Turn on / off the bounding of the normal computation by the this->Bounds bounding box

boundsClipOn

public void boundsClipOn()

Turn on / off the bounding of the normal computation by the this->Bounds bounding box

boundsClipOff

public void boundsClipOff()

Turn on / off the bounding of the normal computation by the this->Bounds bounding box

setBounds

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

Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

setBounds

public void setBounds(int[] id0)

Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

getBounds

public int[] getBounds()

Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

update

public void update()

Recompute the encoded normals and gradient magnitudes.

getEncodedNormalIndex

public int getEncodedNormalIndex(int id0)

Get the encoded normal at an x,y,z location in the volume

getEncodedNormalIndex

public int getEncodedNormalIndex(int id0,
                                 int id1,
                                 int id2)

Get the encoded normal at an x,y,z location in the volume

setNumberOfThreads

public void setNumberOfThreads(int id0)

Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine

getNumberOfThreadsMinValue

public int getNumberOfThreadsMinValue()

Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine

getNumberOfThreadsMaxValue

public int getNumberOfThreadsMaxValue()

Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine

getNumberOfThreads

public int getNumberOfThreads()

Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine

setDirectionEncoder

public void setDirectionEncoder(vtkDirectionEncoder id0)

Set / Get the direction encoder used to encode normal directions to fit within two bytes

getDirectionEncoder

public vtkDirectionEncoder getDirectionEncoder()

Set / Get the direction encoder used to encode normal directions to fit within two bytes

setComputeGradientMagnitudes

public void setComputeGradientMagnitudes(int id0)

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

getComputeGradientMagnitudes

public int getComputeGradientMagnitudes()

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

computeGradientMagnitudesOn

public void computeGradientMagnitudesOn()

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

computeGradientMagnitudesOff

public void computeGradientMagnitudesOff()

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

setCylinderClip

public void setCylinderClip(int id0)

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

getCylinderClip

public int getCylinderClip()

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

cylinderClipOn

public void cylinderClipOn()

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

cylinderClipOff

public void cylinderClipOff()

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

getLastUpdateTimeInSeconds

public double getLastUpdateTimeInSeconds()

Get the time required for the last update in seconds or cpu seconds

getLastUpdateTimeInCPUSeconds

public double getLastUpdateTimeInCPUSeconds()

Get the time required for the last update in seconds or cpu seconds

getUseCylinderClip

public int getUseCylinderClip()

setZeroNormalThreshold

public void setZeroNormalThreshold(double id0)

Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader.

getZeroNormalThreshold

public double getZeroNormalThreshold()

Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader.

setZeroPad

public void setZeroPad(int id0)

Assume that the data value outside the volume is zero when computing normals.

getZeroPadMinValue

public int getZeroPadMinValue()

Assume that the data value outside the volume is zero when computing normals.

getZeroPadMaxValue

public int getZeroPadMaxValue()

Assume that the data value outside the volume is zero when computing normals.

getZeroPad

public int getZeroPad()

Assume that the data value outside the volume is zero when computing normals.

zeroPadOn

public void zeroPadOn()

Assume that the data value outside the volume is zero when computing normals.

zeroPadOff

public void zeroPadOff()

Assume that the data value outside the volume is zero when computing normals.

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkObject