VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTupleInterpolator Class Reference

interpolate a tuple of arbitrary size More...

#include <vtkTupleInterpolator.h>

Inheritance diagram for vtkTupleInterpolator:
[legend]
Collaboration diagram for vtkTupleInterpolator:
[legend]

Public Types

enum  { INTERPOLATION_TYPE_LINEAR = 0, INTERPOLATION_TYPE_SPLINE }
 Enums to control the type of interpolation to use. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkTupleInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetNumberOfComponents (int numComp)
 Specify the number of tuple components to interpolate. More...
 
virtual int GetNumberOfComponents ()
 
int GetNumberOfTuples ()
 Return the number of tuples in the list of tuples to be interpolated. More...
 
double GetMinimumT ()
 Obtain some information about the interpolation range. More...
 
double GetMaximumT ()
 
void Initialize ()
 Reset the class so that it contains no (t,tuple) information. More...
 
void AddTuple (double t, double tuple[])
 Add another tuple to the list of tuples to be interpolated. More...
 
void RemoveTuple (double t)
 Delete the tuple at a particular parameter t. More...
 
void InterpolateTuple (double t, double tuple[])
 Interpolate the list of tuples and determine a new tuple (i.e., fill in the tuple provided). More...
 
void SetInterpolationType (int type)
 Specify which type of function to use for interpolation. More...
 
virtual int GetInterpolationType ()
 
void SetInterpolationTypeToLinear ()
 
void SetInterpolationTypeToSpline ()
 
void SetInterpolatingSpline (vtkSpline *)
 If the InterpolationType is set to spline, then this method applies. More...
 
virtual vtkSplineGetInterpolatingSpline ()
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTupleInterpolatorSafeDownCast (vtkObjectBase *o)
 
static vtkTupleInterpolatorNew ()
 Instantiate the class. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTupleInterpolator ()
 
 ~vtkTupleInterpolator () override
 
void InitializeInterpolation ()
 
- 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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

int NumberOfComponents
 
int InterpolationType
 
vtkSplineInterpolatingSpline
 
vtkPiecewiseFunction ** Linear
 
vtkSpline ** Spline
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

interpolate a tuple of arbitrary size

This class is used to interpolate a tuple which may have an arbitrary number of components (but at least one component). The interpolation may be linear in form, or via a subclasses of vtkSpline.

To use this class, begin by specifying the number of components of the tuple and the interpolation function to use. Then specify at least one pair of (t,tuple) with the AddTuple() method. Next interpolate the tuples with the InterpolateTuple(t,tuple) method, where "t" must be in the range of (t_min,t_max) parameter values specified by the AddTuple() method (if not then t is clamped), and tuple[] is filled in by the method (make sure that tuple [] is long enough to hold the interpolated data).

You can control the type of interpolation to use. By default, the interpolation is based on a Kochanek spline. However, other types of splines can be specified. You can also set the interpolation method to linear, in which case the specified spline has no effect on the interpolation.

Warning
Setting the number of components or changing the type of interpolation causes the list of tuples to be reset, so any data inserted up to that point is lost. Bisection methods are used to speed up the search for the interpolation interval.

Definition at line 53 of file vtkTupleInterpolator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkTupleInterpolator.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enums to control the type of interpolation to use.

Enumerator
INTERPOLATION_TYPE_LINEAR 
INTERPOLATION_TYPE_SPLINE 

Definition at line 120 of file vtkTupleInterpolator.h.

Constructor & Destructor Documentation

◆ vtkTupleInterpolator()

vtkTupleInterpolator::vtkTupleInterpolator ( )
protected

◆ ~vtkTupleInterpolator()

vtkTupleInterpolator::~vtkTupleInterpolator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkTupleInterpolator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkTupleInterpolator::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 vtkObjectBase.

◆ SafeDownCast()

static vtkTupleInterpolator* vtkTupleInterpolator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTupleInterpolator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkTupleInterpolator* vtkTupleInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkTupleInterpolator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

◆ New()

static vtkTupleInterpolator* vtkTupleInterpolator::New ( )
static

Instantiate the class.

◆ SetNumberOfComponents()

void vtkTupleInterpolator::SetNumberOfComponents ( int  numComp)

Specify the number of tuple components to interpolate.

Note that setting this value discards any previously inserted data.

◆ GetNumberOfComponents()

virtual int vtkTupleInterpolator::GetNumberOfComponents ( )
virtual

◆ GetNumberOfTuples()

int vtkTupleInterpolator::GetNumberOfTuples ( )

Return the number of tuples in the list of tuples to be interpolated.

◆ GetMinimumT()

double vtkTupleInterpolator::GetMinimumT ( )

Obtain some information about the interpolation range.

The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty. This is a convenience method for interpolation.

◆ GetMaximumT()

double vtkTupleInterpolator::GetMaximumT ( )

◆ Initialize()

void vtkTupleInterpolator::Initialize ( )

Reset the class so that it contains no (t,tuple) information.

◆ AddTuple()

void vtkTupleInterpolator::AddTuple ( double  t,
double  tuple[] 
)

Add another tuple to the list of tuples to be interpolated.

Note that using the same time t value more than once replaces the previous tuple value at t. At least two tuples must be added to define an interpolation function.

◆ RemoveTuple()

void vtkTupleInterpolator::RemoveTuple ( double  t)

Delete the tuple at a particular parameter t.

If there is no tuple defined at t, then the method does nothing.

◆ InterpolateTuple()

void vtkTupleInterpolator::InterpolateTuple ( double  t,
double  tuple[] 
)

Interpolate the list of tuples and determine a new tuple (i.e., fill in the tuple provided).

If t is outside the range of (min,max) values, then t is clamped. Note that each component of tuple[] is interpolated independently.

◆ SetInterpolationType()

void vtkTupleInterpolator::SetInterpolationType ( int  type)

Specify which type of function to use for interpolation.

By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.

◆ GetInterpolationType()

virtual int vtkTupleInterpolator::GetInterpolationType ( )
virtual

◆ SetInterpolationTypeToLinear()

void vtkTupleInterpolator::SetInterpolationTypeToLinear ( )
inline

Definition at line 139 of file vtkTupleInterpolator.h.

◆ SetInterpolationTypeToSpline()

void vtkTupleInterpolator::SetInterpolationTypeToSpline ( )
inline

Definition at line 140 of file vtkTupleInterpolator.h.

◆ SetInterpolatingSpline()

void vtkTupleInterpolator::SetInterpolatingSpline ( vtkSpline )

If the InterpolationType is set to spline, then this method applies.

By default Kochanek interpolation is used, but you can specify any instance of vtkSpline to use. Note that the actual interpolating splines are created by invoking NewInstance() followed by DeepCopy() on the interpolating spline specified here, for each tuple component to interpolate.

◆ GetInterpolatingSpline()

virtual vtkSpline* vtkTupleInterpolator::GetInterpolatingSpline ( )
virtual

◆ InitializeInterpolation()

void vtkTupleInterpolator::InitializeInterpolation ( )
protected

Member Data Documentation

◆ NumberOfComponents

int vtkTupleInterpolator::NumberOfComponents
protected

Definition at line 161 of file vtkTupleInterpolator.h.

◆ InterpolationType

int vtkTupleInterpolator::InterpolationType
protected

Definition at line 164 of file vtkTupleInterpolator.h.

◆ InterpolatingSpline

vtkSpline* vtkTupleInterpolator::InterpolatingSpline
protected

Definition at line 167 of file vtkTupleInterpolator.h.

◆ Linear

vtkPiecewiseFunction** vtkTupleInterpolator::Linear
protected

Definition at line 171 of file vtkTupleInterpolator.h.

◆ Spline

vtkSpline** vtkTupleInterpolator::Spline
protected

Definition at line 172 of file vtkTupleInterpolator.h.


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