ITK  5.3.0
Insight Toolkit
itkForwardFFTImageFilter.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 itkForwardFFTImageFilter_h
19 #define itkForwardFFTImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 #include "itkMacro.h"
23 
24 namespace itk
25 {
63 template <typename TInputImage,
64  typename TOutputImage = Image<std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
65 class ITK_TEMPLATE_EXPORT ForwardFFTImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
66 {
67 public:
68  ITK_DISALLOW_COPY_AND_MOVE(ForwardFFTImageFilter);
72  using InputImageType = TInputImage;
73  using InputPixelType = typename InputImageType::PixelType;
76  using OutputImageType = TOutputImage;
77  using OutputPixelType = typename OutputImageType::PixelType;
80 
85 
88 
93  itkFactoryOnlyNewMacro(Self);
94 
95  /* Return the preferred greatest prime factor supported for the input image
96  * size. Defaults to 2 as many implementations work only for sizes that are
97  * power of 2.
98  */
99  virtual SizeValueType
100  GetSizeGreatestPrimeFactor() const;
101 
102 protected:
103  ForwardFFTImageFilter() = default;
104  ~ForwardFFTImageFilter() override = default;
105 
107  void
108  GenerateInputRequestedRegion() override;
109 
111  void
112  EnlargeOutputRequestedRegion(DataObject * output) override;
113 };
114 } // end namespace itk
115 
116 #ifndef ITK_MANUAL_INSTANTIATION
117 # include "itkForwardFFTImageFilter.hxx"
118 #endif
119 
120 #ifdef ITK_FFTIMAGEFILTERINIT_FACTORY_REGISTER_MANAGER
121 # include "itkFFTImageFilterInitFactoryRegisterManager.h"
122 #endif
123 
124 #endif
itk::ForwardFFTImageFilter::OutputSizeType
typename OutputIndexType::SizeType OutputSizeType
Definition: itkForwardFFTImageFilter.h:79
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::SmartPointer< Self >
itk::ForwardFFTImageFilter
Base class for forward Fast Fourier Transform.
Definition: itkForwardFFTImageFilter.h:65
itk::ForwardFFTImageFilter::InputSizeType
typename InputImageType::SizeType InputSizeType
Definition: itkForwardFFTImageFilter.h:75
itk::ForwardFFTImageFilter::OutputPixelType
typename OutputImageType::PixelType OutputPixelType
Definition: itkForwardFFTImageFilter.h:77
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
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
itk::ForwardFFTImageFilter::OutputIndexType
typename OutputImageType::IndexType OutputIndexType
Definition: itkForwardFFTImageFilter.h:78
itkMacro.h
itk::ForwardFFTImageFilter::InputIndexType
typename InputImageType::IndexType InputIndexType
Definition: itkForwardFFTImageFilter.h:74
itk::ForwardFFTImageFilter::InputPixelType
typename InputImageType::PixelType InputPixelType
Definition: itkForwardFFTImageFilter.h:73
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: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
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