Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkSpline Class Reference

spline abstract class. More...

#include <vtkSpline.h>

Inheritance diagram for vtkSpline:

Inheritance graph
[legend]
Collaboration diagram for vtkSpline:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetClampValue (int)
virtual int GetClampValue ()
virtual void ClampValueOn ()
virtual void ClampValueOff ()
virtual void Compute ()=0
void AddPoint (float t, float x)
void RemovePoint (float t)
void RemoveAllPoints ()
virtual void SetClosed (int)
virtual int GetClosed ()
virtual void ClosedOn ()
virtual void ClosedOff ()
virtual void SetLeftConstraint (int)
virtual int GetLeftConstraint ()
virtual void SetRightConstraint (int)
virtual int GetRightConstraint ()
virtual void SetLeftValue (float)
virtual float GetLeftValue ()
virtual void SetRightValue (float)
virtual float GetRightValue ()
unsigned long GetMTime ()

Static Public Methods

int IsTypeOf (const char *type)
vtkSpline * SafeDownCast (vtkObject *o)

Protected Methods

 vtkSpline ()
 ~vtkSpline ()
 vtkSpline (const vtkSpline &)
void operator= (const vtkSpline &)

Protected Attributes

unsigned long ComputeTime
int ClampValue
float * Intervals
float * Coefficients
int LeftConstraint
float LeftValue
int RightConstraint
float RightValue
vtkPiecewiseFunctionPiecewiseFunction
int Closed

Detailed Description

spline abstract class.

Date:
2000/12/10 20:08:52
Revision:
1.17

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

See also:
vtkCardinalSpline vtkKochenekSpline


Member Function Documentation

void vtkSpline::AddPoint float    t,
float    x
 

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

virtual void vtkSpline::Compute   [pure virtual]
 

Compute the coefficients for the spline.

Implemented in vtkCardinalSpline.

virtual const char* vtkSpline::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline.

unsigned long vtkSpline::GetMTime   [virtual]
 

Return the MTime also considering the Piecewise function.

Reimplemented from vtkObject.

virtual int vtkSpline::IsA const char *    type [virtual]
 

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline.

int vtkSpline::IsTypeOf const char *    type [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline.

void vtkSpline::PrintSelf ostream &    os,
vtkIndent    indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline.

void vtkSpline::RemoveAllPoints  
 

Remove all points from the data.

void vtkSpline::RemovePoint float    t
 

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

vtkSpline* vtkSpline::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline.

virtual void vtkSpline::SetClampValue int    [virtual]
 

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

virtual void vtkSpline::SetClosed int    [virtual]
 

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.

virtual void vtkSpline::SetLeftConstraint int    [virtual]
 

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


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:33:10 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002