computes an interpolating spline using a Kochanek basis. More...

#include <vtkKochanekSpline.h>

Inheritance diagram for vtkKochanekSpline:

Collaboration diagram for vtkKochanekSpline:

Public Types
typedef vtkSpline	Superclass

Public Types inherited from vtkSpline
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.

vtkKochanekSpline *	NewInstance () const

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

void	Compute () override
	Compute Kochanek Spline coefficients.

double	Evaluate (double t) override
	Evaluate a 1D Kochanek spline.

void	DeepCopy (vtkSpline *s) override
	Deep copy of cardinal spline data.


virtual void	SetDefaultBias (double)
	Set the bias for all points.

virtual double	GetDefaultBias ()
	Set the bias for all points.


virtual void	SetDefaultTension (double)
	Set the tension for all points.

virtual double	GetDefaultTension ()
	Set the tension for all points.


virtual void	SetDefaultContinuity (double)
	Set the continuity for all points.

virtual double	GetDefaultContinuity ()
	Set the continuity for all points.

Public Member Functions inherited from vtkSpline
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkSpline *	NewInstance () const

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

virtual void	Compute ()=0
	Compute the coefficients for the spline.

virtual double	Evaluate (double t)=0
	Interpolate the value of the spline at parametric location of t.

int	GetNumberOfPoints ()
	Return the number of points inserted thus far.

void	AddPoint (double t, double x)
	Add a pair of points to be fit with the spline.

void	FillFromDataPointer (int nb, double *data)
	Add all the points to the list of points in one time, and then sort them only once.

void	RemovePoint (double t)
	Remove a point from the data to be fit with the spline.

void	RemoveAllPoints ()
	Remove all points from the data.

vtkMTimeType	GetMTime () override
	Return the MTime also considering the Piecewise function.

virtual void	DeepCopy (vtkSpline *s)
	Deep copy of spline data.

void	SetParametricRange (double tMin, double tMax)
	Set/Get the parametric range.

void	SetParametricRange (double tRange[2])
	Set/Get the parametric range.

void	GetParametricRange (double tRange[2]) const
	Set/Get the parametric range.

virtual void	SetClampValue (vtkTypeBool)
	Set/Get ClampValue.

virtual vtkTypeBool	GetClampValue ()
	Set/Get ClampValue.

virtual void	ClampValueOn ()
	Set/Get ClampValue.

virtual void	ClampValueOff ()
	Set/Get ClampValue.

virtual void	SetClosed (vtkTypeBool)
	Control whether the spline is open or closed.

virtual vtkTypeBool	GetClosed ()
	Control whether the spline is open or closed.

virtual void	ClosedOn ()
	Control whether the spline is open or closed.

virtual void	ClosedOff ()
	Control whether the spline is open or closed.

virtual void	SetLeftConstraint (int)
	Set the type of constraint of the left(right) end points.

virtual int	GetLeftConstraint ()
	Set the type of constraint of the left(right) end points.

virtual void	SetRightConstraint (int)
	Set the type of constraint of the left(right) end points.

virtual int	GetRightConstraint ()
	Set the type of constraint of the left(right) end points.

virtual void	SetLeftValue (double)
	The values of the derivative on the left and right sides.

virtual double	GetLeftValue ()
	The values of the derivative on the left and right sides.

virtual void	SetRightValue (double)
	The values of the derivative on the left and right sides.

virtual double	GetRightValue ()
	The values of the derivative on the left and right sides.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkKochanekSpline *	SafeDownCast (vtkObjectBase *o)

static vtkKochanekSpline *	New ()
	Construct a KochanekSpline with the following defaults: DefaultBias = 0, DefaultTension = 0, DefaultContinuity = 0.

Static Public Member Functions inherited from vtkSpline
static vtkTypeBool	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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkKochanekSpline ()

	~vtkKochanekSpline () override=default

void	Fit1D (int size, double x, double y, double tension, double bias, double continuity, double coefficients[][4], int leftConstraint, double leftValue, int rightConstraint, double rightValue)

Protected Member Functions inherited from vtkSpline
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=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	DefaultBias

double	DefaultTension

double	DefaultContinuity

Protected Attributes inherited from vtkSpline
vtkMTimeType	ComputeTime

vtkTypeBool	ClampValue

double *	Intervals

double *	Coefficients

int	LeftConstraint

double	LeftValue

int	RightConstraint

double	RightValue

vtkPiecewiseFunction *	PiecewiseFunction

vtkTypeBool	Closed

double	ParametricRange [2]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

computes an interpolating spline using a Kochanek basis.

Implements the Kochanek interpolating spline described in: Kochanek, D., Bartels, R., "Interpolating Splines with Local Tension, Continuity, and Bias Control," Computer Graphics, vol. 18, no. 3, pp. 33-41, July 1984. These splines give the user more control over the shape of the curve than the cardinal splines implemented in vtkCardinalSpline. Three parameters can be specified. All have a range from -1 to 1.

Tension controls how sharply the curve bends at an input point. A value of -1 produces more slack in the curve. A value of 1 tightens the curve.

Continuity controls the continuity of the first derivative at input points.

Bias controls the direction of the curve at it passes through an input point. A value of -1 undershoots the point while a value of 1 overshoots the point.

These three parameters give the user broad control over the shape of the interpolating spline. The original Kochanek paper describes the effects nicely and is recommended reading.

See also: vtkSpline vtkCardinalSpline

Online Examples:

1DTupleInterpolation

FitSplineToCutterOutput

KochanekSpline

KochanekSplineDemo

Tests:: vtkKochanekSpline (Tests)

Definition at line 92 of file vtkKochanekSpline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSpline vtkKochanekSpline::Superclass

Definition at line 95 of file vtkKochanekSpline.h.

Constructor & Destructor Documentation

◆ vtkKochanekSpline()

vtkKochanekSpline::vtkKochanekSpline ( )

protected

◆ ~vtkKochanekSpline()

vtkKochanekSpline::~vtkKochanekSpline ( )

overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkKochanekSpline::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 vtkSpline.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkKochanekSpline::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSpline.

◆ NewInstance()

vtkKochanekSpline * vtkKochanekSpline::NewInstance ( ) const

◆ PrintSelf()

void vtkKochanekSpline::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 vtkObjectBase.

void vtkKochanekSpline::Fit1D	(	int	size,
		double *	x,
		double *	y,
		double	tension,
		double	bias,
		double	continuity,
		double	coefficients[][4],
		int	leftConstraint,
		double	leftValue,
		int	rightConstraint,
		double	rightValue
	)

protected

Definition at line 153 of file vtkKochanekSpline.h.

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

Common/ComputationalGeometry/vtkKochanekSpline.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkKochanekSpline()

◆ ~vtkKochanekSpline()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Compute()

◆ Evaluate()

◆ SetDefaultBias()

◆ GetDefaultBias()

◆ SetDefaultTension()

◆ GetDefaultTension()

◆ SetDefaultContinuity()

◆ GetDefaultContinuity()

◆ DeepCopy()

◆ Fit1D()

Member Data Documentation

◆ DefaultBias

◆ DefaultTension

◆ DefaultContinuity