ITK  5.3.0
Insight Toolkit
itkFFTWRealToHalfHermitianForwardFFTImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
19 
20 #ifndef itkFFTWRealToHalfHermitianForwardFFTImageFilter_h
21 # define itkFFTWRealToHalfHermitianForwardFFTImageFilter_h
22 
23 # include "itkFFTWCommon.h"
24 
25 namespace itk
26 {
53 template <typename TInputImage,
54  typename TOutputImage = Image<std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
56  : public RealToHalfHermitianForwardFFTImageFilter<TInputImage, TOutputImage>
57 {
58 public:
59  ITK_DISALLOW_COPY_AND_MOVE(FFTWRealToHalfHermitianForwardFFTImageFilter);
60 
62  using InputImageType = TInputImage;
63  using InputPixelType = typename InputImageType::PixelType;
65  using OutputImageType = TOutputImage;
66  using OutputPixelType = typename OutputImageType::PixelType;
68 
73 
80 
82  itkNewMacro(Self);
83 
86 
88  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
89 
99  virtual void
100  SetPlanRigor(const int & value)
101  {
102 # ifndef ITK_USE_CUFFTW
103  // Use that method to check the value
105 # endif
106  if (m_PlanRigor != value)
107  {
108  m_PlanRigor = value;
109  this->Modified();
110  }
111  }
112  itkGetConstReferenceMacro(PlanRigor, int);
114 
116  GetSizeGreatestPrimeFactor() const override;
117 
118 protected:
120  ~FFTWRealToHalfHermitianForwardFFTImageFilter() override = default;
121 
122  void
123  GenerateData() override;
124 
125  void
126  UpdateOutputData(DataObject * output) override;
127 
128  void
129  PrintSelf(std::ostream & os, Indent indent) const override;
130 
131 private:
133 
135 };
136 } // namespace itk
137 
138 # ifndef ITK_MANUAL_INSTANTIATION
139 # include "itkFFTWRealToHalfHermitianForwardFFTImageFilter.hxx"
140 # endif
141 
142 #endif // itkFFTWRealToHalfHermitianForwardFFTImageFilter_h
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::InputPixelType
typename InputImageType::PixelType InputPixelType
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:63
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::InputSizeType
typename InputImageType::SizeType InputSizeType
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:64
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itkRealToHalfHermitianForwardFFTImageFilter.h
itk::RealToHalfHermitianForwardFFTImageFilter
Base class for specialized real-to-complex forward Fast Fourier Transform.
Definition: itkRealToHalfHermitianForwardFFTImageFilter.h:56
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::FFTWGlobalConfiguration::GetPlanRigorName
static std::string GetPlanRigorName(const int &value)
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::OutputPixelType
typename OutputImageType::PixelType OutputPixelType
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:66
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::FFTWProxyType
typename fftw::Proxy< InputPixelType > FFTWProxyType
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:79
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::m_CanUseDestructiveAlgorithm
bool m_CanUseDestructiveAlgorithm
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:132
itkFFTWCommon.h
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::OutputSizeType
typename OutputImageType::SizeType OutputSizeType
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:67
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::m_PlanRigor
int m_PlanRigor
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:134
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::FFTWRealToHalfHermitianForwardFFTImageFilter::SetPlanRigor
virtual void SetPlanRigor(const int &value)
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:100
itk::FFTWRealToHalfHermitianForwardFFTImageFilter
FFTW-based forward Fast Fourier Transform.
Definition: itkFFTWRealToHalfHermitianForwardFFTImageFilter.h:55
itk::fftw::Proxy
Definition: itkFFTWCommon.h:54
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293