SimpleITK  2.0.0rc2.post21
sitkFFTConvolutionImageFilter.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 sitkFFTConvolutionImageFilter_h
19 #define sitkFFTConvolutionImageFilter_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 {
33  namespace simple {
34 
52  public:
54 
56  virtual ~FFTConvolutionImageFilter();
57 
61 
64 \
65 
70  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
71 
73  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
74  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
75 
78  bool GetNormalize() const { return this->m_Normalize; }
79 
80  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
81 
84  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
85 
88  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
89 
90  typedef enum {SAME,VALID} OutputRegionModeType;\
91 
94  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
95 
98  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
99 
101  std::string GetName() const { return std::string ("FFTConvolutionImageFilter"); }
102 
104  std::string ToString() const;
105 
106 
109  Image Execute ( const Image & image, const Image & kernelImage );
110 
111  private:
112 
115  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * kernelImage );
116  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * kernelImage );
117 
118 
120 
121  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
122 
123 
124  /* */
125  bool m_Normalize{false};
126 
128 
130 
131 
132  };
133 
145 
147  }
148 }
149 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::FFTConvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkFFTConvolutionImageFilter.h:73
itk::simple::FFTConvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkFFTConvolutionImageFilter.h:78
sitkBasicFilters.h
itk::simple::FFTConvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFFTConvolutionImageFilter.h:63
itk::simple::Normalize
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
itk::simple::FFTConvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkFFTConvolutionImageFilter.h:70
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::FFTConvolutionImageFilter
Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain.
Definition: sitkFFTConvolutionImageFilter.h:51
itk::simple::FFTConvolutionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFFTConvolutionImageFilter.h:121
itk::simple::FFTConvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkFFTConvolutionImageFilter.h:98
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::FFTConvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkFFTConvolutionImageFilter.h:74
itk::simple::FFTConvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkFFTConvolutionImageFilter.h:84
itk::simple::FFTConvolution
Image FFTConvolution(const Image &image, const Image &kernelImage, bool normalize=false, FFTConvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::FFTConvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, FFTConvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::FFTConvolutionImageFilter::SAME)
Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain.
itk::simple::FFTConvolutionImageFilter::SAME
@ SAME
Definition: sitkFFTConvolutionImageFilter.h:90
itk::FFTConvolutionImageFilter::BoundaryConditionType
typename Superclass::BoundaryConditionType BoundaryConditionType
itk::simple::FFTConvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkFFTConvolutionImageFilter.h:80
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FFTConvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkFFTConvolutionImageFilter.h:90
itk::simple::FFTConvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkFFTConvolutionImageFilter.h:88
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::FFTConvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkFFTConvolutionImageFilter.h:101
itk::simple::FFTConvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkFFTConvolutionImageFilter.h:80
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::FFTConvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkFFTConvolutionImageFilter.h:80
itk::simple::FFTConvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkFFTConvolutionImageFilter.h:94
itk::simple::FFTConvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *kernelImage) MemberFunctionType
Definition: sitkFFTConvolutionImageFilter.h:115