SimpleITK  2.0.0rc2.post17
sitkConvolutionImageFilter.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 sitkConvolutionImageFilter_h
19 #define sitkConvolutionImageFilter_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 
57  public:
59 
61  virtual ~ConvolutionImageFilter();
62 
66 
69 \
70 
75  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
76 
78  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
79  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
80 
83  bool GetNormalize() const { return this->m_Normalize; }
84 
85  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
86 
89  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
90 
93  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
94 
95  typedef enum {SAME,VALID} OutputRegionModeType;\
96 
99  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
100 
103  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
104 
106  std::string GetName() const { return std::string ("ConvolutionImageFilter"); }
107 
109  std::string ToString() const;
110 
111 
114  Image Execute ( const Image & image, const Image & kernelImage );
115 
116  private:
117 
120  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * kernelImage );
121  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * kernelImage );
122 
123 
125 
126  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
127 
128 
129  /* */
130  bool m_Normalize{false};
131 
133 
135 
136 
137  };
138 
150 
152  }
153 }
154 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::ConvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkConvolutionImageFilter.h:85
itk::simple::Normalize
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
itk::simple::ConvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkConvolutionImageFilter.h:85
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ConvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkConvolutionImageFilter.h:68
itk::simple::ConvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkConvolutionImageFilter.h:85
itk::simple::ConvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkConvolutionImageFilter.h:99
itk::simple::Convolution
Image Convolution(const Image &image, const Image &kernelImage, bool normalize=false, ConvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::ConvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, ConvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::ConvolutionImageFilter::SAME)
Convolve a given image with an arbitrary image kernel.
itk::simple::ConvolutionImageFilter
Convolve a given image with an arbitrary image kernel.
Definition: sitkConvolutionImageFilter.h:56
itk::simple::ConvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkConvolutionImageFilter.h:78
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::ImageBoundaryCondition
itk::simple::ConvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkConvolutionImageFilter.h:89
itk::simple::ConvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkConvolutionImageFilter.h:75
itk::simple::ConvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *kernelImage) MemberFunctionType
Definition: sitkConvolutionImageFilter.h:120
itk::simple::ConvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkConvolutionImageFilter.h:79
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ConvolutionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkConvolutionImageFilter.h:126
itk::simple::ConvolutionImageFilter::SAME
@ SAME
Definition: sitkConvolutionImageFilter.h:95
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::ConvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkConvolutionImageFilter.h:103
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::ConvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkConvolutionImageFilter.h:106
itk::simple::ConvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkConvolutionImageFilter.h:93
itk::simple::ConvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkConvolutionImageFilter.h:95
itk::simple::ConvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkConvolutionImageFilter.h:83