spline abstract class for interpolating splines More...
#include <vtkSpline.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkSpline * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | Compute ()=0 |
| Compute the coefficients for the spline. More... | |
| virtual double | Evaluate (double t)=0 |
| Interpolate the value of the spline at parametric location of t. More... | |
| int | GetNumberOfPoints () |
| Return the number of points inserted thus far. More... | |
| void | AddPoint (double t, double x) |
| Add a pair of points to be fit with the spline. More... | |
| void | RemovePoint (double t) |
| Remove a point from the data to be fit with the spline. More... | |
| void | RemoveAllPoints () |
| Remove all points from the data. More... | |
| vtkMTimeType | GetMTime () override |
| Return the MTime also considering the Piecewise function. More... | |
| virtual void | DeepCopy (vtkSpline *s) |
| Deep copy of spline data. More... | |
| void | SetParametricRange (double tMin, double tMax) |
| Set/Get the parametric range. More... | |
| void | SetParametricRange (double tRange[2]) |
| Set/Get the parametric range. More... | |
| void | GetParametricRange (double tRange[2]) const |
| Set/Get the parametric range. More... | |
| virtual void | SetClampValue (int) |
| Set/Get ClampValue. More... | |
| virtual int | GetClampValue () |
| Set/Get ClampValue. More... | |
| virtual void | ClampValueOn () |
| Set/Get ClampValue. More... | |
| virtual void | ClampValueOff () |
| Set/Get ClampValue. More... | |
| virtual void | SetClosed (int) |
| Control whether the spline is open or closed. More... | |
| virtual int | GetClosed () |
| Control whether the spline is open or closed. More... | |
| virtual void | ClosedOn () |
| Control whether the spline is open or closed. More... | |
| virtual void | ClosedOff () |
| Control whether the spline is open or closed. More... | |
| virtual void | SetLeftConstraint (int) |
| Set the type of constraint of the left(right) end points. More... | |
| virtual int | GetLeftConstraint () |
| Set the type of constraint of the left(right) end points. More... | |
| virtual void | SetRightConstraint (int) |
| Set the type of constraint of the left(right) end points. More... | |
| virtual int | GetRightConstraint () |
| Set the type of constraint of the left(right) end points. More... | |
| virtual void | SetLeftValue (double) |
| The values of the derivative on the left and right sides. More... | |
| virtual double | GetLeftValue () |
| The values of the derivative on the left and right sides. More... | |
| virtual void | SetRightValue (double) |
| The values of the derivative on the left and right sides. More... | |
| virtual double | GetRightValue () |
| The values of the derivative on the left and right sides. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| int | HasObserver (unsigned long event) |
| int | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| int | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| int | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkSpline * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkSpline () | |
| ~vtkSpline () override | |
| double | ComputeLeftDerivative () |
| double | ComputeRightDerivative () |
| int | FindIndex (int size, double t) |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| vtkMTimeType | ComputeTime |
| int | ClampValue |
| double * | Intervals |
| double * | Coefficients |
| int | LeftConstraint |
| double | LeftValue |
| int | RightConstraint |
| double | RightValue |
| vtkPiecewiseFunction * | PiecewiseFunction |
| int | Closed |
| double | ParametricRange [2] |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
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 vtkKochanekSpline 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.
Definition at line 62 of file vtkSpline.h.
Member Typedef Documentation
| typedef vtkObject vtkSpline::Superclass |
Definition at line 65 of file vtkSpline.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
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 vtkObjectBase.
Reimplemented in vtkKochanekSpline, vtkCardinalSpline, and vtkSCurveSpline.
|
static |
|
protectedvirtual |
Reimplemented in vtkKochanekSpline, vtkCardinalSpline, and vtkSCurveSpline.
| vtkSpline* vtkSpline::NewInstance | ( | ) | const |
|
overridevirtual |
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 vtkSCurveSpline.
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.
|
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 76 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 |
Set/Get ClampValue.
If On, results of the interpolation will be clamped to the min/max of the input data.
|
virtual |
Set/Get ClampValue.
If On, results of the interpolation will be clamped to the min/max of the input data.
|
virtual |
Set/Get ClampValue.
If On, results of the interpolation will be clamped to the min/max of the input data.
|
virtual |
Set/Get ClampValue.
If On, results of the interpolation will be clamped to the min/max of the input data.
|
pure virtual |
Compute the coefficients for the spline.
Implemented in vtkKochanekSpline, vtkCardinalSpline, and vtkSCurveSpline.
Interpolate the value of the spline at parametric location of t.
Implemented in vtkKochanekSpline, vtkCardinalSpline, and vtkSCurveSpline.
| int vtkSpline::GetNumberOfPoints | ( | ) |
Return the number of points inserted thus far.
| 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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
|
overridevirtual |
Return the MTime also considering the Piecewise function.
Reimplemented from vtkObject.
|
virtual |
Deep copy of spline data.
Reimplemented in vtkKochanekSpline, vtkCardinalSpline, and vtkSCurveSpline.
|
protected |
|
protected |
Member Data Documentation
|
protected |
Definition at line 180 of file vtkSpline.h.
|
protected |
Definition at line 181 of file vtkSpline.h.
|
protected |
Definition at line 182 of file vtkSpline.h.
|
protected |
Definition at line 183 of file vtkSpline.h.
|
protected |
Definition at line 184 of file vtkSpline.h.
|
protected |
Definition at line 185 of file vtkSpline.h.
|
protected |
Definition at line 186 of file vtkSpline.h.
|
protected |
Definition at line 187 of file vtkSpline.h.
|
protected |
Definition at line 188 of file vtkSpline.h.
|
protected |
Definition at line 189 of file vtkSpline.h.
|
protected |
Definition at line 192 of file vtkSpline.h.
The documentation for this class was generated from the following file:
- /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Common/DataModel/vtkSpline.h
