SimpleITK  
sitkFFTShiftImageFilter.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 sitkFFTShiftImageFilter_h
19 #define sitkFFTShiftImageFilter_h
20 
21 /*
22  * WARNING: DO NOT EDIT THIS FILE!
23  * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24  * Please look at sitkImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkBasicFilters.h"
30 #include "sitkImageFilter.h"
31 
32 namespace itk::simple {
33 
52  public:
54 
56  virtual ~FFTShiftImageFilter();
57 
61 
64 \
65 
69  SITK_RETURN_SELF_TYPE_HEADER SetInverse ( bool Inverse ) { this->m_Inverse = Inverse; return *this; }
70 
72  SITK_RETURN_SELF_TYPE_HEADER InverseOn() { return this->SetInverse(true); }
73  SITK_RETURN_SELF_TYPE_HEADER InverseOff() { return this->SetInverse(false); }
74 
78  bool GetInverse() const { return this->m_Inverse; }
79 
81  std::string GetName() const { return std::string ("FFTShiftImageFilter"); }
82 
84  std::string ToString() const;
85 
86 
89  Image Execute ( const Image& image1 );
90 
91  private:
92 
95  using MemberFunctionType = Image (Self::*)( const Image& image1 );
96  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
97 
98 
100 
101  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
102 
103 
104  /* */
105  bool m_Inverse{false};
106 
107 
108  };
109 
120  SITKBasicFilters_EXPORT Image FFTShift ( const Image& image1, bool inverse = false );
121 
123 }
124 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::FFTShiftImageFilter::SetInverse
Self & SetInverse(bool Inverse)
Definition: sitkFFTShiftImageFilter.h:69
itk::simple::FFTShiftImageFilter::GetName
std::string GetName() const
Definition: sitkFFTShiftImageFilter.h:81
itk::simple::FFTShiftImageFilter::InverseOff
Self & InverseOff()
Definition: sitkFFTShiftImageFilter.h:73
sitkImageFilter.h
itk::simple::FFTShiftImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkFFTShiftImageFilter.h:95
itk::simple::FFTShiftImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFFTShiftImageFilter.h:101
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::NonLabelPixelIDTypeList
typelist2::append< BasicPixelIDTypeList, ComplexPixelIDTypeList, VectorPixelIDTypeList >::type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::FFTShiftImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkFFTShiftImageFilter.h:63
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::FFTShiftImageFilter::GetInverse
bool GetInverse() const
Definition: sitkFFTShiftImageFilter.h:78
itk::simple::FFTShiftImageFilter
Shift the zero-frequency components of a Fourier transform to the center of the image.
Definition: sitkFFTShiftImageFilter.h:51
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::FFTShift
Image FFTShift(const Image &image1, bool inverse=false)
Shift the zero-frequency components of a Fourier transform to the center of the image.
itk::simple::FFTShiftImageFilter::InverseOn
Self & InverseOn()
Definition: sitkFFTShiftImageFilter.h:72