SimpleITK  1.0.1
sitkTikhonovDeconvolutionImageFilter.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 sitkTikhonovDeconvolutionImageFilter_h
19 #define sitkTikhonovDeconvolutionImageFilter_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 
49  public:
51 
55 
58 
61 
62 
63 
67  SITK_RETURN_SELF_TYPE_HEADER SetRegularizationConstant ( double RegularizationConstant ) { this->m_RegularizationConstant = RegularizationConstant; return *this; }
68 
72  double GetRegularizationConstant() const { return this->m_RegularizationConstant; }
73 
78  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
79 
81  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
82  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
83 
86  bool GetNormalize() const { return this->m_Normalize; }
87 
88  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;
89 
92  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
93 
96  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
97 
98  typedef enum {SAME,VALID} OutputRegionModeType;
99 
102  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
103 
106  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
108  std::string GetName() const { return std::string ("TikhonovDeconvolutionImageFilter"); }
109 
111  std::string ToString() const;
112 
113 
115  Image Execute ( const Image& image1, const Image& image2 );
116 
117 
119  Image Execute ( const Image& image1, const Image& image2, double regularizationConstant, bool normalize, TikhonovDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, TikhonovDeconvolutionImageFilter::OutputRegionModeType outputRegionMode );
120 
121 
122  private:
123 
126  typedef Image (Self::*MemberFunctionType)( const Image& image1, const Image& image2 );
127  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
128 
129 
130 
131  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
132 
133  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
134 
135 
137  /* */
141  };
142 
143 
144 
154 
155  }
156 }
157 #endif
#define SITKBasicFilters_EXPORT
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 TikhonovDeconvolution(const Image &image1, const Image &image2, double regularizationConstant=0.0, bool normalize=false, TikhonovDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, TikhonovDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::TikhonovDeconvolutionImageFilter::SAME)
An inverse deconvolution filter regularized in the Tikhonov sense.
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
An inverse deconvolution filter regularized in the Tikhonov sense.
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
The main Image class for SimpleITK.
Definition: sitkImage.h:54
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
The base interface for SimpleITK filters that take one input image.