vtkSpline Class Reference

#include <vtkSpline.h>

Inheritance diagram for vtkSpline:

Inheritance graph
[legend]
Collaboration diagram for vtkSpline:

Collaboration graph
[legend]

List of all members.


Detailed Description

spline abstract class for interpolating splines

vtkSpline interpolates a set of data points (i.e., interpolation means that the spline passes through the points). vtkSpline is an abstract class: its subclasses vtkCardinalSpline and vtkKochenekSpline do the interpolation. Note that this spline maps the 1D parametric coordinate t into a single value x. Thus if you want to use the spline to interpolate points (i.e. x[3]), you have to create three splines for each of the x-y-z coordinates. Fortunately, the vtkParametricSpline class does this for you.

Typically a spline is used by adding a sequence of parametric coordinate / data (t,x) values followed by use of an evaluation function (e.g., vtkCardinalSpline::Evaluate()). Since these splines are 1D, a point in this context is an independent / dependent variable pair.

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

This implementation of splines does not use a normalized parametric coordinate. If the spline is open, then the parameter space is (tMin <= t <= tMax) where tMin and tMax are the minimum and maximum parametric values seen when performing AddPoint(). If the spline is closed, then the parameter space is (tMin <= t <= (tMax+1)) where tMin and tMax are the minimum and maximum parametric values seen when performing AddPoint(). Note, however, that this behavior can be changed by explicitly setting the ParametricRange(tMin,tMax). If set, the parameter space remains (tMin <= t <= tMax), except that additions of data with parametric values outside this range are clamped within this range.

See also:
vtkCardinalSpline vtkKochenekSpline vtkParametricSpline vtkParametricFunctionSource

Definition at line 60 of file vtkSpline.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Compute ()=0
virtual double Evaluate (double t)=0
int GetNumberOfPoints ()
void AddPoint (double t, double x)
void RemovePoint (double t)
void RemoveAllPoints ()
unsigned long GetMTime ()
virtual void DeepCopy (vtkSpline *s)
void SetParametricRange (double tMin, double tMax)
void SetParametricRange (double tRange[2])
void GetParametricRange (double tRange[2]) const
virtual void SetClampValue (int)
virtual int GetClampValue ()
virtual void ClampValueOn ()
virtual void ClampValueOff ()
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 (double)
virtual double GetLeftValue ()
virtual void SetRightValue (double)
virtual double GetRightValue ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkSplineSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSpline ()
 ~vtkSpline ()
double ComputeLeftDerivative ()
double ComputeRightDerivative ()
int FindIndex (int size, double t)

Protected Attributes

unsigned long ComputeTime
int ClampValue
double * Intervals
double * Coefficients
int LeftConstraint
double LeftValue
int RightConstraint
double RightValue
vtkPiecewiseFunctionPiecewiseFunction
int Closed
double ParametricRange [2]

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline, vtkKochanekSpline, and vtkSCurveSpline.

Definition at line 63 of file vtkSpline.h.


Constructor & Destructor Documentation

vtkSpline::vtkSpline (  )  [protected]

vtkSpline::~vtkSpline (  )  [protected]


Member Function Documentation

virtual const char* vtkSpline::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline, vtkKochanekSpline, and vtkSCurveSpline.

static int vtkSpline::IsTypeOf ( const char *  name  )  [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, vtkKochanekSpline, and vtkSCurveSpline.

virtual int vtkSpline::IsA ( const char *  name  )  [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, vtkKochanekSpline, and vtkSCurveSpline.

static vtkSpline* vtkSpline::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

Reimplemented in vtkCardinalSpline, vtkKochanekSpline, and vtkSCurveSpline.

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, vtkKochanekSpline, and vtkSCurveSpline.

void vtkSpline::SetParametricRange ( double  tMin,
double  tMax 
)

Set/Get the parametric range. If not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint() method will clamp the t value to lie within the specified range.

void vtkSpline::SetParametricRange ( double  tRange[2]  )  [inline]

Set/Get the parametric range. If not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint() method will clamp the t value to lie within the specified range.

Definition at line 72 of file vtkSpline.h.

void vtkSpline::GetParametricRange ( double  tRange[2]  )  const

Set/Get the parametric range. If not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint() method will clamp the t value to lie within the specified range.

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 int vtkSpline::GetClampValue (  )  [virtual]

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

virtual void vtkSpline::ClampValueOn (  )  [virtual]

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

virtual void vtkSpline::ClampValueOff (  )  [virtual]

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

virtual void vtkSpline::Compute (  )  [pure virtual]

Compute the coefficients for the spline.

Implemented in vtkCardinalSpline, vtkKochanekSpline, and vtkSCurveSpline.

virtual double vtkSpline::Evaluate ( double  t  )  [pure virtual]

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

Implemented in vtkCardinalSpline, vtkKochanekSpline, and vtkSCurveSpline.

int vtkSpline::GetNumberOfPoints (  ) 

Return the number of points inserted thus far.

void vtkSpline::AddPoint ( double  t,
double  x 
)

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

void vtkSpline::RemovePoint ( double  t  ) 

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

void vtkSpline::RemoveAllPoints (  ) 

Remove all points from the 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 int vtkSpline::GetClosed (  )  [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::ClosedOn (  )  [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::ClosedOff (  )  [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. 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.

virtual int vtkSpline::GetLeftConstraint (  )  [virtual]

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.

virtual void vtkSpline::SetRightConstraint ( int   )  [virtual]

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.

virtual int vtkSpline::GetRightConstraint (  )  [virtual]

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.

virtual void vtkSpline::SetLeftValue ( double   )  [virtual]

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.

virtual double vtkSpline::GetLeftValue (  )  [virtual]

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.

virtual void vtkSpline::SetRightValue ( double   )  [virtual]

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.

virtual double vtkSpline::GetRightValue (  )  [virtual]

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.

unsigned long vtkSpline::GetMTime (  )  [virtual]

Return the MTime also considering the Piecewise function.

Reimplemented from vtkObject.

virtual void vtkSpline::DeepCopy ( vtkSpline s  )  [virtual]

Deep copy of spline data.

Reimplemented in vtkCardinalSpline, vtkKochanekSpline, and vtkSCurveSpline.

double vtkSpline::ComputeLeftDerivative (  )  [protected]

double vtkSpline::ComputeRightDerivative (  )  [protected]

int vtkSpline::FindIndex ( int  size,
double  t 
) [protected]


Member Data Documentation

unsigned long vtkSpline::ComputeTime [protected]

Definition at line 146 of file vtkSpline.h.

int vtkSpline::ClampValue [protected]

Definition at line 147 of file vtkSpline.h.

double* vtkSpline::Intervals [protected]

Definition at line 148 of file vtkSpline.h.

double* vtkSpline::Coefficients [protected]

Definition at line 149 of file vtkSpline.h.

int vtkSpline::LeftConstraint [protected]

Definition at line 150 of file vtkSpline.h.

double vtkSpline::LeftValue [protected]

Definition at line 151 of file vtkSpline.h.

int vtkSpline::RightConstraint [protected]

Definition at line 152 of file vtkSpline.h.

double vtkSpline::RightValue [protected]

Definition at line 153 of file vtkSpline.h.

Definition at line 154 of file vtkSpline.h.

int vtkSpline::Closed [protected]

Definition at line 155 of file vtkSpline.h.

double vtkSpline::ParametricRange[2] [protected]

Definition at line 158 of file vtkSpline.h.


The documentation for this class was generated from the following file:

Generated on Wed Aug 24 12:07:53 2011 for VTK by  doxygen 1.5.6