VTK  9.2.20230207
vtkGeneralizedKernel Class Referenceabstract

flexible, general interpolation kernels More...

#include <vtkGeneralizedKernel.h>

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

## Public Types

enum  KernelStyle { RADIUS = 0 , N_CLOSEST = 1 }
Enum used to select the interpolation basis form. More...

## Public Member Functions

vtkIdType ComputeBasis (double x[3], vtkIdList *pIds, vtkIdType ptId=0) override
Based on the kernel style, invoke the appropriate locator method to obtain the points making up the basis. More...

virtual vtkIdType ComputeWeights (double x[3], vtkIdList *pIds, vtkDoubleArray *prob, vtkDoubleArray *weights)=0
Given a point x, a list of basis points pIds, and a probability weighting function prob, compute interpolation weights associated with these basis points. More...

vtkIdType ComputeWeights (double x[3], vtkIdList *pIds, vtkDoubleArray *weights) override
Given a point x, and a list of basis points pIds, compute interpolation weights associated with these basis points. More...

virtual void SetKernelFootprint (int)
Specify the interpolation basis style. More...

virtual int GetKernelFootprint ()
Specify the interpolation basis style. More...

Specify the interpolation basis style. More...

void SetKernelFootprintToNClosest ()
Specify the interpolation basis style. More...

If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie. More...

If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie. More...

virtual void SetNumberOfPoints (int)
If the interpolation basis style is NClosest, then this method specifies the number of the closest points used to form the interpolation basis. More...

virtual int GetNumberOfPoints ()
If the interpolation basis style is NClosest, then this method specifies the number of the closest points used to form the interpolation basis. More...

virtual void SetNormalizeWeights (bool)
Indicate whether the interpolation weights should be normalized after they are computed. More...

virtual bool GetNormalizeWeights ()
Indicate whether the interpolation weights should be normalized after they are computed. More...

virtual void NormalizeWeightsOn ()
Indicate whether the interpolation weights should be normalized after they are computed. More...

virtual void NormalizeWeightsOff ()
Indicate whether the interpolation weights should be normalized after they are computed. More...

Public Member Functions inherited from vtkInterpolationKernel
virtual void Initialize (vtkAbstractPointLocator *loc, vtkDataSet *ds, vtkPointData *pd)
Initialize the kernel. More...

vtkAbstractTypeMacro (vtkInterpolationKernel, vtkObject)
Standard method for type and printing. More...

void PrintSelf (ostream &os, vtkIndent indent) override
Standard method for type and printing. More...

virtual void SetRequiresInitialization (bool)
Indicate whether the kernel needs initialization. More...

virtual bool GetRequiresInitialization ()
Indicate whether the kernel needs initialization. More...

virtual void RequiresInitializationOn ()
Indicate whether the kernel needs initialization. More...

virtual void RequiresInitializationOff ()
Indicate whether the kernel needs initialization. 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 ()

vtkTypeBool HasObserver (unsigned long event)

vtkTypeBool HasObserver (const char *event)

int InvokeEvent (unsigned long event)

int InvokeEvent (const char *event)

std::string GetObjectDescription () const override
The object description printed in messages and PrintSelf output. 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)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommandGetCommand (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...

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

vtkTypeBool 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)

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)
This method invokes an event and return whether the event was aborted or not. More...

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

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

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

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). 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...

bool GetIsInMemkind () const
A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

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

## Protected Member Functions

vtkGeneralizedKernel ()

~vtkGeneralizedKernel () override

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

Protected Member Functions inherited from vtkObjectBase
vtkObjectBase ()

virtual ~vtkObjectBase ()

virtual void ReportReferences (vtkGarbageCollector *)

vtkObjectBase (const vtkObjectBase &)

void operator= (const vtkObjectBase &)

## Protected Attributes

int KernelFootprint

int NumberOfPoints

bool NormalizeWeights

Protected Attributes inherited from vtkInterpolationKernel
bool RequiresInitialization

vtkAbstractPointLocatorLocator

vtkDataSetDataSet

vtkPointDataPointData

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

typedef vtkInterpolationKernel Superclass
Standard methods for type and printing. More...

static vtkTypeBool IsTypeOf (const char *type)
Standard methods for type and printing. More...

static vtkGeneralizedKernelSafeDownCast (vtkObjectBase *o)
Standard methods for type and printing. More...

virtual vtkTypeBool IsA (const char *type)
Standard methods for type and printing. More...

vtkGeneralizedKernelNewInstance () const
Standard methods for type and printing. More...

void PrintSelf (ostream &os, vtkIndent indent) override
Standard methods for type and printing. More...

virtual vtkObjectBaseNewInstanceInternal () const
Standard methods for type and printing. 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 ()
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 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...

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

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. More...

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

static vtkReallocingFunction GetCurrentReallocFunction ()

static vtkFreeingFunction GetCurrentFreeFunction ()

static vtkFreeingFunction GetAlternateFreeFunction ()

## Detailed Description

flexible, general interpolation kernels

vtkGeneralizedKernel is an abstract class that defines an API for concrete general-purpose, kernel subclasses. vtkGeneralizedKernels has important properties that make them useful in a variety of interpolation applications:

1. The weights are normalized.
2. The footprint of the basis is configurable.
3. Probabilistic weighting functions can be used to favor certain weights.


The following paragraphs describe each of these properties in more detail.

Normalized weightings simple mean Sum(w_i) = 1. This ensures that the interpolation process is well behaved.

The interpolation footprint is the set of points that are used to perform the interpolation process. For example, it is possible to choose between a radius-based kernel selection, and one based on the N nearest neighbors. Note that the performance and mathematical properties of kernels may vary greatly depending on which kernel style is selected. For example, if a radius-based kernel footprint is used, and the radius is too big, the algorithm can perform in n^3 fashion.

Finally, in advanced usage, probability functions can be applied to the interpolation weights (prior to normalization). These probability functions are confidence estimates that the data at a particular point is accurate. A typical application is when laser scans are used to acquire point measurements, which return normals that indicate glancing returns versus direct, near orthogonal hits. Another use is when point clouds are combined, where some clouds are acquired with more accurate, detailed devices versus a broad, potentially coarser acquisition process.

Warning
Some kernels, like the Voronoi kernel, cannot be subclasses of this class because their definition inherently defines the basis style. For example, the Voronoi kernel is simply the single closest point. SPH kernels are similar, because they implicitly depend on a particle distribution consistent with simulation constraints such as conservation of mass, etc.
vtkPointInterpolator vtkPointInterpolator2D vtkGaussianKernel vtkSPHKernel vtkShepardKernel vtkLinearKernel vtkVoronoiKernel

Definition at line 70 of file vtkGeneralizedKernel.h.

## ◆ Superclass

Standard methods for type and printing.

Definition at line 77 of file vtkGeneralizedKernel.h.

## ◆ KernelStyle

Enum used to select the interpolation basis form.

By default, a Radius form is used (i.e., the basis is defined from all points within a specified radius). However, it is also possible to select the N closest points (NClosest).

Enumerator
N_CLOSEST

Definition at line 130 of file vtkGeneralizedKernel.h.

## ◆ vtkGeneralizedKernel()

 vtkGeneralizedKernel::vtkGeneralizedKernel ( )
protected

## ◆ ~vtkGeneralizedKernel()

 vtkGeneralizedKernel::~vtkGeneralizedKernel ( )
overrideprotected

## ◆ IsTypeOf()

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

Standard methods for type and printing.

## ◆ IsA()

 virtual vtkTypeBool vtkGeneralizedKernel::IsA ( const char * type )
virtual

Standard methods for type and printing.

Reimplemented from vtkObjectBase.

## ◆ SafeDownCast()

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

Standard methods for type and printing.

## ◆ NewInstanceInternal()

 virtual vtkObjectBase* vtkGeneralizedKernel::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for type and printing.

## ◆ NewInstance()

 vtkGeneralizedKernel* vtkGeneralizedKernel::NewInstance ( ) const

Standard methods for type and printing.

## ◆ PrintSelf()

 void vtkGeneralizedKernel::PrintSelf ( ostream & os, vtkIndent indent )
overridevirtual

Standard methods for type and printing.

Reimplemented from vtkObject.

Reimplemented in vtkShepardKernel, vtkProbabilisticVoronoiKernel, and vtkLinearKernel.

## ◆ ComputeBasis()

 vtkIdType vtkGeneralizedKernel::ComputeBasis ( double x[3], vtkIdList * pIds, vtkIdType ptId = 0 )
overridevirtual

Based on the kernel style, invoke the appropriate locator method to obtain the points making up the basis.

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.

Implements vtkInterpolationKernel.

## ◆ ComputeWeights() [1/2]

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

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

Note that basis points list pIds, the probability weighting prob, 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. The probably weighting prob are numbers 0<=prob<=1 which are multiplied against the interpolation weights before normalization. They are estimates of local confidence of weights. The prob may be nullptr in which all probabilities are considered =1.

## ◆ ComputeWeights() [2/2]

 vtkIdType vtkGeneralizedKernel::ComputeWeights ( double x[3], vtkIdList * pIds, vtkDoubleArray * weights )
inlineoverridevirtual

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. Typically this method is called after ComputeBasis(), although advanced users can invoke ComputeWeights() and provide the interpolation basis points pIds directly.

Implements vtkInterpolationKernel.

Definition at line 119 of file vtkGeneralizedKernel.h.

## ◆ SetKernelFootprint()

 virtual void vtkGeneralizedKernel::SetKernelFootprint ( int )
virtual

Specify the interpolation basis style.

By default, a Radius style is used (i.e., the basis is defined from all points within a specified radius). However, it is also possible to select the N closest points (NClosest). Note that in most formulations the Radius style is assumed as it provides better mathematical properties. However, for convenience some bases are easier to use when the N closest points are taken.

## ◆ GetKernelFootprint()

 virtual int vtkGeneralizedKernel::GetKernelFootprint ( )
virtual

Specify the interpolation basis style.

By default, a Radius style is used (i.e., the basis is defined from all points within a specified radius). However, it is also possible to select the N closest points (NClosest). Note that in most formulations the Radius style is assumed as it provides better mathematical properties. However, for convenience some bases are easier to use when the N closest points are taken.

inline

Specify the interpolation basis style.

By default, a Radius style is used (i.e., the basis is defined from all points within a specified radius). However, it is also possible to select the N closest points (NClosest). Note that in most formulations the Radius style is assumed as it provides better mathematical properties. However, for convenience some bases are easier to use when the N closest points are taken.

Definition at line 147 of file vtkGeneralizedKernel.h.

## ◆ SetKernelFootprintToNClosest()

 void vtkGeneralizedKernel::SetKernelFootprintToNClosest ( )
inline

Specify the interpolation basis style.

By default, a Radius style is used (i.e., the basis is defined from all points within a specified radius). However, it is also possible to select the N closest points (NClosest). Note that in most formulations the Radius style is assumed as it provides better mathematical properties. However, for convenience some bases are easier to use when the N closest points are taken.

Definition at line 148 of file vtkGeneralizedKernel.h.

 virtual void vtkGeneralizedKernel::SetRadius ( double )
virtual

If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie.

virtual

If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie.

## ◆ SetNumberOfPoints()

 virtual void vtkGeneralizedKernel::SetNumberOfPoints ( int )
virtual

If the interpolation basis style is NClosest, then this method specifies the number of the closest points used to form the interpolation basis.

## ◆ GetNumberOfPoints()

 virtual int vtkGeneralizedKernel::GetNumberOfPoints ( )
virtual

If the interpolation basis style is NClosest, then this method specifies the number of the closest points used to form the interpolation basis.

## ◆ SetNormalizeWeights()

 virtual void vtkGeneralizedKernel::SetNormalizeWeights ( bool )
virtual

Indicate whether the interpolation weights should be normalized after they are computed.

Generally this is left on as it results in more reasonable behavior.

## ◆ GetNormalizeWeights()

 virtual bool vtkGeneralizedKernel::GetNormalizeWeights ( )
virtual

Indicate whether the interpolation weights should be normalized after they are computed.

Generally this is left on as it results in more reasonable behavior.

## ◆ NormalizeWeightsOn()

 virtual void vtkGeneralizedKernel::NormalizeWeightsOn ( )
virtual

Indicate whether the interpolation weights should be normalized after they are computed.

Generally this is left on as it results in more reasonable behavior.

## ◆ NormalizeWeightsOff()

 virtual void vtkGeneralizedKernel::NormalizeWeightsOff ( )
virtual

Indicate whether the interpolation weights should be normalized after they are computed.

Generally this is left on as it results in more reasonable behavior.

## ◆ KernelFootprint

 int vtkGeneralizedKernel::KernelFootprint
protected

Definition at line 184 of file vtkGeneralizedKernel.h.

protected

Definition at line 185 of file vtkGeneralizedKernel.h.

## ◆ NumberOfPoints

 int vtkGeneralizedKernel::NumberOfPoints
protected

Definition at line 186 of file vtkGeneralizedKernel.h.

## ◆ NormalizeWeights

 bool vtkGeneralizedKernel::NormalizeWeights
protected

Definition at line 187 of file vtkGeneralizedKernel.h.

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