vtk
Class vtkHyperStreamline

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkProcessObject
              vtk.vtkSource
                  vtk.vtkPolyDataSource
                      vtk.vtkDataSetToPolyDataFilter
                          vtk.vtkHyperStreamline

All Implemented Interfaces:

java.io.Serializable

public class vtkHyperStreamline

extends vtkDataSetToPolyDataFilter

implements java.io.Serializable

vtkHyperStreamline - generate hyperstreamline in arbitrary dataset. vtkHyperStreamline is a filter that integrates through a tensor field to generate a hyperstreamline. The integration is along the maximum eigenvector and the cross section of the hyperstreamline is defined by the two other eigenvectors. Thus the shape of the hyperstreamline is "tube-like", with the cross section being elliptical. Hyperstreamlines are used to visualize tensor fields. The starting point of a hyperstreamline can be defined in one of two ways. First, you may specify an initial position. This is a x-y-z global coordinate. The second option is to specify a starting location. This is cellId, subId, and cell parametric coordinates. The integration of the hyperstreamline occurs through the major eigenvector field. IntegrationStepLength controls the step length within each cell (i.e., this is the fraction of the cell length). The length of the hyperstreamline is controlled by MaximumPropagationDistance. This parameter is the length of the hyperstreamline in units of distance. The tube itself is composed of many small sub-tubes - NumberOfSides controls the number of sides in the tube, and StepLength controls the length of the sub-tubes. Because hyperstreamlines are often created near regions of singularities, it is possible to control the scaling of the tube cross section by using a logarithmic scale. Use LogScalingOn to turn this capability on. The Radius value controls the initial radius of the tube. JavaBean wrapper for vtkHyperStreamline object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkTensorGlyph, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkHyperStreamline()
protected	vtkHyperStreamline(int dmy)

Method Summary

java.lang.String	getClassName() Return the class name as a string.
int	getIntegrationDirection() Specify the direction in which to integrate the hyperstreamline.
int	getIntegrationDirectionMaxValue() Specify the direction in which to integrate the hyperstreamline.
int	getIntegrationDirectionMinValue() Specify the direction in which to integrate the hyperstreamline.
int	getIntegrationEigenvector() Set / get the eigenvector field through which to ingrate.
int	getIntegrationEigenvectorMaxValue() Set / get the eigenvector field through which to ingrate.
int	getIntegrationEigenvectorMinValue() Set / get the eigenvector field through which to ingrate.
double	getIntegrationStepLength() Set / get a nominal integration step size (expressed as a fraction of the size of each cell).
double	getIntegrationStepLengthMaxValue() Set / get a nominal integration step size (expressed as a fraction of the size of each cell).
double	getIntegrationStepLengthMinValue() Set / get a nominal integration step size (expressed as a fraction of the size of each cell).
int	getLogScaling() Turn on/off logarithmic scaling.
double	getMaximumPropagationDistance() Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
double	getMaximumPropagationDistanceMaxValue() Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
double	getMaximumPropagationDistanceMinValue() Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
int	getNumberOfSides() Set / get the number of sides for the hyperstreamlines.
int	getNumberOfSidesMaxValue() Set / get the number of sides for the hyperstreamlines.
int	getNumberOfSidesMinValue() Set / get the number of sides for the hyperstreamlines.
double	getRadius() Set / get the initial tube radius.
double	getRadiusMaxValue() Set / get the initial tube radius.
double	getRadiusMinValue() Set / get the initial tube radius.
double[]	getStartPosition() Get the start position of the hyperstreamline in global x-y-z coordinates.
double	getStepLength() Set / get the length of a tube segment composing the hyperstreamline.
double	getStepLengthMaxValue() Set / get the length of a tube segment composing the hyperstreamline.
double	getStepLengthMinValue() Set / get the length of a tube segment composing the hyperstreamline.
double	getTerminalEigenvalue() Set/get terminal eigenvalue.
double	getTerminalEigenvalueMaxValue() Set/get terminal eigenvalue.
double	getTerminalEigenvalueMinValue() Set/get terminal eigenvalue.
vtkHyperStreamline	getThisHyperStreamline()
void	integrateMajorEigenvector() Use the major eigenvector field as the vector field through which to integrate.
void	integrateMediumEigenvector() Use the medium eigenvector field as the vector field through which to integrate.
void	integrateMinorEigenvector() Use the minor eigenvector field as the vector field through which to integrate.
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	logScalingOff() Turn on/off logarithmic scaling.
void	logScalingOn() Turn on/off logarithmic scaling.
void	setIntegrationDirection(int id0) Specify the direction in which to integrate the hyperstreamline.
void	setIntegrationDirectionToBackward() Specify the direction in which to integrate the hyperstreamline.
void	setIntegrationDirectionToForward() Specify the direction in which to integrate the hyperstreamline.
void	setIntegrationDirectionToIntegrateBothDirections() Specify the direction in which to integrate the hyperstreamline.
void	setIntegrationEigenvector(int id0) Set / get the eigenvector field through which to ingrate.
void	setIntegrationEigenvectorToMajor() Set / get the eigenvector field through which to ingrate.
void	setIntegrationEigenvectorToMedium() Set / get the eigenvector field through which to ingrate.
void	setIntegrationEigenvectorToMinor() Set / get the eigenvector field through which to ingrate.
void	setIntegrationStepLength(double id0) Set / get a nominal integration step size (expressed as a fraction of the size of each cell).
void	setLogScaling(int id0) Turn on/off logarithmic scaling.
void	setMaximumPropagationDistance(double id0) Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.
void	setNumberOfSides(int id0) Set / get the number of sides for the hyperstreamlines.
void	setRadius(double id0) Set / get the initial tube radius.
void	setStartLocation(int id0, int id1, double[] id2) Specify the start of the hyperstreamline in the cell coordinate system.
void	setStartLocation(int id0, int id1, double id2, double id3, double id4) Specify the start of the hyperstreamline in the cell coordinate system.
void	setStartPosition(double[] id0) Specify the start of the hyperstreamline in the global coordinate system.
void	setStartPosition(double id0, double id1, double id2) Specify the start of the hyperstreamline in the global coordinate system.
void	setStepLength(double id0) Set / get the length of a tube segment composing the hyperstreamline.
void	setTerminalEigenvalue(double id0) Set/get terminal eigenvalue.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkDataSetToPolyDataFilter

computeInputUpdateExtents, getInput, getThisDataSetToPolyDataFilter, setInput

Methods inherited from class vtk.vtkPolyDataSource

getOutput, getOutput, getThisPolyDataSource, setOutput

Methods inherited from class vtk.vtkSource

getNumberOfOutputs, getOutputIndex, getReleaseDataFlag, getThisSource, inRegisterLoop, propagateUpdateExtent, releaseDataFlagOff, releaseDataFlagOn, setReleaseDataFlag, triggerAsynchronousUpdate, unRegister, unRegisterAllOutputs, update, updateData, updateInformation, updateWholeExtent

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

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

vtkHyperStreamline

public vtkHyperStreamline()

vtkHyperStreamline

protected vtkHyperStreamline(int dmy)

Method Detail

getThisHyperStreamline

public vtkHyperStreamline getThisHyperStreamline()

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 vtkDataSetToPolyDataFilter

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 vtkDataSetToPolyDataFilter

setStartLocation

public void setStartLocation(int id0,
                             int id1,
                             double[] id2)

Specify the start of the hyperstreamline in the cell coordinate system. That is, cellId and subId (if composite cell), and parametric coordinates.

setStartLocation

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

Specify the start of the hyperstreamline in the cell coordinate system. That is, cellId and subId (if composite cell), and parametric coordinates.

setStartPosition

public void setStartPosition(double[] id0)

Specify the start of the hyperstreamline in the global coordinate system. Starting from position implies that a search must be performed to find initial cell to start integration from.

setStartPosition

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

Specify the start of the hyperstreamline in the global coordinate system. Starting from position implies that a search must be performed to find initial cell to start integration from.

getStartPosition

public double[] getStartPosition()

Get the start position of the hyperstreamline in global x-y-z coordinates.

setMaximumPropagationDistance

public void setMaximumPropagationDistance(double id0)

Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.

getMaximumPropagationDistanceMinValue

public double getMaximumPropagationDistanceMinValue()

Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.

getMaximumPropagationDistanceMaxValue

public double getMaximumPropagationDistanceMaxValue()

Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.

getMaximumPropagationDistance

public double getMaximumPropagationDistance()

Set / get the maximum length of the hyperstreamline expressed as absolute distance (i.e., arc length) value.

setIntegrationEigenvector

public void setIntegrationEigenvector(int id0)

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

getIntegrationEigenvectorMinValue

public int getIntegrationEigenvectorMinValue()

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

getIntegrationEigenvectorMaxValue

public int getIntegrationEigenvectorMaxValue()

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

getIntegrationEigenvector

public int getIntegrationEigenvector()

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

setIntegrationEigenvectorToMajor

public void setIntegrationEigenvectorToMajor()

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

setIntegrationEigenvectorToMedium

public void setIntegrationEigenvectorToMedium()

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

setIntegrationEigenvectorToMinor

public void setIntegrationEigenvectorToMinor()

Set / get the eigenvector field through which to ingrate. It is possible to integrate using the major, medium or minor eigenvector field. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

integrateMajorEigenvector

public void integrateMajorEigenvector()

Use the major eigenvector field as the vector field through which to integrate. The major eigenvector is the eigenvector whose corresponding eigenvalue is closest to positive infinity.

integrateMediumEigenvector

public void integrateMediumEigenvector()

Use the medium eigenvector field as the vector field through which to integrate. The medium eigenvector is the eigenvector whose corresponding eigenvalue is between the major and minor eigenvalues.

integrateMinorEigenvector

public void integrateMinorEigenvector()

Use the minor eigenvector field as the vector field through which to integrate. The minor eigenvector is the eigenvector whose corresponding eigenvalue is closest to negative infinity.

setIntegrationStepLength

public void setIntegrationStepLength(double id0)

Set / get a nominal integration step size (expressed as a fraction of the size of each cell).

getIntegrationStepLengthMinValue

public double getIntegrationStepLengthMinValue()

Set / get a nominal integration step size (expressed as a fraction of the size of each cell).

getIntegrationStepLengthMaxValue

public double getIntegrationStepLengthMaxValue()

Set / get a nominal integration step size (expressed as a fraction of the size of each cell).

getIntegrationStepLength

public double getIntegrationStepLength()

Set / get a nominal integration step size (expressed as a fraction of the size of each cell).

setStepLength

public void setStepLength(double id0)

Set / get the length of a tube segment composing the hyperstreamline. The length is specified as a fraction of the diagonal length of the input bounding box.

getStepLengthMinValue

public double getStepLengthMinValue()

Set / get the length of a tube segment composing the hyperstreamline. The length is specified as a fraction of the diagonal length of the input bounding box.

getStepLengthMaxValue

public double getStepLengthMaxValue()

Set / get the length of a tube segment composing the hyperstreamline. The length is specified as a fraction of the diagonal length of the input bounding box.

getStepLength

public double getStepLength()

Set / get the length of a tube segment composing the hyperstreamline. The length is specified as a fraction of the diagonal length of the input bounding box.

setIntegrationDirection

public void setIntegrationDirection(int id0)

Specify the direction in which to integrate the hyperstreamline.

getIntegrationDirectionMinValue

public int getIntegrationDirectionMinValue()

Specify the direction in which to integrate the hyperstreamline.

getIntegrationDirectionMaxValue

public int getIntegrationDirectionMaxValue()

Specify the direction in which to integrate the hyperstreamline.

getIntegrationDirection

public int getIntegrationDirection()

Specify the direction in which to integrate the hyperstreamline.

setIntegrationDirectionToForward

public void setIntegrationDirectionToForward()

Specify the direction in which to integrate the hyperstreamline.

setIntegrationDirectionToBackward

public void setIntegrationDirectionToBackward()

Specify the direction in which to integrate the hyperstreamline.

setIntegrationDirectionToIntegrateBothDirections

public void setIntegrationDirectionToIntegrateBothDirections()

Specify the direction in which to integrate the hyperstreamline.

setTerminalEigenvalue

public void setTerminalEigenvalue(double id0)

Set/get terminal eigenvalue. If major eigenvalue falls below this value, hyperstreamline terminates propagation.

getTerminalEigenvalueMinValue

public double getTerminalEigenvalueMinValue()

Set/get terminal eigenvalue. If major eigenvalue falls below this value, hyperstreamline terminates propagation.

getTerminalEigenvalueMaxValue

public double getTerminalEigenvalueMaxValue()

Set/get terminal eigenvalue. If major eigenvalue falls below this value, hyperstreamline terminates propagation.

getTerminalEigenvalue

public double getTerminalEigenvalue()

Set/get terminal eigenvalue. If major eigenvalue falls below this value, hyperstreamline terminates propagation.

setNumberOfSides

public void setNumberOfSides(int id0)

Set / get the number of sides for the hyperstreamlines. At a minimum, number of sides is 3.

getNumberOfSidesMinValue

public int getNumberOfSidesMinValue()

Set / get the number of sides for the hyperstreamlines. At a minimum, number of sides is 3.

getNumberOfSidesMaxValue

public int getNumberOfSidesMaxValue()

Set / get the number of sides for the hyperstreamlines. At a minimum, number of sides is 3.

getNumberOfSides

public int getNumberOfSides()

Set / get the number of sides for the hyperstreamlines. At a minimum, number of sides is 3.

setRadius

public void setRadius(double id0)

Set / get the initial tube radius. This is the maximum "elliptical" radius at the beginning of the tube. Radius varies based on ratio of eigenvalues. Note that tube section is actually elliptical and may become a point or line in cross section in some cases.

getRadiusMinValue

public double getRadiusMinValue()

Set / get the initial tube radius. This is the maximum "elliptical" radius at the beginning of the tube. Radius varies based on ratio of eigenvalues. Note that tube section is actually elliptical and may become a point or line in cross section in some cases.

getRadiusMaxValue

public double getRadiusMaxValue()

Set / get the initial tube radius. This is the maximum "elliptical" radius at the beginning of the tube. Radius varies based on ratio of eigenvalues. Note that tube section is actually elliptical and may become a point or line in cross section in some cases.

getRadius

public double getRadius()

Set / get the initial tube radius. This is the maximum "elliptical" radius at the beginning of the tube. Radius varies based on ratio of eigenvalues. Note that tube section is actually elliptical and may become a point or line in cross section in some cases.

setLogScaling

public void setLogScaling(int id0)

Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the computed eigenvalues are used to scale the cross section radii.

getLogScaling

public int getLogScaling()

Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the computed eigenvalues are used to scale the cross section radii.

logScalingOn

public void logScalingOn()

Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the computed eigenvalues are used to scale the cross section radii.

logScalingOff

public void logScalingOff()

Turn on/off logarithmic scaling. If scaling is on, the log base 10 of the computed eigenvalues are used to scale the cross section radii.

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkDataSetToPolyDataFilter