VTK  9.3.0
vtkImageSincInterpolator.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
25#ifndef vtkImageSincInterpolator_h
26#define vtkImageSincInterpolator_h
27
29#include "vtkImagingCoreModule.h" // For export macro
30
31#define VTK_LANCZOS_WINDOW 0
32#define VTK_KAISER_WINDOW 1
33#define VTK_COSINE_WINDOW 2
34#define VTK_HANN_WINDOW 3
35#define VTK_HAMMING_WINDOW 4
36#define VTK_BLACKMAN_WINDOW 5
37#define VTK_BLACKMAN_HARRIS3 6
38#define VTK_BLACKMAN_HARRIS4 7
39#define VTK_NUTTALL_WINDOW 8
40#define VTK_BLACKMAN_NUTTALL3 9
41#define VTK_BLACKMAN_NUTTALL4 10
42#define VTK_SINC_KERNEL_SIZE_MAX 32
43
44VTK_ABI_NAMESPACE_BEGIN
45class vtkImageData;
47
48class VTKIMAGINGCORE_EXPORT vtkImageSincInterpolator : public vtkAbstractImageInterpolator
49{
50public:
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
56
64 virtual void SetWindowFunction(int mode);
65 void SetWindowFunctionToLanczos() { this->SetWindowFunction(VTK_LANCZOS_WINDOW); }
66 void SetWindowFunctionToKaiser() { this->SetWindowFunction(VTK_KAISER_WINDOW); }
67 void SetWindowFunctionToCosine() { this->SetWindowFunction(VTK_COSINE_WINDOW); }
68 void SetWindowFunctionToHann() { this->SetWindowFunction(VTK_HANN_WINDOW); }
69 void SetWindowFunctionToHamming() { this->SetWindowFunction(VTK_HAMMING_WINDOW); }
70 void SetWindowFunctionToBlackman() { this->SetWindowFunction(VTK_BLACKMAN_WINDOW); }
71 void SetWindowFunctionToBlackmanHarris3() { this->SetWindowFunction(VTK_BLACKMAN_HARRIS3); }
72 void SetWindowFunctionToBlackmanHarris4() { this->SetWindowFunction(VTK_BLACKMAN_HARRIS4); }
73 void SetWindowFunctionToNuttall() { this->SetWindowFunction(VTK_NUTTALL_WINDOW); }
76 int GetWindowFunction() { return this->WindowFunction; }
77 virtual const char* GetWindowFunctionAsString();
79
87 void SetWindowHalfWidth(int n);
88 int GetWindowHalfWidth() { return this->WindowHalfWidth; }
89
94 void SetUseWindowParameter(int val);
95 void UseWindowParameterOn() { this->SetUseWindowParameter(1); }
96 void UseWindowParameterOff() { this->SetUseWindowParameter(0); }
97 int GetUseWindowParameter() { return this->UseWindowParameter; }
98
107 void SetWindowParameter(double parm);
108 double GetWindowParameter() { return this->WindowParameter; }
109
116 void ComputeSupportSize(const double matrix[16], int support[3]) override;
117
119
127 void SetBlurFactors(double x, double y, double z);
128 void SetBlurFactors(const double f[3]) { this->SetBlurFactors(f[0], f[1], f[2]); }
129 void GetBlurFactors(double f[3])
130 {
131 f[0] = this->BlurFactors[0];
132 f[1] = this->BlurFactors[1];
133 f[2] = this->BlurFactors[2];
134 }
135 double* GetBlurFactors() VTK_SIZEHINT(3) { return this->BlurFactors; }
137
148 void SetAntialiasing(int antialiasing);
149 void AntialiasingOn() { this->SetAntialiasing(1); }
150 void AntialiasingOff() { this->SetAntialiasing(0); }
151 int GetAntialiasing() { return this->Antialiasing; }
152
160 void SetRenormalization(int renormalization);
161 void RenormalizationOn() { this->SetRenormalization(1); }
162 void RenormalizationOff() { this->SetRenormalization(0); }
163 int GetRenormalization() { return this->Renormalization; }
164
169 bool IsSeparable() override;
170
172
182 void PrecomputeWeightsForExtent(const double matrix[16], const int extent[6], int newExtent[6],
183 vtkInterpolationWeights*& weights) override;
184 void PrecomputeWeightsForExtent(const float matrix[16], const int extent[6], int newExtent[6],
185 vtkInterpolationWeights*& weights) override;
187
192
193protected:
196
200 void InternalUpdate() override;
201
206
208
212 void (**doublefunc)(vtkInterpolationInfo*, const double[3], double*)) override;
214 void (**floatfunc)(vtkInterpolationInfo*, const float[3], float*)) override;
216
218
222 void (**doublefunc)(vtkInterpolationWeights*, int, int, int, double*, int)) override;
224 void (**floatfunc)(vtkInterpolationWeights*, int, int, int, float*, int)) override;
226
231
235 virtual void FreeKernelLookupTable();
236
239 float* KernelLookupTable[3];
240 int KernelSize[3];
243 double BlurFactors[3];
244 double LastBlurFactors[3];
247
248private:
250 void operator=(const vtkImageSincInterpolator&) = delete;
251};
252
253VTK_ABI_NAMESPACE_END
254#endif
interpolate data values from images
topologically and geometrically regular array of data
perform sinc interpolation on images
void SetWindowFunctionToKaiser()
The window function to use.
virtual void SetWindowFunction(int mode)
The window function to use.
void InternalDeepCopy(vtkAbstractImageInterpolator *obj) override
Copy the interpolator.
void SetWindowFunctionToCosine()
The window function to use.
virtual const char * GetWindowFunctionAsString()
The window function to use.
double * GetBlurFactors()
Blur the image by widening the windowed sinc kernel by the specified factors for the x,...
virtual void BuildKernelLookupTable()
Build the lookup tables used for the interpolation.
void SetWindowFunctionToLanczos()
The window function to use.
void GetBlurFactors(double f[3])
Blur the image by widening the windowed sinc kernel by the specified factors for the x,...
void SetWindowFunctionToBlackmanNuttall3()
The window function to use.
void GetInterpolationFunc(void(**doublefunc)(vtkInterpolationInfo *, const double[3], double *)) override
Get the interpolation functions.
void SetRenormalization(int renormalization)
Turn off renormalization.
void SetWindowFunctionToBlackmanHarris3()
The window function to use.
void SetUseWindowParameter(int val)
Turn this on in order to use SetWindowParameter.
void SetWindowFunctionToBlackmanNuttall4()
The window function to use.
void SetWindowFunctionToNuttall()
The window function to use.
void InternalUpdate() override
Update the interpolator.
void SetAntialiasing(int antialiasing)
Turn on antialiasing.
void FreePrecomputedWeights(vtkInterpolationWeights *&weights) override
Free the precomputed weights.
~vtkImageSincInterpolator() override
void GetInterpolationFunc(void(**floatfunc)(vtkInterpolationInfo *, const float[3], float *)) override
Get the interpolation functions.
void SetWindowHalfWidth(int n)
Set the window half-width, this must be an integer between 1 and 16, with a default value of 3.
void GetRowInterpolationFunc(void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int)) override
Get the row interpolation functions.
void SetBlurFactors(const double f[3])
Blur the image by widening the windowed sinc kernel by the specified factors for the x,...
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 precomput...
static vtkImageSincInterpolator * New()
void SetWindowFunctionToHann()
The window function to use.
int GetWindowFunction()
The window function to use.
virtual void FreeKernelLookupTable()
Free the kernel lookup tables.
void ComputeSupportSize(const double matrix[16], int support[3]) override
Get the support size for use in computing update extents.
void SetWindowFunctionToBlackman()
The window function to use.
bool IsSeparable() override
Returns true if the interpolator supports weight precomputation.
void SetWindowParameter(double parm)
Set the alpha parameter for the Kaiser window function.
void SetWindowFunctionToBlackmanHarris4()
The window function to use.
void SetWindowFunctionToHamming()
The window function to use.
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 precomput...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void GetRowInterpolationFunc(void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int)) override
Get the row interpolation functions.
void SetBlurFactors(double x, double y, double z)
Blur the image by widening the windowed sinc kernel by the specified factors for the x,...
a simple class to control print indentation
Definition vtkIndent.h:29
#define VTK_HAMMING_WINDOW
#define VTK_KAISER_WINDOW
#define VTK_BLACKMAN_HARRIS4
#define VTK_HANN_WINDOW
#define VTK_NUTTALL_WINDOW
#define VTK_BLACKMAN_WINDOW
#define VTK_BLACKMAN_NUTTALL4
#define VTK_LANCZOS_WINDOW
#define VTK_COSINE_WINDOW
#define VTK_BLACKMAN_HARRIS3
#define VTK_BLACKMAN_NUTTALL3
#define VTK_SIZEHINT(...)