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
|
/*=========================================================================
*
* 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 itkFFTShiftImageFilter_h
#define itkFFTShiftImageFilter_h
#include "itkCyclicShiftImageFilter.h"
namespace itk
{
/**
* \class FFTShiftImageFilter
* \brief Shift the zero-frequency components of a Fourier transform
* to the center of the image.
*
* The Fourier transform produces an image where the zero frequency
* components are in the corner of the image, making it difficult to
* understand. This filter shifts the component to the center of the
* image.
*
* \note For images with an odd-sized dimension, applying this filter
* twice will not produce the same image as the original one without
* using SetInverse(true) on one (and only one) of the two filters.
*
* https://www.insight-journal.org/browse/publication/125
*
* \author Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
*
* \sa ForwardFFTImageFilter, InverseFFTImageFilter
*
* \ingroup FourierTransform
* \ingroup ITKFFT
*/
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT FFTShiftImageFilter : public CyclicShiftImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FFTShiftImageFilter);
/** Standard class type aliases. */
using Self = FFTShiftImageFilter;
using Superclass = CyclicShiftImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Some convenient type alias. */
using InputImageType = TInputImage;
using OutputImageType = TOutputImage;
using InputImagePointer = typename InputImageType::Pointer;
using InputImageConstPointer = typename InputImageType::ConstPointer;
using InputImageRegionType = typename InputImageType::RegionType;
using InputImagePixelType = typename InputImageType::PixelType;
using OutputImagePointer = typename OutputImageType::Pointer;
using OutputImageConstPointer = typename OutputImageType::ConstPointer;
using OutputImageRegionType = typename OutputImageType::RegionType;
using OutputImagePixelType = typename OutputImageType::PixelType;
using IndexType = typename OutputImageType::IndexType;
using SizeType = typename OutputImageType::SizeType;
/** ImageDimension constants */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
/** Standard New method. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(FFTShiftImageFilter);
/** Set/Get whether the filter must invert the transform or not.
* This option has no effect if none of the size of the input image is even,
* but is required to restore the original image if at least one
* of the dimensions has an odd size. */
itkSetMacro(Inverse, bool);
itkGetConstReferenceMacro(Inverse, bool);
itkBooleanMacro(Inverse);
protected:
FFTShiftImageFilter();
~FFTShiftImageFilter() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Override GenerateData method to set some parameters in the
* superclass. */
void
GenerateData() override;
private:
bool m_Inverse{};
}; // end of class
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkFFTShiftImageFilter.hxx"
#endif
#endif
|
