vtkSpline Class Reference
#include <vtkSpline.h>
Inheritance diagram for vtkSpline:
[legend]Collaboration diagram for vtkSpline:
[legend]List of all members.
Detailed Description
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).
- See also:
- vtkCardinalSpline vtkKochenekSpline
- Created by:
-
- CVS contributions (if > 5%):
- Lorensen, Bill (56%)
- Schroeder, Will (26%)
- Martin, Ken (7%)
- CVS logs (CVSweb):
/Filtering/vtkSpline.h)/Filtering/vtkSpline.cxx)
Definition at line 58 of file vtkSpline.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkSpline::vtkSpline |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkSpline::GetClassName |
( |
|
) |
[virtual] |
|
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkCardinalSpline, and vtkKochanekSpline. |
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkCardinalSpline, and vtkKochanekSpline. |
| 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, and vtkKochanekSpline. |
| 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] |
|
| virtual double vtkSpline::Evaluate |
( |
double |
t |
) |
[pure virtual] |
|
| 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] |
|
| double vtkSpline::ComputeLeftDerivative |
( |
|
) |
[protected] |
|
| double vtkSpline::ComputeRightDerivative |
( |
|
) |
[protected] |
|
| int vtkSpline::FindIndex |
( |
int |
size, |
|
|
double |
t |
|
) |
[protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file: