VTK
9.4.20241202
|
perform b-spline interpolation on images More...
#include <vtkImageBSplineInterpolator.h>
Public Types | |
typedef vtkAbstractImageInterpolator | Superclass |
Public Types inherited from vtkAbstractImageInterpolator | |
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. | |
vtkImageBSplineInterpolator * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | ComputeSupportSize (const double matrix[16], int size[3]) override |
Get the support size for use in computing update extents. | |
bool | IsSeparable () override |
Returns true if the interpolator supports weight precomputation. | |
void | FreePrecomputedWeights (vtkInterpolationWeights *&weights) override |
Free the precomputed weights. | |
void | SetSplineDegree (int degree) |
Set the degree of the spline polynomial. | |
int | GetSplineDegree () |
Set the degree of the spline polynomial. | |
int | GetSplineDegreeMinValue () |
Set the degree of the spline polynomial. | |
int | GetSplineDegreeMaxValue () |
Set the degree of the spline polynomial. | |
void | PrecomputeWeightsForExtent (const double matrix[16], const int extent[6], int newExtent[6], vtkInterpolationWeights *&weights) override |
If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed. | |
void | PrecomputeWeightsForExtent (const float matrix[16], const int extent[6], int newExtent[6], vtkInterpolationWeights *&weights) override |
If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed. | |
Public Member Functions inherited from vtkAbstractImageInterpolator | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkAbstractImageInterpolator * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | Initialize (vtkDataObject *data) |
Initialize the interpolator with the data that you wish to interpolate. | |
virtual void | ReleaseData () |
Release any data stored by the interpolator. | |
void | DeepCopy (vtkAbstractImageInterpolator *obj) |
Copy the interpolator. | |
virtual void | Update () |
Update the interpolator. | |
double | Interpolate (double x, double y, double z, int component) |
Get the result of interpolating the specified component of the input data, which should be set to zero if there is only one component. | |
bool | Interpolate (const double point[3], double *value) |
Sample the input data. | |
void | SetOutValue (double outValue) |
The value to return when the point is out of bounds. | |
double | GetOutValue () |
void | SetTolerance (double tol) |
The tolerance to apply when checking whether a point is out of bounds. | |
double | GetTolerance () |
void | SetComponentOffset (int offset) |
This method specifies which component of the input will be interpolated, or if ComponentCount is also set, it specifies the first component. | |
int | GetComponentOffset () |
void | SetComponentCount (int count) |
This method specifies the number of components to extract. | |
int | GetComponentCount () |
int | ComputeNumberOfComponents (int inputComponents) |
Compute the number of output components based on the ComponentOffset, ComponentCount, and the number of components in the input data. | |
int | GetNumberOfComponents () |
Get the number of components that will be returned when Interpolate() is called. | |
void | SetSlidingWindow (bool x) |
Enable sliding window for separable kernels. | |
void | SlidingWindowOn () |
void | SlidingWindowOff () |
bool | GetSlidingWindow () |
virtual void | ComputeSupportSize (const double matrix[16], int support[3])=0 |
Get the support size for use in computing update extents. | |
virtual bool | IsSeparable ()=0 |
True if the interpolation is separable, which means that the weights can be precomputed in order to accelerate the interpolation. | |
virtual void | FreePrecomputedWeights (vtkInterpolationWeights *&weights) |
Free the weights that were provided by PrecomputeWeightsForExtent. | |
void | InterpolateIJK (const double point[3], double *value) |
A version of Interpolate that takes structured coords instead of data coords. | |
void | InterpolateIJK (const float point[3], float *value) |
A version of Interpolate that takes structured coords instead of data coords. | |
bool | CheckBoundsIJK (const double x[3]) |
Check an x,y,z point to see if it is within the bounds for the structured coords of the image. | |
bool | CheckBoundsIJK (const float x[3]) |
Check an x,y,z point to see if it is within the bounds for the structured coords of the image. | |
void | SetBorderMode (vtkImageBorderMode mode) |
The border mode (default: clamp). | |
void | SetBorderModeToClamp () |
The border mode (default: clamp). | |
void | SetBorderModeToRepeat () |
The border mode (default: clamp). | |
void | SetBorderModeToMirror () |
The border mode (default: clamp). | |
vtkImageBorderMode | GetBorderMode () |
The border mode (default: clamp). | |
const char * | GetBorderModeAsString () |
The border mode (default: clamp). | |
void | InterpolateRow (vtkInterpolationWeights *&weights, int xIdx, int yIdx, int zIdx, double *value, int n) |
Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent. | |
void | InterpolateRow (vtkInterpolationWeights *&weights, int xIdx, int yIdx, int zIdx, float *value, int n) |
Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent. | |
virtual double * | GetSpacing () |
Get the spacing of the data being interpolated. | |
virtual void | GetSpacing (double &, double &, double &) |
Get the spacing of the data being interpolated. | |
virtual void | GetSpacing (double[3]) |
Get the spacing of the data being interpolated. | |
virtual double * | GetDirection () |
Get the direction of the data being interpolated. | |
virtual void | GetDirection (double data[9]) |
Get the direction of the data being interpolated. | |
virtual double * | GetOrigin () |
Get the origin of the data being interpolated. | |
virtual void | GetOrigin (double &, double &, double &) |
Get the origin of the data being interpolated. | |
virtual void | GetOrigin (double[3]) |
Get the origin of the data being interpolated. | |
virtual int * | GetExtent () |
Get the extent of the data being interpolated. | |
virtual void | GetExtent (int &, int &, int &, int &, int &, int &) |
Get the extent of the data being interpolated. | |
virtual void | GetExtent (int[6]) |
Get the extent of the data being interpolated. | |
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 vtkImageBSplineInterpolator * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImageBSplineInterpolator * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkAbstractImageInterpolator | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAbstractImageInterpolator * | 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 |
vtkImageBSplineInterpolator () | |
~vtkImageBSplineInterpolator () override | |
void | InternalUpdate () override |
Update the interpolator. | |
void | InternalDeepCopy (vtkAbstractImageInterpolator *obj) override |
Copy the interpolator. | |
virtual void | BuildKernelLookupTable () |
Build the lookup tables used for the interpolation. | |
virtual void | FreeKernelLookupTable () |
Free the kernel lookup tables. | |
void | GetInterpolationFunc (void(**doublefunc)(vtkInterpolationInfo *, const double[3], double *)) override |
Get the interpolation functions. | |
void | GetInterpolationFunc (void(**floatfunc)(vtkInterpolationInfo *, const float[3], float *)) override |
Get the interpolation functions. | |
void | GetRowInterpolationFunc (void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int)) override |
Get the row interpolation functions. | |
void | GetRowInterpolationFunc (void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int)) override |
Get the row interpolation functions. | |
Protected Member Functions inherited from vtkAbstractImageInterpolator | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkAbstractImageInterpolator () | |
~vtkAbstractImageInterpolator () override | |
virtual void | InternalUpdate ()=0 |
Subclass-specific updates. | |
virtual void | InternalDeepCopy (vtkAbstractImageInterpolator *obj)=0 |
Subclass-specific copy. | |
void | CoordinateToIJK (const double point[3], double ijk[3]) |
Convert XYZ coordinate to IJK continuous index. | |
virtual void | GetSlidingWindowFunc (void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int)) |
Get the sliding window interpolation functions. | |
virtual void | GetSlidingWindowFunc (void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int)) |
Get the sliding window interpolation functions. | |
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 | SplineDegree |
float * | KernelLookupTable |
Protected Attributes inherited from vtkAbstractImageInterpolator | |
vtkDataArray * | Scalars |
double | StructuredBoundsDouble [6] |
float | StructuredBoundsFloat [6] |
int | Extent [6] |
double | Spacing [3] |
double | Direction [9] |
double | InverseDirection [9] |
double | Origin [3] |
double | OutValue |
double | Tolerance |
vtkImageBorderMode | BorderMode |
int | ComponentOffset |
int | ComponentCount |
bool | UseDirection |
bool | SlidingWindow |
vtkInterpolationInfo * | InterpolationInfo |
void(* | InterpolationFuncDouble )(vtkInterpolationInfo *info, const double point[3], double *outPtr) |
void(* | InterpolationFuncFloat )(vtkInterpolationInfo *info, const float point[3], float *outPtr) |
void(* | RowInterpolationFuncDouble )(vtkInterpolationWeights *weights, int idX, int idY, int idZ, double *outPtr, int n) |
void(* | RowInterpolationFuncFloat )(vtkInterpolationWeights *weights, int idX, int idY, int idZ, float *outPtr, int n) |
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 () |
perform b-spline interpolation on images
vtkImageBSplineInterpolator can be used to perform b-spline interpolation on images that have been filtered with vtkImageBSplineCoefficients. The b-spline interpolants provide the maximum possible degree of continuity for a given kernel size, but require that the image data be pre-filtered to generate b-spline coefficients before the interpolation is performed. Interpolating data that has not been pre-filtered will give incorrect results.
Definition at line 43 of file vtkImageBSplineInterpolator.h.
Definition at line 47 of file vtkImageBSplineInterpolator.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkAbstractImageInterpolator.
|
static |
|
protectedvirtual |
Reimplemented from vtkAbstractImageInterpolator.
vtkImageBSplineInterpolator * vtkImageBSplineInterpolator::NewInstance | ( | ) | const |
|
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 vtkAbstractImageInterpolator.
void vtkImageBSplineInterpolator::SetSplineDegree | ( | int | degree | ) |
Set the degree of the spline polynomial.
The default value is 3, and the maximum is 9. The data must be pre-filtered for the same degree of polynomial with vtkImageBSplineCoefficients.
|
inline |
Set the degree of the spline polynomial.
The default value is 3, and the maximum is 9. The data must be pre-filtered for the same degree of polynomial with vtkImageBSplineCoefficients.
Definition at line 57 of file vtkImageBSplineInterpolator.h.
|
inline |
Set the degree of the spline polynomial.
The default value is 3, and the maximum is 9. The data must be pre-filtered for the same degree of polynomial with vtkImageBSplineCoefficients.
Definition at line 58 of file vtkImageBSplineInterpolator.h.
|
inline |
Set the degree of the spline polynomial.
The default value is 3, and the maximum is 9. The data must be pre-filtered for the same degree of polynomial with vtkImageBSplineCoefficients.
Definition at line 59 of file vtkImageBSplineInterpolator.h.
|
overridevirtual |
Get the support size for use in computing update extents.
If the data will be sampled on a regular grid, then pass a matrix describing the structured coordinate transformation between the output and the input. Otherwise, pass nullptr as the matrix to retrieve the full kernel size.
Implements vtkAbstractImageInterpolator.
|
overridevirtual |
Returns true if the interpolator supports weight precomputation.
This will always return true for this interpolator.
Implements vtkAbstractImageInterpolator.
|
overridevirtual |
If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.
A matrix must be supplied that provides a transformation between the provided extent and the structured coordinates of the input. This matrix must perform only permutations, scales, and translation, i.e. each of the three columns must have only one non-zero value. A new extent is provided for out-of-bounds checks. THIS METHOD IS THREAD SAFE.
Reimplemented from vtkAbstractImageInterpolator.
|
overridevirtual |
If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.
A matrix must be supplied that provides a transformation between the provided extent and the structured coordinates of the input. This matrix must perform only permutations, scales, and translation, i.e. each of the three columns must have only one non-zero value. A new extent is provided for out-of-bounds checks. THIS METHOD IS THREAD SAFE.
Reimplemented from vtkAbstractImageInterpolator.
|
overridevirtual |
Free the precomputed weights.
THIS METHOD IS THREAD SAFE.
Reimplemented from vtkAbstractImageInterpolator.
|
overrideprotectedvirtual |
Update the interpolator.
Implements vtkAbstractImageInterpolator.
|
overrideprotectedvirtual |
Copy the interpolator.
Implements vtkAbstractImageInterpolator.
|
overrideprotectedvirtual |
Get the interpolation functions.
Reimplemented from vtkAbstractImageInterpolator.
|
overrideprotectedvirtual |
Get the interpolation functions.
Reimplemented from vtkAbstractImageInterpolator.
|
overrideprotectedvirtual |
Get the row interpolation functions.
Reimplemented from vtkAbstractImageInterpolator.
|
overrideprotectedvirtual |
Get the row interpolation functions.
Reimplemented from vtkAbstractImageInterpolator.
|
protectedvirtual |
Build the lookup tables used for the interpolation.
|
protectedvirtual |
Free the kernel lookup tables.
|
protected |
Definition at line 142 of file vtkImageBSplineInterpolator.h.
|
protected |
Definition at line 143 of file vtkImageBSplineInterpolator.h.