VTK
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInterpolationKernel Class Referenceabstract

base class for interpolation kernels More...

#include <vtkInterpolationKernel.h>

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

Public Member Functions

 vtkAbstractTypeMacro (vtkInterpolationKernel, vtkObject)
 Standard method for type and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Initialize (vtkAbstractPointLocator *loc, vtkDataSet *ds, vtkPointData *pd)
 Initialize the kernel. More...
 
virtual void SetRequiresInitialization (bool)
 Indicate whether the kernel needs initialization. More...
 
virtual bool GetRequiresInitialization ()
 
virtual void RequiresInitializationOn ()
 
virtual void RequiresInitializationOff ()
 
virtual vtkIdType ComputeBasis (double x[3], vtkIdList *pIds, vtkIdType ptId=0)=0
 Given a point x (and optional associated point id), determine the points around x which form an interpolation basis. More...
 
virtual vtkIdType ComputeWeights (double x[3], vtkIdList *pIds, vtkDoubleArray *weights)=0
 Given a point x, and a list of basis points pIds, compute interpolation weights associated with these basis points. 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...
 
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 vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (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). 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...
 

Protected Member Functions

 vtkInterpolationKernel ()
 
 ~vtkInterpolationKernel () override
 
virtual void FreeStructures ()
 
- 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

bool RequiresInitialization
 
vtkAbstractPointLocatorLocator
 
vtkDataSetDataSet
 
vtkPointDataPointData
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Detailed Description

base class for interpolation kernels

vtkInterpolationKernel specifies an abstract interface for interpolation kernels. An interpolation kernel is used to produce an interpolated data value at a point X from the points + data in a local neighborhood surrounding X. For example, given the N nearest points surrounding X, the interpolation kernel provides N weights, which when combined with the N data values associated with these nearest points, produces an interpolated data value at point X.

Note that various kernel initialization methods are provided. The basic method requires providing a point locator to accelerate neighborhood queries. Some kernels may refer back to the original dataset, or the point attribute data associated with the dataset. The initialization method enables different styles of initialization and is kernel-dependent.

Typically the kernels are invoked in two parts: first, the basis is computed using the supplied point locator and dataset. This basis is a local footprint of point surrounding a poitnX. In this footprint are the neighboring points used to compute the interpolation weights. Then, the weights are computed from points forming the basis. However, advanced users can develop their own basis, skipping the ComputeBasis() method, and then invoke ComputeWeights() directly.

Warning
The ComputeBasis() and ComputeWeights() methods must be thread safe as they are used in threaded algorithms.
See also
vtkPointInterpolator vtkPointInterpolator2D vtkGeneralizedKernel vtkGaussianKernel vtkSPHKernel vtkShepardKernel vtkVoronoiKernel

Definition at line 63 of file vtkInterpolationKernel.h.

Constructor & Destructor Documentation

◆ vtkInterpolationKernel()

vtkInterpolationKernel::vtkInterpolationKernel ( )
protected

◆ ~vtkInterpolationKernel()

vtkInterpolationKernel::~vtkInterpolationKernel ( )
overrideprotected

Member Function Documentation

◆ vtkAbstractTypeMacro()

vtkInterpolationKernel::vtkAbstractTypeMacro ( vtkInterpolationKernel  ,
vtkObject   
)

Standard method for type and printing.

◆ PrintSelf()

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

Reimplemented in vtkSPHKernel, vtkSPHCubicKernel, vtkSPHQuarticKernel, vtkSPHQuinticKernel, vtkWendlandQuinticKernel, vtkProbabilisticVoronoiKernel, vtkShepardKernel, vtkVoronoiKernel, and vtkLinearKernel.

◆ Initialize()

virtual void vtkInterpolationKernel::Initialize ( vtkAbstractPointLocator loc,
vtkDataSet ds,
vtkPointData pd 
)
virtual

Initialize the kernel.

Pass information into the kernel that is necessary to subsequently perform evaluation. The locator refers to the points that are to be interpolated from; these points (ds) and the associated point data (pd) are provided as well. Note that some kernels may require manual setup / initialization, in which case set RequiresInitialization to false, do not call Initialize(), and of course manually initialize the kernel.

Reimplemented in vtkSPHKernel, vtkEllipsoidalGaussianKernel, vtkSPHCubicKernel, vtkSPHQuarticKernel, vtkSPHQuinticKernel, vtkWendlandQuinticKernel, and vtkGaussianKernel.

◆ SetRequiresInitialization()

virtual void vtkInterpolationKernel::SetRequiresInitialization ( bool  )
virtual

Indicate whether the kernel needs initialization.

By default this data member is true, and using classes will invoke Initialize() on the kernel. However, if the user takes over initialization manually, then set RequiresInitialization to false (0).

◆ GetRequiresInitialization()

virtual bool vtkInterpolationKernel::GetRequiresInitialization ( )
virtual

◆ RequiresInitializationOn()

virtual void vtkInterpolationKernel::RequiresInitializationOn ( )
virtual

◆ RequiresInitializationOff()

virtual void vtkInterpolationKernel::RequiresInitializationOff ( )
virtual

◆ ComputeBasis()

virtual vtkIdType vtkInterpolationKernel::ComputeBasis ( double  x[3],
vtkIdList pIds,
vtkIdType  ptId = 0 
)
pure virtual

Given a point x (and optional associated point id), determine the points around x which form an interpolation basis.

The user must provide the vtkIdList pIds, which will be dynamically resized as necessary. The method returns the number of points in the basis. Typically this method is called before ComputeWeights(). Note that ptId is optional in most cases, although in some kernels it is used to facilitate basis computation.

Implemented in vtkSPHKernel, vtkGeneralizedKernel, and vtkVoronoiKernel.

◆ ComputeWeights()

virtual vtkIdType vtkInterpolationKernel::ComputeWeights ( double  x[3],
vtkIdList pIds,
vtkDoubleArray weights 
)
pure virtual

Given a point x, and a list of basis points pIds, compute interpolation weights associated with these basis points.

Note that both the nearby basis points list pIds and the weights array are provided by the caller of the method, and may be dynamically resized as necessary. The method returns the number of weights (pIds may be resized in some cases). Typically this method is called after ComputeBasis(), although advanced users can invoke ComputeWeights() and provide the interpolation basis points pIds directly.

Implemented in vtkSPHKernel, vtkGeneralizedKernel, and vtkVoronoiKernel.

◆ FreeStructures()

virtual void vtkInterpolationKernel::FreeStructures ( )
protectedvirtual

Reimplemented in vtkEllipsoidalGaussianKernel.

Member Data Documentation

◆ RequiresInitialization

bool vtkInterpolationKernel::RequiresInitialization
protected

Definition at line 124 of file vtkInterpolationKernel.h.

◆ Locator

vtkAbstractPointLocator* vtkInterpolationKernel::Locator
protected

Definition at line 125 of file vtkInterpolationKernel.h.

◆ DataSet

vtkDataSet* vtkInterpolationKernel::DataSet
protected

Definition at line 126 of file vtkInterpolationKernel.h.

◆ PointData

vtkPointData* vtkInterpolationKernel::PointData
protected

Definition at line 127 of file vtkInterpolationKernel.h.


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