ITK  5.2.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  * 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  *=========================================================================*/
18 #ifndef itkComplexToComplexFFTImageFilter_h
19 #define itkComplexToComplexFFTImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 #include "ITKFFTExport.h"
23 #include <complex>
24 
25 namespace itk
26 {
33 {
34 public:
41  {
42  FORWARD = 1,
43  INVERSE = 2
44  };
45 };
46 // Define how to print enumeration
47 extern ITKFFT_EXPORT std::ostream &
49 
75 template <typename TImage>
76 class ITK_TEMPLATE_EXPORT ComplexToComplexFFTImageFilter : public ImageToImageFilter<TImage, TImage>
77 {
78 public:
79  ITK_DISALLOW_COPY_AND_MOVE(ComplexToComplexFFTImageFilter);
80 
82  using ImageType = TImage;
83  using InputImageType = TImage;
84  using OutputImageType = TImage;
85 
91 
92  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
93 
96 
102  static Pointer
103  New();
104 
106 #if !defined(ITK_LEGACY_REMOVE)
107 
108  static constexpr TransformDirectionEnum FORWARD = TransformDirectionEnum::FORWARD;
109  static constexpr TransformDirectionEnum INVERSE = TransformDirectionEnum::INVERSE;
110 #endif
111 
114 
119  itkSetEnumMacro(TransformDirection, TransformDirectionEnum);
120  itkGetConstMacro(TransformDirection, TransformDirectionEnum);
122 
123 protected:
124  ComplexToComplexFFTImageFilter() = default;
125 
126  void
127  GenerateInputRequestedRegion() override;
128 
129 private:
130  TransformDirectionEnum m_TransformDirection{ TransformDirectionEnum::FORWARD };
131 };
132 } // end namespace itk
133 
134 #ifndef ITK_MANUAL_INSTANTIATION
135 # include "itkComplexToComplexFFTImageFilter.hxx"
136 #endif
137 
138 #endif
itk::uint8_t
::uint8_t uint8_t
Definition: itkIntTypes.h:29
TransformDirection
itk::ComplexToComplexFFTImageFilter::ImageSizeType
typename ImageType::SizeType ImageSizeType
Definition: itkComplexToComplexFFTImageFilter.h:113
itk::operator<<
std::ostream & operator<<(std::ostream &os, const Array< TValue > &arr)
Definition: itkArray.h:218
itk::ComplexToComplexFFTImageFilterEnums::TransformDirection
TransformDirection
Definition: itkComplexToComplexFFTImageFilter.h:40
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
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:76
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkImageToImageFilter.h
itk::ComplexToComplexFFTImageFilterEnums::TransformDirection::FORWARD
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ComplexToComplexFFTImageFilter::ImageType
TImage ImageType
Definition: itkComplexToComplexFFTImageFilter.h:82
itk::ComplexToComplexFFTImageFilter::InputImageType
TImage InputImageType
Definition: itkComplexToComplexFFTImageFilter.h:83
itk::ComplexToComplexFFTImageFilterEnums
Contains enum classes used by ComplexToComplexFFTImageFilter class.
Definition: itkComplexToComplexFFTImageFilter.h:32
itk::ComplexToComplexFFTImageFilterEnums::TransformDirection::INVERSE
itk::ComplexToComplexFFTImageFilter::OutputImageType
TImage OutputImageType
Definition: itkComplexToComplexFFTImageFilter.h:84