1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkFFTWComplexToComplexFFTImageFilter_h
#define itkFFTWComplexToComplexFFTImageFilter_h
#include "itkComplexToComplexFFTImageFilter.h"
#include "itkFFTWCommon.h"
#include "itkFFTImageFilterFactory.h"
namespace itk
{
/**
* \class FFTWComplexToComplexFFTImageFilter
*
* \brief Implements an API to enable the Fourier transform or the inverse
* Fourier transform of images with complex valued voxels to be computed using
* either FFTW from MIT or the FFTW interface in Intel MKL.
*
* This filter is multithreaded and supports input images with sizes which are not
* a power of two.
*
* This code was contributed in the Insight Journal paper:
* "FFT Complex to Complex filters and helper classes"
* by Warfield S.
* https://www.insight-journal.org/browse/publication/128
*
* \author Simon K. Warfield simon.warfield\@childrens.harvard.edu
*
* \note Attribution Notice. This research work was made possible by
* Grant Number R01 RR021885 (PI Simon K. Warfield, Ph.D.) from
* the National Center for Research Resources (NCRR), a component of the
* National Institutes of Health (NIH). Its contents are solely the
* responsibility of the authors and do not necessarily represent the
* official view of NCRR or NIH.
*
* \ingroup FourierTransform
* \ingroup MultiThreaded
* \ingroup ITKFFT
*
* \sa FFTWGlobalConfiguration
*/
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT FFTWComplexToComplexFFTImageFilter
: public ComplexToComplexFFTImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FFTWComplexToComplexFFTImageFilter);
/** Standard class type aliases. */
using Self = FFTWComplexToComplexFFTImageFilter;
using Superclass = ComplexToComplexFFTImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using typename Superclass::ImageType;
using PixelType = typename ImageType::PixelType;
using typename Superclass::InputImageType;
using typename Superclass::OutputImageType;
using OutputImageRegionType = typename OutputImageType::RegionType;
// the proxy type is a wrapper for the fftw API
// since the proxy is only defined over double and float,
// trying to use any other pixel type is inoperative, as
// is trying to use double if only the float FFTW version is
// configured in, or float if only double is configured.
//
using FFTWProxyType = typename fftw::Proxy<typename PixelType::value_type>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(FFTWComplexToComplexFFTImageFilter);
static constexpr unsigned int ImageDimension = ImageType::ImageDimension;
/** Image type alias support */
using ImageSizeType = typename ImageType::SizeType;
/**
* Set/Get the behavior of wisdom plan creation. The default is
* provided by FFTWGlobalConfiguration::GetPlanRigor().
*
* The parameter is one of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE,
* FFTW_PATIENT, FFTW_EXHAUSTIVE provided by FFTWGlobalConfiguration.
*
* This is not used when ITK_USE_CUFFTW is enabled.
*
* /sa FFTWGlobalConfiguration
*/
virtual void
SetPlanRigor(const int & value)
{
#ifndef ITK_USE_CUFFTW
// use that method to check the value
FFTWGlobalConfiguration::GetPlanRigorName(value);
#endif
if (m_PlanRigor != value)
{
m_PlanRigor = value;
this->Modified();
}
}
itkGetConstReferenceMacro(PlanRigor, int);
void
SetPlanRigor(const std::string & name)
{
#ifndef ITK_USE_CUFFTW
this->SetPlanRigor(FFTWGlobalConfiguration::GetPlanRigorValue(name));
#endif
}
protected:
FFTWComplexToComplexFFTImageFilter();
~FFTWComplexToComplexFFTImageFilter() override = default;
void
UpdateOutputData(DataObject * output) override;
void
BeforeThreadedGenerateData() override;
void
DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
bool m_CanUseDestructiveAlgorithm{};
int m_PlanRigor{};
};
// Describe whether input/output are real- or complex-valued
// for factory registration
template <>
struct FFTImageFilterTraits<FFTWComplexToComplexFFTImageFilter>
{
template <typename TUnderlying>
using InputPixelType = std::complex<TUnderlying>;
template <typename TUnderlying>
using OutputPixelType = std::complex<TUnderlying>;
using FilterDimensions = std::integer_sequence<unsigned int, 4, 3, 2, 1>;
};
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkFFTWComplexToComplexFFTImageFilter.hxx"
#endif
#endif // itkFFTWComplexToComplexFFTImageFilter_h
|
