ITK  6.0.0
Insight Toolkit
itkComplexToComplexFFTImageFilter.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  * https://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  *=========================================================================*/
18 #ifndef itkComplexToComplexFFTImageFilter_h
19 #define itkComplexToComplexFFTImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 #include "itkMacro.h"
23 #include "ITKFFTExport.h"
24 #include <complex>
25 
26 namespace itk
27 {
34 {
35 public:
39  enum class TransformDirection : uint8_t
40  {
41  FORWARD = 1,
42  INVERSE = 2
43  };
44 };
45 // Define how to print enumeration
46 extern ITKFFT_EXPORT std::ostream &
48 
72 template <typename TInputImage, typename TOutputImage = TInputImage>
73 class ITK_TEMPLATE_EXPORT ComplexToComplexFFTImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
74 {
75 public:
76  ITK_DISALLOW_COPY_AND_MOVE(ComplexToComplexFFTImageFilter);
77 
79  using ImageType = TInputImage;
80  using InputImageType = TInputImage;
81  using OutputImageType = TOutputImage;
82 
88 
89  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
90 
92  itkOverrideGetNameOfClassMacro(ComplexToComplexFFTImageFilter);
93 
99  itkFactoryOnlyNewMacro(Self);
100 
102 #if !defined(ITK_LEGACY_REMOVE)
103 
104  static constexpr TransformDirectionEnum FORWARD = TransformDirectionEnum::FORWARD;
105  static constexpr TransformDirectionEnum INVERSE = TransformDirectionEnum::INVERSE;
106 #endif
107 
110 
115  itkSetEnumMacro(TransformDirection, TransformDirectionEnum);
116  itkGetConstMacro(TransformDirection, TransformDirectionEnum);
119 protected:
120  ComplexToComplexFFTImageFilter() = default;
121 
122  void
123  GenerateInputRequestedRegion() override;
124 
125 private:
126  TransformDirectionEnum m_TransformDirection{ TransformDirectionEnum::FORWARD };
127 };
128 } // end namespace itk
129 
130 #ifndef ITK_MANUAL_INSTANTIATION
131 # include "itkComplexToComplexFFTImageFilter.hxx"
132 #endif
133 
134 #ifdef ITK_FFTIMAGEFILTERINIT_FACTORY_REGISTER_MANAGER
135 # include "itkFFTImageFilterInitFactoryRegisterManager.h"
136 #endif
137 
138 #endif
itk::ComplexToComplexFFTImageFilter::ImageType
TInputImage ImageType
Definition: itkComplexToComplexFFTImageFilter.h:79
itk::ComplexToComplexFFTImageFilterEnums::TransformDirection
TransformDirection
Definition: itkComplexToComplexFFTImageFilter.h:39
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::operator<<
ITKCommon_EXPORT std::ostream & operator<<(std::ostream &out, typename AnatomicalOrientation::CoordinateEnum value)
itk::SmartPointer< Self >
itk::ComplexToComplexFFTImageFilter
Implements an API to enable the Fourier transform or the inverse Fourier transform of images with com...
Definition: itkComplexToComplexFFTImageFilter.h:73
itk::ComplexToComplexFFTImageFilterEnums::TransformDirection::FORWARD
itk::ComplexToComplexFFTImageFilterEnums::TransformDirection::INVERSE
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itkMacro.h
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnatomicalOrientation.h:29
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:139
itk::ComplexToComplexFFTImageFilterEnums
Contains enum classes used by ComplexToComplexFFTImageFilter class.
Definition: itkComplexToComplexFFTImageFilter.h:33
itk::ComplexToComplexFFTImageFilter::ImageSizeType
typename ImageType::SizeType ImageSizeType
Definition: itkComplexToComplexFFTImageFilter.h:109
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90