Documentation for vtkSpline

vtkSpline - spline abstract class

Description:

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 continous 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).

See Also:

vtkCardinalSpline vtkKochenekSpline

Methods:

	void vtkSpline ()
	void vtkSpline ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void SetClampValue (int )
	int GetClampValue ()
	void ClampValueOn ()
	void ClampValueOff ()
	void Compute ()
	void AddPoint (float ,float )
	void RemovePoint (float )
	void RemoveAllPoints ()
	void SetClosed (int )
	int GetClosed ()
	void ClosedOn ()
	void ClosedOff ()
	void SetLeftConstraint (int )
	int GetLeftConstraint ()
	void SetRightConstraint (int )
	int GetRightConstraint ()
	void SetLeftValue (float )
	float GetLeftValue ()
	void SetRightValue (float )
	float GetRightValue ()
	unsigned long GetMTime ()

Detailed Method Descriptions:

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

	void SetClampValue (int )
	int GetClampValue ()
	void ClampValueOn ()
	void ClampValueOff ()

Compute the coefficients for the spline.

void Compute ()

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

void AddPoint (float ,float )

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

void RemovePoint (float )

Remove all points from the data.

void RemoveAllPoints ()

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

	void SetClosed (int )
	int GetClosed ()
	void ClosedOn ()
	void ClosedOff ()

Set the type of constraint of the left(right) end points. Three contraints are available: 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.

	void SetLeftConstraint (int )
	int GetLeftConstraint ()
	void SetRightConstraint (int )
	int GetRightConstraint ()
	void SetLeftValue (float )
	float GetLeftValue ()
	void SetRightValue (float )
	float GetRightValue ()

Return the MTime also considering the Piecewise function.

unsigned long GetMTime ()