vtk
Class vtkSpline

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkSpline

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

vtkCardinalSpline, vtkKochanekSpline

public class vtkSpline

extends vtkObject

implements java.io.Serializable

vtkSpline - spline abstract class. vtkSpline is used to create interpolated data points for specified data. vtkSpline is an abstract class: its subclasses vtkCardinalSpline and vtkKochenekSpline do the interpolation. The current implementation of splines is limited to data dimensions not exceeding four. Typically a spline is used by adding a sequence of points followed by use of an evaluation function (e.g., vtkCardinalSpline::Evaluate()). Since these splines are 1D, a point in this context is a independent/ dependent variable pair. Note that the parameter space of the spline ranges from (0,N-1), where N is the number of points in the spline. Splines can also be set up to be closed or open. Closed splines continue from the last point to the first point with continuous function and derivative values. (You don't need to duplicate the first point to close the spline, just set ClosedOn.) If the spline is closed, the parameter space of the spline becomes (0,N). JavaBean wrapper for vtkSpline object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkCardinalSpline, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkSpline()
protected	vtkSpline(int dmy)

Method Summary

void	addPoint(double id0, double id1) Add a pair of points to be fit with the spline.
void	clampValueOff() Set/Get ClampValue.
void	clampValueOn() Set/Get ClampValue.
void	closedOff() Control whether the spline is open or closed.
void	closedOn() Control whether the spline is open or closed.
void	compute() Compute the coefficients for the spline.
void	deepCopy(vtkSpline id0) Deep copy of spline data.
double	evaluate(double id0) Interpolate the value of the spline at parametric location of t.
int	getClampValue() Set/Get ClampValue.
java.lang.String	getClassName() Return the class name as a string.
int	getClosed() Control whether the spline is open or closed.
int	getLeftConstraint() Set the type of constraint of the left(right) end points.
int	getLeftConstraintMaxValue() Set the type of constraint of the left(right) end points.
int	getLeftConstraintMinValue() Set the type of constraint of the left(right) end points.
double	getLeftValue() The values of the derivative on the left and right sides.
int	getMTime() Return the MTime also considering the Piecewise function.
int	getRightConstraint() Set the type of constraint of the left(right) end points.
int	getRightConstraintMaxValue() Set the type of constraint of the left(right) end points.
int	getRightConstraintMinValue() Set the type of constraint of the left(right) end points.
double	getRightValue() The values of the derivative on the left and right sides.
vtkSpline	getThisSpline()
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	removeAllPoints() Remove all points from the data.
void	removePoint(double id0) Remove a point from the data to be fit with the spline.
void	setClampValue(int id0) Set/Get ClampValue.
void	setClosed(int id0) Control whether the spline is open or closed.
void	setLeftConstraint(int id0) Set the type of constraint of the left(right) end points.
void	setLeftValue(double id0) The values of the derivative on the left and right sides.
void	setRightConstraint(int id0) Set the type of constraint of the left(right) end points.
void	setRightValue(double id0) The values of the derivative on the left and right sides.
protected void	VTKCastInit()

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

vtkSpline

public vtkSpline()

vtkSpline

protected vtkSpline(int dmy)

Method Detail

getThisSpline

public vtkSpline getThisSpline()

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

setClampValue

public void setClampValue(int id0)

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

getClampValue

public int getClampValue()

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

clampValueOn

public void clampValueOn()

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

clampValueOff

public void clampValueOff()

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

compute

public void compute()

Compute the coefficients for the spline.

evaluate

public double evaluate(double id0)

Interpolate the value of the spline at parametric location of t.

addPoint

public void addPoint(double id0,
                     double id1)

Add a pair of points to be fit with the spline.

removePoint

public void removePoint(double id0)

Remove a point from the data to be fit with the spline.

removeAllPoints

public void removeAllPoints()

Remove all points from the data.

setClosed

public void setClosed(int id0)

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

getClosed

public int getClosed()

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

closedOn

public void closedOn()

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

closedOff

public void closedOff()

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

setLeftConstraint

public void setLeftConstraint(int id0)

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

getLeftConstraintMinValue

public int getLeftConstraintMinValue()

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

getLeftConstraintMaxValue

public int getLeftConstraintMaxValue()

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

getLeftConstraint

public int getLeftConstraint()

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

setRightConstraint

public void setRightConstraint(int id0)

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

getRightConstraintMinValue

public int getRightConstraintMinValue()

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

getRightConstraintMaxValue

public int getRightConstraintMaxValue()

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

getRightConstraint

public int getRightConstraint()

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

setLeftValue

public void setLeftValue(double id0)

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

getLeftValue

public double getLeftValue()

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

setRightValue

public void setRightValue(double id0)

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

getRightValue

public double getRightValue()

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

getMTime

public int getMTime()

Return the MTime also considering the Piecewise function.

Overrides:

getMTime in class vtkObject

deepCopy

public void deepCopy(vtkSpline id0)

Deep copy of spline data.

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkObject