SimpleITK  1.3.0.dev466
sitkConvolutionImageFilter.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 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 
55  public:
57 
59  virtual ~ConvolutionImageFilter();
60 
64 
67 
68 
69 
74  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
75 
77  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
78  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
79 
82  bool GetNormalize() const { return this->m_Normalize; }
83 
84  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;
85 
88  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
89 
92  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
93 
94  typedef enum {SAME,VALID} OutputRegionModeType;
95 
98  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
99 
102  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
104  std::string GetName() const { return std::string ("ConvolutionImageFilter"); }
105 
107  std::string ToString() const;
108 
109 
111  Image Execute ( const Image & image, const Image & kernelImage );
112 
113 
115  Image Execute ( const Image & image, const Image & kernelImage, bool normalize, ConvolutionImageFilter::BoundaryConditionType boundaryCondition, ConvolutionImageFilter::OutputRegionModeType outputRegionMode );
116 
117  private:
118 
121  typedef Image (Self::*MemberFunctionType)( const Image * image, const Image * kernelImage );
122  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * kernelImage );
123 
124 
125  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
126 
127  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
128 
129 
130  /* */
134  };
135 
136 
146 
147  }
148 }
149 #endif
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Convolve a given image with an arbitrary image kernel.
#define SITKBasicFilters_EXPORT
BoundaryConditionType GetBoundaryCondition() const
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
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
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.
OutputRegionModeType GetOutputRegionMode() const
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
The Image class for SimpleITK.
Definition: sitkImage.h:78
The base interface for SimpleITK filters that take one input image.