SimpleITK  1.3.0.dev466
sitkFFTConvolutionImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
51  public:
53 
55  virtual ~FFTConvolutionImageFilter();
56 
60 
63 
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; }
100  std::string GetName() const { return std::string ("FFTConvolutionImageFilter"); }
101 
103  std::string ToString() const;
104 
105 
107  Image Execute ( const Image & image, const Image & kernelImage );
108 
109 
111  Image Execute ( const Image & image, const Image & kernelImage, bool normalize, FFTConvolutionImageFilter::BoundaryConditionType boundaryCondition, FFTConvolutionImageFilter::OutputRegionModeType outputRegionMode );
112 
113  private:
114 
117  typedef Image (Self::*MemberFunctionType)( const Image * image, const Image * kernelImage );
118  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * kernelImage );
119 
120 
121  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
122 
123  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
124 
125 
126  /* */
130  };
131 
132 
142 
143  }
144 }
145 #endif
#define SITKBasicFilters_EXPORT
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
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
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
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...
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain...
The Image class for SimpleITK.
Definition: sitkImage.h:78
BoundaryConditionType GetBoundaryCondition() const
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
The base interface for SimpleITK filters that take one input image.