|
VTK
9.0.1
|
an ellipsoidal Gaussian interpolation kernel More...
#include <vtkEllipsoidalGaussianKernel.h>
Public Types | |
| typedef vtkGeneralizedKernel | Superclass |
Public Types inherited from vtkGeneralizedKernel | |
| enum | KernelStyle { RADIUS = 0, N_CLOSEST = 1 } |
| Enum used to select the interpolation basis form. More... | |
| typedef vtkInterpolationKernel | Superclass |
| Standard methods for type and printing. More... | |
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. More... | |
| vtkEllipsoidalGaussianKernel * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | Initialize (vtkAbstractPointLocator *loc, vtkDataSet *ds, vtkPointData *pd) override |
| Initialize the kernel. More... | |
| vtkIdType | ComputeWeights (double x[3], vtkIdList *pIds, vtkDoubleArray *prob, vtkDoubleArray *weights) override |
| 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... | |
| virtual void | SetUseNormals (bool) |
| Specify whether vector values should be used to affect the shape of the Gaussian distribution. More... | |
| virtual bool | GetUseNormals () |
| virtual void | UseNormalsOn () |
| virtual void | UseNormalsOff () |
| virtual void | SetNormalsArrayName (vtkStdString) |
| Specify the normals array name. More... | |
| virtual vtkStdString | GetNormalsArrayName () |
| virtual void | SetUseScalars (bool) |
| Specify whether scalar values should be used to scale the weights. More... | |
| virtual bool | GetUseScalars () |
| virtual void | UseScalarsOn () |
| virtual void | UseScalarsOff () |
| virtual void | SetScalarsArrayName (vtkStdString) |
| Specify the scalars array name. More... | |
| virtual vtkStdString | GetScalarsArrayName () |
| virtual void | SetScaleFactor (double) |
| Multiply the Gaussian splat distribution by this value. More... | |
| virtual double | GetScaleFactor () |
| virtual void | SetSharpness (double) |
| Set / Get the sharpness (i.e., falloff) of the Gaussian. More... | |
| virtual double | GetSharpness () |
| virtual void | SetEccentricity (double) |
| Set / Get the eccentricity of the ellipsoidal Gaussian. More... | |
| virtual double | GetEccentricity () |
| 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... | |
Public Member Functions inherited from vtkGeneralizedKernel | |
| vtkGeneralizedKernel * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| 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... | |
| 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 () |
| void | SetKernelFootprintToRadius () |
| void | SetKernelFootprintToNClosest () |
| virtual void | SetRadius (double) |
| If the interpolation basis style is Radius, then this method specifies the radius within which the basis points must lie. More... | |
| virtual double | GetRadius () |
| 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 () |
| virtual void | SetNormalizeWeights (bool) |
| Indicate whether the interpolation weights should be normalized after they are computed. More... | |
| virtual bool | GetNormalizeWeights () |
| virtual void | NormalizeWeightsOn () |
| virtual void | NormalizeWeightsOff () |
Public Member Functions inherited from vtkInterpolationKernel | |
| 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 | SetRequiresInitialization (bool) |
| Indicate whether the kernel needs initialization. More... | |
| virtual bool | GetRequiresInitialization () |
| virtual void | RequiresInitializationOn () |
| virtual void | RequiresInitializationOff () |
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) |
| vtkCommand * | GetCommand (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 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... | |
Static Public Member Functions | |
| static vtkEllipsoidalGaussianKernel * | New () |
| Standard methods for instantiation, obtaining type information, and printing. More... | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkEllipsoidalGaussianKernel * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkGeneralizedKernel | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkGeneralizedKernel * | 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. 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 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 |
| vtkEllipsoidalGaussianKernel () | |
| ~vtkEllipsoidalGaussianKernel () override | |
| void | FreeStructures () override |
Protected Member Functions inherited from vtkGeneralizedKernel | |
| vtkGeneralizedKernel () | |
| ~vtkGeneralizedKernel () override | |
Protected Member Functions inherited from vtkInterpolationKernel | |
| vtkInterpolationKernel () | |
| ~vtkInterpolationKernel () override | |
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 | UseNormals |
| bool | UseScalars |
| vtkStdString | NormalsArrayName |
| vtkStdString | ScalarsArrayName |
| double | ScaleFactor |
| double | Sharpness |
| double | Eccentricity |
| double | F2 |
| double | E2 |
| vtkDataArray * | NormalsArray |
| vtkDataArray * | ScalarsArray |
Protected Attributes inherited from vtkGeneralizedKernel | |
| 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 |
Protected Attributes inherited from vtkObjectBase | |
| std::atomic< int32_t > | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
an ellipsoidal Gaussian interpolation kernel
vtkEllipsoidalGaussianKernel is an interpolation kernel that returns the weights for all points found in the ellipsoid defined by radius R in combination with local data (normals and/or scalars). For example, "pancake" weightings (the local normal parallel to the minimum ellisoidal axis); or "needle" weightings (the local normal parallel to the maximum ellipsoidal axis) are possible. (Note that spherical Gaussian weightings are more efficiently computed using vtkGaussianKernel.)
The ellipsoidal Gaussian can be described by:
W(x) = S * exp( -( Sharpness^2 * ((rxy/E)**2 + z**2)/R**2) )
where S is the local scalar value; E is a user-defined eccentricity factor that controls the elliptical shape of the splat; z is the distance of the current voxel sample point along the local normal N; and rxy is the distance to neighbor point x in the direction prependicular to N.
Definition at line 58 of file vtkEllipsoidalGaussianKernel.h.
Definition at line 66 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for instantiation, obtaining type information, and printing.
|
static |
|
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 vtkGeneralizedKernel.
|
static |
|
protectedvirtual |
Reimplemented from vtkGeneralizedKernel.
| vtkEllipsoidalGaussianKernel* vtkEllipsoidalGaussianKernel::NewInstance | ( | ) | const |
|
overridevirtual |
|
overridevirtual |
Initialize the kernel.
Overload the superclass to set up scalars and vectors.
Reimplemented from vtkInterpolationKernel.
|
overridevirtual |
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.
Implements vtkGeneralizedKernel.
|
virtual |
Specify whether vector values should be used to affect the shape of the Gaussian distribution.
By default this is on.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Specify the normals array name.
Used to orient the ellipsoid. Note that by default the input normals are used (i.e. the input to vtkPointInterpolator). If no input normals are available, then the named NormalsArrayName is used.
|
virtual |
|
virtual |
Specify whether scalar values should be used to scale the weights.
By default this is off.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Specify the scalars array name.
Used to scale the ellipsoid. Note that by default the input scalars are used (i.e. the input to vtkPointInterpolator). If no input scalars are available, then the named ScalarsArrayName is used.
|
virtual |
|
virtual |
Multiply the Gaussian splat distribution by this value.
If UseScalars is on and a scalar array is provided, then the scalar value will be multiplied by the ScaleFactor times the Gaussian function.
|
virtual |
|
virtual |
Set / Get the sharpness (i.e., falloff) of the Gaussian.
By default Sharpness=2. As the sharpness increases the effects of distant points are reduced.
|
virtual |
|
virtual |
Set / Get the eccentricity of the ellipsoidal Gaussian.
A value=1.0 produces a spherical distribution. Values < 1 produce a needle like distribution (in the direction of the normal); values > 1 produce a pancake like distribution (orthogonal to the normal).
|
virtual |
|
overrideprotectedvirtual |
Reimplemented from vtkInterpolationKernel.
| virtual vtkIdType vtkGeneralizedKernel::ComputeWeights |
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.
|
inlineoverride |
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.
Definition at line 118 of file vtkGeneralizedKernel.h.
|
protected |
Definition at line 173 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 174 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 176 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 177 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 179 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 180 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 181 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 184 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 184 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 185 of file vtkEllipsoidalGaussianKernel.h.
|
protected |
Definition at line 186 of file vtkEllipsoidalGaussianKernel.h.
1.8.17