VTK
9.4.20241202
|
flexible, general interpolation kernels More...
#include <vtkGeneralizedKernel.h>
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. | |
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. | |
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. | |
virtual void | SetKernelFootprint (int) |
Specify the interpolation basis style. | |
virtual int | GetKernelFootprint () |
Specify the interpolation basis style. | |
void | SetKernelFootprintToRadius () |
Specify the interpolation basis style. | |
void | SetKernelFootprintToNClosest () |
Specify the interpolation basis style. | |
virtual void | SetRadius (double) |
If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie. | |
virtual double | GetRadius () |
If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie. | |
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. | |
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. | |
virtual void | SetNormalizeWeights (bool) |
Indicate whether the interpolation weights should be normalized after they are computed. | |
virtual bool | GetNormalizeWeights () |
Indicate whether the interpolation weights should be normalized after they are computed. | |
virtual void | NormalizeWeightsOn () |
Indicate whether the interpolation weights should be normalized after they are computed. | |
virtual void | NormalizeWeightsOff () |
Indicate whether the interpolation weights should be normalized after they are computed. | |
Public Member Functions inherited from vtkInterpolationKernel | |
virtual void | Initialize (vtkAbstractPointLocator *loc, vtkDataSet *ds, vtkPointData *pd) |
Initialize the kernel. | |
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. | |
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. | |
vtkAbstractTypeMacro (vtkInterpolationKernel, vtkObject) | |
Standard method for type and printing. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard method for type and printing. | |
virtual void | SetRequiresInitialization (bool) |
Indicate whether the kernel needs initialization. | |
virtual bool | GetRequiresInitialization () |
Indicate whether the kernel needs initialization. | |
virtual void | RequiresInitializationOn () |
Indicate whether the kernel needs initialization. | |
virtual void | RequiresInitializationOff () |
Indicate whether the kernel needs initialization. | |
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. | |
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. | |
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 | |
int | KernelFootprint |
double | Radius |
int | NumberOfPoints |
bool | NormalizeWeights |
Protected Attributes inherited from vtkInterpolationKernel | |
bool | RequiresInitialization |
vtkAbstractPointLocator * | Locator |
vtkDataSet * | DataSet |
vtkPointData * | PointData |
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. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for type and printing. | |
static vtkGeneralizedKernel * | SafeDownCast (vtkObjectBase *o) |
Standard methods for type and printing. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for type and printing. | |
vtkGeneralizedKernel * | NewInstance () const |
Standard methods for type and printing. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for type and printing. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for type and printing. | |
Additional Inherited Members | |
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. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 58 of file vtkGeneralizedKernel.h.
Standard methods for type and printing.
Definition at line 65 of file vtkGeneralizedKernel.h.
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 | |
---|---|
RADIUS | |
N_CLOSEST |
Definition at line 118 of file vtkGeneralizedKernel.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for type and printing.
|
virtual |
Standard methods for type and printing.
Reimplemented from vtkObjectBase.
Reimplemented in vtkEllipsoidalGaussianKernel, vtkGaussianKernel, vtkLinearKernel, vtkProbabilisticVoronoiKernel, and vtkShepardKernel.
|
static |
Standard methods for type and printing.
|
protectedvirtual |
Standard methods for type and printing.
Reimplemented in vtkEllipsoidalGaussianKernel, vtkGaussianKernel, vtkLinearKernel, vtkProbabilisticVoronoiKernel, and vtkShepardKernel.
vtkGeneralizedKernel * vtkGeneralizedKernel::NewInstance | ( | ) | const |
Standard methods for type and printing.
|
overridevirtual |
Standard methods for type and printing.
Reimplemented from vtkObjectBase.
Reimplemented in vtkLinearKernel, vtkProbabilisticVoronoiKernel, and vtkShepardKernel.
|
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.
|
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.
Implemented in vtkEllipsoidalGaussianKernel, vtkGaussianKernel, vtkLinearKernel, vtkProbabilisticVoronoiKernel, vtkShepardKernel, vtkEllipsoidalGaussianKernel, vtkGaussianKernel, vtkLinearKernel, vtkProbabilisticVoronoiKernel, and vtkShepardKernel.
|
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.
Reimplemented in vtkLinearKernel, vtkProbabilisticVoronoiKernel, and vtkShepardKernel.
Definition at line 107 of file vtkGeneralizedKernel.h.
|
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.
|
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 135 of file vtkGeneralizedKernel.h.
|
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 136 of file vtkGeneralizedKernel.h.
|
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.
|
virtual |
If the interpolation basis style is NClosest, then this method specifies the number of the closest points used to form the interpolation basis.
|
virtual |
If the interpolation basis style is NClosest, then this method specifies the number of the closest points used to form the interpolation basis.
|
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.
|
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.
|
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.
|
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.
|
protected |
Definition at line 172 of file vtkGeneralizedKernel.h.
|
protected |
Definition at line 173 of file vtkGeneralizedKernel.h.
|
protected |
Definition at line 174 of file vtkGeneralizedKernel.h.
|
protected |
Definition at line 175 of file vtkGeneralizedKernel.h.