VTK  9.2.6
vtkImageSincInterpolator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageSincInterpolator.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
36
37#ifndef vtkImageSincInterpolator_h
38#define vtkImageSincInterpolator_h
39
41#include "vtkImagingCoreModule.h" // For export macro
42
43#define VTK_LANCZOS_WINDOW 0
44#define VTK_KAISER_WINDOW 1
45#define VTK_COSINE_WINDOW 2
46#define VTK_HANN_WINDOW 3
47#define VTK_HAMMING_WINDOW 4
48#define VTK_BLACKMAN_WINDOW 5
49#define VTK_BLACKMAN_HARRIS3 6
50#define VTK_BLACKMAN_HARRIS4 7
51#define VTK_NUTTALL_WINDOW 8
52#define VTK_BLACKMAN_NUTTALL3 9
53#define VTK_BLACKMAN_NUTTALL4 10
54#define VTK_SINC_KERNEL_SIZE_MAX 32
55
56class vtkImageData;
58
59class VTKIMAGINGCORE_EXPORT vtkImageSincInterpolator : public vtkAbstractImageInterpolator
60{
61public:
64 void PrintSelf(ostream& os, vtkIndent indent) override;
65
67
75 virtual void SetWindowFunction(int mode);
87 int GetWindowFunction() { return this->WindowFunction; }
88 virtual const char* GetWindowFunctionAsString();
90
98 void SetWindowHalfWidth(int n);
99 int GetWindowHalfWidth() { return this->WindowHalfWidth; }
100
109
118 void SetWindowParameter(double parm);
119 double GetWindowParameter() { return this->WindowParameter; }
120
127 void ComputeSupportSize(const double matrix[16], int support[3]) override;
128
130
138 void SetBlurFactors(double x, double y, double z);
139 void SetBlurFactors(const double f[3]) { this->SetBlurFactors(f[0], f[1], f[2]); }
140 void GetBlurFactors(double f[3])
141 {
142 f[0] = this->BlurFactors[0];
143 f[1] = this->BlurFactors[1];
144 f[2] = this->BlurFactors[2];
145 }
146 double* GetBlurFactors() VTK_SIZEHINT(3) { return this->BlurFactors; }
148
159 void SetAntialiasing(int antialiasing);
160 void AntialiasingOn() { this->SetAntialiasing(1); }
161 void AntialiasingOff() { this->SetAntialiasing(0); }
162 int GetAntialiasing() { return this->Antialiasing; }
163
171 void SetRenormalization(int renormalization);
174 int GetRenormalization() { return this->Renormalization; }
175
180 bool IsSeparable() override;
181
183
193 void PrecomputeWeightsForExtent(const double matrix[16], const int extent[6], int newExtent[6],
194 vtkInterpolationWeights*& weights) override;
195 void PrecomputeWeightsForExtent(const float matrix[16], const int extent[6], int newExtent[6],
196 vtkInterpolationWeights*& weights) override;
198
203
204protected:
207
211 void InternalUpdate() override;
212
217
219
223 void (**doublefunc)(vtkInterpolationInfo*, const double[3], double*)) override;
225 void (**floatfunc)(vtkInterpolationInfo*, const float[3], float*)) override;
227
229
233 void (**doublefunc)(vtkInterpolationWeights*, int, int, int, double*, int)) override;
235 void (**floatfunc)(vtkInterpolationWeights*, int, int, int, float*, int)) override;
237
242
246 virtual void FreeKernelLookupTable();
247
254 double BlurFactors[3];
258
259private:
261 void operator=(const vtkImageSincInterpolator&) = delete;
262};
263
264#endif
topologically and geometrically regular array of data
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:40
#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(...)