SimpleITK  1.1.0
sitkBinaryDilateImageFilter.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 sitkBinaryDilateImageFilter_h
19 #define sitkBinaryDilateImageFilter_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 sitkKernelImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkImageFilter.h"
30 #include "sitkBasicFilters.h"
31 #include "sitkKernel.h"
32 
33 namespace itk {
34  namespace simple {
35 
61  public:
63 
65  virtual ~BinaryDilateImageFilter();
66 
70 
73 
75  typedef enum{Annulus=sitkAnnulus, Ball=sitkBall, Box=sitkBox, Cross=sitkCross} KernelType;
76 
77 
78 
81  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
82 
85  double GetBackgroundValue() const { return this->m_BackgroundValue; }
86 
89  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
90 
93  double GetForegroundValue() const { return this->m_ForegroundValue; }
94 
97  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryToForeground ( bool BoundaryToForeground ) { this->m_BoundaryToForeground = BoundaryToForeground; return *this; }
98 
100  SITK_RETURN_SELF_TYPE_HEADER BoundaryToForegroundOn() { return this->SetBoundaryToForeground(true); }
101  SITK_RETURN_SELF_TYPE_HEADER BoundaryToForegroundOff() { return this->SetBoundaryToForeground(false); }
102 
105  bool GetBoundaryToForeground() const { return this->m_BoundaryToForeground; }
107  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius(uint32_t r);
108 
116  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius(const std::vector<uint32_t> &r );
117  std::vector<uint32_t> GetKernelRadius() const;
118 
121  SITK_RETURN_SELF_TYPE_HEADER SetKernelType(KernelEnum t);
122 #ifndef SWIG
123  SITK_RETURN_SELF_TYPE_HEADER SetKernelType(KernelType t);
124 #endif
125  KernelEnum GetKernelType() const;
126 
128  std::string GetName() const { return std::string ("BinaryDilateImageFilter"); }
129 
131  std::string ToString() const;
132 
133 
135  Image Execute ( const Image& image1 );
136 
137 
139  Image Execute ( const Image& image1, double backgroundValue, double foregroundValue, bool boundaryToForeground );
140 
141 
142  private:
143 
146  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
147  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
148 
149 
150  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
151 
152  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
153 
154 
155  /* */
157  /* */
159  /* */
161 
162  /* Kernel Radius as a vector */
163  std::vector<uint32_t> m_KernelRadius;
164 
167  };
168 
169 
177  uint32_t radius = 1, KernelEnum kernel = sitkBall
178  , double backgroundValue = 0.0, double foregroundValue = 1.0, bool boundaryToForeground = false );
179 
180 
188  const std::vector<uint32_t> vectorRadius, KernelEnum kernel = sitkBall
189  , double backgroundValue = 0.0, double foregroundValue = 1.0, bool boundaryToForeground = false );
190  }
191 }
192 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::BinaryDilateImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryDilateImageFilter.h:93
itk::simple::BinaryDilateImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryDilateImageFilter.h:128
itk::simple::BinaryDilateImageFilter::Self
BinaryDilateImageFilter Self
Definition: sitkBinaryDilateImageFilter.h:62
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::sitkBox
@ sitkBox
Definition: sitkKernel.h:32
itk::simple::BinaryDilateImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryDilateImageFilter.h:85
sitkImageFilter.h
itk::simple::BinaryDilateImageFilter::m_BackgroundValue
double m_BackgroundValue
Definition: sitkBinaryDilateImageFilter.h:156
itk::simple::BinaryDilateImageFilter::GetBoundaryToForeground
bool GetBoundaryToForeground() const
Definition: sitkBinaryDilateImageFilter.h:105
itk::simple::BinaryDilate
Image BinaryDilate(const Image &, uint32_t radius=1, KernelEnum kernel=sitkBall, double backgroundValue=0.0, double foregroundValue=1.0, bool boundaryToForeground=false)
itk::simple::BinaryDilateImageFilter::m_KernelRadius
std::vector< uint32_t > m_KernelRadius
Definition: sitkBinaryDilateImageFilter.h:163
itk::simple::sitkBall
@ sitkBall
Definition: sitkKernel.h:31
itk::simple::sitkAnnulus
@ sitkAnnulus
Definition: sitkKernel.h:30
itk::simple::BinaryDilateImageFilter::BoundaryToForegroundOn
Self & BoundaryToForegroundOn()
Definition: sitkBinaryDilateImageFilter.h:100
itk::simple::BinaryDilateImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryDilateImageFilter.h:81
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::BinaryDilateImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryDilateImageFilter.h:89
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:29
itk::simple::sitkCross
@ sitkCross
Definition: sitkKernel.h:33
itk::simple::BinaryDilateImageFilter::m_KernelType
KernelEnum m_KernelType
Definition: sitkBinaryDilateImageFilter.h:166
itk::simple::BinaryDilateImageFilter::m_ForegroundValue
double m_ForegroundValue
Definition: sitkBinaryDilateImageFilter.h:158
Cross
itk
sitkKernel.h
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::uint32_t
::uint32_t uint32_t
itk::simple::BinaryDilateImageFilter::BoundaryToForegroundOff
Self & BoundaryToForegroundOff()
Definition: sitkBinaryDilateImageFilter.h:101
itk::simple::BinaryDilateImageFilter
Fast binary dilation.
Definition: sitkBinaryDilateImageFilter.h:60
itk::simple::BinaryDilateImageFilter::m_BoundaryToForeground
bool m_BoundaryToForeground
Definition: sitkBinaryDilateImageFilter.h:160
itk::simple::BinaryDilateImageFilter::SetBoundaryToForeground
Self & SetBoundaryToForeground(bool BoundaryToForeground)
Definition: sitkBinaryDilateImageFilter.h:97
itk::simple::IntegerPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > >::Type IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:76
itk::simple::BinaryDilateImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryDilateImageFilter.h:152
itk::simple::BinaryDilateImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryDilateImageFilter.h:72