interpolate a tuple of arbitray size More...

#include <vtkTupleInterpolator.h>

Inheritance diagram for vtkTupleInterpolator:

Collaboration diagram for vtkTupleInterpolator:

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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkTupleInterpolator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

int	GetNumberOfTuples ()
	Return the number of tuples in the list of tuples to be interpolated. More...

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	SetNumberOfComponents (int numComp)
	Specify the number of tuple components to interpolate. More...

virtual int	GetNumberOfComponents ()
	Specify the number of tuple components to interpolate. More...


double	GetMinimumT ()
	Obtain some information about the interpolation range. More...

double	GetMaximumT ()
	Obtain some information about the interpolation range. More...


void	SetInterpolationType (int type)
	Specify which type of function to use for interpolation. More...

virtual int	GetInterpolationType ()
	Specify which type of function to use for interpolation. More...

void	SetInterpolationTypeToLinear ()
	Specify which type of function to use for interpolation. More...

void	SetInterpolationTypeToSpline ()
	Specify which type of function to use for interpolation. More...


void	SetInterpolatingSpline (vtkSpline *)
	If the InterpolationType is set to spline, then this method applies. More...

virtual vtkSpline *	GetInterpolatingSpline ()
	If the InterpolationType is set to spline, then this method applies. 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...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. 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 vtkTupleInterpolator *	SafeDownCast (vtkObjectBase *o)

static vtkTupleInterpolator *	New ()
	Instantiate the class. More...

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

	vtkTupleInterpolator ()

virtual	~vtkTupleInterpolator ()

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=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
int	NumberOfComponents

int	InterpolationType

vtkSpline *	InterpolatingSpline

vtkPiecewiseFunction **	Linear

vtkSpline **	Spline

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

interpolate a tuple of arbitray 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 54 of file vtkTupleInterpolator.h.

Member Typedef Documentation

typedef vtkObject vtkTupleInterpolator::Superclass

Definition at line 57 of file vtkTupleInterpolator.h.

Member Enumeration Documentation

anonymous enum

Enums to control the type of interpolation to use.

Enumerator
INTERPOLATION_TYPE_LINEAR
INTERPOLATION_TYPE_SPLINE

Definition at line 121 of file vtkTupleInterpolator.h.

Constructor & Destructor Documentation

vtkTupleInterpolator::vtkTupleInterpolator ( )

protected

virtual vtkTupleInterpolator::~vtkTupleInterpolator ( )

protectedvirtual

Member Function Documentation

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkTupleInterpolator::NewInstanceInternal ( ) const

protectedvirtual

vtkTupleInterpolator* vtkTupleInterpolator::NewInstance ( ) const

void vtkTupleInterpolator::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.

static vtkTupleInterpolator* vtkTupleInterpolator::New ( )

static

Instantiate the class.

void vtkTupleInterpolator::SetNumberOfComponents ( int numComp )

Specify the number of tuple components to interpolate.

Note that setting this value discards any previously inserted data.

virtual int vtkTupleInterpolator::GetNumberOfComponents ( )

virtual

Specify the number of tuple components to interpolate.

Note that setting this value discards any previously inserted data.

int vtkTupleInterpolator::GetNumberOfTuples ( )

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

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.

double vtkTupleInterpolator::GetMaximumT ( )

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.

void vtkTupleInterpolator::Initialize ( )

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

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.

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.

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.

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.

virtual int vtkTupleInterpolator::GetInterpolationType ( )

virtual

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.

void vtkTupleInterpolator::SetInterpolationTypeToLinear ( )

inline

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.

Definition at line 138 of file vtkTupleInterpolator.h.

void vtkTupleInterpolator::SetInterpolationTypeToSpline ( )

inline

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.

Definition at line 140 of file vtkTupleInterpolator.h.

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.

virtual vtkSpline* vtkTupleInterpolator::GetInterpolatingSpline ( )

virtual

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.

void vtkTupleInterpolator::InitializeInterpolation ( )

protected

Member Data Documentation

int vtkTupleInterpolator::NumberOfComponents

protected

Definition at line 162 of file vtkTupleInterpolator.h.

int vtkTupleInterpolator::InterpolationType

protected

Definition at line 165 of file vtkTupleInterpolator.h.

vtkSpline* vtkTupleInterpolator::InterpolatingSpline

protected

Definition at line 168 of file vtkTupleInterpolator.h.

vtkPiecewiseFunction** vtkTupleInterpolator::Linear

protected

Definition at line 172 of file vtkTupleInterpolator.h.

vtkSpline** vtkTupleInterpolator::Spline

protected

Definition at line 173 of file vtkTupleInterpolator.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkTupleInterpolator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation